# JMP Scripting Index

> The JMP Scripting Index provides a brief description and the syntax for JMP Scripting Language functions, objects, python integration, and display boxes for the JMP® Software.

Documentation for all of the Functions, Objects, Display Boxes, and Python functions that are supported by the JMP Scripting Language also known as JSL. This guide includes syntax, descriptions, code examples, and JMP® software version compatibility for each item.

# JSL Objects Usage Documentation

# [Add-In](#add-in)

## [Item Messages](#item-messages)

### [Auto Load](#auto-load)

**Syntax:** addin \<< Auto Load( boolean )

**Description:** Sets whether or not an add-in should be automatically loaded during JMP's startup process.

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << Auto Load( 1 ),
    Print( "Add-In ID Not Found" )
);


```

### [Display Name](#display-name)

**Syntax:** name = addin \<< Display Name

**Description:** Returns the display name for an add-in.

**Example 1**

```

addins = Get Addins();
addins << Display Name();


```

**Example 2**

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << Display Name(),
    Print( "Add-In ID Not Found" )
);


```

### [Home Folder](#home-folder)

**Syntax:** folder = addin \<< Home Folder

**Description:** Returns the home folder for an add-in.

**Example 1**

```

addins = Get Addins();
addins << Home Folder();


```

**Example 2**

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << Home Folder(),
    Print( "Add-In ID Not Found" )
);


```

### [ID](#id)

**Syntax:** id = addin \<< ID

**Description:** Returns the unique ID for an add-in.

**Example 1**

```

addins = Get Addins();
addins << ID();


```

**Example 2**

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << ID(),
    Print( "Add-In ID Not Found" )
);


```

### [Is Loaded](#is-loaded)

**Syntax:** x = addin \<< Is Loaded

**Description:** Returns whether or not an add-in is currently loaded.

**Example 1**

```

addins = Get Addins();
addins << Is Loaded();


```

**Example 2**

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << Is Loaded(),
    Print( "Add-In ID Not Found" )
);


```

### [Load](#load)

**Syntax:** addin \<< Load

**Description:** Loads an add-in.

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << Load(),
    Print( "Add-In ID Not Found" )
);


```

### [Unload](#unload)

**Syntax:** addin \<< Unload

**Description:** Unloads an add-in.

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << Unload(),
    Print( "Add-In ID Not Found" )
);


```

### [Version](#version)

**Syntax:** ver = addin \<< Version

**Description:** Returns the version number for an add-in.

**Example 1**

```

addins = Get Addins();
addins << Version();


```

**Example 2**

```

addin = Get Addin( "com.mycompany.myaddin" );
If( !Is Missing( addin ),
    addin << Version(),
    Print( "Add-In ID Not Found" )
);


```

# [Alpha Shape](#alpha-shape)

## [Associated Constructors](#associated-constructors)

### [Alpha Shape](#alpha-shape_1)

**Syntax:** ashape = Alpha Shape(Triangulation)

**Description:** Returns the alpha shape for the given triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );


```

## [Item Messages](#item-messages)

### [Get Alpha](#get-alpha)

**Syntax:** alpha = obj \<< Get Alpha

**Description:** Returns the current alpha value.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
ashape << Get Alpha();


```

### [Get Edges](#get-edges)

**Syntax:** edges = obj \<< Get Edges

**Description:** Returns the indices of the edges in the form an Nx2 matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get Edges;


```

### [Get Hull Edges](#get-hull-edges)

**Syntax:** ind = obj \<< Get Hull Edges

**Description:** Returns the indices of the edges on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get Hull Edges;


```

### [Get Hull Path](#get-hull-path)

**Syntax:** ind = obj \<< Get Hull Path

**Description:** Returns the boundary of the triangulation as a path.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get Hull Path;


```

### [Get Hull Points](#get-hull-points)

**Syntax:** ind = obj \<< Get Hull Points

**Description:** Returns the indices of the points on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get Hull Points;


```

### [Get N Edges](#get-n-edges)

**Syntax:** nedge = obj \<< Get N Edges

**Description:** Returns the number of edges in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get NEdges;


```

### [Get N Hull Edges](#get-n-hull-edges)

**Syntax:** nhull = obj \<< Get N Hull Edges

**Description:** Returns the number of edges on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get N Hull Edges;


```

### [Get N Hull Points](#get-n-hull-points)

**Syntax:** nhull = obj \<< Get N Hull Points

**Description:** Returns the number of points on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get N Hull Points;


```

### [Get N Points](#get-n-points)

**Syntax:** npt = obj \<< Get N Points

**Description:** Returns the number of unique points in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get N Points;


```

### [Get N Triangles](#get-n-triangles)

**Syntax:** ntri = obj \<< Get N Triangles

**Description:** Returns the number of triangles.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get N Triangles;


```

### [Get Points](#get-points)

**Syntax:** {x1,x2} = obj \<< Get Points

**Description:** Returns the coordinates of the unique points in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get Points;


```

### [Get Tri Alpha](#get-tri-alpha)

**Syntax:** [alpha1, ...] = obj \<< Get Tri Alpha

**Description:** Returns the alpha values for each triangle.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
ashape << Get Tri Alpha();


```

### [Get Triangles](#get-triangles)

**Syntax:** m = obj \<< Get Triangles

**Description:** Returns the indices of the triangles in the form of an Nx3 matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get Triangles;


```

### [Get Y](#get-y)

**Syntax:** y = obj \<< Get Y

**Description:** Returns the Y values of the unique points in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
tri << Get Y;


```

### [Peel](#peel)

**Syntax:** tri = obj \<< Peel

**Description:** Peel the boundary layer of a triangulation, returning a new triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
Show( tri << Get N Triangles );
tri2 = tri << Peel;
Show( tri2 << Get N Triangles );


```

### [Set Alpha](#set-alpha)

**Syntax:** obj \<< Set Alpha( alpha )

**Description:** Sets the current alpha value and recomputes the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
ashape << Set Alpha( 0.5 );


```

### [Subset](#subset)

**Syntax:** tri = obj \<< Subset( {indices} )

**Description:** Returns a triangulation resulting from the given subset of points.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = tri = Alpha Shape( triang );
Show( tri << Get N Triangles );
tri2 = tri << Subset( tri << Get Hull Points );
Show( tri2 << Get N Triangles );


```

# [Association Analysis](#association-analysis)

## [Associated Constructors](#associated-constructors)

### [Association Analysis](#association-analysis_1)

**Syntax:** Association Analysis( Item( columns ), ID( columns ) )

**Description:** Identifies connections among groups of items in an independent event or transaction. Association analysis is frequently used to analyze transactional data (also called market baskets) to identify items that often appear together in transactions.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Association Analysis(...\<By( column(s) )>...)

**Description:** Specifies the By column during launch.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Association Analysis(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ), Freq( :_freqcol ) );


```

### [ID](#id)

**Syntax:** obj = Association Analysis(...\<ID( column(s) )>...)

**Description:** Specifies the column that identifies the transaction to which an item belongs.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );


```

### [Item](#item)

**Syntax:** obj = Association Analysis(...Item( column(s) )...)

**Description:** Specifies the categorical column(s) that contain the item data to be analyzed.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );


```

## [Item Messages](#item-messages)

### [Frequent Item Sets](#frequent-item-sets)

**Syntax:** obj \<< Frequent Item Sets( state=0|1 )

**Description:** Shows or hides a list of item sets whose support exceeds the Minimum Support value specified in the platform launch. On by default.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Run Script( "Association Analysis of Product" );
obj << Frequent Item Sets( 0 );


```

### [Maximum Antecedents](#maximum-antecedents)

**Syntax:** obj = Association Analysis(...Maximum Antecedents( number=3 )...)

**Description:** Specifies the maximum number of items in the condition item set. Association rules with more than this number of items in the condition set are not considered in the analysis. "3" by default.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
dt << Association Analysis( Item( :Product ), ID( :Customer ID ), Maximum Antecedents( 2 ) );


```

### [Maximum Rule Size](#maximum-rule-size)

**Syntax:** obj = Association Analysis(...Maximum Rule Size( number=4 )...)

**Description:** Specifies the maximum number of items that appear in the union of the condition and consequent item sets. Association rules with more than this combined number of items are not considered in the analysis. "4" by default.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
dt << Association Analysis( Item( :Product ), ID( :Customer ID ), Maximum Rule Size( 7 ) );


```

### [Minimum Confidence](#minimum-confidence)

**Syntax:** obj = Association Analysis(...Minimum Confidence( number=0.40 )...)

**Description:** Specifies a minimum value for the proportion of occurrences that a consequent item set occurs within transactions that contain the conditional item set. This value must be between 0 and 1. Only association rules with confidence equal to or exceeding this value appear in the report. "0.40" by default.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
dt << Association Analysis( Item( :Product ), ID( :Customer ID ), Minimum Confidence( 0.5 ) );


```

### [Minimum Lift](#minimum-lift)

**Syntax:** obj = Association Analysis(...Minimum Lift( number=1.2 )...)

**Description:** Specifies a minimum dependency ratio. Lift values must be 0 or greater. Only association rules with lift equal to or exceeding this value appear in the report. "1.2" by default.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
dt << Association Analysis( Item( :Product ), ID( :Customer ID ), Minimum Lift( 1.1 ) );


```

### [Minimum Support](#minimum-support)

**Syntax:** obj = Association Analysis(...Minimum Support( fraction=0.10 )...)

**Description:** Specifies a minimum value for the proportion of occurrences of an item set. This value must be between 0 and 1. Only item sets with support equal to or exceeding this value are considered in the analysis. "0.10" by default.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    Minimum Support( 0.2 )
);


```

### [Rotated SVD](#rotated-svd)

**Syntax:** obj \<< Rotated SVD

**Description:** Performs a varimax rotated partial singular value decomposition of the item transaction matrix to produce groups of items called topics. You can select this option multiple times to find different numbers of topics.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Run Script( "Association Analysis of Product" );
obj << Rules( 0 );
obj << SVD( Number of Singular Vectors( 20 ) );
obj << Rotated SVD( Number of Topics( 9 ) );


```

### [Rules](#rules)

**Syntax:** obj \<< Rules( state=0|1 )

**Description:** Shows or hides a table of association rules that meet the Minimum Support, Minimum Confidence, Minimum Lift, Maximum Antecedents, and Maximum Rule Size requirements specified in the platform launch. On by default.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Run Script( "Association Analysis of Product" );
obj << Rules( 0 );


```

### [SVD](#svd)

**Syntax:** obj \<< SVD( Number of Singular Vectors( number ) )

**Description:** Shows or hides a report of a partial singular value decomposition (SVD) of the incidence matrix for the items. This decomposition reduces the incidence matrix into a user-specified number of dimensions for analysis.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Run Script( "Association Analysis of Product" );
obj << Rules( 0 );
obj << SVD( Number of Singular Vectors( 20 ) );


```

### [Save Item SVD](#save-item-svd)

**Syntax:** obj \<< Save Item SVD

**Description:** Creates a data table that contains a number of singular vectors that you specify for each item. These are the right singular values in the transaction item matrix.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Run Script( "Association Analysis of Product" );
obj << Rules( 0 );
obj << SVD( Number of Singular Vectors( 20 ) );
obj << Save Item SVD( 20 );


```

### [Save Transaction SVD](#save-transaction-svd)

**Syntax:** obj \<< Save Transaction SVD

**Description:** Creates a data table that contains a number of singular vectors that you specify for each transaction. These are the left singular values in the transaction item matrix.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Run Script( "Association Analysis of Product" );
obj << Rules( 0 );
obj << SVD( Number of Singular Vectors( 20 ) );
obj << Save Transaction SVD( 10 );


```

### [Transaction Listing](#transaction-listing)

**Syntax:** obj \<< Transaction Listing( state=0|1 )

**Description:** Shows or hides a table listing each Transaction ID value and the items included in that transaction. The table is sorted by the Transaction ID column.

```

dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Run Script( "Association Analysis of Product" );
obj << Transaction Listing( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Association Analysis(
    Item( :Product ),
    ID( :Customer ID ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Association Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Associative Array](#associative-array)

## [Associated Constructors](#associated-constructors)

### [Associative Array](#associative-array_1)

**Syntax:** y = Associative Array( {{key1, value1}, ...} ); y = Associative Array( keys, values )

**Description:** Creates an associative array, which is also known as a dictionary or a hash map. In the two-argument form, keys and values can be a list, matrix, or data table column.

```

ex = Associative Array( {"red", "blue"}, {1, 2} );
ex["green"] = 3;
ex << get contents;


```

## [Item Messages](#item-messages)

### [Contains](#contains)

**Syntax:** bool = AAobj \<< Contains( key | AAobj )

**Description:** Inquire if the key or set of keys is in the associative array. Also see Contains Item for a simpler example.

```

Local(
    {rhymes = ["mouse" => "house",
    "car" => "star",
    "orange" => ""], words = ["mouse" => 42,
    "car" => 54]},
    rhymes << Contains( words )
);


```

### [Contains Item](#contains-item)

**Syntax:** bool = AAobj \<< Contains Item( key )

**Description:** Inquire if the key is in the associative array. Also see Contains, which has additional capability.

```

Local( {rhymes = ["mouse" => "house", "car" => "star", "orange" => ""]},
    rhymes << Contains Item( "car" )
);


```

### [First](#first)

**Syntax:** key = AAobj \<< first

**Description:** Iterator for Associative Array.

```

Local( {aa = [1 => "bun", 2 => "shoe", 3 => "tree", 4 => "door"], x, words = ""},
    x = aa << First;
    While( !Is Empty( x ),
        words = words || aa[x];
        x = aa << Next( x );
    );
    words;
);


```

### [Get Contents](#get-contents)

**Syntax:** list = AAObj \<< Get Contents

**Description:** Returns the contents of the Associative Array as a list.

```

Local( {aa = [1 => "bun", 2 => "shoe", 3 => "tree", 4 => "door"]}, aa << Get Contents );


```

### [Get Default Value](#get-default-value)

**Syntax:** value = AAobj \<< Get Default Value()

**Description:** Returns the value the Associative Array will return for keys that are not found.

```

Local( {aa = [=> 99], v1, v2}, /* initial value used for non-existing key is 99 */
    v1 = aa[876]; /* v1 is 99 because the key 876 is not found */
    aa << Insert( "set item" ); /* used for sets, value is 1 */
    aa << Set Default Value( (aa << Get Default Value) - 1 ); /* new default is one less than old default */
    v2 = aa[876]; /* v2 is 98 because the key 876 is STILL not found */
    Char( v1 ) || " " || Char( v2 ) || " " || Char( aa );
);


```

### [Get Keys](#get-keys)

**Syntax:** list = AAObj \<< Get Keys

**Description:** Returns a list of keys found in the Associative Array.

```

Local( {aa = [1 => "bun", 2 => "shoe", 3 => "tree", 4 => "door"]}, aa << Get Keys );


```

### [Get Value](#get-value)

**Syntax:** value = AAobj \<< Get Value( key )

**Description:** Returns the value stored under the key in the associative array.

```

Local( {prices = Associative Array( {{"pineapple", 1.25}, {"grape", .50}, {"orange", .75}} )},
    prices << getvalue( "orange" ) /* or prices["orange"] */
);


```

### [Get Values](#get-values)

**Syntax:** list = AAObj \<< Get Values

**Description:** Returns a list of values found in the Associative Array.

```

Local( {aa = [1 => "bun", 2 => "shoe", 3 => "tree", 4 => "door"]}, aa << Get Values );


```

### [Insert](#insert)

**Syntax:** AAobj1 \<< Insert( AAobj2 | key, { value } )

**Description:** Inserts an associative array into another associative array or stores value under key in the associative array. See Insert Item for a simpler example.

```

Local( {decode = [".-" => "a", "-..." => "b"], others = ["..." => "s", "-.-." => "c"]},
    decode << Insert( others );
    decode["-.-."] || decode[".-"] || decode["-..."] || decode["..."];
);


```

### [Insert Item](#insert-item)

**Syntax:** AAobj \<< Insert Item( key, value )

**Description:** Stores value under key in the associative array. Also see Insert, which has additional capability.

```

Local( {decode = [".-" => "a", "-..." => "b"]},
    decode << insertitem( "-.-.", "c" );/* or decode["-.-."]="c"*/
    decode["-.-."] || decode[".-"] || decode["-..."];
);


```

### [Intersect](#intersect)

**Syntax:** AAobj1 \<< Intersect( AAobj2 )

**Description:** Treats an associative array as a set of objects. Values must be 1 for objects in the set. Default value must be 0. The current set is replaced by its intersection with the set in the message.

**Example 1**

```

Local( {red things = [=> 0], round things = [=> 0]},  /* default values must be zero for intersect to work */
    red things << Insert( "apple" ) << Insert( "blood" ) << Insert( "stop light" ) <<
    Insert( "mars" );
    round things << Insert( "earth" ) << Insert( "mars" ) << Insert( "apple" ) <<
    Insert( "orange" );
    red and round = red things;
    red and round << Intersect( round things );
    red and round << Get Keys;
);


```

**Example 2**

```

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

// select where could be used with :age<=12 & :sex=="M" in one step.  this is a demo of set operations with associative arrays.
// associative array([2,4,7]) builds a set containing keys 2,4,7 with a value of 1 and all other possible keys have a value of 0

dt << Select Where( :age <= 12 );
preteen = Associative Array( dt << Get Selected Rows ); // get selected rows returns an array

dt << SelectWhere( :sex == "M" );
male = Associative Array( dt << GetSelectedRows ); // the array creates a "set" of items

desiredSelection = preteen; // copy the set because the following <<intersect happens in-place
desiredSelection << intersect( male ); // two sets can be intersected, producing the items that are in set1 AND set2

dt << clear select; // clear, because <<SelectRows extends an existing selection
dt << selectrows( desiredSelection << getkeys ); // males <= 12


```

### [Next](#next)

**Syntax:** key = AAobj \<< next( previous key )

**Description:** Iterator for Associative Array.

```

Local( {aa = [1 => "bun", 2 => "shoe", 3 => "tree", 4 => "door"], x, words = ""},
    x = aa << First;
    While( !Is Empty( x ),
        words = words || aa[x];
        x = aa << Next( x );
    );
    words;
);


```

### [Remove](#remove)

**Syntax:** AAobj1 \<< Remove( AAobj2 | key )

**Description:** Removes the set of keys or the key from the associative array. Also see Remove Item for a simpler example.

```

Local( {primes = [2 => 1, 3 => 1, 4 => 1, 5 => 1, 6 => 1, 7 => 1, 8 => 1, 9 => 1]},
    primes << Remove( [4 => 1, 6 => 1, 8 => 1, 9 => 1] );
    primes << GetKeys; /* retrieve a list of remaining keys */
);


```

### [Remove Item](#remove-item)

**Syntax:** AAobj \<< Remove Item( key )

**Description:** Removes the key from the associative array. Also see Remove, which has additional capability.

```

Local(
    {primes = [2 => 1,
    3 => 1,
    4 => 1,
    5 => 1,
    6 => 1,
    7 => 1,
    8 => 1,
    9 => 1] /* all the values are 1; they are not actually used */
    , p, test},
    p = primes << First; /* iterate through keys */
    While( !Is Empty( p ), /* empty key means finished iterating */
        test = p; /* remember the key before advancing */
        p = primes << Next( p ); /* advance to next key before removing this key */
        If( test == 4 | test == 6 | test > 7, /* not the most sophisticated way to make primes */
            primes << Remove Item( test ) /* here it is! remove a key from the Associative Array */
        );
    );
    primes << GetKeys; /* retrieve a list of remaining keys */
);


```

### [Set Default Value](#set-default-value)

**Syntax:** AAobj \<< Set Default Value( value )

**Description:** Changes the value the Associative array will return for keys that are not found.

```

Local( {aa = [=> 99], v1, v2}, /* initial value used for non-existing key is 99 */
    v1 = aa[876]; /* v1 is 99 because the key 876 is not found */
    aa << Insert( "set item" ); /* used for sets, value is 1 */
    aa << Set Default Value( (aa << Get Default Value) - 1 ); /* new default is one less than old default */
    v2 = aa[876]; /* v2 is 98 because the key 876 is STILL not found */
    Char( v1 ) || " " || Char( v2 ) || " " || Char( aa );
);


```

# [Attribute Chart](#attribute-chart)

## [Associated Constructors](#associated-constructors)

### [Attribute Chart](#attribute-chart_1)

**Syntax:** Attribute Chart( Y( columns ), X( columns ) )

**Description:** Analyzes categorical measurements to show you measures of agreement across responses, such as raters.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Attribute Chart(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Attribute Chart(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    Freq( :_freqcol )
);


```

### [Grouping](#grouping)

**Syntax:** obj = Attribute Chart(...Grouping( column(s) )...)

**Description:** Specifies the classification columns that group the ratings, typically parts.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );


```

### [Response](#response)

**Syntax:** obj = Attribute Chart(...Response( column(s) )...)

**Description:** Specifies the columns of ratings given by each rater.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Effectiveness Report( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Response( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Effectiveness Report( 1 );


```

### [Standard](#standard)

**Syntax:** obj = Attribute Chart(...\<Standard( column )>...)

**Description:** Specifies a reference column that contains the known values for each grouping variable (part) level.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );


```

### [X](#x)

**Syntax:** obj = Attribute Chart(...X( column(s) )...)

**Description:** Specifies the classification columns that group the ratings, typically parts.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );


```

### [Y](#y)

**Syntax:** obj = Attribute Chart(...Y( column(s) )...)

**Description:** Specifies the columns of ratings given by each rater.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Effectiveness Report( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Response( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Effectiveness Report( 1 );


```

## [Item Messages](#item-messages)

### [Agreement by Rater Confid Intervals](#agreement-by-rater-confid-intervals)

**Syntax:** obj \<< Agreement by Rater Confid Intervals( state=0|1 )

**Description:** Shows or hides confidence intervals about the cell agreement percents on the efficiency graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
Wait( 2 );
obj << Agreement by Rater Confid Intervals( 0 );


```

### [Attribute Gauge Charts](#attribute-gauge-charts)

**Syntax:** obj \<< Attribute Gauge Charts( state=0|1 )

**Description:** Show or hides the attribute gauge chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
Wait( 2 );
obj << Attribute Gauge Charts( 0 );


```

### [Connect Agreement Points](#connect-agreement-points)

**Syntax:** obj \<< Connect Agreement Points( state=0|1 )

**Description:** Shows or hides a line that connects the cell means within a group of cells on both the attribute gauge chart and the efficiency graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
Wait( 2 );
obj << Connect Agreement Points( 0 );


```

### [Connect Effectiveness Points](#connect-effectiveness-points)

**Syntax:** obj \<< Connect Effectiveness Points( state=0|1 )

**Description:** Shows or hides a red line that connects the values of the percent agreement between the rater and the standard on both the attribute gauge chart and the efficiency graph.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Connect Effectiveness Points( 1 );


```

### [Effectiveness Report](#effectiveness-report)

**Syntax:** obj \<< Effectiveness Report( state=0|1 )

**Description:** Shows or hides a report that contains the agreement counts, effectiveness, misclassifications, and conformance. On by default.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
Wait( 2 );
obj << Effectiveness Report( 0 );


```

### [Effectiveness by Rater Confid Intervals](#effectiveness-by-rater-confid-intervals)

**Syntax:** obj \<< Effectiveness by Rater Confid Intervals( state=0|1 )

**Description:** Shows or hides the confidence intervals about the cell effectiveness percents on the efficiency graph.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Effectiveness by Rater Confid Intervals( 1 );


```

### [Show Agreement Grand Mean](#show-agreement-grand-mean)

**Syntax:** obj \<< Show Agreement Grand Mean( state=0|1 )

**Description:** Shows or hides a line at the value of the overall percent agreement on the attribute gauge chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
Wait( 2 );
obj << Show Agreement Grand Mean( 0 );


```

### [Show Agreement Group Means](#show-agreement-group-means)

**Syntax:** obj \<< Show Agreement Group Means( state=0|1 )

**Description:** Shows or hides a line at the value of the percent agreement within groups on the attribute gauge chart. This option requires more than one grouping variable.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "Group", formula( Sequence( 1, 3, 1, 50 ) ) );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Group, :Part ), Standard( :Standard ) );
obj << Show Agreement Group Means( 1 );


```

### [Show Agreement Points](#show-agreement-points)

**Syntax:** obj \<< Show Agreement Points( state=0|1 )

**Description:** Shows or hides the agreement points on both the attribute gauge chart and the efficiency graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
Wait( 2 );
obj << Show Agreement Points( 0 );


```

### [Show Effectiveness Points](#show-effectiveness-points)

**Syntax:** obj \<< Show Effectiveness Points( state=0|1 )

**Description:** Shows or hides the effectiveness points on both the attribute gauge chart and the efficiency graph.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Show Effectiveness Points( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Attribute Chart(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Conformance Report](#conformance-report)

### [Item Messages](#item-messages_1)

#### [Calculate Escape Rate](#calculate-escape-rate)

**Syntax:** obj \<< Calculate Escape Rate( state=0|1 )

**Description:** Shows or hides a report that contains the escape rate based on the given probability of nonconformance.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    Probability of Nonconformance( 0.1 )
);
obj << Calculate Escape Rate( 1 );


```

#### [Change Conforming Category](#change-conforming-category)

**Syntax:** obj \<< Change Conforming Category( state=0|1 )

**Description:** Specifies which category is used as the conforming identifier.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
obj << Change Conforming Category( 1 );


```

#### [Probability of Nonconformance](#probability-of-nonconformance)

**Syntax:** Attribute Chart( Probability of Nonconformance( probability ) )

**Description:** Sets the probability of nonconformance for subsequent use in the escape rate calculations.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    Probability of Nonconformance( 0.1 )
);
obj << Calculate Escape Rate( 1 );


```

# [Bayesian Optimization](#bayesian-optimization)

## [Associated Constructors](#associated-constructors)

### [Bayesian Optimization](#bayesian-optimization_1)

**Syntax:** Bayesian Optimization( Y( columns ), X( columns ) )

**Description:** Recommends factor settings to optimize responses by augmenting the data table.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);


```

## [Columns](#columns)

### [Iteration](#iteration)

**Syntax:** obj \<< Iteration( column )

**Description:** Specifies a batch label column. Batches are expected to be labeled 0, 1, 2, ..., where batch 0 indicates the original training data.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_itercol",
    Numeric,
    Ordinal,
    set values( V Concat( (Repeat( 0, N Rows( dt ) - 10 )), Repeat( 1, 10 ) ) )
);
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Iteration( _itercol )
);


```

### [Run Order](#run-order)

**Syntax:** obj \<< Run Order( column )

**Description:** Specifies a permutation column of row numbers that indicate the order of observations.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_runorder", Numeric, Ordinal, set values( 1 :: (N Rows( dt )) ) );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Run Order( _runorder )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);


```

## [Item Messages](#item-messages)

### [Automatically Generate a Batch](#automatically-generate-a-batch)

**Syntax:** obj \<< Automatically Generate a Batch( state=0|1 )

**Description:** Indicates whether to run automatic candidate set generation and batch selection. Optionally, you can specify which method to use to select batches. This option is equivalent to specifying both the Generate Candidate Set option and Autoselect Batch option at the same time.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Automatically Generate a Batch( 1 )
);


```

### [Autoselect Batch](#autoselect-batch)

**Syntax:** obj \<< Autoselect Batch( state=0|1 )

**Description:** Selects a batch from the currently loaded candidate set. If no candidate set is loaded, a space-filling set of size 1000 times the number of input variables is generated. This option can also be used to turn off auto batch selection on launch.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Generate Candidate Set(
        Candidate Set Size( 10 ),
        Include Runs that Do Not Conform to Constraints( 0 )
    ),
    Autoselect Batch( Batch Size( 1 ), Minimum RSquare( 0.5 ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Generate Candidate Set(
        Candidate Set Size( 10 ),
        Include Runs that Do Not Conform to Constraints( 0 )
    ),
    Autoselect Batch( 0 )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Automatically Generate a Batch( 0 )
);
obj << Autoselect Batch( Batch Size( 5 ), Augmentation Method( Space Filling Exploration ) );


```

### [Batch Size](#batch-size)

**Syntax:** obj \<< Batch Size( number )

**Description:** Specifies the batch size to autoselect on launch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Batch Size( 5 )
);


```

### [Candidate Set Size](#candidate-set-size)

**Syntax:** obj \<< Candidate Set Size( number )

**Description:** Specifies the desired candidate set size to generate.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Candidate Set Size( 10 )
);


```

### [Continuous Correlation Type](#continuous-correlation-type)

**Syntax:** obj \<< Continuous Correlation Type( "Gaussian"|"Matern 3/2"|"Matern 5/2"|"Exponential" )

**Description:** Specifies the desired kernel for continuous input variables.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Continuous Correlation Type( "Matern 5/2" )
);


```

### [Generate Candidate Set](#generate-candidate-set)

**Syntax:** obj \<< Generate Candidate Set( Candidate Set Size( number ), \<Include Runs that Do Not Conform to Constraints( state = 0|1 )> )

**Description:** Generates a candidate set. You can provide candidate set size and specify whether to allow points that violate the linear constraints in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Generate Candidate Set(
        Candidate Set Size( 10 ),
        Include Runs that Do Not Conform to Constraints( 0 )
    )
);


```

### [Include Runs that Do Not Conform to Constraints](#include-runs-that-do-not-conform-to-constraints)

**Syntax:** obj \<< Include Runs that Do Not Conform to Constraints( state=0|1 )

**Description:** Specifies whether to include points that violate the linear constraints in the data table when generating or loading a candidate set.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Include Runs that Do Not Conform to Constraints( 0 )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dtCand = New Table( "Tiretread Candidate Set",
    Add Rows( 15 ),
    New Column( "SILICA",
        Continuous,
        Set Values(
            [1.2, 1.60825, 0.79175, 0.995875, 1.812375, 1.404125, 0.587625, 0.6896875,
            1.5061875, 1.9144375, 1.0979375, 0.8938125, 1.7103125, 1.3020625, 0.4855625]
        )
    ),
    New Column( "SILANE",
        Continuous,
        Set Values(
            [50, 41.835, 58.165, 45.9175, 62.2475, 37.7525, 54.0825, 43.87625, 60.20625,
            35.71125, 52.04125, 39.79375, 56.12375, 47.95875, 64.28875]
        )
    ),
    New Column( "SULFUR",
        Continuous,
        Set Values(
            [2.3, 1.89175, 2.70825, 2.504125, 1.687625, 2.912375, 2.095875, 3.0144375,
            2.1979375, 2.6061875, 1.7896875, 1.9938125, 2.8103125, 1.5855625, 2.4020625]
        )
    )
);
dt << New Script( "Constraint", {:SILICA + :SULFUR <= 3} );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Include Runs that Do Not Conform to Constraints( 0 ),
    Load Candidate Set from Data Table( dtCand )
);


```

### [Minimum RSquare](#minimum-rsquare)

**Syntax:** obj \<< Minimum RSquare( number )

**Description:** Specifies the minimum required R-square metric for the batch autoselection algorithm. In the Bayesian Optimization platform launch window, this option is referred to as Model Based Augmentation RSquare Threshold.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Minimum RSquare( 0.25 )
);


```

### [Nominal Correlation Type](#nominal-correlation-type)

**Syntax:** obj \<< Nominal Correlation Type( "Equal Correlations"|"Unequal Correlations" )

**Description:** Specifies the desired kernel for nominal input variables.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Nominal Correlation Type( "Equal Correlations" )
);


```

### [Ordinal Correlation Type](#ordinal-correlation-type)

**Syntax:** obj \<< Ordinal Correlation Type( "Equal Correlations"|"Unequal Correlations"|"Latent Variable" )

**Description:** Specifies the desired kernel for ordinal input variables.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Ordinal Correlation Type( "Equal Correlations" )
);


```

### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the prediction formula to a new column in the data table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Save Prediction Formula;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Save Prediction Formula( Elong );


```

### [Set Tab](#set-tab)

**Syntax:** obj \<< Set Tab( number )

**Description:** Specifies the current tab. The argument interprets 0 as the Model Summary tab, 1 as Batch Selection, and so on, in the order in which the tabs appear in the report window.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << set tab( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << set tab( "ABRASION" );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [Bayesian Optimization Batch Customizer > Candidate Set View](#bayesian-optimization-batch-customizer-candidate-set-view)

### [Item Messages](#item-messages_1)

#### [Export Candidate Set to Data Table](#export-candidate-set-to-data-table)

**Syntax:** obj \<< Export Candidate Set to Data Table

**Description:** Exports the currently loaded candidate set to a new data table. You can specify desired column groups as arguments. This option exports factor settings by default if no column groups provided. If no arguments are specified, a window appears where you can specify options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Export Candidate Set to Data Table( Go );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Export Candidate Set to Data Table();


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Export Candidate Set to Data Table(
    Order Added, Factor Settings, Bayesian Desirability, Bayesian Desirability Std Dev,
    Multimodel Prediction Std Dev, MaxPro Space Filling Criterion,
    Bayesian Desirability Expected Improvement, Bayesian Desirability Upper Confidence Bound,
    Training Response Predictions, Augmented Response Prediction Std Dev,
    Augmented Response Prediction Confidence Intervals
);


```

#### [Select Runs](#select-runs)

**Syntax:** obj \<< Select Runs( Row Index( [ numbers ] ), \<Order Added( [ numbers ]>, \<Reason Added( { text } )>, \<Replace( 0|1 )> )

**Description:** Selects rows from the candidate set table to add to the current batch.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Select Runs(
        Row Index( [3 5] ),
        Order Added( [1 2] ),
        Reason Added( {"Custom Reason", "Custom Reason"} ),
        Replace( 1 )
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    autoselect batch( 0 )
);
obj << Select Runs(
    Row Index( [3 5] ),
    Order Added( [1 2] ),
    Reason Added( {"Custom Reason", "Custom Reason"} ),
    Replace( 0 )
);


```

#### [Show Table Columns](#show-table-columns)

**Syntax:** obj \<< Show Table Columns( \<"Column Group Name">,... )

**Description:** Specifies which groups of columns are visible in the candidate set table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Show Table Columns( Order Added, Factor Settings, Bayesian Desirability )
);


```

## [Bayesian Optimization Batch Customizer](#bayesian-optimization-batch-customizer)

### [Item Messages](#item-messages_2)

#### [Add Current Profiler Settings to Batch](#add-current-profiler-settings-to-batch)

**Syntax:** obj \<< Add Current Profiler Settings to Batch

**Description:** Adds the current profiler settings to the candidate set and selects it for inclusion as a run in the next augmentation batch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Add Current Profiler Settings to Batch;


```

#### [Augmented Acquisition Functions Profiler](#augmented-acquisition-functions-profiler)

**Syntax:** obj \<< Augmented Acquisition Functions Profiler( state=0|1 )

**Description:** Shows or hides a profiler that enables you to explore how each acquisition function changes with respect to changes in each factor value. Functions are conditional on the assumption that the points in the current batch will be sampled. This profiler reflects changes to factor levels and desirability functions made in the Augmented Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Augmented Acquisition Functions Profiler( 0 );


```

#### [Augmented Prediction Profiler](#augmented-prediction-profiler)

**Syntax:** obj \<< Augmented Prediction Profiler( state=0|1 )

**Description:** Shows or hides a profiler that enables you to explore how each column changes with respect to changes in each factor value across models. Predictions are conditional on the assumption that the points in the current batch will be sampled.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Augmented Prediction Profiler( 0 );


```

#### [Deselect All](#deselect-all)

**Syntax:** obj \<< Deselect All

**Description:** Deselect all points in current batch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Deselect All;


```

#### [Load Candidate Set from Data Table](#load-candidate-set-from-data-table)

**Syntax:** obj \<< Load Candidate Set from Data Table

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Load Candidate Set from Data Table()
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Borehole Latin Hypercube.jmp" );
:log y << Set Property( "Response Limits", {Goal( maximize ), Importance( 1 )} );
obj = dt << Bayesian Optimization(
    Y( :log y ),
    X( :log10 Rw, :log10 R, :Tu, :Tl, :Hu, :Hl, :L, :Kw )
);
dt_candidate = Open( "$SAMPLE_DATA/Design Experiment/Borehole Uniform.jmp" );
obj << Load Candidate Set from Data Table( dt_candidate );


```

#### [Make Table](#make-table)

**Syntax:** obj \<< Make Table

**Description:** Export currently selected batch points to data table based on current settings.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Make Table;


```

#### [Make Table Options](#make-table-options)

**Syntax:** obj \<< Make Table Options( \<Location( state = 0|1 )>, \<Randomize Runs( state = 0|1 )>, < "Include Option Name"( state = 0|1 ) > , ... )

**Description:** Enables you to select option settings that are used when exporting the selected batch to a data table. Note the "Include Option Name" syntax input refers to any of the options under the Include Options menu.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Make Table Options(
        Location( 1 ),
        Randomize Runs( 0 ),
        Save desirability function values to columns( 1 ),
        Save startup script for next batch selection to data table( 1 ),
        Include observed desirabilities( 1 ),
        Include original candidate set row indices( 1 ),
        Include reason added column( 1 ),
        Include predicted response values( 1 ),
        Include prediction standard deviations( 1 ),
        Include Bayesian desirability expected improvement column( 1 )
    )
);


```

#### [Maximize Bayesian Desirability](#maximize-bayesian-desirability)

**Syntax:** obj \<< Maximize Bayesian Desirability

**Description:** Finds the factor settings that maximize the posterior mean of the desirability distribution.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Maximize Bayesian Desirability;


```

#### [Maximize Bayesian Desirability Std Dev](#maximize-bayesian-desirability-std-dev)

**Syntax:** obj \<< Maximize Bayesian Desirability Std Dev

**Description:** Finds the factor settings that maximize the posterior deviation of the desirability distribution.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Maximize Bayesian Desirability Std Dev;


```

#### [Maximize Expected Improvement](#maximize-expected-improvement)

**Syntax:** obj \<< Maximize Expected Improvement

**Description:** Finds the factor settings with the largest expected improvement as measured by Bayesian desirability.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Maximize Expected Improvement;


```

#### [Maximize MaxPro Criterion](#maximize-maxpro-criterion)

**Syntax:** obj \<< Maximize MaxPro Criterion

**Description:** Finds the most space filling factor settings using the MaxPro criterion.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Maximize MaxPro Criterion;


```

#### [Maximize Multimodel Std Dev](#maximize-multimodel-std-dev)

**Syntax:** obj \<< Maximize Multimodel Std Dev

**Description:** Finds the factor settings that maximize the multiple response prediction standard deviation.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Maximize Multimodel Std Dev;


```

#### [Maximize Upper Confidence Bound](#maximize-upper-confidence-bound)

**Syntax:** obj \<< Maximize Upper Confidence Bound

**Description:** Finds the factor settings for the Bayesian desirability prediction with the highest upper confidence bound. This is often called the UCB criterion.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Maximize Upper Confidence Bound;


```

#### [Restore Best Training Point](#restore-best-training-point)

**Syntax:** obj \<< Restore Best Training Point

**Description:** Returns factor settings to those of the training row with the highest observed desirability.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);
obj << Maximize Bayesian Desirability;
obj << Add Current Profiler Settings to Batch;
obj << Restore Best Training Point;


```

## [Bayesian Optimization Model Summary](#bayesian-optimization-model-summary)

### [Item Messages](#item-messages_3)

#### [All Responses Profiler](#all-responses-profiler)

**Syntax:** obj \<< All Responses Profiler( state=0|1 )

**Description:** Explores how each column changes with respect to changes in each factor value across models.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    All Responses Profiler( 1 )
);


```

## [Gaussian Process Model](#gaussian-process-model)

### [Item Messages](#item-messages_4)

#### [Intercept](#intercept)

**Syntax:** obj \<< Intercept( number )

**Description:** Specifies the value to use as an intercept parameter for fitting a Gaussian Process model. If all theta, nugget, residual, and intercept values are provided, the values are treated as fixed. If a partial set of values is provided, the given values are treated as starting values.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Response Model Tab(
        Y( :ABRASION ),
        Theta Values( {0.5, 0.5, 0.5} ),
        Nugget( 0.05 ),
        Residual( 500 ),
        Intercept( 100 )
    )
);


```

#### [Nugget](#nugget)

**Syntax:** obj \<< Nugget( number )

**Description:** Specifies the value to use as a nugget for fitting a Gaussian Process model. If all theta, nugget, residual, and intercept values are provided, the values are treated as fixed. If a partial set of values is provided, the given values are treated as starting values.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Response Model Tab(
        Y( :ABRASION ),
        Theta Values( {0.5, 0.5, 0.5} ),
        Nugget( 0.05 ),
        Residual( 500 ),
        Intercept( 100 )
    )
);


```

#### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Explores how each column changes with respect to changes in each factor value across models.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Response Model Tab( Y( :MODULUS ), Profiler( 0 ) )
);


```

#### [Residual](#residual)

**Syntax:** obj \<< Residual( number )

**Description:** Specifies the value to use as a residual parameter for fitting a Gaussian Process model. If all theta, nugget, residual, and intercept values are provided, the values are treated as fixed. If a partial set of values is provided, the given values are treated as starting values.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Response Model Tab(
        Y( :ABRASION ),
        Theta Values( {0.5, 0.5, 0.5} ),
        Nugget( 0.05 ),
        Residual( 500 ),
        Intercept( 100 )
    )
);


```

#### [Starting Values](#starting-values)

**Syntax:** obj \<< Starting Values( number )

**Description:** Specifies the starting values to use for fitting a Gaussian Process model.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Response Model Tab(
        Y( :ABRASION ),
        Starting Values(
            Theta Values( {0.5, 0.5, 0.5} ),
            Nugget( 0.05 ),
            Residual( 500 ),
            Intercept( 100 )
        )
    )
);


```

#### [Theta Values](#theta-values)

**Syntax:** obj \<< Theta Values( number )

**Description:** Specifies the values to use as theta parameters for fitting a Gaussian Process model. If all theta, nugget, residual, and intercept values are provided, the values are treated as fixed. If a partial set of values is provided, the given values are treated as starting values.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Response Model Tab(
        Y( :ABRASION ),
        Theta Values( {0.5, 0.5, 0.5} ),
        Nugget( 0.05 ),
        Residual( 500 ),
        Intercept( 100 )
    )
);


```

# [Boosted Tree](#boosted-tree)

## [Associated Constructors](#associated-constructors)

### [Boosted Tree](#boosted-tree_1)

**Syntax:** Boosted Tree (Y( column ), X( columns ))

**Description:** Constructs a predictive model by building a large, additive decision tree that is a sequence of smaller decision trees. Each of the trees is fit on the residuals of the previous tree.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);


```

### [Factor](#factor)

**Syntax:** obj \<< Factor( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Freq( :_freqcol ),
    Go
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Weight( :_weightcol ),
    Go
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

## [Item Messages](#item-messages)

### [Column Contributions](#column-contributions)

**Syntax:** obj \<< Column Contributions( state=0|1 )

**Description:** Shows or hides a report with each input column and its corresponding contribution to the fit.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Column Contributions( 1 );


```

### [Column Sampling Rate](#column-sampling-rate)

**Syntax:** obj \<< Column Sampling Rate( number )

**Description:** Specifies the proportion of predictor columns to sample for each tree layer.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Column Sampling Rate( 0.95 ),
    Go
);


```

### [Decision Threshold](#decision-threshold)

**Syntax:** obj \<< Decision Threshold( state = 0|1, Set Probability Threshold( number ) )

**Description:** Shows or hides the distribution of fitted probabilities and actual versus predicted tables for each model. You can change the probability threshold to explore how different thresholds affect the classification results.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Splits per Tree( 4 ),
    Number of Layers( 171 ),
    Learning Rate( 0.08 ),
    Go
);
obj << Decision Threshold( 1 );


```

### [Early Stopping](#early-stopping)

**Syntax:** Early Stopping( state=0|1 )

**Description:** Stops iterating early when additional layers do not improve the validation statistic. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Early Stopping( 1 ),
    Go
);


```

### [Get Average Absolute Error Test](#get-average-absolute-error-test)

**Syntax:** obj \<< Get Average Absolute Error Test

**Description:** Returns the Mean Abs Dev statistic for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

### [Get Average Absolute Error Training](#get-average-absolute-error-training)

**Syntax:** obj \<< Get Average Absolute Error Training

**Description:** Returns the Mean Abs Dev statistic for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

### [Get Average Absolute Error Validation](#get-average-absolute-error-validation)

**Syntax:** obj \<< Get Average Absolute Error Validation

**Description:** Returns the Mean Abs Dev statistic for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

### [Get Average Log Error Test](#get-average-log-error-test)

**Syntax:** obj \<< Get Average Log Error Test

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

### [Get Average Log Error Training](#get-average-log-error-training)

**Syntax:** obj \<< Get Average Log Error Training

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

### [Get Average Log Error Validation](#get-average-log-error-validation)

**Syntax:** obj \<< Get Average Log Error Validation

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

### [Get Confusion Matrix Test](#get-confusion-matrix-test)

**Syntax:** obj \<< Get Confusion Matrix Test

**Description:** Returns the confusion matrix for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

### [Get Confusion Matrix Training](#get-confusion-matrix-training)

**Syntax:** obj \<< Get Confusion Matrix Training

**Description:** Returns the confusion matrix for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

### [Get Confusion Matrix Validation](#get-confusion-matrix-validation)

**Syntax:** obj \<< Get Confusion Matrix Validation

**Description:** Returns the confusion matrix for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

### [Get Confusion Rates Test](#get-confusion-rates-test)

**Syntax:** obj \<< Get Confusion Rates Test

**Description:** Returns the confusion rates for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

### [Get Confusion Rates Training](#get-confusion-rates-training)

**Syntax:** obj \<< Get Confusion Rates Training

**Description:** Returns the confusion rates for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

### [Get Confusion Rates Validation](#get-confusion-rates-validation)

**Syntax:** obj \<< Get Confusion Rates Validation

**Description:** Returns the confusion rates for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

### [Get Gen RSquare Test](#get-gen-rsquare-test)

**Syntax:** obj \<< Get Gen RSquare Test

**Description:** Returns the generalized RSquare for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

### [Get Gen RSquare Training](#get-gen-rsquare-training)

**Syntax:** obj \<< Get Gen RSquare Training

**Description:** Returns the generalized RSquare for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

### [Get Gen RSquare Validation](#get-gen-rsquare-validation)

**Syntax:** obj \<< Get Gen RSquare Validation

**Description:** Returns the generalized RSquare for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

### [Get MM SAS DATA Step](#get-mm-sas-data-step)

**Syntax:** obj \<< Get MM SAS DATA Step

**Description:** Creates SAS code that you can register in the SAS Model Manager and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
code = obj << Get MM SAS Data Step;


```

### [Get MM Tolerant SAS DATA Step](#get-mm-tolerant-sas-data-step)

**Syntax:** obj \<< Get MM Tolerant SAS DATA Step

**Description:** Creates SAS code for data that includes missing values that you can register in the SAS Model Manager and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
code = obj << Get MM Tolerant SAS Data Step;


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Get Measures;


```

### [Get Microseconds](#get-microseconds)

**Syntax:** obj \<< Get Microseconds

**Description:** Returns the number of microseconds used to complete the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
time = obj << Get Microseconds;
Show( time );


```

### [Get Misclassification Rate Test](#get-misclassification-rate-test)

**Syntax:** obj \<< Get Misclassification Rate Test

**Description:** Returns the misclassification rate for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

### [Get Misclassification Rate Training](#get-misclassification-rate-training)

**Syntax:** obj \<< Get Misclassification Rate Training

**Description:** Returns the misclassification rate for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Method( "Decision Tree" )
);
obj << Split Best( 2 );
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

### [Get Misclassification Rate Validation](#get-misclassification-rate-validation)

**Syntax:** obj \<< Get Misclassification Rate Validation

**Description:** Returns the misclassification rate for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Method( "Decision Tree" ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

### [Get Precision Recall Area Test](#get-precision-recall-area-test)

**Syntax:** obj \<< Get Precision Recall Area Test

**Description:** Returns the area under the precision-recall curve for the test set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

### [Get Precision Recall Area Training](#get-precision-recall-area-training)

**Syntax:** obj \<< Get Precision Recall Area Training

**Description:** Returns the area under the precision-recall curve for the training set. The precision-recall curve must be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

### [Get Precision Recall Area Validation](#get-precision-recall-area-validation)

**Syntax:** obj \<< Get Precision Recall Area Validation

**Description:** Returns the area under the precision-recall curve for the validation set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< Get Prediction Formula

**Description:** Constructs a script to create a prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Get Prediction Formula;


```

### [Get RMS Error Test](#get-rms-error-test)

**Syntax:** obj \<< Get RMS Error Test

**Description:** Returns the square root of the mean square of the test errors. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
rms = obj << Get RMS Error Test;
Show( rms );


```

### [Get RMS Error Training](#get-rms-error-training)

**Syntax:** obj \<< Get RMS Error Training

**Description:** Returns the square root of the mean square of the training errors.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
rms = obj << Get RMS Error Training;
Show( rms );


```

### [Get RMS Error Validation](#get-rms-error-validation)

**Syntax:** obj \<< Get RMS Error Validation

**Description:** Returns the square root of the mean square of the validation errors. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
rms = obj << Get RMS Error Validation;
Show( rms );


```

### [Get ROC Area Test](#get-roc-area-test)

**Syntax:** obj \<< Get ROC Area Test

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the test data. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

### [Get ROC Area Training](#get-roc-area-training)

**Syntax:** obj \<< Get ROC Area Training

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the training data set. The ROC curve needs to be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

### [Get ROC Area Validation](#get-roc-area-validation)

**Syntax:** obj \<< Get ROC Area Validation

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the validation data set. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

### [Get RSquare Test](#get-rsquare-test)

**Syntax:** obj \<< Get RSquare Test

**Description:** Returns the RSquare for the test set. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
r = obj << Get RSquare Test;
Show( r );


```

### [Get RSquare Training](#get-rsquare-training)

**Syntax:** obj \<< Get RSquare Training

**Description:** Returns the RSquare for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
r = obj << Get RSquare Training;
Show( r );


```

### [Get RSquare Validation](#get-rsquare-validation)

**Syntax:** obj \<< Get RSquare Validation

**Description:** Returns the RSquare for the validation set. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
r = obj << Get RSquare Validation;
Show( r );


```

### [Get SAS DATA Step](#get-sas-data-step)

**Syntax:** obj \<< Get SAS DATA Step

**Description:** Creates a SAS DATA step to score the data and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
code = obj << Get SAS Data Step;


```

### [Get Seconds](#get-seconds)

**Syntax:** obj \<< Get Seconds

**Description:** Returns the number of seconds used to complete the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
time = obj << Get Seconds;
Show( time );


```

### [Get Tolerant Prediction Formula](#get-tolerant-prediction-formula)

**Syntax:** obj \<< Get Tolerant Prediction Formula

**Description:** Constructs a script to create a tolerant prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Get Tolerant Prediction Formula;


```

### [Get Tolerant SAS DATA Step](#get-tolerant-sas-data-step)

**Syntax:** obj \<< Get Tolerant SAS DATA Step

**Description:** Creates a SAS DATA step to score data that includes missing values and returns it to the Log window. Missing values are randomly assigned to a tree branch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
code = obj << Get Tolerant SAS Data Step;


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Begins iterating after all parameters have been set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

### [Informative Missing](#informative-missing)

**Syntax:** obj = Boosted Tree(...Informative Missing( state=0|1 )...)

**Description:** For categorical variables, treats missing as a category. For continuous variables, treats missing as either low or high, whichever fits better. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Boosted Tree( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Partition( Y( :height ), X( :age ), Informative Missing( 0 ) );
obj << Split Best( 1 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt:Age[3] = .;
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Informative Missing( 0 ),
    Split Best( 3 )
);


```

### [Learning Rate](#learning-rate)

**Syntax:** Learning Rate( fraction )

**Description:** Sets the learning rate used in the estimate. Default is 0.1. ".1" by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Learning Rate( 0.2 ),
    Go
);


```

### [Lift Curve](#lift-curve)

**Syntax:** obj \<< Lift Curve( state=0|1 )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Lift Curve( 1 );


```

### [Make SAS DATA Step](#make-sas-data-step)

**Syntax:** obj \<< Make SAS DATA Step

**Description:** Creates a SAS DATA step to score the data and returns it to a script window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Make SAS Data Step;


```

### [Make Tolerant SAS DATA Step](#make-tolerant-sas-data-step)

**Syntax:** obj \<< Make Tolerant SAS DATA Step

**Description:** Creates a SAS DATA step to score data that includes missing values and returns it to a script window. Missing values are randomly assigned to a tree branch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Make Tolerant SAS Data Step;


```

### [Maximum Depth](#maximum-depth)

**Syntax:** obj \<< Maximum Depth( number )

**Description:** Restricts tree size by depth instead of number of nodes.

### [Method](#method)

**Syntax:** Method( "Boosted Tree" )

**Description:** Determines the method used for partitioning the data. Decision Tree is the default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

### [Minimum Size Split](#minimum-size-split)

**Syntax:** Minimum Size Split( number )

**Description:** Sets the minimum number of observations for considering splits used in the estimate. Default is 5.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Minimum Size Split( 10 ),
    Go
);


```

### [Multithreading](#multithreading)

**Syntax:** Multithreading( state=0|1 )

**Description:** Divides up the calculations among the available threads on the machine. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Split Best( 2 )
);


```

### [Number of Layers](#number-of-layers)

**Syntax:** Number of Layers( number )

**Description:** Sets the number of layers used in the estimate. Default is 50. "100" by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Number of Layers( 20 ),
    Go
);


```

### [Ordinal Restricts Order](#ordinal-restricts-order)

**Syntax:** obj = Boosted Tree(...Ordinal Restricts Order( state=0|1 )...)

**Description:** For ordinal columns, considers only splits that preserve order. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Boosted Tree( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Partition( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ) );
obj << Split Best( 3 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Ordinal Restricts Order( 1 ),
    Split Best( 2 )
);


```

### [Overfit Penalty](#overfit-penalty)

**Syntax:** Overfit Penalty( fraction )

**Description:** Sets the overfit penalty, which introduces bias to move the probabilities away from zero for models with a categorical response. Default is 0.0001.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Overfit Penalty( 0.0005 ),
    Go
);


```

### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides a plot using the training data with the predicted values on the X axis and actual values on the Y axis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Plot Actual by Predicted( 1 );


```

### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Precision Recall Curve( 1 );


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Profiler( 1 );


```

### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Publish Prediction Formula;


```

### [Publish Tolerant Prediction Formula](#publish-tolerant-prediction-formula)

**Syntax:** obj \<< Publish Tolerant Prediction Formula

**Description:** Builds a prediction formula that predicts even when there are missing values and publishes it as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Publish Tolerant Prediction Formula;


```

### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << ROC Curve( 1 );


```

### [Row Sampling Rate](#row-sampling-rate)

**Syntax:** obj \<< Row Sampling Rate( number )

**Description:** Specifies the proportion of training rows to sample for each tree layer.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Row Sampling Rate( 0.95 ),
    Go
);


```

### [Save Cumulative Details](#save-cumulative-details)

**Syntax:** obj \<< Save Cumulative Details

**Description:** Saves the validation RSquare along with the tree number in a new data table. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Cumulative Details;


```

### [Save Offset Estimates](#save-offset-estimates)

**Syntax:** obj \<< Save Offset Estimates

**Description:** Saves the offset estimates to a new column in the data table. Available only for categorical responses.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Save Offset Estimates;


```

### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds

**Description:** Saves the predicted values in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Predicteds;


```

### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the prediction formula in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Prediction Formula;


```

### [Save Residuals](#save-residuals)

**Syntax:** obj \<< Save Residuals

**Description:** Saves the residuals in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Residuals;


```

### [Save Tolerant Prediction Formula](#save-tolerant-prediction-formula)

**Syntax:** obj \<< Save Tolerant Prediction Formula

**Description:** Save a formula that predicts even when there are missing values in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Tolerant Prediction Formula;


```

### [Save Tree Details](#save-tree-details)

**Syntax:** obj \<< Save Tree Details

**Description:** Saves the layer, split, label, and estimate for each layer-split combination in a new data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Tree Details;


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number )

**Description:** Specifies a random seed to reproduce the results for future launches of the platform.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

### [Show Trees](#show-trees)

**Syntax:** obj \<< Show Trees( "None"|"Show names"|"Show names categories"|"Show names categories estimates" )

**Description:** Shows a list of trees at each layer, with names only, names and categories, or names, categories and estimates at each node.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Show Trees( Show names categories );
(obj << Report)["Tree Views"] << Close( 0 );
(obj << Report)["Layer4"] << Close( 0 );


```

### [Specify Profit Matrix](#specify-profit-matrix)

**Syntax:** obj \<< Specify Profit Matrix

**Description:** Enables you to specify profits or costs associated with correct or incorrect classification decisions.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Specify Profit Matrix( [1 -1, -1 1, . .], "0", "1", "Undecided" ),
    Go
);


```

### [Splits per Tree](#splits-per-tree)

**Syntax:** Splits Per Tree( number )

**Description:** Sets the number of splits per tree used in the estimate. Default is 3. "3" by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Splits Per Tree( 2 ),
    Go
);


```

### [Tuning Design Table](#tuning-design-table)

**Syntax:** Tuning Design Table( "table name" )

**Description:** A table of tuning parameters to run with, supporting: Splits Per Tree, Learning Rate, Row Sampling Rate, Column Sampling Rate, Number of Layers, Minimum Size Split

### [Use Excluded Rows for Validation](#use-excluded-rows-for-validation)

**Syntax:** obj = Boosted Tree(...Use Excluded Rows for Validation( state=0|1 )...)

**Description:** Uses the excluded rows in the data table to create a validation set. This option appears in the launch window only if you are using standard JMP and there are excluded rows.

**JMP Version Added:** 15

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 )
);
obj << Split Best( 5 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Use Excluded Rows for Validation( 1 ),
    Split Best( 2 )
);


```

### [Validation Portion](#validation-portion)

**Syntax:** obj = Boosted Tree(...Validation Portion( fraction=0 )...)

**Description:** Forms a validation set by randomly selecting rows with each row having probability p (fraction) of being selected. "0" by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :country, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 )
);
obj << Split Best( 2 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation Portion( 0.2 ),
    Go
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Bootstrap Forest](#bootstrap-forest)

## [Associated Constructors](#associated-constructors)

### [Bootstrap Forest](#bootstrap-forest_1)

**Syntax:** Bootstrap Forest (Y( column ), X( columns ))

**Description:** Constructs a predictive model by averaging predicted values from many decision trees. Each decision tree is fit to a random bootstrap sample of the training data.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);


```

### [Factor](#factor)

**Syntax:** obj \<< Factor( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Freq( :_freqcol ),
    Go
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Weight( :_weightcol ),
    Go
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

## [Item Messages](#item-messages)

### [Column Contributions](#column-contributions)

**Syntax:** obj \<< Column Contributions( state=0|1 )

**Description:** Shows or hides a report with each input column and its corresponding contribution to the fit.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Column Contributions( 1 );


```

### [Decision Threshold](#decision-threshold)

**Syntax:** obj \<< Decision Threshold( state = 0|1, Set Probability Threshold( number ) )

**Description:** Shows or hides the distribution of fitted probabilities and actual versus predicted tables for each model. You can change the probability threshold to explore how different thresholds affect the classification results.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Number Terms( 8 ),
    Number Trees( 100 ),
    Go
);
obj << Decision Threshold( 1 );


```

### [Early Stopping](#early-stopping)

**Syntax:** obj \<< Early Stopping( state=0|1 )

**Description:** Stops iterating early when additional layers do not improve the validation statistic. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Early Stopping( 1 ),
    Go
);


```

### [Get Average Absolute Error Test](#get-average-absolute-error-test)

**Syntax:** obj \<< Get Average Absolute Error Test

**Description:** Returns the Mean Abs Dev statistic for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

### [Get Average Absolute Error Training](#get-average-absolute-error-training)

**Syntax:** obj \<< Get Average Absolute Error Training

**Description:** Returns the Mean Abs Dev statistic for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

### [Get Average Absolute Error Validation](#get-average-absolute-error-validation)

**Syntax:** obj \<< Get Average Absolute Error Validation

**Description:** Returns the Mean Abs Dev statistic for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

### [Get Average Log Error Test](#get-average-log-error-test)

**Syntax:** obj \<< Get Average Log Error Test

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

### [Get Average Log Error Training](#get-average-log-error-training)

**Syntax:** obj \<< Get Average Log Error Training

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

### [Get Average Log Error Validation](#get-average-log-error-validation)

**Syntax:** obj \<< Get Average Log Error Validation

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

### [Get Confusion Matrix Test](#get-confusion-matrix-test)

**Syntax:** obj \<< Get Confusion Matrix Test

**Description:** Returns the confusion matrix for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

### [Get Confusion Matrix Training](#get-confusion-matrix-training)

**Syntax:** obj \<< Get Confusion Matrix Training

**Description:** Returns the confusion matrix for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

### [Get Confusion Matrix Validation](#get-confusion-matrix-validation)

**Syntax:** obj \<< Get Confusion Matrix Validation

**Description:** Returns the confusion matrix for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

### [Get Confusion Rates Test](#get-confusion-rates-test)

**Syntax:** obj \<< Get Confusion Rates Test

**Description:** Returns the confusion rates for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

### [Get Confusion Rates Training](#get-confusion-rates-training)

**Syntax:** obj \<< Get Confusion Rates Training

**Description:** Returns the confusion rates for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

### [Get Confusion Rates Validation](#get-confusion-rates-validation)

**Syntax:** obj \<< Get Confusion Rates Validation

**Description:** Returns the confusion rates for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

### [Get Gen RSquare Test](#get-gen-rsquare-test)

**Syntax:** obj \<< Get Gen RSquare Test

**Description:** Returns the generalized RSquare for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

### [Get Gen RSquare Training](#get-gen-rsquare-training)

**Syntax:** obj \<< Get Gen RSquare Training

**Description:** Returns the generalized RSquare for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

### [Get Gen RSquare Validation](#get-gen-rsquare-validation)

**Syntax:** obj \<< Get Gen RSquare Validation

**Description:** Returns the generalized RSquare for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

### [Get MM SAS DATA Step](#get-mm-sas-data-step)

**Syntax:** obj \<< Get MM SAS DATA Step

**Description:** Creates SAS code that you can register in the SAS Model Manager and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
code = obj << Get MM SAS Data Step;


```

### [Get MM Tolerant SAS DATA Step](#get-mm-tolerant-sas-data-step)

**Syntax:** obj \<< Get MM Tolerant SAS DATA Step

**Description:** Creates SAS code for data that includes missing values that you can register in the SAS Model Manager and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
code = obj << Get MM Tolerant SAS Data Step;


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Get Measures;


```

### [Get Microseconds](#get-microseconds)

**Syntax:** obj \<< Get Microseconds

**Description:** Returns the number of microseconds used to complete the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
time = obj << Get Microseconds;
Show( time );


```

### [Get Misclassification Rate Test](#get-misclassification-rate-test)

**Syntax:** obj \<< Get Misclassification Rate Test

**Description:** Returns the misclassification rate for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

### [Get Misclassification Rate Training](#get-misclassification-rate-training)

**Syntax:** obj \<< Get Misclassification Rate Training

**Description:** Returns the misclassification rate for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Method( "Decision Tree" )
);
obj << Split Best( 2 );
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

### [Get Misclassification Rate Validation](#get-misclassification-rate-validation)

**Syntax:** obj \<< Get Misclassification Rate Validation

**Description:** Returns the misclassification rate for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Method( "Decision Tree" ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

### [Get Precision Recall Area Test](#get-precision-recall-area-test)

**Syntax:** obj \<< Get Precision Recall Area Test

**Description:** Returns the area under the precision-recall curve for the test set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

### [Get Precision Recall Area Training](#get-precision-recall-area-training)

**Syntax:** obj \<< Get Precision Recall Area Training

**Description:** Returns the area under the precision-recall curve for the training set. The precision-recall curve must be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

### [Get Precision Recall Area Validation](#get-precision-recall-area-validation)

**Syntax:** obj \<< Get Precision Recall Area Validation

**Description:** Returns the area under the precision-recall curve for the validation set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< Get Prediction Formula

**Description:** Constructs a script to create a prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Get Prediction Formula;


```

### [Get RMS Error Test](#get-rms-error-test)

**Syntax:** obj \<< Get RMS Error Test

**Description:** Returns the square root of the mean square of the test errors. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
rms = obj << Get RMS Error Test;
Show( rms );


```

### [Get RMS Error Training](#get-rms-error-training)

**Syntax:** obj \<< Get RMS Error Training

**Description:** Returns the square root of the mean square of the training errors.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
rms = obj << Get RMS Error Training;
Show( rms );


```

### [Get RMS Error Validation](#get-rms-error-validation)

**Syntax:** obj \<< Get RMS Error Validation

**Description:** Returns the square root of the mean square of the validation errors. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
rms = obj << Get RMS Error Validation;
Show( rms );


```

### [Get ROC Area Test](#get-roc-area-test)

**Syntax:** obj \<< Get ROC Area Test

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the test data. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

### [Get ROC Area Training](#get-roc-area-training)

**Syntax:** obj \<< Get ROC Area Training

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the training data set. The ROC curve needs to be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

### [Get ROC Area Validation](#get-roc-area-validation)

**Syntax:** obj \<< Get ROC Area Validation

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the validation data set. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

### [Get RSquare Test](#get-rsquare-test)

**Syntax:** obj \<< Get RSquare Test

**Description:** Returns the RSquare for the test set. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
r = obj << Get RSquare Test;
Show( r );


```

### [Get RSquare Training](#get-rsquare-training)

**Syntax:** obj \<< Get RSquare Training

**Description:** Returns the RSquare for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
r = obj << Get RSquare Training;
Show( r );


```

### [Get RSquare Validation](#get-rsquare-validation)

**Syntax:** obj \<< Get RSquare Validation

**Description:** Returns the RSquare for the validation set. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
r = obj << Get RSquare Validation;
Show( r );


```

### [Get SAS DATA Step](#get-sas-data-step)

**Syntax:** obj \<< Get SAS DATA Step

**Description:** Creates a SAS DATA step to score the data and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
code = obj << Get SAS Data Step;


```

### [Get Seconds](#get-seconds)

**Syntax:** obj \<< Get Seconds

**Description:** Returns the number of seconds used to complete the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
time = obj << Get Seconds;
Show( time );


```

### [Get Tolerant Prediction Formula](#get-tolerant-prediction-formula)

**Syntax:** obj \<< Get Tolerant Prediction Formula

**Description:** Constructs a script to create a tolerant prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Get Tolerant Prediction Formula;


```

### [Get Tolerant SAS DATA Step](#get-tolerant-sas-data-step)

**Syntax:** obj \<< Get Tolerant SAS DATA Step

**Description:** Creates a SAS DATA step to score data that includes missing values and returns it to the Log window. Missing values are randomly assigned to a tree branch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
code = obj << Get Tolerant SAS Data Step;


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Begins iterating after all parameters have been set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Informative Missing](#informative-missing)

**Syntax:** obj = Bootstrap Forest(...Informative Missing( state=0|1 )...)

**Description:** For categorical variables, treats missing as a category. For continuous variables, treats missing as either low or high, whichever fits better. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Boosted Tree( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Partition( Y( :height ), X( :age ), Informative Missing( 0 ) );
obj << Split Best( 1 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt:Age[3] = .;
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Informative Missing( 0 ),
    Split Best( 3 )
);


```

### [Lift Curve](#lift-curve)

**Syntax:** obj \<< Lift Curve( state=0|1 )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Go
);
obj << Lift Curve( 1 );


```

### [Make SAS DATA Step](#make-sas-data-step)

**Syntax:** obj \<< Make SAS DATA Step

**Description:** Creates a SAS DATA step to score the data and returns it to a script window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Make SAS Data Step;


```

### [Make Tolerant SAS DATA Step](#make-tolerant-sas-data-step)

**Syntax:** obj \<< Make Tolerant SAS DATA Step

**Description:** Creates a SAS DATA step to score data that includes missing values and returns it to a script window. Missing values are randomly assigned to a tree branch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Make Tolerant SAS Data Step;


```

### [Maximum Number of Terms](#maximum-number-of-terms)

**Syntax:** obj \<< Maximum Number of Terms( number )

**Description:** Sets the maximum number of terms to try when running multiple models.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Minimum Size Split( 10 ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Maximum Number of Terms( 5 ),
    Go
);


```

### [Maximum Splits per Tree](#maximum-splits-per-tree)

**Syntax:** Maximum Splits Per Tree( number )

**Description:** Sets the maximum number of splits per tree.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Minimum Size Split( 10 ),
    Portion Bootstrap( 1 ),
    Maximum Splits Per Tree( 5 ),
    Go
);


```

### [Method](#method)

**Syntax:** Method( "Bootstrap Forest" )

**Description:** Determines the method used for partitioning the data. Decision Tree is the default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Minimum Size Split](#minimum-size-split)

**Syntax:** Minimum Size Split( number )

**Description:** Sets the minimum number of observations for considering splits used in the estimate. Default is 5.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Minimum Size Split( 10 ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Minimum Splits per Tree](#minimum-splits-per-tree)

**Syntax:** Minimum Splits Per Tree( number )

**Description:** Sets the minimum number of splits per tree. Default is 10.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Multithreading](#multithreading)

**Syntax:** Multithreading( state=0|1 )

**Description:** Divides up the calculations among the available threads on the machine. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Split Best( 2 )
);


```

### [Number Terms](#number-terms)

**Syntax:** Number Terms( number )

**Description:** Sets the number of terms sampled per split. Default is floor(nX/4) where "nX" is the number of X columns.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Number Trees](#number-trees)

**Syntax:** Number Trees( number )

**Description:** Sets the number of trees in the forest. Default is 100.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Ordinal Restricts Order](#ordinal-restricts-order)

**Syntax:** obj = Bootstrap Forest(...Ordinal Restricts Order( state=0|1 )...)

**Description:** For ordinal columns, considers only splits that preserve order. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Boosted Tree( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Partition( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ) );
obj << Split Best( 3 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Ordinal Restricts Order( 1 ),
    Split Best( 2 )
);


```

### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides a plot using the training data with the predicted values on the X axis and actual values on the Y axis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Plot Actual by Predicted( 1 );


```

### [Portion Bootstrap](#portion-bootstrap)

**Syntax:** Portion( fraction )

**Description:** Sets the portion of the population sampled for the bootstrap sample. Default is 1.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Go
);
obj << Precision Recall Curve( 1 );


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Go
);
obj << Split Best( 5 );
obj << Profiler( 1 );


```

### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Publish Prediction Formula;


```

### [Publish Tolerant Prediction Formula](#publish-tolerant-prediction-formula)

**Syntax:** obj \<< Publish Tolerant Prediction Formula

**Description:** Builds a prediction formula that predicts even when there are missing values and publishes it as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Publish Tolerant Prediction Formula;


```

### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Go
);
obj << ROC Curve( 1 );


```

### [Save Cumulative Details](#save-cumulative-details)

**Syntax:** obj \<< Save Cumulative Details

**Description:** Saves the validation RSquare along with the tree number in a new data table. Available only when using a validation column.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Cumulative Details;


```

### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds

**Description:** Saves the predicted values in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Predicteds;


```

### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the prediction formula in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Prediction Formula;


```

### [Save Residuals](#save-residuals)

**Syntax:** obj \<< Save Residuals

**Description:** Saves the residuals in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Residuals;


```

### [Save Tolerant Prediction Formula](#save-tolerant-prediction-formula)

**Syntax:** obj \<< Save Tolerant Prediction Formula

**Description:** Save a formula that predicts even when there are missing values in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Tolerant Prediction Formula;


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number )

**Description:** Specifies a random seed to reproduce the results for future launches of the platform.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

### [Show Trees](#show-trees)

**Syntax:** obj \<< Show Trees( "None"|"Show names"|"Show names categories"|"Show names categories estimates" )

**Description:** Shows a list of individual trees, with names only, names and categories, or names, categories and estimates at each node.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Show Trees( Show names categories );
(obj << Report)["Tree Views"] << Close( 0 );
(obj << Report)["Tree12"] << Close( 0 );


```

### [Specify Profit Matrix](#specify-profit-matrix)

**Syntax:** obj \<< Specify Profit Matrix

**Description:** Enables you to specify profits or costs associated with correct or incorrect classification decisions.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Specify Profit Matrix(
        [1 -1 -1, -1 1 -1, -1 -1 1, . . .],
        "American",
        "European",
        "Japanese",
        "Undecided"
    ),
    Go
);


```

### [Time Limit](#time-limit)

**Syntax:** Time Limit( number )

**Description:** Sets the time limit for iterating. Number is the limit in seconds to stop adding trees.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Minimum Size Split( 10 ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Time Limit( 10 ),
    Go
);


```

### [Tuning Design Table](#tuning-design-table)

**Syntax:** Tuning Design Table( "table name" )

**Description:** A table of tuning parameters to run with, supporting: Number Terms, Minimum Split Per Tree, Maximum Split Per Tree, Number Trees, Portion Bootstrap, Minimum Size Split

### [Use Excluded Rows for Validation](#use-excluded-rows-for-validation)

**Syntax:** obj = Bootstrap Forest(...Use Excluded Rows for Validation( state=0|1 )...)

**Description:** Uses the excluded rows in the data table to create a validation set. This option appears in the launch window only if you are using standard JMP and there are excluded rows.

**JMP Version Added:** 15

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 )
);
obj << Split Best( 5 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Use Excluded Rows for Validation( 1 ),
    Split Best( 2 )
);


```

### [Validation Portion](#validation-portion)

**Syntax:** obj = Bootstrap Forest(...Validation Portion( fraction=0 )...)

**Description:** Forms a validation set by randomly selecting rows with each row having probability p (fraction) of being selected. "0" by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :country, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 )
);
obj << Split Best( 2 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation Portion( 0.2 ),
    Go
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Bootstrap Forest(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Bubble Plot](#bubble-plot)

## [Associated Constructors](#associated-constructors)

### [Bubble Plot](#bubble-plot_1)

**Syntax:** Bubble Plot( X( column ), Y( column ), \<Sizes( column )>, \<Time( column )>, \<ID( column )>, \<Coloring( column ) )

**Description:** Produces a two-dimensional scatterplot of bubbles that can be animated over a time variable. Additional variables can be used to size and color the bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Bubble Plot(...\<By( column(s) )>...)

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Coloring](#coloring)

**Syntax:** obj = Bubble Plot(...\<Coloring( column )>...)

**Description:** Colors the bubbles according to the selected variable.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Coloring( :Pop )
);


```

### [Freq](#freq)

**Syntax:** obj = Bubble Plot(...\<Freq( column )>...)

**Description:** Weights computations when computing position, size, and colors of bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
dtSummary = dt << Summary(
    Group( :Country ),
    Mean( :"Portion 0-19"n ),
    Mean( :"Portion60+"n ),
    Sum( :Pop ),
    Freq( "None" ),
    Weight( "None" )
);
dtSummary << Bubble Plot(
    X( :"Mean(Portion 0-19)"n ),
    Y( :"Mean(Portion60+)"n ),
    Sizes( :"Sum(Pop)"n ),
    Freq( :N Rows )
);


```

### [ID](#id)

**Syntax:** obj = Bubble Plot(...\<ID( column(s) )>...)

**Description:** Identify rows that should be aggregated and shown as a single bubble.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);


```

### [Sizes](#sizes)

**Syntax:** obj = Bubble Plot(...\<Sizes( column )>...)

**Description:** Column to use as the size of the bubbles. If not specified, bubble size is proportional to the number of observations.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);


```

### [Time](#time)

**Syntax:** obj = Bubble Plot(...\<Time( column )>...)

**Description:** Maintains separate coordinates, sizes, and colors for each unique time period.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Region, :Country ),
    Time( :Year )
);


```

### [X](#x)

**Syntax:** obj = Bubble Plot(...X( column )...)

**Description:** Column to use as the x coordinate of the bubbles in the plot.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);


```

### [Y](#y)

**Syntax:** obj = Bubble Plot(...Y( column )...)

**Description:** Column to use as the y coordinate of the bubbles in the plot.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);


```

## [Item Messages](#item-messages)

### [Auto Stretching](#auto-stretching)

**Syntax:** obj \<< Auto Stretching( "Auto"|"On"|"Off" )

**Description:** Sets the auto stretching behavior of the report.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Auto Stretching( "Off" );


```

### [Bubble Size](#bubble-size)

**Syntax:** obj \<< Bubble Size( number )

**Description:** Changes the size of the bubbles on the scatterplot.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Bubble Size( 50 );


```

### [Color Levels](#color-levels)

**Syntax:** obj \<< Color Levels

**Description:** Set the levels for the continuous legend.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Coloring( :Pop )
);
obj << Color Levels( [100000 1000000 10000000] );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

**Description:** Sets the color theme of the bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year ),
    Coloring( :Region )
);
obj << Color Theme( "White to Red" );


```

### [Color as Sum](#color-as-sum)

**Syntax:** obj \<< Color as Sum( state=0|1 )

**Description:** Uses the sum of the Color variable rather than the mean of the Color variable as the Color role.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Time( :Year ),
    Coloring( :Pop ),
    ID( :Region )
);
obj << Color as Sum( 1 );


```

### [Combine](#combine)

**Syntax:** obj \<< Combine( <id> )

**Description:** Combines the selected bubbles (or given ID) in a group into their larger bubble. This option is only available when two ID variables are used.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Region, :Country ),
    Time( :Year )
);
dt << Select Where( :Region == "Europe" );
obj << Split;
Wait( 2 );
obj << Combine( "Europe" );


```

### [Combine All](#combine-all)

**Syntax:** obj \<< Combine All

**Description:** Combines all constituent bubbles in a group into their larger bubble. This option is only available when two ID variables are used.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Region, :Country ),
    Time( :Year )
);
obj << Split All;
Wait( 2 );
obj << Combine All;


```

### [Draw](#draw)

**Syntax:** obj \<< Draw( "Filled"|"Outlined"|"Filled and Outlined" )

**Description:** Set the display mode for the bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Draw( "Outlined" );


```

### [Fit to Window](#fit-to-window)

**Syntax:** obj \<< Fit to Window( "Auto"|"On"|"Off" )

**Description:** Sets the auto stretching behavior of the report.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Fit to Window( "Off" );


```

### [Get Custom Path](#get-custom-path)

**Syntax:** obj \<< Get Custom Path

**Description:** Returns the custom path for the bubbles as a matrix. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Set Custom Path( "M-1,-1 L-1,1 L0,0.5 L1,1 L1,-1 L0,-0.5 L-1,-1 Z" );
obj << Set Shape( "Custom" );
obj << Get Custom Path();


```

### [Get Draw](#get-draw)

**Syntax:** obj \<< Get Draw

**Description:** Returns the display mode for the bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Get Draw();


```

### [Get Label](#get-label)

**Syntax:** obj \<< Get Label

**Description:** Returns the mode for drawing bubble labels.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Get Label();


```

### [Get Shape](#get-shape)

**Syntax:** obj \<< Get Shape

**Description:** Returns the shape for the bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Set Shape( "Triangle" );
obj << Get Shape();


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Initiates the animation when a Time variable is used.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( (:Country == 3300) | (:Country == 4120) );
obj << Go;


```

### [Label](#label)

**Syntax:** obj \<< Label( "None"|"Selected"|"All" )

**Description:** Set the mode for drawing bubble labels.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Label( "All" );


```

### [Label Offset](#label-offset)

**Syntax:** obj \<< Label Offset( {pt, x offset, y offset}, ... )

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Region, :Country ),
    Time( :Year )
);
dt << Select Where( :Region == "Europe" | :Region == "North America" );
obj << Label Offset( {4, -75, -43}, {7, 80, -34} );


```

### [Legend](#legend)

**Syntax:** obj \<< Legend( state=0|1 )

**Description:** Displays the color legend when a coloring column is used. On by default.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year ),
    Coloring( :Region )
);
obj << Legend( 1 );


```

### [Lock Scales](#lock-scales)

**Syntax:** obj \<< Lock Scales( state=0|1 )

**Description:** Locks axis, gradient, and size ranges so they do not change in response to data or filtering changes. On by default.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Lock Scales( 0 );
dt << Data Filter(
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) ),
    Add Filter( Columns( :Region ) )
);


```

### [Orient Shapes](#orient-shapes)

**Syntax:** obj \<< Orient Shapes( state=0|1 )

**Description:** Orient the shape so that the top points in the direction of the movement.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
obj << Set Shape( "Triangle" );
obj << Orient Shapes( 1 );


```

### [Prev](#prev)

**Syntax:** obj \<< Prev

**Description:** Moves the Time variable one step backward in the animation.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( (:Country == 3300) | (:Country == 4120) );
obj << Time Index( 19 );
obj << Prev;


```

### [Revert Color Theme](#revert-color-theme)

**Syntax:** obj \<< Revert Color Theme

**Description:** Reverts the custom color theme, returning to the default theme from column properties or preferences.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year ),
    Coloring( :Region )
);
obj << Color Theme( "White to Red" );
Wait( 2 );
obj << Revert Color Theme();


```

### [Selectable Across Gaps](#selectable-across-gaps)

**Syntax:** obj \<< Selectable Across Gaps( state=0|1 )

**Description:** Allows bubbles to be selectable and keeps the bubble selected during time periods where data is missing. When this option is off, bubbles are not selectable during time periods where data is missing.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( :Country == 3300 );
obj << Selectable Across Gaps( 1 );
obj << Trail Bubbles( 1 );
obj << Go;


```

### [Set Custom Path](#set-custom-path)

**Syntax:** obj \<< Set Custom Path

**Description:** Set the custom path for the bubbles. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Set Custom Path( "M-1,-1 L-1,1 L0,0.5 L1,1 L1,-1 L0,-0.5 L-1,-1 Z" );
obj << Set Shape( "Custom" );


```

### [Set Shape](#set-shape)

**Syntax:** obj \<< Set Shape( "Circle"|"Triangle"|"Square"|"Diamond"|"Arrow"|"Custom" )

**Description:** Set the shape for the bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Set Shape( "Triangle" );


```

### [Show Roles](#show-roles)

**Syntax:** obj \<< Show Roles( state=0|1 )

**Description:** Displays the variables used for each role in a legend across the top of the report.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year ),
    Coloring( :Region )
);
obj << Show Roles( 1 );


```

### [Show Time Annotation](#show-time-annotation)

**Syntax:** obj \<< Show Time Annotation( state=0|1 )

**Description:** Shows the current time as an annotation in an animated Bubble Plot. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year ),
    Coloring( :Region )
);
Wait( 1 );
obj << Show Time Annotation( 0 );


```

### [Size as Sum](#size-as-sum)

**Syntax:** obj \<< Size as Sum( state=0|1 )

**Description:** Uses the sum of the Size variable rather than the mean of the Size variable as the Size role. On by default.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Size as Sum( 1 );


```

### [Speed](#speed)

**Syntax:** obj \<< Speed( number )

**Description:** Changes the speed of the bubble movement over time.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( (:Country == 3300) | (:Country == 4120) );
obj << Speed( 100 );
obj << Go;


```

### [Split](#split)

**Syntax:** obj \<< Split( <id> )

**Description:** Splits the selected bubble (or given ID) into its constituent parts. This option is only available when two ID variables are used.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Region, :Country ),
    Time( :Year )
);
dt << Select Where( :Region == "Europe" );
Wait( 2 );
obj << Split;
Wait( 2 );
obj << Split( "Asia" );


```

### [Split All](#split-all)

**Syntax:** obj \<< Split All

**Description:** Splits all bubbles into their constituent parts. This option is only available when two ID variables are used.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Region, :Country ),
    Time( :Year )
);
Wait( 2 );
obj << Split All;


```

### [Step](#step)

**Syntax:** obj \<< Step

**Description:** Moves the Time variable one step forward in the animation.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( (:Country == 3300) | (:Country == 4120) );
obj << Step;


```

### [Stop](#stop)

**Syntax:** obj \<< Stop

**Description:** Stops the animation when a Time variable is used.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( :Country == 4120 );
obj << Go;
Wait( 2 );
obj << Stop;


```

### [Time Index](#time-index)

**Syntax:** obj \<< Time Index( number )

**Description:** Sets the value of the Time variable on the scatterplot.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
obj << Time Index( 19 );


```

### [Title Position](#title-position)

**Syntax:** obj \<< Title Position( X,Y )

**Description:** Sets the position of the title. A Time variable must be specified to see this option.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
obj << Title Position( 0.8, 0.06 );


```

### [Toggle Animation](#toggle-animation)

**Syntax:** obj \<< Toggle Animation

**Description:** Toggles the current animation state

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( :Country == 4120 );
obj << Go;
Wait( 2 );
obj << Toggle Animation;


```

### [Trail Bubbles](#trail-bubbles)

**Syntax:** obj \<< Trail Bubbles( "None"|"Selected"|"All" )

**Description:** Shows the past history of bubbles as a semi-transparent trail. To show trail bubbles, a Time column must be specified and a bubble must first be selected.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( (:Country == 3300) | (:Country == 4120) );
obj << Trail Bubbles( 1 );
obj << Go;


```

### [Trail Lines](#trail-lines)

**Syntax:** obj \<< Trail Lines( "None"|"Selected"|"All" )

**Description:** Shows the past history of bubbles as connected line segments. To show trail bubbles, a Time column must be specified and a bubble must first be selected.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    Time( :Year )
);
dt << Select Where( (:Country == 3300) | (:Country == 4120) );
obj << Trail Lines( 1 );
obj << Go;


```

### [X as Sum](#x-as-sum)

**Syntax:** obj \<< X as Sum( state=0|1 )

**Description:** Uses the sum of the X variable rather than the mean of the X variable as the X role.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << X as Sum( 1 );


```

### [Y as Sum](#y-as-sum)

**Syntax:** obj \<< Y as Sum( state=0|1 )

**Description:** Uses the sum of the Y variable rather than the mean of the Y variable as the Y role.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Y as Sum( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Bubble Plot(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [CUSUM Control Chart](#cusum-control-chart)

## [Associated Constructors](#associated-constructors)

### [CUSUM Control Chart](#cusum-control-chart_1)

**Syntax:** CUSUM Control Chart( Y( column ), \<X( column )>, \<By( column )>, \<Data Units( 0|1 )>, \<Show Excluded Region( 0|1 )> )

**Description:** Creates a chart that plots the cumulative sums of deviations of subgroup means from a target. This chart is also called a tabular CUSUM chart.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** By( column )

**Description:** Specifies the By column during launch.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << CUSUM Control Chart( Y( :DIAMETER ), X( :DAY ), By( :Phase ) );


```

### [X](#x)

**Syntax:** X( column )

**Description:** Specifies the X column during launch.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    X( :hour ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);


```

### [Y](#y)

**Syntax:** Y( column )

**Description:** Specifies the Y column during launch.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);


```

## [Item Messages](#item-messages)

### [ARL Profiler](#arl-profiler)

**Syntax:** obj \<< ARL Profiler( state=0|1 )

**Description:** Shows or hides an interactive profiler for the Average Run Length as parameters change.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << ARL Profiler( 1 );


```

### [Alarm Script](#alarm-script)

**Syntax:** Alarm Script(Write("...")|Speak("...")|Mail(address, subject,"...") )

**Description:** Sends a message whenever a point on a control chart fails a given test. The message can be sent to the log, can be spoken, or can be emailed.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Alarm Script(
        Write(
            "Out of Control for test ",
            qc_test,
            " in column ",
            qc_col,
            " in sample ",
            qc_sample,
            ". \!N"
        )
    ),
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Test Beyond Limits( 1 );


```

### [Control Panel](#control-panel)

**Syntax:** obj \<< Control Panel( state=0|1 )

**Description:** Shows or hides a report that contains the current values of the parameters and enables you to change them. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
Wait( 1 );
obj << Control Panel( 0 );


```

### [Data Units](#data-units)

**Syntax:** obj = CUSUM Control Chart(...Data Units( state=0|1 )...)

**Description:** Specifies that data units are used in the report rather than standard deviation units.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 0.1 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    Data Units( 1 )
);


```

### [Get Limits](#get-limits)

**Syntax:** obj \<< Get Limits

**Description:** Imports control limits from a selected data table and replaces calculated limits on the chart.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
limitsTable = New Table( "Cusum Limits",
    Add Rows( 4 ),
    New Column( "_LimitsKey", Character, Set Values( {"_H", "_K", "_Std Dev", "_Mean"} ) ),
    New Column( "weight", Set Values( [4, 0.5, 0.01, 8.1] ) )
);
Wait();
obj << Get Limits( limitsTable );


```

### [H](#h)

**Syntax:** obj \<< H( number=5 )

**Description:** Specifies the value of the parameter that defines the limits. If the Data Units option was not specified, this is the h parameter. If the Data Units option was specified, this is the H parameter. Note that H is equal to h times Sigma. "5" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << H( 4.5 );


```

### [Head Start](#head-start)

**Syntax:** obj \<< Head Start( number )

**Description:** Specifies the value of the cumulative sums before the first sample. Starting the cumulative sums at a nonzero value increases the sensitivity of the CUSUM chart near the beginning of the samples. This parameter is also known as the fast initial response (FIR) value. By default, this parameter is set to 0.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Head start( 1.0 );


```

### [K](#k)

**Syntax:** obj \<< K( number=0.5 )

**Description:** Specifies the value of the parameter that defines the smallest change in the mean that is valuable to detect. If the Data Units option was not specified, this is the k parameter. If the Data Units option was specified, this is the K parameter. Note that K is equal to k times Sigma. "0.5" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << K( 0.1 );


```

### [Lower Side](#lower-side)

**Syntax:** obj \<< Lower Side( state=0|1 )

**Description:** Shows or hides the negative values for the cumulative sum on the chart. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Lower Side( 0 );


```

### [Parameters Report](#parameters-report)

**Syntax:** obj \<< Parameters Report( state=0|1 )

**Description:** Shows or hides the parameters report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Parameters Report( 1 );


```

### [Reset to Defaults](#reset-to-defaults)

**Syntax:** obj \<< Reset to Defaults

**Description:** Resets all parameters back to the default values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << H( 3 );
Wait( 1 );
obj << Reset to Defaults();


```

### [Save Limits](#save-limits)

**Syntax:** obj \<< Save Limits( "in Column"|"in New Table" )

**Description:** Saves chart parameters to either a column property or a new data table.

If in Column is specified, the Avg is saved in a Control Limits column property.

If in New Table is specified, parameters h, k, the standard deviation, mean, and head start are saved to a new data table.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
Wait();
obj << Save Limits( "in Column" );
Wait();
obj << Save Limits( "in New Table" );


```

### [Save Sigma](#save-sigma)

**Syntax:** obj \<< Save Sigma

**Description:** Saves the sigma used in the control chart as a column property in the data table.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Save Sigma;


```

### [Save Summaries](#save-summaries)

**Syntax:** obj \<< Save Summaries

**Description:** Creates a new data table that contains statistics for each subgroup in the CUSUM chart.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Save Summaries;


```

### [Show ARL](#show-arl)

**Syntax:** obj \<< Show ARL( state=0|1 )

**Description:** Shows or hides a report with the Average Run Length computed from the associated CUSUM chart.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Show ARL( 1 );


```

### [Show Center Line](#show-center-line)

**Syntax:** obj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line on the graph. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Show Center Line( 0 );


```

### [Show Excluded Region](#show-excluded-region)

**Syntax:** obj = CUSUM Control Chart(...Show Excluded Region( state=0|1 )...)

**Description:** Specifies whether subgroups that are entirely excluded are shown on the horizontal axis in the CUSUM control chart. Applicable only when an X variable is specified.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << Select Rows( {31, 32, 33, 34, 35, 36, 37, 38, 39, 40} ) << exclude << hide;
obj = dt << CUSUM Control Chart( Y( :Gap ), Subgroup( :Sample ), Show Excluded Region( 0 ) );


```

### [Show Limits](#show-limits)

**Syntax:** obj \<< Show Limits( state=0|1 )

**Description:** Shows or hides the limits. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Show Limits( 0 );


```

### [Show Shift Lines](#show-shift-lines)

**Syntax:** obj \<< Show Shift Lines( state=0|1 )

**Description:** Shows or hides vertical lines that designate shifts in the chart. Shift lines are drawn at the start of a shift. Available only when there is a shift detected in the data. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
Wait( 1 );
obj << Show Shift Lines( 0 );


```

### [Sigma](#sigma)

**Syntax:** obj \<< Sigma( number )

**Description:** Specifies the known value of the standard deviation. By default, this parameter is set to the average moving range of the Y column. If there is an X variable, the Sigma parameter is set to the average moving range of the summary data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Sigma( 2 );


```

### [Target](#target)

**Syntax:** obj \<< Target( number )

**Description:** Specifies the known value of the mean. This is the value of the center line in the chart. By default, this parameter is set to the Target value in the Spec Limits column property for the Y column. If the Y column does not have a Target value in the Spec Limits column property, this parameter is set to the overall average of the Y column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Target( 9.5 );


```

### [Test Beyond Limits](#test-beyond-limits)

**Syntax:** obj \<< Test Beyond Limits( state=0|1 )

**Description:** Shows or hides a red circle around any point that is above the upper limit or below the lower limit in the CUSUM chart.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Test Beyond Limits( 1 );


```

### [Tune Chart](#tune-chart)

**Syntax:** obj \<< Tune Chart( \<0|1> | Min( value, Max( value ) ) )

**Description:** Shows or hides a control that enables you to set the value of the k parameter by specifying an acceptable range for the Y variable. In a script, you can also specify the acceptable range directly.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Tune Chart( Min( 8.08, Max( 8.12 ) ) );


```

### [Upper Side](#upper-side)

**Syntax:** obj \<< Upper Side( state=0|1 )

**Description:** Shows or hides the positive values for the cumulative sum on the chart. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Upper Side( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Relaunch Analysis;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = CUSUM Control Chart(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Categorical](#categorical)

## [Associated Constructors](#associated-constructors)

### [Categorical](#categorical_1)

**Syntax:** Categorical( Responses | Aligned Responses | Repeated Measures | Rater Agreement | Multiple Response | Multiple Response by ID | Multiple Delimited | Indicator Group | Response Frequencies( column ), X( column(s) ) )

**Description:** Summarizes and analyzes categorical response data. Data can be simple responses, multiple responses, repeated measures, rater agreement, aligned responses, or free text. Includes the ability to generate custom cross tabulations of responses.

#### [Aligned Responses](#aligned-responses)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured(
        Empty(),
        Empty(),
        Aligned Responses(
            :I am working on my career, :I want to see the world,
            :My home needs some major improvements, :I have vast interests outside of work,
            :I want to get my debt under control, :I come from a large family
        )
    )
);


```

#### [Multiple Response (Structured)](#multiple-response-structured)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical( Structured( :Gender, :Brush Delimited + :Floss Delimited ) );


```

#### [Multiple Response with Nested Groups](#multiple-response-with-nested-groups)

```


dt = Open( "$SAMPLE_DATA/Quality Control/Failure3MultipleField.jmp" );
Categorical( X( :clean, :date ), Multiple Response( :Failure1, :Failure2, :Failure3 ) );


```

#### [Nested within Individual Factors](#nested-within-individual-factors)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured(
        :Single Status * :Gender + :School Age Children * :Gender,
        :I am working on my career + :I want to see the world
    )
);


```

#### [One Response by Two Nested Factors](#one-response-by-two-nested-factors)

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );


```

#### [Rater Agreement](#rater-agreement)

```


dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
Categorical( Rater Agreement( :A, :B, :C ) );


```

#### [Repeated Measures](#repeated-measures)

```


dt = Open( "$SAMPLE_DATA/Presidential Elections.jmp" );
Categorical(
    Repeated Measures(
        :"1980 Winner"n, :"1984 Winner"n, :"1988 Winner"n, :"1992 Winner"n, :"1996 Winner"n,
        :"2000 Winner"n, :"2004 Winner"n, :"2008 Winner"n, :"2012 Winner"n
    )
);


```

#### [Three Responses by Two Individual Factors (Structured)](#three-responses-by-two-individual-factors-structured)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured(
        :I am working on my career + :I want to see the world,
        :Gender + :Single Status + :Age Group
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    Freq( :_freqcol )
);


```

### [Grouping Category](#grouping-category)

**Syntax:** obj \<< Grouping Category( column(s) )

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );


```

### [ID](#id)

**Syntax:** obj \<< ID( column )

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );


```

### [Sample Size](#sample-size)

**Syntax:** obj \<< Sample Size( column )

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );


```

## [Item Messages](#item-messages)

### [Agreement Statistic](#agreement-statistic)

**Syntax:** obj \<< Agreement Statistic( state=0|1 )

**Description:** Tests how closely raters agree with one another and if the lack of agreement is symmetrical. Available only for a Rater Agreement response. On by default.

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Categorical(
    Rater Agreement( :First Survey, :Second Survey ),
    Freq( :Count ),
    Agreement Statistic( 0 )
);
Wait( 1 );
obj << Agreement Statistic( 1 );


```

### [Aligned Responses](#aligned-responses_1)

**Syntax:** obj = Categorical(...Aligned Responses( columns )...)

**Description:** Summarizes data from multiple columns that have the same response levels in a single report.

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Categorical( Aligned Responses( :First Survey, :Second Survey ), Freq( :Count ) );


```

### [Arrange in Rows](#arrange-in-rows)

**Syntax:** obj \<< Arrange in Rows( number )

**Description:** Arranges the reports so that they go across the page. Specify the number of reports to appear in each row.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    Responses( :country ),
    Legend( 0 ),
    Arrange in Rows( 2 )
);
Wait( 1 );
obj << Arrange in Rows( 1 );


```

### [Binomial](#binomial)

**Syntax:** obj \<< Binomial( state=0|1 )

**Description:** Performs a chi-square test of independence of response levels assuming a binomial distribution for each category. Note: Available only for multiple responses.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( Multiple Response( :country, :size ), X( :sex, :marital status ) );
obj << Homogeneity Test( 1 );


```

### [Cell Chisq](#cell-chisq)

**Syntax:** obj \<< Cell Chisq( state=0|1 )

**Description:** Shows or hides p-values for each cell in the table for a chi-square test of independence. The p-values are colored and shaded according to whether the count is larger or smaller than the expected count.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :size ), Responses( :country ) );
obj << Cell Chisq( 1 );


```

### [Cell Chisq FDR](#cell-chisq-fdr)

**Syntax:** obj \<< Cell Chisq FDR( state=0|1 )

**Description:** Shows or hides false discovery rate (FDR) adjusted p-values for each cell in the table for a chi-square test of independence. The FDR adjusted p-values are colored and shaded according to whether the count is larger or smaller than the expected count.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :size ), Responses( :country ) );
obj << Cell Chisq( 1 );


```

### [ChiSquare Test Choices](#chisquare-test-choices)

**Syntax:** obj \<< ChiSquare Test Choices( "Both LR and Pearson"|"LR Only"|"Pearson Only" )

**Description:** Specifies which tests are displayed in the tests for homogeneity, either the Likelihood Ratio Chi-Squared, the Pearson Chi-Squared, or both. Available only for a single response.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << ChiSquare Test Choices( "Pearson Only" );
obj << Test Response Homogeneity( 1 );


```

### [Compare Each Cell](#compare-each-cell)

**Syntax:** obj \<< Compare Each Cell( state=0|1 )

**Description:** Compares each level of the response versus all other levels combined across levels of a grouping variable.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical( X( :Employee Tenure ), Responses( :Job Satisfaction ) );
obj << Compare Each Cell( 1 );


```

### [Compare Each Cell FDR](#compare-each-cell-fdr)

**Syntax:** obj \<< Compare Each Cell FDR( state=0|1 )

**Description:** Compares each level of the response versus all other levels combined across levels of a grouping variable, with false discovery rate (FDR) adjustment.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical( X( :Employee Tenure ), Responses( :Job Satisfaction ) );
obj << Compare Each Cell FDR( 1 );


```

### [Compare Each Sample](#compare-each-sample)

**Syntax:** obj \<< Compare Each Sample( state=0|1 )

**Description:** Compares responses across levels of a grouping variable.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical( X( :Age Group ), Responses( :I am working on my career ) );
obj << Compare Each Sample( 1 );


```

### [Compare Each Sample FDR](#compare-each-sample-fdr)

**Syntax:** obj \<< Compare Each Sample FDR( state=0|1 )

**Description:** Compares responses across levels of a grouping variable with false discovery rate (FDR) adjustment.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical( X( :Age Group ), Responses( :I am working on my career ) );
obj << Compare Each Sample FDR( 1 );


```

### [Conditional Association](#conditional-association)

**Syntax:** obj \<< Conditional Association( state=0|1 )

**Description:** Shows or hides the rate of having a response in a column given the same response in a row. Available only for Multiple Response, Multiple Delimited, and Multiple Response by ID models with Unique Occurrences within ID selected.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    ID( :Response ID ),
    Unique Occurrences within ID( 1 ),
    Structured( :Brush, :Brush Delimited ),
    Share Chart( 0 ),
    Legend( 0 ),
    Conditional Association( 1 )
);


```

### [Confidence Interval Coverage](#confidence-interval-coverage)

**Syntax:** obj = Categorical(...Confidence Interval Coverage( number=0.95 )...)

**Description:** Sets the coverage of confidence intervals for rates and share of responses. The coverage is equal to (1-alpha). "0.95" by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    X( :Age Group ),
    Responses( :I am working on my career ),
    Confidence Interval Coverage( 0.99 ),
    Share Confidence Interval( 1 )
);


```

### [Confidence Limits Format](#confidence-limits-format)

**Syntax:** obj \<< Confidence Limits Format( format, <options> )

**Description:** Formats the confidence limits for Share and Rate in the table. The default value is "Percent", 6, 2.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    X( :Age Group ),
    Responses( :I am working on my career ),
    Confidence Interval Coverage( 0.99 ),
    Share Confidence Interval( 1 )
);
Wait( 1 );
obj << Confidence Limits Format( "Percent", 6, 0 );


```

### [Contents Summary](#contents-summary)

**Syntax:** obj \<< Contents Summary( state=0|1 )

**Description:** Collects all tests and p-values into one report.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Contents Summary( 1 );


```

### [Count Missing Responses](#count-missing-responses)

**Syntax:** obj = Categorical(...Count Missing Responses( state=0|1 )...)

**Description:** Includes missing values as a response category.

```

dt = Open( "$SAMPLE_DATA/Missing Data Pattern.jmp" );
Categorical( X( :Trial 1 ), Count Missing Responses( 1 ), Responses( :Trial 4 ) );


```

### [Count Test](#count-test)

**Syntax:** obj \<< Count Test( state=0|1 )

**Description:** Performs a chi-square test of independence of rates using Poisson regression. Note: Available only for multiple responses.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( Multiple Response( :country, :size ), X( :sex, :marital status ) );
obj << Count Test( 1 );


```

### [Crosstab](#crosstab)

**Syntax:** obj \<< Crosstab( state=0|1 )

**Description:** Generates a cross tabulation of counts with the response levels defining the columns and the grouping variable levels defining the rows. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Crosstab Transposed( 1 );
obj << Crosstab( 1 );


```

### [Crosstab Transposed](#crosstab-transposed)

**Syntax:** obj \<< Crosstab Transposed( state=0|1 )

**Description:** Generates a cross tabulation of counts with the response levels defining the rows and the grouping variable levels defining the columns.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Crosstab Transposed( 1 );


```

### [Exclude Nonresponses](#exclude-nonresponses)

**Syntax:** obj \<< Exclude Nonresponses( state=0|1 )

**Description:** Excludes nonresponses for count and homogeneity tests when comparing multiple response categories. Empty or missing cells are treated as nonresponses. Using a separate category for none-of-these is recommended.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Color Preference Survey.jmp" );
obj = dt << Categorical(
    Structured( :"What is your gender ? "n, :"What colors do you like? (with nonresponse)"n ),
    Share Chart( 0 ),
    Homogeneity Test( 1 )
);
Wait( 1 );
obj << Exclude Nonresponses( 1 );


```

### [FDR Adjusted PValues](#fdr-adjusted-pvalues)

**Syntax:** obj \<< FDR Adjusted PValues( state=0|1 )

**Description:** False discovery rate adjusted p-values (Benjamini and Hochberg, 1995) are used when there are many p-values and it becomes easy for some tests to be significant by chance alone.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    Structured( :I am working on my career, :Age Group * :Employee Tenure ),
    Share Chart( 0 ),
    Test Response Homogeneity( 1 )
);
obj << FDR Adjusted PValues( 1 );


```

### [Filter](#filter)

**Syntax:** obj \<< Filter( state=0|1 )

**Description:** Filters data to specific groups or ranges, locally.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical(
    Responses( :country ),
    Legend( 0 ),
    Local Data Filter(
        Location( {634, 43} ),
        Mode( Select( 0 ), Show( 1 ), Include( 1 ) ),
        Add Filter( columns( :sex ), Where( :sex == "Female" ) )
    )
);
Wait( 1.0 );
obj << Filter( 0 );


```

### [Force Crosstab Shading](#force-crosstab-shading)

**Syntax:** obj \<< Force Crosstab Shading( state=0|1 )

**Description:** Uses shading on Crosstab reports even if Global Preferences are set not to shade. On by default.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Force Crosstab Shading( 0 );
Wait( 1 );
obj << Force Crosstab Shading( 1 );


```

### [Force Labels Horizontal](#force-labels-horizontal)

**Syntax:** obj \<< Force Labels Horizontal( state=0|1 )

**Description:** Uses horizontal labels on the crosstab table regardless of the length of the text. The label text is wrapped rather than rotated.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical( X( :Employee Tenure ), Responses( :Job Satisfaction ) );
Wait( 1 );
obj << Force Labels Horizontal( 1 );


```

### [Format Elements](#format-elements)

**Syntax:** obj \<< Format Elements

**Description:** Opens a window that enables you to specify formats for various elements of the report.

### [Frequencies](#frequencies)

**Syntax:** obj \<< Frequencies( state=0|1 )

**Description:** Shows or hides the Frequency table in the report. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    Frequencies( 0 )
);
Wait( 1 );
obj << Frequencies( 1 );


```

### [Frequencies Format](#frequencies-format)

**Syntax:** obj \<< Frequencies Format( format, <options> )

**Description:** Formats the Frequency values in the table. The default value is "Fixed Dec", 7, 0.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
Wait( 1 );
obj << Frequencies Format( "Fixed Dec", 7, 2 );


```

### [Frequency Chart](#frequency-chart)

**Syntax:** obj \<< Frequency Chart( state=0|1 )

**Description:** Shows or hides the Frequency Chart in the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Frequency Chart( 1 );


```

### [Grouping Option](#grouping-option)

**Syntax:** obj = Categorical(...Grouping Option( "Combinations"|"Each Individually"|"Both" )...)

**Description:** Sets the grouping method for the X variables.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical(
    X( :sex, :marital status ),
    Aligned Responses( :country, :size ),
    Grouping Option( Each Individually )
);


```

### [Hide Nonsignificant](#hide-nonsignificant)

**Syntax:** obj \<< Hide Nonsignificant( state=0|1 )

**Description:** Suppresses reports that are non-significant.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    Grouping Option( Each Individually ),
    X( :Age Group, :School Age Children ),
    Responses( :I am working on my career ),
    Responses( :My home needs some major improvements ),
    Responses( :I have vast interests outside of work ),
    Responses( :I come from a large family ),
    Crosstab Transposed( 1 ),
    Test Response Homogeneity( 1 )
);
obj << Hide Nonsignificant( 1 );


```

### [Highlight Cells](#highlight-cells)

**Syntax:** obj \<< Highlight Cells

**Description:** Highlights the cells that satisfy the specified conditions.

#### [Highlight by Category](#highlight-by-category)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured( :Position Tenure + :Age Group, :I am working on my career + :Brush ),
    Mean Score( 1 ),
    Highlight Cells( Share >= 0.5, Color( "Magenta" ), Category( "30-34" ) ),
    Highlight Cells( Share >= 0.46, Color( "Green" ), Category( "5 to 10 years" ) ),
    Highlight Cells( Share < 0.5, Color( "Blue" ), Category( "Agree" ) ),
    Highlight Cells( Mean Score <= 2, Color( "Yellow" ), Category( "25-29" ) )
);


```

#### [Highlight by Column](#highlight-by-column)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured( :Position Tenure + :Age Group, :I am working on my career + :Brush ),
    Mean Score( 1 ),
    Highlight Cells( Share >= 0.5, Column( :Age Group ) ),
    Highlight Cells( Share >= 0.46, Color( "Fuchsia" ), Column( :Brush ) )
);


```

#### [Highlight by Highest and Lowest in Table](#highlight-by-highest-and-lowest-in-table)

```


dt = Open( "$SAMPLE_DATA/Quality Control/Failures3Delimited.jmp" );
Categorical(
    ID( :ID ),
    X( :clean, :date ),
    Multiple Delimited( :failures ),
    Share Chart( 1 ),
    Highlight Cells( Highest in Table( Freq ), Color( "Green" ) ),
    Highlight Cells( Lowest in Table( Freq ), Color( "Purple" ) )
);


```

#### [Highlight by Highest Response and Highest Sample](#highlight-by-highest-response-and-highest-sample)

```


dt = Open( "$SAMPLE_DATA/Quality Control/Failures3Delimited.jmp" );
obj = dt << Categorical(
    Multiple Delimited( :failures ),
    ID( :ID ),
    X( :clean, :date ),
    Highlight Cells( Highest Response( Share ), Color( "Green" ) ),
    Highlight Cells( Highest Sample( Share ), Color( "Purple" ) )
);


```

#### [Highlight by Lowest Response and Lowest Sample](#highlight-by-lowest-response-and-lowest-sample)

```


dt = Open( "$SAMPLE_DATA/Quality Control/Failures3Delimited.jmp" );
obj = dt << Categorical(
    Multiple Delimited( :failures ),
    ID( :ID ),
    X( :clean, :date ),
    Highlight Cells( Lowest Response( Share ), Color( "Green" ) ),
    Highlight Cells( Lowest Sample( Share ), Color( "Purple" ) )
);


```

#### [Highlight by Mean Score and Share](#highlight-by-mean-score-and-share)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    X( :Gender, :Age Group ),
    Responses( :Job Satisfaction ),
    Responses( :I am working on my career ),
    Mean Score( 1 ),
    Mean Std Error( 1 ),
    Mean Confidence Interval( 1 ),
    Std Dev Score( 1 ),
    Share Chart( 0 ),
    Highlight Cells( Mean Score > 2.3, Color( "Blue" ) ),
    Highlight Cells( Share >= 0.6, Color( "Cyan" ) ),
    Highlight Cells( Share > 0.7, Color( "Green" ) )
);


```

### [Homogeneity Test](#homogeneity-test)

**Syntax:** obj \<< Homogeneity Test( state=0|1 )

**Description:** Performs a chi-square test of independence of response levels assuming a binomial distribution for each category. Note: Available only for multiple responses.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( Multiple Response( :country, :size ), X( :sex, :marital status ) );
obj << Homogeneity Test( 1 );


```

### [Include Response Categories in Excluded Rows](#include-response-categories-in-excluded-rows)

**Syntax:** obj = Categorical(...Include Response Categories in Excluded Rows( state=0|1 )...)

**Description:** Specifies that the report include response categories that appear only in excluded rows. The counts for these categories are zero.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Select Where( :size == "Small" );
dt << Exclude;
obj = Categorical(
    Include Response Categories in Excluded Rows( 1 ),
    X( :marital status ),
    Responses( :size )
);


```

### [Include Responses Not in Data](#include-responses-not-in-data)

**Syntax:** obj = Categorical(...Include Responses Not in Data( state=0|1 )...)

**Description:** Shows response categories that have value labels, even if they do not occur in the data.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
:type << Set Property(
    Value Labels,
    {"Family" = "Family", "Sporty" = "Sporty", "Utility" = "SUV", "Work" = "Work"}
);
obj = Categorical( X( :marital status ), Responses( :type ) );
obj << Include Responses Not in Data( 1 );


```

### [Indicator Group](#indicator-group)

**Syntax:** obj = Categorical(...Indicator Group( columns )...)

**Description:** Summarizes data from a multiple response variable where the responses are in multiple indicator columns.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures3Indicators.jmp" );
obj = dt << Categorical(
    X( :clean, :date ),
    Indicator Group(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    )
);


```

### [Mean Confidence Interval](#mean-confidence-interval)

**Syntax:** obj \<< Mean Confidence Interval( state=0|1 )

**Description:** Shows or hides the confidence interval for the means

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Mean Confidence Interval( 1 );


```

### [Mean Score](#mean-score)

**Syntax:** obj \<< Mean Score( state=0|1 )

**Description:** Displays the mean score, based on raw numeric codes or value scores, in the crosstab table.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Mean Score( 1 );


```

### [Mean Score Comparisons](#mean-score-comparisons)

**Syntax:** obj \<< Mean Score Comparisons( state=0|1 )

**Description:** Compares the mean scores across grouping categories.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Mean Score Comparisons( 1 );


```

### [Mean Score Comparisons FDR](#mean-score-comparisons-fdr)

**Syntax:** obj \<< Mean Score Comparisons FDR( state=0|1 )

**Description:** Compares the mean scores across grouping categories.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Mean Score Comparisons FDR( 1 );


```

### [Mean Score Comparisons as Suffix](#mean-score-comparisons-as-suffix)

**Syntax:** obj \<< Mean Score Comparisons as Suffix( state=0|1 )

**Description:** Compares the mean scores across grouping categories.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Mean Score Comparisons Suffixed( 1 );


```

### [Mean Std Error](#mean-std-error)

**Syntax:** obj \<< Mean Std Error( state=0|1 )

**Description:** Shows or hides the standard error for the means

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Mean Std Error( 1 );


```

### [Means Format](#means-format)

**Syntax:** obj \<< Means Format( format, <options> )

**Description:** Formats the mean scores in the table. The default value is "Fixed", 6, 2.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Mean Score( 1 );
Wait( 1 );
obj << Means Format( "Fixed", 6, 4 );


```

### [Multiple Delimited](#multiple-delimited)

**Syntax:** obj = Categorical(...Multiple Delimited( column )...)

**Description:** Summarizes data from a multiple response variable where the responses are in a single column and each response is separated by a comma, semicolon, or tab.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures3Delimited.jmp" );
obj = dt << Categorical( Multiple Delimited( :failureS ), ID( :ID ), X( :clean, :date ) );


```

### [Multiple Response](#multiple-response)

**Syntax:** obj = Categorical(...Multiple Response( columns )...)

**Description:** Summarizes data from a multiple response variable where each possible response is recorded in its own individual column.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3MultipleField.jmp" );
obj = dt << Categorical(
    X( :clean, :date ),
    Multiple Response( :Failure1, :Failure2, :Failure3 ),
    Frequency Chart( 0 )
);


```

### [Multiple Response by ID](#multiple-response-by-id)

**Syntax:** obj = Categorical(...Multiple Response by ID( column )...)

**Description:** Summarizes data from a multiple response variable where there is a single column of responses and a second column containing an ID for the subject.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3ID.jmp" );
obj = dt << Categorical(
    Multiple Response by ID( :failure ),
    Freq( :N ),
    Sample Size( :SampleSize ),
    ID( :ID ),
    X( :clean, :date )
);


```

### [Order Response Levels High to Low](#order-response-levels-high-to-low)

**Syntax:** obj = Categorical(...Order Response Levels High to Low( state=0|1 )...)

**Description:** Reorders the report so that categories with the highest value are at the top.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical(
    X( :sex, :marital status ),
    Order Response Levels High to Low( 1 ),
    Responses( :country )
);


```

### [Order by Significance](#order-by-significance)

**Syntax:** obj \<< Order by Significance( state=0|1 )

**Description:** Reorders the reports so that the most significant reports are at the top.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    Grouping Option( Each Individually ),
    X( :Age Group, :School Age Children ),
    Responses( :I am working on my career ),
    Responses( :My home needs some major improvements ),
    Responses( :I have vast interests outside of work ),
    Responses( :I come from a large family ),
    Crosstab Transposed( 1 ),
    Test Response Homogeneity( 1 )
);
obj << Order by Significance( 1 );


```

### [Poisson](#poisson)

**Syntax:** obj \<< Poisson( state=0|1 )

**Description:** Performs a chi-square test of independence of rates using Poisson regression. Note: Available only for multiple responses.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( Multiple Response( :country, :size ), X( :sex, :marital status ) );
obj << Count Test( 1 );


```

### [Rate Confidence Interval](#rate-confidence-interval)

**Syntax:** obj \<< Rate Confidence Interval( state=0|1 )

**Description:** Shows or hides the confidence interval for the rate probability. The confidence interval is a normal interval using the standard errors from the Poisson linear model.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical( X( :Gender ), Multiple Delimited( :Brush Delimited ) );
obj << Rate Confidence Interval( 1 );


```

### [Rate Per Case](#rate-per-case)

**Syntax:** obj \<< Rate Per Case( state=0|1 )

**Description:** Shows or hides the Rate per Case table in the report. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3ID.jmp" );
obj = dt << Categorical(
    Multiple Response by ID( :failure ),
    Freq( :N ),
    Sample Size( :SampleSize ),
    ID( :ID ),
    X( :clean, :date ),
    Rate Per Case( 0 )
);
Wait( 1 );
obj << Rate Per Case( 1 );


```

### [Rate per Case Responding](#rate-per-case-responding)

**Syntax:** obj \<< Rate per Case Responding( state=0|1 )

**Description:** Shows or hides the rate of response per case responding (excluding missing).

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3ID.jmp" );
obj = dt << Categorical(
    Multiple Response by ID( :failure ),
    Freq( :N ),
    Sample Size( :SampleSize ),
    ID( :ID ),
    X( :clean, :date )
);
obj << Rate Per Case Responding( 1 );


```

### [Rater Agreement](#rater-agreement_1)

**Syntax:** obj = Categorical(...Rater Agreement( columns )...)

**Description:** Summarizes data from multiple columns where each column is a rating for the same question or item, but is given by a different individual (rater).

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Categorical( Rater Agreement( :First Survey, :Second Survey ), Freq( :Count ) );


```

### [Relative Risk](#relative-risk)

**Syntax:** obj \<< Relative Risk( state=0|1, {}, {level of interest} )

**Description:** Shows or hides the relative risks for a two-level grouping variable for each level of the response. Available when the grouping variable has two levels and either the response has two levels or is a multiple response and the Unique occurrences within ID option has been selected.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = dt << Categorical(
    Response Frequencies(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect,
    ),
    Sample Size( :SampleSize ),
    X( :clean )
);
obj << Relative Risk( 1, {}, {"after"} );


```

### [Repeated Measures](#repeated-measures_1)

**Syntax:** obj = Categorical(...Repeated Measures( columns )...)

**Description:** Summarizes data from multiple columns where each column contains responses to the same question made at different time points.

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Categorical( Repeated Measures( :First Survey, :Second Survey ), Freq( :Count ) );


```

### [Response Frequencies](#response-frequencies)

**Syntax:** obj = Categorical(...Response Frequencies( columns )...)

**Description:** Summarizes a multiple response variable where the frequency of each possible response is recorded in its own column.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = dt << Categorical(
    Response Frequencies(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    X( :clean, :date ),
    Sample Size( :SampleSize )
);


```

### [Response Levels](#response-levels)

**Syntax:** obj \<< Response Levels( state=0|1 )

**Description:** Shows or hides data levels for each response. On by default.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Response Levels( 0 );
Wait( 1 );
obj << Response Levels( 1 );


```

### [Responses](#responses)

**Syntax:** obj = Categorical(...Responses( column )...)

**Description:** Summarizes responses from a single column. If multiple columns are selected, the categorical report contains a separate report for each individual column.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );


```

### [Save Contingency Table](#save-contingency-table)

**Syntax:** obj \<< Save Contingency Table

**Description:** Saves the values in the crosstab table to a new data table. The new table uses the original column names.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :size ) );
obj << Save Contingency Table;


```

### [Save DocX File](#save-docx-file)

**Syntax:** obj \<< Save DocX File

**Description:** Undocumented and Experimental Feature

### [Save Excel File](#save-excel-file)

**Syntax:** obj \<< Save Excel File

**Description:** Saves the tables to an Excel spreadsheet file.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :size ) );
obj << Save Excel File(
    "$DOCUMENTS\ExcelCarSize.xlsx",
    Separate Rows for Each Cell Statistic( 1 )
);


```

### [Save Frequencies](#save-frequencies)

**Syntax:** obj \<< Save Frequencies

**Description:** Saves the frequencies to a new table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Frequencies;


```

### [Save Mean Scores](#save-mean-scores)

**Syntax:** obj \<< Save Mean Scores

**Description:** Saves the mean scores for each sample group to a new table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :size ) );
obj << Save Mean Scores;


```

### [Save Rate Per Case](#save-rate-per-case)

**Syntax:** obj \<< Save Rate Per Case

**Description:** Saves the rate per case to a new table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3ID.jmp" );
obj = dt << Categorical(
    Multiple Response by ID( :failure ),
    Freq( :N ),
    Sample Size( :SampleSize ),
    ID( :ID ),
    X( :clean, :date )
);
obj << Rate Per Case( 1 );
obj << Save Rate Per Case;


```

### [Save Share of Responses](#save-share-of-responses)

**Syntax:** obj \<< Save Share of Responses

**Description:** Saves the share of responses to a new table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Share of Responses;


```

### [Save Stacked Table](#save-stacked-table)

**Syntax:** obj \<< Save Stacked Table

**Description:** Saves the values in the crosstab table to a new data table. The new table uses general column names.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :size ) );
obj << Save Stacked Table;


```

### [Save Test Homogeneity](#save-test-homogeneity)

**Syntax:** obj \<< Save Test Homogeneity

**Description:** Saves the results from the tests for homogeneity to a new table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Test Homogeneity;


```

### [Save Test Rates](#save-test-rates)

**Syntax:** obj \<< Save Test Rates

**Description:** Saves the results of the Test Multiple Response option to a new data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3ID.jmp" );
obj = dt << Categorical(
    Multiple Response by ID( :failure ),
    Freq( :N ),
    Sample Size( :SampleSize ),
    ID( :ID ),
    X( :clean, :date )
);
obj << Rate Per Case( 1 );
obj << Save Test Rates;


```

### [Save Transposed Frequencies](#save-transposed-frequencies)

**Syntax:** obj \<< Save Transposed Frequencies

**Description:** Saves the transposed frequencies to a new table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Transposed Frequencies;


```

### [Save Transposed Rate Per Case](#save-transposed-rate-per-case)

**Syntax:** obj \<< Save Transposed Rate Per Case

**Description:** Saves the transformed rate per case to a new table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3ID.jmp" );
obj = dt << Categorical(
    Multiple Response by ID( :failure ),
    Freq( :N ),
    Sample Size( :SampleSize ),
    ID( :ID ),
    X( :clean, :date )
);
obj << Rate Per Case( 1 );
obj << Save Transposed Rate Per Case;


```

### [Save Transposed Share of Responses](#save-transposed-share-of-responses)

**Syntax:** obj \<< Save Transposed Share of Responses

**Description:** Saves the transposed share of responses to a new table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Transposed Share of Responses;


```

### [Save tTests and pValues](#save-ttests-and-pvalues)

**Syntax:** obj \<< Save tTests and pValues

**Description:** Save t tests and p-values from the Compare Means tests to a new data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :size ) );
obj << Save ttests and pvalues;


```

### [Share Chart](#share-chart)

**Syntax:** obj \<< Share Chart( state=0|1 )

**Description:** Shows or hides the Share Chart in the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    Share Chart( 0 )
);
Wait( 1 );
obj << Share Chart( 1 );


```

### [Share Confidence Interval](#share-confidence-interval)

**Syntax:** obj \<< Share Confidence Interval( state=0|1 )

**Description:** Shows or hides the confidence interval for the share response probability. The confidence interval is constructed using Wilson's Score test method.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical( X( :Age Group ), Responses( :I am working on my career ) );
obj << Share Confidence Interval( 1 );


```

### [Share Of Responses](#share-of-responses)

**Syntax:** obj \<< Share Of Responses( state=0|1 )

**Description:** Shows or hides the Share of Responses table in the report. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    Share of Responses( 0 )
);
Wait( 1 );
obj << Share of Responses( 1 );


```

### [Shares and Rates Format](#shares-and-rates-format)

**Syntax:** obj \<< Shares and Rates Format( format, <options> )

**Description:** Formats the Share, Rate, and Rate per Response values in the table. The default value is "Percent", 6, 1.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
Wait( 1 );
obj << Shares and Rates Format( "Percent", 7, 2 );


```

### [Shorten Labels](#shorten-labels)

**Syntax:** obj = Categorical(...Shorten Labels( state=0|1 )...)

**Description:** Shortens labels by removing common prefixes and suffixes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Age Range",
    Numeric,
    "Continuous",
    Formula( :age > 12 ),
    Value Labels( {0 = "Age Range: Adolescent", 1 = "Age Range: Teenager"} )
);
obj = dt << Categorical( Responses( :Age Range ), Legend( 0 ) );
Wait( 2 );
obj << Shorten Labels( 1 );


```

### [Show Columns Used in Report](#show-columns-used-in-report)

**Syntax:** obj \<< Show Columns Used in Report( state=0|1 )

**Description:** Shows or hides Columns Used in Report information. This option affects only columns that have an SPSS or SAS Name or SPSS or SAS Label Column Property.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
:country << Set Property( "SAS Label", "Country of Manufacture Origin" );
obj = Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Show Columns Used in Report( 1 );


```

### [Show Highlight Legend](#show-highlight-legend)

**Syntax:** obj \<< Show Highlight Legend( state=0|1 )

**Description:** On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    Structured( :Position Tenure + :Age Group, :I am working on my career + :Brush ),
    Mean Score( 1 ),
    Highlight Cells( Share >= 0.8 ),
    Highlight Cells( Mean Score >= 2.7, Color( "Blue" ) )
);

obj << Show Highlight Legend( 0 );
Wait( 1 );
obj << Show Highlight Legend( 1 );


```

### [Show Supercategories](#show-supercategories)

**Syntax:** obj \<< Show Supercategories( state=0|1 )

**Description:** Shows or hides supercategories. On by default.

```

dt = Open( "$SAMPLE_DATA/Color Preference Survey.jmp" );
obj = dt << Categorical(
    X( :"What is your gender ? "n, :"How old are you ? "n ),
    Responses( :I like the color orange. ),
    Supercategories(
        :I like the color orange.(
            {Group( "Positive Response", {"Neutral", "Agree", "Strongly agree"} )}
        )
    ),
    Legend( 0 )
);
obj << Show Supercategories( 0 );
Wait( 1 );
obj << Show Supercategories( 1 );


```

### [Show Warnings](#show-warnings)

**Syntax:** obj \<< Show Warnings( state=0|1 )

**Description:** Shows warnings for chi-square tests related to small sample size.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    Structured( :I am working on my career, :Age Group * :Employee Tenure ),
    Share Chart( 0 ),
    Test Response Homogeneity( 1 )
);
obj << Show Warnings( 1 );


```

### [Std Dev Format](#std-dev-format)

**Syntax:** obj \<< Std Dev Format( format, <options> )

**Description:** Formats the standard deviation scores in the table. The default value is "Fixed", 6, 2.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Std Dev Score( 1 );
Wait( 1 );
obj << Std Dev Format( "Fixed", 6, 4 );


```

### [Std Dev Score](#std-dev-score)

**Syntax:** obj \<< Std Dev Score( state=0|1 )

**Description:** Displays the standard deviation score, based on raw numeric codes or value scores, in the crosstab table

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Std Dev Score( 1 );


```

### [Structured](#structured)

**Syntax:** obj = Categorical(...Structured( Column * nestedColumn ... + rightColumn, sideColumn + lowerColumns... )...)

**Description:** Generates a structured cross tabulation of two or more variables.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Categorical(
    Structured( :Gender * :Age Group + :Position Tenure, :Job Satisfaction + :Salary Group )
);


```

### [Supercategories](#supercategories)

**Syntax:** obj \<< Supercategories( column, ({Group (name, {level1, level2, ... levelN})}) )

**Description:** Specifies supercategories to locally aggregate response categories.

```

dt = Open( "$SAMPLE_DATA/Color Preference Survey.jmp" );
obj = dt << Categorical(
    X( :"What is your gender ? "n, :"How old are you ? "n ),
    Responses( :I like the color orange. ),
    Supercategories(
        :I like the color orange.(
            {Group( "Positive Response", {"Neutral", "Agree", "Strongly agree"} )}
        )
    ),
    Legend( 0 )
);


```

### [Test Response Homogeneity](#test-response-homogeneity)

**Syntax:** obj \<< Test Response Homogeneity( state=0|1 )

**Description:** Tests the response column for homogeneity, giving both Likelihood Ratio and Pearson Chi-Squared tests. Available only for a single response.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Test Response Homogeneity( 1 );


```

### [Total Cases](#total-cases)

**Syntax:** obj \<< Total Cases( state=0|1 )

**Description:** For multiple-response variables, shows the total number of cases in the crosstab table. On by default.

```

dt = Open( "$SAMPLE_DATA/Color Preference Survey.jmp" );
obj = dt << Categorical(
    X( :"What is your gender ? "n, :"How old are you ? "n ),
    Multiple Response(
        :I like the color blue., :I like the color red., :I like the color orange.
    )
);
obj << Total Cases( 0 );
Wait( 1 );
obj << Total Cases( 1 );


```

### [Total Cases Responding](#total-cases-responding)

**Syntax:** obj \<< Total Cases Responding( state=0|1 )

**Description:** For multiple-response variables, shows the total number of cases who responded at least once in the crosstab table. On by default.

```

dt = Open( "$SAMPLE_DATA/Color Preference Survey.jmp" );
obj = dt << Categorical(
    X( :"What is your gender ? "n, :"How old are you ? "n ),
    Multiple Response(
        :I like the color blue., :I like the color red., :I like the color orange.
    )
);
obj << Total Cases Responding( 0 );
Wait( 1 );
obj << Total Cases Responding( 1 );


```

### [Total Responses](#total-responses)

**Syntax:** obj \<< Total Responses( state=0|1 )

**Description:** Shows the total number of responses in the crosstab table. On by default.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Total Responses( 0 );
Wait( 1 );
obj << Total Responses( 1 );


```

### [Totals First](#totals-first)

**Syntax:** obj \<< Totals First( state=0|1 )

**Description:** Shows the Response Totals near the top or left of the crosstab, but only if the totals are the same across multiple tables down each column.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Categorical(
    Structured(
        :Single Status + :School Age Children,
        :Employee Tenure + :Position Tenure + :Age Group
    ),
    Frequencies( 0 ),
    Totals First( 1 ),
    Total Responses( 0 )
);


```

### [Transition Report](#transition-report)

**Syntax:** obj \<< Transition Report( state=0|1 )

**Description:** Shows or hides a report showing how the categories have changed across time. Available only for a Repeated Measures model. On by default.

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Categorical( Repeated Measures( :First Survey, :Second Survey ), Freq( :Count ) );
obj << Transition Report( 1 );


```

### [Transposed Freq Chart](#transposed-freq-chart)

**Syntax:** obj \<< Transposed Freq Chart( state=0|1 )

**Description:** Shows or hides a transposed frequency chart that contains a column for each response level and horizontal rows for the different sample levels.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :marital status ), Responses( :country ) );
obj << Transposed Freq Chart( 1 );


```

### [Unique Occurrences within ID](#unique-occurrences-within-id)

**Syntax:** obj = Categorical(...Unique Occurrences within ID( state=0|1 )...)

**Description:** Aligns multiple responses across rows that have the same ID.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3ID.jmp" );
obj = dt << Categorical(
    Freq( :N ),
    Sample Size( :SampleSize ),
    ID( :ID ),
    X( :clean, :date ),
    Unique occurrences within ID( 1 ),
    Multiple Response by ID( :failure )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Categorical(
    X( :sex, :marital status ),
    Responses( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Categorical(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Cell Plot](#cell-plot)

## [Associated Constructors](#associated-constructors)

### [Cell Plot](#cell-plot_1)

**Syntax:** Cell Plot( Y( column(s) ), \<X( column )> )

**Description:** Produces a rectangular grid of cells drawn with one-to-one correspondence to data table values. The cells in the grid are colored by the values in the cells.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column(s) )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

### [Label](#label)

**Syntax:** obj \<< Label( column(s) )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

## [Item Messages](#item-messages)

### [Arrange Plots](#arrange-plots)

**Syntax:** obj \<< Arrange Plots( number across )

**Description:** Arranges the plots horizontally. Only available when an X variable is present.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Cell Plot( Y( :hist0, :hist1, :hist3, :hist5 ), X( :drug ) );
obj << Arrange Plots( 1 );


```

### [Center at zero](#center-at-zero)

**Syntax:** Cell Plot( Y( columns ), Center at Zero( state=0|1 ) )

**Description:** Centers all the plots at zero.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    Center at Zero( 1 )
);


```

### [Legend](#legend)

**Syntax:** obj \<< Legend( state=0|1 )

**Description:** Displays or hides the legend appended to the end of the plot.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Legend( 1 );


```

### [Scale Uniformly](#scale-uniformly)

**Syntax:** Cell Plot( Y( columns ), Scale Uniformly( state=0|1 ) )

**Description:** Scales all the plots uniformly.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    Scale Uniformly( 1 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Cell Plot(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Choice](#choice)

## [Associated Constructors](#associated-constructors)

### [Choice](#choice_1)

**Syntax:** Choice( Profile DataTable( data table ), Profile ID( column ), Profile Effects( column(s) ), \<Response Data Table( data table )>, \<Subject Data Table( data table )>, \<Response Profile ID Chosen( column )>, \<Response Subject ID( column)>, \<Response Grouping( column(s) )>, \<Response Profile ID Choices( column(s) )>, \<Profile Grouping( column(s) )>, \<Subject Subject ID( column )>, \<Subject Effects( column(s) )> )

**Description:** Models data from a choice experiment that studies customer preferences. Estimates the probability that a specific configuration is preferred using a form of conditional logistic regression.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Pizza Combined.jmp" );
obj = Choice(
    One Table( 1 ),
    Profile DataTable( dt ),
    Profile ID( :Indicator ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Profile Grouping( :Subject, :Trial )
);


```

## [Columns](#columns)

### [Choice Set ID](#choice-set-id)

**Syntax:** Choice( Choice Set ID( column ), ... )

**Description:** A column that identifies the choice set that was presented to the subject for a given preference determination in the one data table situation.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Profile Effects](#profile-effects)

**Syntax:** obj = Choice(...\<Profile Effects( column )>...)

**Description:** One or more columns that contain the effect or factor values in the profile data table.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Profile Grouping](#profile-grouping)

**Syntax:** Choice( Profile Grouping( column(s) ), ... )

**Description:** A column which, when used with the Profile ID column, uniquely designates each choice set.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Profile ID](#profile-id)

**Syntax:** Choice( Profile ID( column ), ... )

**Description:** A column that contains the ID in the profile data table.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Response Freq](#response-freq)

**Syntax:** Choice( Response Freq( column ), ... )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Response Grouping](#response-grouping)

**Syntax:** Choice( Response Grouping( column(s) ), ... )

**Description:** A column which, when used with the Profile ID Chosen column, uniquely designates each choice set.

```

Open( "$Sample_Data/Laptop Profile.jmp" );
Open( "$Sample_Data/Laptop Runs.jmp" );
Choice(
    Response Data Table( Data Table( "Laptop Runs" ) ),
    Profile DataTable( Data Table( "Laptop Profile" ) ),
    Response Grouping( :Survey, :Choice Set ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :Choice ID ),
    Profile Grouping( :Survey, :Choice Set ),
    Profile Effects( :Hard Disk, :Speed, :Battery Life, :Price ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    Response Profile ID Chosen( :Response ),
    Likelihood Ratio Tests( 1 ),
    Willingness to Pay(
        Hard Disk( Feature Factor, "40 GB" ),
        Speed( Feature Factor, "1.5 GHz" ),
        Battery Life( Feature Factor, "4 hours" ),
        Price( Price Factor, 1000 )
    )
);


```

### [Response Profile ID Choices](#response-profile-id-choices)

**Syntax:** Choice( Response Profile ID Choice( columns ), ... )

**Description:** At least two columns that contain the possible choices available as responses.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Response Profile ID Chosen](#response-profile-id-chosen)

**Syntax:** Choice( Response Profile ID Chosen( column ), ... )

**Description:** A column that contains the profile ID that represents the subject's selected profile.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

### [Response Subject ID](#response-subject-id)

**Syntax:** Choice( Response Subject ID( column ), ... )

**Description:** A column that identifies the study participant in the response data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Response Weight](#response-weight)

**Syntax:** Choice( Response Weight( column ), ... )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Subject Effects](#subject-effects)

**Syntax:** obj = Choice(...\<Subject Effects( column )>...)

**Description:** One or more columns that contain the effect or factor values in the subject data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Subject ID](#subject-id)

**Syntax:** Choice( Subject ID( column ), ... )

**Description:** A column that identifies the study participant in the subject data table or in the one data table situation.

```

dt = Open( "$SAMPLE_DATA/Pizza Combined.jmp" );
obj = Choice(
    One Table( 1 ),
    Subject ID( :Subject ),
    Choice Set ID( :Trial ),
    Profile ID( :Indicator ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Subject Subject ID](#subject-subject-id)

**Syntax:** Choice( Subject Subject ID( column ), ... )

**Description:** A column that identifies the study participant in the subject data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

## [Item Messages](#item-messages)

### [Comparisons](#comparisons)

**Syntax:** obj \<< Comparisons( {term1(value1a),term2(value2a),...},{term1(value1b),term2(value2b),...} )

**Description:** Performs comparisons between specific alternative choice profiles. Enables you to specify the factors and the values that you want to compare.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Comparisons(
    {Crust( "Thick" ), Cheese( "Jack" ), Topping( "Pepperoni" )},
    {Crust( "Thin" ), Cheese( "Mozzarella" ), Topping( "None" )}
);


```

### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< Confidence Intervals( state=0|1, <alpha> )

**Description:** Shows or hides (1-alpha)% confidence intervals for each parameter in the Parameter Estimates report.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Confidence Intervals( 1, 0.01 );


```

### [Confidence Limits](#confidence-limits)

**Syntax:** obj \<< Confidence Limits( state=0|1, <alpha> )

**Description:** Shows or hides confidence limits for each parameter in the Bayesian Parameter Estimates report. The limits are constructed based on the 2.5 and 97.5 quantiles of the posterior distribution.

**JMP Version Added:** 14

### [Convergence Criterion](#convergence-criterion)

**Syntax:** obj = Choice(...Convergence Criterion( number )...)

**Description:** Sets the acceptable criterion for convergence when estimating the parameters.

### [Correlation of Estimates](#correlation-of-estimates)

**Syntax:** obj \<< Correlation of Estimates( state=0|1 )

**Description:** Shows or hides the correlation matrix for the parameter estimates.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Correlation of Estimates( 1 );


```

### [Effect Marginals](#effect-marginals)

**Syntax:** obj \<< Effect Marginals( state=0|1 )

**Description:** Shows or hides marginal probabilities and marginal utilities for each main effect in the model. The marginal probability is the probability that an individual selects attribute A over B with all other attributes set to their mean or default levels.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Effect Marginals( 1 );


```

### [Firth Bias-Adjusted Estimates](#firth-bias-adjusted-estimates)

**Syntax:** obj = Choice(...Firth Bias-Adjusted Estimates( state=0|1 )...)

**Description:** Computes bias-corrected maximum likelihood estimates (MLEs) that produce better estimates and tests than MLEs without bias correction. These estimates also improve separation problems that tend to occur in logistic models. On by default.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);
Report( obj )["Parameter Estimates"] << Close( 0 );


```

### [Hierarchical Bayes](#hierarchical-bayes)

**Syntax:** obj = Choice(...Hierarchical Bayes( state=0|1 )...)

**Description:** Uses a Bayesian approach to estimate subject-specific parameters.

### [Joint Factor Tests](#joint-factor-tests)

**Syntax:** obj \<< Joint Factor Tests( state=0|1 )

**Description:** Tests each factor in the model by constructing a likelihood ratio test for all the effects involving that factor. Subject Data Table is required for this option when an interaction is not present in the model.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);
obj << Joint Factor Tests( 1 );


```

### [Likelihood Ratio Tests](#likelihood-ratio-tests)

**Syntax:** obj \<< Likelihood Ratio Tests( state=0|1 )

**Description:** Performs likelihood ratio tests for each effect in the model. On by default for models that converge in less than five seconds.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Likelihood Ratio Tests( 1 );


```

### [Model Dialog](#model-dialog)

**Syntax:** obj \<< Model Dialog

**Description:** Opens the Model Dialog window.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Model Dialog;


```

### [Multiple Choice Profiler](#multiple-choice-profiler)

**Syntax:** obj \<< Multiple Choice Profiler( state=0|1, N Choices( number ) )

**Description:** Shows or hides a specified number of prediction profilers. This enables you to compare the prediction probabilities across alternative sets of choices.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Multiple Choice Profiler( 1, N Choices( 3 ) );


```

### [Number of Bayesian Iterations](#number-of-bayesian-iterations)

**Syntax:** obj = Choice(...Number of Bayesian Iterations( number )...)

### [Number of Burn In Iterations](#number-of-burn-in-iterations)

**Syntax:** obj \<< Number of Burn In Iterations( number )

### [One Table](#one-table)

**Syntax:** obj = Choice(...One Table...)

**Description:** Specifies that the data are in stacked format in one data table.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Probability Profiler](#probability-profiler)

**Syntax:** obj \<< Probability Profiler( state=0|1 )

**Description:** Shows or hides a prediction profiler of the probability of the current choice compared to a reference set.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Probability Profiler( 1 );


```

### [Profile DataTable](#profile-datatable)

**Syntax:** Choice( Profile Data Table( table ), ... )

**Description:** Identifies the profile data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Remove Subject Effects](#remove-subject-effects)

**Syntax:** obj = Choice(...Remove Subject Effects...)

### [Respondents Are Allowed to Choose None](#respondents-are-allowed-to-choose-none)

**Syntax:** Choice( Respondents Are Allowed to Choose None( state=0|1 ), ... )

**Description:** Specifies that a No Choice Indicator be included in the model for response rows that contain missing values.

```

dt = Open( "$SAMPLE_DATA/Pizza Combined No Choice.jmp" );
obj = Choice(
    One Table( 1 ),
    Response Subject ID( :Subject ),
    Profile ID( :Indicator ),
    Profile Grouping( :Subject, :Trial ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    "Firth Bias-adjusted Estimates"n( 1 ),
    Respondents Are Allowed to Choose None( 1 ),
    Likelihood Ratio Tests( 1 )
);


```

### [Response Data Table](#response-data-table)

**Syntax:** Choice( Response Data Table( table ), ... )

**Description:** Identifies the response data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Save Bayes Chain](#save-bayes-chain)

**Syntax:** obj \<< Save Bayes Chain

### [Save Gradients by Subject](#save-gradients-by-subject)

**Syntax:** obj \<< Save Gradients by Subject

**Description:** Creates a new table with a row for each subject containing the average steps on each parameter.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Save Gradients by Subject;


```

### [Save Subject Estimates](#save-subject-estimates)

**Syntax:** obj \<< Save Subject Estimates

### [Save Utility Formula](#save-utility-formula)

**Syntax:** obj \<< Save Utility Formula

**Description:** Creates a new column in the profile data table with a formula for the linear model that is estimated.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Save Utility Formula;


```

### [Show MLE Parameter Estimates](#show-mle-parameter-estimates)

**Syntax:** obj \<< Show MLE Parameter Estimates( state=0|1 )

**Description:** Shows maximum likelihood estimates with Bayes parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Hierarchical Bayes( 1 )
);
obj << Show MLE Parameter Estimates( 1 );


```

### [Subject DataTable](#subject-datatable)

**Syntax:** Choice( Subject Data Table( table ), ... )

**Description:** Identifies the subject data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Use Adaptive Bayes](#use-adaptive-bayes)

**Syntax:** obj \<< Use Adaptive Bayes( state=0|1 )

### [Utility Profiler](#utility-profiler)

**Syntax:** obj \<< Utility Profiler( state=0|1 )

**Description:** Shows or hides the predicted utility for different factor settings. The utility is the value predicted by the linear model.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Utility Profiler( 1 );


```

### [Willingness to Pay](#willingness-to-pay)

**Syntax:** obj \<< Willingness to Pay

**Description:** Requires that your model includes a continuous price column. Calculates the maximum price increase (decrease) that a customer is willing to pay for a new feature over the baseline feature cost. The result is calculated using the Baseline settings for each background setting.

```

dt1 = Open( "$SAMPLE_DATA/Laptop Profile.jmp" );
dt2 = Open( "$SAMPLE_DATA/Laptop Runs.jmp" );
Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Grouping( :Survey, :Choice Set ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :Choice ID ),
    Profile Grouping( :Survey, :Choice Set ),
    Profile Effects( :Hard Disk, :Speed, :Battery Life, :Price ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    Response Profile ID Chosen( :Response ),
    Likelihood Ratio Tests( 1 ),
    Willingness to Pay(
        Hard Disk( Feature Factor, "40 GB" ),
        Speed( Feature Factor, "1.5 GHz" ),
        Battery Life( Feature Factor, "4 hours" ),
        Price( Price Factor, 1000 )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Choice(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Class](#class)

## [Associated Constructors](#associated-constructors)

### [Define Class](#define-class)

**Syntax:** Define Class("class name", \<Base Class{ "base class name", ... }>, \<Show( All( boolean ) | ( Members( boolean ) | Methods( boolean ) | Functions( boolean ) )+ )>, { method *| member* | function\* } )

**Description:** Creates a class where all class methods and class variables created are defined only within the specified class name.

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );


```

## [Item Messages](#item-messages)

### [Clone](#clone)

**Syntax:** obj \<< Clone

**Description:** Clone the contents of a class reference making a new object

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
nclref = clref << Clone;
Show( clref << Equal( nclref ) );
Show( clref == nclref );


```

### [Contains](#contains)

**Syntax:** obj \<< Contains( string )

**Description:** Returns a 1 if the class contains the specified string expression, or a 0 otherwise.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << Contains( "nObs" );


```

### [Delete Class](#delete-class)

**Syntax:** clref \<< Delete Class( < Force( boolean ) > )

**Description:** Deletes this class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
clref << Delete Class;
Show( clref );


```

### [Equal](#equal)

**Syntax:** obj \<< Equal( classref )

**Description:** Compare the class reference argument to the target class reference for equality

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
nclref = New Object( Test() );
Show( clref << Equal( nclref ) );
nclref:nObs = 50;
Show( clref << Equal( nclref ) );


```

### [First](#first)

**Syntax:** obj \<< First

**Description:** Returns the string expression for the first item in this class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << First;


```

### [Get Contents](#get-contents)

**Syntax:** obj \<< Get Contents

**Description:** Returns a list of items within this class. Each element is a two-item list containing a key and its associated value.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << Get Contents;


```

### [Get Keys](#get-keys)

**Syntax:** obj \<< Get Keys

**Description:** Returns a list of keys within this class. Each key is a string representation of an individual item contained in the class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << Get Keys;


```

### [Get Name](#get-name)

**Syntax:** obj \<< Get Name

**Description:** Returns the name of this class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
class name = clref << Get Name;


```

### [Get Value](#get-value)

**Syntax:** obj \<< Get Value( string )

**Description:** Returns the value of the specified item within this class. The "string" is the key to the item.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << Get Value( "nObs" );


```

### [Get Values](#get-values)

**Syntax:** obj \<< Get Values

**Description:** Returns a list of values corresponding to each item within this class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << Get Values;


```

### [Insert](#insert)

**Syntax:** obj \<< Insert( string, value )

**Description:** Inserts a string expression with the specified value into this class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
clref << Insert( "X", 25 );
Show( clref );


```

### [Lock Class](#lock-class)

**Syntax:** obj \<< Lock Class( \<string, | {string, ...}>\* )

**Description:** Locks all method members or specified named members in this class and prevents them from being added, changed, or removed.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
clref << Lock Class;
Try( clref:nObs = 40, "clref is locked." );


```

### [N Items](#n-items)

**Syntax:** obj \<< N Items

**Description:** Returns the number of items contains in this class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
n = clref << N Items;


```

### [Next](#next)

**Syntax:** obj \<< Next( string )

**Description:** Returns the string expression for the next item following the key specified in this class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << Next( "addition" );


```

### [Remove](#remove)

**Syntax:** obj \<< Remove( \<string | {string, ...}>\* )

**Description:** Removes the specified string expression from the class.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
clref << Remove( "nObs" );
Show( clref );


```

### [Show Contents](#show-contents)

**Syntax:** obj \<< Show Contents

**Description:** Shows the contents of a class in the JMP log.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
result = clref << Show Contents;


```

### [Unlock Class](#unlock-class)

**Syntax:** obj \<< Unlock Class( \<string | {string, ...}>\* )

**Description:** Unlocks a locked class containing method members that were prevented from being added, changed, or removed.

**JMP Version Added:** 14

```

Define Class(
    "Test",
    nObs = 20;
    addition = Method( {x, y},
        (x + y) * nObs
    );
    append = Method( {a, b},
        Char( a ) || " + " || Char( b )
    );
);
clref = New Object( Test() );
clref << Lock Class( "nObs" );
Try( clref:nObs = 30, Show( "clref is locked." ) ); 
//Try again after unlocking. 
clref << Unlock Class( "nObs" );
Try( clref:nObs = 40, Show( "clref is locked." ) );


```

# [Cluster Variables](#cluster-variables)

## [Associated Constructors](#associated-constructors)

### [Cluster Variables](#cluster-variables_1)

**Syntax:** Cluster Variables( Y( columns ) )

**Description:** Clusters variables (columns) into groups that can be represented by a single component or variable. Cluster variables can be used as a dimension reduction technique.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Cluster Variables(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Cluster Variables(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), Freq( :_freqcol ) );


```

### [Weight](#weight)

**Syntax:** obj = Cluster Variables(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), Weight( :_weightcol ) );


```

### [Y](#y)

**Syntax:** obj = Cluster Variables(...Y( column(s) )...)

**Description:** Specifies the variables to be clustered.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );


```

## [Item Messages](#item-messages)

### [Cluster Components](#cluster-components)

**Syntax:** obj \<< Cluster Components( state=0|1 )

**Description:** Shows or hides the Standardized Components report, which contains the eigenvectors of the first principal component within each cluster. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Cluster Components( 1 );


```

### [Cluster Members](#cluster-members)

**Syntax:** obj \<< Cluster Members( state=0|1 )

**Description:** Shows or hides a report of the variables in each cluster. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Cluster Members( 1 );


```

### [Cluster Summary](#cluster-summary)

**Syntax:** obj \<< Cluster Summary( state=0|1 )

**Description:** Shows or hides a report that summarizes the results of variable clustering. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Cluster Summary( 1 );


```

### [Color Map on Correlations](#color-map-on-correlations)

**Syntax:** obj \<< Color Map on Correlations( state=0|1 )

**Description:** Shows or hides a color map of the correlations between variables, where the variables are arranged so that members of the same cluster are adjacent in the plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Color Map On Correlations( 1 );


```

### [Launch Fit Model](#launch-fit-model)

**Syntax:** obj \<< Launch Fit Model

**Description:** Launches Fit Model with the Most Representative variables as predictors. Select Save Cluster Components first if you want to use these as predictors.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Launch Fit Model;


```

### [Save Cluster Components](#save-cluster-components)

**Syntax:** obj \<< Save Cluster Components

**Description:** Saves the cluster (first principal) component for each cluster to the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Cluster Components;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Cluster Variables(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Cluster Variables(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Cluster](#cluster)

## [Columns](#columns)

### [Attribute ID](#attribute-id)

**Syntax:** obj = Y(...\<Attribute ID( column(s) )>...)

**Description:** For stacked data, this identifies attributes, which would be columns (variables) if the data was not stacked.

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

### [Label](#label)

**Syntax:** obj \<< Label( column )

### [Object ID](#object-id)

**Syntax:** obj = Y(...\<Object ID( column(s) )>...)

**Description:** For stacked data, this identifies individuals to cluster. Otherwise, it is used to aggregate across each rows of a data.

### [Ordering](#ordering)

**Syntax:** obj \<< Ordering( column )

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

## [Hierarchical Cluster](#hierarchical-cluster)

### [Associated Constructors](#associated-constructors)

#### [Hierarchical Cluster](#hierarchical-cluster_1)

**Syntax:** Hierarchical Cluster( Y( columns ) )

**Description:** Clusters rows based on continuous or categorical variables. Hierarchical clustering begins by treating each row as its own cluster, then successively combining two clusters at a time.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster( Y( :birth, :death ), Label( :country ) );


```

### [Columns](#columns_1)

#### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Item Messages](#item-messages)

#### [Add Spatial Measures](#add-spatial-measures)

**Syntax:** obj = Hierarchical Cluster(...Add Spatial Measures( state=0|1 )...)

**Description:** Enables you to select and weight spatial components to aid in clustering defect patterns. Available only if the specified data structure is Data is stacked.

```

dt = Open( "$SAMPLE_DATA/Wafer Stacked.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Defects ),
    Object ID( :Lot, :Wafer ),
    Attribute ID( :X_Die, :Y_Die ),
    Method( "Ward" ),
    Standardize Data( 0 ),
    Dendrogram Scale( "Distance Scale" ),
    Number of Clusters( 12 ),
    g
    Add Spatial Measures(
        Attributes( 1 ),
        Angle( 1 ),
        Radius( 1 ),
        Streak Angle( 1 ),
        Streak Distance( 1 )
    )
);


```

#### [Cluster Criterion](#cluster-criterion)

**Syntax:** obj \<< Cluster Criterion( state=0|1 )

**Description:** Shows or hides the Cubic Clustering Criterion (CCC) for the entire range of number of clusters. The CCC is used to estimate the number of clusters, where larger values indicate a better fit.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster( Y( :birth, :death ), Label( :country ), Cluster Criterion );


```

#### [Cluster Summary](#cluster-summary)

**Syntax:** obj \<< Cluster Summary( state=0|1 )

**Description:** Shows or hides summary statistics for each of the specified number of clusters.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Cluster Summary
);


```

#### [Clustering History](#clustering-history)

**Syntax:** obj \<< Clustering History( state=0|1 )

**Description:** Shows or hides the agglomeration history in order of joins. The table contains distances and is sorted from nearest to farthest. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Clustering History( 0 )
);


```

#### [Color Clusters](#color-clusters)

**Syntax:** obj \<< Color Clusters( state=0|1 )

**Description:** Colors the rows and the dendrogram labels by cluster membership. The colors are updated as the number of clusters is changed.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Color Clusters( 1 );


```

#### [Color Map](#color-map)

**Syntax:** obj \<< Color Map

**Description:** Shows or hides a color map next to the dendrogram.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Color Map( Green to Black to Red );
Wait( 1 );
obj << Color Map( Blue to Gray to Red );


```

#### [Column Cluster Criterion](#column-cluster-criterion)

**Syntax:** obj \<< Column Cluster Criterion( state=0|1 )

#### [Column Dendrogram Position](#column-dendrogram-position)

**Syntax:** obj \<< Column Dendrogram Position( "Below"|"Above" )

**Description:** Moves the position of the dendrogram for columns when two-way clustering is used.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Number of Clusters( 5 ),
    Two Way Clustering,
    Column Dendrogram Position( "Above" )
);


```

#### [Column Label Position](#column-label-position)

**Syntax:** obj \<< Column Label Position( "Below"|"Above" )

**Description:** Moves the position of the labels on the dendrogram for columns when two-way clustering is used.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Number of Clusters( 5 ),
    Two Way Clustering,
    Distance Graph( 0 ),
    Column Label Position( "Above" )
);


```

#### [Constellation Plot](#constellation-plot)

**Syntax:** obj \<< Constellation Plot( state=0|1 )

**Description:** Shows or hides an alternative way to present the information in the hierarchical clustering dendrogram. Each observation (row) is represented by an endpoint and each cluster join is represented by a new point. The lines that are drawn represent cluster membership.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Constellation Plot( 1 );


```

#### [Dendrogram Scale](#dendrogram-scale)

**Syntax:** obj \<< Dendrogram Scale( "Distance Scale"|"Even Spacing"|"Geometric Spacing" )

**Description:** Specifies the scale for the dendrogram. Even Spacing makes the spacing even across dendrogram branches. Geometric Spacing increases the spacing as a scale multiple up the tree in the dendrogram. Distance Scale uses branch spacing proportional to distances.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Dendrogram Scale( Geometric Spacing );


```

#### [Dendrogram Width](#dendrogram-width)

**Syntax:** obj \<< Dendrogram Width( number=min(max(256,n\*3),500) )

**Description:** How wide the dendrogram frame is for the clustering of rows. "min(max(256,n\*3),500)" by default.

#### [Distance Graph](#distance-graph)

**Syntax:** obj \<< Distance Graph( state=0|1 )

**Description:** Shows or hides a graph that shows the distance overcome at each cluster join. On by default.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 ),
    Distance Graph( 0 )
);
Wait( 1 );
obj << Distance Graph( 1 );


```

#### [Get Clusters](#get-clusters)

**Syntax:** obj \<< Get Clusters

**Description:** Returns a vector of cluster assignments for each row.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 3 )
);
c = obj << Get Clusters;
Show( c );


```

#### [Get Column Display Order](#get-column-display-order)

**Syntax:** obj \<< Get Column Display Order

**Description:** Returns a vector of the display position for each column in two-way clustering.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane, :"1-Octanol"n ),
    Twoway Clustering
);
rowOrder = obj << Get Column Display Order;


```

#### [Get Column Names](#get-column-names)

**Syntax:** obj \<< Get Column Names

**Description:** Returns the column names in cluster order after two-way clustering.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster( Y( :birth, :death ), Label( :country ) );
c = obj << Get Column Names;
Show( c );


```

#### [Get Display Order](#get-display-order)

**Syntax:** obj \<< Get Display Order

**Description:** Returns a vector of the display position for each row in the cluster, with missing values for undisplayed rows.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane, :"1-Octanol"n )
);
rowOrder = obj << Get Display Order;


```

#### [Get Distance Matrix](#get-distance-matrix)

**Syntax:** obj \<< Get Distance Matrix

**Description:** Returns the distance matrix used for hierarchical clustering.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Number of Clusters( 8 )
);
m = obj << Get Distance Matrix;
Show( m );


```

#### [Hybrid Cycles](#hybrid-cycles)

**Syntax:** obj = Hierarchical Cluster(...Hybrid Cycles( number=30 )...)

**Description:** Specifies the minimum number of near-neighbor joining cycles that are performed before switching to the hierarchical clustering routine. "30" by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Method( "Hybrid Ward" ),
    Hybrid Cycles( 20 )
);


```

#### [Hybrid Goal](#hybrid-goal)

**Syntax:** obj = Hierarchical Cluster(...Hybrid Goal( number=400 )...)

**Description:** Specifies the maximum number of clusters allowed before switching to the hierarchical clustering routine. When the hierarchical clustering routine starts, the number of clusters must be less than or equal to the Hybrid Goal. "400" by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Method( "Hybrid Ward" ),
    Hybrid Goal( 300 )
);


```

#### [Hybrid Initial K](#hybrid-initial-k)

**Syntax:** obj = Hierarchical Cluster(...Hybrid Initial K( number=10 )...)

**Description:** Specifies the initial number of neighbors used in the near-neighbor joining cycles. The number of neighbors can increase or decrease depending on how many unique near neighbors are found in the previous cycle. "10" by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Method( "Hybrid Ward" ),
    Hybrid Initial K( 8 )
);


```

#### [Hybrid Log Details](#hybrid-log-details)

**Syntax:** obj = Hierarchical Cluster(...Hybrid Log Details( state=0|1 )...)

**Description:** Specifies whether to show the status and timings of each state of the Hybrid Ward method in the log.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Method( "Hybrid Ward" ),
    Hybrid Log Details( 1 )
);


```

#### [Hybrid RandomPCA Dim](#hybrid-randompca-dim)

**Syntax:** obj = Hierarchical Cluster(...Hybrid RandomPCA Dim( number=0 )...)

**Description:** Specifies the number of dimensions to use in the Randomized PCA dimension reduction technique. This technique is used when the value of Hybrid RandomPCA Dim is any value greater than zero and provides further speed improvements. "0" by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Method( "Hybrid Ward" ),
    Hybrid RandomPCA Dim( 3 )
);


```

#### [Late Join Outliers](#late-join-outliers)

**Syntax:** obj \<< Late Join Outliers( state=0|1 )

**Description:** Shows or hides a report on which items clustered very late in the agglomeration.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Birth Death.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Late Join Outliers( 1 )
);


```

#### [Legend](#legend)

**Syntax:** obj \<< Legend( state=0|1 )

**Description:** Shows or hides a legend for the color map to the right of the dendrogram.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 ),
    Color Map( Blue to Gray to Red )
);
obj << Legend( 1 );


```

#### [Mark Clusters](#mark-clusters)

**Syntax:** obj \<< Mark Clusters( state=0|1 )

**Description:** Assigns markers to the rows of the data table corresponding to the cluster to which the row belongs. The markers update if you change the number of clusters. If you deselect this option, the markers are no longer updated based on the number of clusters.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Mark Clusters;


```

#### [Method](#method)

**Syntax:** Method( "Average"|"Centroid"|"Ward"|"Single"|"Complete"|"Fast Ward"|"Hybrid Ward" )

**Description:** Specifies the distance method used to form the clusters.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 ),
    Method( "Complete" )
);


```

#### [Missing value imputation](#missing-value-imputation)

**Syntax:** obj = Hierarchical Cluster(...Missing value imputation( state=0|1 )...)

**Description:** Imputes missing values using multivariate normal or multivariate SVD imputation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    Method( "Ward" ),
    Standardize Data( 1 ),
    Missing value imputation( 1 ),
    Dendrogram Scale( "Distance Scale" ),
    Number of Clusters( 6 )
);


```

#### [More Color Map Columns](#more-color-map-columns)

**Syntax:** obj \<< More Color Map Columns( column )

**Description:** Adds another color map based on the column specified.

```

dt = Open( "$SAMPLE_DATA/Skull.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :length, :basilar, :zygomat, :postorb ),
    Color Map( "Blue to Gray to Red" ),
    More Color Map columns( :sex )
);


```

#### [Number of Clusters](#number-of-clusters)

**Syntax:** obj \<< Number of Clusters( number )

**Description:** To set the number-of-clusters, the place to cut the tree to define cluster groups. There is a diamond-shaped drag icon that can also change the number of clusters.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 3 )
);


```

#### [Number of Column Clusters](#number-of-column-clusters)

**Syntax:** obj \<< Number of Column Clusters( number )

**Description:** Specifies the number of column clusters prior to saving. Available only for two-way clustering.

**JMP Version Added:** 17

#### [Parallel Coord Plots](#parallel-coord-plots)

**Syntax:** obj \<< Parallel Coord Plots

**Description:** Creates a parallel coordinate plot for each cluster, all contained in a separate window.

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Type, :Weight, :Turning Circle, :Displacement, :Horsepower, :Gas Tank Size ),
    Label( :Model ),
    Number of Clusters( 3 )
);
obj << Parallel Coord Plots;


```

#### [Pivot on Selected Cluster](#pivot-on-selected-cluster)

**Syntax:** obj \<< Pivot on Selected Cluster

**Description:** Reverses the order of the two sub-clusters of the currently selected cluster.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster( Y( :birth, :death ), Label( :country ) );
dt << Select Rows( Loc( (obj << Get Clusters) == 3 ) );
Wait( 2 );
obj << Pivot on Selected Cluster;


```

#### [Release Zoom](#release-zoom)

**Syntax:** obj \<< Release Zoom

**Description:** Releases the zoom on the dendrogram to the selected rows.

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
dt << Select Rows( [19, 22, 45, 61, 62, 64] );
obj = dt << Hierarchical Cluster(
    Y( :Type, :Weight, :Turning Circle, :Displacement, :Horsepower, :Gas Tank Size ),
    Label( :Model )
);
obj << Zoom to Selected Rows;
Wait( 2 );
obj << Release Zoom;


```

#### [Row Dendrogram Position](#row-dendrogram-position)

**Syntax:** obj \<< Row Dendrogram Position( "Left"|"Right" )

**Description:** Moves the position of the dendrogram for rows.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Two Way Clustering,
    Row Dendrogram Position( "Left" )
);


```

#### [Row Label Position](#row-label-position)

**Syntax:** obj \<< Row Label Position( "Left"|"Right" )

**Description:** Moves the position of the labels on the dendrogram for rows.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Two Way Clustering,
    Row Label Position( "Right" )
);


```

#### [Row More Position](#row-more-position)

**Syntax:** obj \<< Row More Position( "Left"|"Right" )

**Description:** Moves the position of the color map added with the More Color Map Columns command.

```

dt = Open( "$SAMPLE_DATA/Skull.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :length, :basilar, :zygomat, :postorb ),
    Color Map( "Blue to Gray to Red" ),
    More Color Map Columns( :sex ),
    Row More Position( "Right" )
);


```

#### [Save Cluster Hierarchy](#save-cluster-hierarchy)

**Syntax:** obj \<< Save Cluster Hierarchy

**Description:** Creates a data table that contains information useful in reconstructing the dendrogram.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Save Cluster Hierarchy;


```

#### [Save Cluster History](#save-cluster-history)

**Syntax:** obj \<< Save Cluster History

**Description:** Saves the table that appears in the Clustering History report as a new data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Save Cluster History
);


```

#### [Save Cluster Means](#save-cluster-means)

**Syntax:** obj \<< Save Cluster Means

**Description:** Saves a table of cluster means for the given number of clusters.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Save Cluster Means
);


```

#### [Save Cluster Tree](#save-cluster-tree)

**Syntax:** obj \<< Save Cluster Tree

**Description:** Creates a data table that contains the nodes of the cluster tree.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Save Cluster Tree;


```

#### [Save Clusters](#save-clusters)

**Syntax:** obj \<< Save Clusters

**Description:** Creates a data table column that contains the cluster numbers.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Save Clusters;


```

#### [Save Column Clusters](#save-column-clusters)

**Syntax:** obj \<< Save Column Clusters

**Description:** Save a new data table that contains cluster membership information for the columns. Available only for two-way clustering.

**JMP Version Added:** 17

#### [Save Constellation Coordinates](#save-constellation-coordinates)

**Syntax:** obj \<< Save Constellation Coordinates

**Description:** Saves the coordinates of the constellation plot to a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Constellation Plot( 1 );
obj << Save Constellation Coordinates( 1 );


```

#### [Save Display Order](#save-display-order)

**Syntax:** obj \<< Save Display Order

**Description:** Creates a data table column that contains the order in which the row appears in the dendrogram.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Save Display Order;


```

#### [Save Distance Matrix](#save-distance-matrix)

**Syntax:** obj \<< Save Distance Matrix

**Description:** Creates a data table that contains the distances between observations.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Save Distance Matrix
);


```

#### [Save Formula for Closest Cluster](#save-formula-for-closest-cluster)

**Syntax:** obj \<< Save Formula for Closest Cluster

**Description:** Saves a formula column to the data table that gives the cluster number of the closest cluster mean.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 )
);
obj << Save Formula for Closest Cluster;


```

#### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** obj \<< Scatterplot Matrix

**Description:** Creates a scatterplot matrix in a new window with confidence ellipses based on the current number of clusters.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Scatterplot Matrix
);


```

#### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number )

**Description:** Specifies a random seed to reproduce the results for future launches of the platform.

#### [Show Dendrogram](#show-dendrogram)

**Syntax:** obj \<< Show Dendrogram( state=0|1 )

**Description:** Enables you to turn off dendrogram if you want to see only the color map. On by default.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 3 ),
    Distance Graph( 0 ),
    Color Map( Green to Black to Red ),
    Color Clusters( 1 ),
    Show Dendrogram( 0 )
);


```

#### [Show NCluster Handle](#show-ncluster-handle)

**Syntax:** obj \<< Show NCluster Handle( state=0|1 )

**Description:** Shows or hides the diamond handle that is used to choose the number of clusters on the dendrogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :birth, :death ),
    Label( :country ),
    Number of Clusters( 4 ),
    Color Clusters( 1 ),
    Show NCluster Handle( 0 )
);


```

#### [Standardize](#standardize)

**Syntax:** obj \<< Standardize( "Unstandardized"|"Columns"|"Rows"|"Columns and Rows" )

**Description:** Alias for 'Standardize By', which specifies how to standardize the values prior to clustering.

#### [Standardize By](#standardize-by)

**Syntax:** obj = Hierarchical Cluster(...Standardize By( "Unstandardized"|"Columns"|"Rows"|"Columns and Rows" )...)

**Description:** Specifies how to standardize the values prior to clustering. You can standardize by columns, rows, columns and rows, or not at all.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Unstandardized" ),
    Two Way Clustering,
    Row Label Position( "Right" )
);


```

#### [Standardize Data](#standardize-data)

**Syntax:** obj \<< Standardize Data( state=0|1 )

**Description:** Old option name, still supported, but replaced by 'Standardize By'.

#### [Standardize Robustly](#standardize-robustly)

**Syntax:** obj = Hierarchical Cluster(...Standardize Robustly( state=0|1 )...)

**Description:** Uses robust estimates of the mean and standard deviation to standardize the data.

#### [Two Way Clustering](#two-way-clustering)

**Syntax:** obj = Hierarchical Cluster(...Two Way Clustering...)

**Description:** Clusters together columns as well as rows. The columns must be measured on the same scale.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Hierarchical Cluster(
    Y( :"1-Octanol"n, :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Number of Clusters( 8 )
);
Wait( .1 );
obj << Two Way Clustering;


```

#### [Use Saved Cluster Table](#use-saved-cluster-table)

**Syntax:** obj = Hierarchical Cluster(...Use Saved Cluster Table( state=0|1 )...)

**Description:** Uses a separate cluster history table to specify the clustering.

#### [Zoom to Selected Rows](#zoom-to-selected-rows)

**Syntax:** obj \<< Zoom to Selected Rows

**Description:** Zooms the dendrogram to the selected rows.

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
dt << Select Rows( [19, 22, 45, 61, 62, 64] );
obj = dt << Hierarchical Cluster(
    Y( :Type, :Weight, :Turning Circle, :Displacement, :Horsepower, :Gas Tank Size ),
    Label( :Model )
);
Wait( 2 );
obj << Zoom to Selected Rows;


```

## [KDTable](#kdtable)

### [Associated Constructors](#associated-constructors_1)

#### [KDTable](#kdtable_1)

**Syntax:** tbl = KDTable( [ point1, point2, point3, point4, point5, ... ] )

**Description:** Returns a table for efficiently looking up near neighbors. The matrix arguments are k-dimensional points. There is no built in limit on the number of dimensions or points.

```

tbl = KDTable( [1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6] );
{rows, dist} = tbl << K nearest rows( 2, 1 ); 
//2 nearest rows to row 1 are: 
Show( rows );


```

### [Item Messages](#item-messages_1)

#### [Distance between rows](#distance-between-rows)

**Syntax:** distance = KDTable \<< Distance between rows( row1, row2 )

**Description:** Returns the distance between two rows. Distance applies to removed rows as well as inserted rows.

```

tbl = KDTable( [1 1, 2 2, 1 2, 2 1, 4 4] );
distance = tbl << Distance between rows( 1, 2 ); 
//distance from row 1 to row 2 is: 
Show( distance );


```

#### [Insert rows](#insert-rows)

**Syntax:** n = KDTable \<< Insert rows( number|[ vector ] )

**Description:** Enables you to re-insert rows into table searches. The row indexes do not change when rows are inserted or removed, and only the original rows can be removed and then (re)inserted. Returns the number of rows inserted. If a row was already inserted, it is ignored.

```

tbl = KDTable( [1 1, 2 2, 1 2, 2 1, 4 4] ); 
//  remove 3 rows 
tbl << Remove Rows( [2 1 3] ); 
//  re-insert 1 row 
tbl << InsertRows( 2 ); 
// re-insert 2 rows, ignoring row 2 
tbl << InsertRows( [3 2] );
{rows, dist} = tbl << K nearest rows( 2, 4 ); 
//2 nearest rows to row 4, ignoring row 1, are:
Show( rows );


```

#### [K nearest rows](#k-nearest-rows)

**Syntax:** {rows, dist} = KDTable \<< K nearest rows( stop, <position> )

**Description:** Returns the n nearest rows and distances to either a point or row (if position is specified) or all rows (if position is omitted), stopping the search when the distance limit is exceeded. Stop can be either n or {n,limit}. The optional position is a point either as (1xK) matrix where K is the number of dimensions or the number of a row. If position is not supplied, the nearest n rows to each row are returned in a (rows x n) matrix.

```

tbl = KDTable( [1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6] );
{rows, dist} = tbl << K nearest rows( {3, 2.0} ); 
//3 nearest rows to each row are: 
Show( rows );


```

#### [Remove rows](#remove-rows)

**Syntax:** n = KDTable \<< Remove rows( number|[ vector ] )

**Description:** Remove rows from table searches. The row indexes do not change when rows are inserted or removed, and only the original rows can be removed then (re)inserted. The removed row's index can still be used as a starting point for K nearest rows. Returns the number of rows removed. If a row was already removed, it is ignored.

```

tbl = KDTable( [1 1, 2 2, 1 2, 2 1, 4 4] );  
//  remove 2 rows
tbl << RemoveRows( [2 1] ); 
//  re-insert 1 row 
tbl << Insert rows( 2 );
{rows, dist} = tbl << K nearest rows( 2, [1.5 1.5] ); 
//2 nearest rows to point at [1.5 1.5], ignoring row 1, are: 
Show( rows );


```

# [Column Switcher](#column-switcher)

## [Item Messages](#item-messages)

### [Close Outline](#close-outline)

**Syntax:** obj \<< Close Outline( state=0|1 )

**Description:** Opens or closes the Column Switcher outline box

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Close Outline( 1 );


```

### [Get Current](#get-current)

**Syntax:** obj \<< Get Current

**Description:** get the name of the current variable

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Set Current( "country" );
ColumnSwitcherObject << Get Current/*country*/ ;


```

### [Get Layout](#get-layout)

**Syntax:** obj \<< Get Layout

**Description:** Gets the layout for multiple Column Switchers. Vertical(0) or horizontal(1).

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Country ), Y( :Weight ) ),
    Elements( Bar( X, Y, Legend( 4 ) ) )
);
cs1 = gb << Column Switcher( :Country, {:Model, :Country, :Type}, Layout( 1 ) );
cs2 = gb << Column Switcher(
    :Weight,
    {:Weight, :Turning Circle, :Displacement, :Horsepower, :Gas Tank Size}
);
If( cs2 << Get Layout() == 1,
    Print( "Horizontal" ),
    Print( "Vertical" )
);


```

### [Get List](#get-list)

**Syntax:** obj \<< Get List

**Description:** get the list of available variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Get List/*{"sex","country","marital status"}*/ ;


```

### [Get Original](#get-original)

**Syntax:** obj \<< Get Original

**Description:** get the name of the original variable

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Next;
ColumnSwitcherObject << Get Original/*marital status*/ ;


```

### [Get Speed](#get-speed)

**Syntax:** obj \<< Get Speed

**Description:** fpm = obj\<<getSpeed /\* in Frames Per Minute \*/;

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
FPM = ColumnSwitcherObject << Get Speed;


```

### [Link Platform](#link-platform)

**Syntax:** obj \<< Link Platform( platform )

**Description:** Links a platform to this column switcher.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
columnSwitcher = dt << Column Switcher(
    :Process 1,
    {:Process 1, :Process 2, :Process 3, :Process 4, :Process 5, :Process 6, :Process 7}
);
gb = Graph Builder( Variables( Y( :Process 1 ) ), Elements( Histogram( Y, Legend( 3 ) ) ) );
columnSwitcher << Link Platform( gb );


```

### [Make Column Switch Handler](#make-column-switch-handler)

**Syntax:** handler = cs \<< Make Column Switch Handler( function(pre), function(post) )

**Description:** Creates a handler for column switches with callback functions which are called before and after the column is switched. The callback functions receive the previous column, the next column and the ColumnSwitcher. The function specified for before the switch should return a non-zero value to allow the switch. Returning 0 will prevent the switch. The function called after the switch shouldn't return a value.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
gb = Graph Builder( Variables( Y( :Process 1 ) ), Elements( Histogram( Y, Legend( 3 ) ) ) );
columnSwitcher = gb << Column Switcher(
    :Process 1,
    {:Process 1, :Process 2, :Process 3, :Process 4, :Process 5, :Process 6, :Process 7}
);
pre = Function( {currentColumn, nextColumn, switcher},
    Print(
        "Before switch: " || (currentColumn << get name) || " >> " || (nextColumn << get name
        ) || " [Column Switcher] current: " || (columnSwitcher << Get Current)
    );
    If( nextColumn << get name == "Process 4",
        0,
        1
    );
);
post = Function( {previousColumn, currentColumn, switcher},
    Print(
        "After switch: " || (previousColumn << get name) || " >> " || (currentColumn <<
        get name) || " [Column Switcher] current: " || (columnSwitcher << Get Current)
    )
);
handler = columnSwitcher << Make Column Switch Handler( pre, post );
columnSwitcher << Run;


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Change the column switcher's selection to the next available choice

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Next;


```

### [Pause](#pause)

**Syntax:** obj \<< Pause

**Description:** pause the animation

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Run;
Wait( 5/*seconds, while it animates*/ );
ColumnSwitcherObject << Pause;


```

### [Previous](#previous)

**Syntax:** obj \<< Previous

**Description:** Change the column switcher's selection to the previous available choice

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Previous;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Remove this Column Switcher

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Run;
Wait( 2/*seconds, while it animates*/ );
ColumnSwitcherObject << Remove Column Switcher;


```

### [Retain Axis Settings](#retain-axis-settings)

**Syntax:** obj \<< Retain Axis Settings( state=0|1 )

**Description:** Some graphs store axis customizations based on the name of the column. By default, these customizations are removed when switching columns. If this option is enabled, the column is updated when switching so that the customizations are applied to the new graph.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
Graph Builder(
    Variables( X( :Process 1 ), Y( :Process 2 ) ),
    Elements( Points( X, Y, Legend( 2 ) ), Smoother( X, Y, Legend( 3 ) ) ),
    Column Switcher(
        :Process 1,
        {:Process 1, :Process 3, :Process 4, :Process 5, :Process 6, :Process 7},
        Retain Axis Settings( 1 )
    ),
    SendToReport(
        Dispatch( {}, "Process 1", ScaleBox,
            {Min( -0.5 ), Max( 22 ), Inc( 4 ), Minor Ticks( 3 ),
            Add Ref Line( 12, "Solid", "Black", "", 1 )}
        )
    )
);


```

### [Run](#run)

**Syntax:** obj \<< Run

**Description:** start the animation

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Run;


```

### [Script](#script)

**Syntax:** obj \<< Script( script )

**Description:** Set a script that is run when the column switches

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Set Script(
    Print( "New Value: " || Char( ColumnSwitcherObject << Get Current ) )
);
ColumnSwitcherObject << Run;
Wait( 5/*seconds, while it animates*/ );


```

### [Set Current](#set-current)

**Syntax:** obj \<< Set Current( string )

**Description:** set the current variable

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Set Current( "country" );


```

### [Set Layout](#set-layout)

**Syntax:** obj \<< Set Layout( 0 = Vertical | 1 = Horizontal )

**Description:** Sets the layout for multiple Column Switchers to vertical(0) or horizontal(1).

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Country ), Y( :Weight ) ),
    Elements( Bar( X, Y, Legend( 4 ) ) )
);
cs1 = gb << Column Switcher( :Country, {:Model, :Country, :Type} );
cs2 = gb << Column Switcher(
    :Weight,
    {:Weight, :Turning Circle, :Displacement, :Horsepower, :Gas Tank Size}
);
cs1 << Set Layout( 1 );


```

### [Set N Lines](#set-n-lines)

**Syntax:** obj \<< Set N Lines( number )

**Description:** Set the number of lines in the List Box of column names

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Set N Lines( 20 );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Set a script that is run when the column switches

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Set Script(
    Print( "New Value: " || Char( ColumnSwitcherObject << Get Current ) )
);
ColumnSwitcherObject << Run;
Wait( 5/*seconds, while it animates*/ );


```

### [Set Size](#set-size)

**Syntax:** obj \<< Set Size( number )

**Description:** Set the pixel width of the List Box of column names

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Set Size( 300 );


```

### [Set Speed](#set-speed)

**Syntax:** obj \<< Set Speed( number )

**Description:** obj\<<setSpeed(60) /\* in Frames Per Minute \*/;

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Set Speed( 60 );/*FPM*/ColumnSwitcherObject << Run;


```

### [Title](#title)

**Syntax:** obj \<< Title( string )

**Description:** Sets the title for the ColumnSwitcher outline box

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
ColumnSwitcherObject << Title( "Switch on X" );


```

# [Columns Manager](#columns-manager)

## [Item Messages](#item-messages)

### [Clear All Filters](#clear-all-filters)

**Syntax:** obj \<< Clear All Filters

**Description:** This option removes all the filters from the summary table. Note that the Set Columns command is not a filter, so calling this command does not remove that restriction on the displayed columns.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Set Text Filter( "t" );
obj << Clear All Filters;


```

### [Create Data Dictionary](#create-data-dictionary)

**Syntax:** obj \<< Create Data Dictionary

**Description:** Create a journal that includes statistics and property information about each column.

**JMP Version Added:** 18

### [Extended Statistics](#extended-statistics)

**Syntax:** obj \<< Extended Statistics(<list of statistics>)

**Description:** Override the default set of extended statistics without having to configure the list in preferences.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager( Include Extended Statistics( 1 ) );
obj << Extended Statistics( {"Median Absolute Deviation", "Q1"} );


```

### [Force calculations for all categorical columns](#force-calculations-for-all-categorical-columns)

**Syntax:** obj \<< Force calculations for all categorical columns( state=0|1 )

**Description:** With this option enabled, stats are calculated for all categorical columns, not just character columns. For example, an expression column calculates the number of missing values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Columns Manager;
obj << Force calculations for all categorical columns( 1 );


```

### [Force calculations for all numeric columns](#force-calculations-for-all-numeric-columns)

**Syntax:** obj \<< Force calculations for all numeric columns( state=0|1 )

**Description:** With this option enabled, numeric stats are calculated for all numeric columns, if possible. For example, the number of unique values is calculated for columns designated as continuous.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Force calculations for all numeric columns( 1 );


```

### [Get Summary Table](#get-summary-table)

**Syntax:** obj \<< Get Summary Table

**Description:** Get the Table Box for the summary table

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
tab = obj << Get Summary table;
tab << Sort By Column( "n unique" );


```

### [Hide Excluded Columns](#hide-excluded-columns)

**Syntax:** obj \<< Hide Excluded Columns( state=0|1 )

**Description:** Include or remove columns marked Excluded from the summary table.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Hide Excluded Columns( 0 );


```

### [Hide Hidden Columns](#hide-hidden-columns)

**Syntax:** obj \<< Hide Hidden Columns( state=0|1 )

**Description:** Include or remove columns marked Hidden from the summary table.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Hide Hidden Columns( 0 );


```

### [Include Extended Statistics](#include-extended-statistics)

**Syntax:** obj \<< Include Extended Statistics( state=0|1 )

**Description:** The set of additional statistics can be configured in Preferences.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Include Extended Statistics( 1 );


```

### [Select Rows](#select-rows)

**Syntax:** obj \<< Select Rows(<empty> | All | None | <column references>)

**Description:** This option selects rows in the summary table corresponding to columns. Clear by passing in no arguments. Select all or none of the visible rows by passing in All or None. Selected specific rows by passing a list of column references.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Select Rows( :age, :height );


```

### [Set Columns](#set-columns)

**Syntax:** obj \<< Set Columns(<columns>)

**Description:** By default the Columns Manager includes all of the columns in the data table as its base set of columns. That set might (or might not) be reduced in the report by applying the removal of excluded columns. This option allows the restriction of the set of columns that the Columns Manager has access to.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Set Columns( {:height, :weight} );


```

### [Set Modeling Type Filter](#set-modeling-type-filter)

**Syntax:** obj \<< Set Modeling Type Filter(<empty> | \<Continuous, Nominal, Ordinal, Vector, Unstructured Text, Multiple Response, None>)

**Description:** This option sets the modeling type filter. Clear by passing no arguments, or specify one or more modeling type names. The filter is satisfied by columns that match any of the analysis types.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Set Modeling Type Filter( "Continuous", "Ordinal" );


```

### [Set Property Filter](#set-property-filter)

**Syntax:** obj \<< Set Property Filter(<empty> | At Least One Property | <list of property names>)

**Description:** This option sets the property filter. Clear by passing no arguments, or specify one or more property names. The filter is specified by columns that contain any of the properties. There is also a special value that is matched by columns having any properties.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Columns Manager;
obj << Set Property Filter( "Matrix Column Names", "Value colors" );


```

### [Set Selection Filter](#set-selection-filter)

**Syntax:** obj \<< Set Selection Filter(<empty> | Keep | Hide)

**Description:** This option sets the selection filter. It allows the user to make arbitrary selection of columns and then filter the list to that set of columns (with Keep, or its inverse with Hide). Clear by passing no arguments.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Select Rows( :age, :height );
obj << Set Selection Filter( "Keep" );


```

### [Set Text Filter](#set-text-filter)

**Syntax:** obj \<< Set Text Filter(<empty> | <search text>)

**Description:** This option sets the current text filter data, which reduces the number of columns shown in the summary table. The text filter is applied only to column names.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Set Text Filter( "me" );


```

### [Show Attributes](#show-attributes)

**Syntax:** obj \<< Show Attributes( state=0|1 )

**Description:** Expand or collapse the section of the summary table that contains column attributes.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Show Attributes( 0 );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties( state=0|1 )

**Description:** Expand or collapse the section of the summary table that contains column properties.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Show Properties( 0 );


```

### [Show Statistics](#show-statistics)

**Syntax:** obj \<< Show Statistics( state=0|1 )

**Description:** Expand or collapse the section of the summary table that contains column statistics.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Columns Manager;
obj << Show Statistics( 0 );


```

# [Compare Data Tables](#compare-data-tables)

## [Associated Constructors](#associated-constructors)

### [Compare Data Tables](#compare-data-tables_1)

**Syntax:** Compare Data Tables( \<Compare with( Data Table( name ))>, \<show window(0 | 1)>, \<limit(integer)>, \<Compare table properties(0 | 1)>, \<Compare column attributes and properties(0 | 1)>, \<Compare data(0 | 1)>, \<Fuzzy compare( \<0 | 1>, \<Relative Error(number)>)>, \<Show difference summary(0 | 1)>, \<Show difference plot(0 | 1)> )

**Description:** Compares two open data tables and reports differences between data, as well as metadata.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );


```

## [Item Messages](#item-messages)

### [Are Data Different](#are-data-different)

**Syntax:** obj \<< Are Data Different

**Description:** Returns true or false depending on whether the data of the two tables are different or not.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
how = (obj << Are Data Different);


```

### [Auto compare](#auto-compare)

**Syntax:** Auto Compare(0|1)

**Description:** Perform comparisons as soon as any setting is changed

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Auto Compare( 1 );


```

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Close the Compare Data Table object

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << close;


```

### [Compare](#compare)

**Syntax:** Compare()

**Description:** Perform comparisons now

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Compare();


```

### [Compare Column Attributes and Properties](#compare-column-attributes-and-properties)

**Syntax:** obj \<< Compare Column Attributes and Properties( state=0|1 )

**Description:** Set or clear the flag to compare the columns attributes and properties. On by default.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << compare column attributes and properties( 1 );


```

### [Compare Data](#compare-data)

**Syntax:** obj \<< Compare Data( state=0|1 )

**Description:** Set or clear the flag to compare the columns data. On by default.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << compare data( 0 );


```

### [Compare Table Properties](#compare-table-properties)

**Syntax:** obj \<< Compare Table Properties( state=0|1 )

**Description:** Set or clear the flag to compare the table variables and scripts. On by default.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << compare table properties;


```

### [Compare With](#compare-with)

**Syntax:** obj \<< Compare With( Data Table( name ) )

**Description:** Compare the first table with this table. Returns true or false.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
obj = dt << Compare Data Tables();
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
same = obj << compare with( dt2 );


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Put the Compare Data Tables script on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Copy Script;


```

### [Fuzzy Compare](#fuzzy-compare)

**Syntax:** obj \<< Fuzzy Compare( \<(state= 1 | 0)>, \<Relative Error (number)> )

**Description:** Set or clear the flag to compare the columns data.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << fuzzy compare( relative error( 0.0001 ) );


```

### [Get column attributes differences](#get-column-attributes-differences)

**Syntax:** obj \<< Get column attributes differences( columns( column) )

**Description:** Get the list of column attributes which are different for the compared columns.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
attribDiff = (obj << Get columns attributes differences( :name ));


```

### [Get column properties differences](#get-column-properties-differences)

**Syntax:** obj \<< Get column properties differences( columns( column) )

**Description:** Get the list of column properties which are different for the compared columns.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
propDiff = (obj << Get columns properties differences( :name ));


```

### [Get columns list](#get-columns-list)

**Syntax:** obj \<< Get columns list( ( <differed in data> | <differed in properties> | <mismatched data type> | <differed in attributes>) )

**Description:** Get the list of columns that differ in data, column properties, data type, or other column attributes.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
colDiff = (obj << Get columns list( differed in attributes ));
Show( colDiff );


```

### [Get difference summary matrix](#get-difference-summary-matrix)

**Syntax:** obj \<< Get difference summary matrix

**Description:** Gets the difference summary as a matrix. The matrix columns correspond to the columns in the difference summary. The first column, action, is represented in the matrix with -1 for Delete, 0 for Replace, and 1 for Add.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
mtx = (obj << Get Difference Summary matrix);


```

### [Get table scripts difference list](#get-table-scripts-difference-list)

**Syntax:** obj \<< Get table scripts difference list

**Description:** Get the list of table scripts that are different or missing.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
scriptDiff = (obj << Get table scripts difference list);


```

### [Get table variables difference list](#get-table-variables-difference-list)

**Syntax:** obj \<< Get table variables difference list

**Description:** Get the list of table variables which are different or missing.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
tvdiff = (obj << Get table variables difference list);


```

### [Get unmatched columns list](#get-unmatched-columns-list)

**Syntax:** obj \<< Get unmatched columns list

**Description:** Get the list of unmatched columns, those that do not have corresponding columns to be compared

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
colDiff = (obj << Get unmatched columns list);


```

### [Hide column properties with no differences](#hide-column-properties-with-no-differences)

**Syntax:** Hide column properties with no differences(0|1)

**Description:** Hide properties that are the same when comparing column properties.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Hide column properties with no differences( 0 );


```

### [Hide columns with no differences](#hide-columns-with-no-differences)

**Syntax:** Hide columns with no differences(0|1)

**Description:** Hide columns that are the same when comparing table data.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Hide columns with no differences( 0 );


```

### [Hide rows with no differences](#hide-rows-with-no-differences)

**Syntax:** Hide rows with no differences(0|1)

**Description:** Hide rows that are the same when comparing table data.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Hide rows with no differences( 0 );


```

### [Hide table properties with no differences](#hide-table-properties-with-no-differences)

**Syntax:** Hide table properties with no differences(0|1)

**Description:** Hide items that are the same when comparing table metadata.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Hide table properties with no differences( 0 );


```

### [Ignore case](#ignore-case)

**Syntax:** Ignore Case(0|1)

**Description:** Ignore character case during data comparison

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Ignore Case( 1 );


```

### [Ignore missing](#ignore-missing)

**Syntax:** Ignore Missing(0|1)

**Description:** Ignore missing values during data comparison

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Ignore Missing( 1 );


```

### [Ignore whitespace](#ignore-whitespace)

**Syntax:** Ignore Whitespce(0|1)

**Description:** Ignore whitespace characters during data comparison

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Ignore Whitespace( 1 );


```

### [Limit](#limit)

**Syntax:** obj \<< Limit( integer )

**Description:** Set the limit for the number of difference. Compare will stop when the limit is reached.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << limit( 100 );


```

### [Link](#link)

**Syntax:** Link({"col1", "col2", \<ID(0|1)>, \<No Compare(0|1)>, \<Fuzzy Compare(\<Ignore Case(0|1)>, \<Ignore Whitespace(0|1)>, \<Ignore Missing(0|1)>, \<Relative Error(<amount>)>)>

**Description:** Specify column pairs to compare and other comparison options.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Link( {:age, :weight}, );


```

### [Relative Error](#relative-error)

**Syntax:** obj \<< Relative Error( integer )

**Description:** Set the relative error for fuzzy compare.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Relative Error( 0.00001 );


```

### [Report](#report)

**Syntax:** obj \<< Report

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Row Alignment](#row-alignment)

**Syntax:** obj \<< Row Alignment (Flexible by Row|By Row|Use ID Columns)

**Description:** Set how the rows are aligned for comparison.

Flexible By Row: attempt to find as many matching rows as possible in order by skipping over blocks of non-matching rows.

By Row: compare each row by line number.

Use ID Columns: the ID columns specified are used to create a key for each row. This key is used to match rows.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Row Alignment( "By Row" );


```

### [Save Difference Summary](#save-difference-summary)

**Syntax:** obj \<< Save Difference Summary( \<invisible(0 | 1)> )

**Description:** Save the difference summary in a data table.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
summaryDT = (obj << save difference summary( invisible ));


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** obj \<< Save Script to Data Table

**Description:** Save the Compare Data Tables script as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Save Script to Data Table;


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Add a Button to the journal containing the Compare Data Tables script.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Save Script to Journal;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Append the Compare Data Tables script to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Save Script to Script Window;


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( Show window( 0|1) )

**Description:** Show or hide the window for Compare Data Table

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << show window( 1 );


```

### [Show fuzzy differences](#show-fuzzy-differences)

**Syntax:** Show Fuzzy Differences(0|1)

**Description:** Hilite differences in data comparison for values that are equal only because of fuzzy comparison settings

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Show Fuzzy Differences( 1 );


```

### [Unlink](#unlink)

**Syntax:** Unlink(\<column name 1>, \<column name 2>)

**Description:** Remove the column comparison.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Unlink( {"a", "b"} );


```

### [Unlink All](#unlink-all)

**Syntax:** Unlink All

**Description:** Remove all column comparisons.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
obj = dt << Compare Data Tables( compare With( Data Table( "Students2" ) ) );
obj << Unlink All;


```

# [Constant Stress ALT Design](#constant-stress-alt-design)

## [Associated Constructors](#associated-constructors)

### [ALT Plan](#alt-plan)

**Syntax:** ALT Plan

### [Factors](#factors)

**Syntax:** Factors

**Description:** Creates the Factor Table in the CSALT platform.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

## [Item Messages](#item-messages)

### [Factor](#factor)

**Syntax:** obj \<< Factor

**Description:** Adds a factor with the specified properties.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [Factor Name](#factor-name)

**Syntax:** obj \<< Factor Name

**Description:** Sets the name of the factor.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [Factor Transformation](#factor-transformation)

**Syntax:** obj \<< Factor Transformation( Arrhenius Celsius|Arrhenius Fahrenheit|Arrhenius Kelvin|Reciprocal|Log|Root|None )

**Description:** Sets the transformation function for the levels of the factor.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [High Test Condition](#high-test-condition)

**Syntax:** obj \<< High Test Condition

**Description:** Sets the highest testing level for the factor.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [High Usage Condition](#high-usage-condition)

**Syntax:** obj \<< High Usage Condition

**Description:** Sets the highest level for the usage condition for the factor. This value can be the same as the lowest usage condition.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [Low Test Condition](#low-test-condition)

**Syntax:** obj \<< Low Test Condition

**Description:** Sets the lowest testing level for the factor.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [Low Usage Condition](#low-usage-condition)

**Syntax:** obj \<< Low Usage Condition

**Description:** Sets the lowest level for the usage condition for the factor. This value can be the same as the highest usage condition.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [Number of Levels](#number-of-levels)

**Syntax:** obj \<< Number of Levels

**Description:** Sets the number of levels for the factor. Primarily used for balanced designs.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    )
);


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a Script that will reproduce this design.

```

d = Constant Stress ALT Design(
    Factors(
        Factor(
            Factor Name( "X1" ),
            Number of Levels( 3 ),
            Factor Transformation( "Arrhenius Celsius" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        ),
        Factor(
            Factor Name( "X2" ),
            Number of Levels( 3 ),
            Factor Transformation( "Log" ),
            Low Usage Condition( 20 ),
            High Usage Condition( 30 ),
            Low Test Condition( 90 ),
            High Test Condition( 110 ),

        )
    ),
    ALT Plan(),
    Save Script to Script Window
);


```

# [Contour Plot](#contour-plot)

## [Associated Constructors](#associated-constructors)

### [Contour Plot](#contour-plot_1)

**Syntax:** Contour Plot( X( column, column ), Y( column ) )

**Description:** Produces a graph of three variables in a two-dimensional view, where the third variable is represented by contour curves of equal value.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Contour Plot(...\<By( column(s) )>...)

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [X](#x)

**Syntax:** obj = Contour Plot(...X( column, column )...)

**Description:** Two independent variables that define the domain.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );


```

### [Y](#y)

**Syntax:** obj = Contour Plot(...Y( column(s) )...)

**Description:** The response variable that will be used to compute curves of constant value over the domain.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );


```

## [Item Messages](#item-messages)

### [Fill Areas](#fill-areas)

**Syntax:** obj \<< Fill Areas( state=0|1 )

**Description:** Fills the areas between the contours with a solid color on the contour plot.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Fill Areas( 1 );


```

### [Fit to Window](#fit-to-window)

**Syntax:** obj \<< Fit to Window( "Auto"|"On"|"Off" )

**Description:** Sets the auto stretching behavior of the report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Fit to Window( "Off" );


```

### [Generate Grid](#generate-grid)

**Syntax:** dt = obj \<< Generate Grid( Xsize, Ysize )

**Description:** Saves a grid of the contour information in a new data table for contours currently drawn on the contour plot.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Generate Grid( 11, 11 );


```

### [Label Contours](#label-contours)

**Syntax:** obj \<< Label Contours( state=0|1 )

**Description:** Shows or hides the label or z-value of the contour lines.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Label Contours( 1 );


```

### [Retrieve Contours](#retrieve-contours)

**Syntax:** obj \<< Retrieve Contours( table )

**Description:** Retrieves contour information stored in a data table for contours drawn on the contour plot.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Specify Contours(
    Min( -4 ),
    Max( 6 ),
    N( 3 ),
    Contour( 1, -4, -2768895 ),
    Contour( 2, 1, -9344469 ),
    Contour( 3, 6, -13927556 )
);
obj << Save Contours;
obj << Revert Contours;
obj << Retrieve Contours( Data Table( "Contours from Little Pond" ) );


```

### [Revert Contours](#revert-contours)

**Syntax:** obj \<< Revert Contours

**Description:** Reverts any changes to contours drawn on the contour plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Specify Contours(
    Min( -4 ),
    Max( 8 ),
    N( 4 ),
    Contour( 1, -4, -2768895 ),
    Contour( 2, 0, -7700704 ),
    Contour( 3, 4, -12632256 ),
    Contour( 4, 8, -14575206 ),
    Contour( 5, 8, -16517899 )
);
Wait( 2 );
obj << Revert Contours;


```

### [Save Contours](#save-contours)

**Syntax:** dt = obj \<< Save Contours

**Description:** Saves contour information stored in a new data table for contours currently drawn on the contour plot.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Save Contours;


```

### [Save Triangulation](#save-triangulation)

**Syntax:** dt = obj \<< Save Triangulation

**Description:** Lists the coordinates of each triangle used to construct the contours in a new data table.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Save Triangulation;


```

### [Set Alpha](#set-alpha)

**Syntax:** obj \<< Set Alpha( number )

**Description:** Set the alpha value to control the shape of the boundary. A value of 0 results in the convex hull of the point set. Larger values of alpha remove triangles with long edges.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Contour Plot( X( :Longitude, :Latitude ), Y( :Pop ), Fill Areas( 1 ) );
obj << Set Alpha( 0.06 );


```

### [Show Boundary](#show-boundary)

**Syntax:** obj \<< Show Boundary( state=0|1 )

**Description:** Shows or hides the boundary around the total contour area on the contour plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Show Boundary( 1 );


```

### [Show Contours](#show-contours)

**Syntax:** obj \<< Show Contours( state=0|1 )

**Description:** Shows or hides the data points on the contour plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Show Contours( 1 );


```

### [Show Control Panel](#show-control-panel)

**Syntax:** obj \<< Show Control Panel( state=0|1 )

**Description:** Shows or hides the controls for the shape boundary.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Contour Plot( X( :Longitude, :Latitude ), Y( :Pop ), Fill Areas( 1 ) );
obj << Set Alpha( 0.06 );
obj << Show Control Panel( 1 );


```

### [Show Data Points](#show-data-points)

**Syntax:** obj \<< Show Data Points( state=0|1 )

**Description:** Shows or hides the data points on the contour plot.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Show Data Points( 1 );


```

### [Show Missing Data Points](#show-missing-data-points)

**Syntax:** obj \<< Show Missing Data Points( state=0|1 )

**Description:** Shows or hides points with missing Y values if data points are shown

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "SqrtZ", Numeric, Continuous, Formula( Sqrt( Z ) ) );
r = dt << Select Where( :Z < 0 );
r << Colors( "Red" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :SqrtZ ) );
obj << Show Data Points( 1 );
Wait( 2 );
obj << Show Missing Data Points( 1 );


```

### [Specify Contours](#specify-contours)

**Syntax:** obj \<< Specify Contours( Min( value ), Max( value ), N( number ), Contour(1, value, color), Contour(2, value, color), ... Contour(n+1, value, color) )

**Description:** Changes the number and size of the contours on the contour plot.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Specify Contours(
    Min( -4 ),
    Max( 8 ),
    N( 4 ),
    Contour( 1, -4, -2768895 ),
    Contour( 2, 0, -7700704 ),
    Contour( 3, 4, -12632256 ),
    Contour( 4, 8, -14575206 ),
    Contour( 5, 8, -16517899 )
);


```

### [Transform](#transform)

**Syntax:** obj \<< Transform( "None"|"Range Normalized" )

**Description:** Set the transform for the triangulation computation. Transformation will not affect the coordinates of the output, but the triangulation will be computed in the transformed space. This might result in a different triangulation depending on the aspect ratio of the coordinate space and transformed space.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Contour Plot( X( :Longitude, :Latitude ), Y( :Pop ), Fill Areas( 1 ) );
Wait( 2 );
obj << Transform( "Range Normalized" );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Plot(
    X( :X, :Y ),
    Y( :Z ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Contour Plot(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Contour Profiler](#contour-profiler)

## [Associated Constructors](#associated-constructors)

### [Contour Profiler](#contour-profiler_1)

**Syntax:** Contour Profiler( Y( column1, column2, ... ) )

**Description:** Produces an interactive contour plot that enables you to explore how one or more predicted responses change across pairs of factors. The values of factors not used in the plot can be varied to further explore the impact of the factor settings on the predicted responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

## [Columns](#columns)

### [Noise Factors](#noise-factors)

**Syntax:** obj = Contour Profiler(...\<Noise Factors( column(s) )>...)

**Description:** Specifies noise factors, which must be columns that are ingredients to the formula columns. Noise factors are used to study robustness (or flatness) with respect to transmitted variation from these factors. The resulting profiler includes derivatives of the formulas with respect to the noise factors.

**Contour Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Custom Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Mixture Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Noise Factors( :p1 ) );


```

**Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

### [Prediction Formula](#prediction-formula)

**Syntax:** obj = Contour Profiler(...Prediction Formula( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

### [Y](#y)

**Syntax:** obj = Contour Profiler(...Y( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

## [Item Messages](#item-messages)

### [Animation](#animation)

**Syntax:** obj \<< Animation( \<Tour Type( "Sequential"|("Single Factor",factorname)|"Random"|"Data Sequential"|"Data Random" )>, \<Speed(ticks)>, <Go>, <Stop> )

**Description:** Starts or stops the animation of the profiler. You can also specify how the animation cycles through factor combinations.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Animation( Tour Type( "Sequential" ), Go );
Wait( 3 );
obj << Animation( "Stop" );


```

### [Append Settings to Table](#append-settings-to-table)

**Syntax:** obj \<< Append Settings to Table

**Description:** Saves the settings of the current profiler as a new row at the end of the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Append Settings to Table;


```

### [Arrange X Controls Left](#arrange-x-controls-left)

**Syntax:** obj \<< Arrange X Controls Left( state=0|1 )

**Description:** Rearranges the X and Y controls horizontally so that the X controls are on the left.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Arrange X Controls Left( 1 );


```

### [Broadcast Factor Settings](#broadcast-factor-settings)

**Syntax:** obj \<< Broadcast Factor Settings

**Description:** Sends the factor settings for the current profiler to all other profilers. This option does not link the profilers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 ),
    Term Value(
        SILICA( 1.75, Lock( 0 ), Show( 1 ) ),
        SILANE( 45.2, Lock( 0 ), Show( 1 ) ),
        SULFUR( 2.45, Lock( 0 ), Show( 1 ) )
    )
);
obj << Contour Profiler( 1 );
Wait( 1 );
obj << Broadcast Factor Settings;


```

### [Clipping](#clipping)

**Syntax:** obj \<< Clipping( horizCenter,horizWidth,verticalCenter,VerticalWidth )

**Description:** Sets up a clipping region, which is circular for wafer maps.

```

dt = Open( "$Sample_Data/Wafer Stacked.jmp" );
Neural(
    Y( :Defects ),
    X( :X_Die, :Y_Die ),
    Informative Missing( 0 ),
    Validation Method( "Holdback", 0.3333 ),
    Fit(
        NGaussian( 9 ),
        Contour Profiler(
            1,
            Term Value(
                :X_Die( 0, Lock( 0 ), Show( 1 ) ), :Y_Die( 0, Lock( 0 ), Show( 1 ) )
            ),
            Contour Value( :Defects( 0.1309, Min( -0.28 ), Max( 7.28 ) ) ),
            Grid Density( "40 x 40" ),
            Contour Grid( 0, 0.275, 0.025, :Defects, Filled( 1 ), Reverse Scale( 0 ) ),
            Horizontal Factor( :X_Die ),
            Vertical Factor( :Y_Die ),
            Clipping( {0, 0}, {42, 42} )
        )
    ),
    SendToReport(
        Dispatch( {"Model NGaussian(9)", "Contour Profiler"}, "Contour Profiler Frame",
            FrameBox,
            {Frame Size( 400, 400 )}
        )
    )
);


```

### [Conditional Predictions](#conditional-predictions)

**Syntax:** scrobj \<< Conditional Predictions( state=0|1 )

**Description:** Includes random effects when formulating the predicted value and profiles. This option is available only when random effects are included in the model.

```

dt = Open( "$Sample_Data/Reactor.jmp" );
Column( "A" ) << Set Modeling Type( "Nominal" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Ct, :T, :Cn, :Ct * :T, :T * :Cn ),
    Random Effects( :A ),
    Emphasis( "Minimal Report" ),
    Run( Contour Profiler( 1 ) )
);
scrobj = (Report( obj )["Contour Profiler"] << get scriptable object);
scrobj << Conditional Predictions( 1 );


```

### [Contour Grid](#contour-grid)

**Syntax:** obj \<< Contour Grid( minimum, maximum, increment, y column, Filled( state=0|1 ), Reverse Scale( state=0|1 ) )

**Description:** Draws a contour grid on the contour profiler. The grid is based on the specified intervals.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Contour Grid( 525.7492294, 2173.9472704279, 206.024755128638, :PredFormulaMODULUS );


```

### [Contour Label](#contour-label)

**Syntax:** obj \<< Contour Label( state=0|1 )

**Description:** Shows or hides the name of the response variables as labels on the contour profiler. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Contour Label( 0 );


```

### [Contour Value](#contour-value)

**Syntax:** obj \<< Contour Value( y1( number, \<Lo Limit( number )>, \<Hi Limit( number )>, \<Min( number )>, \<Max( number )>), y2 (...) )

**Description:** Sets specific contour values for responses in the contour profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Contour Value(
    :PredFormulaAbrasion( 167, Lo Limit( 160 ), Hi Limit( 180 ) ), :Pred Formula Elong( 320 )
);


```

### [Copy Settings Script](#copy-settings-script)

**Syntax:** obj \<< Copy Settings Script

**Description:** Copies the current factor settings to the clipboard. The settings can then be pasted into another profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Custom Profiler](#custom-profiler)

**Syntax:** obj \<< Custom Profiler( state=0|1 )

**Description:** Shows or hides the Custom Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Custom Profiler( 1 );


```

### [Data Points](#data-points)

**Syntax:** obj \<< Data Points( state=0|1 )

**Description:** Shows or hides the data points.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Data Points( 1 );


```

### [Formulas for OPTMODEL](#formulas-for-optmodel)

**Syntax:** obj \<< Formulas for OPTMODEL

**Description:** Saves the prediction formulas from the model in a new file as SAS statements for PROC OPTMODEL.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Formulas for OPTMODEL;


```

### [Get Constraints](#get-constraints)

**Syntax:** obj \<< Get Constraints

**Description:** Returns a list of factor constraints.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Profiler(
    Y( :Pred Formula Y ),
    Profiler( 1, Profile at Boundary( "Stop at Boundaries" ), )
);
obj << Get Constraints;


```

### [Get Factor Settings](#get-factor-settings)

**Syntax:** obj \<< Get Factor Settings

**Description:** Returns the current factor settings as a list.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Get Factor Settings;


```

### [Get Factor Settings Script](#get-factor-settings-script)

**Syntax:** obj \<< Get Factor Settings Script

**Description:** Returns the current factor settings as an expression that can be used in a script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Get Factor Settings Script;


```

### [Get Simulator](#get-simulator)

**Syntax:** obj \<< Get Simulator

**Description:** Returns a reference to the Simulator.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ), SILANE << Fixed( 50 ),
        SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << Add Random Noise( 1 ),
        Pred Formula HARDNESS << Add Random Weighted Noise( 1 )
    )
);
obj2 = obj << Get Simulator;
obj2 << Simulation Experiment;


```

### [Graph Updating](#graph-updating)

**Syntax:** obj \<< Graph Updating( "Per Mouse Move"|"Per Mouse Up" )

**Description:** Sets the frequency of updating the Contour Profiler. The Per Mouse Move setting updates the graph as the mouse moves. The Per Mouse Up setting updates the graph after the mouse button has been released.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Graph Updating( "Per Mouse Up" );
// use your mouse to move the slider scale for a response


```

### [Grid Density](#grid-density)

**Syntax:** obj \<< Grid Density( "10 x 10"|"20 x 20"|"30 x 30"|"40 x 40"|"50 x 50"|"60 x 60" )

**Description:** Sets the density of the individual mesh or surface plots.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Grid Density( "10 x 10" );


```

### [Hide X Controls](#hide-x-controls)

**Syntax:** obj \<< Hide X Controls( state=0|1 )

**Description:** Shows or hides the control settings for the factors.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Hide X Controls( 1 );


```

### [Hide Y Controls](#hide-y-controls)

**Syntax:** obj \<< Hide Y Controls( state=0|1 )

**Description:** Shows or hides the control settings for the responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Hide Y Controls( 1 );


```

### [Horizontal Factor](#horizontal-factor)

**Syntax:** obj \<< Horizontal Factor( column )

**Description:** Specifies the factor that is displayed on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 2 );
obj << Horizontal Factor( :SULFUR );


```

### [Link Profilers](#link-profilers)

**Syntax:** obj \<< Link Profilers( state=0|1 )

**Description:** Links all the profilers in a single report together, so that a change in a factor in one profiler causes that factor to change to that value in all other profilers.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Prediction Profiler( 1 );
obj << Contour Profiler( 1 );
obj << Link Profilers( 1 );
Wait( 1 );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );


```

### [Multiple Contour Frames](#multiple-contour-frames)

**Syntax:** obj \<< Multiple Contour Frames( Horizontal Factor( column ), Vertical Factor( column ), <Remove Previous Frames> )

**Description:** Adds another contour plot that represents the specified combination of factors.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Multiple Contour Frames( Horizontal Factor( :SULFUR ), Vertical Factor( :SILANE ) );


```

### [Number of Plots Across](#number-of-plots-across)

**Syntax:** obj \<< Number of Plots Across( number )

**Description:** Specifies the layout of the plots when multiple contour frames are shown in the report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Multiple Contour Frames( Horizontal Factor( :Sulfur ), Vertical Factor( :Silane ) );
obj << Multiple Contour Frames( Horizontal Factor( :Silane ), Vertical Factor( :Silica ) );
obj << Number of Plots Across( 2 );


```

### [Paste Settings Script](#paste-settings-script)

**Syntax:** obj \<< Paste Settings Script

**Description:** Pastes the profiler settings from the clipboard to a profiler in another report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Predict for Another Table](#predict-for-another-table)

**Syntax:** obj \<< Predict for Another Table( <data table> )

**Description:** Adds prediction columns to a specified data table, using the factors in that table. This option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
dt2 = dt << Subset(
    All rows,
    columns( :SILICA, :SILANE, :SULFUR ),
    Output Table( "Subset" )
);
obj << Predict For Another Table( dt2 );


```

### [Prediction Profiler](#prediction-profiler)

**Syntax:** obj \<< Prediction Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Prediction Profiler( 1 );


```

### [Remember Settings](#remember-settings)

**Syntax:** obj \<< Remember Settings

**Description:** Adds an outline node to the report with the values of the factor settings.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Remember Settings;


```

### [Remove Contour Grid](#remove-contour-grid)

**Syntax:** obj \<< Remove Contour Grid

**Description:** Removes the contour grid that is overlaid on the contour profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Contour Grid( 525.7492294, 2173.9472704279, 206.024755128638, :PredFormulaMODULUS );
Wait( 2 );
obj << Remove Contour Grid;


```

### [Reset](#reset)

**Syntax:** obj \<< Reset

**Description:** Updates the predictions at the current values.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );
obj << Reset;


```

### [Save Expanded Formulas](#save-expanded-formulas)

**Syntax:** obj \<< Save Expanded Formulas

**Description:** Saves a new formula column to the data table. The new column contains resolved formula references within the formulas used as Y variables to see the underlying variables. This is available only after the Expand Intermediate Formulas option is selected in the launch window or the Expand message is specified in the Profiler script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Profiler( Y( :GP Fit, :NL Fit, :Difference ), Expand, Contour Profiler( 1 ) );
obj << Save Expanded Formulas;


```

### [Set Contours to Current](#set-contours-to-current)

**Syntax:** obj \<< Set Contours to Current

**Description:** Resets the contour lines to where the current Y values are located.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Contour Value(
    :PredFormulaAbrasion( 167, Lo Limit( 160 ), Hi Limit( 180 ) ), :Pred Formula Elong( 320 )
);
Wait( 1 );
obj << Set Contours to Current;


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( Function( {arguments}, \<{locals}>, expr ) )

**Description:** Sets a script that is run each time a factor changes.

```

ProfileCallbackLog = Function( {arg}, Show( arg ) );
dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set Script( ProfileCallbackLog );
obj << Term Value( :Silica( 1 ) );


```

### [Set to Data in Row](#set-to-data-in-row)

**Syntax:** obj \<< Set to Data in Row( row number )

**Description:** Assigns the values of a data table row to the X variables in the profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 2 );
obj << Set to Data in Row( 4 );


```

### [Show Formulas](#show-formulas)

**Syntax:** obj \<< Show Formulas

**Description:** Opens a script window that contains JSL for all formulas that are being profiled.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Formulas;


```

### [Simulator](#simulator)

**Syntax:** obj \<< Simulator( state=0|1 )

**Description:** Shows or hides the Simulator.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator( 1 );


```

### [Surface Plot](#surface-plot)

**Syntax:** obj \<< Surface Plot( state=0|1 )

**Description:** Shows or hides the individual mesh plots.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Surface Plot( 1 );


```

### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides the Surface Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Surface Profiler( 1 );


```

### [Term Value](#term-value)

**Syntax:** obj \<< Term Value( (x1( number ),x2( number ), ... )

**Description:** Sets specific term values for factors on the contour profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );


```

### [Unthreaded](#unthreaded)

**Syntax:** obj \<< Unthreaded( state=0|1 )

**Description:** To suppress any multithreading in evaluating the profile traces, the contour grid, and the optimizer trips.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Unthreaded( 1 );
obj << Maximize Desirability;


```

### [Up Dots](#up-dots)

**Syntax:** obj \<< Up Dots( state=0|1 )

**Description:** Shows or hides dots next to the contour lines. These dots indicate the upward direction of the response. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Up Dots( 0 );


```

### [Vertical Factor](#vertical-factor)

**Syntax:** obj \<< Vertical Factor( column )

**Description:** Specifies the factor that is displayed on the vertical axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 2 );
obj << Vertical Factor( :SULFUR );


```

### [Y Colors](#y-colors)

**Syntax:** obj \<< Y Colors( color1, color2, ... )

**Description:** Specifies the colors for each Y term in both the contour plot and the individual mesh plots.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Surface Plot( 1 )
);
obj << Y Colors( 8, 4, 5, 46 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Control Chart Builder](#control-chart-builder)

## [Associated Constructors](#associated-constructors)

### [Control Chart Builder](#control-chart-builder_1)

**Syntax:** Control Chart Builder( Class( "Shewhart Variables"|"Shewhart Attribute"|"Short Run"|"Rare Event" ), Variables( variables ), \<Chart( Position( number ), Points( Statistic( "statistic" ), <points options> ), Limits( Sigma( "sigma" ), <limits options> )> ) ) )

**Description:** Enables you to interactively create control charts, which are used to determine whether a process is stable and predictable. The Control Chart Builder platform can be used to create the following types of control charts: IMR, XBar, Short Run, Run, P, NP, C, U, Laney P', Laney U', Levey-Jennings, IMR on Means, Three Way, and Rare Event charts.

#### [C Chart](#c-chart)

```

// Create a C chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Count, and changing the Sigma to Poisson.
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Poisson" ) ) ),
    Show Control Panel( 0 )
);


```

#### [IMR Chart](#imr-chart)

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );


```

#### [IMR on Group Standard Deviation Chart (Set Subgroup Size)](#imr-on-group-standard-deviation-chart-set-subgroup-size)

```

// Create an IMR on Group Standard Deviation chart by adding a Y variable and defining a subgroup size, and changing the Statistic on the location chart to Standard Deviation, on the dispersion chart to Moving Range on Std Dev and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [IMR on Group Standard Deviation Chart (Subgroup Variable)](#imr-on-group-standard-deviation-chart-subgroup-variable)

```

// Create an IMR on Group Standard Deviation chart by adding a Y variable and a subgroup variable, and changing the Statistic on the location chart to Standard Deviation, on the dispersion chart to Moving Range on Std Dev and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [IMR on Means Chart (Set Subgroup Size)](#imr-on-means-chart-set-subgroup-size)

```

// Create an IMR on Means chart by adding a Y variable and defining a subgroup size, and changing the Statistic on the dispersion chart to Moving Range on Means and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart( Position( 1 ), Limits( Sigma( "Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [IMR on Means Chart (Subgroup Variable)](#imr-on-means-chart-subgroup-variable)

```

// Create an IMR on Means chart by adding a Y variable and a subgroup variable, and changing the Statistic on the dispersion chart to Moving Range on Means and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Levey-Jennings Chart](#levey-jennings-chart)

```

// Create a Levey-Jennings chart by adding a Y variable, removing the dispersion chart, and changing the Sigma to Levey Jennings. Make sure that the Statistic is set to Individual.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Show Two Shewhart Charts( 0 ),
    Variables( Y( :Weight ) ),
    Chart( Points( Statistic( "Individual" ) ), Limits( Sigma( "Levey Jennings" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range Chart](#median-moving-range-chart)

```

// Create a Median Moving Range chart by adding a Y variable and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Chart( Position( 2 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Means Chart (Set Subgroup Size)](#median-moving-range-on-group-means-chart-set-subgroup-size)

```

// Create a Median Moving Range on Group Means chart by adding a Y variable and defining a subgroup size, changing the Statistic on the dispersion chart to Moving Range on Means, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart( Position( 1 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Means Chart (Subgroup Variable)](#median-moving-range-on-group-means-chart-subgroup-variable)

```

// Create a Median Moving Range on Group Means chart by adding a Y variable and a subgroup variable, changing the Statistic on the dispersion chart to Moving Range on Means, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Standard Deviations Chart (Set Subgroup Size)](#median-moving-range-on-group-standard-deviations-chart-set-subgroup-size)

```

// Create a Median Moving Range on Group Standard Deviations chart by adding a Y variable and defining a subgroup size, changing the Statistic on the location chart to Standard deviation, on the dispersion chart to Moving Range on Std Dev, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Standard Deviations Chart (Subgroup Variable)](#median-moving-range-on-group-standard-deviations-chart-subgroup-variable)

```

// Create a Median Moving Range on Group Standard Deviations chart by adding a Y variable and a subgroup variable, changing the Statistic on the location chart to Standard deviation, on the dispersion chart to Moving Range on Std Dev, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [NP Chart](#np-chart)

```

// Create an NP chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Count, and changing the Sigma to Binomial (P, NP).
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Binomial" ) ) ),
    Show Control Panel( 0 )
);


```

#### [P Chart](#p-chart)

```

// Create a P chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Binomial (P, NP).
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Binomial" ) ) ),
    Show Control Panel( 0 )
);


```

#### [P' Chart](#p-chart_1)

```

// Create a P' chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Laney P'.
dt = Open( "$SAMPLE_DATA/Quality Control/Washers.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Lot ), Y( :"# defective"n ), n Trials( :Lot Size ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Laney P Prime" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Rare Event G Chart](#rare-event-g-chart)

```

// Create a G chart by changing the class to Rare Event and adding a nonnegative discrete Y variable. Make sure that the Sigma is set to Negative Binomial.
dt = Open( "$SAMPLE_DATA/Quality Control/Fan Burnout.jmp" );
obj = dt << Control Chart Builder(
    Class( "Rare Event" ),
    Variables( Subgroup( :Burnout ), Y( :Hours between Burnouts ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Negative Binomial" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Rare Event T Chart](#rare-event-t-chart)

```

// Create a T chart by changing the class to Rare Event, changing the Sigma to Weibull, and adding a nonnegative discrete Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Fan Burnout.jmp" );
obj = dt << Control Chart Builder(
    Class( "Rare Event" ),
    Variables( Subgroup( :Burnout ), Y( :Hours between Burnouts ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Weibull" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Run Chart](#run-chart)

```

// Create a Run chart by adding a Y variable, turning off the limits, and removing the dispersion chart.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Show Two Shewhart Charts( 0 ),
    Show Limit Summaries( 0 ),
    Variables( Y( :Weight ) ),
    Chart( Limits( Show Lower Limit( 0 ), Show Upper Limit( 0 ) ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Difference Chart](#short-run-difference-chart)

```

// Create a Short Run Difference chart by changing the class to Short Run and adding a Product or Part variable. Make sure that the Statistic values for the location chart and dispersion chart are set to Centered and Moving Range Centered, respectively. Centered Short Run control charts are sometimes referred to as Deviation from Nominal (DNOM) charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Difference Chart for XBar](#short-run-difference-chart-for-xbar)

```

// Create a Short Run Difference chart for summarized data by changing the class to Short Run and adding a Product or Part variable,  Short Run Standardized charts are sometimes referred to as Z-MR charts. Centered Short Run control charts are sometimes referred to as Deviation from Nominal (DNOM) charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Fancy Chocolate Factory.jmp" );
obj = dt << Control Chart Builder(
    Show Product Separators( 0 ),
    Class( "Short Run" ),
    Variables( Subgroup( :Box ), Y( :"%Cocoa"n ), Part( :Product ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Standardized Chart](#short-run-standardized-chart)

```

// Create a Short Run Standardized chart by changing the class to Short Run and adding a Subgroup and a Product or Part variable, changing the Statistic for the location chart type to Standardized, and changing the Statistic for the dispersion chart to Moving Range Standardized. Short Run Standardized charts are sometimes referred to as Z-MR charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Chart( Position( 1 ), Points( Statistic( "Standardized" ) ) ),
    Chart( Position( 2 ), Points( Statistic( "Moving Range Standardized" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Standardized Chart for XBar](#short-run-standardized-chart-for-xbar)

```

// Create a Short Run Standardized chart for summarized data by changing the class to Short Run and adding a Subgroup and a Product or Part variable,  Short Run Standardized charts are sometimes referred to as Z-MR charts. Centered Short Run control charts are sometimes referred to as Deviation from Nominal (DNOM) charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Fancy Chocolate Factory.jmp" );
obj = dt << Control Chart Builder(
    Show Product Separators( 0 ),
    Class( "Short Run" ),
    Variables( Subgroup( :Box ), Y( :"%Cocoa"n ), Part( :Product ) ),
    Chart( Position( 1 ), Points( Statistic( "Standardized" ) ) ),
    Chart( Position( 2 ), Points( Statistic( "Range Standardized" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Three Way Chart (Set Subgroup Size)](#three-way-chart-set-subgroup-size)

```

// Create a Three Way chart by adding a dispersion chart after adding a Y variable and setting a subgroup size.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Average" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 3 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Standard Deviation" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Three Way Chart (Subgroup Variable)](#three-way-chart-subgroup-variable)

```

// Create a Three Way chart by adding a dispersion chart after adding a Y variable and adding a subgroup variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Average" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart( Position( 3 ), Points( Statistic( "Range" ) ), Limits( Sigma( "Range" ) ) ),
    Show Control Panel( 0 )
);


```

#### [U Chart](#u-chart)

```

// Create a U chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Poisson.
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Poisson" ) ) ),
    Show Control Panel( 0 )
);


```

#### [U' Chart](#u-chart_1)

```

// Create a U' chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Laney U'.
dt = Open( "$SAMPLE_DATA/Quality Control/Washers.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Lot ), Y( :"# defective"n ), n Trials( :Lot Size ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Laney U Prime" ) ) ),
    Show Control Panel( 0 )
);


```

#### [XBar/R Chart](#xbarr-chart)

```

// Create an XBar/R chart by adding a subgroup or setting a subgroup size after adding a Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Show Control Panel( 0 )
);


```

#### [XBar/S Chart (Set Subgroup Size)](#xbars-chart-set-subgroup-size)

```

// Create an XBar/S chart by adding a Y variable and defining a subgroup size, changing the Statistic for the dispersion chart to Standard Deviation, and changing the Sigma for the location chart to Standard Deviation.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart( Position( 1 ), Limits( Sigma( "Standard Deviation" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Standard Deviation" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [XBar/S Chart (Subgroup Variable)](#xbars-chart-subgroup-variable)

```

// Create an XBar/S chart by adding a Y variable and a subgroup variable, changing the Statistic for the dispersion chart to Standard Deviation, and changing the Sigma for the location chart to Standard Deviation.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Standard Deviation" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Standard Deviation" ) )
    ),
    Show Control Panel( 0 )
);


```

## [Item Messages](#item-messages)

### [Add Limits](#add-limits)

**Syntax:** obj \<< Chart( Position( number ), Add Limits( {LCL( number ), Avg( number ), UCL( number )} ) )

**Description:** Adds an additional set of limits for the specified chart. The added limits appear as dashed lines.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Show Control Panel( 0 )
);
obj << Chart( Position( 1 ), Add Limits( {LCL( 17.5 ), Avg( 20.25 ), UCL( 23 )} ) );


```

### [Add Spec Limits](#add-spec-limits)

**Syntax:** obj \<< Chart( Position( number ), Add Spec Limits( {LSL( number ), Target( number ), USL( number )} ) )

**Description:** Sets the specification limits for each Y variable.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Show Control Panel( 0 )
);
obj << Chart( Position( 1 ), Add Spec Limits( {LSL( 18 ), Target( 20.1 ), USL( 22.2 )} ) );


```

### [Alarm Script](#alarm-script)

**Syntax:** obj \<< Alarm Script( Write( "..." )|Speak( "..." )|Mail( address, subject,"..." ) )

**Description:** Sends a message whenever a point on a control chart fails a given test. The message can be sent to the log, can be spoken, or can be emailed.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Warnings( Test 1( 1 ) ) ),
    Show Control Panel( 0 )
);
obj << Alarm Script(
    Write(
        "Out of Control for test ",
        qc_test,
        " in column ",
        qc_col,
        " in sample ",
        qc_sample,
        " in phase ",
        qc_phase
    )
);


```

### [Chart](#chart)

**Syntax:** obj \<< Chart( Position( number ), \<Points( Statistic(),... )>, \<Set Control Limits( { LCL(), UCL(), Avg() } )>, \<Add Limits( { LCL(), UCL(), Avg() } )>, \<Add Spec Limits( { LSL(), USL(), Target() } )>, \<Limits( Sigma(), ... )>, \<Warnings( Test number( state=0|1 ) )> )

**Description:** Sets the warning, limit, and point attributes for the chart that is specified by the Position argument.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Warnings( Test 1( 1 ) ),
        Add Limits( {LCL( 18 ), UCL( 22.4 ), Avg( 20.2 )} )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Standard Deviation" ) )
    ),
    Show Control Panel( 0 )
);


```

### [Class](#class)

**Syntax:** obj \<< Class( "Shewhart Variables"|"Shewhart Attribute"|"Short Run"|"Rare Event" )

**Description:** Specifies the class or family of point and sigma statistic combinations.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma ) ),
    Show Control Panel( 0 )
);


```

### [Color By Product](#color-by-product)

**Syntax:** obj \<< Color By Product( state=0|1 )

**Description:** Colors the points plotted by the level of the product variable. On by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Color By Product( 1 );


```

### [Connect Thru Missing](#connect-thru-missing)

**Syntax:** obj \<< Connect Thru Missing( state=0|1 )

**Description:** Determines whether points and lines are connected when some samples have missing values or excluded rows.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = Control Chart Builder( Variables( Y( :Gap ) ), Show Control Panel( 0 ) );
Wait( 1 );
obj << Connect Thru Missing( 1 );


```

### [Customize Tests](#customize-tests)

**Syntax:** obj \<< Customize Tests( Test 1 | Test 2 | Test 3 | Test 4 | Test 5 | Test 6 | Test 7 | Test 8 (n, label) )

**Description:** Enables you to select, customize labels, and set the sigma-based distance parameters for Western Electric tests.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Customize Tests( Test 1( 2, "A" ) ),
    Chart( Position( 1 ), Warnings( Test 1( 1 ) ) ),
    Show Control Panel( 0 )
);


```

### [Fit to Window](#fit-to-window)

**Syntax:** obj \<< Fit to Window( "Auto"|"On"|"Off"|"Maintain Aspect Ratio"="Off" )

**Description:** Sets the auto stretching behavior of the report. "Off" by default.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Fit to Window( "On" );


```

### [Get Control Limits](#get-control-limits)

**Syntax:** obj \<< Get Control Limits( filename )

**Description:** Imports control limits from a selected data table and replaces calculated limits on the chart.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Points( Statistic( "Average" ) ), Limits( Sigma( "Range" ) ) ),
    Chart( Position( 2 ), Points( Statistic( "Range" ) ), Limits( Sigma( "Range" ) ) ),
    Show Control Panel( 0 )
);
obj << Get Control Limits( "$SAMPLE_DATA/Quality Control/CoatingLimits.jmp" );


```

### [Get Product Statistics](#get-product-statistics)

**Syntax:** obj \<< Get Product Statistics( filename )

**Description:** Imports values for the Short Run Product Target and Sigma from a specified data table.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Get Product Statistics( "$SAMPLE_DATA/Quality Control/CoatingProductInfo.jmp" );


```

### [Get Spec Limits](#get-spec-limits)

**Syntax:** obj \<< Get Spec Limits( filename )

**Description:** Imports specification limits from a file.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :OZONE, :CO ) ),
    Set Subgroup Size( 5 ),
    Show Control Panel( 0 )
);
obj << Get Spec Limits( "$SAMPLE_DATA/CitySpecLimits.jmp" );


```

### [Graph Borders](#graph-borders)

**Syntax:** obj \<< Graph Borders( state=0|1 )

**Description:** Shows or hides the internal graph panel borders.

**JMP Version Added:** 17

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
Wait( 0.5 );
obj << Graph Spacing( 5 );
obj << Graph Transparency( 0 );
obj << Graph Borders( 1 );


```

### [Graph Spacing](#graph-spacing)

**Syntax:** obj \<< Graph Spacing( gap=2 )

**Description:** Specifies the amount of space between the graph panels. "2" by default.

**JMP Version Added:** 16

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
Wait( 1 );
obj << Graph Spacing( 5 );


```

### [Graph Spacing Color](#graph-spacing-color)

**Syntax:** obj \<< Graph Spacing Color( color )

**Description:** Specifies the color of the space between the graph panels.

**JMP Version Added:** 17

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
Wait( 0.5 );
obj << Graph Spacing Color( "Red" );


```

### [Graph Spacing Transparency](#graph-spacing-transparency)

**Syntax:** obj \<< Graph Spacing Transparency( number )

**Description:** Specifies the transparency level of the space between the graph panels. Must be between 0 and 1.

**JMP Version Added:** 17

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
Wait( 0.5 );
obj << Graph Spacing Transparency( 0.3 );


```

### [Include Missing Categories](#include-missing-categories)

**Syntax:** obj \<< Include Missing Categories( state=0|1 )

**Description:** Includes an extra level for nominal and ordinal variables when the data contain missing values. On by default.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Diameter ), Subgroup( :Day ) ),
    Show Control Panel( 0 )
);
:Day[{8, 9, 10, 11, 12}] = .;
Wait( 1 );
obj << Include Missing Categories( 0 );


```

### [K Sigma](#k-sigma)

**Syntax:** obj \<< K Sigma( value=3 )

**Description:** Sets the K value to be multiplied by sigma to form the control limits about the average. "3" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    K Sigma( 2.5 ),
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << K Sigma( 3 );


```

### [Limits](#limits)

**Syntax:** obj \<< Chart( Position( number ), Limits( Sigma( "sigma" ), \<Zones( state=0|1 )>, \<Shade Zones( state=0|1 )>, \<Set Control Limits( state=0|1 )>, \<Show Upper Limit( state=0|1 )>, \<Show Lower Limit( state=0|1 )>, \<Show Center Line( state=0|1 )> ) )

**Description:** Provides options for changing the limit characteristics of the chart. Depending on the type of chart, you can assign one of the following values as the sigma argument: Range, Standard Deviation, Moving Range, Median Moving Range, Levey-Jennings, Poisson, Binomial, Negative Binomial, Weibull, Laney P Prime, or Laney U Prime.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Standard Deviation" ), Shade Zones( 1 ) ) ),
    Show Control Panel( 0 )
);
obj << Chart(
    Position( 2 ),
    Points( Statistic( "Standard Deviation" ) ),
    Limits( Sigma( "Standard Deviation" ) )
);


```

### [Limits Label Precision](#limits-label-precision)

**Syntax:** obj \<< Limits Label Precision( number )

**Description:** Specifies the decimal precision that is displayed in the limits labels beyond the vertical axis decimal specification.

**JMP Version Added:** 18

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Show Limit Labels( 1 );
Wait( 1 );
obj << Limits Label Precision( 5 );


```

### [OC Curve](#oc-curve)

**Syntax:** obj \<< OC Curve

**Description:** Shows in a new window, an Operator Characteristic Curve using the control limits and sigma from the control chart.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << OC Curve;


```

### [Points](#points)

**Syntax:** obj \<< Chart( Position( number ), Points( Statistic( "statistic" ), \<Individual Points( state=0|1 )>, \<Box Plots( state=0|1 )>, \<Show Connect Line( state=0|1 )>, \<Show Points( state=0|1 )> ) )

**Description:** Provides options for changing the point characteristics of the chart. Depending on the type of chart, you can assign one of the following values for the statistic argument: Average, Range, Standard Deviation, Moving Range on Means, Moving Range on Standard Deviation, Individual, Moving Range, Count, Proportion, Centered, Standardized, Range Centered, or Range Standardized.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Points( Box Plots( 1 ) ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Chart( Position( 2 ), Points( Statistic( "Standard Deviation" ) ) );


```

### [Product Statistics](#product-statistics)

**Syntax:** obj \<< Product Statistics( ( column ) ( Product Level( l1 ( Target( number ), Sigma ( number ) ), \<l2 ( Target( number ), Sigma ( number ) )) ), < (column ( Product Level( ... ) ) ) > )

**Description:** Sets the values for the Short Run Product Target and Sigma.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Product Statistics(
    :Weight( ProductLevel( A( Target( 20 ), Sigma( 1 ) ), B( Target( 22 ), Sigma( .7 ) ) ) )
);


```

### [Range Span](#range-span)

**Syntax:** obj \<< Range Span( value=2 )

**Description:** Sets the value of the Range Span option that is used in the Moving Range charts. "2" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    K Sigma( 2.5 ),
    Variables( Y( :Weight ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Range Span( 3 );


```

### [Rerun All Tests](#rerun-all-tests)

**Syntax:** obj \<< Rerun All Tests

**Description:** Reruns all the currently selected tests and any associated alarm script.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Alarm Script(
        Write(
            "Out of Control for test ",
            qc_test,
            " in column ",
            qc_col,
            " in sample ",
            qc_sample,
            " in phase ",
            qc_phase
        )
    ),
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Warnings( Test 1( 1 ) ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << K Sigma( 2.5 );
obj << Rerun All Tests;


```

### [Save Control Limits](#save-control-limits)

**Syntax:** obj \<< Save Control Limits( "in Column"|"in New Table"|"in New Tall Table" )

**Description:** Saves control limits to either a column property or a new data table.

If in Column is specified and the limits are constant, LCL, Avg, and UCL values for each chart type in the report are saved in a Control Limits column property. If the limits are not constant, no column property is saved.

If in New Table is specified, the standard deviation and mean for each chart are saved to a new data table. If the limits are constant, the LCL, Avg, and UCL for each chart are saved as well. If there are phases, a new set of values is saved for each phase.

**JMP Version Added:** Before version 14

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Save Control Limits( "in Column" );
obj << Save Control Limits( "in New Table" );


```

### [Save Product Statistics](#save-product-statistics)

**Syntax:** obj \<< Save Product Statistics

**Description:** Saves columns to a new data table. The new data table contains the product statistics (target and sigma) for each level of the Part / Product variable.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Save Product Statistics;


```

### [Save Spec Limits](#save-spec-limits)

**Syntax:** obj \<< Save Spec Limits

**Description:** Saves the specification limits to a new data table. This option is available only if specification limits have been set, with a Spec Limits column property, via JSL, Get Spec Limits file import or the Set Spec Limits option.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Show Control Panel( 0 )
);
obj << Chart( Position( 1 ), Add Spec Limits( {LSL( 18 ), Target( 20.1 ), USL( 22.2 )} ) );
obj << Save Spec Limits;


```

### [Save Summaries](#save-summaries)

**Syntax:** obj \<< Save Summaries

**Description:** Saves a new data table for each chart. The data table includes a row for each sample and columns for the sample label, sample size, and product level, if a Product/Part variable is specified. For each chart, there are also columns for the individual point plotted, the chart type, UCL, Avg, LCL, and any selected tests that are failing.

**JMP Version Added:** Before version 14

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Save Summaries;


```

### [Set Control Limits](#set-control-limits)

**Syntax:** obj \<< Chart( Position( number ), Set Control Limits( {LCL( number ), Avg( number ), UCL( number )} ) )

**Description:** Sets the control limits for the specified chart.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Show Control Panel( 0 )
);
obj << Chart( Position( 1 ), Set Control Limits( {LCL( 19 ), Avg( 20 ), UCL( 21 )} ) );


```

### [Set Last N Subgroups](#set-last-n-subgroups)

**Syntax:** obj \<< Set Last N Subgroups( number )

**Description:** Changes the horizontal axis to show only the last N subgroups on the graph. The number of specified subgroups does not take into account excluded or hidden observations. This option is not available when there is a Phase variable with more than one level.

**JMP Version Added:** 19

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Set Last n Subgroups( 5 );


```

### [Set Sigma](#set-sigma)

**Syntax:** obj \<< Set Sigma( value )

**Description:** Sets the sigma value used in the Control Chart.

**JMP Version Added:** 18

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
Wait( 1 );
obj << Set Sigma( 1.8 );


```

### [Set Subgroup Size](#set-subgroup-size)

**Syntax:** obj \<< Set Subgroup Size( integer )

**Description:** Specifies the number of rows per subgroup.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Set Subgroup Size( 4 );


```

### [Show Alarm Report](#show-alarm-report)

**Syntax:** obj \<< Show Alarm Report( state=0|1 )

**Description:** Shows or hides the table of alarm rates and out of control samples.

**JMP Version Added:** 15

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Show Alarm Report( 1 );


```

### [Show Capability](#show-capability)

**Syntax:** obj \<< Show Capability( state=0|1 )

**Description:** Shows or hides the Process Capability Analysis report. On by default.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Limits( Sigma( "Moving Range" ) ),
        Add Spec Limits( {LSL( 17 ), USL( 23 ), Target( 20 )} )
    )
);
Wait( 1 );
obj << Show Capability( 0 );


```

### [Show Center Line](#show-center-line)

**Syntax:** obj \<< Chart( Position( number ), Limits( Show Center Line( state=0|1 ) ) )

**Description:** Shows or hides the center line. On by default.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Show Control Panel( 0 )
);
obj << Chart( Position( 1 ), Limits( Show Center Line( 0 ) ) );


```

### [Show Control Panel](#show-control-panel)

**Syntax:** obj \<< Show Control Panel( state=0|1 )

**Description:** Shows or hides the control panel. On by default.

**JMP Version Added:** Before version 14

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
Wait( 1 );
obj << Show Control Panel( 1 );


```

### [Show Excluded Region](#show-excluded-region)

**Syntax:** obj \<< Show Excluded Region( state=0|1 )

**Description:** Shows or hides the regions of the chart where samples have been excluded. On by default.

**JMP Version Added:** Before version 14

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
r = dt << Select Where( :Sample < 4 );
r << Exclude;
Wait( 1 );
obj << Show Excluded Region( 0 );


```

### [Show Limit Labels](#show-limit-labels)

**Syntax:** obj \<< Show Limit Labels( state=0|1 )

**Description:** Shows or hides the limit labels on the graph.

**JMP Version Added:** 16

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Show Limit Labels( 1 );


```

### [Show Limit Summaries](#show-limit-summaries)

**Syntax:** obj \<< Show Limit Summaries( state=0|1 )

**Description:** Shows or hides the Limit Summaries report. This report contains the control limits (LCL and UCL), the center line (Avg), the Points and Limits plotted, and the Sample Size for the chart. On by default.

**JMP Version Added:** Before version 14

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
Wait( 1 );
obj << Show Limit Summaries( 0 );


```

### [Show Lower Limit](#show-lower-limit)

**Syntax:** obj \<< Chart( Position( number ), Limits( Show Lower Limit( state=0|1 ) ) )

**Description:** Shows or hides the lower control limit. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Show Lower Limit( 0 ) ) ),
    Show Control Panel( 0 )
);


```

### [Show Product Separators](#show-product-separators)

**Syntax:** obj \<< Show Product Separators( state=0|1 )

**Description:** Shows or hides dashed vertical lines on the graph indicating the product changed. On by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Show Product Separators( 0 );


```

### [Show Sigma Report](#show-sigma-report)

**Syntax:** obj \<< Show Sigma Report( state=0|1 )

**Description:** Shows or hides the table of Overall Sigma, Within Sigma, Stability Index, and Mean. For Three Way charts, the Between Sigma and Between-and-Within Sigma are also shown.

**JMP Version Added:** 15

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Show Sigma Report( 1 );


```

### [Show Two Shewhart or Short Run Charts](#show-two-shewhart-or-short-run-charts)

**Syntax:** obj \<< Show Two Shewhart or Short Run Charts( state=0|1 )

**Description:** Shows both the location and the dispersion chart. When the value of this option is 0, the dispersion chart is not shown. On by default.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Control Chart Builder(
    Show Two Shewhart Charts( 0 ),
    Variables( Y( :Diameter ), Subgroup( :Day ) ),
    Show Control Panel( 0 )
);


```

### [Show Upper Limit](#show-upper-limit)

**Syntax:** obj \<< Chart( Position( number ), Limits( Show Upper Limit( state=0|1 ) ) )

**Description:** Shows or hides the upper control limit. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Show Upper Limit( 0 ) ) ),
    Show Control Panel( 0 )
);


```

### [Size](#size)

**Syntax:** obj \<< Size( width, height )

**Description:** Sets the size of the graph.

**JMP Version Added:** Before version 14

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Size( 808, 586 );


```

### [Sort by Subgroup](#sort-by-subgroup)

**Syntax:** obj \<< Sort by Subgroup( state=0|1 )

**Description:** Sorts the process data by the subgroup variable, or combination of nested subgroup variables, before calculations are performed. This option is available only if a Subgroup variable is specified.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Airline Delays.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Day of Week ), Y( :Arrival Delay ) ),
    Show Control Panel( 0 )
);
Wait( 1 );
obj << Sort by Subgroup( 1 );


```

### [Test Excluded Subgroups](#test-excluded-subgroups)

**Syntax:** obj \<< Test Excluded Subgroups( state=0|1 )

**Description:** Includes or excludes entirely excluded subgroups in the computation of tests. This option is available only when the Show Excluded Region option is selected. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Test Excluded Subgroups( 0 ),
    Show Control Panel( 0 ),
    Show Alarm Report( 1 ),
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Warnings( Test 1( 1 ) ) )
);
Wait( 1 );
dt << Select Rows( Index( 21, 24 ) ) << Exclude;


```

### [Use Event Chooser](#use-event-chooser)

**Syntax:** obj \<< Use Event Chooser( state=0|1 )

**Description:** Categorizes ordinal numeric data and offers individual numeric-level modeling selections. The Use Event Chooser option is available only for Attribute Charts that include numeric, non-continuous Y variables.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Y( :Age ) ),
    Show Control Panel( 0 )
);
obj << Use Event Chooser( 1 );


```

### [Use Excluded Points on MR](#use-excluded-points-on-mr)

**Syntax:** Platform preferences( Control Chart Builder (Use Excluded Points on MR(1)) )

**Description:** Preference for including points which are excluded in the moving range calculations.

**JMP Version Added:** 19

```

Platform Preferences( Control Chart Builder( Use Excluded Points on MR( 1 ) ) );
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
dt << Select Rows( 4 :: 6 ) << Exclude( 1 );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );


```

### [Variables](#variables)

**Syntax:** obj \<< Variables( Y( column ), \<Subgroup( column)>, \<Phase( column )>, \<Part( column )> )

**Description:** Assigns the indicated variables to roles.

**JMP Version Added:** Before version 14

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );


```

### [n Trials](#n-trials)

**Syntax:** obj \<< n Trials( column | integer )

**Description:** Assigns a lot size for an attribute control chart.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Washers.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Lot ), Y( :"# defective"n ), nTrials( :Lot Size ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Binomial" ) ) ),
    Show Control Panel( 0 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Show Control Panel( 0 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Show Control Panel( 0 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Cumulative Damage](#cumulative-damage)

## [Associated Constructors](#associated-constructors)

### [Cumulative Damage](#cumulative-damage_1)

**Syntax:** Cumulative Damage

**Description:** Analyzes varying-stress and step-stress models.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);


```

## [Item Messages](#item-messages)

### [Fit All](#fit-all)

**Syntax:** obj \<< Fit All

**Description:** Fits all available distributions.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" ),
    Fit All
);


```

### [Get Results](#get-results)

**Syntax:** obj \<< Get Results

**Description:** Gets the available results as JSL objects.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" ), 

);
obj << Get Results;


```

### [Model Type](#model-type)

**Syntax:** obj \<< Model Type( Step Stress | Ramp Stress | Sinusoid Stress | Piecewise Ramp Stress )

**Description:** Specifies the type of stress pattern for the cumulative damage model. This option must be specified in the launch script.

```

/*See sample scripts in the following data tables.*/
Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Ramp Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Sinusoid Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Piecewise Ramp Stress.jmp" );


```

### [Simulate](#simulate)

**Syntax:** obj \<< Simulate

**Description:** Shows or hides the Simulation Configuration panel.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" ),
    Simulate
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Custom Function](#custom-function)

## [Item Messages](#item-messages)

### [Custom Format Category](#custom-format-category)

**Syntax:** f \<< Custom Format Category(1|0)

**Description:** Treat the custom function as a custom format. Specify 0 to exclude the function from the custom format menu.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Custom Format Category( 1 );


```

### [Description](#description)

**Syntax:** obj \<< Description( text )

**Description:** Set the description for the custom function. This description will show up in the Scripting Index and in tooltips.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Description( "Add two numbers together, but subtract 1" );


```

### [Example](#example)

**Syntax:** f \<< Example(example text | Expr(example JSL code), <example name>)

**Description:** Add an example that shows how to effectively use the function. The example should be passed in as a text string or as JSL code wrapped with the Expr command. You can send the message multiple times to add more than one example.

**JMP Version Added:** 14

**Example 1**

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Example( "Add(1, 2)" );


```

**Example 2**

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Example( "Add(1, 2)", "small add" );
myAdd << Example( "Add(1, 500)", "bigger add" );


```

### [Formula Category](#formula-category)

**Syntax:** f \<< Formula Category(name|""|1|0)

**Description:** Include the function in the specified Formula Editor category. If specified, this function will be added at the end of the matching category. If the category doesn't exist, a new category will be created. Specify 0 or empty string to not show the function in the formula editor tree.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Formula Category( "NumberStuff" );


```

### [Get Custom Format Category](#get-custom-format-category)

**Syntax:** f \<< Get Custom Format Category

**Description:** Get the custom format category for the custom function.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Custom Format Category( 1 );
myAdd << Get Custom Format Category;


```

### [Get Description](#get-description)

**Syntax:** f \<< Get Description

**Description:** Get the description for the custom function.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Description( "Add two numbers together, but subtract 1" );
myAdd << Get Description;


```

### [Get Examples](#get-examples)

**Syntax:** f \<< Get Examples

**Description:** Retrieve the list of examples, as strings

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Example( "Add(1, 2)", "small add" );
myAdd << Example( "Add(1, 500)", "bigger add" );
myAdd << Get Examples;


```

### [Get Formula Category](#get-formula-category)

**Syntax:** f \<< Get Formula Category

**Description:** Return which Formula Editor category this function should be part of, if any.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Formula Category( "NumberStuff" );
myAdd << Get Formula Category;


```

### [Get Function](#get-function)

**Syntax:** f \<< Get Function

**Description:** Retrieve the function definition.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Get Function;


```

### [Get Name](#get-name)

**Syntax:** f \<< Get Name

**Description:** Retrieve the function name.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Get Name;


```

### [Get Namespace](#get-namespace)

**Syntax:** f \<< Get Namespace

**Description:** Retrieve the function namespace.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Get Namespace;


```

### [Get Parameters](#get-parameters)

**Syntax:** f \<< Get Parameters

**Description:** Retrieve the list of parameters.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Parameter( "Number", "number" );
myAdd << Parameter( "Number", "<number=1>" );
myAdd << Get Parameters;


```

### [Get Prototype](#get-prototype)

**Syntax:** f \<< Get Prototype

**Description:** Get the prototype that shows up for this function in the Scripting Index

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Prototype( "Add(number, <number=1>)" );
myAdd << Get Prototype;


```

### [Get Result Type](#get-result-type)

**Syntax:** f \<< Get Result Type

**Description:** Get the result type of the function.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Result Type( "Number" );
myAdd << Get Result Type;


```

### [Get Scripting Index Category](#get-scripting-index-category)

**Syntax:** f \<< Get Scripting Index Category

**Description:** Get the category for the custom function in the Scripting Index.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Scripting Index Category( "My Functions" );
myAdd << Get Scripting Index Category;


```

### [Get Transform Category](#get-transform-category)

**Syntax:** f \<< Get Transform Category

**Description:** Get the transform category for the custom function.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Transform Category( 1 );
myAdd << Get Transform Category;


```

### [Parameter](#parameter)

**Syntax:** f \<< Parameter(typename | {typename1, typename2, ...}, hint text)

**Description:** Add information about a parameter of the function. Send this message once for each parameter the function takes. This can be used for code validation. Valid choices for the parameter types are Any, Name, Number, String, List, Matrix, RowState. If multiple result types are possible, supply the type names in a list. The hint text is used to indicate what data should be used in the corresponding argument in the formula editor. Specify an empty string if no hint text is desired.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Parameter( "Number", "number" );
myAdd << Parameter( "Number", "<number=1>" );


```

### [Prototype](#prototype)

**Syntax:** obj \<< Prototype( text )

**Description:** Set the prototype that shows up for this function in the Scripting Index

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Prototype( "Add(number, <number=1>)" );


```

### [Result Type](#result-type)

**Syntax:** f \<< Result Type(typename | {typename1, typename2 ...})

**Description:** Set the result type of the function. This can be used for code validation. Valid choices are Any, Name, Number, String, List, Matrix, RowState. If multiple result types are possible, supply the type names in a list.

**JMP Version Added:** 14

**Example 1**

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Result Type( "Number" );


```

**Example 2**

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Result Type( {"Number", "String"} );


```

### [Scripting Index Category](#scripting-index-category)

**Syntax:** f \<< Scripting Index Category(name|""|1|0)

**Description:** Sets the category for the custom function in the Scripting Index. Every custom function will be listed in the All Functions category in addition to the category that you specify. Specify 0 or "" to list the function in the All Functions category only.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Scripting Index Category( "My Functions" );


```

### [Transform Category](#transform-category)

**Syntax:** f \<< Transform Category(1|0)

**Description:** Treat the custom function as a column transform. Specify 0 to exclude the function from the column transform menu.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );
myAdd << Transform Category( 1 );


```

# [Custom Graph](#custom-graph)

## [Associated Constructors](#associated-constructors)

### [Custom Graph](#custom-graph_1)

**Syntax:** New Window(Window title, \<Editable|Dialog>, Graph Box( named arguments, ..., script segment

**Description:** Creates a graph using a custom script.

```

obj = New Window( "Example",
    Graph Box(
        Y Scale( -10, 90 ),
        X Scale( -10, 90 ),
        Oval(
            X Origin() + 10,
            (Y Origin() + Y Range()) - 10,
            (X Origin() + X Range()) - 10,
            Y Origin() + 10,
            1
        ),
        Title( "Oval" )
    )
);


```

## [Item Messages](#item-messages)

### [Append Seg](#append-seg)

**Syntax:** obj \<< Append Seg( display seg )

**Description:** Adds a display seg to the FrameBox

```

x = [20, 40, 60, 80];
New Window( "Example",
    Graph Box( Frame Size( 300, 120 ), Append Seg( Marker Seg( x, x ), Line Seg( x, x ) ) )
);


```

### [Background Map](#background-map)

**Syntax:** obj \<< Background Map

### [Bottom](#bottom)

**Syntax:** obj \<< Bottom( number )

### [FrameSize](#framesize)

**Syntax:** Frame Size( width, height )

**Description:** Sets the size of the graph.

**Example 1**

```

obj = New Window( "Example",
    Graph Box(
        Framesize( 400, 400 ),
        <<backgroundcolor( "cyan" ),
        XAxis( Show Major Grid ),
        Title( "Sine curve" ),
        Y Function( 10 + 50 * Sin( a / 30 ), a )
    )
);


```

**Example 2**

```

xmin = -2;
xmax = 1;
ymin = -1.5;
ymax = 1.5;
contourMatrix = J( 30, 20, 0 );
depth = 100;
/* build a demonstration matrix -- a really low resolution Mandelbrot */
Parallel Assign(
    {r = N Row( contourMatrix ) - 1, c = N Col( contourMatrix ) - 1, xmin = xmin, xmax = xmax,
    ymin = ymin, ymax = ymax, depth = depth},
    contourMatrix[irow, icol] = Mandelbrot(
        depth,
        2,
        (xmax - xmin) * (irow - 1) / (r) + xmin,
        (ymax - ymin) * (icol - 1) / (c) + ymin
    )
);
colors = J( depth + 1, 1, 0 ); // color choices for contours
For( i = 1, i <= depth + 1, i++,
    colors[i] = RGB Color(
        0,
        (Sqrt( Sqrt( (i - 1) / depth ) )),
        1 - (Sqrt( Sqrt( (i - 1) / depth ) ))
    )
);
/* see the Mandelbrot Function for a better way to do this */
New Window( "Example",
    Graph Box(
        X Scale( xmin, xmax ),
        Y Scale( ymin, ymax ),
        framesize( 500, 500 ),
        Contour( /* map the matrix rows onto the axes */
            (0 :: N Row( contourMatrix ) - 1) * (xmax - xmin) / (N Row( contourMatrix ) - 1)
             + xmin,
            (0 :: N Col( contourMatrix ) - 1) * (ymax - ymin) / (N Col( contourMatrix ) - 1)
             + ymin, 
            // the low res Mandelbrot data
            contourMatrix, 
            // the Mandelbrot function returns integers from 1 to depth, map them to colors
            0 :: depth,
            colors,
            fill
        )
    )
);


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Get Background Color( color )

### [Get Background Fill](#get-background-fill)

**Syntax:** obj \<< Get Background Fill( state=0|1 )

### [Get Bottom](#get-bottom)

**Syntax:** obj \<< Get Bottom

### [Get Graphics Script](#get-graphics-script)

**Syntax:** obj \<< Get Graphics Script

### [Get Height](#get-height)

**Syntax:** obj \<< Get Height

### [Get Left](#get-left)

**Syntax:** obj \<< Get Left

### [Get Right](#get-right)

**Syntax:** obj \<< Get Right

### [Get Sides](#get-sides)

**Syntax:** obj \<< Get Sides

### [Get Top](#get-top)

**Syntax:** obj \<< Get Top

### [Get Width](#get-width)

**Syntax:** obj \<< Get Width

### [Get X Axis](#get-x-axis)

**Syntax:** obj \<< Get X Axis

### [Get X Name](#get-x-name)

**Syntax:** obj \<< Get X Name

### [Get Y Axis](#get-y-axis)

**Syntax:** obj \<< Get Y Axis

### [Get Y Name](#get-y-name)

**Syntax:** obj \<< Get Y Name

### [Left](#left)

**Syntax:** obj \<< Left( number )

### [Right](#right)

**Syntax:** obj \<< Right( number )

### [Set Background Color](#set-background-color)

**Syntax:** obj \<< Set Background Color( color )

### [Set Background Fill](#set-background-fill)

**Syntax:** obj \<< Set Background Fill( state=0|1 )

### [Set Graphics Script](#set-graphics-script)

**Syntax:** obj \<< Set Graphics Script

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width

### [Set X Axis](#set-x-axis)

**Syntax:** obj \<< Set X Axis

### [Set X Name](#set-x-name)

**Syntax:** obj \<< Set X Name

### [Set Y Axis](#set-y-axis)

**Syntax:** obj \<< Set Y Axis

### [Set Y Name](#set-y-name)

**Syntax:** obj \<< Set Y Name

### [Sides](#sides)

**Syntax:** obj \<< Sides( number )

### [Suppress Axes](#suppress-axes)

**Syntax:** obj \<< Suppress Axes

**Description:** Hides the axes of the graph box.

```

obj = New Window( "Example",
    Graph Box(
        Framesize( 400, 400 ),
        Suppress Axes,
        <<backgroundcolor( "cyan" ),
        XAxis( Show Major Grid ),
        Title( "Sine curve" ),
        Y Function( 10 + 50 * Sin( a / 30 ), a )
    )
);


```

### [Title](#title)

**Syntax:** Title( string )

**Description:** Sets the title for the graph.

```

obj = New Window( "Example",
    Graph Box(
        <<backgroundcolor( "cyan" ),
        XAxis( Show Major Grid ),
        Title( "Sine curve" ),
        Y Function( 10 + 50 * Sin( a / 30 ), a )
    )
);


```

### [Top](#top)

**Syntax:** obj \<< Top( number )

### [X Scale](#x-scale)

**Syntax:** X Scale( xMin, xMax )

**Description:** Sets the scale for the X axis on the graph.

```

obj = New Window( "Example",
    Graph Box(
        Y Scale( -10, 90 ),
        X Scale( -10, 90 ),
        Oval(
            X Origin() + 10,
            (Y Origin() + Y Range()) - 10,
            (X Origin() + X Range()) - 10,
            Y Origin() + 10,
            1
        ),
        Title( "Oval" )
    )
);


```

### [XAxis](#xaxis)

**Syntax:** X Axis(Scale, Min, Max, Inc, Tick Font, Show Major Ticks, Show Minor Ticks, Show Major Grid, Show Minor Grid, Format, Decimal, Show Labels, Rotated Labels, Rotated Labels Alt, Minor Ticks, Add Ref Line )

**Description:** Sets X Axis features on the graph.

```

obj = New Window( "Example",
    Graph Box(
        Framesize( 400, 400 ),
        <<backgroundcolor( "cyan" ),
        XName( "Time" ),
        YName( "Result" ),
        XAxis( Show Major Grid, Inc( 5 ) ),
        Title( "Cosine curve" ),
        Y Function( 50 + 10 * Cos( a / 10 ), a )
    )
);


```

### [XName](#xname)

**Syntax:** X Name( string )

**Description:** Sets the name for the X Axis on the graph.

```

obj = New Window( "Example",
    Graph Box(
        Framesize( 400, 400 ),
        <<backgroundcolor( "blue" ),
        XName( "Time" ),
        YName( "Result" ),
        XAxis( Show Major Grid ),
        Title( "Sine curve" ),
        Y Function( 10 + 50 * Sin( a / 30 ), a )
    )
);


```

### [Y Scale](#y-scale)

**Syntax:** Y Scale( yMin, yMax )

**Description:** Sets the scale for the Y axis on the graph.

```

obj = New Window( "Example",
    Graph Box(
        Y Scale( -10, 90 ),
        X Scale( -10, 90 ),
        Oval(
            X Origin() + 10,
            (Y Origin() + Y Range()) - 10,
            (X Origin() + X Range()) - 10,
            Y Origin() + 10,
            1
        ),
        Title( "Oval" )
    )
);


```

### [YAxis](#yaxis)

**Syntax:** Y Axis(Scale, Min, Max, Inc, Tick Font, Show Major Ticks, Show Minor Ticks, Show Major Grid, Show Minor Grid, Format, Decimal, Show Labels, Rotated Labels, Rotated Labels Alt, Minor Ticks, Add Ref Line )

**Description:** Sets Y Axis features on the graph.

```

obj = New Window( "Example",
    Graph Box(
        Framesize( 400, 400 ),
        <<backgroundcolor( "cyan" ),
        XName( "Time" ),
        YName( "Result" ),
        YAxis( Show Major Grid ),
        Title( "Cosine curve" ),
        Y Function( 50 + 10 * Cos( a / 10 ), a )
    )
);


```

### [YName](#yname)

**Syntax:** Y Name( string )

**Description:** Sets the name for the Y Axis on the graph.

```

obj = New Window( "Example",
    Graph Box(
        Framesize( 400, 400 ),
        <<backgroundcolor( "cyan" ),
        XName( "Time" ),
        YName( "Result" ),
        XAxis( Show Major Grid ),
        Title( "Cosine curve" ),
        Y Function( 50 + 10 * Cos( a / 10 ), a )
    )
);


```

# [Custom Profiler](#custom-profiler)

## [Associated Constructors](#associated-constructors)

### [Custom Profiler](#custom-profiler_1)

**Syntax:** Custom Profiler( Y( column1, column2, ... ) )

**Description:** Provides an interface that enables you to optimize responses without a graphical output. This profiler is useful for larger problems.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

## [Columns](#columns)

### [Noise Factors](#noise-factors)

**Syntax:** obj = Custom Profiler(...\<Noise Factors( column(s) )>...)

**Description:** Specifies noise factors, which must be columns that are ingredients to the formula columns. Noise factors are used to study robustness (or flatness) with respect to transmitted variation from these factors. The resulting profiler includes derivatives of the formulas with respect to the noise factors.

**Contour Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Custom Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Mixture Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Noise Factors( :p1 ) );


```

**Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

### [Prediction Formula](#prediction-formula)

**Syntax:** obj = Custom Profiler(...Prediction Formula( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

### [Y](#y)

**Syntax:** obj = Custom Profiler(...Y( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

## [Item Messages](#item-messages)

### [Append Settings to Table](#append-settings-to-table)

**Syntax:** obj \<< Append Settings to Table

**Description:** Saves the settings of the current profiler as a new row at the end of the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Append Settings to Table;


```

### [Broadcast Factor Settings](#broadcast-factor-settings)

**Syntax:** obj \<< Broadcast Factor Settings

**Description:** Sends the factor settings for the current profiler to all other profilers. This option does not link the profilers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 ),
    Term Value(
        SILICA( 1.75, Lock( 0 ), Show( 1 ) ),
        SILANE( 45.2, Lock( 0 ), Show( 1 ) ),
        SULFUR( 2.45, Lock( 0 ), Show( 1 ) )
    )
);
obj << Contour Profiler( 1 );
Wait( 1 );
obj << Broadcast Factor Settings;


```

### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the Contour Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Contour Profiler( 1 );


```

### [Converge Limit](#converge-limit)

**Syntax:** obj \<< Converge Limit( number )

**Description:** Specifies the criterion for convergence for the optimization algorithm. If the convergence criterion is less than this value for two consecutive iterations, the algorithm stops.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Converge limit( 0.0001 );
obj << Optimize;


```

### [Copy Settings Script](#copy-settings-script)

**Syntax:** obj \<< Copy Settings Script

**Description:** Copies the current factor settings to the clipboard. The settings can then be pasted into another profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Edit Constraints](#edit-constraints)

**Syntax:** obj \<< Edit Constraints

**Description:** Adds, changes, or deletes linear constraints.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Edit Constraints;


```

### [Formulas for OPTMODEL](#formulas-for-optmodel)

**Syntax:** obj \<< Formulas for OPTMODEL

**Description:** Saves the prediction formulas from the model in a new file as SAS statements for PROC OPTMODEL.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Formulas for OPTMODEL;


```

### [Get Constraints](#get-constraints)

**Syntax:** obj \<< Get Constraints

**Description:** Returns a list of factor constraints.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Profiler(
    Y( :Pred Formula Y ),
    Profiler( 1, Profile at Boundary( "Stop at Boundaries" ), )
);
obj << Get Constraints;


```

### [Get Factor Settings](#get-factor-settings)

**Syntax:** obj \<< Get Factor Settings

**Description:** Returns the current factor settings as a list.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Get Factor Settings;


```

### [Get Factor Settings Script](#get-factor-settings-script)

**Syntax:** obj \<< Get Factor Settings Script

**Description:** Returns the current factor settings as an expression that can be used in a script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Get Factor Settings Script;


```

### [Get Objective](#get-objective)

**Syntax:** obj \<< Get Objective

**Description:** Returns the current value of the objective function in the custom profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler( Y( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Optimize;
o = obj << Get Objective;
Show( o );


```

### [Get Objective Formula](#get-objective-formula)

**Syntax:** obj \<< Get Objective Formula

**Description:** Returns the formula for the objective function as an expression in the custom profiler output.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler( Y( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Optimize;
form = obj << Get Objective Formula;
Show( form );


```

### [Get Simulator](#get-simulator)

**Syntax:** obj \<< Get Simulator

**Description:** Returns a reference to the Simulator.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ), SILANE << Fixed( 50 ),
        SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << Add Random Noise( 1 ),
        Pred Formula HARDNESS << Add Random Weighted Noise( 1 )
    )
);
obj2 = obj << Get Simulator;
obj2 << Simulation Experiment;


```

### [Goal](#goal)

**Syntax:** obj \<< Goal( "Maximize"|"Minimize" )

### [Link Profilers](#link-profilers)

**Syntax:** obj \<< Link Profilers( state=0|1 )

**Description:** Links all the profilers in a single report together, so that a change in a factor in one profiler causes that factor to change to that value in all other profilers.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Prediction Profiler( 1 );
obj << Contour Profiler( 1 );
obj << Link Profilers( 1 );
Wait( 1 );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );


```

### [Load Constraints from Table](#load-constraints-from-table)

**Syntax:** obj \<< Load Constraints from Table

**Description:** Loads linear constraints from a data table.

```


dtlc = New Table( "Linear Constraints",
    Add Rows( 2 ),
    New Column( "SILICA", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 2] ) ),
    New Column( "SILANE", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [0, 0] ) ),
    New Column( "SULFUR", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 1] ) ),
    New Column( "Comparison", Character, "Nominal", Set Values( {">=", "<="} ) ),
    New Column( "RHS", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [3, 6] ) )
);
dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Load Constraints from Table( dtlc );
obj << Profile at Boundary( "Stop at Boundaries" );


```

### [Log Iterations](#log-iterations)

**Syntax:** obj \<< Log Iterations( state=0|1 )

**Description:** Creates a new data table that contains iterations of the optimization algorithm.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler( Y( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );
obj << Log Iterations( 1 );
obj << Optimize;


```

### [Max Cycles](#max-cycles)

**Syntax:** obj \<< Max Cycles( number )

**Description:** Specifies the maximum number of cycles within each trip in the optimization algorithm.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Max Cycles( 5 );
obj << Optimize;


```

### [MaxIter](#maxiter)

**Syntax:** obj \<< MaxIter( number )

**Description:** Specifies the maximum number of iterations within each trip in the optimization algorithm.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << MaxIter( 10 );
obj << Optimize;


```

### [Objective Formula](#objective-formula)

**Syntax:** obj \<< Objective Formula

**Description:** Specifies the formula to be optimized.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler( Y( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Objective Formula( :Pred Formula ABRASION + .5 * :Pred Formula MODULUS );
Wait( 1 );
obj << Optimize;
obj << Get Objective Formula;


```

### [Optimize](#optimize)

**Syntax:** obj \<< Optimize

**Description:** Optimizes the current settings in the custom profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler( Y( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );
Wait( 1 );
obj << Optimize;


```

### [Paste Settings Script](#paste-settings-script)

**Syntax:** obj \<< Paste Settings Script

**Description:** Pastes the profiler settings from the clipboard to a profiler in another report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Predict for Another Table](#predict-for-another-table)

**Syntax:** obj \<< Predict for Another Table( <data table> )

**Description:** Adds prediction columns to a specified data table, using the factors in that table. This option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
dt2 = dt << Subset(
    All rows,
    columns( :SILICA, :SILANE, :SULFUR ),
    Output Table( "Subset" )
);
obj << Predict For Another Table( dt2 );


```

### [Prediction Profiler](#prediction-profiler)

**Syntax:** obj \<< Prediction Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Prediction Profiler( 1 );


```

### [Remember Settings](#remember-settings)

**Syntax:** obj \<< Remember Settings

**Description:** Adds an outline node to the report with the values of the factor settings.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Remember Settings;


```

### [Reset](#reset)

**Syntax:** obj \<< Reset

**Description:** Resets any changes made to the response variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );
obj << Reset;


```

### [Save Constraints to New Table](#save-constraints-to-new-table)

**Syntax:** obj \<< Save Constraints to New Table

**Description:** Saves existing linear constraints to a new data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Script(
    "Constraint",
    {1 * :SILICA + 1 * :SULFUR >= 3, 2 * :SILICA + 1 * :SULFUR <= 6}
);
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Constraints to New Table;


```

### [Save Constraints to Table Script](#save-constraints-to-table-script)

**Syntax:** obj \<< Save Constraints to Table Script

**Description:** Saves existing linear constraints to a table script called Constraint.

```

dtlc = New Table( "Linear Constraints",
    Add Rows( 2 ),
    New Column( "SILICA", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 2] ) ),
    New Column( "SILANE", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [0, 0] ) ),
    New Column( "SULFUR", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 1] ) ),
    New Column( "Comparison", Character, "Nominal", Set Values( {">=", "<="} ) ),
    New Column( "RHS", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [3, 6] ) )
);
dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Load Constraints from Table( dtlc );
obj << Save Constraints to Table Script;


```

### [Save Expanded Formulas](#save-expanded-formulas)

**Syntax:** obj \<< Save Expanded Formulas

**Description:** Saves a new formula column to the data table. The new column contains resolved formula references within the formulas used as Y variables to see the underlying variables. This is available only after the Expand Intermediate Formulas option is selected in the launch window or the Expand message is specified in the Profiler script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Profiler( Y( :GP Fit, :NL Fit, :Difference ), Expand, Contour Profiler( 1 ) );
obj << Save Expanded Formulas;


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( Function( {arguments}, \<{locals}>, expr ) )

**Description:** Sets a script that is run each time a factor changes.

```

ProfileCallbackLog = Function( {arg}, Show( arg ) );
dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set Script( ProfileCallbackLog );
obj << Term Value( :Silica( 1 ) );


```

### [Set to Data in Row](#set-to-data-in-row)

**Syntax:** obj \<< Set to Data in Row( row number )

**Description:** Assigns the values of a data table row to the X variables in the profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 2 );
obj << Set to Data in Row( 4 );


```

### [Show Formulas](#show-formulas)

**Syntax:** obj \<< Show Formulas

**Description:** Opens a script window that contains JSL for all formulas that are being profiled.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Formulas;


```

### [Simulator](#simulator)

**Syntax:** obj \<< Simulator( state=0|1 )

**Description:** Shows or hides the Simulator.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator( 1 );


```

### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides the Surface Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Surface Profiler( 1 );


```

### [Term Value](#term-value)

**Syntax:** obj \<< Term Value( x1( number ),x2( number ), ... )

**Description:** Sets specific term values for factors on the custom profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );


```

### [Trips](#trips)

**Syntax:** obj \<< Trips( number )

**Description:** Specifies the number of random starts in the optimization algorithm. Each trip restarts the algorithm at a different starting point.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Trips( 10 );
obj << Optimize;


```

### [Unthreaded](#unthreaded)

**Syntax:** obj \<< Unthreaded( state=0|1 )

**Description:** To suppress any multithreading in evaluating the profile traces, the contour grid, and the optimizer trips.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Unthreaded( 1 );
obj << Maximize Desirability;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [DLLScriptable](#dllscriptable)

## [Associated Constructors](#associated-constructors)

### [Load DLL](#load-dll)

**Syntax:** dll = Load DLL( file path | Base Name( file path without extension ), < AutoDeclare( bool | Quiet | Verbose) | Quiet | Verbose )> )

**Description:** Loads a DLL pointed to by the specified path.

```

If( Host is( "Windows" ),
    dll = Load DLL( "C:/Windows/System32/User32.DLL" );
    dll << CallDLL( "MessageBeep", "n", 0 );
    Wait( 1 );
    dll << CallDLL( "MessageBeep", "n", 0 );
    dll << UnloadDLL();
);


```

## [Item Messages](#item-messages)

### [Call DLL](#call-dll)

**Syntax:** obj \<< Call DLL( function name, signature, args )

**Description:** Calls a specified function within the DLL, with a given signature and arguments.

```

If( Host is( "Windows" ),
    dll = Load DLL( "C:/Windows/System32/User32.DLL" );
    dll << CallDLL( "MessageBeep", "n", 0 );
    Wait( 1 );
    dll << CallDLL( "MessageBeep", "n", 0 );
    dll << UnloadDLL();
);


```

### [Declare Function](#declare-function)

**Syntax:** obj \<< Declare Function( name, Convention( STDCALL| CDECL| Pascal ), Alias( string ), Arg( Int8| UInt8| Int16| UInt16| Int32| UInt32| Int64| UInt64| Float| Double| AnsiString| UnicodeString| Struct| IntPtr| UIntPtr| ObjPtr, string ), Returns( type ); )

**Description:** Declares the return type and parameter types of a function defined in the DLL so that it can be successfully invoked from JSL.

```

If( Host is( "Windows" ),
    dll = Load DLL( "C:/Windows/System32/User32.DLL" );
    dll << DeclareFunction(
        "MessageBoxW",
        Convention( STDCALL ),
        Alias( "MsgBox" ),
        Arg( IntPtr, "hWnd" ),
        Arg( UnicodeString, "message" ),
        Arg( UnicodeString, "caption" ),
        Arg( UInt32, "uType" ),
        Returns( Int32 )
    );
    result = dll << MsgBox( 0, "Here is a message from JMP.", "Call DLL", 321 );
    Show( result );
);


```

### [Get Declaration JSL](#get-declaration-jsl)

**Syntax:** obj \<< Get Declaration JSL

**Description:** Retrieves the declaration JSL from the DLL and displays it in the log. This message applies only to DLLs that contain the function, \_JMP_Declarations().

```

dll = Load DLL( /*DLL with JSL keyword*/ ); 
//dll << Get Declaration JSL;


```

### [Show Functions](#show-functions)

**Syntax:** obj \<< Show Functions

**Description:** Stream the list of declared functions to the log

```

If( Host is( "Windows" ),
    dll = Load DLL( "C:/Windows/System32/User32.DLL" );
    dll << DeclareFunction(
        "MessageBoxW",
        Convention( STDCALL ),
        Alias( "MsgBox" ),
        Arg( IntPtr, "hWnd" ),
        Arg( UnicodeString, "message" ),
        Arg( UnicodeString, "caption" ),
        Arg( UInt32, "uType" ),
        Returns( Int32 )
    );
    dll << Show Functions;
);


```

### [Unload DLL](#unload-dll)

**Syntax:** obj \<< Unload DLL

**Description:** Unloads the DLL.

```

If( Host is( "Windows" ),
    dll = Load DLL( "C:/Windows/System32/User32.DLL" );
    dll << CallDLL( "MessageBeep", "n", 0 );
    Wait( 1 );
    dll << CallDLL( "MessageBeep", "n", 0 );
    dll << UnloadDLL();
);


```

# [DOE](#doe)

## [Associated Constructors](#associated-constructors)

### [DOE](#doe_1)

**Syntax:** DOE

#### [Augment Design](#augment-design)

```


Open( "$SAMPLE_DATA/Design Experiment/Reactor 8 Runs.jmp" );
Wait( 0 );
DOE(
    Augment Design,
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    Y( :Percent Reacted ),
    {Augment Method( Augment ), Set Random Seed( 282322901 ), Number of Starts( 800 ),
    Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ),
    Add Term( {4, 1} ), Add Term( {5, 1} ), Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ), Add Term( {1, 1}, {4, 1} ), Add Term( {1, 1}, {5, 1} ),
    Add Term( {2, 1}, {3, 1} ), Add Term( {2, 1}, {4, 1} ), Add Term( {2, 1}, {5, 1} ),
    Add Term( {3, 1}, {4, 1} ), Add Term( {3, 1}, {5, 1} ), Add Term( {4, 1}, {5, 1} ),
    Set Sample Size( 16 ), Optimality Criterion( "Make D-Optimal Design" ), Make Design,
    Save X Matrix( 0 ), Simulate Responses( 0 )}
);


```

#### [Augment Design, Add Center Points to a Design](#augment-design-add-center-points-to-a-design)

```


Open( "$SAMPLE_DATA/Design Experiment/Reactor 8 Runs.jmp" );
Wait( 0 );
DOE(
    Augment Design,
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    Y( :Percent Reacted ),
    {Group new runs into separate block, Augment Method( Centerpoints, 2 ),
    Save X Matrix( 0 ), Simulate Responses( 0 )}
);


```

#### [Augment Design, Replicate a Design](#augment-design-replicate-a-design)

```


Open( "$SAMPLE_DATA/Design Experiment/Reactor 8 Runs.jmp" );
Wait( 0 );
DOE(
    Augment Design,
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    Y( :Percent Reacted ),
    {Group new runs into separate block, Augment Method( Replicate, 2 ), Save X Matrix( 0 ),
    Simulate Responses( 0 )}
);


```

#### [Choice Design](#choice-design)

```


DOE(
    Choice Design,
    {Add Factor( Categorical, {"Medium", "Coarse"}, "Grind", 0 ),
    Add Factor( Categorical, {"195", "200", "205"}, "Temperature", 0 ),
    Add Factor( Categorical, {"3", "3.5", "4"}, "Time", 0 ),
    Add Factor( Categorical, {"1.6", "2", "2.4"}, "Charge", 0 ), Set Random Seed( 12345 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {4, 1} ),
    Set Prior Mean Choice( [0 0 0 0 0 0 0] ),
    Set Prior Variance Matrix(
        [1 0 0 0 0 0 0,
        0 1 0 0 0 0 0,
        0 0 1 0 0 0 0,
        0 0 0 1 0 0 0,
        0 0 0 0 1 0 0,
        0 0 0 0 0 1 0,
        0 0 0 0 0 0 1]
    ), Set Number of Attributes( 4 ), Set Number of Profiles( 2 ),
    Set Number of Choice Sets( 12 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 10 ), Make Design,
    Choice Design Table Output( Separate )}
);


```

#### [Custom Design, Coffee Strength](#custom-design-coffee-strength)

```


DOE(
    Custom Design,
    {Add Response( Match Target, "Strength", 1.2, 1.4, . ),
    Add Factor( Categorical, {"Coarse", "Medium"}, "Grind", 0 ),
    Add Factor( Continuous, 195, 205, "Temperature", 0 ),
    Add Factor( Continuous, 3, 4, "Time", 0 ), Add Factor(
        Continuous, 1.6, 2.4, "Charge", 0
    ), Add Factor( Blocking, 4, "Station " ), Set Random Seed( 569534903 ),
    Number of Starts( 100 ), Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Add Term( {3, 1} ), Add Term( {4, 1} ), Add Term( {5, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ), Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {1, 1}, {4, 1} ), Add Alias Term( {2, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {4, 1} ), Add Alias Term( {3, 1}, {4, 1} ), Set Sample Size( 12 ),
    Make Design}
);


```

#### [Custom Design, Design for Fixed Blocks](#custom-design-design-for-fixed-blocks)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ), Add Factor( Continuous, -1, 1, "X3", 0 ),
    Add Factor( Blocking, 3, "X4" ), Set Random Seed( 12345 ), Number of Starts( 5 ),
    Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ),
    Add Term( {4, 1} ), Add Term( {1, 1}, {2, 1} ), Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ), Set Sample Size( 18 ), Make Design}
);


```

#### [Custom Design, Design with Fixed Covariates](#custom-design-design-with-fixed-covariates)

```

Open( "$SAMPLE_DATA/Design Experiment/Thermoplastic.jmp" );
Wait( 0 );
DOE(
    Custom Design,
    {Add Response( Minimize, "Shrinkage", ., ., . ),
    Add Factor( Covariate, Specific Gravity, 0 ), Add Factor(
        Covariate, Tensile Strength, 0
    ), Add Factor( Covariate, Supplier, 0 ), Add Factor(
        Continuous, -1, 1, "Temperature", 0
    ), Add Factor( Continuous, -1, 1, "Speed", 0 ), Add Factor(
        Continuous, -1, 1, "Time", 0
    ), Set Random Seed( 84951 ), Number of Starts( 40 ), Add Term( {1, 0} ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {4, 1} ),
    Add Term( {5, 1} ), Add Term( {6, 1} ), Add Alias Term( {1, 1}, {2, 1} ),
    Add Alias Term( {1, 1}, {3, 1} ), Add Alias Term( {1, 1}, {4, 1} ),
    Add Alias Term( {1, 1}, {5, 1} ), Add Alias Term( {1, 1}, {6, 1} ),
    Add Alias Term( {2, 1}, {3, 1} ), Add Alias Term( {2, 1}, {4, 1} ),
    Add Alias Term( {2, 1}, {5, 1} ), Add Alias Term( {2, 1}, {6, 1} ),
    Add Alias Term( {3, 1}, {4, 1} ), Add Alias Term( {3, 1}, {5, 1} ),
    Add Alias Term( {3, 1}, {6, 1} ), Add Alias Term( {4, 1}, {5, 1} ),
    Add Alias Term( {4, 1}, {6, 1} ), Add Alias Term( {5, 1}, {6, 1} ), Set Sample Size( 12 ),
    Make Design}
);


```

#### [Custom Design, Design with Hard-to-Change Covariates](#custom-design-design-with-hard-to-change-covariates)

```

Open( "$SAMPLE_DATA/Design Experiment/Runners Covariates.jmp" );
Wait( 0 );
DOE(
    Custom Design,
    {Add Response( Minimize, "Wear", ., ., . ), Add Factor( Covariate, Miles, 1 ),
    Add Factor( Covariate, Weight, 1 ), Add Factor( Covariate, Strike Point, 1 ),
    Add Factor( Continuous, 5, 20, "Thickness", 0 ),
    Add Factor( Continuous, 1, 10, "Gel", 0 ), Add Factor(
        Categorical,
        {"L1", "L2", "L3"},
        "Outsole",
        0
    ), Add Factor( Categorical, {"L1", "L2", "L3"}, "Midsole", 0 ), Set Random Seed( 12345 ),
    Number of Starts( 1 ), Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Add Term( {3, 1} ), Add Term( {4, 1} ), Add Term( {5, 1} ), Add Term( {6, 1} ),
    Add Term( {7, 1} ), Add Term( {1, 1}, {2, 1} ), Add Term( {1, 1}, {3, 1} ),
    Add Term( {1, 1}, {4, 1} ), Add Term( {1, 1}, {5, 1} ), Add Term( {1, 1}, {6, 1} ),
    Add Term( {1, 1}, {7, 1} ), Add Term( {2, 1}, {3, 1} ), Add Term( {2, 1}, {4, 1} ),
    Add Term( {2, 1}, {5, 1} ), Add Term( {2, 1}, {6, 1} ), Add Term( {2, 1}, {7, 1} ),
    Add Term( {3, 1}, {4, 1} ), Add Term( {3, 1}, {5, 1} ), Add Term( {3, 1}, {6, 1} ),
    Add Term( {3, 1}, {7, 1} ), Add Term( {4, 1}, {5, 1} ), Add Term( {4, 1}, {6, 1} ),
    Add Term( {4, 1}, {7, 1} ), Add Term( {5, 1}, {6, 1} ), Add Term( {5, 1}, {7, 1} ),
    Add Term( {6, 1}, {7, 1} ), Set N Whole Plots( 32 ), Set Sample Size( 64 ),
    Simulate Responses( 0 ), Save X Matrix( 0 ), Make Design}
);


```

#### [Custom Design, Mixture Design with Nonmixture Factors](#custom-design-mixture-design-with-nonmixture-factors)

```


DOE(
    Custom Design,
    {Add Response( None, "Damping", ., ., . ), Add Factor( Mixture, 0.2, 0.8, "CuSO4", 0 ),
    Add Factor( Mixture, 0.2, 0.8, "Na2S2O3", 0 ), Add Factor(
        Mixture, 0, 0.6, "Glyoxal", 0
    ), Add Factor( Categorical, {"L1", "L2", "L3"}, "Wavelength", 0 ),
    Set Random Seed( 12345 ), Number of Starts( 5 ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Add Term( {3, 1} ), Add Term( {1, 1}, {2, 1} ), Add Term( {1, 1}, {3, 1} ),
    Add Term( {1, 1}, {4, 1} ), Add Term( {2, 1}, {3, 1} ), Add Term( {2, 1}, {4, 1} ),
    Add Term( {3, 1}, {4, 1} ), Set Sample Size( 18 ), Make Design}
);


```

#### [Custom Design, Mixture of Mixtures Design](#custom-design-mixture-of-mixtures-design)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Taste", 0, 10, . ), Add Factor( Mixture, 0.1, 0.2, "Cocoa", 0 ),
    Add Factor( Mixture, 0, 0.15, "Sugar", 0 ), Add Factor( Mixture, 0.2, 0.3, "Flour", 0 ),
    Add Factor( Mixture, 0.1, 0.2, "Butter", 0 ), Add Factor(
        Mixture, 0.25, 0.35, "Milk", 0
    ), Add Factor( Mixture, 0.05, 0.2, "Eggs", 0 ), Set Random Seed( 12345 ),
    Number of Starts( 40 ), Add Constraint( [1 1 1 0 0 0 0.45, -1 -1 -1 0 0 0 -0.45] ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {4, 1} ),
    Add Term( {5, 1} ), Add Alias Term( {1, 1}, {2, 1} ), Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {1, 1}, {4, 1} ), Add Alias Term( {1, 1}, {5, 1} ),
    Add Alias Term( {1, 1}, {6, 1} ), Add Alias Term( {2, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {4, 1} ), Add Alias Term( {2, 1}, {5, 1} ),
    Add Alias Term( {2, 1}, {6, 1} ), Add Alias Term( {3, 1}, {4, 1} ),
    Add Alias Term( {3, 1}, {5, 1} ), Add Alias Term( {3, 1}, {6, 1} ),
    Add Alias Term( {4, 1}, {5, 1} ), Add Alias Term( {4, 1}, {6, 1} ),
    Add Alias Term( {5, 1}, {6, 1} ), Set Sample Size( 10 ), Make Design}
);


```

#### [Custom Design, Resolution V Screening Experiment that Resolves all Two-Factor Interactions](#custom-design-resolution-v-screening-experiment-that-resolves-all-two-factor-interactions)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ), Add Factor( Continuous, -1, 1, "X3", 0 ),
    Add Factor( Continuous, -1, 1, "X4", 0 ), Add Factor( Continuous, -1, 1, "X5", 0 ),
    Set Random Seed( 12345 ), Number of Starts( 10 ), Add Term( {1, 0} ), Add Term( {1, 1} ),
    Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {4, 1} ), Add Term( {5, 1} ),
    Add Term( {1, 1}, {2, 1} ), Add Term( {1, 1}, {3, 1} ), Add Term( {1, 1}, {4, 1} ),
    Add Term( {1, 1}, {5, 1} ), Add Term( {2, 1}, {3, 1} ), Add Term( {2, 1}, {4, 1} ),
    Add Term( {2, 1}, {5, 1} ), Add Term( {3, 1}, {4, 1} ), Add Term( {3, 1}, {5, 1} ),
    Add Term( {4, 1}, {5, 1} ), Set Sample Size( 16 ),
    Optimality Criterion( "Make D-Optimal Design" ), Make Design}
);


```

#### [Custom Design, Response Surface Design](#custom-design-response-surface-design)

```


DOE(
    Custom Design,
    {Add Response( Match Target, "Y", 54, 56, . ), Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ), Add Factor( Continuous, -1, 1, "X3", 0 ),
    Set Random Seed( 929281409 ), Number of Starts( 40 ), Add Term( {1, 0} ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {1, 2} ),
    Add Term( {1, 1}, {2, 1} ), Add Term( {2, 2} ), Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ), Add Term( {3, 2} ), Set Sample Size( 16 ),
    Optimality Criterion( 2 ), Make Design}
);


```

#### [Custom Design, Response Surface Design with Flexible Blocking](#custom-design-response-surface-design-with-flexible-blocking)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ), Add Factor( Blocking, 4, "X3" ),
    Set Random Seed( 12345 ), Number of Starts( 5 ), Add Term( {1, 0} ), Add Term( {1, 1} ),
    Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {1, 2} ), Add Term( {1, 1}, {2, 1} ),
    Add Term( {2, 2} ), Set Sample Size( 12 ), Optimality Criterion( 2 ), Make Design}
);


```

#### [Custom Design, Screening Experiment that Estimates Main Effects Only](#custom-design-screening-experiment-that-estimates-main-effects-only)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ), Add Factor( Continuous, -1, 1, "X3", 0 ),
    Add Factor( Continuous, -1, 1, "X4", 0 ), Add Factor( Continuous, -1, 1, "X5", 0 ),
    Add Factor( Continuous, -1, 1, "X6", 0 ), Set Random Seed( 12345 ), Number of Starts( 1 ),
    Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ),
    Add Term( {4, 1} ), Add Term( {5, 1} ), Add Term( {6, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ), Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {1, 1}, {4, 1} ), Add Alias Term( {1, 1}, {5, 1} ),
    Add Alias Term( {1, 1}, {6, 1} ), Add Alias Term( {2, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {4, 1} ), Add Alias Term( {2, 1}, {5, 1} ),
    Add Alias Term( {2, 1}, {6, 1} ), Add Alias Term( {3, 1}, {4, 1} ),
    Add Alias Term( {3, 1}, {5, 1} ), Add Alias Term( {3, 1}, {6, 1} ),
    Add Alias Term( {4, 1}, {5, 1} ), Add Alias Term( {4, 1}, {6, 1} ),
    Add Alias Term( {5, 1}, {6, 1} ), Set Sample Size( 12 ), Make Design}
);


```

#### [Custom Design, Split-Plot Experiment](#custom-design-split-plot-experiment)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "thickness", 10, ., . ),
    Add Factor( Continuous, -1, 1, "extrusion rate", 1 ),
    Add Factor( Continuous, -1, 1, "temperature", 1 ), Add Factor( Mixture, 0, 1, "m1", 0 ),
    Add Factor( Mixture, 0, 1, "m2", 0 ), Add Factor( Mixture, 0, 1, "m3", 0 ),
    Set Random Seed( 12345 ), Number of Starts( 5 ), Add Term( {3, 1} ), Add Term( {4, 1} ),
    Add Term( {5, 1} ), Add Term( {1, 1}, {2, 1} ), Add Term( {1, 1}, {3, 1} ),
    Add Term( {1, 1}, {4, 1} ), Add Term( {1, 1}, {5, 1} ), Add Term( {2, 1}, {3, 1} ),
    Add Term( {2, 1}, {4, 1} ), Add Term( {2, 1}, {5, 1} ), Add Term( {3, 1}, {4, 1} ),
    Add Term( {3, 1}, {5, 1} ), Add Term( {4, 1}, {5, 1} ), Set N Whole Plots( 7 ),
    Set Sample Size( 28 ), Optimality Criterion( "Make D-Optimal Design" ), Make Design}
);


```

#### [Custom Design, Supersaturated Screening Design](#custom-design-supersaturated-screening-design)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ), Add Factor( Continuous, -1, 1, "X3", 0 ),
    Add Factor( Continuous, -1, 1, "X4", 0 ), Add Factor( Continuous, -1, 1, "X5", 0 ),
    Add Factor( Continuous, -1, 1, "X6", 0 ), Add Factor( Continuous, -1, 1, "X7", 0 ),
    Add Factor( Continuous, -1, 1, "X8", 0 ), Add Factor( Continuous, -1, 1, "X9", 0 ),
    Add Factor( Continuous, -1, 1, "X10", 0 ), Add Factor( Continuous, -1, 1, "X11", 0 ),
    Add Factor( Continuous, -1, 1, "X12", 0 ), Set Random Seed( 12345 ),
    Number of Starts( 5 ), Add Term( {1, 0} ), Add Potential Term( {1, 1} ),
    Add Potential Term( {2, 1} ), Add Potential Term( {3, 1} ), Add Potential Term( {4, 1} ),
    Add Potential Term( {5, 1} ), Add Potential Term( {6, 1} ), Add Potential Term( {7, 1} ),
    Add Potential Term( {8, 1} ), Add Potential Term( {9, 1} ), Add Potential Term( {10, 1} ),
    Add Potential Term( {11, 1} ), Add Potential Term( {12, 1} ), Set Sample Size( 8 ),
    Simulate Responses( 1 ), Save X Matrix( 0 ), Set Run Order( Randomize ), Make Design}
);


```

#### [Custom Design, Two-Way Split-Plot Experiment](#custom-design-two-way-split-plot-experiment)

```


DOE(
    Custom Design,
    {Add Response( Minimize, "OCV", ., ., . ), Add Factor( Continuous, -1, 1, "A1", 2 ),
    Add Factor( Continuous, -1, 1, "A2", 2 ), Add Factor( Continuous, -1, 1, "A3", 2 ),
    Add Factor( Continuous, -1, 1, "A4", 2 ), Add Factor( Continuous, -1, 1, "C1", 1 ),
    Add Factor( Continuous, -1, 1, "C2", 1 ), Set Random Seed( 1866762673 ),
    Number of Starts( 21 ), Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Add Term( {3, 1} ), Add Term( {4, 1} ), Add Term( {5, 1} ), Add Term( {6, 1} ),
    Add Term( {1, 1}, {2, 1} ), Add Term( {1, 1}, {3, 1} ), Add Term( {1, 1}, {4, 1} ),
    Add Term( {1, 1}, {5, 1} ), Add Term( {1, 1}, {6, 1} ), Add Term( {2, 1}, {3, 1} ),
    Add Term( {2, 1}, {4, 1} ), Add Term( {2, 1}, {5, 1} ), Add Term( {2, 1}, {6, 1} ),
    Add Term( {3, 1}, {4, 1} ), Add Term( {3, 1}, {5, 1} ), Add Term( {3, 1}, {6, 1} ),
    Add Term( {4, 1}, {5, 1} ), Add Term( {4, 1}, {6, 1} ), Add Term( {5, 1}, {6, 1} ),
    Make Strip Plot Design, Set N Whole Plots( 16 ), Set N Subplots( 6 ),
    Set Sample Size( 48 ), Optimality Criterion( "Make D-Optimal Design" ), Make Design}
);


```

#### [Custom Design, Wine Tasting](#custom-design-wine-tasting)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Rating", 0, 20, . ), Add Factor( Blocking, 8, "Rater" ),
    Add Factor( Categorical, {"Bernard", "Dijon"}, "Variety", 0 ),
    Add Factor( Categorical, {"1", "2", "3", "4"}, "Field", 0 ),
    Add Factor( Categorical, {"No", "Yes"}, "De-Stem", 0 ),
    Add Factor( Categorical, {"Cultured", "Wild"}, "Yeast", 0 ),
    Add Factor( Categorical, {"High", "Low"}, "Temperature", 0 ),
    Add Factor( Categorical, {"Hard", "Soft"}, "Press", 0 ),
    Add Factor( Categorical, {"New", "2 Years"}, "Barrel Age", 0 ),
    Add Factor( Categorical, {"Air", "Kiln"}, "Barrel Seasoning", 0 ),
    Add Factor( Categorical, {"No", "Yes"}, "Filtering", 0 ), Set Random Seed( 1234 ),
    Number of Starts( 2 ), Add Term( {1, 0} ), Add Term( {2, 1} ), Add Term( {3, 1} ),
    Add Term( {4, 1} ), Add Term( {5, 1} ), Add Term( {6, 1} ), Add Term( {7, 1} ),
    Add Term( {8, 1} ), Add Term( {9, 1} ), Add Term( {10, 1} ), Add Term( {1, 1} ),
    Add Alias Term( {2, 1}, {3, 1} ), Add Alias Term( {2, 1}, {4, 1} ),
    Add Alias Term( {2, 1}, {5, 1} ), Add Alias Term( {2, 1}, {6, 1} ),
    Add Alias Term( {2, 1}, {7, 1} ), Add Alias Term( {2, 1}, {8, 1} ),
    Add Alias Term( {2, 1}, {9, 1} ), Add Alias Term( {2, 1}, {10, 1} ),
    Add Alias Term( {3, 1}, {4, 1} ), Add Alias Term( {3, 1}, {5, 1} ),
    Add Alias Term( {3, 1}, {6, 1} ), Add Alias Term( {3, 1}, {7, 1} ),
    Add Alias Term( {3, 1}, {8, 1} ), Add Alias Term( {3, 1}, {9, 1} ),
    Add Alias Term( {3, 1}, {10, 1} ), Add Alias Term( {4, 1}, {5, 1} ),
    Add Alias Term( {4, 1}, {6, 1} ), Add Alias Term( {4, 1}, {7, 1} ),
    Add Alias Term( {4, 1}, {8, 1} ), Add Alias Term( {4, 1}, {9, 1} ),
    Add Alias Term( {4, 1}, {10, 1} ), Add Alias Term( {5, 1}, {6, 1} ),
    Add Alias Term( {5, 1}, {7, 1} ), Add Alias Term( {5, 1}, {8, 1} ),
    Add Alias Term( {5, 1}, {9, 1} ), Add Alias Term( {5, 1}, {10, 1} ),
    Add Alias Term( {6, 1}, {7, 1} ), Add Alias Term( {6, 1}, {8, 1} ),
    Add Alias Term( {6, 1}, {9, 1} ), Add Alias Term( {6, 1}, {10, 1} ),
    Add Alias Term( {7, 1}, {8, 1} ), Add Alias Term( {7, 1}, {9, 1} ),
    Add Alias Term( {7, 1}, {10, 1} ), Add Alias Term( {8, 1}, {9, 1} ),
    Add Alias Term( {8, 1}, {10, 1} ), Add Alias Term( {9, 1}, {10, 1} ),
    Set Sample Size( 40 ), Simulate Responses( 0 ), Save X Matrix( 0 ), Make Design}
);


```

#### [Definitive Screening Design](#definitive-screening-design)

```


DOE(
    Definitive Screening Design,
    {Add Response( Maximize, "Yield", ., ., . ), Add Factor(
        Continuous, 0, 10, "Methanol", 0
    ), Add Factor( Continuous, 0, 10, "Ethanol", 0 ),
    Add Factor( Continuous, 0, 10, "Propanol", 0 ), Add Factor(
        Continuous, 0, 10, "Butanol", 0
    ), Add Factor( Continuous, 6, 9, "pH", 0 ), Add Factor( Continuous, 1, 2, "Time", 0 ),
    Show Blocking Options( 0, 0 ), Number of Extra Runs( 4 ), Set Random Seed( 880596769 ),
    Make Design, Simulate Responses( 0 ), Save X Matrix( 0 )}
);


```

#### [Definitive Screening Design with Blocks](#definitive-screening-design-with-blocks)

```


DOE(
    Definitive Screening Design,
    {Add Response( Maximize, "Yield", ., ., . ), Add Factor( Blocking, 0, "Lot" ),
    Add Factor( Continuous, 0, 10, "Methanol", 0 ), Add Factor(
        Continuous, 0, 10, "Ethanol", 0
    ), Add Factor( Continuous, 0, 10, "Propanol", 0 ),
    Add Factor( Continuous, 0, 10, "Butanol", 0 ), Add Factor( Continuous, 6, 9, "pH", 0 ),
    Add Factor( Continuous, 1, 2, "Time", 0 ), Show Blocking Options( 1, 2 ),
    Number of Extra Runs( 0 ), Set Random Seed( 1146016221 ), Make Design,
    Simulate Responses( 0 ), Save X Matrix( 0 )}
);


```

#### [Full Factorial Design](#full-factorial-design)

```


DOE(
    Full Factorial Design,
    {Add Response( Maximize, "Percent Reacted", 90, 100, 1 ),
    Add Factor( Continuous, {10, 15}, "Feed Rate", 0 ),
    Add Factor( Continuous, {1, 2}, "Catalyst", 0 ),
    Add Factor( Continuous, {100, 120}, "Stir Rate", 0 ),
    Add Factor( Continuous, {140, 180}, "Temperature", 0 ),
    Add Factor( Continuous, {3, 6}, "Concentration", 0 ), Set Random Seed( 12345 ),
    Make Design}
);


```

#### [Group Orthogonal Supersaturated Design](#group-orthogonal-supersaturated-design)

```


DOE(
    Group Orthogonal Supersaturated Design,
    {GOSSDStructure( 12, 16, 4, 4 ), ChangeFactorSettings( 1, Continuous, -1, 1, "Fake 1" ),
    ChangeFactorSettings( 2, Continuous, -1, 1, "Fake 2" ),
    ChangeFactorSettings( 3, Continuous, -1, 1, "Fake 3" ),
    ChangeFactorSettings( 4, Continuous, -1, 1, "X4" ),
    ChangeFactorSettings( 5, Continuous, -1, 1, "X5" ),
    ChangeFactorSettings( 6, Continuous, -1, 1, "X6" ),
    ChangeFactorSettings( 7, Continuous, -1, 1, "X7" ),
    ChangeFactorSettings( 8, Continuous, -1, 1, "X8" ),
    ChangeFactorSettings( 9, Continuous, -1, 1, "X9" ),
    ChangeFactorSettings( 10, Continuous, -1, 1, "X10" ),
    ChangeFactorSettings( 11, Continuous, -1, 1, "X11" ),
    ChangeFactorSettings( 12, Continuous, -1, 1, "X12" ),
    ChangeFactorSettings( 13, Continuous, -1, 1, "X13" ),
    ChangeFactorSettings( 14, Continuous, -1, 1, "X14" ),
    ChangeFactorSettings( 15, Continuous, -1, 1, "X15" ), Make Design,
    Simulate Responses( 0 )}
);


```

#### [MaxDiff Design](#maxdiff-design)

```


Open( "$SAMPLE_DATA/Design Experiment/Candy Profiles.jmp" );
DOE(
    MaxDiff Design,
    X( :Candy ),
    {Set Number of Profiles( 4 ), Set Number of Choice Sets( 7 ), Make Design,
    Simulate Responses( 0 )}
);


```

#### [Mixture Design, Extreme Vertices Design](#mixture-design-extreme-vertices-design)

```


DOE(
    Mixture Design,
    {Add Response( Maximize, "Y", ., ., . ), Change Factor Settings( 1, 0.05, 0.25, "X1" ),
    Change Factor Settings( 2, 0.1, 0.3, "X2" ), Change Factor Settings( 3, 0.1, 0.3, "X3" ),
    Add Factor( Mixture, 0.1, 0.4, "X4", 0 ), Add Factor( Mixture, 0.05, 0.25, "X5", 0 ),
    Set Random Seed( 1409 ), Mixture Design Type( Extreme Vertices, 4 ), Find Subset( 10 ),
    Simulate Responses( 0 )}
);


```

#### [Mixture Design, Optimal Mixture Design](#mixture-design-optimal-mixture-design)

```


DOE(
    Custom Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Mixture, 0, 1, "X1", 0 ),
    Add Factor( Mixture, 0, 1, "X2", 0 ), Add Factor( Mixture, 0, 1, "X3", 0 ),
    Set Random Seed( 1409 ), Number of Starts( 2 ), Add Constraint( [1 1 0 0.8] ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ), Add Term( {2, 1}, {3, 1} ), Center Points( 2 ),
    Set Sample Size( 12 ), Simulate Responses( 0 ), Save X Matrix( 0 ),
    Optimality Criterion( "Make D-Optimal Design" ), Make Design}
);


```

#### [MSA Design](#msa-design)

```


DOE(
    MSA Design,
    {Add Response( None, "Y", ., ., . ), Add Factor(
        Categorical,
        {"1", "2", "3", "4", "5"},
        "Part",
        MSA( 2, 1 )
    ), Add Factor( Categorical, {"1", "2", "3"}, "Operator", MSA( 1, 1 ) ),
    Add Factor( Categorical, {"Lab A", "Lab B", "Lab C"}, "Lab", MSA( 3, 1 ) ),
    Set Random Seed( 123 ), Replicates( 5, 0 ),
    Nesting Structure( {"Lab", {"Operator" || "Part"}} ), Make Design,
    Simulate Responses( 0 )}
);


```

#### [Response Surface Design, Box-Behnken Design](#response-surface-design-box-behnken-design)

```


DOE(
    Response Surface Design,
    {Add Response( Match Target, "Stretch", 350, 550, 1 ),
    Change Factor Settings( 1, 0.7, 1.7, "Silica" ),
    Change Factor Settings( 2, 1.8, 2.8, "Sulfur" ),
    Add Factor( Continuous, 40, 60, "Silane", 0 ), Set Random Seed( 12345 ), Make Design( 1 ),
    Center Points( 3 ), Simulate Responses( 0 ), Save X Matrix( 0 )}
);


```

#### [Screening Design, Fractional Factorial Design](#screening-design-fractional-factorial-design)

```


DOE(
    Screening Design,
    {Add Response( Match Target, "Depth", 0.12, 0.22, . ),
    Add Factor( Continuous, 3, 5, "Speed", 0 ), Add Factor(
        Continuous, 150, 165, "Current", 0
    ), Add Factor( Continuous, 20, 30, "Wall Size", 0 ),
    Add Factor( Categorical, {"John", "Mary"}, "Operator", 0 ),
    Add Factor( Categorical, {"Conductance", "Keyhole"}, "Mode", 0 ),
    Add Factor( Categorical, {"Double", "Single"}, "Geometry", 0 ),
    Add Factor( Categorical, {"Aluminum", "Magnesium"}, "Material", 0 ),
    Set Random Seed( 12345 ), Make Design( 1 ), Simulate Responses( 0 ), Save X Matrix( 0 )}
);


```

#### [Screening Design, Main Effects Screening Design](#screening-design-main-effects-screening-design)

```


DOE(
    Screening Design,
    {Add Response( Match Target, "Depth", 0.12, 0.22, . ),
    Add Factor( Continuous, 3, 5, "Speed", 0 ), Add Factor(
        Continuous, 150, 165, "Current", 0
    ), Add Factor( Continuous, 20, 30, "Wall Size", 0 ),
    Add Factor( Categorical, {"John", "Mary"}, "Operator", 0 ),
    Add Factor( Categorical, {"Conductance", "Keyhole"}, "Mode", 0 ),
    Add Factor( Categorical, {"Double", "Single"}, "Geometry", 0 ),
    Add Factor( Categorical, {"Aluminum", "Magnesium"}, "Material", 0 ),
    Set Random Seed( 12345 ), Screening Type( 1 ), Number of Starts( 1 ),
    Number of Column Starts( 50 ), Set Sample Size( 12 ), Make Design,
    Simulate Responses( 0 ), Save X Matrix( 0 )}
);


```

#### [Screening Design, Mixed-Level Screening Design](#screening-design-mixed-level-screening-design)

```


DOE(
    Screening Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ), Add Factor( Continuous, -1, 1, "X3", 0 ),
    Add Factor( Continuous, -1, 1, "X4", 0 ), Add Factor( Continuous, -1, 1, "X5", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X6", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X7", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X8", 0 ), Set Random Seed( 12345 ),
    Screening Type( 2, 2, 16 ), Make Design, Simulate Responses( 0 ), Save X Matrix( 0 )}
);


```

#### [Space Filling Design, Constrained Fast Flexible Filling](#space-filling-design-constrained-fast-flexible-filling)

```


DOE(
    Space Filling Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, 0, 1, "X1", 0 ),
    Add Factor( Continuous, 0, 1, "X2", 0 ), Set Random Seed( 765 ),
    Add Constraint( [1 1 0.8] ), FFF Optimality Criterion( MaxPro ),
    Space Filling Design Type( Fast Flexible Filling, 200 ), Simulate Responses( 0 )}
);


```

#### [Space Filling Design, Sphere Packing](#space-filling-design-sphere-packing)

```


DOE(
    Space Filling Design,
    {Add Response( Maximize, "Y", ., ., . ), Add Factor( Continuous, 0, 1, "X1", 0 ),
    Add Factor( Continuous, 0, 1, "X2", 0 ), Set Random Seed( 765 ),
    Space Filling Design Type( Sphere Packing, 8 ), Simulate Responses( 0 )}
);


```

## [Columns](#columns)

### [Factor](#factor)

**Syntax:** obj \<< Factor( column(s) )

```


DOE(
    Custom Design,
    {Add Response( Match Target, "Strength", 1.2, 1.4, . ),
    Add Factor( Categorical, {"Coarse", "Medium"}, "Grind", 0 ),
    Add Factor( Continuous, 195, 205, "Temperature", 0 ),
    Add Factor( Continuous, 3, 4, "Time", 0 ), Add Factor( Continuous, 1.6, 2.4, "Charge", 0 ),
    Add Factor( Blocking, 4, "Station " ), Set Random Seed( 569534903 ), Number of Starts( 100 ),
    Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ), Add Term( {3, 1} ),
    Add Term( {4, 1} ), Add Term( {5, 1} ), Add Alias Term( {1, 1}, {2, 1} ),
    Add Alias Term( {1, 1}, {3, 1} ), Add Alias Term( {1, 1}, {4, 1} ),
    Add Alias Term( {2, 1}, {3, 1} ), Add Alias Term( {2, 1}, {4, 1} ),
    Add Alias Term( {3, 1}, {4, 1} ), Set Sample Size( 12 ), Make Design}
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```


DOE(
    Custom Design,
    {Add Response( Match Target, "Strength", 1.2, 1.4, . ),
    Add Factor( Categorical, {"Coarse", "Medium"}, "Grind", 0 ),
    Add Factor( Continuous, 195, 205, "Temperature", 0 ),
    Add Factor( Continuous, 3, 4, "Time", 0 ), Add Factor(
        Continuous, 1.6, 2.4, "Charge", 0
    ), Add Factor( Blocking, 4, "Station " ), Set Random Seed( 569534903 ),
    Number of Starts( 100 ), Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Add Term( {3, 1} ), Add Term( {4, 1} ), Add Term( {5, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ), Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {1, 1}, {4, 1} ), Add Alias Term( {2, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {4, 1} ), Add Alias Term( {3, 1}, {4, 1} ), Set Sample Size( 12 ),
    Make Design}
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```


DOE(
    Custom Design,
    {Add Response( Match Target, "Strength", 1.2, 1.4, . ),
    Add Factor( Categorical, {"Coarse", "Medium"}, "Grind", 0 ),
    Add Factor( Continuous, 195, 205, "Temperature", 0 ),
    Add Factor( Continuous, 3, 4, "Time", 0 ), Add Factor(
        Continuous, 1.6, 2.4, "Charge", 0
    ), Add Factor( Blocking, 4, "Station " ), Set Random Seed( 569534903 ),
    Number of Starts( 100 ), Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Add Term( {3, 1} ), Add Term( {4, 1} ), Add Term( {5, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ), Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {1, 1}, {4, 1} ), Add Alias Term( {2, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {4, 1} ), Add Alias Term( {3, 1}, {4, 1} ), Set Sample Size( 12 ),
    Make Design}
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```


DOE(
    Custom Design,
    {Add Response( Match Target, "Strength", 1.2, 1.4, . ),
    Add Factor( Categorical, {"Coarse", "Medium"}, "Grind", 0 ),
    Add Factor( Continuous, 195, 205, "Temperature", 0 ),
    Add Factor( Continuous, 3, 4, "Time", 0 ), Add Factor(
        Continuous, 1.6, 2.4, "Charge", 0
    ), Add Factor( Blocking, 4, "Station " ), Set Random Seed( 569534903 ),
    Number of Starts( 100 ), Add Term( {1, 0} ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Add Term( {3, 1} ), Add Term( {4, 1} ), Add Term( {5, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ), Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {1, 1}, {4, 1} ), Add Alias Term( {2, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {4, 1} ), Add Alias Term( {3, 1}, {4, 1} ), Set Sample Size( 12 ),
    Make Design}
);


```

## [Item Messages](#item-messages)

### [A-Optimality Parameter Weights](#a-optimality-parameter-weights)

**Syntax:** obj \<< A-Optimality Parameter Weights

**Description:** Sets the weights to be used for creating an A-optimal design.

**JMP Version Added:** 14

```

DOE(
    Custom Design,
    {Add Factor( Continuous, -1, 1, "X1", 0 ), Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ), Add Term( {1, 0} ), Add Term( {1, 1} ),
    Add Term( {2, 1} ), Add Term( {3, 1} ), Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ), Add Term( {2, 1}, {3, 1} ), Set Sample Size( 14 ),
    Optimality Criterion( "Make A-Optimal Design"n ),
    "A-Optimality Parameter Weights"n( [1 1 1 1 0.1 0.1 0.1] )}
);


```

### [ALT Factor Settings](#alt-factor-settings)

**Syntax:** obj \<< ALT Factor Settings

**Description:** For the given factor number in an accelerated life test plan, allows specification of factor name, number of levels, factor transformation, usage conditions and test conditions.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [ALT Plan Setup](#alt-plan-setup)

**Syntax:** obj \<< ALT Plan Setup( 1|2|3 )

**Description:** Specifies the initial choice of model for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Add Alias Term](#add-alias-term)

**Syntax:** obj \<< Add Alias Term

**Description:** Adds an alias term to the list of alias terms. Specify the factor number and power for each effect in a list. Create interactions by separating effects with commas.

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 )
);
d << Add Alias Term( {1, 1}, {2, 1} );
d << Add Alias Term( {1, 2} );


```

### [Add Constraint](#add-constraint)

**Syntax:** obj \<< Add Constraint

**Description:** Adds linear constraints through a matrix. Each row represents a constraint. The last column is for values on the right side of the inequality constraints. In JSL, the inequality constraints must be less than or equal to the values on the right.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Add Constraint( [1 1 0 1, 1 0 1 1] ),
    Add Term( {1, 0} )
);


```

### [Add Factor](#add-factor)

**Syntax:** obj \<< Add Factor( Continuous|Discrete Numeric|Blocking|Constant|Categorical|Mixture )

**Description:** Adds a factor of the specified type and optional arguments. If nothing is specified, this command adds a continuous factor.

```

d = DOE( Custom Design );
d << Add Factor( Continuous, -1, 1, "X1", 0 );
d << Add Factor( Discrete Numeric, {1, 2, 3}, "X2", 0 );
d << Add Factor( Categorical, {"L1", "L2"}, "X3", 0 );
d << Add Factor( Blocking, 8, "X4" );
d << Add Factor( Constant, 3, "X5" );


```

### [Add Functional Response](#add-functional-response)

**Syntax:** obj \<< Add Functional Response

**Description:** Adds a functional response with the specified name, number of measurements per run, and values.

**JMP Version Added:** 15

```

DOE(
    Custom Design,
    Add Response( Maximize, "Y", ., ., . ),
    Add Functional Response( "Y", 5, {1, 2, 3, 4, 5} ),
    Set Random Seed( 46055034 ),
    Simulate Responses( 0 ),
    Save X Matrix( 0 )
);


```

### [Add Potential Term](#add-potential-term)

**Syntax:** obj \<< Add Potential Term

**Description:** Adds an If Possible term to the list of model terms. Specify the factor number and power for each effect in a list. Create interactions by separating effects with commas.

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 )
);
d << Add Potential Term( {1, 1}, {2, 1} );
d << Add Potential Term( {1, 2} );


```

### [Add Response](#add-response)

**Syntax:** obj \<< Add Response( goal, name, lower limit, upper limit, importance, lower detection limit, upper detection limit )

**Description:** Adds a response with the specified goal, name, lower limit, upper limit, and importance.

**Example 1**

```

DOE( Custom Design, Add Response( Match Target, "Y", 10, 30, 1 ) );


```

**Example 2**

```

DOE( Custom Design, Add Response( Match Target, "Y", ., ., 1, 10, 30 ) );


```

### [Add Term](#add-term)

**Syntax:** obj \<< Add Term

**Description:** Adds a "Necessary" term to list of the model terms. Effects are specified by {factor number, power}. Interactions can be created by separating effects by commas.

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 )
);
d << Add Term( {1, 1}, {2, 1} );
d << Add Term( {1, 2} );


```

### [Additional Designs](#additional-designs)

**Syntax:** obj \<< Additional Designs

**Description:** Specify up to nine additional designs to be compared to the reference design.

**JMP Version Added:** 14

```

DOE(
    Custom Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Set Sample Size( 12 ),
    Make Design,
    Make Table
);
DOE( Custom Design, Add Factor, Add Factor, Add Factor, Make Design, Make Table );
DOE(
    Custom Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Set Sample Size( 4 ),
    Make Design,
    Make Table
);
DOE(
    Compare Designs,
    Reference Design( "Custom Design", X( :X1, :X2, :X3 ) ),
    Additional Designs(
        "Custom Design 2",
        X( :X1, :X2, :X3 ),
        "Custom Design 3",
        X( :X1, :X2, :X3 )
    )
);


```

### [Allow covariate rows to be repeated](#allow-covariate-rows-to-be-repeated)

**Syntax:** obj \<< Allow covariate rows to be repeated( state=0|1 )

**Description:** Specifies if covariate rows are allowed to be repeated in the design.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
DOE(
    Custom Design,
    Add Response( Maximize, "Y", ., ., . ),
    Add Factor( Covariate, :sex, 0 ),
    Add Factor( Covariate, :height, 0 ),
    Add Factor( Covariate, :weight, 0 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Enforce Use of Selected Covariate Rows( 1 ),
    Allow covariate rows to be repeated( 1 ),
    Select Covariate Rows( [1 2 3 4] ),
    Set Sample Size( 24 )
);


```

### [Augment Method](#augment-method)

**Syntax:** obj \<< Augment Method( Replicate|Centerpoints|Fold Over|Add Axial|Augment )

**Description:** Specifies the type of augment method and its parameters.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Augment Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Augment Method( Augment );
d << Set Sample Size( 24 );
d << Make Design;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/2x3x4 Factorial.jmp" );
d = DOE( Augment Design, X( :X1, :X2, :X3 ), Y( :Y ) );
d << Augment Method( Replicate, 2 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Augment Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Augment Method( Centerpoints, 3 );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Augment Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Augment Method( Fold Over, [1 2] );


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Augment Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Augment Method( Add Axial, 1, 2 );


```

### [Blocks](#blocks)

**Syntax:** obj \<< Blocks

**Description:** Specifies the block size for a balanced incomplete block design (BIBD).

**JMP Version Added:** 14

```

d = DOE( Balanced Incomplete Block Design, Treatments( 3, {"L1", "L2", "L3"} ) );
d << Blocks( 2 );
d << Make Design;


```

### [Center Points](#center-points)

**Syntax:** obj \<< Center Points

**Description:** Specifies the number of center points.

**Example 1**

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 )
);
d << Make Model( Linear );
d << Center Points( 2 );


```

**Example 2**

```

DOE(
    Definitive Screening Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Show Blocking Options( 1, 2 ),
    Number of Extra Runs( 4 ),
    Center Points( 1 )
);


```

### [Change Anticipated Coefficients](#change-anticipated-coefficients)

**Syntax:** obj \<< Change Anticipated Coefficients

**Description:** Change the Anticipated Coefficients in Power Analysis.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Change Anticipated Coefficients( [1 2 3 4 2 2 2 3 3 3] );


```

### [Change Factor Settings](#change-factor-settings)

**Syntax:** obj \<< Change Factor Settings

**Description:** Specifies the minimum, maximum, and name of the continuous or mixture factor that you included in the first argument. Most useful for platforms that initially have predefined factors.

**Example 1**

```

d = DOE( Response Surface Design );
d << Change Factor Settings( 1, 2, 3, "A" );
d << Change Factor Settings( 2, 0, 4 );


```

**Example 2**

```

d = DOE( Mixture Design );
d << Change Factor Settings( 1, 0.1, 0.4, "A" );
d << Change Factor Settings( 3, 0, 0.8, "C" );


```

### [Check Inscribe](#check-inscribe)

**Syntax:** obj \<< Check Inscribe

**Description:** Rescales the design so that axial points are at the low and high ends of the range.

```

d = DOE( Response Surface Design, Make Design( 2 ) );
d << Set Axial Choice( 2 );
d << Check Inscribe;


```

### [Choice Design Table Output](#choice-design-table-output)

**Syntax:** obj \<< Choice Design Table Output( "Separate"|"Combined" )

**Description:** Specifies how to create a data table for a choice design.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Add Term( {1, 1} ), Add Term( {2, 1} ),
    Set Prior Mean Choice( [0 0] ), Set Prior Variance Matrix( [1 0, 0 1] ),
    Set Number of Attributes( 2 ), Set Number of Profiles( 2 ),
    Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 ), Make Design,
    Choice Design Table Output( Combined )}
);


```

### [D Efficiency Weight](#d-efficiency-weight)

**Syntax:** obj \<< D Efficiency Weight

**Description:** Use this option to control the relative importance of D-efficiency and reduction of aliasing. Supply a number between zero and one.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    D Efficiency Weight( 0.5 ),
    Make Design
);


```

### [Design Search Time](#design-search-time)

**Syntax:** obj \<< Design Search Time( number )

**Description:** Specifies the number of seconds to search for a design.

```

DOE(
    Custom Design,
    {Add Factor( Continuous, -1, 1, "X1", 0 ), Add Factor( Continuous, -1, 1, "X2", 0 ),
    Set Sample Size( 7 ), Design Search Time( 8 ), Make Design}
);


```

### [Disallowed Combinations](#disallowed-combinations)

**Syntax:** obj \<< Disallowed Combinations

**Description:** Enables you to supply a script that returns true for any factor combinations that should be excluded from your design.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ),
    Number of Starts( 100 ),
    Disallowed Combinations( X1 > 0.5 & X2 == 2 ),
    Make Design
);


```

### [Discrete Numeric Powers Set to Necessary](#discrete-numeric-powers-set-to-necessary)

**Syntax:** obj \<< Discrete Numeric Powers Set to Necessary( state=0|1 )

**Description:** Specifies if powers in discrete numeric factors should be necessary model terms.

```

DOE(
    Custom Design,
    Add Factor( Discrete Numeric, {1, 2, 3}, "X1", 0 ),
    Add Factor( Discrete Numeric, {1, 2, 3}, "X2", 0 ),
    Discrete Numeric Powers Set to Necessary( 1 ),
    Make Model( Linear )
);


```

### [Distribution Choice](#distribution-choice)

**Syntax:** obj \<< Distribution Choice

**Description:** Specifies the distribution for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Enforce Use of Selected Covariate Rows](#enforce-use-of-selected-covariate-rows)

**Syntax:** obj \<< Enforce Use of Selected Covariate Rows( state=0|1 )

**Description:** Specifies if all selected covariate rows should be included in the design.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
DOE(
    Custom Design,
    Add Response( Maximize, "Y", ., ., . ),
    Add Factor( Covariate, :sex, 0 ),
    Add Factor( Covariate, :height, 0 ),
    Add Factor( Covariate, :weight, 0 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Enforce Use of Selected Covariate Rows( 1 ),
    Allow covariate rows to be repeated( 1 ),
    Select Covariate Rows( [1 2 3 4] ),
    Set Sample Size( 24 )
);


```

### [FFF Optimality Criterion](#fff-optimality-criterion)

**Syntax:** obj \<< FFF Optimality Criterion( "MaxPro"|"Centroid" )

**Description:** Specifies the criterion used in the design. Recommended is the default value.

**Example 1**

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Optimality Criterion( "Make I-optimal Design" ),
    Make Design
);


```

**Example 2**

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Optimality Criterion( 2 ),
    Make Design
);


```

### [Find Subset](#find-subset)

**Syntax:** obj \<< Find Subset

**Description:** Finds the D-optimal subset of an Extreme Vertices design.

```

d = DOE( Mixture Design, Add Factor( Mixture, 0.1, 1, "X4", 0 ) );
d << Mixture Design Type( Extreme Vertices, 3 );
d << Find Subset( 10 );


```

### [GOSSDDetails](#gossddetails)

**Syntax:** obj \<< GOSSDDetails

**Description:** Returns the current factor settings as a list.

**JMP Version Added:** 15

```

d = DOE( Group Orthogonal Supersaturated Design );
Show( d << GOSSDDetails );


```

### [GOSSDStructure](#gossdstructure)

**Syntax:** obj \<< GOSSDStructure

**Description:** Specifies the structure of a GOSSD

**JMP Version Added:** 15

```

d = DOE( Group Orthogonal Supersaturated Design );
d << GOSSDStructure( 6, 8 );


```

### [Get Alias Matrix](#get-alias-matrix)

**Syntax:** obj \<< Get Alias Matrix

**Description:** Returns the alias matrix from design evaluation.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Get Alias Matrix;


```

### [Get Design Diagnostics](#get-design-diagnostics)

**Syntax:** obj \<< Get Design Diagnostics

**Description:** Return D-Efficiency, G-Efficiency, A-Efficiency and Average Variance of Prediction.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Get Design Diagnostics;


```

### [Get Effect Power](#get-effect-power)

**Syntax:** obj \<< Get Effect Power

**Description:** Return vector of powers for effect estimates.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/2x3x4 Factorial.jmp" );
d = DOE( Evaluate Design, X( :X1, :X2, :X3 ), Y( :Y ) );
d << Get Effect Power;


```

### [Get Estimation Efficiencies](#get-estimation-efficiencies)

**Syntax:** obj \<< Get Estimation Efficiencies

**Description:** Returns a vector for the increased width of each parameter estimate compared to an ideal design.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Get Estimation Efficiencies;


```

### [Get MaxPro Values](#get-maxpro-values)

**Syntax:** obj \<< Get MaxPro Values

**Description:** Returns the MaxPro values for a fast-flexible design, including any subdesigns based on levels of a categorical factor.

**JMP Version Added:** 14

```

d = DOE(
    Space Filling Design,
    {Add Factor( Continuous, -1, 1, "X1", 0 ), Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Categorical, {"L1", "L2", "L3", "L4"}, "X3", 0 ),
    FFF Optimality Criterion( MaxPro ), MaxPro Categorical Weight( 4 ),
    Space Filling Design Type( Fast Flexible Filling, 100 )}
);
d << Get MaxPro Values;


```

### [Get Number of Random Starts](#get-number-of-random-starts)

**Syntax:** obj \<< Get Number of Random Starts

**Description:** Returns the number of random starts used in design generation.

**JMP Version Added:** 15

### [Get Power](#get-power)

**Syntax:** obj \<< Get Power

**Description:** Return vector of powers for parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Get Power;


```

### [Get Prediction Variances](#get-prediction-variances)

**Syntax:** obj \<< Get Prediction Variances

**Description:** Returns the vector of prediction variances from the Fraction of Design Space Plot.

**JMP Version Added:** 14

```

d = DOE(
    Custom Design,
    {Add Factor( Continuous, -1, 1, "X1", 0 ), Add Factor( Continuous, -1, 1, "X2", 0 ),
    Set Sample Size( 7 ), Design Search Time( 8 ), Set Number of FDS points( 20000 ),
    Make Design}
);
d << Get Prediction Variances;


```

### [Get X Matrix](#get-x-matrix)

**Syntax:** obj \<< Get X Matrix

**Description:** Returns the design matrix (also called the X matrix).

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Get X Matrix;


```

### [Group New Runs Into Separate Block](#group-new-runs-into-separate-block)

**Syntax:** obj \<< Group New Runs Into Separate Block

**Description:** Adds a blocking factor, which groups new runs into separate blocks when augmenting a design.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Augment Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Group New Runs Into Separate Block;


```

### [Load Constraints](#load-constraints)

**Syntax:** obj \<< Load Constraints

**Description:** Load a previously saved factor constraints table for use in this experiment.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Diamond Constraints.jmp" );
d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Term( {1, 0} ),
    Load Constraints
);


```

### [Load Design](#load-design)

**Syntax:** obj \<< Load Design

**Description:** Load Design

```

d = DOE( Custom Design );
d << Load Design();


```

### [Load Factors](#load-factors)

**Syntax:** obj \<< Load Factors

**Description:** Load a previously saved factors table for use in this experiment.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Factors.jmp" );
DOE( Custom Design, Load Factors );


```

### [Load Responses](#load-responses)

**Syntax:** obj \<< Load Responses

**Description:** Loads a previously saved data table of responses.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Response.jmp" );
DOE( Custom Design, Load Responses );


```

### [Local Design](#local-design)

**Syntax:** obj \<< Local Design( state=0|1 )

**Description:** Specifies if local design for the prior mean should be created.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( 2, {5, 200, 200} ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Local Design( 0 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Inspection Times( [200 400 600 800 1000] ),
    Set Number of Units( 150 ), Set Candidate Runs( [90 0 150, 100 0 150, 110 0 150] )}
);


```

### [Make Design](#make-design)

**Syntax:** obj \<< Make Design

**Description:** Creates the design that you specified in the script.

```

d = DOE( Custom Design, Add factor, Add factor, Add factor );
d << Make Model( RSM );
d << Make Design;


```

### [Make Model](#make-model)

**Syntax:** obj \<< Make Model( Linear|Interactions|RSM )

**Description:** Adds terms to the list of model terms for the specified model.

**Example 1**

```

d = DOE( Custom Design, Add Factor, Add Factor, Add Factor );
d << Make Model( RSM );


```

**Example 2**

```

d = DOE( Custom Design, Add Factor, Add Factor, Add Factor );
d << Make Model( Interactions );


```

### [Make Strip Plot Design](#make-strip-plot-design)

**Syntax:** obj \<< Make Strip Plot Design

**Description:** Specifies a strip plot design when hard-to-change factors vary independently from very hard-to-change factors.

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 2 ),
    Add Factor( Continuous, -1, 1, "X2", 1 ),
    Add Factor( Continuous, -1, 1, "X3", 0 )
);
d << Set N Whole Plots( 4 );
d << Make Strip Plot Design;


```

### [Make Table](#make-table)

**Syntax:** obj \<< Make Table

**Description:** Creates a data table from the current design.

```

d = DOE( Custom Design, Add factor, Add factor, Add factor );
d << Make Design;
d << Make Table;


```

### [Make Test Plan](#make-test-plan)

**Syntax:** obj \<< Make Test Plan

**Description:** Creates the test plan for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Monitoring at Intervals", {5, 200, 200} ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Inspection Times( [200 400 600 800 1000] ),
    Set Number of Units( 150 ), Set Candidate Runs( [90 0 150, 100 0 150, 110 0 150] ),
    Make Design, Make Test Plan}
);


```

### [MaxPro Categorical Weight](#maxpro-categorical-weight)

**Syntax:** obj \<< MaxPro Categorical Weight

**Description:** Specifies MaxPro weight. Values larger than 1 increase the separation of points that have the same categorical level.

**JMP Version Added:** 14

```

DOE(
    Space Filling Design,
    {Add Factor( Continuous, -1, 1, "X1", 0 ), Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Categorical, {"L1", "L2", "L3", "L4"}, "X3", 0 ),
    FFF Optimality Criterion( MaxPro ), MaxPro Categorical Weight( 4 ),
    Space Filling Design Type( Fast Flexible Filling, 100 )}
);


```

### [Mixture Design Type](#mixture-design-type)

**Syntax:** obj \<< Mixture Design Type( Simplex Centroid|Simplex Lattice|ABCD|Extreme Vertices|Space Filling )

**Description:** Specifies the type of mixture design. The default parameters are used unless you specify the parameter as the second argument.

**Example 1**

```

d = doe( Mixture Design );
d << Mixture Design Type( Simplex Centroid, 2 );


```

**Example 2**

```

d = doe( Mixture Design );
d << Mixture Design Type( Simplex Lattice, 4 );


```

**Example 3**

```

d = doe( Mixture Design );
d << Mixture Design Type( ABCD );


```

**Example 4**

```

d = doe( Mixture Design );
d << Change Factor Settings( 1, .05, .25 );
d << Mixture Design Type( Extreme Vertices, 3 );


```

**Example 5**

```

d = doe( Mixture Design );
d << Mixture Design Type( Space Filling, 25 );


```

### [Mixture Sum](#mixture-sum)

**Syntax:** obj \<< Mixture Sum

**Description:** Use this option when you want to express the sum of all the ingredients to be other than 1. The mixture total is the sum of all the ingredient amounts.

```

DOE(
    Custom Design,
    Mixture Sum( 50 ),
    Add Factor( Mixture, 10, 25, "X1", 0 ),
    Add Factor( Mixture, 0, 15, "X2", 0 ),
    Add Factor( Mixture, 25, 40, "X3", 0 ),
    Make Design
);


```

### [Nesting Structure](#nesting-structure)

**Syntax:** obj \<< Nesting Structure

**Description:** Specifies the nesting structure of the design. Use a bracketed list to indicate nesting (first element is nesting factor, second element is bracketed list of nested factors or structures). Use horizontal concatenation ('||') to indicate crossed factors or structures.

```

DOE(
    MSA Design,
    Add Factor( Categorical, {"L1", "L2"}, "X1", MSA( 4, 1, 1 ) ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", MSA( 4, 1, 1 ) ),
    Add Factor( Categorical, {"L1", "L2"}, "X3", MSA( 4, 1, 1 ) ),
    Nesting Structure( {"X1", {"X2"}} || "X3" )
);


```

### [Number of Column Starts](#number-of-column-starts)

**Syntax:** obj \<< Number of Column Starts

**Description:** Specifies the number of times that random columns are optimized for each factor of a main effects screening design.

```

DOE(
    Screening Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Screening Type( 1 ),
    Number of Column Starts( 100 ),
    Set Sample Size( 12 ),
    Make Design
);


```

### [Number of Extra Runs](#number-of-extra-runs)

**Syntax:** obj \<< Number of Extra Runs

**Description:** Specifies the number of extra runs to include in a definitive screening design.

```

DOE(
    Definitive Screening Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Show Blocking Options( 1, 2 ),
    Number of Extra Runs( 4 )
);


```

### [Number of Starts](#number-of-starts)

**Syntax:** obj \<< Number of Starts

**Description:** Specifies the number of times the design is regenerated to optimize the overall design.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Number of Starts( 1000 ),
    Make Design
);


```

### [Optimality Criterion](#optimality-criterion)

**Syntax:** obj \<< Optimality Criterion( "Recommended"|"Make D-Optimal Design"|"Make I-Optimal Design"|"Make A-Optimal Design"|"Make Alias Optimal Design" )

**Description:** Specifies the criterion used in the design. Recommended is the default value.

**Example 1**

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Optimality Criterion( "Make I-optimal Design" ),
    Make Design
);


```

**Example 2**

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Optimality Criterion( 2 ),
    Make Design
);


```

### [Order Column](#order-column)

**Syntax:** obj \<< Order Column

**Description:** Requests an order column when the data table is created.

**JMP Version Added:** 14

```

d = DOE( Balanced Incomplete Block Design );
d << Treatments( 3, {"L1", "L2", "L3"} );
d << Make Design;
d << OrderColumn( 1 );


```

### [Prior Parameter Variance](#prior-parameter-variance)

**Syntax:** obj \<< Prior Parameter Variance

**Description:** Use this option to control the weight used for If Possible terms in a model. Higher values mean more prior information and smaller variance. The variances are the reciprocals of the entered values.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Potential Term( {1, 1} ),
    Add Potential Term( {2, 1} ),
    Add Potential Term( {1, 1}, {2, 1} ),
    Prior Parameter Variance( [0, 1, 2, 6] ),
    Make Design
);


```

### [Prior Specification Choice](#prior-specification-choice)

**Syntax:** obj \<< Prior Specification Choice

**Description:** Sets the option for specifying prior parameters, where 1 indicates Specify Intercept and 2 indicates Specify Quantile.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Prior Specification Choice( 1 ), Set Prior Mean ALT( [-40 1.5 2] ),
    Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Reference Design](#reference-design)

**Syntax:** obj \<< Reference Design

**Description:** Specify the reference design for design comparison.

**JMP Version Added:** 14

```

DOE(
    Custom Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Set Sample Size( 12 ),
    Make Design,
    Make Table
);
DOE( Custom Design, Add Factor, Add Factor, Add Factor, Make Design, Make Table );
DOE(
    Custom Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Set Sample Size( 4 ),
    Make Design,
    Make Table
);
DOE(
    Compare Designs,
    Reference Design( "Custom Design", X( :X1, :X2, :X3 ) ),
    Additional Designs(
        "Custom Design 2",
        X( :X1, :X2, :X3 ),
        "Custom Design 3",
        X( :X1, :X2, :X3 )
    )
);


```

### [Remove Alias Term](#remove-alias-term)

**Syntax:** obj \<< Remove Alias Term

**Description:** Removes a term from the list of alias terms. Specify the factor number and power for each effect in a list. Create interactions by separating effects with commas.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Remove Alias Term( {1, 1}, {3, 1} );


```

### [Remove All Alias Terms](#remove-all-alias-terms)

**Syntax:** obj \<< Remove All Alias Terms

**Description:** Removes all Alias Terms from the list of alias terms

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 )
);
d << Make Model( Linear );
d << Remove All Alias Terms;


```

### [Remove Term](#remove-term)

**Syntax:** obj \<< Remove Term

**Description:** Removes a term from the list of model terms. Specify the factor number and power for each effect in a list. Create interactions by separating effects with commas.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Remove Term( {1, 1}, {3, 1} );
d << Remove Term( {3, 2} );


```

### [Replicates](#replicates)

**Syntax:** obj \<< Replicates

**Description:** Specifies the number of replicate runs. For MSA Designs, a second argument specifies the replicate structure: 0=Completely Randomized, 1=Batch Repeat, 2=Fast Repeat.

**Example 1**

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 )
);
d << Make Model( Linear );
d << Replicates( 2 );


```

**Example 2**

```

d = DOE(
    MSA Design,
    {Add Response( None, "Y", ., ., . ), Add Factor(
        Categorical,
        {"L1", "L2"},
        "X1",
        MSA( 4, 1 )
    ), Add Factor( Categorical, {"L1", "L2"}, "X2", MSA( 4, 1 ) ),
    Add Factor( Categorical, {"L1", "L2"}, "X3", MSA( 4, 1 ) ), Set Random Seed( 3983347 ),
    Replicates( 2, 0 ), Simulate Responses( 0 )}
);


```

### [Report](#report)

**Syntax:** obj \<< Report

**Description:** Returns a reference to the report object.

```

d = DOE( Custom Design );
r = d << report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save Constraints](#save-constraints)

**Syntax:** obj \<< Save Constraints

**Description:** Save the factor constraints of the current experiment to a JMP table for use in another experiment

```

DOE(
    Custom Design,
    Add Response( Maximize, "Y", ., ., . ),
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Add Constraint( [1 1 0 1, 1 0 1 1] ),
    Add Term( {1, 0} ),
    Save Constraints
);


```

### [Save Factors](#save-factors)

**Syntax:** obj \<< Save Factors

**Description:** Save the factors you just created to a JMP table so you can use these factors for another experiment.

```

DOE(
    Custom Design,
    Add Response( Match Target, "Stretch", 350, 550, 1 ),
    Add Factor( Continuous, 0.7, 1.7, "Silica", 0 ),
    Add Factor( Continuous, 1.8, 2.8, "Sulfur", 0 ),
    Add Factor( Continuous, 40, 60, "Silane", 0 ),
    Save Factors
);


```

### [Save Responses](#save-responses)

**Syntax:** obj \<< Save Responses

**Description:** Saves the responses that you created as a JMP data table. You can load these responses in other experiments.

```

DOE(
    Custom Design,
    Add Response( Match Target, "Stretch", 350, 550, 1 ),
    Add Factor( Continuous, 0.7, 1.7, "Silica", 0 ),
    Add Factor( Continuous, 1.8, 2.8, "Sulfur", 0 ),
    Add Factor( Continuous, 40, 60, "Silane", 0 ),
    Save Responses
);


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** obj \<< Save Script to Data Table

**Description:** Create a Script that will reproduce this design.

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a Script that will reproduce this design.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Make Design,
    Save Script to Script Window
);


```

### [Save X Matrix](#save-x-matrix)

**Syntax:** obj \<< Save X Matrix( state=0|1 )

**Description:** Saves the design matrix (also called the X matrix) as a table property in the JMP data table that contains the design.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Save X Matrix,
    Make Design,
    Make Table
);


```

### [Screening Type](#screening-type)

**Syntax:** obj \<< Screening Type

**Description:** Specifies a main effects screening design, which is orthogonal or near orthogonal.

```

d = DOE(
    Screening Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 )
);
d << Screening Type( 1 );
d << Set Sample Size( 12 );
d << Make Design;


```

### [Select Covariate Rows](#select-covariate-rows)

**Syntax:** obj \<< Select Covariate Rows

**Description:** Specifies the rows from the covariate table to be selected in DOE.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
DOE(
    Custom Design,
    Add Response( Maximize, "Y", ., ., . ),
    Add Factor( Covariate, :sex, 0 ),
    Add Factor( Covariate, :height, 0 ),
    Add Factor( Covariate, :weight, 0 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Enforce Use of Selected Covariate Rows( 1 ),
    Allow covariate rows to be repeated( 1 ),
    Select Covariate Rows( [1 2 3 4] ),
    Set Sample Size( 24 )
);


```

### [Set ALT Probability of Interest](#set-alt-probability-of-interest)

**Syntax:** obj \<< Set ALT Probability of Interest

**Description:** Sets the probability of interest for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set ALT Time Range](#set-alt-time-range)

**Syntax:** obj \<< Set ALT Time Range

**Description:** Sets the time range of interest for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Failure Probability Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set Average Cluster Size](#set-average-cluster-size)

**Syntax:** obj \<< Set Average Cluster Size

**Description:** Controls number of random points for clustering a Fast Flexible Filling Design.

```

DOE(
    Space Filling Design,
    Change Factor Settings( 1, -1, 1, "X1" ),
    Change Factor Settings( 2, -1, 1, "X2" ),
    Set Average Cluster Size( 100 ),
    Space Filling Design Type( Fast Flexible Filling, 50 )
);


```

### [Set Axial Choice](#set-axial-choice)

**Syntax:** obj \<< Set Axial Choice( 1|2|3|4 )

**Description:** Specifies the axial value settings. Use 1 for Rotatable, 2 for Orthogonal, 3 for On Face, and 4 User Specified.

```

d = DOE( Response Surface Design, Make Design( 2 ) );
d << Set Axial Choice( 2 );


```

### [Set Axial Value](#set-axial-value)

**Syntax:** obj \<< Set Axial Value

**Description:** Specifies the User Specified axial value.

```

d = DOE( Response Surface Design, Make Design( 2 ) );
d << Set Axial Value( 2 );


```

### [Set Candidate Runs](#set-candidate-runs)

**Syntax:** obj \<< Set Candidate Runs

**Description:** Sets the candidate runs for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Monitoring at Intervals", {5, 200, 200} ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Inspection Times( [200 400 600 800 1000] ),
    Set Number of Units( 150 ), Set Candidate Runs( [90 0 150, 100 0 150, 110 0 150] )}
);


```

### [Set Delta For Power](#set-delta-for-power)

**Syntax:** obj \<< Set Delta For Power

**Description:** Specifies the values of the anticipated coefficients in Power Analysis. Anticipated coefficients will be one half of the specified value.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Set Delta For Power( 3 ),
    Make Design
);


```

### [Set Expected Number of Respondents](#set-expected-number-of-respondents)

**Syntax:** obj \<< Set Expected Number of Respondents

**Description:** Sets the expected number of respondents per survey.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 )}
);


```

### [Set Generators](#set-generators)

**Syntax:** obj \<< Set Generators

**Description:** Specifies the generators to be used in a screening design.

```

DOE(
    Screening Design,
    {Add Factor, Add Factor, Add Factor, Make Design( 1 ), Set Generators( [1, 1, 0] )}
);


```

### [Set Inspection Times](#set-inspection-times)

**Syntax:** obj \<< Set Inspection Times

**Description:** Sets the inspection times for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Monitoring at Intervals", {5, 200, 200} ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Inspection Times( [200 400 600 800 1000] ),
    Set Number of Units( 150 ), Set Candidate Runs( [90 0 150, 100 0 150, 110 0 150] )}
);


```

### [Set Length of Test](#set-length-of-test)

**Syntax:** obj \<< Set Length of Test

**Description:** Sets the length of test for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set Level Values](#set-level-values)

**Syntax:** obj \<< Set Level Values

**Description:** Sets the level values for the accelerating factor(s) in an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Monitoring at Intervals", {5, 200, 200} ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Inspection Times( [200 400 600 800 1000] ),
    Set Number of Units( 150 ), Set Candidate Runs( [90 0 150, 100 0 150, 110 0 150] )}
);


```

### [Set Monitoring Choice](#set-monitoring-choice)

**Syntax:** obj \<< Set Monitoring Choice

**Description:** Specifies the type of monitoring for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set N Subplots](#set-n-subplots)

**Syntax:** obj \<< Set N Subplots

**Description:** Specifies the number of subplots when there are both hard-to-change and very hard-to-change factors.

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 2 ),
    Add Factor( Continuous, -1, 1, "X2", 1 ),
    Add Factor( Continuous, -1, 1, "X3", 0 )
);
d << Set N Whole Plots( 4 );
d << Set N Subplots( 8 );


```

### [Set N Whole Plots](#set-n-whole-plots)

**Syntax:** obj \<< Set N Whole Plots

**Description:** Specifies the number of whole plots when there are hard-to-change or very hard-to-change factors.

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 1 ),
    Add Factor( Continuous, -1, 1, "X2", 0 )
);
d << Set N Whole Plots( 6 );


```

### [Set Number of Attributes](#set-number-of-attributes)

**Syntax:** obj \<< Set Number of Attributes

**Description:** Sets the number of attributes that can change within a choice set.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 )}
);


```

### [Set Number of Choice Sets](#set-number-of-choice-sets)

**Syntax:** obj \<< Set Number of Choice Sets

**Description:** Sets the number of choice sets per survey.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 )}
);


```

### [Set Number of FDS points](#set-number-of-fds-points)

**Syntax:** obj \<< Set Number of FDS points

**Description:** Sets the number of points used to generate the Fraction of Design Space Plot.

**JMP Version Added:** 14

```

DOE(
    Custom Design,
    {Add Factor( Continuous, -1, 1, "X1", 0 ), Add Factor( Continuous, -1, 1, "X2", 0 ),
    Set Sample Size( 7 ), Design Search Time( 8 ), Set Number of FDS points( 20000 ),
    Make Design}
);


```

### [Set Number of Profiles](#set-number-of-profiles)

**Syntax:** obj \<< Set Number of Profiles

**Description:** Sets the number of profiles per choice set.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 )}
);


```

### [Set Number of Surveys](#set-number-of-surveys)

**Syntax:** obj \<< Set Number of Surveys

**Description:** Sets the number of surveys for a choice design.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 )}
);


```

### [Set Number of Units](#set-number-of-units)

**Syntax:** obj \<< Set Number of Units

**Description:** Sets the number of units under test for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set Prior Correlation ALT](#set-prior-correlation-alt)

**Syntax:** obj \<< Set Prior Correlation ALT

**Description:** Sets the prior correlations for an accelerated life test plan.

**JMP Version Added:** 16

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set Prior Mean ALT](#set-prior-mean-alt)

**Syntax:** obj \<< Set Prior Mean ALT

**Description:** Sets the prior mean for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set Prior Mean Choice](#set-prior-mean-choice)

**Syntax:** obj \<< Set Prior Mean Choice

**Description:** Sets the Prior Mean for a choice design.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 )}
);


```

### [Set Prior Quantile ALT](#set-prior-quantile-alt)

**Syntax:** obj \<< Set Prior Quantile ALT

**Description:** Sets the information for specifying the prior intercept based on a quantile.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Prior Specification Choice( 2 ), Set Prior Quantile ALT( {[1.5 2], 0.065, 2642, 45} ),
    Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set Prior Std Error ALT](#set-prior-std-error-alt)

**Syntax:** obj \<< Set Prior Std Error ALT

**Description:** Sets the prior standard error for an accelerated life test plan.

**JMP Version Added:** 16

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Number of Units( 150 )}
);


```

### [Set Prior Variance ALT](#set-prior-variance-alt)

**Syntax:** obj \<< Set Prior Variance ALT

**Description:** Sets the prior variance for an accelerated life test plan.

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( "Continuous Monitoring" ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Variance ALT( [0.1 0 0, 0 0.1 0, 0 0 0.1] ),
    Use Prior Uncertainty( 1 ), Set ALT Time Range( 10000, 20000 ),
    Set ALT Probability of Interest( 0.1 ), Set Length of Test( 1000 ),
    Set Number of Units( 150 )}
);


```

### [Set Prior Variance Matrix](#set-prior-variance-matrix)

**Syntax:** obj \<< Set Prior Variance Matrix

**Description:** Sets the Prior Variance Matrix for a choice design.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 )}
);


```

### [Set RMSE](#set-rmse)

**Syntax:** obj \<< Set RMSE

**Description:** Specifies the anticipated root mean square error (RMSE) in Power Analysis.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Set RMSE( 1.5 );


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed

**Description:** Useful for teaching. Setting the random seed to a specific value assures that all class members get the same design.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Set Random Seed( 34067086 ),
    Make Design
);


```

### [Set Run Order](#set-run-order)

**Syntax:** obj \<< Set Run Order

**Description:** Specifies how the run order should be set when making a data table from a design.

```

d = DOE( Custom Design, Add factor, Add factor, Add factor );
d << Make Design;
d << Set Run Order( Sort Left to Right );
d << Make Table;


```

### [Set Runs Per Random Block](#set-runs-per-random-block)

**Syntax:** obj \<< Set Runs Per Random Block

**Description:** Specifies the size of random blocks in the design.

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Make Model( Linear )
);
d << Set Runs Per Random Block( 4 );


```

### [Set Sample Size](#set-sample-size)

**Syntax:** obj \<< Set Sample Size

**Description:** Specifies the sample size before the design is created. If the specified number is less than the minimum value shown in the designer, the sample size is set to the minimum value.

```

d = DOE( Custom Design, Add factor, Add factor, Add factor );
d << Make Model( Linear );
d << Set Sample Size( 12 );


```

### [Set Significance Level](#set-significance-level)

**Syntax:** obj \<< Set Significance Level

**Description:** Change the significance level in Power Analysis.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
d = DOE( Evaluate Design, X( :Silica, :Sulfur, :Silane ), Y( :Stretch ) );
d << Set Significance Level( 0.10 );


```

### [Set Strength](#set-strength)

**Syntax:** obj \<< Set Strength

**Description:** Sets the strength for Covering Arrays

```

d = DOE(
    Covering Array,
    Add factor( Categorical ),
    Add factor( Categorical ),
    Add factor( Categorical )
);
d << Set Strength( 3 );
d << Make Table;


```

### [Show Blocking Options](#show-blocking-options)

**Syntax:** obj \<< Show Blocking Options

**Description:** Specifies the blocking choice and number of blocks for a definitive screening design. Specifying a value of 0 indicates no blocks.

**Example 1**

```

DOE(
    Definitive Screening Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Show Blocking Options( 0, 0 ),
    Number of Extra Runs( 4 )
);


```

**Example 2**

```

DOE(
    Definitive Screening Design,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Add Factor,
    Show Blocking Options( 1, 2 ),
    Number of Extra Runs( 4 )
);


```

### [Simulate Responses](#simulate-responses)

**Syntax:** obj \<< Simulate Responses( state=0|1 )

**Description:** Add data for the responses to the JMP design table. For use in teaching DOE.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Make Design,
    Simulate Responses,
    Make Table
);


```

### [Solve for Power](#solve-for-power)

**Syntax:** obj \<< Solve for Power

**Description:** Sets the anticipated coefficients in Power Analysis so that the power is near the specified value.

**JMP Version Added:** 16

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Make Design,
    Solve for Power( 0.8 )
);


```

### [Space Filling Design Type](#space-filling-design-type)

**Syntax:** obj \<< Space Filling Design Type( Sphere Packing|Latin Hypercube|Uniform|Minimum Potential|Maximum Entropy|IMSE Optimal|Fast Flexible Filling )

**Description:** Specifies the type of space filling design and the number of runs.

**Example 1**

```

d = DOE( Space Filling Design );
d << Space Filling Design Type( Sphere Packing, 30 );


```

**Example 2**

```

d = DOE( Space Filling Design );
d << Space Filling Design Type( Latin Hypercube, 100 );


```

**Example 3**

```

d = DOE( Space Filling Design );
d << Space Filling Design Type( Uniform, 20 );


```

**Example 4**

```

d = DOE( Space Filling Design );
d << Space Filling Design Type( Fast Flexible Filling, 100 );


```

**Example 5**

```

d = DOE( Space Filling Design, Space Filling Design Type( IMSE Optimal, 20 ) );
d << Theta( [2, 3] );
d << Make Design;


```

### [Sphere Radius](#sphere-radius)

**Syntax:** obj \<< Sphere Radius

**Description:** Specifies a spherical design region and enables you to set the radius of the region.

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Sphere Radius( 1 ),
    Make Design
);


```

### [Split Plot Variance Ratio](#split-plot-variance-ratio)

**Syntax:** obj \<< Split Plot Variance Ratio( Whole Plot Ratio | [Whole Plot Ratio, Subplot Ratio] )

**Description:** For hard-to-change factors, specify the ratio of the whole-plot error variance to the run-to-run error. For hard-to-change and very hard-to-change factors, specify the ratio of the whole plot and subplot error to the run-to-run error.

**Example 1**

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 1 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Set N Whole Plots( 4 ),
    Split Plot Variance Ratio( 2 ),
    Make Design
);


```

**Example 2**

```

d = DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 2 ),
    Add Factor( Continuous, -1, 1, "X2", 1 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Set N Whole Plots( 4 )
);
d << Split Plot Variance Ratio( [3, 2] );
d << Make Design;


```

### [Suppress Cotter Designs](#suppress-cotter-designs)

**Syntax:** obj \<< Suppress Cotter Designs( state=0|1 )

**Description:** Shows or hides Cotter designs in the list of screening designs. This option is selected by default, which means that Cotters designs are initially not in the screening design list. On by default.

```

DOE(
    Screening Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Factor( Continuous, -1, 1, "X3", 0 ),
    Suppress Cotter Designs,
    Make Design( 5 )
);


```

### [Table of Correlations](#table-of-correlations)

**Syntax:** obj \<< Table of Correlations

**Description:** Create a data table with the Table of Correlations from Design Diagnostics.

**JMP Version Added:** 15

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Make Design,
    Table of Correlations
);


```

### [Theta](#theta)

**Syntax:** obj \<< Theta

**Description:** Specifies the Covariance Parameter Vector for Space Filling designs.

```

d = DOE( Space Filling Design, Space Filling Design Type( IMSE Optimal, 20 ) );
d << Theta( [2, 3] );


```

### [Treatments](#treatments)

**Syntax:** obj \<< Treatments

**Description:** Specifies the number of treatments for a balanced incomplete block design (BIBD).

**JMP Version Added:** 14

```

d = DOE( Balanced Incomplete Block Design );
d << Treatments( 3, {"L1", "L2", "L3"} );
d << Make Design;


```

### [Use Bayesian information](#use-bayesian-information)

**Syntax:** obj \<< Use Bayesian information( state=0|1 )

**Description:** Uses prior information in the Bayesian setting for the design diagnostics.

**JMP Version Added:** 15

```

DOE(
    Custom Design,
    Add Factor( Continuous, -1, 1, "X1", 0 ),
    Add Factor( Continuous, -1, 1, "X2", 0 ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Potential Term( {1, 1}, {2, 1} ),
    Number of Starts( 10 ),
    Make Design,
    Use Bayesian Information( 1 )
);


```

### [Use Blue to Red color theme for color map](#use-blue-to-red-color-theme-for-color-map)

**Syntax:** obj \<< Use Blue to Red color theme for color map( state=0|1 )

**Description:** Uses blue to red color theme for color map on correlations.

**JMP Version Added:** 15

### [Use Prior Uncertainty](#use-prior-uncertainty)

**Syntax:** obj \<< Use Prior Uncertainty( state=0|1 )

**Description:** Specifies if the prior uncertainty should be used to construct the optimal design.

**JMP Version Added:** 16

```

DOE(
    Accelerated Life Test Plan,
    {ALT Plan Setup( 1 ), Set Monitoring Choice( 2, {5, 200, 200} ),
    ALT Optimality Criterion( "Make Quantile Estimate Optimal" ),
    ALT Factor Settings( 1, {"X1", 3, 1, 20, 30, 90, 110} ),
    Set Level Values( 1, [90 100 110] ), Distribution Choice( LogNormal ),
    Set Prior Mean ALT( [-40 1.5 2] ), Set Prior Std Error ALT( [10, 0.2, 0.5] ),
    Set Prior Correlation ALT( [1 -0.99 0, -0.99 1 0, 0 0 1] ), Use Prior Uncertainty( 1 ),
    Set ALT Time Range( 10000, 20000 ), Set ALT Probability of Interest( 0.1 ),
    Set Length of Test( 1000 ), Set Inspection Times( [200 400 600 800 1000] ),
    Set Number of Units( 150 ), Set Candidate Runs( [90 0 150, 100 0 150, 110 0 150] )}
);


```

### [Utility Neutral Design](#utility-neutral-design)

**Syntax:** obj \<< Utility Neutral Design( state=0|1 )

**Description:** Specifies if Utility Neutral Choice Design should be created.

```

DOE(
    Choice Design,
    {Add Factor( Categorical, {"L1", "L2"}, "X1", 0 ),
    Add Factor( Categorical, {"L1", "L2"}, "X2", 0 ), Set Random Seed( 1245253625 ),
    Add Term( {1, 1} ), Add Term( {2, 1} ), Set Prior Mean Choice( [0 0] ),
    Set Prior Variance Matrix( [1 0, 0 1] ), Set Number of Attributes( 2 ),
    Set Number of Profiles( 2 ), Set Number of Choice Sets( 8 ), Set Number of Surveys( 1 ),
    Set Expected Number of Respondents( 1 ), Utility Neutral Design( 1 )}
);


```

# [Data Connector Metadata](#data-connector-metadata)

## [Item Messages](#item-messages)

### [Get Description](#get-description)

**Syntax:** metadata \<< Get Description()

**Description:** Gets the data connector description

**JMP Version Added:** 18

```


description = metadata << Get Description();


```

### [Get Driver](#get-driver)

**Syntax:** metadata \<< Get Driver()

**Description:** Gets data connector driver, if there is one.

**JMP Version Added:** 18

```


type = metadata << Get Driver();


```

### [Get Name](#get-name)

**Syntax:** metadata \<< Get Name()

**Description:** Gets the data connector name

**JMP Version Added:** 18

```


name = metadata << Get Name();


```

### [Get Path](#get-path)

**Syntax:** metadaata \<< Get Path()

**Description:** Gets data connector path

**JMP Version Added:** 18

```


path = metadata << Get Path();


```

### [Get Type](#get-type)

**Syntax:** metadata \<< Get Type()

**Description:** Gets the data connector type

**JMP Version Added:** 18

```


type = metadata << Get Type();


```

### [Set Description](#set-description)

**Syntax:** metadata \<< Set Description(description)

**Description:** Sets the data connector description

**JMP Version Added:** 18

```


metadata << Set Description( "My frequently used SQL Server connection." );


```

### [Set Name](#set-name)

**Syntax:** metadata \<< Set Name( name )

**Description:** Sets the data connector name

**JMP Version Added:** 18

```


metadata << Set Name( "A new Name" );


```

# [Data Connector Registry](#data-connector-registry)

## [Item Messages](#item-messages)

### [Get](#get)

**Syntax:** Data Connector Registry() \<< Get ( name )

**Description:** Retrieves a data connector from the registry

**JMP Version Added:** 18

```


dc = Data Connector Registry() << Get( "com.jmp.sql_server" );


```

### [Get Available](#get-available)

**Syntax:** Data Connector Registry() \<< Get Available()

**Description:** Retrieves a list of available data connectors in the registry

**JMP Version Added:** 18

```


list = Data Connector Registry() << Get Available();


```

### [Get Metadata](#get-metadata)

**Syntax:** Data Connector Registry() \<< Get Metadata ( name )

**Description:** Gets data connector metadata from the registry

**JMP Version Added:** 18

```


metadata = Data Connector Registry() << Get Metadata( "com.jmp.sql_server" );


```

### [Register](#register)

**Syntax:** Data Connector Registry() \<< Register( Path(path), \<Name(name)>, \<Description(Description)> )

**Description:** Adds a data connector to the registry

**JMP Version Added:** 18

```


Data Connector Registry() << Register(
    Path( "$DOCUMENTS/my connector.jmpdc" ),
    Name( "My Data Connector" )
);


```

### [Unregister](#unregister)

**Syntax:** Data Connector Registry() \<< Unregister ( name )

**Description:** Removes a data connector from the registry

**JMP Version Added:** 18

```


dc = Data Connector Registry() << Unregister( "My Data Connector" );


```

# [Data Connector](#data-connector)

## [Item Messages](#item-messages)

### [Dump](#dump)

**Syntax:** res = obj \<< Dump()

**Description:** Get the contents of this data connector as a specification string that specifies the type and any non-default values.

```


New Data Connector(
    Type( "ODBC" ),
    Block Fetch( "ON" ),  // Default value; won't be included
    Supports Schemas( "ON" ),  // Non-default value; will be included
) << Dump();


```

### [Get](#get)

**Syntax:** res = obj \<< Get( OPTION )

**Description:** Get the value of an option.

```


dc = New Data Connector( Type( "ODBC" ) );
// Get dc's value for the Supports Schemas option, namely the default value
dc << Get( Supports Schemas );


```

### [Open](#open)

**Syntax:** res = obj \<< Open()

**Description:** Open a new data table as specified by this data connector.

```


New Data Connector(
    ID( "com.example.odbc_example" ),  // Some ODBC-type base configuration
    Table( "my_table" )  // The table to open
) << Open();


```

### [Open Backing Data](#open-backing-data)

**Syntax:** obj \<< Open Backing Data( < Schema( "schema" ) >, Table( "table" ), < Args( ... ) > )

**Description:** Connect and open the file or other data that backs the named table.

```


New Data Connector(
    // Available with https://marketplace.jmp.com/appdetails/Python+Data+Connector+Demo
    ID( "jmp_py_data_connector_demo.folder" ),
    Folder( Get Path Variable( "SAMPLE_IMPORT_DATA" ) ),
    Limit To Extension( ".xlsx" )
) << Open Backing Data(
    Table( "Bigclass" ),
    Args(
        Worksheets( "Bigclass" ),
        Use for all sheets( 1 ),
        Concatenate Worksheets( 0 ),
        Create Concatenation Column( 0 ),
        Worksheet Settings(
            1,
            Has Column Headers( 1 ),
            Number of Rows in Headers( 1 ),
            Headers Start on Row( 1 ),
            Data Starts on Row( 2 ),
            Data Starts on Column( 1 ),
            Data Ends on Row( 0 ),
            Data Ends on Column( 0 ),
            Replicated Spanned Rows( 1 ),
            Replicated Spanned Headers( 0 ),
            Suppress Hidden Rows( 1 ),
            Suppress Hidden Columns( 1 ),
            Suppress Empty Columns( 0 ),
            Treat as Hierarchy( 0 ),
            Multiple Series Stack( 0 ),
            Import Cell Colors( 0 ),
            Limit Column Detect( 0 ),
            Column Separator String( "-" )
        )
    )
);


```

### [Save](#save)

**Syntax:** obj \<< Save( file path )

**Description:** Save the contents of this data connector to a file. The file contents are the same as the result of \<< Dump().

```


New Data Connector(
    Type( "ODBC" ),
    Block Fetch( "ON" ),  // Default value; won't be included
    Supports Schemas( "ON" ),  // Non-default value; will be included
) << Save( "$DOCUMENTS/data connector save example.jmpdc" );


```

### [Set](#set)

**Syntax:** obj \<< Set( < Option1( value1 ) >, ..., < OptionN( valueN ) > )

**Description:** Set the value of any number of options.

```


dc = New Data Connector( Type( "ODBC" ) );
Show( dc << Get( Block Fetch ), dc << Get( Supports Schemas ) );
dc << Set( Block Fetch( "ON" ), Supports Schemas( "ON" ) );
Show( dc << Get( Block Fetch ), dc << Get( Supports Schemas ) );


```

### [Type](#type)

**Syntax:** res = obj \<< Type()

**Description:** Get the type of the data connector.

```

New Data Connector( Type( "ODBC" ) ) << Type();


```

# [Data Filter](#data-filter)

## [Associated Constructors](#associated-constructors)

### [Data Filter](#data-filter_1)

**Syntax:** Data Filter( <local>, <invisible>, <Add Filter>, <Mode>, \<Show Window(0 | 1)>, \<no outline box(0 | 1)> )

**Description:** Creates or shows a Data Filter, where you interactively select complex subsets of data. The Mode option determines which row states are affected by selection in the filter. The Add Filter command will add a filter group with the given Columns and Where clauses. When multiple filter groups are present, the combined behavior is determined by the Group By AND option. If the Local keyword is given, the filter can be embedded in a report to filter one or more platforms without affecting other reports.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);


```

## [Columns](#columns)

### [Add Filter Columns](#add-filter-columns)

**Syntax:** obj \<< Add Filter Columns( Add Filter Columns( column ) )

**Description:** Add one or more filter columns.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Add Filter Columns( :State );


```

### [Filter Column](#filter-column)

**Syntax:** obj \<< Filter Column( column(s) )

**Description:** Add a filter column.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
obj << Filter Column( :State );


```

### [Filter Columns](#filter-columns)

**Syntax:** obj \<< Filter Columns( column(s) )

**Description:** Add one or more filter columns.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Filter Columns( :State, :OZONE );


```

### [Filter Group](#filter-group)

**Syntax:** obj \<< Filter Group( column(s) )

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);


```

## [Item Messages](#item-messages)

### [Add Favorites](#add-favorites)

**Syntax:** obj \<< Add Favorites( name or string )

**Description:** Associate the current filter selection with the given name and save into the favorites list

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
df = dt << Data Filter(
    Add Filter(
        columns( :age, :sex, :height, :weight ),
        Where( :sex == "F" ),
        Where( :height >= 55 & :height <= 65 )
    ),
    Mode( Select )
);
Wait( 1 );
fav1 = df << add favorites( "FemaleAverageHt" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
df = dt << Data Filter(
    Add Filter( columns( :age, :sex, :height, :weight ), Where( :sex == "F" ) ),
    Mode( Select )
);
Wait( 1 );
fav1 = df << add favorites();
Show( fav1 );


```

### [Add Filter](#add-filter)

**Syntax:** obj \<< Add Filter( columns( column, ... ), \<Where( clause )> )

**Description:** Add one or more filter columns in a new OR group.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter();
obj << Add Filter( columns( :POP ) );
obj << Add Filter(
    columns( :Region, :State, :City ),
    Where( :Region == "S" ),
    Where( :State == {"SC", "NC"} )
);


```

### [Animation](#animation)

**Syntax:** obj \<< Animation( \<Animate Column( column )>, \<Animate Rate( number )>, \<Forward|Backward|Bounce> )

**Description:** Cycles through the sorted values of specified column selecting and deselecting rows.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Columns( :Region );
obj << Animation( Animate Column( :Region ), Bounce );
//Now press the play button.


```

### [Apply Favorites](#apply-favorites)

**Syntax:** obj \<< Apply Favorites( name or string )

**Description:** Apply the filter selection as saved in the named favorites to the data filter.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
df = dt << Data Filter(
    Add Filter(
        columns( :age, :sex, :height, :weight ),
        Where( :sex == "F" ),
        Where( :height >= 55 & :height <= 65 )
    ),
    Mode( Select )
);
a = "FemaleAverageHt";
b = "Female";
df << add favorites( a );
df << Match( Where( :sex == "F" ) );
df << add favorites( b );
Wait( 1 );
df << apply favorites( "FemaleAverageHt" );


```

### [Auto clear](#auto-clear)

**Syntax:** obj \<< Auto clear( state=0|1 )

**Description:** Clears all currently selected rows prior to setting a new selection when filtering.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Data Filter;
obj << Auto Clear( 1 );
obj << Add Filter( columns( :age, :sex ), Where( :age == {13, 14} ) );
Wait( 1 );
obj << (filter column( :sex ) << Where( :sex == "M" ));


```

### [Clear](#clear)

**Syntax:** obj \<< Clear

**Description:** Clears the currently selected rows.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Region ), Where( :Region == "N" ) );
Wait( 1 );
obj << Clear;


```

### [Clear Selection](#clear-selection)

**Syntax:** obj \<< Clear Selection

**Description:** Clear the selection for this column filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter( Add( Filter Columns( :Region ), Where( :Region = {"N", "S"} ) ) );
Wait( 1 );
obj << (Filter Column( :Region ) << Clear Selection);


```

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Closes the data filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
obj << Close;


```

### [Conditional](#conditional)

**Syntax:** obj \<< Conditional( state=0|1 )

**Description:** The option flags whether the categorical columns filters are conditionally ordered. Selecting a category will limit the categories of the next column filter only to those that are in the selected category.

```

dt = Open( "$SAMPLE_DATA/SATByYear.jmp" );
obj = dt << Data Filter( Add Filter( columns( :Region, :State ) ) );
obj << (Filter Column( :Region ) << Where( :Region == {"South"} ));
Wait( 1 );
obj << conditional( 1 );


```

### [Copy Local Data Filter](#copy-local-data-filter)

**Syntax:** obj \<< Copy Local Data Filter

**Description:** Copy the script for the local data filter to the clipboard.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce the filter window and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Copy Script;


```

### [Count Excluded Rows](#count-excluded-rows)

**Syntax:** obj \<< Count Excluded Rows( state=0|1 )

**Description:** If the option is cleared, the column values and counts in the data filter will not include rows with excluded row states in the data table.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Data Filter(
    Mode( Select( 0 ), Show( 1 ), Include( 1 ) ),
    Add Filter( columns( :sex ), Where( :sex == "F" ) )
);
Distribution(
    Automatic Recalc( 1 ),
    Continuous Distribution( Column( :weight ) ),
    Local Data Filter(
        Count Excluded Rows( 0 ),
        Add Filter( columns( :age ), Where( :age == 12 ) )
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Data Filter(
    Mode( Select( 0 ), Show( 1 ), Include( 1 ) ),
    Add Filter( columns( :sex ), Where( :sex == "F" ) )
);
New Window( "Hierarchical Data Filter",
    V List Box(
        Data Filter Context Box(
            H List Box(
                Filter Ref Sub 1 = dt << Data Filter(
                    Local,
                    Add Filter( columns( :age ), Where( :age == 12 ) )
                ),
                Platform( Current Data Table(), Distribution( Column( :weight ) ) )
            )
        ),
        Data Filter Context Box(
            H List Box(
                Filter Ref Sub 2 = dt << Data Filter(
                    Local,
                    Count Excluded Rows( 0 ),
                    Add Filter( columns( :age ), Where( :age == 12 ) )
                ),
                Platform( Current Data Table(), Distribution( Column( :weight ) ) )
            )
        )
    )
);


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Show the data table used for this filter dialog.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Data Table Window;


```

### [Delete](#delete)

**Syntax:** obj \<< Delete( {column(s)} )

**Description:** Deletes the specified columns with existing filters in the data filter.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Columns( :Region, :SO2, :CO, :State );
Wait( 1 );
obj << Delete( {:State} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Columns( :Region, :SO2, :CO, :State );
Wait( 1 );
obj << (Filter Column( :State ) << delete);


```

### [Delete All](#delete-all)

**Syntax:** obj \<< Delete All

**Description:** Deletes all existing filters in the data filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Columns( :Region, :SO2, :CO, :State );
Wait( 2 );
obj << Delete All;


```

### [Display](#display)

**Syntax:** obj \<< Display( column, \<Invisible(0 | 1)>, <options> )

**Description:** Changes the way the column levels are displayed in the filter. Categorical columns support a display type option of "Blocks Display", "List Display", "Single Category Display", "Check Box Display", or "Radio Box Display". Option NItems(n) will set the number of visible items in a scrollable view. Continuous columns support options of NBins(n) and Height(h).

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
obj << Display( :Region, N Items( 4 ) );


```

### [Extend Where](#extend-where)

**Syntax:** obj \<< Extend Where

**Description:** Extend the selection based on the given criterion for this column filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter( Add( Filter Columns( :Region ), Where( :Region = {"N", "S"} ) ) );
Wait( 1 );
obj << (Filter Column( :Region ) << Extend Where( :Region = "W" ));


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns the data table associated with the filter.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionfilter = obj << Get Data Table();


```

### [Get Filter Column](#get-filter-column)

**Syntax:** obj \<< Get Filter Column( column, <index> )

**Description:** Returns the filter column object for the named column. If the same column is used multiple times, the index argument will return the specified occurrence

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionfilter = obj << Get Filter Column( :Region );
regionfilter << Invert Selection;


```

### [Get Filtered Rows](#get-filtered-rows)

**Syntax:** obj \<< Get Filtered Rows

**Description:** Returns a matrix of row numbers that satisfy the current filter conditions.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Get Filtered Rows;


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Get the data filter script as text.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
txt = obj << Get Script;
Show( txt );


```

### [Get where clause](#get-where-clause)

**Syntax:** obj \<< Get where clause

**Description:** Get the descriptive text for the filter selection.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter( Add( Filter Columns( :Region, :Lead ) ) );
Wait( 1 );
obj << (Filter Column( :Lead ) << Where( :Lead >= .4 & :Lead <= 1.4 ));
txt = obj << get where clause;


```

### [Grouped by AND](#grouped-by-and)

**Syntax:** obj \<< Grouped by AND( state=0|1 )

**Description:** Groups of filter items are joined by AND

### [Inverse](#inverse)

**Syntax:** obj \<< Inverse( state=0|1 )

**Description:** Inverts the current selection state of the rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
obj << Inverse( 1 );


```

### [Invert Selection](#invert-selection)

**Syntax:** obj \<< Invert Selection

**Description:** Invert the selection for this column filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter( Add( Filter Columns( :Region ), Where( :Region = {"N", "S"} ) ) );
Wait( 1 );
obj << (Filter Column( :Region ) << invert selection);


```

### [Make Filter Change Handler](#make-filter-change-handler)

**Syntax:** rs = df \<< Make Filter Change Handler(function(a) );

**Description:** Creates a data filter handler to handle notification that the filter has changed. The number of rows filtered is returned in the argument to the function.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Automatic Recalc( 1 ), Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter( Add Filter( columns( :Region ) ) );
f = Function( {a}, Print( a ) );
rs = filter << Make Filter Change Handler( f );


```

### [Match](#match)

**Syntax:** obj \<< Match( Filter Columns(:a, :b, :c, ...), where( conditions ) )

**Description:** Sets the filter conditions for each group.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :BP 8W, :BP 6M ) ),
    Add Filter( columns( :BP 12M ) )
);
Wait( 1 );
obj << Match( Filter Columns( :BP 8W, :BP 6M ), Where( :BP 8W > 174.8 & :BP 8W < 184.2 ) );
obj << Match( Filter Columns( :BP 12M ), Where( :BP 12M > 181.9 & :BP 12M < 192.1 ) );


```

### [Mode](#mode)

**Syntax:** obj \<< Mode( Select|Show|Include (state = 0|1) )

**Description:** Sets the action or mode used when selecting rows through the data filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Mode( Include( 1 ), Select( 0 ), Show( 0 ) );
obj << Add Filter( Columns( :Region ), Where( :Region == "N" ) );


```

### [On Clear](#on-clear)

**Syntax:** obj \<< On Clear

**Description:** Set a script or function to be executed after the filter is cleared.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Data Filter;
df = obj << Add Filter( columns( :age, :sex ), Where( :age == {13, 14} ) );
obj << OnClear( Function( {}, df << Mode( Include( 0 ), Select( 1 ), Show( 0 ) ) ) );
Wait( 1 );
df << Mode( Include( 1 ), Select( 0 ), Show( 0 ) );


```

### [Remove Favorites](#remove-favorites)

**Syntax:** obj \<< Remove Favorites( name or string )

**Description:** Remove the named favorites from the favorites list

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
df = dt << Data Filter(
    Add Filter(
        columns( :age, :sex, :height, :weight ),
        Where( :sex == "F" ),
        Where( :height >= 55 & :height <= 65 )
    ),
    Mode( Select )
);
df << add favorites( "FemaleAverageHt" );
df << Match( Where( :sex == "F" ) );
df << add favorites( "Female" );
Wait( 1 );
df << remove favorites( "FemaleAverageHt" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
df = dt << Data Filter(
    Add Filter(
        columns( :age, :sex, :height, :weight ),
        Where( :sex == "F" ),
        Where( :height >= 55 & :height <= 65 )
    ),
    Mode( Select )
);
df << add favorites( "FemaleAverageHt" );
df << Match( Where( :sex == "F" ) );
df << add favorites( "Female" );
Wait( 1 );
df << remove favorites();


```

### [Report](#report)

**Syntax:** obj \<< Report

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Add Filter( columns( :POP ) );
obj << Add Filter(
    columns( :Region, :State, :City ),
    Where( :Region == "S" ),
    Where( :State == {"SC", "NC"} )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** obj \<< Save Script to Data Table

**Description:** Create a JSL script to produce the filter window and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Save Script to Data Table;


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce the filter window and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Save Script to Journal;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce the filter window and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Save Script to Script Window;


```

### [Save Where Clause to Clipboard](#save-where-clause-to-clipboard)

**Syntax:** obj \<< Save Where Clause to Clipboard

**Description:** Create the WHERE clause from the filter criteria and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Lead ), Where( :Lead >= .4 & :Lead <= 2.0 ) );
obj << Save Where Clause To Clipboard;


```

### [Save Where Clause to Data Table](#save-where-clause-to-data-table)

**Syntax:** obj \<< Save Where Clause to Data Table

**Description:** Create a WHERE clause from the filter criteria and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Lead ), Where( :Lead >= .4 & :Lead <= 2.0 ) );
obj << Save Where Clause To Data Table;


```

### [Save Where Clause to Formula Column](#save-where-clause-to-formula-column)

**Syntax:** obj \<< Save Where Clause to Formula Column

**Description:** Create an indicator column that has a formula equivalent to the filter criteria. Rows satisfying the filer criteria will have a value of 1, and all other rows will have a value of 0.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Lead ), Where( :Lead >= .4 & :Lead <= 2.0 ) );
obj << Save Where Clause To Formula Column;


```

### [Save Where Clause to Journal](#save-where-clause-to-journal)

**Syntax:** obj \<< Save Where Clause to Journal

**Description:** Create the WHERE clause from the filter criteria and append it to the journal.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Lead ), Where( :Lead >= .4 & :Lead <= 2.0 ) );
obj << Save Where Clause To Journal;


```

### [Save Where Clause to Row State Column](#save-where-clause-to-row-state-column)

**Syntax:** obj \<< Save Where Clause to Row State Column

**Description:** Create a row state column that has a formula equivalent to the filter criteria.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Lead ), Where( :Lead >= .4 & :Lead <= 2.0 ) );
obj << Save Where Clause To Row State Column;


```

### [Save Where Clause to Script Window](#save-where-clause-to-script-window)

**Syntax:** obj \<< Save Where Clause to Script Window

**Description:** Create a WHERE clause from the filter criteria and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Lead ), Where( :Lead >= .4 & :Lead <= 2.0 ) );
obj << Save Where Clause To Script Window;


```

### [Save and restore current row states](#save-and-restore-current-row-states)

**Syntax:** obj \<< Save and restore current row states( state=0|1 )

**Description:** Save the current row states for the data table, then restores those states upon closing the data filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Save and Restore Current Row States( 1 ),
    Add Filter( Columns( :Region ), Where( :Region == "N" ) )
);
Wait( 1 );
obj << Close;


```

### [Select Missing](#select-missing)

**Syntax:** obj \<< Select Missing( state=0|1 )

**Description:** Add the missing rows to the selection for this continuous column filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter( Add( Filter Columns( :CO ), Where( :CO >= 9 & :CO < 15 ) ) );
Wait( 1 );
obj << (Filter Column( :CO ) << Select Missing);


```

### [Set Include](#set-include)

**Syntax:** obj \<< Set Include( state=0|1 )

**Description:** Check the uncheck the include mode.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Data Filter( Add Filter( columns( :age, :sex ) ) );
obj << set Include( 1 );
Wait( 1 );
obj << set Include( 0 );


```

### [Set Select](#set-select)

**Syntax:** obj \<< Set Select( state=0|1 )

**Description:** Check or uncheck the select mode.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Data Filter( Add Filter( columns( :age, :sex ) ) );
obj << set select( 1 );
Wait( 1 );
obj << set select( 0 );


```

### [Set Show](#set-show)

**Syntax:** obj \<< Set Show( state=0|1 )

**Description:** Check the uncheck the show mode.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Data Filter( Add Filter( columns( :age, :sex ) ) );
obj << set Show( 1 );
Wait( 1 );
obj << set Show( 0 );


```

### [Show Controls](#show-controls)

**Syntax:** obj \<< Show Controls( state=0|1 )

**Description:** Show or hide the controls for modifying the data filter options.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
obj << Show Controls( 0 );


```

### [Show Counts](#show-counts)

**Syntax:** obj \<< Show Counts( state=0|1 )

**JMP Version Added:** 16

### [Show Histograms and Bars](#show-histograms-and-bars)

**Syntax:** obj \<< Show Histograms and Bars( state=0|1 )

**Description:** Show Histograms and Bars for filter columns where available

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) )
);
Wait( 1 );
obj << Show Histograms and Bars( 0 );


```

### [Show Modes](#show-modes)

**Syntax:** obj \<< Show Modes( state=0|1 )

**Description:** Show or hide the controls for changing the mode of the data filter, which controls the select/show/include behavior of the data filter.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
obj << Show Modes( 0 );


```

### [Show Subset](#show-subset)

**Syntax:** obj \<< Show Subset

**Description:** Show the filtered data in a separate data table window.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Add Filter( Columns( :Region ), Where( :Region == "N" ) );
obj << Show Subset;


```

### [Stretch Width](#stretch-width)

**Syntax:** obj \<< Stretch Width( "Manual" | "Window" )

**Description:** Sets the horizontal stretching behavior of the filter. By default, the filter width can be changed manually. If set to "Window", the width gets larger or smaller with the window size.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Shared Local Filter",
    Data Filter Context Box(
        H Splitter Box(
            Size( 1200, 500 ),
            V Scroll Box(
                dt << Data Filter(
                    Local,
                    Stretch Width( "Window" ),
                    Add Filter( columns( :sex ), Where( :sex == "F" ) )
                ),
                <<Set Stretch( "Off", "Fill" )
            ),
            H Splitter Box(
                dt << Bubble Plot(
                    X( :weight ),
                    Y( :height ),
                    Fit To Window( "On" ),
                    Sizes( :age ),
                    Title Position( 0, 0 )
                ),
                dt << Graph Builder(
                    Size( 525, 456 ),
                    Show Control Panel( 0 ),
                    Fit To Window( "On" ),
                    Variables( X( :weight ), Y( :age ) ),
                    Elements( Box Plot( X, Y, Legend( 4 ) ) ),

                ),

            )
        )
    )
);


```

### [Title](#title)

**Syntax:** obj \<< Title

### [Unstructured Text](#unstructured-text)

**Syntax:** obj \<< Unstructured Text

**JMP Version Added:** 16

### [Use Floating Window](#use-floating-window)

**Syntax:** obj \<< Use Floating Window( state=0|1 )

**Description:** Toggle whether this data filter uses a window that floats above its data table and associated windows, or uses a window that can be arranged with other windows normally.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter;
obj << Use Floating Window;


```

### [Where](#where)

**Syntax:** obj \<< Where

**Description:** Select the rows based on the given criterion for this column filter.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter( Add( Filter Columns( :Region, :Lead ) ) );
Wait( 1 );
obj << (Filter Column( :Lead ) << Where( :Lead >= .4 & :Lead <= 1.4 ));


```

### [columns](#columns_1)

**Syntax:** obj \<< columns( columns )

**Description:** Add filter columns. It is alternative command to add filter columns.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
obj << Columns( :Region, :SO2, :CO, :State );


```

## [Categorical Filter](#categorical-filter)

### [Item Messages](#item-messages_1)

#### [Blocks Display](#blocks-display)

**Syntax:** obj \<< Blocks Display( state=0|1 )

**Description:** Show each level as a selectable block.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Blocks Display;


```

#### [Check Box Display](#check-box-display)

**Syntax:** obj \<< Check Box Display( state=0|1 )

**Description:** Show each level with a check box, along with frequency count and bars.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Check Box Display;


```

#### [Clear Find](#clear-find)

**Syntax:** obj \<< Clear Find

**JMP Version Added:** 15

#### [Clear Selection](#clear-selection_1)

**Syntax:** obj \<< Clear Selection

**Description:** Clears any selection in effect for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Clear Selection;


```

#### [Continuous](#continuous)

**Syntax:** obj \<< Continuous( state=0|1 )

**JMP Version Added:** 16

#### [Delete](#delete_1)

**Syntax:** obj \<< Delete

**Description:** Removes the variable from the Data Filter control panel.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Delete;


```

#### [Extend Where](#extend-where_1)

**Syntax:** obj \<< Extend Where

**Description:** Select rows using an expression, adding to the current selection.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Extend Where( :Region == {"MW"} );


```

#### [Find](#find)

**Syntax:** obj \<< Find(Set Text("string"), <options>)

**Description:** Provides a text box where you can enter a search string for the selected column.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Find( Set Text( "w" ) );


```

#### [Get Selected Items](#get-selected-items)

**Syntax:** obj \<< Get Selected Items

**JMP Version Added:** 15

#### [Get Visible Items](#get-visible-items)

**Syntax:** obj \<< Get Visible Items

**JMP Version Added:** 19

#### [Invert Selection](#invert-selection_1)

**Syntax:** obj \<< Invert Selection

**Description:** Deselects any selected values, and selects all values not previously selected, for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Invert Selection;


```

#### [List Display](#list-display)

**Syntax:** obj \<< List Display( state=0|1 )

**Description:** Show each level in a list, along with frequency count and bars.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "Check Box Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << List Display;


```

#### [Multiple Response](#multiple-response)

**Syntax:** obj \<< Multiple Response( state=0|1 )

**JMP Version Added:** 16

#### [Nominal/Ordinal](#nominalordinal)

**Syntax:** obj \<< Nominal/Ordinal( state=0|1 )

**JMP Version Added:** 16

#### [Order By Count](#order-by-count)

**Syntax:** obj \<< Order By Count( state=0|1 )

**Description:** Orders the values in decreasing sort order by count.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Order by Count;


```

#### [Radio Box Display](#radio-box-display)

**Syntax:** obj \<< Radio Box Display( state=0|1 )

**Description:** Show each level with a radio box, along with frequency count and bars.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Radio Box Display;


```

#### [Select Filter Item](#select-filter-item)

**Syntax:** obj \<< Select Filter Item

**Description:** Select the given filter item. The selected filter is used as the current animation object.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
popobj = obj << Get Filter Column( :POP );
popobj << Select Filter Item;


```

#### [Single Category Display](#single-category-display)

**Syntax:** obj \<< Single Category Display( state=0|1 )

**Description:** Show each level and frequency count in a combo box menu.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Single Category Display;


```

#### [Unstructured Text](#unstructured-text_1)

**Syntax:** obj \<< Unstructured Text( state=0|1 )

**JMP Version Added:** 16

#### [Where](#where_1)

**Syntax:** obj \<< Where

**Description:** Select rows using an expression.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Where( :Region == {"MW"} );


```

## [Continuous Filter](#continuous-filter)

### [Item Messages](#item-messages_2)

#### [Clear Selection](#clear-selection_2)

**Syntax:** obj \<< Clear Selection

**Description:** Clears any selection in effect for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Clear Selection;


```

#### [Continuous](#continuous_1)

**Syntax:** obj \<< Continuous( state=0|1 )

**JMP Version Added:** 16

#### [Delete](#delete_2)

**Syntax:** obj \<< Delete

**Description:** Removes the variable from the Data Filter control panel.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Delete;


```

#### [Extend Where](#extend-where_2)

**Syntax:** obj \<< Extend Where

**Description:** Select rows using an expression, adding to the current selection.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Extend Where( :Region == {"MW"} );


```

#### [Invert Selection](#invert-selection_2)

**Syntax:** obj \<< Invert Selection

**Description:** Deselects any selected values, and selects all values not previously selected, for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Invert Selection;


```

#### [Multiple Response](#multiple-response_1)

**Syntax:** obj \<< Multiple Response( state=0|1 )

**JMP Version Added:** 16

#### [Nominal/Ordinal](#nominalordinal_1)

**Syntax:** obj \<< Nominal/Ordinal( state=0|1 )

**JMP Version Added:** 16

#### [Reset Zoom](#reset-zoom)

**Syntax:** obj \<< Reset Zoom

**Description:** Reset the min and max of the filter display to the default values.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Time Series/Air.jmp" );
gb = dt << Graph Builder(
    Size( 522, 492 ),
    Show Control Panel( 0 ),
    Variables(
        X( :month ),
        Y( :Ozone Concentration ),
        Group X( :Summer Months Intervention )
    ),
    Elements( Points( X, Y, Legend( 10 ) ), Smoother( X, Y, Legend( 11 ) ) ), 

);
ldf = gb << Local Data Filter(
    Add Filter( columns( :date ), Where( :date >= 16Oct1965 & :date <= 31Aug1968 ) )
);
fc = ldf << Get Filter Column( :date );
fc << Zoom to Selection;
Wait( 1 );
fc << Reset Zoom;


```

#### [Select Filter Item](#select-filter-item_1)

**Syntax:** obj \<< Select Filter Item

**Description:** Select the given filter item. The selected filter is used as the current animation object.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
popobj = obj << Get Filter Column( :POP );
popobj << Select Filter Item;


```

#### [Select Missing](#select-missing_1)

**Syntax:** obj \<< Select Missing

**Description:** Selects rows that contain missing values.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Location( {2098, 120} ),
    Mode( Select( 0 ), Include( 1 ) ),
    Add Filter( columns( :OZONE ), Where( :OZONE >= 0.1 & :OZONE <= 0.2 ) )
);
Wait( 1 );
ozoneobj = obj << Get Filter Column( :OZONE );
ozoneobj << Select Missing;


```

#### [Unstructured Text](#unstructured-text_2)

**Syntax:** obj \<< Unstructured Text( state=0|1 )

**JMP Version Added:** 16

#### [Where](#where_2)

**Syntax:** obj \<< Where

**Description:** Select rows using an expression.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Where( :Region == {"MW"} );


```

#### [Zoom to Selection](#zoom-to-selection)

**Syntax:** obj \<< Zoom to Selection

**Description:** Set the min and max of the filter display based on the current selected interval.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Time Series/Air.jmp" );
gb = dt << Graph Builder(
    Size( 522, 492 ),
    Show Control Panel( 0 ),
    Variables(
        X( :month ),
        Y( :Ozone Concentration ),
        Group X( :Summer Months Intervention )
    ),
    Elements( Points( X, Y, Legend( 10 ) ), Smoother( X, Y, Legend( 11 ) ) ), 

);
ldf = gb << Local Data Filter(
    Add Filter( columns( :date ), Where( :date >= 16Oct1965 & :date <= 31Aug1968 ) )
);
fc = ldf << Get Filter Column( :date );
Wait( 1 );
fc << Zoom to Selection;


```

## [Multiple Response Filter](#multiple-response-filter)

### [Item Messages](#item-messages_3)

#### [Blocks Display](#blocks-display_1)

**Syntax:** obj \<< Blocks Display( state=0|1 )

**Description:** Show each level as a selectable block.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Blocks Display;


```

#### [Check Box Display](#check-box-display_1)

**Syntax:** obj \<< Check Box Display( state=0|1 )

**Description:** Show each level with a check box, along with frequency count and bars.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Check Box Display;


```

#### [Clear Find](#clear-find_1)

**Syntax:** obj \<< Clear Find

**JMP Version Added:** 15

#### [Clear Selection](#clear-selection_3)

**Syntax:** obj \<< Clear Selection

**Description:** Clears any selection in effect for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Clear Selection;


```

#### [Continuous](#continuous_2)

**Syntax:** obj \<< Continuous( state=0|1 )

**JMP Version Added:** 16

#### [Delete](#delete_3)

**Syntax:** obj \<< Delete

**Description:** Removes the variable from the Data Filter control panel.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Delete;


```

#### [Extend Where](#extend-where_3)

**Syntax:** obj \<< Extend Where

**Description:** Select rows using an expression, adding to the current selection.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Extend Where( :Region == {"MW"} );


```

#### [Find](#find_1)

**Syntax:** obj \<< Find(Set Text("string"), <options>)

**Description:** Provides a text box where you can enter a search string for the selected column.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Find( Set Text( "w" ) );


```

#### [Get Selected Items](#get-selected-items_1)

**Syntax:** obj \<< Get Selected Items

**JMP Version Added:** 15

#### [Get Visible Items](#get-visible-items_1)

**Syntax:** obj \<< Get Visible Items

**JMP Version Added:** 19

#### [Invert Selection](#invert-selection_3)

**Syntax:** obj \<< Invert Selection

**Description:** Deselects any selected values, and selects all values not previously selected, for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Invert Selection;


```

#### [List Display](#list-display_1)

**Syntax:** obj \<< List Display( state=0|1 )

**Description:** Show each level in a list, along with frequency count and bars.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "Check Box Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << List Display;


```

#### [Match All](#match-all)

**Syntax:** obj \<< Match All

**Description:** Selects rows with values that match all of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match All;


```

#### [Match Any](#match-any)

**Syntax:** obj \<< Match Any

**Description:** Selects rows with values that match any of the checked values. By default, this option is selected.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Any;


```

#### [Match At Least](#match-at-least)

**Syntax:** dfitem \<< Match At Least(n);

**Description:** Select rows with values that match at least n of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match At Least( 1 );


```

#### [Match At Most](#match-at-most)

**Syntax:** dfitem \<< Match At Most(n);

**Description:** Select rows with values that match at most n of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match At Most( 1 );


```

#### [Match Between](#match-between)

**Syntax:** dfitem \<< Match Between(n, m);

**Description:** Select rows with values that match between n and m of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Between( 1, 2 );


```

#### [Match Exactly](#match-exactly)

**Syntax:** obj \<< Match Exactly

**Description:** Selects rows with values that match exactly the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Exactly;


```

#### [Match None](#match-none)

**Syntax:** obj \<< Match None

**Description:** Selects rows with values that match none of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match None;


```

#### [Match Only](#match-only)

**Syntax:** obj \<< Match Only

**Description:** Select rows with values that match only the checked value.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Only;


```

#### [Multiple Response](#multiple-response_2)

**Syntax:** obj \<< Multiple Response( state=0|1 )

**JMP Version Added:** 16

#### [Nominal/Ordinal](#nominalordinal_2)

**Syntax:** obj \<< Nominal/Ordinal( state=0|1 )

**JMP Version Added:** 16

#### [Order By Count](#order-by-count_1)

**Syntax:** obj \<< Order By Count( state=0|1 )

**Description:** Orders the values in decreasing sort order by count.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Order by Count;


```

#### [Radio Box Display](#radio-box-display_1)

**Syntax:** obj \<< Radio Box Display( state=0|1 )

**Description:** Show each level with a radio box, along with frequency count and bars.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Radio Box Display;


```

#### [Select Filter Item](#select-filter-item_2)

**Syntax:** obj \<< Select Filter Item

**Description:** Select the given filter item. The selected filter is used as the current animation object.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
popobj = obj << Get Filter Column( :POP );
popobj << Select Filter Item;


```

#### [Single Category Display](#single-category-display_1)

**Syntax:** obj \<< Single Category Display( state=0|1 )

**Description:** Show each level and frequency count in a combo box menu.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Single Category Display;


```

#### [Unstructured Text](#unstructured-text_3)

**Syntax:** obj \<< Unstructured Text( state=0|1 )

**JMP Version Added:** 16

#### [Where](#where_3)

**Syntax:** obj \<< Where

**Description:** Select rows using an expression.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Where( :Region == {"MW"} );


```

## [Unstructured Text Filter](#unstructured-text-filter)

### [Item Messages](#item-messages_4)

#### [Add Missing](#add-missing)

**Syntax:** obj \<< Add Missing

**Description:** Add a missing value as a selectable option for unstructured text.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :sibling ages ) ),
    Elements( Bar( X, Legend( 3 ) ) )
);
df = obj << Local Data Filter(
    Add Filter(
        columns( :reported illnesses ),
        Unstructured Text( Column( :reported illnesses ), Add Filter Text( "head" ) ),
        Match Any( Where( Contains( :reported illnesses, "head" ) ) ),

    )
);
Wait( 1 );
illness_obj = df << Get Filter Column( :reported illnesses );
illness_obj << Add Missing;


```

#### [Blocks Display](#blocks-display_2)

**Syntax:** obj \<< Blocks Display( state=0|1 )

**Description:** Show each level as a selectable block.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Blocks Display;


```

#### [Check Box Display](#check-box-display_2)

**Syntax:** obj \<< Check Box Display( state=0|1 )

**Description:** Show each level with a check box, along with frequency count and bars.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Check Box Display;


```

#### [Clear Filter Texts List](#clear-filter-texts-list)

**Syntax:** obj \<< Clear Filter Texts List

**Description:** Clear the list of filters for an unstructured text filter item.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :sibling ages ) ),
    Elements( Bar( X, Legend( 3 ) ) )
);
df = obj << Local Data Filter(
    Add Filter(
        columns( :reported illnesses ),
        Unstructured Text( Column( :reported illnesses ), Add Filter Text( "head" ) ),
        Match Any( Where( Contains( :reported illnesses, "head" ) ) ),

    )
);
Wait( 1 );
illness_obj = df << Get Filter Column( :reported illnesses );
illness_obj << Clear Filter Texts List;


```

#### [Clear Selection](#clear-selection_4)

**Syntax:** obj \<< Clear Selection

**Description:** Clears any selection in effect for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Clear Selection;


```

#### [Continuous](#continuous_3)

**Syntax:** obj \<< Continuous( state=0|1 )

**JMP Version Added:** 16

#### [Delete](#delete_4)

**Syntax:** obj \<< Delete

**Description:** Removes the variable from the Data Filter control panel.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Delete;


```

#### [Extend Where](#extend-where_4)

**Syntax:** obj \<< Extend Where

**Description:** Select rows using an expression, adding to the current selection.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Extend Where( :Region == {"MW"} );


```

#### [Get Selected Items](#get-selected-items_2)

**Syntax:** obj \<< Get Selected Items

**JMP Version Added:** 15

#### [Get Visible Items](#get-visible-items_2)

**Syntax:** obj \<< Get Visible Items

**JMP Version Added:** 19

#### [Invert Selection](#invert-selection_4)

**Syntax:** obj \<< Invert Selection

**Description:** Deselects any selected values, and selects all values not previously selected, for the given column.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Invert Selection;


```

#### [List Display](#list-display_2)

**Syntax:** obj \<< List Display( state=0|1 )

**Description:** Show each level in a list, along with frequency count and bars.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "Check Box Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << List Display;


```

#### [Match All](#match-all_1)

**Syntax:** obj \<< Match All

**Description:** Selects rows with values that match all of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match All;


```

#### [Match Any](#match-any_1)

**Syntax:** obj \<< Match Any

**Description:** Selects rows with values that match any of the checked values. By default, this option is selected.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Any;


```

#### [Match At Least](#match-at-least_1)

**Syntax:** dfitem \<< Match At Least(n);

**Description:** Select rows with values that match at least n of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match At Least( 1 );


```

#### [Match At Most](#match-at-most_1)

**Syntax:** dfitem \<< Match At Most(n);

**Description:** Select rows with values that match at most n of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match At Most( 1 );


```

#### [Match Between](#match-between_1)

**Syntax:** dfitem \<< Match Between(n, m);

**Description:** Select rows with values that match between n and m of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Between( 1, 2 );


```

#### [Match Exactly](#match-exactly_1)

**Syntax:** obj \<< Match Exactly

**Description:** Selects rows with values that match exactly the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Exactly;


```

#### [Match None](#match-none_1)

**Syntax:** obj \<< Match None

**Description:** Selects rows with values that match none of the checked values.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match None;


```

#### [Match Only](#match-only_1)

**Syntax:** obj \<< Match Only

**Description:** Select rows with values that match only the checked value.

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = dt << Data Filter(
    Add Filter(
        columns( :Sports ),
        Match Any( Where( :sports == {"Basketball", "Tennis"} ) )
    ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
sportsobj = obj << Get Filter Column( :Sports );
sportsobj << Match Only;


```

#### [Multiple Response](#multiple-response_3)

**Syntax:** obj \<< Multiple Response( state=0|1 )

**JMP Version Added:** 16

#### [Nominal/Ordinal](#nominalordinal_3)

**Syntax:** obj \<< Nominal/Ordinal( state=0|1 )

**JMP Version Added:** 16

#### [Order By Count](#order-by-count_2)

**Syntax:** obj \<< Order By Count( state=0|1 )

**Description:** Orders the values in decreasing sort order by count.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Order by Count;


```

#### [Radio Box Display](#radio-box-display_2)

**Syntax:** obj \<< Radio Box Display( state=0|1 )

**Description:** Show each level with a radio box, along with frequency count and bars.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Radio Box Display;


```

#### [Select Filter Item](#select-filter-item_3)

**Syntax:** obj \<< Select Filter Item

**Description:** Select the given filter item. The selected filter is used as the current animation object.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
popobj = obj << Get Filter Column( :POP );
popobj << Select Filter Item;


```

#### [Show Filter Text Edit Box](#show-filter-text-edit-box)

**Syntax:** obj \<< Show Filter Text Edit Box( state=0|1 )

**Description:** Show or hide the text edit box for defining text filter conditions.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :sibling ages ) ),
    Elements( Bar( X, Legend( 3 ) ) )
);
df = obj << Local Data Filter(
    Add Filter(
        columns( :reported illnesses ),
        Unstructured Text( Column( :reported illnesses ), Add Filter Text( "head" ) ),
        Match Any( Where( Contains( :reported illnesses, "head" ) ) ),

    )
);
Wait( 1 );
illness_obj = df << Get Filter Column( :reported illnesses );
illness_obj << Show Filter Text Edit Box( 0 );


```

#### [Single Category Display](#single-category-display_2)

**Syntax:** obj \<< Single Category Display( state=0|1 )

**Description:** Show each level and frequency count in a combo box menu.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Display( :Region, "List Display" ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Single Category Display;


```

#### [Unstructured Text](#unstructured-text_4)

**Syntax:** obj \<< Unstructured Text( state=0|1 )

**JMP Version Added:** 16

#### [Where](#where_4)

**Syntax:** obj \<< Where

**Description:** Select rows using an expression.

```


dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Data Filter(
    Add Filter( columns( :Region, :POP ), Where( :Region == {"C", "N"} ) ),
    Mode( Select( 0 ), Show( 0 ), Include( 1 ) )
);
Wait( 1 );
regionobj = obj << Get Filter Column( :Region );
regionobj << Where( :Region == {"MW"} );


```

# [Data Table](#data-table)

## [Associated Constructors](#associated-constructors)

### [Association Analysis](#association-analysis)

**Syntax:** Association Analysis( Item( columns ), ID( columns ) )

**Description:** Identifies connections among groups of items in an independent event or transaction. Association analysis is frequently used to analyze transactional data (also called market baskets) to identify items that often appear together in transactions.

```

dt = Open( "$SAMPLE_DATA/Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );


```

### [Attribute Chart](#attribute-chart)

**Syntax:** Attribute Chart( Y( columns ), X( columns ) )

**Description:** Analyzes categorical measurements to show you measures of agreement across responses, such as raters.

```

dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );


```

### [Bayesian Optimization](#bayesian-optimization)

**Syntax:** Bayesian Optimization( Y( columns ), X( columns ) )

**Description:** Recommends factor settings to optimize responses by augmenting the data table.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Bayesian Optimization(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR )
);


```

### [Bivariate](#bivariate)

**Syntax:** Bivariate( Y( columns ), X( columns ) )

**Description:** Models a continuous response with respect to another continuous variable. Analysis methods include fitting lines, polynomials, splines, and bivariate densities.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );


```

### [Boosted Tree](#boosted-tree)

**Syntax:** Boosted Tree (Y( column ), X( columns ))

**Description:** Constructs a predictive model by building a large, additive decision tree that is a sequence of smaller decision trees. Each of the trees is fit on the residuals of the previous tree.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Go
);


```

### [Bootstrap Forest](#bootstrap-forest)

**Syntax:** Bootstrap Forest (Y( column ), X( columns ))

**Description:** Constructs a predictive model by averaging predicted values from many decision trees. Each decision tree is fit to a random bootstrap sample of the training data.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Minimum Splits Per Tree( 5 ),
    Portion Bootstrap( 1 ),
    Number Terms( 3 ),
    Number Trees( 25 ),
    Go
);


```

### [Bubble Plot](#bubble-plot)

**Syntax:** Bubble Plot( X( column ), Y( column ), \<Sizes( column )>, \<Time( column )>, \<ID( column )>, \<Coloring( column ) )

**Description:** Produces a two-dimensional scatterplot of bubbles that can be animated over a time variable. Additional variables can be used to size and color the bubbles.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
obj = dt << Bubble Plot(
    X( :"Portion 0-19"n ),
    Y( :"Portion60+"n ),
    Sizes( :Pop ),
    ID( :Country )
);


```

### [CUSUM Control Chart](#cusum-control-chart)

**Syntax:** CUSUM Control Chart( Y( column ), \<X( column )>, \<By( column )>, \<Data Units( 0|1 )>, \<Show Excluded Region( 0|1 )> )

**Description:** Creates a chart that plots the cumulative sums of deviations of subgroup means from a target. This chart is also called a tabular CUSUM chart.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Oil1 Cusum.jmp" );
obj = dt << CUSUM Control Chart(
    Y( :weight ),
    H( 2 ),
    Lower Side( 1 ),
    Target( 8.1 ),
    K( 0.025 ),
    Sigma( 0.05 ),
    Head Start( 0.05 )
);


```

### [Categorical](#categorical)

**Syntax:** Categorical( Responses | Aligned Responses | Repeated Measures | Rater Agreement | Multiple Response | Multiple Response by ID | Multiple Delimited | Indicator Group | Response Frequencies( column ), X( column(s) ) )

**Description:** Summarizes and analyzes categorical response data. Data can be simple responses, multiple responses, repeated measures, rater agreement, aligned responses, or free text. Includes the ability to generate custom cross tabulations of responses.

#### [Aligned Responses](#aligned-responses)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured(
        Empty(),
        Empty(),
        Aligned Responses(
            :I am working on my career, :I want to see the world,
            :My home needs some major improvements, :I have vast interests outside of work,
            :I want to get my debt under control, :I come from a large family
        )
    )
);


```

#### [Multiple Response (Structured)](#multiple-response-structured)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical( Structured( :Gender, :Brush Delimited + :Floss Delimited ) );


```

#### [Multiple Response with Nested Groups](#multiple-response-with-nested-groups)

```


dt = Open( "$SAMPLE_DATA/Quality Control/Failure3MultipleField.jmp" );
Categorical( X( :clean, :date ), Multiple Response( :Failure1, :Failure2, :Failure3 ) );


```

#### [Nested within Individual Factors](#nested-within-individual-factors)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured(
        :Single Status * :Gender + :School Age Children * :Gender,
        :I am working on my career + :I want to see the world
    )
);


```

#### [One Response by Two Nested Factors](#one-response-by-two-nested-factors)

```


dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Categorical( X( :sex, :marital status ), Responses( :country ) );


```

#### [Rater Agreement](#rater-agreement)

```


dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
Categorical( Rater Agreement( :A, :B, :C ) );


```

#### [Repeated Measures](#repeated-measures)

```


dt = Open( "$SAMPLE_DATA/Presidential Elections.jmp" );
Categorical(
    Repeated Measures(
        :"1980 Winner"n, :"1984 Winner"n, :"1988 Winner"n, :"1992 Winner"n, :"1996 Winner"n,
        :"2000 Winner"n, :"2004 Winner"n, :"2008 Winner"n, :"2012 Winner"n
    )
);


```

#### [Three Responses by Two Individual Factors (Structured)](#three-responses-by-two-individual-factors-structured)

```


dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Categorical(
    Structured(
        :I am working on my career + :I want to see the world,
        :Gender + :Single Status + :Age Group
    )
);


```

### [Cell Plot](#cell-plot)

**Syntax:** Cell Plot( Y( column(s) ), \<X( column )> )

**Description:** Produces a rectangular grid of cells drawn with one-to-one correspondence to data table values. The cells in the grid are colored by the values in the cells.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
obj = dt << Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

### [Choice](#choice)

**Syntax:** Choice( Profile DataTable( data table ), Profile ID( column ), Profile Effects( column(s) ), \<Response Data Table( data table )>, \<Subject Data Table( data table )>, \<Response Profile ID Chosen( column )>, \<Response Subject ID( column)>, \<Response Grouping( column(s) )>, \<Response Profile ID Choices( column(s) )>, \<Profile Grouping( column(s) )>, \<Subject Subject ID( column )>, \<Subject Effects( column(s) )> )

**Description:** Models data from a choice experiment that studies customer preferences. Estimates the probability that a specific configuration is preferred using a form of conditional logistic regression.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = dt << Choice(
    Response Data Table( Data Table( "Pizza Responses" ) ),
    Profile DataTable( Data Table( "Pizza Profiles" ) ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Pizza Combined.jmp" );
obj = Choice(
    One Table( 1 ),
    Profile DataTable( dt ),
    Profile ID( :Indicator ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Profile Grouping( :Subject, :Trial )
);


```

### [Close](#close)

**Syntax:** Close( \<dataTableRef|name>, \<NoSave|Save( "path" )> )

**Description:** Closes the data table referenced by the first argument, which defaults to the current data table. The second argument is used to save the data table. Use an appropriate file extension in the path to save the data table as a non-JMP format. Specifying NoSave bypasses the prompt to save or disregard changes.

```

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


```

### [Cluster Variables](#cluster-variables)

**Syntax:** Cluster Variables( Y( columns ) )

**Description:** Clusters variables (columns) into groups that can be represented by a single component or variable. Cluster variables can be used as a dimension reduction technique.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Cluster Variables( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );


```

### [Contingency](#contingency)

**Syntax:** Contingency( Y( columns ), X( columns ) )

**Description:** Models a categorical response across a set of categorical groups. Analysis methods include chi-square tests and mosaic plots.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );


```

### [Contour Plot](#contour-plot)

**Syntax:** Contour Plot( X( column, column ), Y( column ) )

**Description:** Produces a graph of three variables in a two-dimensional view, where the third variable is represented by contour curves of equal value.

```

dt = Open( "$SAMPLE_DATA/Little Pond.jmp" );
obj = dt << Contour Plot( X( :X, :Y ), Y( :Z ) );


```

### [Contour Profiler](#contour-profiler)

**Syntax:** Contour Profiler( Y( column1, column2, ... ) )

**Description:** Produces an interactive contour plot that enables you to explore how one or more predicted responses change across pairs of factors. The values of factors not used in the plot can be varied to further explore the impact of the factor settings on the predicted responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

### [Control Chart Builder](#control-chart-builder)

**Syntax:** Control Chart Builder( Class( "Shewhart Variables"|"Shewhart Attribute"|"Short Run"|"Rare Event" ), Variables( variables ), \<Chart( Position( number ), Points( Statistic( "statistic" ), <points options> ), Limits( Sigma( "sigma" ), <limits options> )> ) ) )

**Description:** Enables you to interactively create control charts, which are used to determine whether a process is stable and predictable. The Control Chart Builder platform can be used to create the following types of control charts: IMR, XBar, Short Run, Run, P, NP, C, U, Laney P', Laney U', Levey-Jennings, IMR on Means, Three Way, and Rare Event charts.

#### [C Chart](#c-chart)

```

// Create a C chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Count, and changing the Sigma to Poisson.
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Poisson" ) ) ),
    Show Control Panel( 0 )
);


```

#### [IMR Chart](#imr-chart)

```

// Create an IMR chart by adding a continuous Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder( Variables( Y( :Weight ) ), Show Control Panel( 0 ) );


```

#### [IMR on Group Standard Deviation Chart (Set Subgroup Size)](#imr-on-group-standard-deviation-chart-set-subgroup-size)

```

// Create an IMR on Group Standard Deviation chart by adding a Y variable and defining a subgroup size, and changing the Statistic on the location chart to Standard Deviation, on the dispersion chart to Moving Range on Std Dev and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [IMR on Group Standard Deviation Chart (Subgroup Variable)](#imr-on-group-standard-deviation-chart-subgroup-variable)

```

// Create an IMR on Group Standard Deviation chart by adding a Y variable and a subgroup variable, and changing the Statistic on the location chart to Standard Deviation, on the dispersion chart to Moving Range on Std Dev and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [IMR on Means Chart (Set Subgroup Size)](#imr-on-means-chart-set-subgroup-size)

```

// Create an IMR on Means chart by adding a Y variable and defining a subgroup size, and changing the Statistic on the dispersion chart to Moving Range on Means and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart( Position( 1 ), Limits( Sigma( "Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [IMR on Means Chart (Subgroup Variable)](#imr-on-means-chart-subgroup-variable)

```

// Create an IMR on Means chart by adding a Y variable and a subgroup variable, and changing the Statistic on the dispersion chart to Moving Range on Means and the Sigma on both charts to Moving Range.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Levey-Jennings Chart](#levey-jennings-chart)

```

// Create a Levey-Jennings chart by adding a Y variable, removing the dispersion chart, and changing the Sigma to Levey Jennings. Make sure that the Statistic is set to Individual.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Show Two Shewhart Charts( 0 ),
    Variables( Y( :Weight ) ),
    Chart( Points( Statistic( "Individual" ) ), Limits( Sigma( "Levey Jennings" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range Chart](#median-moving-range-chart)

```

// Create a Median Moving Range chart by adding a Y variable and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Chart( Position( 2 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Means Chart (Set Subgroup Size)](#median-moving-range-on-group-means-chart-set-subgroup-size)

```

// Create a Median Moving Range on Group Means chart by adding a Y variable and defining a subgroup size, changing the Statistic on the dispersion chart to Moving Range on Means, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart( Position( 1 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Means Chart (Subgroup Variable)](#median-moving-range-on-group-means-chart-subgroup-variable)

```

// Create a Median Moving Range on Group Means chart by adding a Y variable and a subgroup variable, changing the Statistic on the dispersion chart to Moving Range on Means, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Median Moving Range" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Standard Deviations Chart (Set Subgroup Size)](#median-moving-range-on-group-standard-deviations-chart-set-subgroup-size)

```

// Create a Median Moving Range on Group Standard Deviations chart by adding a Y variable and defining a subgroup size, changing the Statistic on the location chart to Standard deviation, on the dispersion chart to Moving Range on Std Dev, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Median Moving Range on Group Standard Deviations Chart (Subgroup Variable)](#median-moving-range-on-group-standard-deviations-chart-subgroup-variable)

```

// Create a Median Moving Range on Group Standard Deviations chart by adding a Y variable and a subgroup variable, changing the Statistic on the location chart to Standard deviation, on the dispersion chart to Moving Range on Std Dev, and changing the Sigma to Median Moving Range on both the location and dispersion charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Std Dev" ) ),
        Limits( Sigma( "Median Moving Range" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [NP Chart](#np-chart)

```

// Create an NP chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Count, and changing the Sigma to Binomial (P, NP).
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Binomial" ) ) ),
    Show Control Panel( 0 )
);


```

#### [P Chart](#p-chart)

```

// Create a P chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Binomial (P, NP).
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Binomial" ) ) ),
    Show Control Panel( 0 )
);


```

#### [P' Chart](#p-chart_1)

```

// Create a P' chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Laney P'.
dt = Open( "$SAMPLE_DATA/Quality Control/Washers.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Lot ), Y( :"# defective"n ), n Trials( :Lot Size ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Laney P Prime" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Rare Event G Chart](#rare-event-g-chart)

```

// Create a G chart by changing the class to Rare Event and adding a nonnegative discrete Y variable. Make sure that the Sigma is set to Negative Binomial.
dt = Open( "$SAMPLE_DATA/Quality Control/Fan Burnout.jmp" );
obj = dt << Control Chart Builder(
    Class( "Rare Event" ),
    Variables( Subgroup( :Burnout ), Y( :Hours between Burnouts ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Negative Binomial" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Rare Event T Chart](#rare-event-t-chart)

```

// Create a T chart by changing the class to Rare Event, changing the Sigma to Weibull, and adding a nonnegative discrete Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Fan Burnout.jmp" );
obj = dt << Control Chart Builder(
    Class( "Rare Event" ),
    Variables( Subgroup( :Burnout ), Y( :Hours between Burnouts ) ),
    Chart( Points( Statistic( "Count" ) ), Limits( Sigma( "Weibull" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Run Chart](#run-chart)

```

// Create a Run chart by adding a Y variable, turning off the limits, and removing the dispersion chart.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Show Two Shewhart Charts( 0 ),
    Show Limit Summaries( 0 ),
    Variables( Y( :Weight ) ),
    Chart( Limits( Show Lower Limit( 0 ), Show Upper Limit( 0 ) ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Difference Chart](#short-run-difference-chart)

```

// Create a Short Run Difference chart by changing the class to Short Run and adding a Product or Part variable. Make sure that the Statistic values for the location chart and dispersion chart are set to Centered and Moving Range Centered, respectively. Centered Short Run control charts are sometimes referred to as Deviation from Nominal (DNOM) charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Difference Chart for XBar](#short-run-difference-chart-for-xbar)

```

// Create a Short Run Difference chart for summarized data by changing the class to Short Run and adding a Product or Part variable,  Short Run Standardized charts are sometimes referred to as Z-MR charts. Centered Short Run control charts are sometimes referred to as Deviation from Nominal (DNOM) charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Fancy Chocolate Factory.jmp" );
obj = dt << Control Chart Builder(
    Show Product Separators( 0 ),
    Class( "Short Run" ),
    Variables( Subgroup( :Box ), Y( :"%Cocoa"n ), Part( :Product ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Standardized Chart](#short-run-standardized-chart)

```

// Create a Short Run Standardized chart by changing the class to Short Run and adding a Subgroup and a Product or Part variable, changing the Statistic for the location chart type to Standardized, and changing the Statistic for the dispersion chart to Moving Range Standardized. Short Run Standardized charts are sometimes referred to as Z-MR charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Class( "Short Run" ),
    Variables( Y( :Weight ), Part( :Product ) ),
    Chart( Position( 1 ), Points( Statistic( "Standardized" ) ) ),
    Chart( Position( 2 ), Points( Statistic( "Moving Range Standardized" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Short Run Standardized Chart for XBar](#short-run-standardized-chart-for-xbar)

```

// Create a Short Run Standardized chart for summarized data by changing the class to Short Run and adding a Subgroup and a Product or Part variable,  Short Run Standardized charts are sometimes referred to as Z-MR charts. Centered Short Run control charts are sometimes referred to as Deviation from Nominal (DNOM) charts.
dt = Open( "$SAMPLE_DATA/Quality Control/Fancy Chocolate Factory.jmp" );
obj = dt << Control Chart Builder(
    Show Product Separators( 0 ),
    Class( "Short Run" ),
    Variables( Subgroup( :Box ), Y( :"%Cocoa"n ), Part( :Product ) ),
    Chart( Position( 1 ), Points( Statistic( "Standardized" ) ) ),
    Chart( Position( 2 ), Points( Statistic( "Range Standardized" ) ) ),
    Show Control Panel( 0 )
);


```

#### [Three Way Chart (Set Subgroup Size)](#three-way-chart-set-subgroup-size)

```

// Create a Three Way chart by adding a dispersion chart after adding a Y variable and setting a subgroup size.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Average" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 3 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Standard Deviation" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [Three Way Chart (Subgroup Variable)](#three-way-chart-subgroup-variable)

```

// Create a Three Way chart by adding a dispersion chart after adding a Y variable and adding a subgroup variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Average" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Moving Range on Means" ) ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart( Position( 3 ), Points( Statistic( "Range" ) ), Limits( Sigma( "Range" ) ) ),
    Show Control Panel( 0 )
);


```

#### [U Chart](#u-chart)

```

// Create a U chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Poisson.
dt = Open( "$SAMPLE_DATA/Quality Control/Orange Juice.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Sample ), Y( :Status ), Phase( :Phase ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Poisson" ) ) ),
    Show Control Panel( 0 )
);


```

#### [U' Chart](#u-chart_1)

```

// Create a U' chart by adding a Y variable, changing the Class to Shewhart Attribute, changing the Statistic to Proportion, and changing the Sigma to Laney U'.
dt = Open( "$SAMPLE_DATA/Quality Control/Washers.jmp" );
obj = dt << Control Chart Builder(
    Class( "Shewhart Attribute" ),
    Variables( Subgroup( :Lot ), Y( :"# defective"n ), n Trials( :Lot Size ) ),
    Chart( Points( Statistic( "Proportion" ) ), Limits( Sigma( "Laney U Prime" ) ) ),
    Show Control Panel( 0 )
);


```

#### [XBar/R Chart](#xbarr-chart)

```

// Create an XBar/R chart by adding a subgroup or setting a subgroup size after adding a Y variable.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Show Control Panel( 0 )
);


```

#### [XBar/S Chart (Set Subgroup Size)](#xbars-chart-set-subgroup-size)

```

// Create an XBar/S chart by adding a Y variable and defining a subgroup size, changing the Statistic for the dispersion chart to Standard Deviation, and changing the Sigma for the location chart to Standard Deviation.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Y( :Weight ) ),
    Set Subgroup Size( 4 ),
    Chart( Position( 1 ), Limits( Sigma( "Standard Deviation" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Standard Deviation" ) )
    ),
    Show Control Panel( 0 )
);


```

#### [XBar/S Chart (Subgroup Variable)](#xbars-chart-subgroup-variable)

```

// Create an XBar/S chart by adding a Y variable and a subgroup variable, changing the Statistic for the dispersion chart to Standard Deviation, and changing the Sigma for the location chart to Standard Deviation.
dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Control Chart Builder(
    Variables( Subgroup( :Sample ), Y( :Weight ) ),
    Chart( Position( 1 ), Limits( Sigma( "Standard Deviation" ) ) ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Standard Deviation" ) ),
        Limits( Sigma( "Standard Deviation" ) )
    ),
    Show Control Panel( 0 )
);


```

### [Cumulative Damage](#cumulative-damage)

**Syntax:** Cumulative Damage

**Description:** Analyzes varying-stress and step-stress models.

```

Open( "$SAMPLE_DATA/Reliability/CD Step Stress.jmp" );
Open( "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp" );
obj = Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        Data Table( "CD Step Stress" ),
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID ),
        Censor Code( 1 )
    ),
    Step Stress Pattern Data Table(
        Data Table( "CD Step Stress Pattern" ),
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Lognormal" ),
    Pattern Continuation( "Terminate" )
);


```

### [Custom Profiler](#custom-profiler)

**Syntax:** Custom Profiler( Y( column1, column2, ... ) )

**Description:** Provides an interface that enables you to optimize responses without a graphical output. This profiler is useful for larger problems.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

### [Degradation](#degradation)

**Syntax:** Degradation( Y( column ), Time( column ), Application( "Repeated Measures Degradation"|"Destructive Degradation"|"Stability Test" ), \<X( column )>, \<Label( column )>, \<Freq( column )>, \<Censor( column )>, \<Censor Code( value )>, \<Upper Spec Limit( value )>, \<Lower Spec Limit( value )>, \<Censoring Time( value )> )

**Description:** Models degradation over time using linear and nonlinear curves. Analysis options include stability analysis and generation of pseudo-failure data.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);


```

### [Destructive Degradation](#destructive-degradation)

**Syntax:** Destructive Degradation( Y( column ), Time( column ), \<X( column )>, \<Freq( column )>, \<Censor( column ), Censor Code( value )> )

**Description:** Models destructive degradation data over time.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

### [Diagram](#diagram)

**Syntax:** Diagram( Y( column ), X( column ) )

**Description:** Creates a cause and effect diagram. Also called Ishikawa or fishbone diagrams. These are hierarchical diagrams that enable you to explore root causes.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );


```

### [Discriminant](#discriminant)

**Syntax:** Discriminant( Y( columns ), X( columns ) )

**Description:** Estimates the distance from each observation to each group's multivariate mean (centroid) using Mahalanobis distance. The observations are then classified into the group that they are closest to.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Distance Matrix](#distance-matrix)

**Syntax:** Distance Matrix( Y( columns ) )

**Description:** Computes distances between rows using a variety of methods.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

### [Distribution](#distribution)

**Syntax:** Distribution( Column() )

**Description:** Shows the distribution and univariate summary statistics for each variable. Results and options depend on the modeling type of each variable. Some options include histograms, box plots, quantile plots, fitting distributions, and capability analysis.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
colref = Column( "age" );
// Correct way to use the colref
Distribution( Column( colref ) );
// This will not work
Distribution( colref );


```

### [EMP Measurement Systems Analysis](#emp-measurement-systems-analysis)

**Syntax:** EMP Measurement Systems Analysis( Y( column ), X( columns ), Part(column), Model(Main|Crossed|Crossed with Two Factor Interactions|Nested|Crossed then Nested|Nested then Crossed), Dispersion Chart Type(Range|Standard Deviation) )

**Description:** Launches the EMP (Evaluating the Measurement Process) method for Measurement Systems Analysis. The average and dispersion (range or standard deviation) charts are displayed by default.

#### [Crossed Effects Model, Range Chart](#crossed-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Crossed Effects Model, Std Dev Chart](#crossed-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Crossed then Nested Effects Model, Range Chart](#crossed-then-nested-effects-model-range-chart)

```

dt = New Table( "3 Factors Crossed then Nested",
    Add Rows( 81 ),
    New Column( "Operator",
        Character( 7 ),
        "Nominal",
        Set Values(
            {"Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Instrument",
        Character( 1 ),
        "Nominal",
        Set Values(
            {"A", "A", "A", "A", "A", "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B",
            "B", "B", "C", "C", "C", "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A",
            "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C",
            "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A", "A", "A", "A", "A", "B",
            "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C", "C", "C", "C", "C", "C",
            "C"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Part",
        Numeric,
        "Nominal",
        Format( "Best", 8 ),
        Set Values(
            [1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4, 5, 5, 5, 6, 6, 6, 7, 7, 7, 8, 8, 8, 9, 9, 9,
            10, 10, 10, 11, 11, 11, 12, 12, 12, 13, 13, 13, 14, 14, 14, 15, 15, 15, 16, 16,
            16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20, 20, 20, 21, 21, 21, 22, 22, 22, 23,
            23, 23, 24, 24, 24, 25, 25, 25, 26, 26, 26, 27, 27, 27]
        ),
        Set Display Width( 0 )
    ),
    New Column( "Y",
        Numeric,
        "Continuous",
        Format( "Best", 8 ),
        Set Values(
            [0.5, 0.6, 0.2, 0.8, 0.6, 0.6, 1.6, 1.1, 1, 0.4, 0.2, 0.1, 0.1, 0.5, 0, 0.3, 0.6,
            0.8, 0.1, 0.1, 0.2, 0.4, 0.9, 1.8, 0.1, 0.3, 0.4, 0.1, 0.3, 0.1, 0.9, 0.4, 0, 0.6,
            0.7, 0.7, 0.3, 0.1, 0.2, 0.3, 0.6, 0.2, 0.2, 0.4, 0.4, 0.8, 0.3, 0.3, 2.6, 0.4,
            1.6, 0.5, 0.3, 2.9, 0, 0, 0.5, 0.1, 0, 0.3, 0.5, 0, 0, 0.4, 0, 0.4, 0.3, 0.2, 0,
            0, 0.5, 0.1, 0.1, 0.2, 0.3, 1.1, 0.2, 0.1, 0.6, 0.3, 0.6]
        ),
        Set Display Width( 68 )
    )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed then Nested (3 Factors Only)"n ),
    Dispersion Chart Type( Range ),
    Variance Components( 1 )
);


```

#### [Crossed then Nested Effects Model, Std Dev Chart](#crossed-then-nested-effects-model-std-dev-chart)

```

dt = New Table( "3 Factors Crossed then Nested",
    Add Rows( 81 ),
    New Column( "Operator",
        Character( 7 ),
        "Nominal",
        Set Values(
            {"Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Instrument",
        Character( 1 ),
        "Nominal",
        Set Values(
            {"A", "A", "A", "A", "A", "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B",
            "B", "B", "C", "C", "C", "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A",
            "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C",
            "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A", "A", "A", "A", "A", "B",
            "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C", "C", "C", "C", "C", "C",
            "C"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Part",
        Numeric,
        "Nominal",
        Format( "Best", 8 ),
        Set Values(
            [1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4, 5, 5, 5, 6, 6, 6, 7, 7, 7, 8, 8, 8, 9, 9, 9,
            10, 10, 10, 11, 11, 11, 12, 12, 12, 13, 13, 13, 14, 14, 14, 15, 15, 15, 16, 16,
            16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20, 20, 20, 21, 21, 21, 22, 22, 22, 23,
            23, 23, 24, 24, 24, 25, 25, 25, 26, 26, 26, 27, 27, 27]
        ),
        Set Display Width( 0 )
    ),
    New Column( "Y",
        Numeric,
        "Continuous",
        Format( "Best", 8 ),
        Set Values(
            [0.5, 0.6, 0.2, 0.8, 0.6, 0.6, 1.6, 1.1, 1, 0.4, 0.2, 0.1, 0.1, 0.5, 0, 0.3, 0.6,
            0.8, 0.1, 0.1, 0.2, 0.4, 0.9, 1.8, 0.1, 0.3, 0.4, 0.1, 0.3, 0.1, 0.9, 0.4, 0, 0.6,
            0.7, 0.7, 0.3, 0.1, 0.2, 0.3, 0.6, 0.2, 0.2, 0.4, 0.4, 0.8, 0.3, 0.3, 2.6, 0.4,
            1.6, 0.5, 0.3, 2.9, 0, 0, 0.5, 0.1, 0, 0.3, 0.5, 0, 0, 0.4, 0, 0.4, 0.3, 0.2, 0,
            0, 0.5, 0.1, 0.1, 0.2, 0.3, 1.1, 0.2, 0.1, 0.6, 0.3, 0.6]
        ),
        Set Display Width( 68 )
    )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed then Nested (3 Factors Only)"n ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Crossed with Two Factor Interaction Effects Model, Range Chart](#crossed-with-two-factor-interaction-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :new Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed with Two Factor Interactions" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Crossed with Two Factor Interaction Effects Model, Std Dev Chart](#crossed-with-two-factor-interaction-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :new Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed with Two Factor Interactions" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Main Effects Model, Range Chart](#main-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Main" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Main Effects Model, Std Dev Chart](#main-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Main" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Nested Effects Model, Range Chart](#nested-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Nested" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Nested Effects Model, Std Dev Chart](#nested-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Nested" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Nested then Crossed Effects Model, Range Chart](#nested-then-crossed-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Nested & Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Nested then Crossed (3 Factors Only)"n ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Nested then Crossed Effects Model, Std Dev Chart](#nested-then-crossed-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Nested & Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Nested then Crossed (3 Factors Only)"n ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

### [EWMA Control Chart](#ewma-control-chart)

**Syntax:** EWMA Control Chart( Y( column ), \<Subgroup( column )>, \<By( column )>, \<Center Data( 1 )> )

**Description:** Creates a chart that plots the exponentially weighted moving averages and a chart that plots either the individual observations or the subgroup means. An EWMA chart is also known as a feedback control chart.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );


```

### [Explore Missing Values](#explore-missing-values)

**Syntax:** Explore Missing Values( Y( columns ) )

**Description:** Find patterns of missing values and conduct imputation.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );


```

### [Explore Outliers](#explore-outliers)

**Syntax:** Explore Outliers( Y( columns ) )

**Description:** Identifies, explores, and manages outliers in univariate or multivariate data.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );


```

### [Explore Patterns](#explore-patterns)

**Syntax:** Explore Patterns( Y( columns ) )

**Description:** Searches for unusual features in the data, including long runs, duplicate long sequences, unusual formatted values, and runs of linear relationships.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );


```

### [Factor Analysis](#factor-analysis)

**Syntax:** Factor Analysis( Y( columns ) )

**Description:** Uncovers the underlying structure of data by extracting unobserved variables, or factors, that represent the common variability across observed variables. Factor rotation is used to increase their interpretability.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);


```

### [Fatigue Model](#fatigue-model)

**Syntax:** Fatigue Model( N( column ), X( column ), \<Freq( column )>, \<Censor( column ), Censor Code( value )> )

**Description:** Analyzes fatigue data, also known as S-N curve modeling.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);


```

### [Fit Curve](#fit-curve)

**Syntax:** Fit Curve( Y( column ), X( column ) )

**Description:** Fits a variety of built-in nonlinear models.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

### [Fit Life by X](#fit-life-by-x)

**Syntax:** Fit Life by X( Y( column ), X( column ), Relationship( string ), Distribution( string ), \<Censor( column )> )

**Description:** Analyzes the distribution of time-to-event data parameterized by a single regression factor. Analysis options include accelerated failure models, life distributions across groups, and transformations of regression factors.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);


```

### [Fit Parametric Survival](#fit-parametric-survival)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Parametric Survival" ), Censor( columns ) )

**Description:** Fits a general linear regression model to survival times. These models can be used for survival times that can be expressed as a function of one or more explanatory variables. Takes into account various survival distributions and censoring.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);


```

### [Fit Proportional Hazards](#fit-proportional-hazards)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Proportional Hazard" ), Censor( columns ) )

**Description:** Fits a semiparametric regression model (the Cox proportional hazards model) to assess the effect of explanatory variables on survival times while taking censoring into account.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);


```

### [Formula Depot](#formula-depot)

**Syntax:** Formula Depot

**Description:** A container for prediction models that supports model comparison, profiling, and scoring code generation. The Formula Depot is launched through the analyze menu, Publish commands in modeling platforms, Recode, and the Formula Editor.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];


```

### [Functional Data Explorer](#functional-data-explorer)

**Syntax:** Functional Data Explorer( Y(column), X(column), ID(column) )

**Description:** Fits functional models using a B-Spline, P-Spline, Fourier, or Wavelets basis model. A functional principal components analysis can be performed on the functional model to extract important features from the data. There is also an option to perform functional principal components analysis directly on the data, without fitting a basis function model first.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

### [Gaussian Process](#gaussian-process)

**Syntax:** Gaussian Process( Y( column ), X( columns ) )

**Description:** Models the relationship between a continuous response and one or more continuous predictors as a spline with interpolation.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );


```

### [Graph Builder](#graph-builder)

**Syntax:** Graph Builder( Variables( X(column ), Y( column ), \<Group X( column )>, \<Group Y( column )>, \<Shape( column )>, \<Color( column )>, \<Overlay( column )>, \<Freq( column )> ), \<Elements(...)> ) )

**Description:** Provides an interactive graphical interface that enables you to explore your data. You can drag columns into graph zones to create a variety of graphs including scatterplots, contour plots, bar charts, area charts, box plots, histograms, heat maps, pie charts, treemaps, mosaic plots, and maps.

#### [100% stacked bar chart](#100-stacked-bar-chart)

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// 100% stacked bar chart, custom legend colors
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Age ), Y( :Cholesterol ), Overlay( :Alcohol Use ) ),
    Elements(
        Bar( X, Y, Legend( 55 ), Bar Style( "Stacked" ), Summary Statistic( "% of Factor" ) )
    ),
    SendToReport(
        Dispatch( {}, "Cholesterol", ScaleBox, {Max( 1 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                55,
                Properties( 0, {Fill Color( RGB Color( 0.9, 0.9, 0.9 ) )} ),
                Properties( 1, {Fill Color( RGB Color( 1.0, 0.8, 0.8 ) )} ),
                Properties( 2, {Fill Color( RGB Color( 1.0, 0.6, 0.6 ) )} ),
                Properties( 3, {Fill Color( RGB Color( 1.0, 0.3, 0.3 ) )} )
            )}
        )
    )
);


```

#### [Arrow lines, one per row](#arrow-lines-one-per-row)

```

Open( "$SAMPLE_DATA/Cholesterol.jmp" );
// arrow lines, one per row
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :April AM ),
        X( :April PM, Position( 1 ) ),
        Y( :June AM ),
        Y( :June PM, Position( 1 ) ),
        Overlay( :treatment )
    ),
    Elements(
        Line(
            X( 1 ),
            X( 2 ),
            Y( 1 ),
            Y( 2 ),
            Legend( 8 ),
            Ordering( "Within Row" ),
            Connection( "Arrow" )
        )
    )
);


```

#### [Axis summary table](#axis-summary-table)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// caption axis table
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :sex ), Y( :height ) ),
    Elements(
        Bar( X, Y, Legend( 4 ) ),
        Caption Box(
            X,
            Y,
            Legend( 5 ),
            Summary Statistic( "Mean" ),
            Summary Statistic 2( "N" ),
            Location( "Axis Table" )
        )
    )
);


```

#### [Bar chart and smooth trend line combination](#bar-chart-and-smooth-trend-line-combination)

```

Open( "$SAMPLE_DATA/Spring.jmp" );
// bar chart and smooth trend line combination, left and right y axes
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :April ), Y( :Temp ), Y( :Precip, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 12 ) ),
        Smoother( X, Y( 1 ), Legend( 13 ) ),
        Bar( X, Y( 2 ), Legend( 16 ) )
    ),
    SendToReport(
        Dispatch( {}, "Precip", ScaleBox,
            {Format( "Best", 12 ), Max( 5 ), Inc( 1 ), Minor Ticks( 1 )}
        )
    )
);


```

#### [Binomial proportion confidence interval](#binomial-proportion-confidence-interval)

```

Open( "$SAMPLE_DATA/Bands Data.jmp" );
// binomial proportion confidence interval
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Show Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables( X( :customer ), Y( :Banding? ) ),
    Elements(
        Points( X, Y, Legend( 3 ) ),
        Line Of Fit( X, Y, Legend( 4 ), Means and Std Devs( 1 ) )
    ),
    Local Data Filter(
        Add Filter(
            columns( :customer ),
            Where( :customer == {"MODMAT", "REI", "ROSES", "SHEPLERS", "TARGET"} )
        )
    ),
    SendToReport(
        Dispatch( {}, "Banding?", ScaleBox,
            {Min( -0.07 ), Max( 1.07 ), Label Row( Show Major Grid( 1 ) )}
        )
    )
);


```

#### [Bubble chart with overlaid curves](#bubble-chart-with-overlaid-curves)

```

Open( "$SAMPLE_DATA/SATByYear.jmp" );
// Smooth trend line, variable dot size, overlaid y variables, bubble chart. data filter
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :"% Taking (2004)"n ),
        Y( :SAT Verbal ),
        Y( :SAT Math, Position( 1 ) ),
        Size( :Population )
    ),
    Elements(
        Points( X, Y( 1 ), Y( 2 ), Legend( 7 ) ),
        Smoother( X, Y( 1 ), Y( 2 ), Legend( 8 ), Lambda( 0.45 ) )
    ),
    Local Data Filter( Add Filter( columns( :Year ), Where( :Year == 2004 ) ) ),
    SendToReport(
        Dispatch( {}, "% Taking (2004)", ScaleBox, {Format( "Percent", 12, 0 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 7, Properties( 0, {Marker Size( 6 )} ) )}
        )
    )
);


```

#### [Connected lines with overlaid dots](#connected-lines-with-overlaid-dots)

```

Open( "$SAMPLE_DATA/Time Series/M3C Quarterly Wide Format.jmp" );
// connected lines with overlaid dots, custom markers, nested date axis
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Time ), Y( :N 646 ), Y( :N 647, Position( 1 ) ) ),
    Elements(
        Line( X, Y( 1 ), Y( 2 ), Legend( 10 ) ),
        Points( X, Y( 1 ), Y( 2 ), Legend( 11 ) )
    ),
    SendToReport(
        Dispatch( {}, "Time", ScaleBox,
            {Min( 2515958948 ), Max( 2872394250 ), Interval( "Quarter" ), Inc( 1 ),
            Minor Ticks( 0 ), Label Row Nesting( 2 ), Label Row( 1, Set Font Size( 12 ) )}
        ),
        Dispatch( {}, "N 646", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                10,
                Properties( 0, {Line Label Properties( {Last Label( 1 )} )} ),
                Properties( 1, {Line Label Properties( {Last Label( 1 )} )} )
            ), Legend Model(
                11,
                Base( 0, 0, 0, Item ID( "N 646", 1 ) ),
                Base( 1, 0, 1, Item ID( "N 647", 1 ) ),
                Properties( 0, {Marker( "FilledCircle" )} ),
                Properties( 1, {Marker( "Filled Up Triangle" )} )
            )}
        ),
        Dispatch( {}, "Graph Builder", FrameBox,
            {DispatchSeg(
                Line Seg( "Line (N 646)" ),
                Label Offset( "Last", 45, {2843799627.0183, 6317.56810988166} )
            ), DispatchSeg(
                Line Seg( "Line (N 647)" ),
                Label Offset( "Last", 45, {2857099451.70628, 4518.71614237549} )
            )}
        )
    )
);


```

#### [Contour plot and scatter plot points](#contour-plot-and-scatter-plot-points)

```

Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
// contour plot and scatter plot points, smoothing, alpha shapes for non-convex hull
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Labor ), Y( :Capital ), Color( :Difference ) ),
    Elements(
        Contour(
            X,
            Y,
            Legend( 9 ),
            Boundary( 0 ),
            Number of Levels( 7 ),
            Alpha( 5 ),
            Smoothness( 0.2 )
        ),
        Points( X, Y, Color( 0 ), Legend( 10 ) )
    )
);


```

#### [Coplot-style trellis grouping](#coplot-style-trellis-grouping)

```

Open( "$SAMPLE_DATA/Design Experiment/Algorithm Data.jmp" );
// coplot style grouping using continuous grouping variables, smoother and scatter plot
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Alpha, Levels( 2 ) ),
        Y( :CPU Time ),
        Group X( :Beta, Levels( 2 ) ),
        Group Y( :Gamma, Levels( 2 ) ),
        Overlay( :Algorithm )
    ),
    Elements( Points( X, Y, Legend( 29 ) ), Smoother( X, Y, Legend( 30 ), Lambda( 0.25 ) ) )
);


```

#### [Independent charts using BY variable](#independent-charts-using-by-variable)

```

Open( "$SAMPLE_DATA/Financial.jmp" );
// by variable creates multiple Graph Builder instances
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :"Assets($Mil.)"n ), Y( :"Stockholder's Eq($Mil.)"n ), ),
    Elements( Points( X, Y, Legend( 17 ) ), Smoother( X, Y, Legend( 18 ) ) ),
    By( :Type )
);


```

#### [Left and right y axes](#left-and-right-y-axes)

```

Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
// left and right y axes sharing a graph, overlaid lines
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Time ), Y( :pH ), Y( :Tank Level, Position( 1 ), Side( "Right" ) ) ),
    Elements( Line( X, Y( 1 ), Legend( 41 ) ), Line( X, Y( 2 ), Legend( 46 ) ) ),
    SendToReport( Dispatch( {}, "Time", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ) )
);


```

#### [Line with custom band interval](#line-with-custom-band-interval)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// range area, custom interval, overlaid line, transparency
Graph Builder(
    Transform Column(
        "Quantile...=0.75[height][age]",
        Formula( Col Quantile( :height, 0.75, :age, :"@Exclude"n, :"@Filter"n ) )
    ),
    Transform Column(
        "Quantile...=0.25[height][age]",
        Formula( Col Quantile( :height, 0.25, :age, :"@Exclude"n, :"@Filter"n ) )
    ),
    Show Control Panel( 0 ),
    Variables(
        X( :age ),
        Y( :height ),
        Y( :"Quantile...=0.25[height][age]"n, Position( 1 ) ),
        Y( :"Quantile...=0.75[height][age]"n, Position( 1 ) )
    ),
    Elements(
        Area( X, Y( 2 ), Y( 3 ), Legend( 5 ), Area Style( "Range" ) ),
        Line( X, Y( 1 ), Legend( 6 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Level Name( 0, "IQR" ),
                Properties( 0, {Transparency( 0.33 )} )
            )}
        ),
        Dispatch( {}, "400", LegendBox, {Set Title( "" )} )
    )
);


```

#### [Linear regression panels](#linear-regression-panels)

```

Open( "$SAMPLE_DATA/Financial.jmp" );
// line of fit, regression, small multiples, custom group color, custom graph spacing
Graph Builder(
    Show Control Panel( 0 ),
    Grid Color( "Medium Light Gray" ),
    Grid Transparency( 0.25 ),
    Title Fill Color( "Medium Light Gray" ),
    Title Frame Color( "Medium Light Gray" ),
    Level Fill Color( {217, 217, 217} ),
    Level Frame Color( "Medium Light Gray" ),
    Level Spacing Color( "Medium Light Gray" ),
    Graph Spacing( 10 ),
    Variables( X( :"Assets($Mil.)"n ), Y( :"Stockholder's Eq($Mil.)"n ), Wrap( :Type ) ),
    Elements( Points( X, Y, Legend( 17 ) ), Line Of Fit( X, Y, Legend( 19 ) ) ),
    Local Data Filter(
        Add Filter( columns( :"Assets($Mil.)"n ), Where( :"Assets($Mil.)"n <= 60941 ) )
    )
);


```

#### [Mediterranean equal-area choropleth](#mediterranean-equal-area-choropleth)

```

Open( "$SAMPLE_DATA/World Demographics.jmp" );
// Mediterranean map, choropleth, equal area projection, grid lines
Graph Builder(
    Size( 1094, 586 ),
    Show Control Panel( 0 ),
    Variables( Color( :Total Median Age ), Shape( :Territory ) ),
    Elements( Map Shapes( Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "", ScaleBox,
            {Format( "Longitude DDD", "PUNDIR", 16 ), Min( -14.2917884823647 ),
            Max( 64.9684846475565 ), Inc( 20 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "", ScaleBox( 2 ),
            {Format( "Latitude DDD", "PUNDIR", 16 ), Min( 21.8020806509188 ),
            Max( 61.3932495299748 ), Inc( 10 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        )
    )
);


```

#### [Multiple x axes](#multiple-x-axes)

```

Open( "$SAMPLE_DATA/Design Experiment/Algorithm Data.jmp" );
// mutiple x variables in separate panels, smoother with confidence intervals and scatter plot
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Alpha ), X( :Beta ), X( :Gamma ), Y( :CPU Time ), Overlay( :Algorithm ) ),
    Elements(
        Position( 1, 1 ),
        Points( X, Y, Legend( 39 ) ),
        Smoother( X, Y, Legend( 40 ), Lambda( 1.5 ), Confidence of Fit( 1 ) )
    ),
    Elements(
        Position( 2, 1 ),
        Points( X, Y, Legend( 41 ) ),
        Smoother( X, Y, Legend( 42 ), Lambda( 1.5 ), Confidence of Fit( 1 ) )
    ),
    Elements(
        Position( 3, 1 ),
        Points( X, Y, Legend( 43 ) ),
        Smoother( X, Y, Legend( 44 ), Lambda( 1.5 ), Confidence of Fit( 1 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 40, Properties( 2, {Line Color( RGB Color( 0.4, 0.4, 0.4 ) )} ) )}
        )
    )
);


```

#### [Napoleon's March flow diagram](#napoleons-march-flow-diagram)

```

Open( "$SAMPLE_DATA/Napoleons March.jmp" );
// flow diagram
Graph Builder(
    Show Control Panel( 0 ),
    Show X Axis( 0 ),
    Show Y Axis( 0 ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables(
        X( :Longitude ),
        Y( :Latitude ),
        Overlay( :Group ),
        Color( :Direction ),
        Size( :Army Size )
    ),
    Elements(
        Line( X, Y, Legend( 3 ), Ordering( "Row Order" ), Missing Values( "No Connection" ) )
    ),
    SendToReport(
        Dispatch( {}, "Longitude", ScaleBox,
            {Min( 26.71 ), Max( 34.9 ), Inc( 2.5 ), Minor Ticks( 0 ),
            Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "Latitude", ScaleBox,
            {Min( 53.32 ), Max( 56.61 ), Inc( 0.5 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                3,
                Properties( 0, {Line Width( 10 )} ),
                Properties( 1, {RGB Color( 1, 0.69, 0.49 )} ),
                Properties( 2, {RGB Color( 0.47, 0.47, 0.47 )} )
            )}
        ),
        Dispatch( {}, "graph title", TextEditBox,
            {Set Text( "Napoleon's March to Moscow" )}
        ),
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Images( "Detailed Earth", Transparency( 0.75 ) ) )}
        )
    )
);


```

#### [Overlaid bivariate kernel density contours](#overlaid-bivariate-kernel-density-contours)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// overlaid bivariate kernel density contour
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Culmen Depth ), Y( :Culmen Length ), Overlay( :Species ) ),
    Elements(
        Contour( X, Y, Legend( 6 ), Line( 1 ), Number of Levels( 5 ), Smoothness( 0.2174 ) )
    )
);


```

#### [Overlaid empirical cumulative distribution function curves](#overlaid-empirical-cumulative-distribution-function-curves)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// CDF, empirical cumulative distribution function
Graph Builder(
    Transform Column(
        "Rank[Culmen Length]@Overlay",
        Formula(
            Col Rank( :Culmen Length, :"@Exclude"n, :"@Filter"n, :"@Graph"n, :"@Overlay"n )
             / Col Number(
                :Culmen Length,
                :"@Exclude"n,
                :"@Filter"n,
                :"@Graph"n,
                :"@Overlay"n
            )
        )
    ),
    Show Control Panel( 0 ),
    Legend Position( "Inside Bottom Right" ),
    Show Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables(
        X( :Culmen Length ),
        Y( :"Rank[Culmen Length]@Overlay"n ),
        Overlay( :Species )
    ),
    Elements( Line( X, Y, Legend( 15 ), Connection( "Step" ) ) ),
    SendToReport(
        Dispatch( {}, "Rank[Culmen Length]@Overlay", ScaleBox, {Max( 1.0117745954803 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                15,
                Level Name( 0, "Adelie" ),
                Level Name( 1, "Chinstrap" ),
                Level Name( 2, "Gentoo" )
            )}
        )
    )
);


```

#### [Panels with unaligned y axes](#panels-with-unaligned-y-axes)

```

Open( "$SAMPLE_DATA/US Regional Population.jmp" );
// panels with unaligned y axes
Graph Builder(
    Transform Column( "Transform[Year]", Continuous, Formula( Num( :Year ) ) ),
    Show Control Panel( 0 ),
    Extend Axis to Zero( 10 ),
    Link Page Axes( "X Only" ),
    Replicate Linked Page Axes( 0 ),
    Variables(
        X( :"Transform[Year]"n ),
        Y( :Population ),
        Page( :Region, Levels per Row( 3 ) )
    ),
    Elements( Points( X, Y, Legend( 3 ) ), Smoother( X, Y, Legend( 4 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :Region ),
            Where(
                :Region == {"AR,LA,OK,TX", "Great Lakes", "KY,TN,AL,MS", "Midwest",
                "Mountain", "New England", "NY,NJ,PA", "Pacific", "South Atlantic"}
            )
        )
    ),
    SendToReport(
        Dispatch( {}, "Population", ScaleBox, {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 2 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 3 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 4 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 5 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 6 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 7 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 8 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 9 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 10 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Transform[Year]", TextEditBox, {Set Text( "Year" )} ),
        Dispatch( {}, "Transform[Year]", Text Edit Box( 2 ), {Set Text( "Year" )} ),
        Dispatch( {}, "Transform[Year]", Text Edit Box( 3 ), {Set Text( "Year" )} )
    )
);


```

#### [Parallel y axes, overlaid lines](#parallel-y-axes-overlaid-lines)

```

Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
// parallel y axes, multiple y scales sharing a graph, overlaid lines
Graph Builder(
    Show Control Panel( 0 ),
    Parallel Axes( "Y Only" ),
    Variables(
        X( :Time ),
        Y( :Temp ),
        Y( :NH3 Feed ),
        Y( :Air ),
        Y( :Tank Level ),
        Y( :pH )
    ),
    Elements( Position( 1, 1 ), Line( X, Y, Legend( 37 ) ) ),
    Elements( Position( 1, 2 ), Line( X, Y, Legend( 39 ) ) ),
    Elements( Position( 1, 3 ), Line( X, Y, Legend( 40 ) ) ),
    Elements( Position( 1, 4 ), Line( X, Y, Legend( 41 ) ) ),
    Elements( Position( 1, 5 ), Line( X, Y, Legend( 42 ) ) ),
    SendToReport( Dispatch( {}, "Time", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ) )
);


```

#### [Points and smoother](#points-and-smoother)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);


```

#### [Scatter plot with marginal box plots](#scatter-plot-with-marginal-box-plots)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// scatter plot with marginal box plots, custom graph sizes
Graph Builder(
    Transform Column( "dummy1", Nominal, Formula( 1 ) ),
    Transform Column( "dummy2", Nominal, Formula( 1 ) ),
    Show Control Panel( 0 ),
    Variables(
        X( :Delta 13 C ),
        X( :dummy1 ),
        Y( :dummy2 ),
        Y( :Delta 15 N ),
        Color( :Sex ),
        Size( :Body Mass )
    ),
    Relative Sizes( "X", [100 10] ),
    Relative Sizes( "Y", [10 100] ),
    Elements( Position( 1, 1 ), Box Plot( X, Y, Color( 0 ), Size( 0 ), Legend( 12 ) ) ),
    Elements( Position( 1, 2 ), Points( X, Y, Legend( 4 ) ) ),
    Elements( Position( 2, 1 ) ),
    Elements( Position( 2, 2 ), Box Plot( X, Y, Color( 0 ), Size( 0 ), Legend( 13 ) ) ),
    SendToReport(
        Dispatch( {}, "dummy1", ScaleBox, {Label Row( Show Major Labels( 0 ) )} ),
        Dispatch( {}, "dummy2", ScaleBox, {Label Row( Show Major Labels( 0 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                4,
                Properties( 1, {Transparency( 0.75 )} ),
                Properties( 2, {Transparency( 0.75 )} )
            )}
        ),
        Dispatch( {}, "dummy1", TextEditBox, {Set Text( "" )} ),
        Dispatch( {}, "dummy2", TextEditBox, {Set Text( "" )} ),
        Dispatch( {}, "400", LegendBox,
            {Legend Position( {12, [1, -3], 4, [0, 3, 4], 13, [2, -3]} )}
        )
    )
);


```

#### [Variability chart](#variability-chart)

```

Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
// variability chart, mean and range interval, nested axis
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Operator ), X( :Part, Position( 1 ) ), Y( :Y ) ),
    Elements(
        Points(
            X( 1 ),
            X( 2 ),
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Range" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Operator", ScaleBox, {Label Row( 2, Show Major Grid( 1 ) )} )
    )
);


```

#### [Violin plots with quartiles](#violin-plots-with-quartiles)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// violin plots, overlaid median line and quartile intervals
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ) ),
    Elements(
        Contour( X, Y, Legend( 3 ) ),
        Bar(
            X,
            Y,
            Legend( 4 ),
            Bar Style( "Float" ),
            Summary Statistic( "Median" ),
            Error Interval( "Interquartile Range" )
        )
    )
);


```

#### [Wafer map](#wafer-map)

```

Open( "$SAMPLE_DATA/Wafer Stacked.jmp" );
// wafer map, heat map, trellis, wrap arrangement
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :X_Die ), Y( :Y_Die ), Wrap( :Wafer ), Color( :Defects ) ),
    Elements( Heatmap( X, Y, Legend( 8 ) ) ),
    SendToReport(
        Dispatch( {}, "X_Die", ScaleBox, {Minor Ticks( 9 )} ),
        Dispatch( {}, "Y_Die", ScaleBox, {Minor Ticks( 9 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                8,
                Properties( 0, {gradient( {Color Theme( "White to Orange" )} )} )
            )}
        )
    )
);


```

### [Hierarchical Cluster](#hierarchical-cluster)

**Syntax:** Hierarchical Cluster( Y( columns ) )

**Description:** Clusters rows based on continuous or categorical variables. Hierarchical clustering begins by treating each row as its own cluster, then successively combining two clusters at a time.

```

dt = Open( "$SAMPLE_DATA/Birth Death Subset.jmp" );
obj = dt << Hierarchical Cluster( Y( :birth, :death ), Label( :country ) );


```

### [Item Analysis](#item-analysis)

**Syntax:** Item Analysis( Y( columns ) )

**Description:** Relates a trait or ability to an individual's probability of endorsing or correctly responding to an item.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );


```

### [K Means Cluster](#k-means-cluster)

**Syntax:** K Means Cluster( Y( column(s) ), Number of Clusters( number ) )

**Description:** Clusters rows based on numeric variables in data tables with up to millions of rows. You must specify the number of clusters in advance.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

### [K Nearest Neighbors](#k-nearest-neighbors)

**Syntax:** K Nearest Neighbors(Y( column ), X( columns ))

**Description:** Predicts a continuous or categorical response based on the responses of the k nearest neighbors in the space of the X variables.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);


```

### [Latent Class Analysis](#latent-class-analysis)

**Syntax:** Latent Class Analysis( Y( column(s) ), Number of Clusters( number ) )

**Description:** Clusters rows based on categorical variables using multinomial mixtures. You must specify the number of latent classes (clusters) in advance.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);


```

### [Life Distribution](#life-distribution)

**Syntax:** Life Distribution( Y( column(s) ) )

**Description:** Analyzes the distribution of time-to-event data. Can be used for modeling censored data, product lifetime, reliability, and competing causes.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );


```

### [Logistic](#logistic)

**Syntax:** Logistic( Y( columns ), X( columns ) )

**Description:** Models a categorical response with respect to a continuous variable. Analysis methods include logistic regression and ROC curves.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );


```

### [Make Validation Column](#make-validation-column)

**Syntax:** Make Validation Column( \<Stratification Columns(columns)>, \<Grouping Columns(columns)>, \<Cutpoint Column(column)>, \<Cutpoint Batch ID(column)> )

**Description:** Makes a column used to divide the data into training, validation, and test sets.

**Cutpoint Example**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << Make Validation Column(
    Cutpoint Column( :Week of Year ),
    Cutpoint Batch ID( :ID ),
    Training Set( 0.60 ),
    Validation Set( 0.25 ),
    Test Set( 0.15 ),
    New Column Name( "Cutpoint Batch Validation" ),
    Go
);


```

**Stratification Example**

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);


```

### [Manage Limits](#manage-limits)

**Syntax:** Manage Limits( Process Variables( columns ) )

**Description:** Launches utility for managing quality limits for multiple columns at once. You can add, edit, and save limits to column properties.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );


```

### [Marker Admixture](#marker-admixture)

**Syntax:** Marker Admixture( Marker( columns ) )

**Description:** Estimates population admixture for individuals based on marker genotypes.

**JMP Version Added:** 19

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(
        Missing Marker Imputation Method( "Specified" ),
        Estimation Method( "Fixed Parameter" ),
        Unthreaded( 1 ),
        Imputation Value( 1 ),
        Number of Ancestral Populations( 3 )
    ),
    Fit(
        Missing Marker Imputation Method( "Specified" ),
        Estimation Method( "Fixed Parameter" ),
        Unthreaded( 1 ),
        Imputation Value( 1 ),
        Number of Ancestral Populations( 3 )
    )
);


```

### [Marker Imputation](#marker-imputation)

**Syntax:** Marker Imputation( Marker( columns ) )

**Description:** Imputes numeric missing marker genotypes.

**JMP Version Added:** 19

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
obj = dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 0 ),
    Method( "Specified" ),
    Imputation Value( 1 )
);


```

### [Marker Relatedness](#marker-relatedness)

**Syntax:** Marker Relatedness( Marker( columns ) )

**Description:** Estimates several types of genomic relationship measures between pairs of individuals based genetic markers in both diploid and polyploid organisms.

**JMP Version Added:** 18

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
obj = dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE On" ),
    Kinship Type( "Identical by State" )
);


```

### [Marker Simulation](#marker-simulation)

**Syntax:** Marker Simulation( Marker( columns ), Predictor Formula( columns ) )

**Description:** Simulates marker genotypes from parental crosses and computes related measures of breeding performance.

**JMP Version Added:** 17

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
obj = dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Marker Statistics](#marker-statistics)

**Syntax:** Marker Statistics( Marker( columns ), With Marker( columns ) )

**Description:** Performs analysis on genetic marker data to compute measures such as minor allele frequency, Hardy-Weinberg equilibrium, and linkage disequilibrium.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 )
);


```

### [Matched Pairs](#matched-pairs)

**Syntax:** Matched Pairs( Y( columns ), X( column ) )

**Description:** Compares the means of matched sets of variables using paired t tests or simple repeated measures analysis to account for correlation between responses.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );


```

### [MaxDiff](#maxdiff)

**Syntax:** MaxDiff( Profile DataTable( data table ), Profile ID( column ), Profile Effects( column(s) ), \<Response Data Table( data table )>, \<Subject Data Table( data table )>, \<Response Profile ID Chosen( column )>, \<Response Subject ID( column)>, \<Response Grouping( column(s) )>, \<Response Profile ID Choices( column(s) )>, \<Profile Grouping( column(s) )>, \<Subject Subject ID( column )>, \<Subject Effects( column(s) )> )

**Description:** Creates a design to find the combination of product attributes that customers most prefer and least prefer.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Mixture Profiler](#mixture-profiler)

**Syntax:** Mixture Profiler( Y( column1, column2, ... ) )

**Description:** Produces an interactive ternary plot that enables you to explore the contours of the saved prediction formulas for mixture models with three or more factors.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );


```

### [Model Comparison](#model-comparison)

**Syntax:** Model Comparison( Predictors( columns ), Group( column ) )

**Description:** Compares performance across models using prediction formula columns.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();


```

### [Model Driven Multivariate Control Chart](#model-driven-multivariate-control-chart)

**Syntax:** Model Driven Multivariate Control Chart( Process( columns ) )

**Description:** Creates multivariate control charts based on principal components or partial least squares methods.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);


```

### [Model Screening](#model-screening)

**Syntax:** Model Screening( Y( column ), X( columns ) )

**Description:** Fits many different predictive models, so that you can select the best.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);


```

### [Multidimensional Scaling](#multidimensional-scaling)

**Syntax:** Multidimensional Scaling( Y( columns ) )

**Description:** Creates a visual representation of the pattern of proximities among a set of objects.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);


```

### [Multiple Correspondence Analysis](#multiple-correspondence-analysis)

**Syntax:** Multiple Correspondence Analysis( Y( columns ), X( columns ) )

**Description:** Identifies associations between the levels of categorical variables. Multiple Correspondence Analysis is analogous to principal components analysis for categorical data.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );


```

### [Multiple Factor Analysis](#multiple-factor-analysis)

**Syntax:** Multiple Factor Analysis( MFABLocks({"Block 1", columns},{"Block 2", columns}) )

**Description:** Analyzes agreement among panelists in sensory data analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);


```

### [Multivariate](#multivariate)

**Syntax:** Multivariate( Y( columns ) )

**Description:** Explores correlation and associations among numeric variables using a variety of multivariate analysis techniques. These techniques include both parametric and nonparametric measures of association, scatterplot matrices, principal components analysis, outlier analysis, and item reliability.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );


```

### [Multivariate Embedding](#multivariate-embedding)

**Syntax:** Multivariate Embedding( Y( columns ) )

**Description:** Maps data from very high-dimensional spaces to a low-dimensional space, using the Uniform Manifold Approximation and Projection (UMAP) method or the t-Distributed Stochastic Neighbor Embedding (t-SNE) method. Many times, you want to map the data to either two or three dimensions so that the low-dimensional space can be easily visualized. Both methods try to preserve the local structure of the data, but UMAP is generally faster than t-SNE for large data sets.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
/* Parameters can be changed according to data features */
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Maximum Iterations( 1500 ),
    Perplexity( 15 ),
    Initial Principal Component Dimensions( 55 ),
    Random Seed( 2022 ),
    Output Dimensions( 3 )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
/* by group example */
dt << New Column( "_bycol",
    Character,
    Nominal,
    set values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( _bycol )
);


```

### [Naive Bayes](#naive-bayes)

**Syntax:** Naive Bayes( Y( column ), X( columns ), Method( "Naive Bayes" ) )

**Description:** Predicts group membership for a categorical variable based on the closeness of its predictor values to the predictor values for each group.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Neural](#neural)

**Syntax:** Neural( Y( column ), X( columns ), \<Validation( column )> )

**Description:** Predicts one or more response variables using a flexible function of the input variables. The flexible framework incorporates layering and s-shaped functions.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);


```

### [New Table](#new-table)

**Syntax:** dt = New Table( name, \<visibility("private"|"invisible"|"visible")>, \<Enable Filter Views(bool)>, <actions> )

**Description:** Creates a new data table. "Invisible" hides the data table from view but lists it in the JMP Home Window. "Private" hides the table completely. "Visible" is the default, and creates a normal table that is visible and listed in the JMP Home Window. The optional actions arguments are any messages that data tables support.

```

dt = New Table( "Little Class",
    Add Rows( 3 ),
    New Column( "name", Character, Nominal, Set Values( {"KATIE", "LOUISE", "JANE"} ) ),
    New Column( "height", Continuous, Set Values( [59, 61, 55] ) )
);


```

### [Nonlinear](#nonlinear)

**Syntax:** Nonlinear( Y( column ), X( column with predictor formula ) )

**Description:** Fits nonlinear models using least squares or a custom loss function.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );


```

### [Normal Mixtures](#normal-mixtures)

**Syntax:** Normal Mixtures( Y( column(s) ), Number of Clusters( number ) )

**Description:** Clusters rows based on numeric variables when your data come from a mixture of overlapping multivariate normal distributions. You must specify the number of clusters in advance.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

### [Normalization](#normalization)

**Syntax:** Normalization( Y( columns ) )

**Description:** Adjusts for technical biases and improves suitability for subsequent analysis

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

### [Notebook](#notebook)

**Syntax:** nb = Notebook( name|number )

**Description:** Creates a new notebook, or returns the notebook with the provided name or index.

```


nb = Notebook();


```

### [Oneway](#oneway)

**Syntax:** Oneway( Y( columns ), X( columns ) )

**Description:** Models a continuous response across a set of categorical groups. Analysis methods include ANOVA, means comparisons, analysis of means, and quantile plots.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );


```

### [Open](#open)

**Syntax:** Open( filePath, \<data table options | Excel import options | text import options | SAS import options | HTML import options | esriShapeFile import options | PDF import options | other file options > )

**Description:** Opens a JMP file or imports another supported file type. The open data table option 'Invisible' hides the file from view but lists it in the JMP Home Window, 'Private' hides the file completely. The file option 'Select Columns' reads in only the specified columns, 'Ignore Columns' is the inverse of 'Select Columns', it does not read in the specified columns. The JMP file options 'Column Names Only' and 'Table Info' do not read in the data, nor create a data table. 'Column Names Only' returns the list of the data table's columns names, 'Table Info' returns the number of columns and rows in the data table. The options 'FIRST(n)'/'LAST(n)'/'RANDOM(n)' read in only n rows of the data table. If n is a number between 0 and 1, n is a fraction of the total number of rows in the data table.

**Example 1**

```

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


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", ignore columns( "age" ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", "Column Names Only" );


```

**Example 4**

```

info = Open( "$SAMPLE_DATA/probe.jmp", "Table Info" );
Print( info );


```

**Example 5**

```

info = Open( "$SAMPLE_DATA/SATByYear.jmp", random( 10 ) );
Print( info );


```

**Example 6**

```

info = Open( "$SAMPLE_DATA/SATByYear.jmp", First( 10 ) );
Print( info );


```

### [Parallel Plot](#parallel-plot)

**Syntax:** Parallel Plot( Y( columns ), \<X( column )> )

**Description:** Produces a plot of two or more variables with connecting line segments for each row.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Parallel Plot( Y( :hist0, :hist1, :hist3, :hist5 ) );


```

### [Pareto Plot](#pareto-plot)

**Syntax:** Pareto Plot( Cause( column ), \<X( column )>, \<Subcategory( column )>, \<Freq( column )>, \<Weight( column )> )

**Description:** Displays the relative frequency of items in a quality-related process in decreasing order. You can define one or more classification variables to create a comparative Pareto plot.

#### [Group](#group)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );


```

#### [Simple](#simple)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure Raw Data.jmp" );
obj = dt << Pareto Plot( Cause( :failure ) );


```

#### [Subcategory](#subcategory)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Subcategory( :clean ),
    Freq( :N ),
    Subcategory Bar Style( Stacked )
);


```

### [Partial Least Squares](#partial-least-squares)

**Syntax:** Partial Least Squares( Y( columns ), X( columns ) )

**Description:** Fits a model to one or more response variables using latent factors. This permits models to be fit when explanatory variables are highly correlated, or when there are more explanatory variables than there are observations.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Go
);


```

### [Predictor Screening](#predictor-screening)

**Syntax:** Predictor Screening( Y( columns ), X( columns ) )

**Description:** Identifies significant predictors from a large number of candidates by using bootstrap forest partitioning to evaluate the contribution of the predictors on the response.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );


```

### [Principal Components](#principal-components)

**Syntax:** Principal Components( Y( columns ) )

**Description:** Models the variation in a set of variables in terms of a smaller number of independent linear combinations (principal components) of those variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane )
);


```

### [Process Capability](#process-capability)

**Syntax:** Process Capability( Process Variables (columns), < Spec Limits() > )

**Description:** Computes a process capability analysis for each process and creates graphs useful for analyzing the capability of multiple processes at one time. Specification limits can also be defined.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);


```

### [Process History Explorer](#process-history-explorer)

**Syntax:** Process History Explorer( Y( columns ),ID( columns), X( columns ), Step( columns ), Timestamp( columns ) )

**Description:** Identifies process steps associated with poor yield.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

### [Process Screening](#process-screening)

**Syntax:** Process Screening( Process Variables( columns ) )

**Description:** Examines many processes from several perspectives, including stability, capability, control chart tests, and shift (drift). Assists with the ability to focus on which processes need attention.

#### [Screen Count Processes with Alarm Graph for Environmental Monitoring](#screen-count-processes-with-alarm-graph-for-environmental-monitoring)

```


dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Alarm Graph( 1 ),
    Show Charts as Selected( 1 ),
    Select Where( Action >= 1 )
);


```

#### [Screen Many Processes with Grouping Column](#screen-many-processes-with-grouping-column)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Grouping( :Site )
);


```

#### [Screen Many Processes with Individual-and-Moving-Range Control Chart Metrics](#screen-many-processes-with-individual-and-moving-range-control-chart-metrics)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);


```

#### [Screen Many Processes with XBar-and-R Control Chart Metrics](#screen-many-processes-with-xbar-and-r-control-chart-metrics)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "XBar and R" )
);


```

#### [Screen Many Processes with XBar-and-S Control Chart Metrics](#screen-many-processes-with-xbar-and-s-control-chart-metrics)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Subgroup( :wafer ),
    Control Chart Type( "XBar and S" )
);


```

#### [Screen Nonnegative Continuous Data for Environmental Monitoring](#screen-nonnegative-continuous-data-for-environmental-monitoring)

```


dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Nonnegative Continuous" ),
    Time( :Time ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Alarm Graph( 1 ),
    Show Charts as Selected( 1 )
);


```

#### [Screen Process with a 3-Way Chart (XBar-MR-and-R)](#screen-process-with-a-3-way-chart-xbar-mr-and-r)

```


dt = Open( "$Sample_Data/Quality Control/Vial Fill Weights.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fill Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar MR and R" ),
    Moving Range Limit Exceeded( 1 ),
    Chart Options as Selected( Dispersion Chart( 1 ) ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] )
);


```

#### [Screen Process with a 3-Way Chart (XBar-MR-and-S)](#screen-process-with-a-3-way-chart-xbar-mr-and-s)

```


dt = Open( "$Sample_Data/Quality Control/Vial Fill Weights.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fill Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar MR and S" ),
    Moving Range Limit Exceeded( 1 ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] )
);


```

#### [Screen Process with a Proportion Chart](#screen-process-with-a-proportion-chart)

```


dt = Open( "$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp" );
obj = dt << Process Screening(
    Process Variables( :N Defective ),
    Control Chart Type( "Proportion" ),
    n Trials( :N Units ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] )
);


```

#### [Screen Processes to Show Control Charts for Selected Processes](#screen-processes-to-show-control-charts-for-selected-processes)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    Show Charts as Selected( 1 ),
    Select Where( Alarm Rate > 0.006 ),     // what selects in the table
    Filter Where( Alarm Rate > 0.005 )  // what shows in the table
);


```

#### [Screen Processes with Capability Goal Plot](#screen-processes-with-capability-goal-plot)

```



dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Goal Plot( 1 )
);


```

#### [Screen Processes with Process Performance Graph](#screen-processes-with-process-performance-graph)

```



dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Process Performance Graph( 1 )
);


```

#### [Screen Processes with Process Potential Graph](#screen-processes-with-process-potential-graph)

```


dt = Open( "$Sample_Data/Quality Control/Coating.jmp" );
Column( "Weight" ) << Set Property(
    "Process Screening",
    {Centerline( 20.5 ), Specified Sigma( 1.5 ), Measurement Sigma( .8 )}
);
Column( "Weight" ) << Set Property( "Spec Limits", {LSL( 17 ), USL( 24 )} );
obj = dt << Process Screening(
    Process Variables( :Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar and R" ),
    Out of Spec Count( 0 ),
    Out of Spec Rate( 0 ),
    Latest Out of Spec( 0 ),
    Process Potential Graph( 1 )
);


```

#### [Screen Processes with Shift Detection](#screen-processes-with-shift-detection)

```


dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Current.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure ),
    Control Chart Type( "Indiv and MR" ),
    Shift Graph( 1 ),
    Show Charts as Selected( 1 ),
    Select Where( Stability Index > 2 )
);


```

#### [Screen Processes with Specification Limits in a Separate Table](#screen-processes-with-specification-limits-in-a-separate-table)

```


dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    )
);


```

### [Profiler](#profiler)

**Syntax:** Profiler( Y( column1, <column2>, ..., \<PredSE column1, PredSE column2>, ... ), <Expand> )

**Description:** Produces an interactive graph that enables you to explore how a predicted response changes as you change factor settings. For each factor, the profiler shows prediction traces that are based on saved predictions formulas and linear constraints and illustrate how the response changes with respect to that factor. The Expand argument corresponds to the Expand Intermediate Formulas option in the launch window.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);


```

**Example 2**

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
colNum = N Items( dt << Get Column Names );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Screening" ),
    Run()
);
obj << Save Columns( Prediction Formula( 1 ), StdErr Pred Formula( 1 ) );
obj << Close Window( 1 );
predCol = Column( dt, colNum + 1 );
stderrCol = Column( dt, colNum + 2 );
dt << Profiler(
    Y( predCol, stderrCol ),
    Profiler( 1, Confidence Intervals( 1 ), ),
    Use SE Formula( 1 )
);


```

**Example 3**

```

dt = Open( "$Sample_Data/Stochastic Optimization.jmp" );
dt << Profiler( Y( :Yield ), Profiler( 1, Desirability Functions( 1 ), ), Expand );


```

### [Recurrence Analysis](#recurrence-analysis)

**Syntax:** Recurrence Analysis( Y( column ), Cost( column ), Label( column ), \<Grouping( column )> )

**Description:** Analyzes how a recurring event is distributed over time, per system, or until the system goes out of service.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Reliability Forecast](#reliability-forecast)

**Syntax:** Reliability Forecast

**Description:** Predicts future failures based on observed data and future units at risk. The platform accepts several input formats. See each format for specification details.

#### [Dates Format](#dates-format)

```


dt1 = Open( "$SAMPLE_DATA/Reliability/Small Production part1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Reliability/Small Production part2.jmp" );

obj = dt1 << Reliability Forecast(
    Input Format( Dates ),
    Production Data Table(
        dt1,
        Production Count( :Sold Quantity ),
        Timestamp( :Sold Month )
    ),
    Failure Data Table(
        dt2,
        Failure Time( :Return Month ),
        Timestamp( :Sold Month ),
        Failure Count( :Return Quantity )
    ),
    Life Time Unit( Month ),
    Show Legend( 1 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group( "" ),
        Risk Set( [2550, 2600, 2650, 2700, 2750, 2800, 2850] ),
        Future Risk Set(
            [3082.5, 3052.5, 3367.5, 3952.5, 3667, 3667],
            [3347740800, 3350160000, 3352579200, 3355257600, 3357849600, 3360528000]
        ),
        Forecast To( "02/2011" ),
        Distribution( Weibull ),
        Contract( 6, Month ),
        Forecast Type( Sequential ),
        Interval Type( Prediction Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 1 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

#### [Nevada Format](#nevada-format)

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

#### [Time to Event Format](#time-to-event-format)

```


dt = Open( "$SAMPLE_DATA/Reliability/Small Production Time to Event.jmp" );
obj = dt << Reliability Forecast(
    Input Format( Time to Event ),
    Time to Event( :"Time (Month)"n, :Time Right ),
    Freq( :Freq ),
    Life Time Unit( Month ),
    Forecast Start( Informat( "03/01/2010", "Locale Date" ) ),
    Forecast(
        Group( "" ),
        Future Risk Set( [33, 33, 33], [3352924800, 3355516800, 3358195200] ),
        Forecast To( "09/01/2010" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( [1] ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( 0 ),
        Use Approximate Distribution( 1 )
    )
);


```

### [Reliability Growth](#reliability-growth)

**Syntax:** obj = Reliability Growth( Input Format( Time to Event ), Time to Event( column, <column> ), \<Event Count( column )>, \<Phase( column )> ); obj = Reliability Growth( Input Format( Dates ), Timestamp( column, <column> ), \<Event Count( column )>, \<Phase( column )> ); obj = Reliability Growth( Input Format( Concurrent Systems ), Time to Event( column, column, ... ), System ID( column ), \<Phase( column )> ) obj = Reliability Growth( Input Format( Parallel Systems ), Time to Event( column, column, ... ), \<Event Count( column )>, System ID( column ), \<Phase( column )> )

**Description:** Models the change in reliability of a single repairable system over time as improvements are incorporated into its design. The platform accepts several input formats. See each format for specification details.

#### [Concurrent Systems](#concurrent-systems)

```

dt = Open( "$SAMPLE_DATA/Reliability/Concurrent Systems.jmp" );
obj = dt << Reliability Growth(
    Input Format( Concurrent Systems ),
    Time to Event( :Prototype 1, :Prototype 2 ),
    System ID( :Failed System ),

);
obj << Crow AMSAA;


```

#### [Dates](#dates)

```

dt = Open( "$SAMPLE_DATA/Reliability/BrakeReliability.jmp" );
obj = dt << Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes )
);


```

#### [Parallel Systems](#parallel-systems)

```

dt = Open( "$SAMPLE_DATA/Reliability/Parallel Systems Multiple Phases.jmp" );
obj = dt << Reliability Growth(
    Input Format( Parallel Systems ),
    Time to Event( :Hours ),
    Event Count( :Fixes ),
    System ID( :System ID ),
    Phase( :Phase )
);
obj << Piecewise Weibull NHPP with Different Intercepts;


```

#### [Time to Event](#time-to-event)

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;


```

### [Repeated Measures Degradation](#repeated-measures-degradation)

**Syntax:** Repeated Measures Degradation( Y( column ), Time( column ), \<X( column )>, \<Freq( column )>, \<Censor( column ), Censor Code( value )> )

**Description:** Models repeated measures degradation data over time with random parameters.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [Response Screening](#response-screening)

**Syntax:** Response Screening( Y( columns ), X( columns ) )

**Description:** Automates the process of conducting tests for linear model effects across a large number of responses. Test results and summary statistics are presented in data tables and plots. The false discovery rate (FDR) guards against incorrect declarations of significance. A robust estimation method reduces the sensitivity of tests to outliers.

#### [Response Screening in subgroups with volcano plot selected](#response-screening-in-subgroups-with-volcano-plot-selected)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( :Trait1, :Trait2, :Trait3, :Trait4 ),
    X( :Father, :Mother, :Sex, :Disease Status ),
    Subgroup( Column Group( "Markers" ) ),
    Common Y Scale( 1 ),
    SendToReport( Dispatch( {}, "", TabListBox, {Set Selected( 4 )} ) )
);


```

#### [Response Screening of 4 Responses and 26 Prospective Predictors](#response-screening-of-4-responses-and-26-prospective-predictors)

```


dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Response Screening( Y( :ls, :ha, :dt ), X( Column Group( "Intensities" ) ) );


```

#### [Response Screening of Many Columns in Groups](#response-screening-of-many-columns-in-groups)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Markers" ) ),
    X( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Grouping( "Sex" )
);


```

#### [Response Screening of Many Columns on Each of Four Predictors](#response-screening-of-many-columns-on-each-of-four-predictors)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Markers" ) ),
    X( :Trait1, :Trait2, :Trait3, :Trait4 )
);


```

#### [Response Screening of Many Columns with Means Differences Volcano Plot](#response-screening-of-many-columns-with-means-differences-volcano-plot)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Markers" ) ),
    X( :Father, :Mother, :Sex, :Disease Status ),
    Common Y Scale( 1 ),
    Volcano Plots Use FDR Axis( 1 ),
    SendToReport(
        Dispatch( {}, "", TabListBox( 1 ), {Set Selected( 4 )} ),
        Dispatch( {}, "", TabListBox( 2 ), {Set Selected( 2 )} )
    )
);


```

#### [Response Screening Specified with Column Numbers](#response-screening-specified-with-column-numbers)

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );


```

#### [Response Screening with Robust Fitting](#response-screening-with-robust-fitting)

```


dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Responses" ) ),
    X( :Process ),
    Robust( 1 )
);


```

### [Scatterplot 3D](#scatterplot-3d)

**Syntax:** Scatterplot 3D( Y( columns ) )

**Description:** Produces a rotating three-dimensional scatterplot for three or more variables. If you specify more than three variables, you can cycle through which variables are shown in the scatterplot.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** Scatterplot Matrix( Y( columns ), \<X( columns )>, \<Group( column )>, \<By( column )> )

**Description:** Produces a grid of scatterplots that enables you to explore bivariate relationships. If no X variables are specified, the scatterplots are for all pairs of the Y variables. If one or more X variables are specified, the scatterplots are for the Y variables plotted against the X variables.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Structural Equation Models](#structural-equation-models)

**Syntax:** Structural Equation Models( Model Variables ( columns ) )

**Description:** Provides a framework to fit a variety of models, including confirmatory factor analysis, path models with or without latent variables, measurement error models, and latent growth curve models.

**JMP Version Added:** 15

#### [Confirmatory Factor Analysis](#confirmatory-factor-analysis)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);


```

#### [Higher Order Confirmatory Factor Analysis](#higher-order-confirmatory-factor-analysis)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables(
        :Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C, :Inter_C, :General_S,
        :Growth_S, :Coworker_S, :Supervisor_S
    ),
    Fit(
        Model Name( "Higher Order CFA" ),
        New Latent( "Leadership", "Conflict", "Satisfaction", "General" ),
        Means(
            {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C,
            :Inter_C, :General_S, :Growth_S, :Coworker_S, :Supervisor_S}}
        ),
        Loadings(
            {"Leadership", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}},
            {"Conflict", {:Person_C, :Intra_C, :Inter_C}, {1}},
            {"Satisfaction", {:General_S, :Growth_S, :Coworker_S, :Supervisor_S}, {1}},
            {"General", {"Leadership", "Conflict", "Satisfaction"}, {1}}
        ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {:Person_C, {:Person_C}},
            {:Intra_C, {:Intra_C}},
            {:Inter_C, {:Inter_C}},
            {:General_S, {:General_S}},
            {:Growth_S, {:Growth_S}},
            {:Coworker_S, {:Coworker_S}},
            {:Supervisor_S, {:Supervisor_S}},
            {"Leadership", {"Leadership"}},
            {"Conflict", {"Conflict"}},
            {"Satisfaction", {"Satisfaction"}},
            {"General", {"General"}}
        )
    )
);


```

#### [Linear Latent Growth Curve Model](#linear-latent-growth-curve-model)

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Linear Growth Curve Model" ),
        New Latent( "Intercept", "Slope" ),
        Means( {"Constant", {"Intercept", "Slope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}, {"b1"}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}, {"b1"}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}, {"b1"}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}, {"b1"}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}}
        ),
        Covariances( {"Intercept", {"Slope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);


```

#### [Multiple Linear Regression with SEM](#multiple-linear-regression-with-sem)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables( :Satisfaction_Avg, :Support_L, :Goal_L, :Work_L ),
    Fit(
        Model Name( "Multiple Regression" ),
        Means( {"Constant", {:Satisfaction_Avg, :Support_L, :Goal_L, :Work_L}} ),
        Regressions(
            {:Support_L, {:Satisfaction_Avg}},
            {:Goal_L, {:Satisfaction_Avg}},
            {:Work_L, {:Satisfaction_Avg}}
        ),
        Variances(
            {:Satisfaction_Avg, {:Satisfaction_Avg}},
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}}
        ),
        Covariances( {:Support_L, {:Goal_L, :Work_L}}, {:Goal_L, {:Work_L}} ),

    )
);


```

#### [Path Analysis Model](#path-analysis-model)

```

dt = Open( "$SAMPLE_DATA/Online Consumer Data.jmp" );
dt << Structural Equation Models(
    Model Variables( :Privacy, :Reputation, :Trust, :Purchase Int ),
    Fit(
        Model Name( "Path Analysis with Observed Variables" ),
        Means( {"Constant", {:Privacy, :Reputation, :Trust, :Purchase Int}} ),
        Regressions(
            {:Privacy, {:Trust}},
            {:Reputation, {:Trust, :Purchase Int}},
            {:Trust, {:Purchase Int}}
        ),
        Variances(
            {:Privacy, {:Privacy}},
            {:Reputation, {:Reputation}},
            {:Trust, {:Trust}},
            {:Purchase Int, {:Purchase Int}}
        ),
        Covariances( {:Privacy, {:Reputation}} )
    )
);


```

#### [Path Analysis with Latent Variables](#path-analysis-with-latent-variables)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables(
        :Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C, :Inter_C, :General_S,
        :Growth_S, :Coworker_S, :Supervisor_S
    ),
    Fit(
        Model Name( "Path Analysis with Latent Variables" ),
        New Latent( "Leadership", "Conflict", "Satisfaction" ),
        Means(
            {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C,
            :Inter_C, :General_S, :Growth_S, :Coworker_S, :Supervisor_S}}
        ),
        Loadings(
            {"Leadership", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}},
            {"Conflict", {:Person_C, :Intra_C, :Inter_C}, {1}},
            {"Satisfaction", {:General_S, :Growth_S, :Coworker_S, :Supervisor_S}, {1}}
        ),
        Regressions(
            {"Leadership", {"Conflict", "Satisfaction"}},
            {"Conflict", {"Satisfaction"}}
        ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {:Person_C, {:Person_C}},
            {:Intra_C, {:Intra_C}},
            {:Inter_C, {:Inter_C}},
            {:General_S, {:General_S}},
            {:Growth_S, {:Growth_S}},
            {:Coworker_S, {:Coworker_S}},
            {:Supervisor_S, {:Supervisor_S}},
            {"Leadership", {"Leadership"}},
            {"Conflict", {"Conflict"}},
            {"Satisfaction", {"Satisfaction"}}
        )
    )
);


```

#### [Quadratic Latent Growth Curve Model](#quadratic-latent-growth-curve-model)

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Quadratic Growth Model" ),
        New Latent( "Intercept", "Slope", "QuadSlope" ),
        Means( {"Constant", {"Intercept", "Slope", "QuadSlope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}},
            {"QuadSlope", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {0, 1, 4, 9}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}},
            {"QuadSlope", {"QuadSlope"}}
        ),
        Covariances( {"Intercept", {"Slope", "QuadSlope"}}, {"Slope", {"QuadSlope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);


```

#### [Simple Linear Regression with SEM](#simple-linear-regression-with-sem)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Satisfaction_Avg ),
    Fit(
        Model Name( "Simple Regression" ),
        Means( {"Constant", {:Leadership_Avg, :Satisfaction_Avg}} ),
        Regressions( {:Leadership_Avg, {:Satisfaction_Avg}} ),
        Variances(
            {:Leadership_Avg, {:Leadership_Avg}},
            {:Satisfaction_Avg, {:Satisfaction_Avg}}
        )
    )
);


```

#### [Simple Mediation Model](#simple-mediation-model)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg, :Satisfaction_Avg ),
    Fit(
        Model Name( "Mediation Analysis" ),
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg, :Satisfaction_Avg}} ),
        Regressions(
            {:Leadership_Avg, {:Conflict_Avg, :Satisfaction_Avg}},
            {:Conflict_Avg, {:Satisfaction_Avg}}
        ),
        Variances(
            {:Leadership_Avg, {:Leadership_Avg}},
            {:Conflict_Avg, {:Conflict_Avg}},
            {:Satisfaction_Avg, {:Satisfaction_Avg}}
        )
    )
);


```

### [Support Vector Machines](#support-vector-machines)

**Syntax:** Support Vector Machines(Y( column ), X( columns ))

**Description:** Predicts a response based on the support vectors in the space of the X variables. One of the goals of the Support Vector Machines algorithm is to use training data to learn how to classify new data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Surface Plot](#surface-plot)

**Syntax:** Surface Plot( Columns() )

**Description:** Produces a rotating three-dimensional plot of points or a surface defined by a saved formula.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

### [Survival](#survival)

**Syntax:** Survival( Y( columns ), Censor( column ), \<Grouping( column )> )

**Description:** Calculates estimates of survival functions using the product-limit (Kaplan-Meier) method for one or more groups.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );


```

### [Tabulate](#tabulate)

**Syntax:** Tabulate( Add Table( Column Table( Analysis Columns( column(s) )|Grouping Columns( column(s))|Statistics( )), Row Table( Analysis Columns( column(s) )|Grouping Columns( column(s))|Statistics( )) )

**Description:** Creates a custom table of summary statistics of one or more variables. The variables can be grouped by one or more classification columns. Enables you to build the summary table using drag and drop operations.

#### [Categories and stats](#categories-and-stats)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :gender, :goals ), Statistics( N, Column % ) ),
        Row Table( Grouping Columns( :Grade, :Age ) )
    )
);


```

#### [Columns by Categories](#columns-by-categories)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Columns by Categories( :Grades, :Sports, :Looks, :Money ) ) )
);


```

#### [Frequency](#frequency)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Freq( :Count ),
    Add Table( Row Table( Grouping Columns( :Causes ) ) )
);


```

#### [ID column](#id-column)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    ID( :Division ),
    Set Format( Uniform Format( 10, 2 ) ),
    Add Table(
        Column Table(
            Statistics( Sum ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name ) )
    )
);


```

#### [Multiple response grouping columns](#multiple-response-grouping-columns)

```

dt = Open( "$Sample_Data/Consumer Preferences.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :Floss Delimited ), Statistics( N, "% of Total"n ) ),
        Row Table( Grouping Columns( :Frequency of Teeth Cleaning, :Brush Delimited ) )
    )
);


```

#### [Multiple response page column](#multiple-response-page-column)

```

dt = Open( "$Sample_Data/Big Class Families.jmp" );
obj = Tabulate(
    Show Control Panel( 0 ),
    Page Column( :family cars( "Jeep" ) ),
    Add Table(
        Column Table( Analysis Columns( :height ), Statistics( N, "% of Total"n ) ),
        Row Table( Grouping Columns( :sex ) )
    )
);


```

#### [Multiple row and column tables](#multiple-row-and-column-tables)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :gender ) ),
        Column Table( Grouping Columns( :race ) ),
        Row Table( Grouping Columns( :goals ) ),
        Row Table( Grouping Columns( :"Urban/Rural"n ) )
    )
);


```

#### [Multiple row tables](#multiple-row-tables)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Row Table( Grouping Columns( :Grades ) ),
        Row Table( Grouping Columns( :Sports ) ),
        Row Table( Grouping Columns( :Looks ) ),
        Row Table( Grouping Columns( :Money ) )
    )
);


```

#### [Nested categories](#nested-categories)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);


```

#### [Packed columns](#packed-columns)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Statistics( Sum, Max ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name, :Engine ) )
    )
);


```

#### [Page column](#page-column)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Page Column( :Engine( "Gas" ) ),
    Add Table(
        Column Table( Analysis Columns( :City MPG, :Hwy MPG ), Statistics( Max ) ),
        Row Table( Grouping Columns( :Mfr Name ) )
    )
);


```

#### [Stacked grouping columns](#stacked-grouping-columns)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :marital status ),
            Add Aggregate Statistics( :marital status ),
            Analysis Columns( :age ),
            Statistics( Min, Max )
        ),
        Row Table(
            Grouping Columns( :sex, :country, :size ),
            Add Aggregate Statistics( :sex, :country, :size ),
            Stack Grouping Columns( 1 )
        )
    )
);


```

#### [Weight](#weight)

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Weight( :Weight ),
    Add Table(
        Column Table( Analysis Columns( :Horsepower ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Type ) )
    )
);


```

### [Ternary Plot](#ternary-plot)

**Syntax:** Ternary Plot( Y( columns ) )

**Description:** Produces a two-dimensional plot of three mixture components that sum to a constant.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );


```

### [Text Explorer](#text-explorer)

**Syntax:** Text Explorer( Text Columns( columns ) )

**Description:** Parses words from text in a column, counts them, associates them with other columns, saves indicators, and graphs relationships.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );


```

### [Time Series](#time-series)

**Syntax:** Time Series( Y( column ) )

**Description:** Models a series of observations over equally spaced time points. Includes a time series plot, autocorrelations, variogram, spectral density, ARIMA, seasonal ARIMA, smoothing models, and forecasts.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );


```

### [Time Series Forecast](#time-series-forecast)

**Syntax:** Time Series Forecast( Y( column ) )

**Description:** Fits and forecasts multiple time series using specified methods.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );


```

### [Uplift](#uplift)

**Syntax:** Uplift( Y( column ), X( columns ), Treatment( column ) )

**Description:** Fits a recursive partition tree that selects splits to maximize treatment differences. The models identify groups of individuals who are most likely to respond to a treatment.

**Example 1**

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

**Example 2**

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 3 )
);


```

### [Variability Chart](#variability-chart_1)

**Syntax:** Variability Chart( Y( column ), X( columns ) )

**Description:** Analyzes continuous measurements to determine how your measurement system is performing. You can also perform a gauge study to see measures of variation in your data.

#### [Crossed Effects Model](#crossed-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    Model( "Crossed" ),
    X( :Operator, :part# ),
    Variance Components( 1 )
);


```

#### [Crossed then Nested Effects Model](#crossed-then-nested-effects-model)

```

dt = New Table( "3 Factors Crossed then Nested",
    Add Rows( 81 ),
    New Column( "Operator",
        Character( 7 ),
        "Nominal",
        Set Values(
            {"Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Instrument",
        Character( 1 ),
        "Nominal",
        Set Values(
            {"A", "A", "A", "A", "A", "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B",
            "B", "B", "C", "C", "C", "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A",
            "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C",
            "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A", "A", "A", "A", "A", "B",
            "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C", "C", "C", "C", "C", "C",
            "C"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Part",
        Numeric,
        "Nominal",
        Format( "Best", 8 ),
        Set Values(
            [1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4, 5, 5, 5, 6, 6, 6, 7, 7, 7, 8, 8, 8, 9, 9, 9,
            10, 10, 10, 11, 11, 11, 12, 12, 12, 13, 13, 13, 14, 14, 14, 15, 15, 15, 16, 16,
            16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20, 20, 20, 21, 21, 21, 22, 22, 22, 23,
            23, 23, 24, 24, 24, 25, 25, 25, 26, 26, 26, 27, 27, 27]
        ),
        Set Display Width( 0 )
    ),
    New Column( "Y",
        Numeric,
        "Continuous",
        Format( "Best", 8 ),
        Set Values(
            [0.5, 0.6, 0.2, 0.8, 0.6, 0.6, 1.6, 1.1, 1, 0.4, 0.2, 0.1, 0.1, 0.5, 0, 0.3, 0.6,
            0.8, 0.1, 0.1, 0.2, 0.4, 0.9, 1.8, 0.1, 0.3, 0.4, 0.1, 0.3, 0.1, 0.9, 0.4, 0, 0.6,
            0.7, 0.7, 0.3, 0.1, 0.2, 0.3, 0.6, 0.2, 0.2, 0.4, 0.4, 0.8, 0.3, 0.3, 2.6, 0.4,
            1.6, 0.5, 0.3, 2.9, 0, 0, 0.5, 0.1, 0, 0.3, 0.5, 0, 0, 0.4, 0, 0.4, 0.3, 0.2, 0,
            0, 0.5, 0.1, 0.1, 0.2, 0.3, 1.1, 0.2, 0.1, 0.6, 0.3, 0.6]
        ),
        Set Display Width( 68 )
    )
);
obj = dt << Variability Chart(
    Y( :Y ),
    X( :Operator, :Instrument, :Part ),
    Model( "Crossed then Nested" ),
    Variance Components( 1 )
);


```

#### [Decide Later on Model](#decide-later-on-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );


```

#### [Main Effects Model](#main-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Wafer.jmp" );
obj = dt << Variability Chart(
    Y( :Y ),
    Model( "Main Effect" ),
    X( :Operator, :Wafer ),
    Variance Components( 1 )
);


```

#### [Nested Effects Model](#nested-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
obj = dt << Variability Chart(
    Y( :Y ),
    Model( "Nested" ),
    X( :Operator, :Part ),
    Variance Components( 1 )
);


```

#### [Nested then Crossed Effects Model](#nested-then-crossed-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Nested & Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Y ),
    Model( "Nested then Crossed" ),
    X( :Operator, :Instrument, :Part ),
    Variance Components( 1 )
);


```

### [Virtual Join](#virtual-join)

**Syntax:** Virtual Join

**Description:** Links a main data table to an auxiliary data table through an ID column.

Enables the main table to access columns from the auxiliary table without physically joining the tables.

The Link ID column property marks a column in the auxiliary table as the ID column.

The Link Reference column property maps a column in the main table to the ID column in the auxiliary table.

Link Reference Property lets you set data table reference or the path of the data table that you want to link.

The option 'Use Linked Column Name' will build the linked columns with the source column name instead of the fully qualified unique name.

**Example 1**

```

cID = New Table( "Color IDs",
    Add Rows( 2 ),
    New Column( "ID", Numeric, Set Property( "Link ID", 1 ), Set Values( [1, 2] ) ),
    New Column( "color", Character, Set Values( {"magenta", "cyan"} ) )
);
cID << Save( "$temp\cID.jmp" );

Favs = New Table( "Favorite Colors",
    Add Rows( 4 ),
    New Column( "colorID",
        Numeric,
        Set Property( "Link Reference", Reference Table( "$temp\cID.jmp" ) ),
        Set Values( [1, 2, 1, 2] )
    ),
    New Column( "person", Character, Set Values( {"fred", "ralph", "artemus", "neil"} ) )
);

Favs:"color[colorID]"n << hide( 0 ); // show the color column in the table, it is hidden by default

Write( "\!n", Favs:person[2], " likes ", Favs:"color[colorID]"n[2] );

Favs:colorID[2] = 1; // change ralph's color by changing his color id
Write( "\!n", Favs:person[2], " likes ", Favs:"color[colorID]"n[2] );
Favs:"color[colorID]"n << hide( 1 ) << hide( 0 );

Write( "\!nRalph's color changed." );


```

**Example 2**

```

cID = New Table( "Color IDs",
    Add Rows( 2 ),
    New Column( "ID", Numeric, Set Values( [1, 2] ) ),
    New Column( "color", Character, Set Values( {"magenta", "cyan"} ) )
);

Favs = New Table( "Favorite Colors",
    Add Rows( 4 ),
    New Column( "colorID", Numeric, Set Values( [1, 2, 1, 2] ) ),
    New Column( "person", Character, Set Values( {"fred", "ralph", "artemus", "neil"} ) )
);
cID:ID << Set Property( "Link ID", 1 );
Favs:colorID << Set Property(
    "Link Reference",
    {Reference Table( cID ), options( "use linked column name" )}
);


Favs:color << hide( 0 ); // show the color column in the table, it is hidden by default

Write( "\!n", Favs:person[2], " likes ", Favs:color[2] ); // not Favs:"color[colorID]"n

Favs:colorID[2] = 1;    // change ralph's color by changing his color id
Write( "\!n", Favs:person[2], " likes ", Favs:color[2] );

Write( "\!nRalph's color changed." );


```

**Example 3**

```


cID = New Table( "Color IDs",
    Add Rows( 2 ),
    New Column( "ID", Numeric, Set Values( [1, 2] ) ),
    New Column( "color", Character, Set Values( {"magenta", "cyan"} ) )
);

Favs = New Table( "Favorite Colors",
    Add Rows( 4 ),
    New Column( "colorID", Numeric, Set Values( [1, 2, 1, 2] ) ),
    New Column( "person", Character, Set Values( {"fred", "ralph", "artemus", "neil"} ) )
);
cID:ID << Set Property( "Link ID", 1 );
Favs:colorID << Set Property(
    "Link Reference",
    {Reference Table( cID ), options( "use linked column name"(1), "auto open" )}
);

Favs2 = New Table( "More Favorites",
    Add Rows( 4 ),
    New Column( "ID", Numeric, Set Values( [1, 2, 3, 4] ) ),
    New Column( " person", Character, Set Values( {"susie", "james", "mark", "ami"} ) )
);

// A link ID and link reference can be assigned to the same column.  The option "Auto open" will  
// automatically open the linked tables for you when you open the main referencing table.
Favs2:ID << Set Property( "Link ID", 1 );
cID:ID << Set Property(
    "Link Reference",
    {Reference Table( Favs2 ), Options( "Use Linked Column Name"(1) )}
);

Favs:color << hide( 0 ); // Show the color column in the table, it is hidden by default
Favs:ID << hide( 0 );  // Show the ID column in the table, from More Favorites table
Write( "\!n", Favs:person[2], " likes ", Favs:color[2] ); // Not Favs:"color[colorID]"n

Favs:colorID[2] = 1;    // Change ralph's color by changing his color id
Write( "\!n", Favs:person[2], " likes ", Favs:color[2] );

Write( "\!nRalph's color changed." );
cid:person << hide( 0 );

Write( "\!n", cID:person[2], " likes ", Favs:color[4] );


```

## [Item Messages](#item-messages)

### [Add Properties to Table](#add-properties-to-table)

**Syntax:** obj \<< Add Properties to Table

**Description:** Add the properties to the table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Properties( {2, 4} );
proplist = dt << Get Selected Properties();
dt2 = New Table( "Little Class" );
dt2 << Add Properties to Table( proplist );


```

### [Add Scripts to Table](#add-scripts-to-table)

**Syntax:** obj \<< Add Scripts to Table

**Description:** This command is an alias of 'Add properties to table'.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Properties( {2, 4} );
proplist = dt << Get Selected Properties();
dt2 = New Table( "Little Class" );
dt2 << Add scripts to table( proplist );


```

### [Anonymize](#anonymize)

**Syntax:** obj \<< Anonymize( columns( columns ), \<Output Table( name )> )

**Description:** Creates a new data table with unique identifiers removed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << anonymize( columns( :name, :age ), output table name( "anonymized" ) );


```

### [Apply Columns List Filter To Data Grid](#apply-columns-list-filter-to-data-grid)

**Syntax:** obj \<< Apply Columns List Filter To Data Grid( state=0|1 )

**Description:** Turn on to apply filters in the data table Columns list to the data grid.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Column Filter( Column Name( "tude" ) );
Wait( 1 );
dt << Apply Columns List Filter To Data Grid( 0 );
Wait( 1 );
dt << Apply Columns List Filter To Data Grid( 1 );


```

### [Apply Formula](#apply-formula)

**Syntax:** dt \<< Apply Formula(\[Columns(\<col|{cols}|Group(col, count)|<group name>, \[Ref(<name>)\], \[List Ref(<name>)\]\]+, \[Output(In Place|In Place Formula|New Formula(<prefix>|New Static(<prefix>)\], \[Group(<name>)\])

**Description:** Use a formula to transform one or more columns and place the results (either as formulas or data) into new or existing columns.

At least one column group must be defined (a single column, an explicit list of columns, a run of columns, or an existing column group name).

The first group defined serves as the target if the output is 'in place'. If needed, you can specify a name in the formula that refers to the columns taken one at a time (Ref) or as a list of columns (ListRef).

Lastly, the output type can be specified, optionally with a name and group name for new columns.

**JMP Version Added:** 18

#### [New Data Columns/ListRef](#new-data-columnslistref)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Data Table( "Big Class" ) << Apply Formula(
    Columns(
        Group( :height, 2 ),
        Ref( "_relative_from_height" ),
        ListRef( "height_to_weight" )
    ),
    Formula( _relative_from_height / Sum( height_to_weight ) ),
    Output( New Static )
);


```

#### [New Formula Columns/Grouping](#new-formula-columnsgrouping)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Apply Formula(
    Columns( Group( :height, 2 ), Ref( "_relative_from_height" ) ),
    Formula( _relative_from_height * 2 ),
    Output( New Formula( "result", Group( "output group" ) ) )
);


```

#### [Simple New Formula Column](#simple-new-formula-column)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Data Table( "Big Class" ) << Apply Formula(
    Columns( :height ),
    Formula( :height / 5 ),
    Output( New Formula )
);


```

### [Begin Data Update](#begin-data-update)

**Syntax:** obj \<< Begin Data Update

**Description:** Holds all Update messages until the End Data Update command is reached. This is useful for updating many cells without interruption. This applies only to changes in data cells.

```

dt = Open( "$SAMPLE_DATA/Central Limit Theorem.jmp" );
dt << Add Rows( 2000 );
dt << Distribution( Column( :"N=1"n, :"N=5"n, :"N=10"n ) );
Wait();
dt << Begin Data Update;
dt << Add Rows( 2000 );
dt << End Data Update;


```

### [Checksum](#checksum)

**Syntax:** obj \<< Checksum( < Version(version) >, < Include(flags) >, < Exclude(flags) > )

**Description:** Compute the table's checksum. Available flags include: "ColData", "ColName", "ColDataType", "ColModelingType", "ColFormat", "ColInFormat", "ColFormatWidth", "ColAttributes", "ColProperties", "ColListCheck", "ColRangeCheck", "ColCompact", "ColLabel", "ColHidden", "ColExclude", "ColSelection", "ColState", "ColDisplayWidth", "TableVariables", "TableScripts", "RowExclude", "RowHidden", "RowLabel", "RowColor", "RowMarker", "RowSelection", "RowState"

**JMP Version Added:** 18

**Example 1**

```

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


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Checksum( Exclude( "ColData" ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Checksum( Include( "ColData", "ColAttributes" ) );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
flags = {"ColData", "ColAttributes"};
dt << Checksum( Include( flags ) );


```

### [Clear Cell Colors](#clear-cell-colors)

**Syntax:** obj \<< Clear Cell Colors

**Description:** Clear the cell color of the selected columns. If no columns are selected, cell colors of all columns are cleared.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:age << Color Cells( "Red" );
a = {1, 3, 5};
b = {2, 4, 6};
:height << color cells( {{"Red", a}, {"blue", b}} );
:weight << color cells( {{"blue", a}} );
Wait( 2 );
dt << Clear cell colors( {:height, :age} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:age << Color Cells( "Red" );
a = {1, 3, 5};
b = {2, 4, 6};
:height << color cells( {{"Red", a}, {"blue", b}} );
:weight << color cells( {{"blue", a}} );
Wait( 2 );
dt << Clear cell colors();


```

### [Clear Column Selection](#clear-column-selection)

**Syntax:** obj \<< Clear Column Selection

**Description:** Clears the column selection in the data table.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Go To( :BP 12F );
Wait( 2 );
dt << Clear Column Selection();


```

### [Clear Edit Lock](#clear-edit-lock)

**Syntax:** obj \<< Clear Edit Lock( [ \<"Modify Cells">, \<"Add rows">, \<"Add Columns">, \<"Delete Rows">, \<"Delete Columns">] )

**Description:** Allow specified operations on the data table which were previously disallowed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Edit Lock( "Modify Cells", "Add Rows", "Delete Columns" );
:age << set selected( 1 );
:height << set selected( 1 );
Wait( 2 );
dt << Clear Edit Lock( "Delete Columns" );


```

### [Clear Properties Selection](#clear-properties-selection)

**Syntax:** obj \<< Clear Properties Selection( { property1, property2, ... )

**Description:** Deselect the specified table properties, where the list can be a list of property name or indices to the properties. If no list is given, deselect all the selected properties.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
list = {"Bivariate", "Logistic"};
proplist = dt << Select Properties();
Wait( 1 );
dt << clear properties selection( list );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
list = {"Bivariate", "Logistic"};
proplist = dt << Select Properties();
Wait( 1 );
dt << clear properties selecction();


```

### [Clone](#clone)

**Syntax:** dt \<< Clone( < Table Name(name) >, < Copy Formulas(1|0) >, < Eval Formulas(1|0) > )

**Description:** Create a copy of the data table

**JMP Version Added:** 18

```

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


```

### [Close Data Grid](#close-data-grid)

**Syntax:** obj \<< Close Data Grid

**Description:** Close or open the data grid.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Close Data Grid( 1 );


```

### [Close Side Panels](#close-side-panels)

**Syntax:** obj \<< Close Side Panels

**Description:** Close or open the data table's side panels.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Close Side Panels( 1 );


```

### [Close summary panels](#close-summary-panels)

**Syntax:** obj \<< Close summary panels

**Description:** Close or open the data table's summary panels.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Close Summary Panels( 1 );


```

### [Cluster](#cluster)

**Syntax:** obj \<< Cluster

### [Collapse All Column Groups](#collapse-all-column-groups)

**Syntax:** obj \<< Collapse All Column Groups

**Description:** Collapses all column groups

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Group Columns( "Monday", BP 8M, 3 );
dt << Group Columns( "Wednesday", BP 8W, 3 );
dt << Group Columns( "Friday", BP 8F, 3 );
dt << Expand All Column Groups;
Wait( 2 );
dt << Collapse All Column Groups;


```

### [Column Filter](#column-filter)

**Syntax:** obj \<< Column Filter

**Description:** Retrieves object to manipulate active column filter for the table.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Expand All Column Groups;
dt:sex << Hide( 1 );

// Use immediately
dt << Column Filter( Column Name( "Weight|Wt", Regular Expression( 1 ) ) );
dt << Column Filter( Tags( {"Blood Measurements", "Good Measure"} ) );
dt << Column Filter( Tags( {"Blood Measurements", "Good Measure"}, Intersection( 1 ) ) );
dt << Column Filter( Column Name( "3" ), Tags( {"Blood Measurements"} ) );
dt << Column Filter( Clear );

// Return an object and send messages later
cf = dt << Column Filter;
cf << Column Name( "3yr" );
cf << Get Script;

// Related to (can also send to object)
dt << Show Hidden Columns in Columns List( 0 );
dt << Apply Columns List Filter to Data Grid( 0 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Creates a standalone column switcher

**JMP Version Added:** 16

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
dt << Column Switcher(
    :Process 1,
    {:Process 1, :Process 3, :Process 4, :Process 5, :Process 6, :Process 7}
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Bivariate",
    H List Box(
        cs = dt << Column Switcher( :age, {:age, :weight} ),
        V List Box(
            female = Bivariate( Y( :age ), X( :height ), Where( :sex == "F" ) ),
            male = Bivariate( Y( :age ), X( :height ), Where( :sex == "M" ) )
        )
    )
);
cs << Link Platform( female );
cs << Link Platform( male );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Bivariate",
    H List Box(
        cs = dt << Column Switcher( :age, {:age, :weight} ),
        b = Bivariate( Y( :age ), X( :height ), by( :sex ) )
    )
);
cs << Link Platform( b[1] );
cs << Link Platform( b[2] );


```

### [Combine Columns](#combine-columns)

**Syntax:** obj \<< Combine Columns

**Description:** Combine several columns into a single column, with each source column's values separated by the given delimiter.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Combine Columns(
    delimiter( "," ),
    Columns(
        :Brush After Waking Up, :Brush After Meal, :Brush Before Sleep, :Brush Another Time
    ),
    Selected Columns are Indicator Columns( 1 ),
    Column Name( "When to Brush" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Combine Columns(
    delimiter( "," ),
    Columns(
        :Brush After Waking Up, :Brush After Meal, :Brush Before Sleep, :Brush Another Time
    ),
    Column Name( "When to Brush" )
);


```

### [Compare Data Tables](#compare-data-tables)

**Syntax:** obj \<< Compare Data Tables( Compare with( Data Table( name )), \<Compare table variables and scripts( 0|1)>, <show window>,\<Compare columns attributes and properties( 0|1)>, \<Compare data( 0|1 )>, \<Show difference summary(0|1)>, \<Show difference plot(0|1)> )

**Description:** Compares two open data tables and reports differences between data, as well as metadata.

```

dt = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
dt << compare data tables( compare With( Data Table( "Students2" ) ) );


```

### [Compress File When Saved](#compress-file-when-saved)

**Syntax:** obj \<< Compress File When Saved( state=0|1 )

**Description:** Compress the file when saving the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Compress File When Saved( 1 );


```

### [Compress Selected Columns](#compress-selected-columns)

**Syntax:** obj \<< Compress Selected Columns( { column1, column2, ...} )

**Description:** Compresses each column into the most compact form.

Character data will be 1-byte if there are fewer than 255 levels.

Numeric data will be 1-byte if the data is between -127 and 127.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Compress Selected Columns( {:Age, :sex, :Height, :Weight} );


```

### [Concatenate](#concatenate)

**Syntax:** obj \<< Concatenate( <Private>, <Invisible>, Data Table( name ), \<Data Table(name), ...> \<Label( column )>, \<Output Table( name ) | Append to first table>, <Keep Formulas>, <Create Source Column> )

**Description:** Combines rows from several data tables and creates a new data table or appends the rows to the first data table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Trial1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Trial2.jmp" );
dt << Concatenate( Data Table( "Trial2" ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Students.jmp" );
dt1 = Open( "$SAMPLE_DATA/Students1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students2.jmp" );
dt << Concatenate(
    Data Table( dt1 ),
    Data Table( dt2 ),
    "Append to first table",
    "Create source column"
);


```

### [Copy Column Properties](#copy-column-properties)

**Syntax:** obj \<< Copy Column Properties( \<column 1 column 2, ...> )

**Description:** Copies to the clipboard the column properties of selected columns into a list of separate lists of properties. Optionally, you can specify a list of source columns instead of pre-selecting them in the data table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << Select Columns( :MODULUS, :ELONG );
dt << Copy Column Properties;
New Window( "Script", Script Box( "//Try Paste here
                     " ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << Copy Column Properties( {:MODULUS, :ELONG} );
New Window( "Script", Script Box( "//Try Paste here
                     " ) );


```

### [Copy Selected Properties](#copy-selected-properties)

**Syntax:** obj \<< Copy Selected Properties

**Description:** Copy the selected table properties to the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << select properties( {"Distribution", "Oneway"} );
proplist = dt << Copy Selected Properties();
New Window( "Script", Script Box( "//Try Paste here
                     " ) );


```

### [Copy Table Script](#copy-table-script)

**Syntax:** obj \<< Copy Table Script( \<"No data"> )

**Description:** Copies a script to re-create the data table. The resultant script includes all the table scripts stored in the data table. Optionally, add the keyword "No Data" to omit data from the script.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Copy Table Script();
New Window( "Script", Script Box( "//Try Paste here
                     " ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Copy Table Script( "No Data" );
New Window( "Script", Script Box( "//Try Paste here
                     " ) );


```

### [Debug Script](#debug-script)

**Syntax:** obj \<< Debug Script( name )

**Description:** Debugs a named script stored as a property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Debug Script( "Distribution" );


```

### [Decision Tree](#decision-tree)

**Syntax:** obj \<< Decision Tree

### [Define Tag](#define-tag)

**Syntax:** Define Tag(<name>, \[Color(<color>)\], \[Symbol(<symbol char>)\], \[Description(<text>)\], \[Replace(<existing tag name>)\])

**Description:** Create or update a column tag definition on the table. If the tag doesn't exist, create it. Optionally assign color, symbol, and other attributes.

**JMP Version Added:** 19

#### [Color, Symbol, or None](#color-symbol-or-none)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Define Tag( "ID1", Color( Red ) );
dt << Define Tag( "ID2", Symbol( "\!UD83D\!UDCCB" ) );
dt << Define Tag( "ID3" );


```

#### [New Tag](#new-tag)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Define Tag( "ID", Color( Blue ) );


```

#### [Replace](#replace)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Define Tag( "ID", Color( Red ) );
:height << Set Property( "Tags", {"ID"} );
dt << Define Tag( "Identifier", Replace( "ID" ), Color( Blue ) );
:height << Get Property( "Tags" );


```

### [Delete Columns](#delete-columns)

**Syntax:** obj \<< Delete Columns( <column>, <column>, ... )

**Description:** Deletes the specified column(s). If no argument is specified, deletes selected columns in the data table.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:height << Set Selected;
Wait( 2 );
dt << Delete Columns();


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
dt << Delete Columns( :Height );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
cols = {"height", "weight"};
Wait( 2 );
dt << Delete Columns( cols );


```

### [Delete Filter View](#delete-filter-view)

**Syntax:** obj \<< Delete Filter View( name | obj )

**Description:** Delete the given filter view.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv dream = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
fv male = dt << New Filter View(
    "Male",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Sex ), Where( :Sex == "MALE" ) ) )
);
Wait( 1 );
dt << Delete Filter View( fv dream );
dt << Delete Filter View( "Male" );


```

### [Delete Scripts](#delete-scripts)

**Syntax:** obj \<< Delete Scripts( \<script| {script 1, script 2, script 3, ...} > )

**Description:** Deletes the specified scripts from the data table.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Table Script(
    "New Script",
    Distribution( Column( :Height, :Weight ), By( :sex ) )
);
Wait( 2 );
dt << Delete Scripts( "New Script" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
list = {"Bivariate", "Logistic"};
Wait( 2 );
dt << Delete Scripts( list );


```

### [Delete Table Property](#delete-table-property)

**Syntax:** obj \<< Delete Table Property

**Description:** Alias for Delete Scripts.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Table Script(
    "New Script",
    Distribution( Column( :Height, :Weight ), By( :sex ) )
);
Wait( 2 );
dt << Delete Table Property( "New Script" );


```

### [Delete Table Variable](#delete-table-variable)

**Syntax:** obj \<< Delete Table Variable( name )

**Description:** Deletes a table variable stored in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Table Variable( "Days", 42 );
Wait( 2 );
dt << Delete Table Variable( "Days" );


```

### [Delete Tag](#delete-tag)

**Syntax:** Delete Tag(<tag>|{<tag>, <tag>, ...}, \[force(0|1)

**Description:** Delete a tag from the table. Tags will not be deleted if any columns still use them, unless the Force(1) flag is provided.

**JMP Version Added:** 19

#### [Delete tag](#delete-tag_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Define Tag( "ID" );
Wait( 3 );
dt << Delete Tag( "ID" );


```

#### [Force delete](#force-delete)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Define Tag( "ID" );
:height << Set Property( "Tags", {"ID"} );
Wait( 3 );
dt << Delete Tag( "ID", Force( 1 ) );


```

### [Deselect Column Group](#deselect-column-group)

**Syntax:** obj \<< Deselect Column Group( name of group | list of names )

**Description:** Deselect the column groups. If the column group is omitted, all column groups will be deselected.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
dt << select column group();
Wait( 2 );
dt << deselect column group( "pollutants" );


```

### [Disable Undo](#disable-undo)

**Syntax:** obj \<< Disable Undo( state=0|1 )

**Description:** When the option is set, any operation on the data table cannot be undone.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << disable undo( 1 );


```

### [End Data Update](#end-data-update)

**Syntax:** obj \<< End Data Update

**Description:** Sends all Update messages held since the Begin Data Update command was issued. This is useful for updating many cells without interruption. This applies only to changes in data cells.

```

dt = Open( "$SAMPLE_DATA/Central Limit Theorem.jmp" );
dt << Add Rows( 2000 );
dt << Distribution( Column( :"N=1"n, :"N=5"n, :"N=10"n ) );
Wait();
dt << Begin Data Update;
dt << Add Rows( 2000 );
dt << End Data Update;


```

### [Exclude Columns](#exclude-columns)

**Syntax:** obj \<< Exclude Columns( < 0|1 > | < { column1, column2, ... } > )

**Description:** Excludes the columns from any analysis run

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Exclude Columns( 1, {:Age, :Name} );


```

### [Exit Filter View](#exit-filter-view)

**Syntax:** obj \<< Exit Filter View

**Description:** Return to the unfiltered view. If already in the unfiltered view, this has no effect.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
dt << New Filter View(
    "Dream",
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Wait( 1 );
dt << Exit Filter View;


```

### [Expand All Column Groups](#expand-all-column-groups)

**Syntax:** obj \<< Expand All Column Groups

**Description:** Expands all column groups

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Group Columns( "Monday", BP 8M, 3 );
dt << Group Columns( "Wednesday", BP 8W, 3 );
dt << Group Columns( "Friday", BP 8F, 3 );
dt << Collapse All Column Groups;
Wait( 2 );
dt << Expand All Column Groups;


```

### [Fit Model](#fit-model)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Standard Least Squares" ) )

**Description:** Fits linear regression models, including analysis of variance, logistic regression, variance components, penalized regression, stepwise regression, MANOVA, and survival models.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run Model()
);


```

### [Get Active Filter View](#get-active-filter-view)

**Syntax:** fv = obj \<< Get Active Filter View

**Description:** Get the active filter view. Returns a FilterView object.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
dt << New Filter View(
    "Dream",
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
fv active = dt << Get Active Filter View;
Show( fv active << Get Name );


```

### [Get All Columns As Matrix](#get-all-columns-as-matrix)

**Syntax:** obj \<< Get All Columns As Matrix

**Description:** Returns the data table as a matrix. Character columns are numbered according to the sorted levels, starting at 1.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
m = dt << Get All Columns As Matrix();
Show( m );


```

### [Get As Report](#get-as-report)

**Syntax:** obj \<< Get As Report

**Description:** Returns a report of the data table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
jmp_report = New Window( "Big Class",
    Text Box( "Big Class" ),
    H List Box( Outline Box( "Big Class", dt << Get As Report ) ), 

);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Where( :Age < 14 );
dt << Select Columns( :name, :age, :height );
jmp_report = New Window( "Big Class",
    Text Box( "Big Class" ),
    H List Box( Outline Box( "Big Class", dt << Get As Report ) ), 

);


```

### [Get Cell Height](#get-cell-height)

**Syntax:** obj \<< Get Cell Height

**Description:** Get a row's display height.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
ht = dt << Get Cell Height;


```

### [Get Column Group](#get-column-group)

**Syntax:** obj \<< Get Column Group( name of column group | list of names )

**Description:** Returns the list of the columns in the column group.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
dt << get column group( "xy" );


```

### [Get Column Groups Names](#get-column-groups-names)

**Syntax:** obj \<< Get Column Groups Names

**Description:** Returns the names of the columns groups.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
dt << get column groups names;


```

### [Get Column Names](#get-column-names)

**Syntax:** obj \<< Get Column Names( \<Numeric|Character|RowState>, \<Continuous|Ordinal|Nominal>,<String> )

**Description:** Returns the column names in the data table. If the string keyword is used, strings are returned.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
n = dt << Get Column Names();
Show( n );
CNames = dt << Get Column Names( Continuous );
Show( CNames );
SNames = dt << Get Column Names( String );
Show( SNames );


```

### [Get Column Reference](#get-column-reference)

**Syntax:** obj \<< Get Column Reference( list of column names )

**Description:** Returns the column reference of the strings in the list

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
refList = dt << Get Column Reference( {"sex", "age"} );
Show( refList );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
a = {1, 3, 4};
refList = dt << Get Column Reference( a );
Show( refList );


```

### [Get Edit Lock](#get-edit-lock)

**Syntax:** obj \<< Get Edit Lock

**Description:** Get the list of disallowed operations on the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Edit Lock( "Add Rows", "Delete Columns" );
Wait( 2 );
dt << Get Edit Lock();


```

### [Get Excluded Columns](#get-excluded-columns)

**Syntax:** obj \<< Get Excluded Columns

**Description:** Returns the currently excluded columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Name << Exclude;
exCols = dt << Get Excluded Columns;
Show( exCols );


```

### [Get Excluded Rows](#get-excluded-rows)

**Syntax:** obj \<< Get Excluded Rows

**Description:** Returns the currently excluded rows in the data table. Prefer Where.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( 1 );
dt << Select Rows( 5 );
dt << Exclude();
r1 = dt << Get Excluded Rows();
r2 = Where( Excluded() );
Show( r1, r2 );


```

### [Get Filter View](#get-filter-view)

**Syntax:** fv = obj \<< Get Filter View( name | \<<Temporary | \<<Unfiltered )

**Description:** Get a filter view by name, or get one of the special filter views by using \<<Temporary or \<<Unfiltered. If a filter view by the given name does not exist, returns Empty().

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
fv dream = dt << Get Filter View( "Dream" );
Show( fv dream << Get Name );
Show( (dt << Get Filter View( <<Unfiltered )) << Get Name );


```

### [Get Filter Views](#get-filter-views)

**Syntax:** { fv, ... } = obj \<< Get Filter Views( < Temporary(0|1) >, < Unfiltered(0|1) > )

**Description:** Get a list of all filter views. By default, the temporary and unfiltered views are not included.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv dream = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
fvs = dt << Get Filter Views( Unfiltered( 1 ), Temporary( 1 ) );
Show( fvs << Get Name );


```

### [Get Header Height](#get-header-height)

**Syntax:** obj \<< Get Header Height

**Description:** Get column header's display height

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
ht = dt << Get Header Height;


```

### [Get Hidden Columns](#get-hidden-columns)

**Syntax:** obj \<< Get Hidden Columns

**Description:** Returns the columns currently hidden in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Weight << Hide;
hidCols = dt << Get Hidden Columns;
Show( hidCols );


```

### [Get Hidden Rows](#get-hidden-rows)

**Syntax:** obj \<< Get Hidden Rows

**Description:** Returns the currently hidden rows in the data table. Prefer Where.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( 1 );
dt << Select Rows( 5 );
dt << Hide();
r1 = dt << Get Hidden Rows();
r2 = Where( Hidden() );
Show( r1, r2 );


```

### [Get Label Columns](#get-label-columns)

**Syntax:** obj \<< Get Label Columns

**Description:** Returns the columns used to label rows.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
labelCols = dt << Get Label Columns;
Show( labelCols );


```

### [Get Labeled Rows](#get-labeled-rows)

**Syntax:** obj \<< Get Labeled Rows

**Description:** Returns the currently labeled rows in the data table. Prefer Where.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( 1 );
dt << Select Rows( 5 );
dt << Label();
r1 = dt << Get Labeled Rows();
r2 = Where( Labeled() );
Show( r1, r2 );


```

### [Get Lock](#get-lock)

**Syntax:** obj \<< Get Lock( state=0|1 )

**Description:** Checks whether the data table is locked.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
a = dt << get lock();
Show( a );
Wait( 1 );
dt << Lock Data Table( 1 );
a = dt << get lock();
Show( a );


```

### [Get MM SAS DATA Step for Formula Columns](#get-mm-sas-data-step-for-formula-columns)

**Syntax:** obj \<< Get MM SAS DATA Step for Formula Columns

**Description:** Creates Model Manager SAS DATA step code corresponding to formula columns in a JMP data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Ratio", Formula( :height / :weight ) );
dt << Get MM SAS Data Step for Formula Columns;


```

### [Get Name](#get-name)

**Syntax:** obj \<< Get Name( \<"Ignore Extension"> )

**Description:** Returns the display name of the data table. With the optional argument 'Ignore Extension', the command returns the name of the data table without the extension

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
n = dt << Get Name();
Show( n );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
n = dt << Get Name( "Ignore Extension" );
Show( n );


```

### [Get Path](#get-path)

**Syntax:** obj \<< Get Path

**Description:** Returns the complete path of the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
path = dt << Get Path();
Show( path );


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( name )

**Description:** Returns the named property in the data table as a script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = dt << Get Property( "Distribution" );
Show( s );


```

### [Get Row ID Width](#get-row-id-width)

**Syntax:** obj \<< Get Row ID Width

**Description:** Get row ID area's display width

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
ht = dt << Get Row ID Width;


```

### [Get Row States](#get-row-states)

**Syntax:** obj \<< Get Row States

**Description:** Returns a vector containing encoded row state values for every row in the data table. Note that encoded row state values cannot be used as a row state structure in row state functions like Color Of. See Example 2 for a way you can use the vector directly.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
rs = dt << Get Row States;
Show( rs );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
rs = dt << GetRowStates;
w = Marker Of( As Row State( rs[3] ) );
dt2 = Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( dt2, 5 ) = Marker State( w );


```

### [Get Rows Where](#get-rows-where)

**Syntax:** obj \<< Get Rows Where

**Description:** Returns the rows in the data table matching the where criteria. Prefer Where instead.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r1 = dt << Get Rows Where( :sex == "M" );
r2 = Where( :sex == "M" );
Show( r1, r2 );


```

### [Get SAS DATA Step for Formula Columns](#get-sas-data-step-for-formula-columns)

**Syntax:** obj \<< Get SAS DATA Step for Formula Columns

**Description:** Creates SAS DATA step code corresponding to formula columns in a JMP data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Ratio", Formula( :height / :weight ) );
dt << Get SAS Data Step for Formula Columns;


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script( <script name> )

**Description:** Returns the requested script. If the script name is omitted, returns a text representation of the data table together with all scripts stored in the data.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = dt << Get Script;
New Window( "Script", Script Box( Char( Name Expr( s ) ) ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = dt << Get Script( "Distribution" );


```

### [Get Script Group](#get-script-group)

**Syntax:** obj \<< Get Script Group( name of script group )

**Description:** Returns the list of scripts in the group.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
gb = dt << get script group( "GB" );
Wait( 1 );
dt << run script( gb[2] );


```

### [Get Script Groups Names](#get-script-groups-names)

**Syntax:** obj \<< Get Script Groups Names

**Description:** Returns the list of names of script groups.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
gb = dt << get script groups names;


```

### [Get Scroll Locked Columns](#get-scroll-locked-columns)

**Syntax:** obj \<< Get Scroll Locked Columns

**Description:** Returns the columns currently locked from scrolling in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Name << Scroll Lock;
lockCols = dt << Get Scroll Locked Columns;
Show( lockCols );


```

### [Get Selected Columns](#get-selected-columns)

**Syntax:** obj \<< Get Selected Columns

**Description:** Returns the names of the selected columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Go To( :weight );
names = dt << Get Selected Columns;
Show( names );


```

### [Get Selected Properties](#get-selected-properties)

**Syntax:** obj \<< Get Selected Properties( \<{list of properties}> )

**Description:** Get the selected table properties (variable and scripts) into a list. Instead of selecting, you can use an optional list to specify the properties to get.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Properties( {2, 4} );
proplist = dt << Get Selected Properties();


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
proplist = dt << Get Selected Properties( {2, 4} );


```

### [Get Selected Rows](#get-selected-rows)

**Syntax:** obj \<< Get Selected Rows

**Description:** Returns the currently selected rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( 1 );
dt << Select Rows( 5 );
r = dt << Get Selected Rows();
Show( r );


```

### [Get Table Script Names](#get-table-script-names)

**Syntax:** obj \<< Get Table Script Names

**Description:** Returns the names of all the properties in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
names = dt << Get Table Script Names;
Show( names );


```

### [Get Table Variable](#get-table-variable)

**Syntax:** obj \<< Get Table Variable( name )

**Description:** Returns the value of a specified table variable in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Table Variable( "Days", 42 );
var = dt << Get Table Variable( "Days" );
Show( var );


```

### [Get Table Variable Names](#get-table-variable-names)

**Syntax:** obj \<< Get Table Variable Names

**Description:** Returns the names of all the variables in the data table.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
names = dt << Get Table Variable Names;
Show( names );


```

### [Get Tagged Columns](#get-tagged-columns)

**Syntax:** obj \<< Get Tagged Columns( tag|{tag1, tag2, ...}, [Intersection] )

**Description:** Returns the list of the columns matching the supplied tags. If intersection is requested, only the columns containing all listed tags are returned.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt:Ozone << setProperty( "Tags", {"Air Pollution Levels"} );
dt:CO << setProperty( "Tags", {"Air Pollution Levels"} );
dt:SO2 << setProperty( "Tags", {"Air Pollution Levels"} );
dt:NO << setProperty( "Tags", {"Air Pollution Levels"} );
dt:PM10 << setProperty( "Tags", {"Air Pollution Levels"} );
dt:Lead << setProperty( "Tags", {"Air Pollution Levels"} );
dt << Get Tagged Columns( "Air Pollution Levels" );


```

### [Get Transforms](#get-transforms)

**Syntax:** dt \<< Get Transforms()

**Description:** Retrieve the list of transform columns associated with this data table.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Transform Column( "A", Formula( :B + 1 ) );
dt << Transform Column( "B", Formula( :height + 1 ) );
Show( dt << Get Transforms() );
dt << Delete Columns( {:A, :B} );


```

### [Get as Matrix](#get-as-matrix)

**Syntax:** obj \<< Get as Matrix( <list of columns by name>, <list of columns by number>, <column range> )

**Description:** Returns the specified columns in the data table as a matrix. The default is all numeric columns.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
m = dt << Get As Matrix();
Show( m );
x = dt << GetAsMatrix( {4, 5} );
Show( x );


```

### [Group Columns](#group-columns)

**Syntax:** obj \<< Group Columns( first column, number ) obj \<< Group Columns( {column1, column2, ...}) obj \<< Group Columns(group name | Path({<a>, <b>, ...}), {column1, column2, ...}) obj \<< Group Columns( group name | Path({<a>, <b>, ...}), first column, number )

**Description:** Groups a list of columns.

#### [Add to group](#add-to-group)

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
Wait( 1 );
theGroup = dt << Group Columns( "BP", :BP 8M :: :BP 8W );
Wait( 2 );
// add to theGroup
theGroup = dt << Group Columns( theGroup, {:BP 12W} );


```

#### [Nested group](#nested-group)

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
Wait( 1 );
dt << Group Columns( Path( {"Groups", "BP8"} ), :BP 8M :: :BP 8W );


```

#### [Using count](#using-count)

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
Wait( 1 );
group = dt << Group Columns( BP 8M, 9 );


```

### [Group Scripts](#group-scripts)

**Syntax:** obj \<< Group Scripts({ script1, script2, ...}) obj \<< Group Scripts(group name | Path({<a>, <b>, ...}), {script1, script1, ...})

**Description:** Group a list of scripts.

**JMP Version Added:** 14

#### [Nested group](#nested-group_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    Path( {"GB", "Sample Graphs"} ),
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);


```

#### [Simple group](#simple-group)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);


```

### [Has Column](#has-column)

**Syntax:** dt \<< Has Column( name, < Exact Match(1|0) > )

**Description:** Inquire whether the data table has a column with the given name.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Has Column( "weight" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Show(
    dt << Has Column( "Weight" ),
    dt << Has Column( "Weight", Exact Match( 1 ) ),
    dt << Has Column( "a g e" ),
    dt << Has Column( "a g e", Exact Match( 1 ) )
);


```

### [Has data view](#has-data-view)

**Syntax:** obj \<< Has data view

**Description:** Returns true if the data table has a visible window opened.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Has Data View();


```

### [Hide Columns](#hide-columns)

**Syntax:** obj \<< Hide Columns( < 0|1 > | < { column1, column2, ... } > )

**Description:** Hides the columns in the data grid

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Hide Columns( 1, {:Age, :Name} );


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Inquire whether the data table has been modified.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
a = dt << is Dirty;
Show( a );
dt << add rows( 5 );
b = dt << is dirty;
Show( b );


```

### [Is Linked Subset](#is-linked-subset)

**Syntax:** obj \<< Is Linked Subset

**Description:** Inquire whether the data table is a linked subset

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
linkedSubset = dt << Subset( All Rows, Link To Original Data Table( 1 ) );
subset = dt << Subset( All Rows );
Show( dt << Is Linked Subset, linkedSubset << Is Linked Subset, subset << Is Linked Subset );


```

### [JMP Query Builder](#jmp-query-builder)

**Syntax:** obj \<< JMP Query Builder

**Description:** Builds a query for one or more JMP data tables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << JMP Query Builder();


```

### [Join](#join)

**Syntax:** obj \<< Join( <Private>, <Invisible>,With( Data Table( name )), By Matching Columns( column1 = column2, ...), Selected( columns ), SelectedWith( columns ), \<Drop Multiples( 0|1, 0|1 )>, \<Include nonmatches( 0|1, 0|1 )>,\<Copy formula( 0|1 )>, <Suppress Formula Evaluation>, <Update>, <Merge Same Name Columns>, <Preserve Main Table Order> )

**Description:** Combines multiple data tables into one new data table. The data can be combined by row assignment, matching column values, or in a Cartesian fashion.

```

dt = Open( "$SAMPLE_DATA/Trial1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Little.jmp" );
dt << Join(
    With( Data Table( "Little" ) ),
    Select( :popcorn, :oil amt, :batch, :yield ),
    SelectWith( :yield ),
    By Matching Columns( :popcorn = :popcorn, :batch = :batch, :oil amt = :oil )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the data table. Only the data grid is included, not notes, variables, or scripts.

```

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


```

### [Journal Link](#journal-link)

**Syntax:** dt \<< Journal Link( < Save( <filepath> ) | Embed( ) >, < Button Name( "Ben") > )

**Description:** Appends a data table link-button to a journal. Use embed() or save(), but not both. Embed() has no options. Save() option is similar to dt\<<save(). Use ButtonName() to override the button label. Returns new link-button.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Journal Link(); // assumes the table can be saved at its current location; button gets name from table
dt << Journal Link( Embed() ); // embed JSL script to re-create table; button gets name from table
dt << Journal Link(
    Save( "$temp/DeleteMe1.jmp" ),
    ButtonName( "Fancy Name for Temporary File" )
);
// even more fancy...
button = dt << Journal Link( Save( "$temp/DeleteMe2.jmp" ), ButtonName( "" ) ); // no text name
button << UnderlineStyle( 0 ); // not using the link-style appearance
button << SetIcon( "DataTableFile" ); // add an icon
button << SibAppend( Text Box( "Pick Me!" ), "Horizontal" ); // append a label
// save it with a prompt...you can change the name in the save-as dialog...or cancel
dt << Journal Link( Save( "" ) ); // prompt for path and save table; button gets name from prompt
Close( dt, "NoSave" );


```

### [Last Modified](#last-modified)

**Syntax:** obj \<< Last Modified

**Description:** Returns the date of the last saved modification to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
date = dt << Last Modified();
Show( date );


```

### [Lock Data Table](#lock-data-table)

**Syntax:** obj \<< Lock Data Table( state=0|1 )

**Description:** Locks the data table so values cannot be edited or added.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Lock Data Table( 1 );
// Now try changing a value in the data table.


```

### [MSA Variability Chart](#msa-variability-chart)

**Syntax:** obj \<< MSA Variability Chart( Y( column ), X( columns ) )

**Description:** Displays a variability chart showing how a measurement varies across categories and performs analysis examining how the mean and variance change across the categories.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );


```

### [Make Indicator Columns](#make-indicator-columns)

**Syntax:** obj \<< Make Indicator Columns

**Description:** Convert a nominal or ordinal column to as many columns as the number of categories. The column names of the resultant columns are the categories of the source column. The values of the resultant columns are zeroes or ones.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << Make Indicator Columns( columns( {:species, :season} ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = dt \<< Make RowState Handler( function(a) )

**Description:** Creates a row state handler to the data table. The argument of the function holds the rows whose row states get changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
f = Function( {a}, Print( a ) );
rs = dt << make row state handler( f );
dt << Select Rows( 1 );
dt << Select Rows( 5 );


```

### [Make SAS DATA Step](#make-sas-data-step)

**Syntax:** sd = dt \<< Make SAS Data Step( ) sd = dt \<< Make SAS Data Step( SaveJMPMetadata(true) )

**Description:** Returns the data table as a SAS DATA step.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
sd = dt << Make SAS Data Step();
Show( sd );


```

### [Make SAS DATA Step Window](#make-sas-data-step-window)

**Syntax:** sd = dt \<< Make SAS Data Step Window( ) sd = dt \<< Make SAS Data Step Window( SaveJMPMetadata(true) )

**Description:** Opens a new window of type sas and creates a SAS DATA step from the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
sd = dt << Make SAS Data Step Window();


```

### [Merge Referenced Data](#merge-referenced-data)

**Syntax:** obj \<< Merge Referenced Data

**Description:** Makes the table stand-alone by merging the data from the source table to the referenced columns and unlinking them. The Link Reference property of the referencing columns is also removed.

```

dt1 = Open( "$SAMPLE_DATA\Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA\Pizza Responses.jmp" );
dt1:ID << Set Property( "Link ID", 1 );
dt2:Choice << Set Property( "Link Reference", Reference Table( dt1 ) );
dt2:Choice1 << Set Property( "Link Reference", Reference Table( dt1 ) );
dt2:Choice2 << Set Property( "Link Reference", Reference Table( dt1 ) );
dt2 << Merge Referenced Data();


```

### [Missing Data Pattern](#missing-data-pattern)

**Syntax:** obj \<< Missing Data Pattern( columns( columns ), \<Output Table( name )> )

**Description:** Finds patterns of missing values in the data table and creates a table of each pattern and its frequency.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Missing Data Pattern(
    columns( :POP, :Max deg. F Jan, :OZONE, :CO, :SO2, :NO, :PM10, :Lead )
);


```

### [Move Column Group](#move-column-group)

**Syntax:** obj \<< Move Column Group( name of group | Path({<a>, <b>, ...}), to first | to last | after(column) | after(group) | after(Path({<a>, <b>, ...})) )

**Description:** Move the column group to specified location. If the column group name is omitted, all groups are moved.

#### [After group](#after-group)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
dt << move column group( "Pollutants", after( "xy" ) );


```

#### [Move all](#move-all)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
dt << move column group( to first );


```

#### [To first](#to-first)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
dt << move column group( "xy", to first );


```

### [Move Script Group](#move-script-group)

**Syntax:** obj \<< Move Script Group( name of group | Path({<a>, <b>, ...}), to first | to last | after(script) | after(group) | after(Path({<a>, <b>, ...})) )

**Description:** Move the script group to specified location. If the script group name is omitted, all groups are moved.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
Wait( 1 );
dt << move script group( "VL", after( "Oneway" ) );
Wait( 1 );
dt << move script group( "GB", after( "VL" ) );
Wait( 1 );
dt << move script group( "VL", after( Path( {"GB"} ) ) );
Wait( 1 );
dt << move script group( to first );


```

### [Move Selected Scripts](#move-selected-scripts)

**Syntax:** obj \<< Move Selected Scripts( script|list of scripts|group|Path({<a>, <b>, ...}), to first | to last | after(script) | after(group) | after(Path({<a>, <b>, ...})) )

**Description:** Move the scripts to specified location.

**JMP Version Added:** 14

#### [After group](#after-group_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << Move Selected scripts( {"Logistic"}, after( "GB" ) );


```

#### [Move Group](#move-group)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    Path( {"GB", "Graphs"} ),
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << Move Selected scripts( Path( {"GB", "Graphs"} ), after( "Contingency" ) );


```

#### [To first](#to-first_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Move Selected scripts(
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"},
    to first
);


```

### [Move down](#move-down)

**Syntax:** obj \<< Move down

**Description:** Replaces the values in the first row of the data table with the column names and replaces the column names with default sequencing names.

**JMP Version Added:** 16

```

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


```

### [Move up](#move-up)

**Syntax:** obj \<< Move up

**Description:** Replaces the column names with the values in the first row of the data table.

**JMP Version Added:** 16

```

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


```

### [Move up and append](#move-up-and-append)

**Syntax:** obj \<< Move up and append

**Description:** Replaces the column names by appending the values in the first row of the data table to the corresponding column names.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Move up and append;


```

### [New Data Box](#new-data-box)

**Syntax:** obj \<< New Data Box( < \<<Enable Filter Views(0|1) > )

**Description:** Makes a data table view in a display box tree. Changes the current data table to the given data table. The optional Enable Filter Views argument controls whether the view allows filter views; the default is to allow them.

```

dtA = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "school",
    H List Box(
        dtA << New Data Box(),
        Text Box(),
        dtA << Distribution(
            ContinuousDistribution( Column( :weight ) ),
            NominalDistribution( Column( :age ) )
        )
    )
);
dtA = 0;


```

### [New Data View](#new-data-view)

**Syntax:** obj \<< New Data View

**Description:** Makes a new view of the data table. This view is linked to the original in that anything highlighted or changed will affect the original. This is useful when you need to scroll to different parts of the same table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << New Data View();


```

### [New Filter View](#new-filter-view)

**Syntax:** fv = dt \<< New Filter View( < name >, < Copy From(name|obj) >, < Temporary(0|1) >, < Active(0|1) >, < DataFilter(expr) >)

**Description:** Create a new filter view. The created FilterView object is returned. The new filter view will be active by default. If you do not name the filter view, it is temporary, unless you set Temporary to zero.

**JMP Version Added:** 19

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
dt << New Filter View(
    "Dream",
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
dt << New Filter View(
    "Dream Inverse",
    Data Filter(
        Data Filter(
            Inverse( 1 ),
            Add Filter( Columns( :Island ), Where( :Island == "Dream" ) )
        )
    )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    Data Filter( Add Filter( Columns( :Sex ), Where( Is Missing( :Sex ) ) ) )
);
dt << New Filter View( "Unknown Sex", CopyFrom( fv ), Active( 0 ) );


```

### [New Script](#new-script)

**Syntax:** New Property( name, script ) New Script( name, script )

**Description:** Creates and sets a new property in the data table as a script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Script( "New Script", Distribution( Column( :Height, :Weight ), By( :sex ) ) );


```

### [New Table Variable](#new-table-variable)

**Syntax:** obj \<< New Table Variable( name, number )

**Description:** Creates and sets a new variable in the data table as a constant value. If there is an existing variable with the same name, a number is appended to the name of the new variable to make it unique. The similar command Set Table Variable is recommended for most cases.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Table Variable( "Days", 42 );


```

### [OC Curves](#oc-curves)

**Syntax:** obj \<< OC Curves

**Description:** Creates a graph that plots the probability of not detecting a shift in process as a function of the size of the shift.

**JMP Version Added:** 16

### [Partition](#partition)

**Syntax:** obj \<< Partition( Y( column ), X( column(s) ) )

**Description:** Constructs a decision tree by recursively partitioning the data according to a relationship between the predictor and response values. Both the response and predictors can be either continuous or categorical.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);


```

### [Paste Column Properties](#paste-column-properties)

**Syntax:** obj \<< Paste Column Properties

**Description:** Pastes from the clipboard multiple lists of column properties to multiple columns. Optionally, you can specify a list of target columns instead of selecting them in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << Copy Column Properties( {:MODULUS, :ELONG} );
dt2 = New Table( "test it",
    New Column( "T1", numeric, continuous ),
    New Column( "T2", numeric, continuous ),
    New Column( "T3", numeric, continuous ),
    Add Rows( 10 )
);
dt2 << Paste Column Properties( {:T1, :T3} );


```

### [Recode](#recode)

**Syntax:** obj \<< Recode

**Description:** Recode the old values of selected columns to new values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Go To( :weight );
dt << Recode;


```

### [Recode Column](#recode-column)

**Syntax:** obj \<< Recode Column(<source column reference>, {<transform>, ...}, \<Update Properties(0|1)>, \<By Word(Delimiters(<chars>)>, Target Column(<column reference> | <column name>))

**Description:** Apply the listed transformations to each value from the source column and store the result in the original column or specified target column. The By Word option splits supplied character data into smaller input values. Once the input values are determined, the transformations are applied to those values separately.

Special JSL variables are populated during the execution of the command:

```
_rcNow is the current value of the input after the previous transformation(s).

_rcOrig is the original value of the input.

```

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = New Column( :age );
col << Data Type( "Character" );
dt << Recode Column(
    :age,
    {If( _rcNow >= 17, "Older", _rcNow >= 15, "Middle", "Younger" )},
    Target Column( col )
);


```

### [Rename Column Group](#rename-column-group)

**Syntax:** obj \<< Rename Column Group( oldname | Path({<a>, <b>, ...}), newname )

**Description:** Rename the column group.

#### [Nested Group](#nested-group_2)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( Path( {"xy", "Cols"} ), {:X, :y} );
Wait( 1 );
dt << rename column group( Path( {"xy"} ), "XY" );
dt << rename column group( Path( {"XY", "Cols"} ), "Columns" );


```

#### [Simple Group](#simple-group_1)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
Wait( 1 );
dt << rename column group( "xy", "coordinates" );


```

### [Rename Script Group](#rename-script-group)

**Syntax:** obj \<< Rename Script Group( oldname | Path({<a>, <b>, ...}), newname )

**Description:** Rename the script group

**JMP Version Added:** 14

#### [Nested group](#nested-group_3)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    Path( {"GB", "Graphs"} ),
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << rename script group( Path( {"GB", "Graphs"} ), "My Graphs" );


```

#### [Simple group](#simple-group_2)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << rename script group( "GB", "GraphBuilders" );


```

### [Rename Table Property](#rename-table-property)

**Syntax:** obj \<< Rename Table Property( old name, new name )

**Description:** Renames the specified Table Property.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Script( "New Script", Distribution( Column( :Height, :Weight ), By( :sex ) ) );
Wait( 1 );
dt << Rename Table Property( "New Script", "Great Script" );


```

### [Rename Table Script](#rename-table-script)

**Syntax:** obj \<< Rename Table Script( old name, new name )

**Description:** Renames the specified Table Script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Script( "New Script", Distribution( Column( :Height, :Weight ), By( :sex ) ) );
Wait( 1 );
dt << Rename Table Script( "New Script", "Great Script" );


```

### [Rename Table Variable](#rename-table-variable)

**Syntax:** obj \<< Rename Table Variable( old name, new name )

**Description:** Renames a specified Table Variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Table Variable( "Days", 42 );
Wait( 2 );
dt << Rename Table Variable( "Days", "Hours" );


```

### [Rerun Formulas](#rerun-formulas)

**Syntax:** obj \<< Rerun Formulas

**Description:** Re-evaluates all column formulas in the data table.

```

dt = Open( "$SAMPLE_DATA/Central Limit Theorem.jmp" );
dt << Add Rows( 100 );
dt << Rerun Formulas;


```

### [Reset Transforms](#reset-transforms)

**Syntax:** dt >> Reset Transforms()

**Description:** When transform columns are accessed, they cache their data for future calls. This function removes that data. The data will be recreated if the column is accessed again.

**JMP Version Added:** 16

```

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


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

**Description:** Reverts any changes to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Row States(
    [33, 33, 33, 33, 33, 97, 97, 97, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 768]
);
Wait( 2 );
dt << revert();


```

### [Run Formulas](#run-formulas)

**Syntax:** obj \<< Run Formulas

**Description:** Performs all pending formula evaluations. Not all formulas will be evaluated.

```

dt = Open( "$SAMPLE_DATA/Central Limit Theorem.jmp" );
dt << Add Rows( 10000 );
dt << Run Formulas();
Distribution( Column( :"N=1"n, :"N=5"n, :"N=10"n ) );


```

### [Run Script](#run-script)

**Syntax:** obj \<< Run Script( name )

**Description:** Runs a named script stored as a property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Run Script( "Distribution" );


```

### [Save](#save)

**Syntax:** obj \<< Save( <filepath>, <file type> ) obj \<< Save As( filepath, <file type> )

**Description:** Saves the data table to any supported format. Supported formats include .jmp, .xls, .xlsx, .txt, .csv, .tsv, .xpt, .v8xpt, .stx, .sqlite, .db, .sqlite3, and .db3. Some formats are supported only on Windows. See Using JMP for details.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Save( "$temp\deleteme Big Class.jmp" ); // explicit location
If( dt << Save( "" ),
    Write( "\!nsaved to " || (dt << GetPath) ),
    Write( "\!nsave canceled" )
); // prompt
dt << Save( "$temp\deleteme Big Class.csv" ); // convert to CSV format
Close( dt, "NoSave" );


```

### [Save As](#save-as)

**Syntax:** obj \<< Save( <filepath>, <file type> ) obj \<< Save As( filepath, <file type> )

**Description:** Saves the data table to any supported format. Supported formats include .jmp, .xls, .xlsx, .txt, .csv, .tsv, .xpt, .v8xpt, .stx, .sqlite, .db, .sqlite3, and .db3. Some formats are supported only on Windows. See Using JMP for details.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Save( "$temp\deleteme Big Class.jmp" ); // explicit location
If( dt << Save( "" ),
    Write( "\!nsaved to " || (dt << GetPath) ),
    Write( "\!nsave canceled" )
); // prompt
dt << Save( "$temp\deleteme Big Class.csv" ); // convert to CSV format
Close( dt, "NoSave" );


```

### [Save Database](#save-database)

**Syntax:** obj \<< Save Database( connectInfo, TableName )

**Description:** Saves the data table back to a database.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Save Database( "Connect Dialog", "My_Class" );


```

### [Screen Predictors](#screen-predictors)

**Syntax:** obj \<< Screen Predictors

**Description:** This is an alias and old name for Predictor Screening

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );


```

### [Select Column Group](#select-column-group)

**Syntax:** obj \<< Select Column Group( name of group | list of names )

**Description:** Select the column groups.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << group columns( "xy", {:X, :y} );
dt << group columns( "pollutants", :Ozone :: :Lead );
dt << select column group( "xy", "pollutants" );


```

### [Select Properties](#select-properties)

**Syntax:** obj \<< Select Properties( { property1, property2, ... )

**Description:** Select the specified table properties, where the list can be a list of property name or indices to the properties.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
proplist = dt << Select Properties( {2, 4} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
proplist = dt << Select Properties( {"Bivariate", "Logistic"} );


```

### [Select Script Group](#select-script-group)

**Syntax:** obj \<< Select Script Group( \<name of group | { group1, group2, ...} > )

**Description:** Select the script groups. If no script group is given, all groups are selected.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
Wait( 1 );
dt << select script group( "VL" );


```

### [Select Scripts](#select-scripts)

**Syntax:** obj \<< Select Scripts( \<name of script | { script1, script2, ...} > )

**Description:** Select the named scripts.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
Wait( 1 );
dt << select scripts( {"Distribution", "Graph Builder Heat Map"} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
Wait( 1 );
a = dt << get script group( "GB" );
dt << select scripts( a );


```

### [Select columns](#select-columns)

**Syntax:** obj \<< Select columns( <column>, <column>, ... )

**Description:** Select the specified columns. To select all columns, use the keyword 'All'.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
dt << Select Columns( :Height );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
dt << Select Columns( "All" );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
clist = {:Height, :Weight};
dt << Select Columns( clist );


```

### [Sequencing Variants Toolset](#sequencing-variants-toolset)

**Syntax:** obj \<< Sequencing Variants Toolset

**Description:** Interface to Sequencing Variants Toolset Add-in Platform

### [Set Active Filter View](#set-active-filter-view)

**Syntax:** obj \<< Set Active Filter View( name | obj )

**Description:** Set the active filter view

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Wait( 1 );
dt << Set Active Filter View( "Dream" );


```

### [Set Cell Height](#set-cell-height)

**Syntax:** obj \<< Set Cell Height( number )

**Description:** Set the display height of each data table cell.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Cell Height( 20 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty( state=0|1 )

**Description:** Marks the data table as changed, even though no change has occurred. This is helpful for causing a prompt to save on closing.

```

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


```

### [Set Edit Lock](#set-edit-lock)

**Syntax:** obj \<< Set Edit Lock( [ \<"Modify Cells">, \<"Add rows">, \<"Add Columns">, \<"Delete Rows">, \<"Delete Columns">] )

**Description:** Disallow specified operations on the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Edit Lock( "Add Rows", "Delete Columns" );


```

### [Set Header Height](#set-header-height)

**Syntax:** obj \<< Set Header Height( number )

**Description:** Set column header's display height

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Header Height( 20 );


```

### [Set Label Columns](#set-label-columns)

**Syntax:** obj \<< Set Label Columns( column(s) )

**Description:** Assigns a label role to selected columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
Wait( 1 );
dt << Set Label Columns( :City, :State );


```

### [Set Matrix](#set-matrix)

**Syntax:** obj \<< Set Matrix( [ matrix with rows separated by commas ] )

**Description:** Creates a data table from a matrix.

```

dt = New Table( "B" );
dt << Set Matrix( [12 59 95, 12 61 123, 12 55 74, 12 66 145] );


```

### [Set Name](#set-name)

**Syntax:** obj \<< Set Name( new TableName )

**Description:** Changes the name of the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Name( "New Class" );


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( name, script )

**Description:** Creates and sets a new property in the data table as a script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Property( "New Script", Distribution( Column( :Height, :Weight ), By( :sex ) ) );


```

### [Set Row ID Width](#set-row-id-width)

**Syntax:** obj \<< Set Row ID Width( number )

**Description:** Set row ID area's display width

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Row ID Width( 80 );


```

### [Set Row States](#set-row-states)

**Syntax:** obj \<< Set Row States( [state1, state2, ... stateN] )

**Description:** Sets the Row States for all rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Row States(
    [33, 33, 33, 33, 33, 97, 97, 97, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 768]
);


```

### [Set Scroll Lock Columns](#set-scroll-lock-columns)

**Syntax:** obj \<< Set Scroll Lock Columns( column(s) )

**Description:** Locks selected columns in the data table from scrolling. To indicate that a column is locked, the background color changes.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Set Scroll Lock Columns( :City );


```

### [Set Table Variable](#set-table-variable)

**Syntax:** obj \<< Set Table Variable( name, number )

**Description:** Creates and sets a new variable in the data table as a constant value. An existing variable with the same name will be overwritten.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Set Table Variable( "Days", 42 );


```

### [Show Header Filter Icons](#show-header-filter-icons)

**Syntax:** obj \<< Show Header Filter Icons( state=0|1 )

**Description:** Show or hide the filter icons on columns in the current filter view.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Show Header Filter Icons( 0 );


```

### [Show Header Graphs](#show-header-graphs)

**Syntax:** obj \<< Show Header Graphs( state=0|1 )

**Description:** Show or hide the header graphs in the data table display.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Show Header Graphs( 0 );


```

### [Show Header Groups](#show-header-groups)

**Syntax:** obj \<< Show Header Groups( state=0|1 )

**Description:** Show or hide the column groups in the data table display.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Show Header Groups( 0 );


```

### [Show Header Statistics](#show-header-statistics)

**Syntax:** obj \<< Show Header Statistics( state=0|1 )

**Description:** Show or hide the header statistics in the data table display.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Show Header Statistics( 0 );


```

### [Show Header Tags](#show-header-tags)

**Syntax:** obj \<< Show Header Tags( state=0|1 )

**Description:** Show or hide the column tags in the data table display.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Show Header Tags( 0 );


```

### [Show Hidden Columns In Columns List](#show-hidden-columns-in-columns-list)

**Syntax:** obj \<< Show Hidden Columns In Columns List( state=0|1 )

**Description:** Turn off to omit Hidden columns from the data table Columns list. These columns never show in the data grid.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Hide Columns( 1, {:"pop- m"n, :Max deg. F Jan, :X, :Y} );
Wait( 1 );
dt << Show Hidden Columns In Columns List( 0 );


```

### [Show Transforms](#show-transforms)

**Syntax:** dt \<< Show Transforms()

**Description:** Print information to the log about the transform columns associated with this data table and its platforms. This is informational and the format might change. It should not be parsed.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Transform Column( "A", Formula( :height + 1 ) );
dt << Show Transforms();
dt << Delete Columns( :A );


```

### [Sort](#sort)

**Syntax:** obj \<< Sort( <Private>, <Invisible>, <Replace table>, By( column ), Order( ascending|descending ) )

**Description:** Creates a new data table that is sorted by specified columns in either ascending or descending order.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Sort( By( :name ), Order( Ascending ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Sort( replace table, By( :name ), Order( Ascending ) );


```

### [Split](#split)

**Syntax:** obj \<< Split( Split( columns ), Split by( column ), \<Group(column)>, <Private>|<Invisible>, \<Remaining Columns( Keep All | Drop All | Drop( columns ) | Keep( columns ) )>, \<Copy formula( 0|1 )>, \<Suppress formula evaluation( 0|1 )>, <Sort by Column Property>, \<Output Table( "name" )> )

**Description:** Creates a new data table that maps several rows of one column into one row in several columns.

```

dt = Open( "$SAMPLE_DATA/Restaurant Tips.jmp" );
:Day of Week << set property( "Row Order Levels", 1 );
dt << Split(
    Split By( :Day of Week ),
    Split( :Bill Amount ),
    Sort by Column Property,
    remaining columns( drop all )
);


```

### [Stack](#stack)

**Syntax:** obj \<< Stack( <Private>, <Invisible>, columns( columns ), \<Source Label Column( string )>, \<Stacked Data Column( string )>, \<Copy formula( 0|1 )>, \<Number of Series(n)>, <Contiguous>, \<Drop All Other Columns(1) | Name("Non-stacked columns")(Keep( col1, ... )) | Name("Non-stacked columns")(Drop( col1, ... ))>, \<Output Table( "name" )>) )

**Description:** Creates a new data table with values from multiple columns stacked into a single column.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << Stack(
    columns( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Source Label Column( "Time" ),
    Stacked Data Column( "Log Hist" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Stack(
    columns( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    ,
    Number of Series( 3 ),
    Contiguous,
    Source Label Column( "Day" ),
    Stacked Data Column( "BP" )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Stack(
    columns( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    ,
    Number of Series( 3 ),
    Source Label Column( "Time" ),
    Stacked Data Column( "BP" )
);


```

### [Subscribe](#subscribe)

**Syntax:** obj \<< Subscribe( Key( \<"client"> ), OnDeleteColumns| OnAddColumns| OnAddRows| OnDeleteRows| OnRenameColumn | OnClose | OnSave | OnRename (function) )

**Description:** Subscribes to get messages regarding changes in the data table. Key is the subscription name, so that it can be referenced. The optional parameter, client, will trigger a close confirmation when a close is attempted on the data table. Function can either be the name of a previously defined function, or the function itself. On Close only requires one argument to the function, the data table. The other messages require an additional argument, either a list of columns or number of rows affected. Each subscription remains in effect until you unsubscribe.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Subscribe( "name1"("client"), On Close( Print( "Closing Data Table" ) ) );
f = Function( {dtab, oldname},
    Print( "oldname", oldname );
    Print( "new name", dtab << getname() );
);
fsave = Function( {dtab, newpathname},
    Print( "new path name", newpathname );
    Print( "new name", dtab << getname() );
);
dt << Subscribe( "name1", On Rename( f ) );
dt << Subscribe( "name1", On Save( fsave ) );
fcols = Function( {dtab, b},
    n = N Items( b );
    dtname = (dtab << getname());
    Print( dtname );
    Print( n );
    For( i = 1, i <= n, i++,
        colname = (b[i] << getname());
        Print( colname );
    );
);
dt << Subscribe( "name2", On Delete Columns( fcols ) ); 
//Try deleting a column, then close the data table.


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
f = Function( {dtab, col, oldname},
    Print( dtab << getname() );
    Print( "new column name", (col << getname()) );
    Print( "old name", oldname );
);
sub = dt << Subscribe( "", OnRenameColumn( f ) );
Column( dt, 1 ) << set name( "test" );
Wait( 1 );
dt << unsubscribe( sub, on rename column );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
delRowsFn = Function( {a, b, rows},
    dtname = (a << Get Name());
    Print( dtname );
    Print( b );
    Print Matrix( rows );
);
addRowsFn = Function( {a, b, insert},
    dtname = (a << Get Name());
    Print( dtname );
    Print( b );
    Print( insert );
);
dt << subscribe( "Test Delete", onDeleteRows( delRowsFn, 3 ) );
dt << subscribe( "Test Add", onAddRows( addRowsFn, 3 ) );
// Try deleting some rows and adding new ones.


```

### [Subset](#subset)

**Syntax:** obj \<< Subset( <Private>, <Invisible>, <Selected columns>, \<Columns(column list)>, \<All rows | Selected Rows | Filtered Rows(where clause) | Rows([number, number, ...])>, \<By(column list)>, \<Sampling Rate(fraction)>, \<Sample Size(integer)>, \<Stratify(column list)>, \<Link to original data table(0|1)>, \<Copy formula(0|1)>, <Suppress Formula Evaluation>, <Keep by columns> )

**Description:** Creates a new data table from the selected rows and columns of the source data table. You can also randomly select rows to subset.

#### [By](#by)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Subset( By( :sex ), Keep by columns );


```

#### [Filtered Rows](#filtered-rows)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Subset( Filtered Rows( :age == 14 & Contains( :name, "E" ) ) );


```

#### [Rows](#rows)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Subset( Rows( [28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40] ) );


```

#### [Stratified Sample](#stratified-sample)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Subset( Sample Size( 10 ), Stratify( :sex ) );


```

### [Summary](#summary)

**Syntax:** obj \<< Summary( <Private>, <Invisible>, FREQ(column | "none"), WEIGHT(column | "none"),Group( columns ),Subgroup(columns), \<N (column)>, \<Mean( column )>, \<Std Dev( column )>, \<Min( column )>, \<Max( column )>, \<Range( column )>, \<Sum( column )>, \<CV( column )>...,Include marginal statistics, Link to original data table (0|1),statistics column name format( "stat(column)" | "column" | "stat of column" | "column stat" | "stat") )

**Description:** Creates a new data table of summary statistics. If specified, there is a row for each level of a grouping variable or each combination of levels of multiple grouping variables.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Summary(
    Group( :Age ),
    subgroup( :sex ),
    Mean( :Height ),
    Include marginal statistics
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Summary(
    Group( :Age ),
    Mean( :Height ),
    statistics column name format( "stat of column" )
);


```

### [Suppress Formula Eval](#suppress-formula-eval)

**Syntax:** obj \<< Suppress Formula Eval( state=0|1 )

**Description:** Suppresses or enables formula evaluation. This is useful for faster adding of rows, running multiple analyses, and sorting.

```

dt = Open( "$SAMPLE_DATA/Central Limit Theorem.jmp" );
dt << Add Rows( 2000 );
dt << Suppress Formula Eval( 1 );
dt << Add Rows( 2000 );
dt << Suppress Formula Eval( 0 );


```

### [Text to Columns](#text-to-columns)

**Syntax:** obj \<< Text to Columns( delimiters(\<"separator">, <TAB>, <NEWLINE>), columns(column1, column2, ...) )

**Description:** Convert a column of strings with embedded delimiter into separate columns. The resultant columns can be indicator columns. Delimiters can be any character, the key word TAB, or the key word NEWLINE.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Text To Columns( delimiter( "," ), columns( :Brush Delimited ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Text To Columns(
    delimiter( "," ),
    columns( :Brush Delimited ),
    Make Indicator Columns( 1 )
);


```

### [Torch Deep Learning](#torch-deep-learning)

**Syntax:** obj \<< Torch Deep Learning

**Description:** Interface to Torch Deep Learning Add-in Platform

### [Transform Column](#transform-column)

**Syntax:** dt \<< Transform Column(<name>, Formula(<expression>), [Replace(0|1)], [Private(0|1)], \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]

**Description:** Create a transform column associated with the target table. The transform column can be accessed like a real column.

```
Name: Name of the column

Formula: The formula that defines the data in the transform column

Replace: With this flag, a transform defined with the same name as an existing transform will replace the existing transform. Without this flag, the existing transform will be returned if it is equivalent; otherwise the name of the new column will be changed to be distinct.

Private: With this flag, the column will not show up in column selector lists

Data type: Optionally specify the data type. If not specified, it will be inferred from the first row.

Modeling type: Optionally specify the modeling type. If not specified, the default for the data type will be used

Column Properties: These are any standard column properties you wish to set. You can also set them on the column after it is created.

```

**JMP Version Added:** 16

#### [Nested](#nested)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Transform Column( "A", Formula( :B + 1 ) );
dt << Transform Column( "B", Formula( :height + 1 ) );
Show( :A[1] );
dt << Delete Columns( {:A, :B} );


```

#### [Random](#random)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Transform Column( "Predictable", Formula( Random Uniform() ), Random Seed( 314 ) );
dt << Transform Column( "Random", Formula( Random Uniform() ) );
Show( :Predictable[1], :Random[1] );
dt << Delete Columns( {:Predictable, :Random} );


```

#### [Simple](#simple_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Transform Column( "A", Formula( :height + 1 ) );
Show( :A[1] );
dt << Delete Columns( :A );


```

### [Transpose](#transpose)

**Syntax:** obj \<< Transpose( <Private>, <Invisible>,columns( columns ), By( column ), \<Label( column )>, \<Output Table( name )> )

**Description:** Creates a new data table from the source table where the rows and columns are interchanged.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Transpose(
    columns( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    By( :Dose ),
    Label( :Subject )
);


```

### [Type 1 Gauge](#type-1-gauge)

**Syntax:** obj \<< Type 1 Gauge( Y( column ) )

**Description:** Analyzes measurement systems on continuous data using the Type 1 Gauge method to evaluate the capability of a measurement process on one part.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);


```

### [Ungroup Columns](#ungroup-columns)

**Syntax:** obj \<< Ungroup Columns( {column1, column2, ...} | Column Group( group name ) )

**Description:** Ungroups a list of columns.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Group Columns( "Monday", BP 8M, 3 );
dt << Group Columns( "Wednesday", BP 8W, 3 );
dt << Group Columns( "Friday", BP 8F, 3 );
Wait( 2 );
dt << Ungroup Columns();


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Group Columns( "Monday", BP 8M, 3 );
dt << Group Columns( "Wednesday", BP 8W, 3 );
dt << Group Columns( "Friday", BP 8F, 3 );
Wait( 2 );
dt << Ungroup Columns( Column Group( "Monday" ) );


```

### [Ungroup Scripts](#ungroup-scripts)

**Syntax:** obj \<< Ungroup Scripts( name of script group | list of scripts )

**Description:** Ungroup a list of scripts. If scripts are not given, selected scripts will be detached from its group. All of the groups will be removed from their grouping if no script is given and no script is selected.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
Wait( 1 );
dt << ungroup scripts( "VL" );
Wait( 1 );
dt << ungroup scripts( {"Graph Builder Line and Bar Charts", "Graph Builder Heat Map"} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group scripts(
    "GB",
    {"Graph Builder Smoother Line", "Graph Builder Line and Bar Charts",
    "Graph Builder Line Chart", "Graph Builder Heat Map"}
);
dt << group scripts( "VL", {"Set Sex Value Labels", "Set Age Value Labels"} );
Wait( 1 );
dt << select scripts( {"Graph Builder Smoother Line", "Graph Builder Line Chart"} );
Wait( 1 );
dt << ungroup scripts();


```

### [Unsubscribe](#unsubscribe)

**Syntax:** obj \<< Unsubscribe( Key, OnDeleteColumns| OnAddColumns| OnAddRows| OnDeleteRows| OnClose | OnColRename | All )

**Description:** Cancel previous subscription to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Subscribe( "myname", On Close( Print( "Closing Data table" ) ) );
dt << Unsubscribe( "myname", On Close );


```

### [Update](#update)

**Syntax:** obj \<< Update( With( Data Table( name )), Match Columns( column1 = column2, ...), Selected( columns ), Add columns from Update table(<ALL>, <NONE>, \<{column1, column2, ...}>), Replace columns in main table(<ALL>, <NONE>, \<{column1, column2, ...}>), <Ignore missing> )

**Description:** Merges a table of updated data into the original data table by adding or replacing selected columns.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Trial1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Little.jmp" );
dt << Update(
    With( Data Table( "Little" ) ),
    Match Columns( :popcorn = :popcorn, :batch = :batch, :oil amt = :oil )
);


```

**Example 2**

```


dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt2 = New Table( "Little Class",
    Add Rows( 3 ),
    New Column( "name", Character, Nominal, Set Values( {"KATIE", "ALFRED", "HENRY"} ) ),
    New Column( "height", Continuous, Set Values( [999, 999, 999] ) ),
    New Column( "weight", Continuous, Set Values( [999, 999, 999] ) ),
    New Column( "RANK", Continuous, Set Values( [3, 1, 2] ) ),
    New Column( "CODE", Continuous, Set Values( [0, 1, 1] ) )
);
dt1 << Update(
    With( Data Table( "Little Class" ) ),
    Match Columns( :name = :name ),
    Add columns from Update table( {:RANK} ),
    Replace columns in Main Table( {:height} )
);


```

**Example 3**

```


dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt2 = New Table( "Little Class",
    Add Rows( 3 ),
    New Column( "name", Character, Nominal, Set Values( {"KATIE", "ALFRED", "HENRY"} ) ),
    New Column( "height", Continuous, Set Values( [999, 999, 999] ) ),
    New Column( "weight", Continuous, Set Values( [999, 999, 999] ) ),
    New Column( "RANK", Continuous, Set Values( [3, 1, 2] ) ),
    New Column( "CODE", Continuous, Set Values( [0, 1, 1] ) )
);
dt1 << Update(
    With( Data Table( "Little Class" ) ),
    Match Columns( :name = :name ),
    Add columns from Update table( {:RANK} )
);


```

### [Update From Database](#update-from-database)

**Syntax:** obj \<< Update From Database( connectInfo )

**Description:** Updates the data in the table with data re-imported from the database.

```

dt = Open Database( "DSN=somedb; UID=userid;pwd=PW", "SELECT * FROM DB.TABLE" );
dt << Update From Database( "Connect Dialog" );


```

### [XGBoost](#xgboost)

**Syntax:** obj \<< XGBoost

**Description:** Experimental interface to XGBoost for stochastic gradient boosting predictive modeling.

### [set private](#set-private)

**Syntax:** obj \<< set private( \<1|0> )

**Description:** Make the table private. A private table is omitted from the data table list and subscriptions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Show( Get Data Table List() );
Wait( 1 );

dt << Set Private;
Show( Get Data Table List() );
Wait( 1 );

dt << Set Private( 0 );
Show( Get Data Table List() );
Wait( 1 );

Close( dt, No Save );


```

## [Column Scripting](#column-scripting)

### [Item Messages](#item-messages_1)

#### [Add Column Properties](#add-column-properties)

**Syntax:** obj \<< Add Column Properties

**Description:** Adds properties to the selected column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Add Column Properties( List Check( {17, 16, 15, 14, 13, 12} ) );


```

#### [Add From Row States](#add-from-row-states)

**Syntax:** obj \<< Add From Row States

**Description:** Updates a row state column with any currently used row state changes that are not the default state.

```

dt = Open( "$SAMPLE_DATA/Birth Death.jmp" );
dt << New Column( "Row State Col", Row State, Copy from Row States );
dt << Select Rows( 1 );
dt << Select Rows( 5 );
dt << Exclude();
col = Column( "Row State Col" );
col << Add From Row States();


```

#### [Add To Row States](#add-to-row-states)

**Syntax:** obj \<< Add To Row States

**Description:** Copies all row state values in a column that are not the default state to the currently used row state in the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Pickles.jmp" );
col = Column( "Time Marker" );
col << Copy To Row States();
col[5] = Color State( "Red" );
Wait( 2 );
col << Add To Row States();


```

#### [Codes to Labels](#codes-to-labels)

**Syntax:** :col \<< Codes To Labels(<AssociativeArray>|<ListOfAssignments>)

**Description:** Make a column of character values using value labels corresponding to the original codes.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
:age << Value Labels(
    {12 = "12!", 13 = "13!", 14 = "14!", 15 = "15!", 16 = "16!", 17 = "17!"}
);
:age << Codes to Labels;


```

**Example 2**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
:sex << Labels to Codes( ["F" => 1, "M" => 2] );
:sex << Codes To Labels( [1 => "Female", 2 => "Male"] );


```

**Example 3**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
:sex << Labels to Codes( ["F" => 1.5, "M" => 2.5] );
:sex << Codes To Labels( {1.5 = "Female", 2.5 = "Male"} );


```

#### [Color Cell by Value](#color-cell-by-value)

**Syntax:** obj \<< Color Cell by Value( state=0|1 )

**Description:** Changes the display color for cells in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Set Property(
    "Value Colors",
    {12 = -13977430, 13 = -3780930, 14 = -4157407, 15 = -13596965, 16 = -2210961, 17 =
    -10562523}
);
Wait( 1 );
:Age << Color Cell by Value( 1 );


```

#### [Color Cells](#color-cells)

**Syntax:** obj \<< Color Cells( color, \<row | { row1, row2, ...} > )

**Description:** Color the cells in the column with the specified color. If rows are not given, the same color is applied to the entire column.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Color Cells( "Red" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
a = {1, 3, 5};
:Age << Color Cells( "Red", a );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
a = {1, 3, 5};
b = {2, 4, 6};
:height << color cells( {{"Red", a}, {"blue", b}} );


```

#### [Compact](#compact)

**Syntax:** :col \<< Compact( \<1|0> )

**Description:** Changes a character column's internals so it only stores one copy of each value, potentially saving memory and speeding up some operations. The optional Save Format controls the format in which the column is saved. The condensed format is smaller and faster to load, but the table cannot be opened in JMP 17 and earlier. The Default format uses the save format preference.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Air Traffic.jmp" );
:Airline << Compact();


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Air Traffic.jmp" );
:Airline << Compact();
:Airline << Get Compact;


```

#### [Convert to Table Column](#convert-to-table-column)

**Syntax:** obj \<< Convert to Table Column

**Description:** Adds the transform column to the data table.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Transform Column( "New Col", Formula( 1 ) );
:NewCol << Convert to Table Column();


```

#### [Copy from Row States](#copy-from-row-states)

**Syntax:** obj \<< Copy from Row States

**Description:** Copies all row state values currently used in the data table to a column.

```

dt = Open( "$SAMPLE_DATA/Birth Death.jmp" );
dt << New Column( "Row State Col", Row State, Copy from Row States );


```

#### [Copy to Row States](#copy-to-row-states)

**Syntax:** obj \<< Copy to Row States

**Description:** Copies all row state values in a column to the currently used row state in the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Pickles.jmp" );
col = Column( "Time Marker" );
Wait( 2 );
col << Copy To Row States();


```

#### [Data Type](#data-type)

**Syntax:** obj \<< Data Type( "Numeric"|"Character"|"Expression"|"Row State", \<Format("format string")>, \<Input Format("format string")>, \<1|2|4>, < \<<Fail On Conversion Error >, < \<<Return Failed Rows > )

**Description:** Sets the data type for the column. Using the optional arguments, you can also set the format, input format, and the width in bytes if the column is numeric. Fail On Conversion Error aborts the data type change if any values fail to convert. This is especially useful when converting a character column to a numeric column. Return Failed Rows returns a list containing indices of the rows that failed to convert.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Time",
    "Character",
    "Nominal",
    Set Values( {"13:32", "20:10", "20:12", "14:56"} )
);
Wait( 2 );
dt:Time << Set Data Type( "Numeric", Format( "h:m", 12 ), Input Format( "h:m" ) );
dt:Time << Set Modeling Type( "Continuous" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
dt:Age << Set Data Type( "Character" );
dt:Height << Set Data Type( "Numeric", 2 );


```

**Example 3**

```

dt = New Table( "My Table",
    New Column( "col1",
        Character,
        "Nominal",
        Set Values( {"123", "456", "abc", "789", "", "def"} )
    )
);
r = dt:col1 << Set Data Type( "Numeric", <<Fail On Conversion Error, <<Return Failed Rows );
Show( r );


```

**Example 4**

```

dt = New Table( "My Table",
    New Column( "col1",
        Character,
        "Nominal",
        Set Values( {"123", "456", "abc", "789", "", "def"} )
    )
);
r = dt:col1 << Set Data Type( "Numeric", <<Return Failed Rows );
Show( r );


```

#### [Delete Formula](#delete-formula)

**Syntax:** obj \<< Delete Formula

**Description:** Deletes any formula in the column.

```

dt = Open( "$SAMPLE_DATA/Bank Loan.jmp" );
:Time << Delete Formula;


```

#### [Delete Property](#delete-property)

**Syntax:** obj \<< Delete Property( property name )

**Description:** Deletes the named property from the column.

```

dt = Open( "$SAMPLE_DATA/Bank Loan.jmp" );
:Time << Delete Property( "Spec Limits" );


```

#### [Eval Formula](#eval-formula)

**Syntax:** obj \<< Eval Formula

**Description:** Evaluates the formula in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = New Column( "Ratio" );
col << Set Formula( :Height / :Weight );
col << Eval Formula;


```

#### [Format](#format)

**Syntax:** obj \<< Format( "Best|Fixed Dec...", <width>, <dec>, \<"Use Thousands Separator"> ) obj \<< Format( "mdy|ddmmyy|Long Date...", width ) obj \<< Format( "Format Pattern", pattern ) obj \<< Format("Currency", <Country symbol>, <width>, \<"Use Thousands Separator"> ) obj \<< Format("Use Thousands Separator" )

**Description:** Sets the format used for displaying data in the column. Available formats include all items in the Column Info dialog under format.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Height << Format( "Fixed Dec", 6, 3 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/XYZ Stock Averages (plots).jmp" );
:Date << Format( "ddMonyyyy", 9 );
:DJI High << Format( "Currency" );
:DJI Close << Format( "best", "Use Thousands Separator", 10, 0 );
:DJI Low << Format( "Fixed Dec", "Use Thousands Separator", 10, 2 );


```

**Example 3**

```

dt = New Table( "hour24_times",
    Add Rows( 3 ),
    New Column( "time",
        Continuous,
        Format( "Format Pattern", "<hh24><:><mm><:><ss>" ),
        Set Values( {"01:23:45", "18:19:20", "23:45:01"} )
    )
);


```

#### [Formula](#formula)

**Syntax:** obj \<< Set Formula( formula ) obj \<< Formula( formula )

**Description:** Sets the formula in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = New Column( "Ratio" );
col << Set Formula( :Height / :Weight );


```

#### [Get Column Properties](#get-column-properties)

**Syntax:** obj \<< Get Column Properties

**Description:** Copies all properties defined in the selected columns.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
:HARDNESS << Get Column Properties();


```

#### [Get Compact](#get-compact)

**Syntax:** obj \<< Get Compact

**Description:** Is compact set on the column

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Air Traffic.jmp" );
Show( :Airline << Get Compact );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Air Traffic.jmp" );
:Airline << Compact();
Show( :Airline << Get Compact );


```

#### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Gets the column's data table.

**JMP Version Added:** 14

```

dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = Column( dt1, "Age" );
Show( c << Get Name, c << Get Data Table );


```

#### [Get Data Type](#get-data-type)

**Syntax:** obj \<< Get Data Type( \<"English"> )

**Description:** Returns the data type for the column. If the keyword "English" is omitted, the data type is returned in the language that JMP is running in.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
which = dt:Age << Get Data Type;
Show( which );


```

#### [Get Data Type Length](#get-data-type-length)

**Syntax:** obj \<< Get Data Type Length( <English> )

**Description:** Returns the data type and data length of the column. Only the data type is returned if the data length is not fixed, like most character columns.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
which = dt:Age << Get Data Type Length;
Show( which );


```

**Example 2**

```

dt = New Table( "Little Class",
    Add Rows( 3 ),
    New Column( "name", Character( 8 ), Nominal, Set Values( {"KATIE", "CAROL", "MARTHA"} ) ),
    New Column( "Age", Numeric( 2 ), Set Values( [12, 14, 16] ) )
);
nameTypeLength = dt:Name << Get Data Type Length;
ageTypeLength = dt:Age << Get Data Type Length;
Show( nameTypeLength, ageTypeLength );


```

#### [Get Display Width](#get-display-width)

**Syntax:** obj \<< Get Display Width

**Description:** Get column's display width.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 0 );
w = :Height << Get Display Width;


```

#### [Get Excluded](#get-excluded)

**Syntax:** obj \<< Get Excluded

**Description:** Returns 1 if the column is excluded

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = :Weight << Get excluded;
Show( s );


```

#### [Get Field Width](#get-field-width)

**Syntax:** obj \<< Get Field Width

**Description:** Returns the field width used for displaying data in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
width = :Height << Get Field Width;
Show( width );


```

#### [Get Format](#get-format)

**Syntax:** obj \<< Get Format

**Description:** Returns the format for the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
f = :Height << Get Format;
Show( f );


```

#### [Get Formula](#get-formula)

**Syntax:** obj \<< Get Formula

**Description:** Returns the formula in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = New Column( "Ratio" );
col << Set Formula( :Height / :Weight );
col << Eval Formula;
result = col << Get Formula;
Show( result );


```

#### [Get Group Name](#get-group-name)

**Syntax:** obj \<< Get Group Name

**Description:** Return the group name or path of the group containing this column, if any.

**JMP Version Added:** 19

**Nested Group**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Group Columns( "XYZ", :sex, 3 );
dt << Group Columns( Path( "XYZ", "Measures" ), :height, 2 );
Show( :height << Get Group Name );


```

**Simple Group**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Group Columns( :height, 2 );
Show( :height << Get Group Name );


```

#### [Get Header Background Color](#get-header-background-color)

**Syntax:** obj \<< Get Header Background Color

**Description:** Get the header color

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Set Header Background Color( "Light Red" );
Show( :height << Get Header Background Color );


```

#### [Get Header Chart Type](#get-header-chart-type)

**Syntax:** obj \<< Get Header Chart Type

**Description:** Gets the type of chart displayed in the data table column header.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Show( :height << Get Header Chart Type );


```

#### [Get Header Text Color](#get-header-text-color)

**Syntax:** obj \<< Get Header Text Color

**Description:** Get the header text color

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Set Header Text Color( "Dark Purple" );
Show( :height << Get Header Text Color );


```

#### [Get Hidden](#get-hidden)

**Syntax:** obj \<< Get Hidden

**Description:** Returns 1 if the column is hidden

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = :Weight << Get hidden;
Show( s );


```

#### [Get Initial Data](#get-initial-data)

**Syntax:** obj \<< Get Initial Data

**Description:** Get the value or the expression used to initialize column's data.

```

dt = New Table( "MyDt" );
dt << Add Rows( 5 );
Column( dt, 1 ) << set initial data( Log( 1 ) );
Column( dt, 1 ) << get initial data;


```

#### [Get Input Format](#get-input-format)

**Syntax:** obj \<< Get Input Format

**Description:** Returns the format used for inputting and storing the data for the column.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
f = :Date << Get Input Format;
Show( f );


```

#### [Get Labeled](#get-labeled)

**Syntax:** obj \<< Get Labeled

**Description:** Returns 1 if the column is labeled

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = :Weight << Get labeled;
Show( s );


```

#### [Get List Check](#get-list-check)

**Syntax:** obj \<< Get List Check

**Description:** Returns the List Check, if defined in the column.

```

dt = Open( "$SAMPLE_DATA/Movies.jmp" );
prop = :Type << Get List Check;
Show( prop );


```

#### [Get Lock](#get-lock_1)

**Syntax:** obj \<< Get Lock

**Description:** Returns true if a column is locked.

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
lock = :Prin1 << Get Lock;
Show( lock );


```

#### [Get Modeling Type](#get-modeling-type)

**Syntax:** obj \<< Get Modeling Type( \<"English"> )

**Description:** Returns the modeling type for the column. If the keyword "English" is omitted, the modeling type is returned in the language that JMP is running in.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
which = :Age << Get Modeling Type;
Show( which );


```

#### [Get Name](#get-name_1)

**Syntax:** obj \<< Get Name

**Description:** Returns the name of the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col name = Column( 4 ) << Get Name;
Show( col name );


```

#### [Get Properties List](#get-properties-list)

**Syntax:** obj \<< Get Properties List

**Description:** Get the list of names of all the properties for this column

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
:HARDNESS << Get Properties List();


```

#### [Get Property](#get-property_1)

**Syntax:** obj \<< Get Property( Notes| Range Check| List Check| Missing Value Codes| Value Labels| Value Scores | Value Order | Value Colors| Color Gradient| Axis| Units| Response Limits| Design Role| Coding| Mixture| Factor Changes | Spec Limits| Control Limits| Process Screening | Sigma| Process Capability Distribution| MSA | Distribution | Time Frequency| Map Role| Super Categories | Multiple Response | Target Level | Control Level| Profit Matrix | Expression Role | Event Handler | Link ID | Link Reference | Next In Hierarchy )

**Description:** Returns specific properties, if defined in the column.

```

dt = Open( "$SAMPLE_DATA/Bank Loan.jmp" );
prop = :Credit Check << Get Property( "Axis" );
Show( prop );


```

#### [Get Range Check](#get-range-check)

**Syntax:** obj \<< Get Range Check

**Description:** Returns the Range Check, if defined in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Height << Range Check( LE LT( 48, 75 ) );
check = :Height << Get Range Check;
Show( check );


```

#### [Get Role](#get-role)

**Syntax:** obj \<< Get Role( \<"English"> )

**Description:** Returns the role for the column. If the keyword "English" is omitted, the role is returned in the language that JMP is running in.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
which = :Count << Get Role();
Show( which );


```

#### [Get Script](#get-script_1)

**Syntax:** obj \<< Get Script

**Description:** Returns the script to recreate the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = :Age << Get Script;
Show( s );


```

#### [Get Scroll Locked](#get-scroll-locked)

**Syntax:** obj \<< Get Scroll Locked

**Description:** Returns 1 if the column is scroll locked

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = :Weight << Get Scroll locked;
Show( s );


```

#### [Get Selected](#get-selected)

**Syntax:** obj \<< Get Selected

**Description:** Returns 1 if the column is selected.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = :Weight << Get Selected;
Show( s );


```

#### [Get Stored Values](#get-stored-values)

**Syntax:** obj \<< Get Stored Values

**Description:** Returns the values in the columns without Missing Values Codes conversion

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Height << Set Property( "Missing Value Codes", 65 );
valuesMatrix = :Height << Get Stored Values;
Show( valuesMatrix );
valuesList = :Height << GetStoredValues(
    Format(/* a numeric column will be list of character items if a format is supplied, see format function */
        "Currency",
        "EUR",
        2,
        <<use locale(
            0 /* ignore locale and use period for decimal.  the default is 1: use the locale. */
        )
    )
);
Show( valuesList );


```

#### [Get Use Value Labels](#get-use-value-labels)

**Syntax:** obj \<< Get Use Value Labels

**Description:** Returns the state of the Use Value Labels flag.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
flag = :Color << Get Use Value Labels;
Show( flag );


```

#### [Get Value Labels](#get-value-labels)

**Syntax:** obj \<< Get Value Labels

**Description:** Returns the value labels, if defined in the column.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
values = :Color << Get Value Labels;
Show( values );


```

#### [Get Values](#get-values)

**Syntax:** obj \<< Get Values

**Description:** Returns the values in the column.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
valuesMatrix = :Height << Get Values;
Show( valuesMatrix );
valuesList = :Height << GetValues(
    Format(/* a numeric column will be list of character items if a format is supplied, see format function */
        "Currency",
        "EUR",
        2,
        <<use locale(
            0 /* ignore locale and use period for decimal.  the default is 1: use the locale. */
        )
    )
);
Show( valuesList );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Height << Set Property( "Missing Value Codes", 65 );
valuesMatrix = :Height << Get Values;
Show( valuesMatrix );
valuesList = :Height << GetValues(
    Format(/* a numeric column will be list of character items if a format is supplied, see format function */
        "Currency",
        "EUR",
        2,
        <<use locale(
            0 /* ignore locale and use period for decimal.  the default is 1: use the locale. */
        )
    )
);
Show( valuesList );


```

#### [Ignore Errors](#ignore-errors)

**Syntax:** obj \<< Ignore Errors( state=0|1 )

**Description:** Set the flag to ignore errors when a column formula is being evaluated

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = New Column( "Ratio" );
col << Set Formula( :Height / :Weight );
col << ignore errors( true );


```

#### [Input Format](#input-format)

**Syntax:** obj \<< Input Format( format ) obj \<< Input Format( "Format Pattern", pattern )

**Description:** Sets the format used for inputting and storing the data for the column. This is often used for date and time formats.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
:Date << Input Format( "ddmmyyyy" );


```

**Example 2**

```

dt = New Table( "duration_table",
    Add Rows( 3 ),
    New Column( "durations",
        Continuous,
        Format( "Format Pattern", "<Hour><:><mm><:><ss>" ),
        Input Format( "Format Pattern", "<Hour>h <mm>m <ss>s" ),
        Set Values( {"65h 43m 21s", "12h 34m 56s", "4h 32m 10s"} )
    )
);


```

#### [Is Transform Column](#is-transform-column)

**Syntax:** obj \<< Is Transform Column

**Description:** Returns 1 if the column is a transform column, 0 otherwise.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Is Transform Column();


```

#### [IsTransformedOnSASExport](#istransformedonsasexport)

**Syntax:** obj \<< IsTransformedOnSASExport

**Description:** Returns true if the data in the resulting SAS dataset for this column will be changed upon exporting to SAS. Note: This applies only to date columns, as dates are stored differently in SAS and JMP.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
flag = :Date << Is Transformed On SAS Export;
Show( flag );


```

#### [Labels to Codes](#labels-to-codes)

**Syntax:** :col \<< Labels to Codes(<AssociativeArray>|<ListOfAssignments>)

**Description:** Make a column of numeric codes with value labels corresponding to the original character values.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
:sex << Labels to Codes;


```

**Example 2**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
:sex << Labels to Codes( ["F" => 10, "M" => 20] );


```

**Example 3**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
:sex << Labels to Codes( {"F" = 10, "M" = 20} );


```

#### [Lock](#lock)

**Syntax:** obj \<< Lock

**Description:** Locks the column from any further changes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Lock( 1 );


```

#### [Preselect Role](#preselect-role)

**Syntax:** obj \<< Preselect Role( "No Role"|"X"|"Y"|"Weight"|"Freq"|"Validation" )

**Description:** Assigns a preselected role to the data table column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Preselect Role( "Y" );


```

#### [Remove Value Labels](#remove-value-labels)

**Syntax:** obj \<< Remove Value Labels

**Description:** Removes any value labels defined in the column.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
:Color << Remove Value Labels;


```

#### [Reset Transform](#reset-transform)

**Syntax:** obj \<< Reset Transform

**Description:** Removes the cached data for the transform column. Accessing column data will rebuild the cache. Use this to reduce memory or to allow recalculation if the formula depends on external information.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
global:a = 2;
dt << Transform Column( "sqrt[height]", Formula( global:a * Sqrt( :height ) ) );
Show( :"sqrt[height]"n[1] );
global:a = 3;
:"sqrt[height]"n << Reset Transform();
Show( :"sqrt[height]"n[1] );


```

#### [Set Data Type](#set-data-type)

**Syntax:** obj \<< Set Data Type( "Numeric"|"Character"|"Expression"|"Row State", \<Format("format string")>, \<Input Format("format string")>, \<1|2|4>, < \<<Fail On Conversion Error >, < \<<Return Failed Rows > )

**Description:** Sets the data type for the column. Using the optional arguments, you can also set the format, input format, and the width in bytes if the column is numeric. Fail On Conversion Error aborts the data type change if any values fail to convert. This is especially useful when converting a character column to a numeric column. Return Failed Rows returns a list containing indices of the rows that failed to convert.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Time",
    "Character",
    "Nominal",
    Set Values( {"13:32", "20:10", "20:12", "14:56"} )
);
Wait( 2 );
dt:Time << Set Data Type( "Numeric", Format( "h:m", 12 ), Input Format( "h:m" ) );
dt:Time << Set Modeling Type( "Continuous" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
dt:Age << Set Data Type( "Character" );
dt:Height << Set Data Type( "Numeric", 2 );


```

**Example 3**

```

dt = New Table( "My Table",
    New Column( "col1",
        Character,
        "Nominal",
        Set Values( {"123", "456", "abc", "789", "", "def"} )
    )
);
r = dt:col1 << Set Data Type( "Numeric", <<Fail On Conversion Error, <<Return Failed Rows );
Show( r );


```

**Example 4**

```

dt = New Table( "My Table",
    New Column( "col1",
        Character,
        "Nominal",
        Set Values( {"123", "456", "abc", "789", "", "def"} )
    )
);
r = dt:col1 << Set Data Type( "Numeric", <<Return Failed Rows );
Show( r );


```

#### [Set Display Width](#set-display-width)

**Syntax:** obj \<< Set Display Width( number )

**Description:** Change column's display width.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 0 );
w = :Height << Get Display Width;
:Height << Set Display Width( 2 * w );


```

#### [Set Each Value](#set-each-value)

**Syntax:** obj \<< Set Each Value( number )

**Description:** Sets all the values in a column to a constant.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "X" );
dt:X << Set Each Value( 5 );


```

#### [Set Excluded](#set-excluded)

**Syntax:** obj \<< Set Excluded

**Description:** Excludes the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Set excluded;


```

#### [Set Field Width](#set-field-width)

**Syntax:** obj \<< Set Field Width( number )

**Description:** Sets the field width used for displaying data in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Height << Set Field Width( 20 );


```

#### [Set Formula](#set-formula)

**Syntax:** obj \<< Set Formula( formula ) obj \<< Formula( formula )

**Description:** Sets the formula in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = New Column( "Ratio" );
col << Set Formula( :Height / :Weight );


```

#### [Set Header Background Color](#set-header-background-color)

**Syntax:** obj \<< Set Header Background Color

**Description:** Set the header color. Set to "None" to use the default color

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Set Header Background Color( "Light Red" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Set Header Background Color( {250, 200, 150} );


```

#### [Set Header Chart Type](#set-header-chart-type)

**Syntax:** obj \<< Set Header Chart Type

**Description:** Sets the type of chart to display in the data table column header.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Set Header Chart Type( "Run Chart" );


```

#### [Set Header Text Color](#set-header-text-color)

**Syntax:** obj \<< Set Header Text Color

**Description:** Set the header text color. Set to "None" to use the default color

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Set Header Text Color( "Dark Purple" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:height << Set Header Text Color( {100, 50, 100} );


```

#### [Set Hidden](#set-hidden)

**Syntax:** obj \<< Set Hidden

**Description:** Hides the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Set hidden;


```

#### [Set Initial Data](#set-initial-data)

**Syntax:** obj \<< Set Initial Data

**Description:** Initialize the column's data with any constant, or a simple expression.

**Example 1**

```

dt = New Table( "MyDt", New Column(), New Column() );
dt << Add Rows( 5 );
Column( dt, 1 ) << set initial data( Today() );
Column( dt, 2 ) << set initial data( 99 );


```

**Example 2**

```

dt = New Table( "MyDt" );
dt << Add Rows( 5 );
Column( dt, 1 ) << set initial data( Log( 1 ) );


```

#### [Set Labeled](#set-labeled)

**Syntax:** obj \<< Set Labeled

**Description:** Use the column's data value for label.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Set labeled;


```

#### [Set Modeling Type](#set-modeling-type)

**Syntax:** obj \<< Set Modeling Type( "None"|"Continuous"|"Ordinal"|"Nominal"|"Row State"|"Multiple Response"|"Unstructured Text"|"Vector" )

**Description:** Sets the modeling type for the data table column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Set Modeling Type( "Continuous" );


```

#### [Set Name](#set-name_1)

**Syntax:** obj \<< Set Name( name )

**Description:** Sets the column name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Set Name( "Time" );


```

#### [Set Property](#set-property_1)

**Syntax:** obj \<< Set Property( Notes | List Check | Range Check | Axis | Spec Limits | Control Limits | Sigma | Process Capability Distribution | Coding | Mixture | Design Role | Response Limits | Units | Value Order | Value Labels | Value Scores | Row Order Levels | Distribution | Time Frequency | Value Colors | Color Gradient | Missing Value Codes | Factor Change | Map Role | Supercategories | Multiple Response | Profit Matrix | Informative Missing | Expression Role | Link ID | Link Reference | Event Handler | Custom Property, {argument list} )

**Description:** Sets properties in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Set Property( "Units", lbs );


```

#### [Set Scroll Locked](#set-scroll-locked)

**Syntax:** obj \<< Set Scroll Locked

**Description:** Scroll locks the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Set Scroll locked;


```

#### [Set Selected](#set-selected)

**Syntax:** obj \<< Set Selected( state=0|1 )

**Description:** Selects the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Height << Set Selected( 1 );


```

#### [Set Use for Marker](#set-use-for-marker)

**Syntax:** obj \<< Set Use for Marker

**Description:** Use the values in this column as the markers in a graph. Expression columns with pictures or character columns with IDs might work well.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Name << Set Use for Marker;


```

#### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( [ value1, value2, value3, ... ] )

**Description:** Sets the values in a column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "X" );
:X << Set Values(
    [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 1, 2, 3, 4, 5, 6, 7, 8, 9,
    10, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
);


```

#### [SetLock](#setlock)

**Syntax:** obj \<< SetLock

**Description:** Locks the column from any further changes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Lock( 1 );


```

#### [Suppress Eval](#suppress-eval)

**Syntax:** obj \<< Suppress Eval( state=0|1 )

**Description:** Set the flag to suppress evaluation of the formula in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = New Column( "Ratio" );
col << Set Formula( :Height / :Weight );
col << suppress eval( true );


```

#### [Use Value Labels](#use-value-labels)

**Syntax:** obj \<< Use Value Labels( state=0|1 )

**Description:** Substitutes value labels defined in the column in all output.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
:Color << Use Value Labels( 1 );
Distribution( Column( :Color ) );


```

#### [Value Labels](#value-labels)

**Syntax:** obj \<< Value Labels( { value1 = "label1", value2 = "label2", ... } )

**Description:** Sets the Value Labels

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:sex << Value Labels( {"F" = "Female", "M" = "Male"} );


```

## [Data Table Cols](#data-table-cols)

### [Associated Constructors](#associated-constructors_1)

#### [Column](#column)

**Syntax:** y = Column( name|number ); y = Column( dataTable, name|number, \<"formatted"> )

**Description:** Returns a reference to the specified data table column.

```

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


```

### [Item Messages](#item-messages_2)

#### [Add Multiple Columns](#add-multiple-columns)

**Syntax:** obj \<< Add Multiple Columns( Column prefix, number of columns, \<before first|after last|after(column)>, Character|Numeric|Row State, \<fieldwidth(number)> )

**Description:** Creates multiple new columns in the current data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Add Multiple Columns( "Date", 5, Character );


```

#### [Clear Column Selection](#clear-column-selection_1)

**Syntax:** obj \<< Clear Column Selection

**Description:** Clears the column selection in the data table.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Go To( :BP 12F );
Wait( 2 );
dt << Clear Column Selection();


```

#### [Clone Formula Column](#clone-formula-column)

**Syntax:** obj \<< Clone Formula Column( column, n, \<Substitute Column Reference( column1, list )> )

**Description:** Creates n new formula columns based on the given column. Column references to column1 from the original formula will be replaced by each column in list for all n columns. Use multiple Substitute Column Reference arguments when replacing more than one column reference from the original formula.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "Day 1", Formula( (:BP 8M + :BP 12M + :BP 6M) / 3 ) );
list1 = {:BP 8W, :BP 8F};
list2 = {:BP 12W, :BP 12F};
list3 = {:BP 6W, :BP 6F};
dt << Clone Formula Column(
    "Day 1",
    2,
    Substitute Column Reference( :BP 8M, list1 ),
    Substitute Column Reference( :BP 12M, list2 ),
    Substitute Column Reference( :BP 6M, list3 )
);


```

#### [Columns Manager](#columns-manager)

**Syntax:** obj \<< Columns Manager

**Description:** Invoke the Columns Manager on the current table, showing properties and statistics for the columns.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col1 = dt << Columns Manager;


```

#### [Combine Columns](#combine-columns_1)

**Syntax:** obj \<< Combine Columns

**Description:** Combine a set of columns into a delimited (multiple response) column.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Combine Columns(
    delimiter( "," ),
    Columns(
        :Brush After Waking Up, :Brush After Meal, :Brush Before Sleep, :Brush Another Time
    ),
    Selected Columns are Indicator Columns( 1 ),
    Column Name( "When to Brush" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Combine Columns(
    delimiter( "," ),
    Columns(
        :Brush After Waking Up, :Brush After Meal, :Brush Before Sleep, :Brush Another Time
    ),
    Column Name( "When to Brush" )
);


```

#### [Compress Selected Columns](#compress-selected-columns_1)

**Syntax:** obj \<< Compress Selected Columns( { column1, column2, ... )

**Description:** Compresses each column into the most compact form.

Character data will be 1-byte if there are fewer than 255 levels.

Numeric data will be 1-byte if the data is between -127 and 127.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Compress Selected Columns( {:Age, :sex, :Height, :Weight} );


```

#### [Exclude/Unexclude](#excludeunexclude)

**Syntax:** obj \<< Exclude( 0|1 )

**Description:** Excludes the column from any analysis run.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Name << Exclude( 1 );


```

#### [Formula](#formula_1)

**Syntax:** obj \<< Formula

**Description:** Sets a formula in the column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col1 = dt << New Column( "Ratio", Numeric, Continuous );
col1 << Formula( :height / :weight );


```

#### [Freq](#freq)

**Syntax:** obj \<< Preselect Role( Freq )

**Description:** Assigns the Freq role to the data table column

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = Column( "weight" );
col << Preselect Role( "freq" );


```

#### [Go to](#go-to)

**Syntax:** obj \<< Go to( column name|column number )

**Description:** Selects and moves to the specified column in the current data table.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << Go to( :BP 12F );


```

#### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide( 0|1 )

**Description:** Hides the column in the data grid.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Age << Hide( 1 );


```

#### [Invert Column Selection](#invert-column-selection)

**Syntax:** obj \<< Invert Column Selection( <list of columns> )

**Description:** Inverts the current column selection. If a list of columns is given, the columns that are not in the list will be selected.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age << Set Selected( 1 );
dt:height << Set Selected( 1 );
Wait( 1 );
b = dt << Invert Column Selection;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
a = {:height, :weight};
b = dt << Invert Column Selection( a );


```

#### [Label/Unlabel](#labelunlabel)

**Syntax:** obj \<< Label( 0|1 )

**Description:** Sets this column as a label for identification. Values in the column will appear on a graphs when a point is selected.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Age << Label( 1 );


```

#### [Make Indicator Columns](#make-indicator-columns_1)

**Syntax:** obj \<< Make Indicator Columns

**Description:** Make a set of indicator columns from the selected column

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << Make Indicator Columns( columns( {:species, :season} ) );


```

#### [Move Selected Columns](#move-selected-columns)

**Syntax:** obj \<< Move Selected Columns( column|column list, To first|To last|After(column)|after(group)|after(Path({<a>, <b>, ...}) )

**Description:** Moves selected columns in the data table.

**After column**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Go To( :Age );
Wait( 2 );
dt << Move Selected Columns( After( :sex ) );


```

**After group**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << group Columns( "Measures", {:height, :weight} );
dt << Go To( :Age );
Wait( 2 );
dt << Move Selected Columns( After( "Measures" ) );


```

**Input list**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Move Selected Columns( {:height, :weight}, After( :name ) );


```

**To last**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Go To( :Age );
Wait( 2 );
dt << Move Selected Columns( To last );


```

#### [New Column](#new-column)

**Syntax:** obj \<< New Column( <name>, <data type>, <modeling type>, \<Format()>, \<Formula()>, \<Set Property()>, \<Set Values()>, \<Like()> )

**Description:** Creates a new column in the current data table.

**Like**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "like name", Like( :name ) );


```

**New Table**

```

New Table( "test",
    Add Rows( 5 ),
    New Column( "name",
        Character( 8 ),
        Nominal,
        Set Values( {"KATIE", "LOUISE", "JANE", "JACLYN", "LILLIE"} )
    ),
    New Column( "age",
        Numeric,
        Ordinal,
        Format( "Fixed Dec", Use thousands separator( 0 ), 5, 0 ),
        Set Values( [12, 12, 12, 12, 12] )
    ),
    New Column( "code",
        Character( 2 ),
        Nominal,
        Set Values( {"AA", "AA", "BB", "BB", "AA"} )
    )
);


```

**Simple**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "X", Formula( Random Uniform() ) );


```

#### [New Formula Column](#new-formula-column)

**Syntax:** dt \<< New Formula Column(Operation(name, \<Category(name)>), Columns(columns), \<Group By(columns)>)

**Description:** Create a formula column in the table, using the columns specified and applying the operation and optional grouping columns. The operation category can be specified if necessary to disambiguate the operation name. Returns a list of column references to the created columns.

**JMP Version Added:** 17

**Group By**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Formula Column(
    Operation( "Mean" ),
    Columns( :height, :weight ),
    Group By( :age )
);


```

**Log 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Formula Column( Operation( "Log 2" ), Columns( :height, :weight ) );


```

#### [Next Selected Column](#next-selected-column)

**Syntax:** obj \<< Next Selected Column

**Description:** Go to the next selected column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age << Set Selected( 1 );
dt:height << Set Selected( 1 );
Wait( 1 );
dt << Next Selected Column;
Wait( 2 );
dt << Next Selected Column;


```

#### [No Role](#no-role)

**Syntax:** obj \<< Preselect Role( No Role )

**Description:** Removes the assigned role from the data table column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Preselect Role( "No Role" );


```

#### [Original Order](#original-order)

**Syntax:** obj \<< Original Order

**Description:** Moves columns back to their original order in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Go To( :Age );
dt << Move Selected Columns( To last );
Wait( 2 );
dt << Original Order();


```

#### [Paste Column Properties](#paste-column-properties_1)

**Syntax:** obj \<< Paste Column Properties

**Description:** Pastes from the clipboard multiple lists of column properties to multiple columns. Optionally, you can specify a list of target columns instead of selecting them in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << Copy Column Properties( {:MODULUS, :ELONG} );
dt2 = New Table( "test it",
    New Column( "T1", numeric, continuous ),
    New Column( "T2", numeric, continuous ),
    New Column( "T3", numeric, continuous ),
    Add Rows( 10 )
);
dt2 << Paste Column Properties( {:T1, :T3} );


```

#### [Previous Selected Column](#previous-selected-column)

**Syntax:** obj \<< Previous Selected Column

**Description:** Go to the previously selected column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age << Set Selected( 1 );
dt:height << Set Selected( 1 );
Wait( 1 );
dt << Next Selected Column;
dt << Next Selected Column;
Wait( 2 );
dt << Previous Selected Column;


```

#### [Reorder by Data Type](#reorder-by-data-type)

**Syntax:** obj \<< Reorder by Data Type

**Description:** Reorders columns in the data table sorting by data type.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
Wait( 1 );
dt << Reorder By Data Type();


```

#### [Reorder by Modeling Type](#reorder-by-modeling-type)

**Syntax:** obj \<< Reorder by Modeling Type

**Description:** Reorders columns in the data table sorting by modeling type.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
Wait( 1 );
dt << Reorder By Modeling Type();


```

#### [Reorder by Name](#reorder-by-name)

**Syntax:** obj \<< Reorder by Name

**Description:** Reorders columns in the data table sorting by column name.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
Wait( 1 );
dt << Reorder By Name();


```

#### [Reverse Order](#reverse-order)

**Syntax:** obj \<< Reverse Order

**Description:** Reverses the order of columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
Wait( 1 );
dt << Reverse Order();


```

#### [Set Label Columns](#set-label-columns_1)

**Syntax:** obj \<< Set Label Columns( column(s) )

**Description:** Assigns a label role to selected columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
Wait( 1 );
dt << Set Label Columns( :City, :State );


```

#### [Set Scroll Lock Columns](#set-scroll-lock-columns_1)

**Syntax:** obj \<< Set Scroll Lock Columns( column(s) )

**Description:** Locks selected columns in the data table from scrolling. To indicate that a column is locked, the background color changes.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Set Scroll Lock Columns( :City );


```

#### [Text to Columns](#text-to-columns_1)

**Syntax:** obj \<< Text to Columns

**Description:** Make a set of text columns or indicator columns from a delimited text column

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Text To Columns( delimiter( "," ), columns( :Brush Delimited ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << Text To Columns(
    delimiter( "," ),
    columns( :Brush Delimited ),
    Make Indicator Columns( 1 )
);


```

#### [Use for Marker](#use-for-marker)

**Syntax:** obj \<< UseForMarker( 0|1 )

**Description:** Use the values in this column as the markers in a graph. Expression columns with pictures or character columns with IDs might work well.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Name << UseForMarker( 1 );


```

#### [Validation](#validation)

**Syntax:** obj \<< Preselect Role( Validation)

**Description:** Assigns the Validation role to the data table column

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = Column( "age" );
col << Preselect Role( "Validation" );


```

#### [Weight](#weight_1)

**Syntax:** obj \<< Preselect Role( Weight )

**Description:** Assigns the Weight role to the data table column

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:Weight << Preselect Role( "weight" );


```

#### [X](#x)

**Syntax:** obj \<< Preselect Role( X )

**Description:** Assigns the X role to the data table column

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
col = Column( "weight" );
col << Preselect Role( "X" );


```

#### [Y](#y)

**Syntax:** obj \<< Preselect Role( Y )

**Description:** Assigns the Y role to the data table column

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Weight << Preselect Role( "Y" );


```

## [Data Table Rows](#data-table-rows)

### [Item Messages](#item-messages_3)

#### [Add Rows](#add-rows)

**Syntax:** obj \<< Add Rows( <n>, \<At Start|At End|After(m)> | {list of (column name = value) pairs}) )

**Description:** Adds n rows, at start, at end, or after row m to the data table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Add Rows( 3, after( 5 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Add Rows( {name = "David", age = 15} );


```

#### [Clear Row States](#clear-row-states)

**Syntax:** obj \<< Clear Row States

**Description:** Clears from all rows the states, including selected, excluded, hidden, markers, labels, and colors.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [5, 7, 8, 10, 12, 15] );
Wait( 2 );
dt << Clear Row States;


```

#### [Clear Select](#clear-select)

**Syntax:** obj \<< Clear Select

**Description:** Clears or deselects the selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [5, 7, 8, 10] );
Wait( 2 );
dt << Clear Select();


```

#### [Clear Selected Row States](#clear-selected-row-states)

**Syntax:** obj \<< Clear Selected Row States

**Description:** Clears from the selected rows the states, including selected, excluded, hidden, markers, labels, and colors.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Rows( [5, 6, 7, 8, 9, 10] );
r << Exclude;
r << clear select;
r << Select Rows( [5, 6] );
Wait( 1 );
dt << Clear Selected Row States;


```

#### [Color Rows by Row State](#color-rows-by-row-state)

**Syntax:** obj \<< Color Rows by Row State

**Description:** Displays or hides in the cells of the data table, the color assigned in the row state.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Color by Column( :Age );
Wait( 2 );
dt << Color Rows by Row State;


```

#### [Color by Column](#color-by-column)

**Syntax:** obj \<< Color by Column( column, \<Color( number )>, \<Color Theme( color theme )>, < Continuous scale(0|1)>, \<Reverse scale(0|1)>, \<Excluded Row( 0|1 ), <Make window with legend> )

**Description:** Assigns a color for each row in the data table based on the value of the column specified.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Color by Column( :Age );


```

#### [Color or Mark by Column](#color-or-mark-by-column)

**Syntax:** obj \<< Color or Mark by Column( column, \<Color( number )>, \<Color Theme( color theme )>, \<Marker Theme( standard|hollow|solid|paired|classic|alphanumeric )> )

**Description:** Associate colors or markers with the values of a specified column

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Color or Mark by Column( :Age );


```

#### [Colors](#colors)

**Syntax:** obj \<< Colors( color )

**Description:** Colors the selected rows in all graphical output containing markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Run Script( "Bivariate" );
Wait( 1 );
dt << Select Where( :sex == "F" );
Wait( 1 );
dt << Colors( "Red" );


```

#### [Data Filter](#data-filter)

**Syntax:** obj \<< Data Filter( \<Location(x,y)>, \<"Close Outline">, \<"Local">, \<Inverse(0|1)>, \<Show Columns Selector(0|1)>, \<Title(string)>, \<Save And Restore Current Row States(0|1)>, \<Conditional(0|1)>, \<Auto Clear(0|1)>, \<Group By AND(0|1)>, \<Show Histograms And Bars(0|1)>, \<Count Excluded Rows(0|1)>, \<Mode(...)>, \<Add Filter(Columns(...), Where(...), Display(...), \<Select Missing(cols)>, \<Order By Count(cols)>)>, \<Favorites(...)>, \<Animation(...)> )

**Description:** Creates or shows a Data Filter, where you interactively select complex subsets of data. The Mode option determines which row states are affected by selection in the filter. The Add Filter command will add a filter group with the given Columns and Where clauses. When multiple filter groups are present, the combined behavior is determined by the Group By AND option. If the Local keyword is given, the filter can be embedded in a report to filter one or more platforms without affecting other reports.

**Global Data Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Data Filter(
    Location( {218, 114} ),
    Mode( Select( 0 ), Show( 1 ), Include( 1 ) ),
    Add Filter(
        columns( :age, :height ),
        Where( :age == {13, 14, 15} ),
        Where( :height >= 65 & :height <= 70 )
    ),
    Add Filter( columns( :weight ), Where( :weight >= 64 & :weight <= 100 ) )
);


```

**Local Data Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Local Data Filter",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Mode( Show( 1 ), Include( 1 ) ),
                Add Filter(
                    columns( :age, :height ),
                    Where( :age == {13, 14, 15} ),
                    Where( :height >= 65 & :height <= 70 )
                ),
                Add Filter( columns( :weight ), Where( :weight >= 64 & :weight <= 100 ) )
            ),
            dt << Run Script( "Bivariate" ),
            dt << Run Script( "Distribution" )
        )
    )
);


```

#### [Data View](#data-view)

**Syntax:** obj \<< Data View

**Description:** Makes a new data view of the currently selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Where( :age < 14 );
dt << Data View;


```

#### [Delete Rows](#delete-rows)

**Syntax:** obj \<< Delete Rows

**Description:** Deletes the selected row(s).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [5, 7, 8, 10] );
Wait( 2 );
r = dt << Delete Rows;
Show( r );


```

#### [Exclude/Unexclude](#excludeunexclude_1)

**Syntax:** obj \<< Exclude/Unexclude

**Description:** Excludes the selected rows from contributing to calculations.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Rows( [5, 7, 8, 10] );
r << Exclude;


```

#### [Get Rows](#get-rows)

**Syntax:** obj \<< Get Rows( number )

**Description:** returns a list of column values for the specified rows

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Get Rows( 3 );
dt << Get Rows( {1, 2, 3} );


```

#### [Go to Row](#go-to-row)

**Syntax:** obj \<< Go to Row( row number )

**Description:** Returns a row object, moves to the specified row, selects the row and highlights it.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Go To Row( 5 );


```

#### [Hide and Exclude](#hide-and-exclude)

**Syntax:** obj \<< Hide and Exclude

**Description:** Hides the selected rows from appearing on graphs and excludes them from contributing to calculations.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Rows( [5, 7, 8, 10] );
r << Hide and Exclude;


```

#### [Hide/Unhide](#hideunhide_1)

**Syntax:** obj \<< Hide/Unhide

**Description:** Hides the selected rows from appearing on graphs.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Go To Row( 12 );
r << Hide;


```

#### [Insert Rows](#insert-rows)

**Syntax:** obj \<< Insert Rows

**Description:** Inserts rows before selected rows. Has no effect if no rows are selected.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [3, 4, 5] );
dt << Insert Rows;


```

#### [Invert Row Selection](#invert-row-selection)

**Syntax:** obj \<< Invert Row Selection

**Description:** Inverts the current row selection.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Where( :Age < 14 );
Wait( 2 );
r << Invert Row Selection;


```

#### [Label/Unlabel](#labelunlabel_1)

**Syntax:** obj \<< Label/Unlabel

**Description:** Labels the selected rows in all graphical output containing markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Go To Row( 5 );
r << Label;


```

#### [Marker by Column](#marker-by-column)

**Syntax:** obj \<< Marker by Column( column, \<Marker( number )>, \<Marker Theme( standard | hollow | solid | paired | classic | alphanumeric )>, \<Color theme( string )>, < Continuous scale(0|1)>, \<Reverse scale(0|1)>, \<Excluded Row( 0|1 ), <Make window with legend> )

**Description:** Assigns a marker for each row in the data table based on the value of the column specified.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Marker by Column( :sex );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/big class.jmp" );
dt << Marker By Column(
    :age,
    Marker( 1 ),
    Color theme( "White to Red" ),
    Marker Theme( "alphanumeric" ),
    Reverse Scale( 1 ),
    Make Window With Legend
);


```

#### [Markers](#markers)

**Syntax:** obj \<< Markers( marker )

**Description:** Changes the markers for the selected rows in all graphical output containing markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Where( :sex == "M" );
r << Markers( "+" );


```

#### [Move Rows](#move-rows)

**Syntax:** obj \<< Move Rows( At Start|At End|After(n) )

**Description:** Moves the selected rows up or down in the data table to the specified new location.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Rows( [5, 7, 8, 10] );
Wait( 2 );
r << Move Rows( At Start );


```

#### [Name Selection in Column](#name-selection-in-column)

**Syntax:** obj \<< Name Selection in Column( Column Name( name ), Selected( string ), Unselected( string ) )

**Description:** Creates a new categorical column with two values, one each for the selected and nonselected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Where( :Age < 14 );
dt << Name Selection in Column(
    Column Name( "Younger" ),
    Selected( "Yes" ),
    Unselected( "No" )
);


```

#### [Next Selected](#next-selected)

**Syntax:** obj \<< Next Selected

**Description:** Highlights the next row in the group of selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Rows( [5, 7, 8, 10] );
Wait( 2 );
r << Next Selected;


```

#### [Previous Selected](#previous-selected)

**Syntax:** obj \<< Previous Selected

**Description:** Highlights the previous row in the group of selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Rows( [5, 7, 8, 10] );
Wait( 2 );
r << Previous Selected;


```

#### [Row Editor](#row-editor)

**Syntax:** obj \<< Row Editor

**Description:** Opens the Row Editor dialog for the selected row(s).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
r = dt << Select Rows( [5, 7, 8, 10] );
r << Row Editor();


```

#### [Row Selection](#row-selection)

**Syntax:** obj \<< Row Selection( Select Where(condition), < current selection("extend" | "restrict" | "clear")>, \<Dialog("Keep Dialog Open")>, \<Match Case(0|1)> )

**Description:** Selects all rows that meet the defined condition, with option to extend or restrict existing selections, option to execute the selection or just show the dialog. When Match Case is omitted, the default is a case-sensitive match.

**JMP Version Added:** 15

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Row Selection( Select where( :age < 15 ) );


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Row Selection( Select where( :age < 15 ) );
Wait( 2 );
dt << Row Selection( Select where( :age == 15 ), current selection( "extend" ) );


```

**Example 3**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Row Selection( Select where( :age < 15 ) );
dt << Row Selection(
    Select where( :sex == "M" ),
    current selection( "restrict" ),
    Dialog( "keep dialog open" )
);


```

**Example 4**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Row Selection( Select where( :name == "jane" ), Match Case( 0 ) );


```

#### [Select All Matching Cells](#select-all-matching-cells)

**Syntax:** obj \<< Select All Matching Cells

**Description:** Selects in all open data tables, all rows where the values in the column selected match one of the values for the rows selected in that column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt2 = Open( "$SAMPLE_DATA/Students.jmp" );
dt << Select Rows( [1, 2, 3, 4] );
dt << Go To( :Height );
Wait( 2 );
dt << Select All Matching Cells();


```

#### [Select All Rows](#select-all-rows)

**Syntax:** obj \<< Select All Rows

**Description:** Selects all the rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select All Rows;


```

#### [Select Dominant](#select-dominant)

**Syntax:** obj \<< Select Dominant( {column1, column2, ...},{0|1, 0|1, ...} )

**Description:** Selects all rows based on the high (1) or low (0) values of the Pareto Frontier.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Go To( :height );
dt << Select Dominant( {:height, :weight}, {0, 0} );


```

#### [Select Duplicate Rows](#select-duplicate-rows)

**Syntax:** obj \<< Select Duplicate Rows( \<match(column1, column2, ...)> )

**Description:** Selects duplicate rows and matches on the selected columns. If no match columns are given, rows are matched on all columns of the table. Returns the number of duplicate rows.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select duplicate rows( Match( :age, :height ) );


```

#### [Select Excluded](#select-excluded)

**Syntax:** obj \<< Select Excluded

**Description:** Selects all excluded rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [5, 7, 8, 10, 15] );
dt << Exclude( 1 );
dt << Clear Select;
Wait( 2 );
dt << Select Excluded;


```

#### [Select Hidden](#select-hidden)

**Syntax:** obj \<< Select Hidden

**Description:** Selects all hidden rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [5, 7, 8, 10, 15] );
dt << Hide( 1 );
dt << Clear Select;
Wait( 2 );
dt << Select Hidden;


```

#### [Select Labeled](#select-labeled)

**Syntax:** obj \<< Select Labeled

**Description:** Selects all labeled rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [5, 7, 8, 10, 15] );
dt << Label( 1 );
dt << Clear Select;
Wait( 2 );
dt << Select Labeled;


```

#### [Select Matching Cells](#select-matching-cells)

**Syntax:** obj \<< Select Matching Cells

**Description:** Selects all rows where the values in the column selected match one of the values for the rows selected in that column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [1, 2, 3, 4] );
dt << Go To( :Height );
Wait( 2 );
dt << Select Matching Cells();


```

#### [Select Randomly](#select-randomly)

**Syntax:** obj \<< Select Randomly( number | probability | Sample Size( number ) | Sampling Rate( probability ) )

**Description:** Selects a specified fraction of rows randomly.

**Probability**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Randomly( 0.3 );


```

**Sample Size**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Randomly( Sample Size( 12 ) );


```

**Sampling Rate**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Randomly( Sampling Rate( 0.3 ) );


```

#### [Select Rows](#select-rows)

**Syntax:** obj \<< Select Rows( [row1, row2, ...] )

**Description:** Selects the specified rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [5, 7, 8, 10] );


```

#### [Select Where](#select-where)

**Syntax:** obj \<< Select Where( condition, < current selection("extend" | "restrict" | "clear")> )

**Description:** The options are extending or restricting selections, executing the selection, or showing only the dialog.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Where( :Age < 14 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Where( :Age == 14 );
Wait( 0 );
dt << Select Where( :sex == "M", current selection( "extend" ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Where( Contains( :name, "AR" ) );


```

## [Filter Views](#filter-views)

### [Item Messages](#item-messages_4)

#### [Get Data Filter](#get-data-filter)

**Syntax:** expr = obj \<< Get Data Filter

**Description:** Returns the filter view's filter definition

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Get Data Filter );


```

#### [Get Data Table](#get-data-table_1)

**Syntax:** data table = obj \<< Get Data Table

**Description:** Returns the table that owns the filter view

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Get Data Table );


```

#### [Get Name](#get-name_2)

**Syntax:** string = obj \<< Get Name

**Description:** Get the name of the filter view

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Get Name );


```

#### [Get Show Hidden Rows](#get-show-hidden-rows)

**Syntax:** 0|1 = obj \<< Get Show Hidden Rows

**Description:** Returns the show hidden rows setting for this filter view

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Show Hidden Rows( 1 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Get Show Hidden Rows );


```

#### [Get Type](#get-type)

**Syntax:** obj \<< Get Type

**Description:** Get the type of the filter view; one of: "Unfiltered", "Filtered", or "TemporaryFiltered".

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Get Type, fv << Is Temporary, fv << Is Unfiltered );


```

#### [Is Locked](#is-locked)

**Syntax:** 0|1 = obj \<< Is Locked

**Description:** Returns the lock setting for this filter view

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Lock( 1 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Is Locked );


```

#### [Is Temporary](#is-temporary)

**Syntax:** 0|1 = obj \<< Is Temporary

**Description:** Returns 1 if the filtered view is a temporary filter view

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Get Type, fv << Is Temporary, fv << Is Unfiltered );


```

#### [Is Unfiltered](#is-unfiltered)

**Syntax:** 0|1 = obj \<< Is Unfiltered

**Description:** Returns 1 if the filtered view is the unfiltered filter view

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Get Type, fv << Is Temporary, fv << Is Unfiltered );


```

#### [Lock](#lock_1)

**Syntax:** obj \<< Lock( 0|1 )

**Description:** Prevent editing this filter view.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
fv << Lock( 1 );
Show( fv << Is Locked );


```

#### [Set Data Filter](#set-data-filter)

**Syntax:** obj \<< Set Data Filter( expr )

**Description:** Changes the filter definition of the filter view. The filter definition of the unfiltered view cannot be changed

**JMP Version Added:** 19

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View( "Dream", Active( 0 ) );
fv << Set Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) );
Show( fv << Get Data Filter );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View( "Dream", Active( 0 ) );
fv << Set Data Filter(
    Data Filter(
        Inverse( 1 ),
        Add Filter( Columns( :Island ), Where( :Island == "Dream" ) )
    )
);
Show( fv << Get Data Filter );


```

#### [Set Name](#set-name_2)

**Syntax:** string = obj \<< Set Name( name )

**Description:** Changes the name of the filter view. The names of the unfiltered view and the temporary filtered view cannot be changed.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
Show( fv << Set Name( "Dream Penguins" ) );
Show( fv << Get Name );


```

#### [Show Hidden Rows](#show-hidden-rows)

**Syntax:** obj \<< Show Hidden Rows( 0|1 )

**Description:** Changes the show hidden rows setting for this filter view.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fv = dt << New Filter View(
    "Dream",
    Active( 0 ),
    Show Hidden Rows( 1 ),
    Data Filter( Add Filter( Columns( :Island ), Where( :Island == "Dream" ) ) )
);
fv << Show Hidden Rows( 0 );
Show( fv << Get Show Hidden Rows );


```

# [Datafeed](#datafeed)

## [Associated Constructors](#associated-constructors)

### [Datafeed](#datafeed_1)

**Syntax:** y = Open Datafeed( ... )

**Description:** (Windows only) Creates a real-time method to read data continuously, such as from a laboratory measurement device connected to a serial port.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << getLine ) )
);


```

## [Item Messages](#item-messages)

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** (Windows only) Closes the data feed object and its window.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << Get Line ) )
);
Wait( 1 );
feed << Close;


```

### [Connect](#connect)

**Syntax:** obj \<< Connect( Port( "com1"|"com2"|"lpt1"... ), Parity( even|odd|none ), Baud rate( 4800|9600 ), Data bits( 8|7 ), \<Stop bits( 0|1|2 )>, \<DTR_DSR( 0|1 )>, \<RTS_CTS( 0|1 )>, \<XON_XOFF( 1|0 )> )

**Description:** (Windows only) Sets up port settings for the connection to the device.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << Get Line ) )
);


```

### [Disconnect](#disconnect)

**Syntax:** obj \<< Disconnect

**Description:** (Windows only) Disconnects the device from the data feed queue but leaves the data feed object active.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << Get Line ) )
);
feed << Disconnect;


```

### [EOL](#eol)

**Syntax:** obj \<< EOL( "CR"|"LF"|"CRLF" )

**Description:** (Windows only) Sets the line ending value used as a separator when parsing incoming lines of data. The value is also used as the terminator in outgoing lines of data. CR = ASCII character 13 (Carriage Return). LF = ASCII character 10 (Line Feed). CRLF will use both CR and LF in sequence.

```

exfeed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script(
        ex = exfeed << Get Line;
        Show( ex );
    )
);
exfeed << EOL( "CRLF" );
For( exi = 0, exi < 5, exi++, 
    /* Example to test a feed when the real data source is not available.*/    
    exfeed << Queue Line( Char( exi ) );
    exfeed << EOL;
    Wait( .5 );
);


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << getLine ) )
);
t = feed << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

### [Get Line](#get-line)

**Syntax:** line = obj \<< Get Line

**Description:** (Windows only) Returns and removes one line from the data feed queue.

```

exfeed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script(
        ex = exfeed << Get Line;
        Show( ex );
    )
);


```

### [Get Lines](#get-lines)

**Syntax:** list = obj \<< Get Lines

**Description:** (Windows only) Returns as a list and removes all lines from the data feed queue.

```

exfeed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script(
        ex = exfeed << Get Lines;
        Show( ex );
    )
);
For( exi = 0, exi < 5, exi++, 
    /* Example to test a feed when the real data source is not available.*/    
    exfeed << Queue Line( Char( exi ) );
    Wait( .5 );
);


```

### [Print Queue](#print-queue)

**Syntax:** obj \<< Print Queue

**Description:** (Windows only) Prints the internal queue of messages to the log window.

```

exfeed = Open Datafeed( /*no JSL to consume queue for this example*/ );
For( exi = 1, exi <= 5, exi++,
    exfeed << Queue Line( {"alice", "chuck", "ralph", "susan", "bobby"}[exi] )
);
exfeed << print queue;/* or red triangle menu item */;


```

### [Queue Line](#queue-line)

**Syntax:** obj \<< Queue Line( string )

**Description:** (Windows only) Sends one line to the end of the data feed queue.

```

exfeed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script(
        ex = exfeed << Get Line;
        Show( ex );
    )
);
For( exi = 0, exi < 5, exi++, 
    /* Example to test a feed when the real data source is not available.*/    
    exfeed << Queue Line( Char( exi ) );
    Wait( .5 );
);


```

### [Restart](#restart)

**Syntax:** obj \<< Restart

**Description:** (Windows only) Restarts processing queued lines.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << Get Line ) )
);
feed << Stop;
Wait( 1 );
feed << Restart;


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** (Windows only) Assigns the script that is run each time a line of data is received.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << Get Line ) )
);


```

### [Stop](#stop)

**Syntax:** obj \<< Stop

**Description:** (Windows only) Stops processing queued lines.

```

feed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script( Print( feed << Get Line ) )
);
feed << Stop;


```

### [Write](#write)

**Syntax:** obj \<< Write( string )

**Description:** (Windows only) Sends a string to the data feed device.

**JMP Version Added:** 14

```

exfeed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script(
        ex = exfeed << Get Line;
        Show( ex );
    )
); 
/* Example - send a message to external device over the serial port to trigger data messages. This can be used to send control messages to a sensor or other attached device.*/
exfeed << Write( "Ready" );


```

### [Write Line](#write-line)

**Syntax:** obj \<< Write Line( string )

**Description:** (Windows only) Sends the string to the data feed device. If EOL has been set for the data feed, the strings are terminated by the EOL value specified. If EOL has not been set, the line is terminated with CRLF.

**JMP Version Added:** 14

```

exfeed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script(
        ex = exfeed << Get Line;
        Show( ex );
    )
); 
/* Example - send a message to external device over the serial port to trigger data messages.*/
exfeed << Write Line( "Ready" );


```

### [Write Lines](#write-lines)

**Syntax:** obj \<< Write Lines( list )

**Description:** (Windows only) Sends a list of strings to the data feed device. If EOL has been set for the data feed, each string is separated by the EOL value. If EOL has not been set, each line is separated with CRLF.

**JMP Version Added:** 14

```

exfeed = Open Datafeed(
    Connect( Port( "com1" ), Baud rate( 4800 ), Parity( even ), DataBits( 8 ) ),
    Set Script(
        ex = exfeed << Get Line;
        Show( ex );
    )
); 
/* Example - send a message to external device over the serial port.*/
exfeed << Write Lines( {"Ready", "Set", "Go"} );


```

# [Degradation](#degradation)

## [Associated Constructors](#associated-constructors)

### [Degradation](#degradation_1)

**Syntax:** Degradation( Y( column ), Time( column ), Application( "Repeated Measures Degradation"|"Destructive Degradation"|"Stability Test" ), \<X( column )>, \<Label( column )>, \<Freq( column )>, \<Censor( column )>, \<Censor Code( value )>, \<Upper Spec Limit( value )>, \<Lower Spec Limit( value )>, \<Censoring Time( value )> )

**Description:** Models degradation over time using linear and nonlinear curves. Analysis options include stability analysis and generation of pseudo-failure data.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);


```

## [Columns](#columns)

### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    Censor( :Censor ),
    X( :Degrees ),
    Application( Destructive Degradation )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    Freq( :_freqcol )
);


```

### [Label](#label)

**Syntax:** obj \<< Label( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    X( :Batch ),
    Application( "Repeated Measures Degradation" )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    X( :Batch ),
    Application( "Repeated Measures Degradation" )
);


```

### [System ID](#system-id)

**Syntax:** obj \<< System ID( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    X( :Batch ),
    Application( "Repeated Measures Degradation" )
);


```

### [Time](#time)

**Syntax:** obj \<< Time( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    X( :Batch ),
    Application( "Repeated Measures Degradation" )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    X( :Batch ),
    Application( "Repeated Measures Degradation" )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    X( :Batch ),
    Application( "Repeated Measures Degradation" )
);


```

## [Item Messages](#item-messages)

### [Censor Code](#censor-code)

**Syntax:** obj = Degradation(...Censor Code( value=1 )...)

**Description:** Identifies the value in the Censor column that designates right-censored observations. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Application( "Destructive Degradation" )
);


```

### [Connect Data Markers](#connect-data-markers)

**Syntax:** obj \<< Connect Data Markers( state=0|1 )

**Description:** Shows or hides lines that connect the points on the Overlay plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Connect Data Markers( 0 )
);
Wait( 1 );
obj << Connect Data Markers( 1 );


```

### [Curve Interval Alpha](#curve-interval-alpha)

**Syntax:** obj \<< Curve Interval Alpha( fraction )

**Description:** Specifies the alpha level that is used for the confidence interval curves in the Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Show Curve Interval( "Prediction Interval" );
Wait( 1 );
obj << Curve Interval Alpha( .01 );


```

### [Generate Pseudo Failure Data](#generate-pseudo-failure-data)

**Syntax:** Generate Pseudo Failure Data(interval_censor, <alpha>)

**Description:** Saves the predicted time that each unit crosses the specification limit to a new data table. The new data table contains a Life Distribution or Fit Life by X script that can be used to fit a distribution to the pseudo failure times.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Lower Spec Limit( 0 );
obj << Set Upper Spec Limit( 6 );
obj << Set Censoring Time( 6 );
dt1 = obj << Generate Pseudo Failure Data( 1, .05 );


```

### [Generate Report for Current Model](#generate-report-for-current-model)

**Syntax:** obj \<< Generate Report for Current Model

**Description:** Creates a report for the current model settings. This includes a Model Summary report and an Estimates report that contains the parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
Wait( 1 );
obj << Generate Report for Current Model;


```

### [Get Inverse Prediction Results](#get-inverse-prediction-results)

**Syntax:** obj \<< Get Inverse Prediction Results

**Description:** Returns a named list that contains the results from the Inverse Prediction plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 10 );
obj << Get Inverse Prediction Results;


```

### [Get Prediction Results](#get-prediction-results)

**Syntax:** obj \<< Get Prediction Results

**Description:** Returns a named list that contains the results from the Prediction Plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Longitudinal Prediction Time( 4500 );
obj << Get Prediction Results;


```

### [Get Residuals](#get-residuals)

**Syntax:** obj \<< Get Residuals

**Description:** Returns a named list that contains the results from the Residual Plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Get Residuals;


```

### [Get Results](#get-results)

**Syntax:** obj \<< Get Results

**Description:** Returns a named list that contains the results for all fitted models.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Generate Report for Current Model;
obj << Get Results;


```

### [Inverse Prediction Alpha](#inverse-prediction-alpha)

**Syntax:** obj \<< Inverse Prediction Alpha( fraction )

**Description:** Specifies the alpha level that is used for the intervals in the Inverse Prediction plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 6 );
obj << Show Curve Interval( "Prediction Interval" );
obj << Show Residual Plot( 0 );
obj << No Tab List( 1 );
obj << Inverse Prediction Interval( "Prediction Interval" );
Wait( 1 );
obj << Inverse Prediction Alpha( .01 );


```

### [Inverse Prediction Interval](#inverse-prediction-interval)

**Syntax:** obj \<< Inverse Prediction Interval( "No Interval"|"Confidence Interval"|"Prediction Interval" )

**Description:** Shows or hides confidence or prediction intervals for the pseudo failure times that are shown on the Inverse Prediction plot. When intervals are enabled, the intervals are also included in the data table that is created when using the Save Crossing Time option.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 6 );
obj << Show Curve Interval( "Prediction Interval" );
obj << Show Residual Plot( 0 );
obj << No Tab List( 1 );
Wait( 1 );
obj << Inverse Prediction Interval( "Prediction Interval" );


```

### [Inverse Prediction Side](#inverse-prediction-side)

**Syntax:** obj \<< Inverse Prediction Side( "Two sided"|"Lower One Sided"|"Upper One sided" )

**Description:** Specifies whether one-sided or two-sided intervals are shown in the Inverse Prediction plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 6 );
obj << Show Curve Interval( "Prediction Interval" );
obj << No Tab List( 1 );
obj << Show Residual Plot( 0 );
obj << Inverse Prediction Interval( "Prediction Interval" );
Wait( 1 );
obj << Inverse Prediction Side( "Lower One Sided" );


```

### [Longitudinal Prediction Alpha](#longitudinal-prediction-alpha)

**Syntax:** obj \<< Longitudinal Prediction Alpha( fraction )

**Description:** Specifies the alpha level that is used for the intervals in the Prediction Plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 6 );
obj << Show Curve Interval( "Prediction Interval" );
obj << No Tab List( 1 );
obj << Show Residual Plot( 0 );
obj << Show Inverse Prediction Plot( 0 );
obj << Longitudinal Prediction Interval( "Prediction Interval" );
obj << Longitudinal Prediction Time( 4500 );
Wait( 1 );
obj << Longitudinal Prediction Alpha( .01 );


```

### [Longitudinal Prediction Interval](#longitudinal-prediction-interval)

**Syntax:** obj \<< Longitudinal Prediction Interval( "No Interval"|"Confidence Interval"|"Prediction Interval" )

**Description:** Shows or hides confidence or prediction intervals for the estimated responses that are shown on the Prediction Plot. When intervals are enabled, the intervals are also included in the data table that is created when using the Save Predictions option.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 6 );
obj << Show Curve Interval( "Prediction Interval" );
obj << No Tab List( 1 );
obj << Show Residual Plot( 0 );
obj << Show Inverse Prediction Plot( 0 );
obj << Longitudinal Prediction Time( 4500 );
Wait( 1 );
obj << Longitudinal Prediction Interval( "Prediction Interval" );


```

### [Longitudinal Prediction Time](#longitudinal-prediction-time)

**Syntax:** obj \<< Longitudinal Prediction Time( number )

**Description:** Specifies the time value for which you want to predict the response.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 6 );
obj << Show Curve Interval( "Prediction Interval" );
obj << No Tab List( 1 );
obj << Show Residual Plot( 0 );
obj << Show Inverse Prediction Plot( 0 );
obj << Longitudinal Prediction Interval( "Prediction Interval" );
Wait( 1 );
obj << Longitudinal Prediction Time( 3000 );


```

### [No Tab List](#no-tab-list)

**Syntax:** obj \<< No Tab List( state=0|1 )

**Description:** Arranges the Residual Plot, Inverse Prediction, and Prediction Graph tabs as a stacked report.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
Wait( 1 );
obj << No Tab List( 1 );


```

### [Nonlinear Path](#nonlinear-path)

**Syntax:** obj \<< Nonlinear Path

**Description:** Sets the degradation path style to Nonlinear Path.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
Wait( 1 );
obj << Nonlinear Path;


```

### [Prediction Settings](#prediction-settings)

**Syntax:** obj \<< Prediction Settings

**Description:** Opens a window that contains options to modify the settings that are used in the model predictions.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
Wait( 0 );
obj << Prediction Settings;


```

### [Residual Plot](#residual-plot)

**Syntax:** obj \<< Residual Plot( \<Jittering( state=0|1 )>, \<Jittering Scale( number )>, \<Separate Groups( state=0|1 )> )

**Description:** Enables you to specify options for the Residual Plot.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Residual Plot( Jittering( 1 ), Jittering Scale( 0.5 ) );
Wait( 1 );
obj << Residual Plot( Jittering Scale( 1.5 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Application( "Repeated Measures Degradation" )
);
Wait( 1 );
obj << Residual Plot( Jittering( 1 ), Separate Groups( 1 ) );


```

### [Save Crossing Time](#save-crossing-time)

**Syntax:** obj \<< Save Crossing Time

**Description:** Saves the pseudo failure times for the current model to a new data table. The new data table contains a Life Distribution or Fit Life by X script that can be used to fit a distribution to the pseudo failure times. When one of the Inverse Prediction Interval options is enabled, the table also includes the intervals.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Save Crossing Time;


```

### [Save Predictions](#save-predictions)

**Syntax:** obj \<< Save Predictions

**Description:** Saves the predicted response values for the current model to a new data table. The table also includes columns for lower and upper bounds based on the setting of the Longitudinal Prediction Interval option.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Longitudinal Prediction Time( 4500 );
obj << Save Predictions;


```

### [Save Residuals](#save-residuals)

**Syntax:** obj \<< Save Residuals

**Description:** Saves the residuals for the current model to a new data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Save Residuals;


```

### [Set Baseline](#set-baseline)

**Syntax:** obj \<< Set Baseline( number )

**Description:** Specifies the normal use conditions for the explanatory variable in nonlinear degradation paths. The baseline value appears on the Overlay plot as a black line.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Application( "Repeated Measures Degradation" ),
    Show Fitted Lines( 1 ),
    Path Specifications(
        Nonlinear Path(
            Add Formula(
                Formula Name( "Reaction Rate 1" ),
                Formula(
                    Parameter(
                        {DInf = -1.4423, Ru = 0.000526206474198, Ea = 0.816981438481622},
                        DInf * (1 - Exp(
                            -Ru * Exp(
                                Ea * (11604.5181215503 / (193.5 + 273.15) - 11604.5181215503
                                 / (Degrees C + 273.15))
                            ) * Hours
                        ))
                    )
                ),
                Initial Values( [-1.4423, 0.000526206474198, 0.816981438481622] ),
                Lower( [-1.58653, 0.0004735858267782, 0.73528329463346] ),
                Upper( [-1.29807, 0.0005788271216178, 0.898679582329784] ),
                Fitting Method( Newton ),
                Fixed( [0, 0, 0] )
            ),
            Select Formula( "Reaction Rate 1" )
        )
    ),
    Nonlinear Path( 1 )
);
Wait( 1 );
obj << Set Baseline( 130 );


```

### [Set Censoring Time](#set-censoring-time)

**Syntax:** obj \<< Set Censoring Time( number )

**Description:** Specifies the censoring time, which appears on the Overlay and Inverse Prediction plots as a dotted vertical line. When No Interval is selected for the Inverse Prediction Interval option, observations that exceed the Censoring Time are displayed on horizontal lines starting at the Censoring Time. If Confidence Interval or Prediction Interval is selected for the Inverse Prediction Interval option, horizontal lines extend indefinitely to the right of observations whose upper limits exceed the Censoring Time. The Censoring Time is reflected in data tables that are created using the Save Crossing Time and Generate Pseudo Failure Data options.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Show Fitted Lines( 1 );
Wait( 1 );
obj << Set Censoring Time( 3800 );


```

### [Set Lower Spec Limit](#set-lower-spec-limit)

**Syntax:** obj \<< Set Lower Spec Limit( number )

**Description:** Specifies the lower specification limit. Specification limits appear on the Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Application( "Repeated Measures Degradation" )
);
obj << Show Fitted Lines( 1 );
Wait( 1 );
obj << Set Lower Spec Limit( -1.5 );


```

### [Set Upper Spec Limit](#set-upper-spec-limit)

**Syntax:** obj \<< Set Upper Spec Limit( number )

**Description:** Specifies the upper specification limit. Specification limits appear on the Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Show Fitted Lines( 1 );
Wait( 1 );
obj << Set Upper Spec Limit( 6 );


```

### [Show Curve Interval](#show-curve-interval)

**Syntax:** obj \<< Show Curve Interval( "No Interval"|"Confidence Interval"|"Prediction Interval" )

**Description:** Shows or hides the confidence or prediction intervals for the fitted lines that are shown on the Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
Wait( 1 );
obj << Show Curve Interval( "Prediction Interval" );


```

### [Show Fitted Lines](#show-fitted-lines)

**Syntax:** obj \<< Show Fitted Lines( state=0|1 )

**Description:** Shows or hides the fitted lines on the Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Show Fitted Lines( 0 )
);
Wait( 1 );
obj << Show Fitted Lines( 1 );


```

### [Show Inverse Prediction Plot](#show-inverse-prediction-plot)

**Syntax:** obj \<< Show Inverse Prediction Plot( state=0|1 )

**Description:** Shows or hides the Inverse Prediction plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Show Residual Plot( 0 ),
    Show Inverse Prediction Plot( 0 )
);
obj << Set Upper Spec Limit( 6 );
obj << No Tab List( 1 );
Wait( 1 );
obj << Show Inverse Prediction Plot( 1 );


```

### [Show Legend](#show-legend)

**Syntax:** obj \<< Show Legend( state=0|1 )

**Description:** Shows or hides a legend for the markers used on the Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Show Legend( 1 );


```

### [Show Residual Plot](#show-residual-plot)

**Syntax:** obj \<< Show Residual Plot( state=0|1 )

**Description:** Shows or hides the Residual Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Show Residual Plot( 0 )
);
Wait( 1 );
obj << Show Residual Plot( 1 );


```

### [Show Spec Limits](#show-spec-limits)

**Syntax:** obj \<< Show Spec Limits( state=0|1 )

**Description:** Shows or hides the specification limits on the Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Set Upper Spec Limit( 7.5 ),
    Application( "Repeated Measures Degradation" )
);
Wait( 1 );
obj << Show Spec Limits( 0 );


```

### [Simple Linear Path](#simple-linear-path)

**Syntax:** obj \<< Simple Linear Path

**Description:** Sets the degradation path style to Simple Linear Path.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Nonlinear Path;
Wait( 1 );
obj << Simple Linear Path;


```

### [Specify and Fit Path](#specify-and-fit-path)

**Syntax:** obj \<< Specify and Fit Path( Formula Name( string ), Formula( Model Type( string ), Parameter(...)|specification ), fitting command )

**Description:** Enables you to specify and fit a path model directly in a script. The Degradation platform identifies initial values and fits the model automatically without further intervention from user. Each model is specified with a model name, a model definition, and a fitting command. The model type within the Formula argument must be one of the following: Custom Linear, Reaction Rate, Reaction Rate Type I, or Constant Rate. For a custom linear model, use the Parameter() function to define the formula, similar to specifying models in the Nonlinear platform. For other model types, the specification information differs by model type; see the examples for details. The fitting command can be either Fit Model or Fit by System ID.

**Fit by System ID Example**

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Specify and Fit Path(
    Formula Name( "custom linear model 1" ),
    Formula(
        Model Type( "Custom Linear" ),
        Parameter( {b0 = 0, b1 = 0, b2 = 0}, b0 + b1 * Hours + b2 * Hours ^ 2 )
    ),
    Fit by System ID() //Illustration of using Fit by System ID in script for custom linear models.
);


```

**Fit Model Example**

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Specify and Fit Path(
    Formula Name( "custom linear model 1" ),
    Formula(
        Model Type( "Custom Linear" ),
        Parameter( {b0 = 0, b1 = 0, b2 = 0}, b0 + b1 * Hours + b2 * Hours ^ 2 )
    ),
    Fit Model() //Illustration of using Fit Model in script for custom linear models
);


```

**Other Examples**

```

dt = Open( "$sample_data/reliability/Device B.jmp" );
obj = dt << Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Nonlinear Path( 1 ),
    Mean Path( 1 ),
    Application( "Repeated Measures Degradation" )
);
obj << Specify and Fit Path(
    Formula Name( "Reaction Rate 1" ),
    Formula(
        Model Type( "Reaction Rate" ),
        Temperature Unit( "Celsius" ),
        Baseline Temperature( . )
    ), //Illustration of using builtin models in script without going through UI interaction to setup.
    Fit by System ID()
);
obj << Generate Report for Current Model();
obj << Specify and Fit Path(
    Formula Name( "Reaction Rate 2" ),
    Formula(
        Model Type( "Reaction Rate" ),
        Temperature Unit( "Celsius" ),
        Baseline Temperature( 100 )
    ), //Illustration of using builtin models in script without going through UI interaction to setup.
    Fit by System ID()
);
obj << Generate Report for Current Model();
obj << Specify and Fit Path(
    Formula Name( "Reaction Rate Type I 1" ),
    Formula(
        Model Type( "Reaction Rate Type I" ),
        Temperature Unit( "Celsius" ),
        Baseline Temperature( . )
    ), //Illustration of using builtin models in script without going through UI interaction to setup. This is not a proper model for the data. For illustration purpose only.
    Fit by System ID()
);
obj << Generate Report for Current Model();
obj << Specify and Fit Path(
    Formula Name( "Constant Rate 1" ),
    Formula(
        Model Type( "Constant Rate" ),
        Path Transformation( "No Transformation" ),
        Rate Transformation( "Arrhenius Celsius" ),
        Time Transformation( Custom( "Function({x}, x^(1/3))" ) )
    ), //Illustration of using builtin models in script without going through UI interaction to setup. This is not a proper model for the data. For illustration purpose only.
    Fit Model()
);
obj << Generate Report for Current Model();


```

### [Test Stability](#test-stability)

**Syntax:** obj \<< Test Stability

**Description:** Runs a stability analysis for determining estimated expiration dates.

```

dt = Open( "$SAMPLE_DATA/Reliability/Stability.jmp" );
obj = dt << Degradation(
    Y( :"Concentration (mg/Kg)"n ),
    Time( :Time ),
    Label( :Batch Number ),
    Set Lower Spec Limit( 99 )
);
obj << Test Stability;


```

### [Use Interpolation through Data](#use-interpolation-through-data)

**Syntax:** obj \<< Use Interpolation through Data( state=0|1 )

**Description:** Specifies the use of linear interpolation between points (instead of the fitted model) to predict when a unit crosses the specification limit. The behavior depends on whether a unit has observations that exceed the specification limit. If a unit has observations exceeding the specification limit, the inverse prediction is the linear interpolation between the observations that surround the specification limit. If a unit does not have observations exceeding the specification limit, the inverse prediction is censored and has a value equal to the maximum observed time for that unit.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" )
);
obj << Set Upper Spec Limit( 6 );
obj << Show Curve Interval( "Prediction Interval" );
obj << Show Residual Plot( 0 );
obj << No Tab List( 1 );
Wait( 1 );
obj << Use Interpolation through Data( 1 );


```

### [Use Pooled MSE for Nonpoolable Model](#use-pooled-mse-for-nonpoolable-model)

**Syntax:** obj = Degradation(...Use Pooled MSE for Nonpoolable Model( state=0 )...)

**Description:** Specifies that the first model in the stability analysis uses a model with a pooled mean square error (MSE) to compute the earliest crossing time. "0" by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Stability.jmp" );
obj = dt << Degradation(
    Y( :"Concentration (mg/Kg)"n ),
    Time( :Time ),
    Label( :Batch Number ),
    Application( "Stability Test" ),
    Set Lower Spec Limit( 99 ),
    Use Pooled MSE for Nonpoolable Model( 1 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/GaAs Laser.jmp" );
obj = dt << Degradation(
    Y( :Current ),
    Time( :Hours ),
    Label( :Unit ),
    Application( "Repeated Measures Degradation" ),
    Upper Spec Limit( 10 ),
    Model Report(
        Simple Linear Path(
            X Scale( Linear ),
            Y Scale( Linear ),
            Intercept( Common ),
            Slope( Different )
        )
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Degradation(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Destructive Degradation](#destructive-degradation)

## [Associated Constructors](#associated-constructors)

### [Destructive Degradation](#destructive-degradation_1)

**Syntax:** Destructive Degradation( Y( column ), Time( column ), \<X( column )>, \<Freq( column )>, \<Censor( column ), Censor Code( value )> )

**Description:** Models destructive degradation data over time.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

## [Columns](#columns)

### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Freq( :_freqcol )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

### [Time](#time)

**Syntax:** obj \<< Time( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

### [X](#x)

**Syntax:** obj \<< X( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

## [Item Messages](#item-messages)

### [Control](#control)

**Syntax:** obj \<< Control( yTrans, timeTrans, distribution, path definition )

**Description:** Selects a model in the Path Definition panel of the report. The selected model is also displayed in the degradation plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

### [Model](#model)

**Syntax:** obj \<< Model( yTrans, timeTrans, distribution, path definition )

**Description:** Specifies a model fit and shows a report for the fitted model.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);


```

### [Shade](#shade)

**Syntax:** obj \<< Shade( state=0|1 )

**Description:** Shows or hides the upper and lower bounds for the displayed model. This option also shows or hides the shading between the bounds. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
Wait( 3 );
obj << Shade( 0 );


```

### [Shade Coverage](#shade-coverage)

**Syntax:** obj \<< Shade Coverage( proportion )

**Description:** Specifies a proportion to increase or decrease the amount of shading coverage.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
Wait( 3 );
obj << Shade Coverage( 0.90 );


```

### [Use Condition Temperature](#use-condition-temperature)

**Syntax:** obj \<< Use Condition Temperature( "Celsius"|"Fahrenheit"|"Kelvin", temperature )

**Description:** Specifies the scale and temperature for the use condition (X0) in first-order kinetics models.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" )
);
obj << Use Condition Temperature( "Celsius", 35 );
obj << Control( "Log", "Sqrt", "Normal", "First Order Kinetics Type3" );
obj << Model( "Log", "Sqrt", "Normal", "First Order Kinetics Type3" );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Adhesive Bond.jmp" );
obj = dt << Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    X( :Degrees ),
    Censor( :Censor ),
    Censor Code( "Right" ),
    Model( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" ),
    Control( "Log10", "Sqrt", "Normal", "Individual Path with Intercept" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Destructive Degradation(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Diagram](#diagram)

## [Associated Constructors](#associated-constructors)

### [Diagram](#diagram_1)

**Syntax:** Diagram( Y( column ), X( column ) )

**Description:** Creates a cause and effect diagram. Also called Ishikawa or fishbone diagrams. These are hierarchical diagrams that enable you to explore root causes.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Diagram(
    Y( :Child ),
    X( :Parent ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Child](#child)

**Syntax:** obj \<< Child( column )

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );


```

### [Label](#label)

**Syntax:** obj \<< Label( column )

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );


```

### [Parent](#parent)

**Syntax:** obj \<< Parent( column )

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );


```

### [X](#x)

**Syntax:** obj \<< X( column )

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column )

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Diagram(
    Y( :Child ),
    X( :Parent ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Diagram(
    Y( :Child ),
    X( :Parent ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Ishikawa.jmp" );
obj = dt << Diagram( Y( :Child ), X( :Parent ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Discriminant](#discriminant)

## [Associated Constructors](#associated-constructors)

### [Discriminant](#discriminant_1)

**Syntax:** Discriminant( Y( columns ), X( columns ) )

**Description:** Estimates the distance from each observation to each group's multivariate mean (centroid) using Mahalanobis distance. The observations are then classified into the group that they are closest to.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Discriminant(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Categories](#categories)

**Syntax:** obj = Discriminant(...Categories( column )...)

**Description:** Specifies the column that contains the categories or groups into which observations are to be classified.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Covariates](#covariates)

**Syntax:** obj = Discriminant(...Covariates( column(s) )...)

**Description:** Specifies the columns that contain continuous variables that are used to classify observations into categories.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Freq](#freq)

**Syntax:** obj = Discriminant(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Freq( :_freqcol )
);


```

### [Validation](#validation)

**Syntax:** obj = Discriminant(...\<Validation( column )>...)

**Description:** Specifies a numeric column that defines the validation sets. This column should contain at most three distinct values.

```

dt = Open( "$SAMPLE_DATA/Liver Cancer.jmp" );
obj = dt << Discriminant(
    X( :Severity ),
    Validation( :Validation ),
    Y( :BMI, :Age, :Time ),
    Use Matrix Columns( 1 )
);


```

### [Weight](#weight)

**Syntax:** obj = Discriminant(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Weight( :_weightcol )
);


```

### [X](#x)

**Syntax:** obj = Discriminant(...X( column )...)

**Description:** Specifies the column that contains the categories or groups into which observations are to be classified.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Y](#y)

**Syntax:** obj = Discriminant(...Y( column(s) )...)

**Description:** Specifies the columns that contain continuous variables that are used to classify observations into categories.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Item Messages](#item-messages)

### [Apply This Model](#apply-this-model)

**Syntax:** obj \<< Apply This Model

**Description:** Applies the current variable selection to the model in the Stepwise Variable Selection and closes the dialog.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Stepwise Variable Selection( 1 );
obj << Step Forward;
Wait( 2 );
obj << Apply This Model;


```

### [Biplot Ray Position](#biplot-ray-position)

**Syntax:** obj \<< Biplot Ray Position( [x position, y position, radius scaling] )

**Description:** Enables you to specify the position and radius scaling of the biplot rays in the Canonical Plot and in the Canonical 3D Plot.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Biplot Ray Position( [0, 1.7, 3.5] );


```

### [Canonical 3D Plot](#canonical-3d-plot)

**Syntax:** obj \<< Canonical 3D Plot( state=0|1 )

**Description:** Shows or hides a three-dimensional version of the Canonical Plot. Note: Only available when there are four or more groups.

```

dt = Open( "$SAMPLE_DATA/Cherts.jmp" );
obj = dt << Discriminant(
    X( :location name ),
    Y( :Al, :Mn, :Na, :Br, :Ce, :Co, :Cr, :Cs, :Eu, :Fe, :Hf, :La, :Sc, :Sm, :U )
);
obj << Canonical 3D Plot( 1 );
(obj << report)["Discriminant Scores"] << Close( 1 );


```

### [Canonical Plot](#canonical-plot)

**Syntax:** obj \<< Canonical Plot( state=0|1 )

**Description:** Shows or hides the Canonical Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Canonical Plot( 1 );


```

### [Color Points](#color-points)

**Syntax:** obj \<< Color Points

**Description:** Colors the points in the Canonical Plot and the Canonical 3D Plot based on the levels of the X variable. Color markers are added to the rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
dt << Clear Row States;
Wait( 2 );
obj << Color Points;


```

### [Consider New Levels](#consider-new-levels)

**Syntax:** obj \<< Consider New Levels( fraction )

**Description:** Specifies that some points might not fit into any known group and should be considered to be from an unscored new group. Enter the prior probability of a new level.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Consider New Levels( 0.05 );


```

### [Cross Validate by Excluded Rows](#cross-validate-by-excluded-rows)

**Syntax:** obj = Discriminant(...Cross Validate by Excluded Rows( state=0 )...)

**Description:** Specifies that the excluded rows form a validation set for which statistics of fit are calculated. "0" by default.

**JMP Version Added:** 14

### [Discriminant Method](#discriminant-method)

**Syntax:** obj \<< Discriminant Method( Linear ); obj \<< Discriminant Method( Quadratic ); obj \<< Discriminant Method( Regularized, Regularization Lambda( fraction ), Regularization Gamma( fraction ) ); obj \<< Discriminant Method( Wide Linear )

**Description:** Specifies the discriminant method.

The Regularized option requires additional arguments. The Regularization Lambda parameter ranges from 0 (quadratic discriminant analysis) to 1 (linear discriminant analysis). The Regularization Gamma parameter ranges from 0 (no shrinkage) to 1 (diagonals only).

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Discriminant Method(
    Regularized,
    Regularization Lambda( 0.2 ),
    Regularization Gamma( 0.6 )
);


```

### [Discriminant Scores](#discriminant-scores)

**Syntax:** obj \<< Discriminant Scores( state=0|1 )

**Description:** Shows or hides a table of the discriminant scores for each row. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Discriminant Scores( 1 );


```

### [Enter All](#enter-all)

**Syntax:** obj \<< Enter All

**Description:** Adds all the variables to the model in the Stepwise Variable Selection.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Stepwise Variable Selection( 1 );
obj << Enter All;


```

### [Get Discrim Matrices](#get-discrim-matrices)

**Syntax:** obj \<< Get Discrim Matrices

**Description:** Returns a list that contains the discriminant matrices from the analysis. The list contains a named list for each of the following items: the Y names, the X names, the X values, and the Y means.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
z = obj << Get Discrim Matrices;
Show( z );


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Get Measures;


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Enters covariates in forward steps until there is no further improvement in RSquare.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Stepwise Variable Selection( 1 );
obj << Go;


```

### [Make Scoring Script](#make-scoring-script)

**Syntax:** obj \<< Make Scoring Script

**Description:** Creates a script that constructs the formula columns saved by the Save Formulas option. You can save this script and use it, perhaps with other data tables, to create the formula columns that calculate membership probabilities and predict group membership.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Make Scoring Script;


```

### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Precision Recall Curve( 1 );


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Profiler;


```

### [Publish Probability Formulas](#publish-probability-formulas)

**Syntax:** obj \<< Publish Probability Formulas

**Description:** Creates probability formulas and saves them as formula column scripts in the Formula Depot platform. If a Formula Depot report is not open, this option creates a Formula Depot report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Publish Probability Formulas;


```

### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity).

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
Wait( 0 );
obj << ROC Curve( 1 );


```

### [Remove All](#remove-all)

**Syntax:** obj \<< Remove All

**Description:** Removes all the variables in the model in the Stepwise Variable Selection.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Stepwise Variable Selection( 1 );
obj << Enter All;
Wait( 2 );
obj << Remove All;


```

### [Save Canonical Scores](#save-canonical-scores)

**Syntax:** obj \<< Save Canonical Scores

**Description:** Saves columns to the data table that contain canonical score formulas for each observation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Canonical Scores;


```

### [Save Discrim Matrices](#save-discrim-matrices)

**Syntax:** obj \<< Save Discrim Matrices

**Description:** Saves a script to the data table that contains a list of the discriminant matrices from the analysis. The list contains a named list for each of the following items: the Y names, the X names, the X values, and the Y means.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Discrim Matrices;


```

### [Save Formulas](#save-formulas)

**Syntax:** obj \<< Save Formulas

**Description:** Saves distance, probability, and predicted membership formulas to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Formulas;


```

### [Save To New Data Table](#save-to-new-data-table)

**Syntax:** obj \<< Save To New Data Table

**Description:** Saves the group means and the biplot rays on the canonical variables, together with the canonical scores to a new data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save To New Data Table;


```

### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** obj \<< Scatterplot Matrix

**Description:** Opens a Scatterplot Matrix report that shows a matrix with a scatterplot for each pair of covariates. The option invokes the Scatterplot Matrix platform with shaded density ellipses for each group. The scatterplots include all observations in the data table, even if validation is used.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Scatterplot Matrix( 1 );


```

### [Score Data](#score-data)

**Syntax:** obj \<< Score Data( state=0|1 )

### [Select Misclassified Rows](#select-misclassified-rows)

**Syntax:** obj \<< Select Misclassified Rows

**Description:** Selects the misclassified rows in the data table and in report windows that display a listing by row.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Interesting Rows Only( 1 );
obj << Select Misclassified Rows;


```

### [Select Uncertain Rows](#select-uncertain-rows)

**Syntax:** obj \<< Select Uncertain Rows( fraction )

**Description:** Selects rows with uncertain classifications in the data table and in report windows that display a listing by row. An uncertain row is one whose probability of group membership for any group is neither close to 0 nor close to 1. The fraction argument represents the difference in probability from 0 or 1 to be defined uncertain.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Interesting Rows Only( 1 );
obj << Select Uncertain Rows( 0.2 );


```

### [Show Biplot Rays](#show-biplot-rays)

**Syntax:** obj \<< Show Biplot Rays( state=0|1 )

**Description:** Shows or hides the biplot rays in the Canonical Plot and the Canonical 3D Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Biplot Rays( 1 );


```

### [Show Canonical Details](#show-canonical-details)

**Syntax:** obj \<< Show Canonical Details( state=0|1 )

**Description:** Shows or hides the Canonical Details report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Canonical Details( 1 );


```

### [Show Canonical Structure](#show-canonical-structure)

**Syntax:** obj \<< Show Canonical Structure( state=0|1 )

**Description:** Shows or hides the Canonical Structures report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Canonical Structure( 1 );


```

### [Show Canonical Structures](#show-canonical-structures)

**Syntax:** obj \<< Show Canonical Structures( state=0|1 )

### [Show Classification Counts](#show-classification-counts)

**Syntax:** obj \<< Show Classification Counts( state=0|1 )

**Description:** Shows or hides the confusion matrices, showing actual by predicted counts, in the Score Summaries report. By default, the Score Summaries report shows a confusion matrix for each level of the categorical X.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Classification Counts( 1 );


```

### [Show Distances to Each Group](#show-distances-to-each-group)

**Syntax:** obj \<< Show Distances to Each Group( state=0|1 )

**Description:** Shows or hides a report that contains each observation's squared Mahalanobis distance to each group mean.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Distances to each group( 1 );


```

### [Show Group Means](#show-group-means)

**Syntax:** obj \<< Show Group Means( state=0|1 )

**Description:** Shows or hides the Group Means report that provides the mean of each covariate. Means for each level of the X variable and overall means appear.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Group Means( 1 );


```

### [Show Interesting Rows Only](#show-interesting-rows-only)

**Syntax:** obj \<< Show Interesting Rows Only( state=0|1 )

**Description:** In the Discriminant Scores report, shows only rows that are misclassified and those with predicted probability between 0.05 and 0.95.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Interesting Rows Only( 1 );


```

### [Show Means CL Ellipses](#show-means-cl-ellipses)

**Syntax:** obj \<< Show Means CL Ellipses( state=0|1 )

**Description:** Shows or hides 95% confidence ellipses for the mean of each group on the Canonical Plot and the Canonical 3D Plot, assuming normality. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Means CL Ellipses( 1 );


```

### [Show Normal 50% Contours](#show-normal-50-contours)

**Syntax:** obj \<< Show Normal 50% Contours( state=0|1 )

**Description:** Shows or hides the normal ellipse region estimated to contain 50% of the population for each group in the Canonical Plot and the Canonical 3D Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Normal 50% Contours( 1 );


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the points in the Canonical Plot and the Canonical 3D Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Points( 1 );


```

### [Show Probabilities to Each Group](#show-probabilities-to-each-group)

**Syntax:** obj \<< Show Probabilities to Each Group( state=0|1 )

**Description:** Shows or hides a report that contains the probability that an observation belongs to each of the groups defined by the categorical X.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Probabilities to each group( 1 );


```

### [Show Within Covariances](#show-within-covariances)

**Syntax:** obj \<< Show Within Covariances( state=0|1 )

**Description:** Shows or hides reports related to the covariance matrices. The reports that appear depend on the specified discriminant method. Not available for the Wide Linear discriminant method.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Within Covariances( 1 );


```

### [Shrink Covariances](#shrink-covariances)

**Syntax:** obj = Discriminant(...Shrink Covariances( state=0|1 )...)

**Description:** Shrinks the off-diagonal elements of the pooled within-group covariance matrix and the within-group covariance matrices. This can improve stability and reduce the variance of prediction.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Shrink Covariances( 1 )
);


```

### [Specify Priors](#specify-priors)

**Syntax:** obj \<< Specify Priors( Equal Probabilities | Proportional to Occurrence | [matrix of priors] )

**Description:** Sets the prior probabilities for each level of the X variable.

```

dt = Open( "$SAMPLE_DATA/Cherts.jmp" );
obj = dt << Discriminant(
    X( :location name ),
    Y( :Al, :Mn, :Na, :Br, :Ce, :Co, :Cr, :Cs, :Eu, :Fe, :Hf, :La, :Sc, :Sm, :U )
);
obj << Specify Priors( Proportional to Occurrence );


```

### [Step Backward](#step-backward)

**Syntax:** obj \<< Step Backward

**Description:** Moves one step backward in the Stepwise Variable Selection by removing one variable from the model.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Stepwise Variable Selection( 1 );
obj << Enter All;
Wait( 2 );
obj << Step Backward;


```

### [Step Forward](#step-forward)

**Syntax:** obj \<< Step Forward

**Description:** Moves one step forward in the Stepwise Variable Selection by adding one variable to the model.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Stepwise Variable Selection( 1 );
obj << Step Forward;


```

### [Stepwise Variable Selection](#stepwise-variable-selection)

**Syntax:** obj = Discriminant(...Stepwise Variable Selection( state=0|1 )...)

**Description:** Shows or hides the Column Selection control panel. This control panel contains options that enable you to perform stepwise variable selection using covariance analysis and p-values. This option is not available for the Wide Linear method.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Stepwise Variable Selection( 1 );


```

### [Uncentered Canonical](#uncentered-canonical)

**Syntax:** obj = Discriminant(...Uncentered Canonical( state=0|1 )...)

**Description:** Suppresses centering of canonical scores for compatibility with older versions of JMP.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Uncentered Canonical( 1 )
);


```

### [Use Matrix Columns](#use-matrix-columns)

**Syntax:** obj \<< Use Matrix Columns( state=0|1 )

**Description:** Specifies that matrix columns be used in calculations. Matrix columns can cut down the overhead in calculating scoring predictions in formula columns.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Use Matrix Columns( 1 )
);


```

### [Use Pseudoinverses](#use-pseudoinverses)

**Syntax:** obj = Discriminant(...Use Pseudoinverses( state=0|1 )...)

**Description:** Uses Moore-Penrose pseudoinverses in the analysis when the covariance matrix is singular. The resulting scores involve all covariates. If left unchecked, the analysis drops covariates that are linear combinations of covariates that precede them in the list of Y, Covariates. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Use Pseudoinverses( 0 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Discriminant(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Discriminant(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Distance Matrix](#distance-matrix)

## [Associated Constructors](#associated-constructors)

### [Distance Matrix](#distance-matrix_1)

**Syntax:** Distance Matrix( Y( columns ) )

**Description:** Computes distances between rows using a variety of methods.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :species )
);


```

### [Grouping Columns](#grouping-columns)

**Syntax:** obj \<< Grouping Columns( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    X( :species )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    X( :species )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

## [Item Messages](#item-messages)

### [Create New Tables for Results](#create-new-tables-for-results)

**Syntax:** Create New Tables for Results ( state =0|1 )

**Description:** Create New Tables for Results

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Create New Tables for Results( 1 )
);


```

### [Method](#method)

**Syntax:** Method( "Row Standardize" | "Wrench" )

**Description:** Specifies the distance method.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "Bray-Curtis" ),

);


```

### [Missing Value Imputation](#missing-value-imputation)

**Syntax:** Missing Value Imputation( state =0|1 )

**Description:** Specifies that missing values in the data are imputed using a multivariate singular value decomposition (SVD) technique.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Missing Value Imputation( 1 )
);


```

### [Number of Permutations](#number-of-permutations)

**Syntax:** Permutations ( number = 1000 )

**Description:** Number of Permutations to Calculate PERMANOVA "1000" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    X( :species ),
    Number of Permutations( 99 )
);


```

### [Number of Principal Components](#number-of-principal-components)

**Syntax:** Pricpal Components ( number = 2 )

**Description:** Number of Principal Components "2" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Principal Components( 4 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distance Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Distance Matrix( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Distance Matrix(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Distribution](#distribution)

## [Associated Constructors](#associated-constructors)

### [Distribution](#distribution_1)

**Syntax:** Distribution( Column() )

**Description:** Shows the distribution and univariate summary statistics for each variable. Results and options depend on the modeling type of each variable. Some options include histograms, box plots, quantile plots, fitting distributions, and capability analysis.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
colref = Column( "age" );
// Correct way to use the colref
Distribution( Column( colref ) );
// This will not work
Distribution( colref );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Distribution(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Column](#column)

**Syntax:** obj = Distribution(...\<Column( column(s) )>...)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );


```

### [Freq](#freq)

**Syntax:** obj = Distribution(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Distribution( Column( :Age, :Weight ), Freq( :_freqcol ) );


```

### [Weight](#weight)

**Syntax:** obj = Distribution(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Distribution( Column( :Age, :Weight ), Weight( :_weightcol ) );


```

### [Y](#y)

**Syntax:** obj = Distribution(...Y( column(s) )...)

**Description:** Specifies the categorical or continuous columns to be analyzed.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Columns( :Age, :Weight ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Y( :Age, :Weight ) );


```

## [Item Messages](#item-messages)

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();
dt2 = Open( "$SAMPLE_DATA/Aircraft Incidents.jmp" );
obj2 = dt2 << Distribution(
    Nominal Distribution( Column( :Aircraft Damage ) ),
    Continuous Distribution( Column( :Total Minor Injuries ) )
);
Wait( 1 );
obj2[2] << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
Wait( 1 );
obj[1] << Apply Preset( "Sample Presets", "Check Normality" );


```

### [Arrange in Rows](#arrange-in-rows)

**Syntax:** obj \<< Arrange in Rows( number )

**Description:** Specifies the number of distribution reports to display across the window.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Distribution( Column( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W ) );
obj << ArrangeInRows( 3 );


```

### [Axes on Left](#axes-on-left)

**Syntax:** obj \<< Axes on Left( state=0|1 )

**Description:** Moves the count, probability, density, and normal quantile plot axes to the left side of a horizontal graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ), Horizontal Layout( 1 ), Count Axis( 1 ) );
obj << Axes on Left( 1 );


```

### [CDF Plot](#cdf-plot)

**Syntax:** obj \<< CDF Plot( state=0|1 )

**Description:** Shows or hides a plot of the empirical cumulative distribution function.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << CDF Plot( 1 );


```

### [Capability Analysis](#capability-analysis)

**Syntax:** obj \<< Capability Analysis( LSL( number ), Target( number ), USL( number ) )

**Description:** Performs a capability analysis given the stated lower specification limit (LSL), target, and upper specification limit (USL).

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Distribution( Column( :Weight ) );
obj << Capability Analysis( LSL( 16 ), USL( 24 ), Target( 20 ) );


```

### [Confidence Interval](#confidence-interval)

**Syntax:** obj \<< Confidence Interval( number, \<Upper | Lower>, \<Sigma( number )> )

**Description:** Computes the specified confidence intervals around both the mean and the standard deviation. If you specify sigma, the specified value is used to compute the confidence interval around the mean.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Confidence Interval( 0.98 ); 

obj << Confidence Interval( 0.95, Lower ); 

obj << Confidence Interval( 0.95, Sigma( 4 ) );


```

### [Count Axis](#count-axis)

**Syntax:** obj \<< Count Axis( state=0|1 )

**Description:** Shows or hides the count axis for the histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Count Axis( 1 );


```

### [Custom Quantiles](#custom-quantiles)

**Syntax:** obj \<< Custom Quantiles( fraction, [quantile1, quantile2, ... quantileN] )

**Description:** Creates a report of the quantile rank estimates and a report of the smoothed empirical likelihood quantile estimates for the specified quantiles. Uses the fraction as the confidence level for confidence intervals in both reports.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Custom Quantiles( 0.975, [0.075, 0.1, 0.125, 0.975, 0.99] );


```

### [Customize Summary Statistics](#customize-summary-statistics)

**Syntax:** obj \<< Customize Summary Statistics(statistic1( state=0|1 ), statistic2( state=0|1 ), ..., statisticN( state=0|1 ), \<Set Trimmed Mean Percent(number)>, \<Set Alpha Level(number)>)

**Description:** Customizes the summary statistics that are displayed in the Summary Statistics report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Customize Summary Statistics( N( 0 ), Variance( 1 ), Skewness( 1 ) );


```

### [Density Axis](#density-axis)

**Syntax:** obj \<< Density Axis( state=0|1 )

**Description:** Shows or hides the density axis for the density curve on the histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Density Axis( 1 );


```

### [Fit All](#fit-all)

**Syntax:** obj \<< Fit All

**Description:** Compares all possible distributions.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit All;


```

### [Fit Beta](#fit-beta)

**Syntax:** obj \<< Fit Beta

**Description:** Fits a two-parameter beta distribution to data between 0 and 1 (not inclusive).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :OZONE ) );
obj << Fit Beta;


```

### [Fit Beta Binomial](#fit-beta-binomial)

**Syntax:** obj \<< Fit Beta Binomial( Sample Size( n | column ) )

**Description:** Fits a beta binomial distribution given a specified constant sample size or a column that contains the sample sizes. This distribution is a more flexible version of the binomial distribution.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit Beta Binomial( Sample Size( 10 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit Beta Binomial( Sample Size( :Box Size ) );


```

### [Fit Binomial](#fit-binomial)

**Syntax:** obj \<< Fit Binomial( Sample size( n | column ) )

**Description:** Fits a binomial distribution given a specified constant sample size or a column that contains the sample sizes. This distribution models the total number of successes in n independent trials.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit Binomial( Sample Size( :Box Size ) );


```

### [Fit Cauchy](#fit-cauchy)

**Syntax:** obj \<< Fit Cauchy

**Description:** Fits a Cauchy distribution to the data. The Cauchy distribution is robust to outliers and is equivalent to a t distribution with one degree of freedom.

**JMP Version Added:** 15

```

Random Reset( 15 );
d = J( 75, 1, Random Normal() );
d[1] = 10;
d[2] = 9;
d[3] = 8;
As Table( d );
Column( 1 ) << set name( "X" );
Distribution( Column( :X ), Fit Normal, Fit Cauchy );


```

### [Fit ExGaussian](#fit-exgaussian)

**Syntax:** obj \<< Fit ExGaussian

**Description:** Fits an exponentially modified Gaussian distribution to the data.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit ExGaussian;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit ExGaussian;
obj << Fit Normal;
obj << Fit Exponential;


```

### [Fit Exponential](#fit-exponential)

**Syntax:** obj \<< Fit Exponential

**Description:** Fits an exponential distribution to nonnegative data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :POP ) );
obj << Fit Exponential;


```

### [Fit Gamma](#fit-gamma)

**Syntax:** obj \<< Fit Gamma

**Description:** Fits a two-parameter gamma distribution to positive data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :Max deg. F Jan ) );
obj << Fit Gamma;


```

### [Fit Handle](#fit-handle)

**Syntax:** obj \<< (Fit Handle[number] \<< {option}); obj \<< (Fit Handle["Distribution Name"] \<< {option})

**Description:** Array of handles to the fitted distributions. This enables you to send commands to specific distributions that have been fit.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Lognormal;
obj << Fit Weibull;
obj << (Fit Handle[2] << Goodness of Fit( 1 ));
obj << (Fit Handle["Lognormal"] << QQ Plot( 1 ));


```

### [Fit Johnson](#fit-johnson)

**Syntax:** obj \<< Fit Johnson

**Description:** Fits a Johnson distribution to the data. The most appropriate of the three types of Johnson distributions (Su, Sb, and Sl) is chosen based on the quantiles.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit Johnson;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Johnson;


```

### [Fit Largest Extreme Value](#fit-largest-extreme-value)

**Syntax:** obj \<< Fit Largest Extreme Value

**Description:** Fits a largest extreme value distribution to the data.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :NO ) );
obj << Fit Largest Extreme Value;


```

### [Fit Lognormal](#fit-lognormal)

**Syntax:** obj \<< Fit Lognormal

**Description:** Fits a lognormal distribution to positive data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Lognormal;


```

### [Fit Negative Binomial](#fit-negative-binomial)

**Syntax:** obj \<< Fit Negative Binomial

**Description:** Fits a negative binomial distribution to the data. This distribution is equivalent to the Gamma Poisson distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Airport.jmp" );
obj = dt << Distribution( Column( :Delay ) );
obj << Fit Negative Binomial;


```

### [Fit Normal](#fit-normal)

**Syntax:** obj \<< Fit Normal

**Description:** Fits a normal distribution to the data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Weight ) );
obj << Fit Normal;


```

### [Fit Normal 2 Mixture](#fit-normal-2-mixture)

**Syntax:** obj \<< Fit Normal 2 Mixture

**Description:** Fits a mixture of two normal distributions. This distribution is capable of fitting bimodal data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Distribution( Column( :CD8 ) );
obj << Fit Normal 2 Mixture;


```

### [Fit Normal 3 Mixture](#fit-normal-3-mixture)

**Syntax:** obj \<< Fit Normal 3 Mixture

**Description:** Fits a mixture of three normal distributions. This distribution is capable of fitting multi-modal data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Distribution( Column( :CD8 ) );
obj << Fit Normal 3 Mixture;


```

### [Fit Poisson](#fit-poisson)

**Syntax:** obj \<< Fit Poisson

**Description:** Fits a Poisson distribution to the data. This distribution is a popular choice for count data. The fitted mean of the Poisson distribution is equal to the variance.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Airport.jmp" );
obj = dt << Distribution( Column( :Delay ) );
obj << Fit Poisson;


```

### [Fit SHASH](#fit-shash)

**Syntax:** obj \<< Fit Shash

**Description:** Fits a sinh-arcsinh (SHASH) distribution to the data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Shash;


```

### [Fit Smallest Extreme Value](#fit-smallest-extreme-value)

**Syntax:** obj \<< Fit Smallest Extreme Value

**Description:** Fits a smallest extreme value distribution to the data.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :NO ) );
obj << Fit Smallest Extreme Value;


```

### [Fit Smooth Curve](#fit-smooth-curve)

**Syntax:** obj \<< Fit Smooth Curve( \<Bandwidth( number )> )

**Description:** Fits a smooth curve to the data using nonparametric density estimation. You can set the smoothness by specifying the bandwidth.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :SO2 ) );
obj << Fit Smooth Curve;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :SO2 ) );
obj << Fit Smooth Curve( Bandwidth( 0.02 ) );


```

### [Fit Student's t](#fit-students-t)

**Syntax:** obj \<< Fit Student's t

**Description:** Fits a Student's t distribution to the data. This distribution is a robust option that spans the space between a normal distribution and a Cauchy distribution.

**JMP Version Added:** 16

```

Random Reset( 15 );
d = J( 75, 1, Random Normal() );
d[1] = 10;
d[2] = 9;
d[3] = 8;
As Table( d );
Column( 1 ) << set name( "X" );
Distribution( Column( :X ), Fit Normal, Fit Student's t );


```

### [Fit Weibull](#fit-weibull)

**Syntax:** obj \<< Fit Weibull

**Description:** Fits a two-parameter Weibull distribution to positive data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :NO ) );
obj << Fit Weibull;


```

### [Fit ZI Beta Binomial](#fit-zi-beta-binomial)

**Syntax:** obj \<< Fit ZI Beta Binomial( Sample Size( n | column ) )

**Description:** Fits a zero inflated beta binomial distribution given the specified constant sample size or a column that contains the sample size. This distribution models the total number of successes in n independent trials where there are more zeros observed than would be expected for the beta binomial distribution.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit ZI Beta Binomial( Sample Size( :Box Size ) );


```

### [Fit ZI Binomial](#fit-zi-binomial)

**Syntax:** obj \<< Fit ZI Binomial( Sample Size( n | column ) )

**Description:** Fits a zero inflated binomial distribution given the specified constant sample size or a column that contains the sample size. This distribution models the total number of successes in n independent trials where there are more zeros observed than would be expected for the binomial distribution.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit ZI Binomial( Sample Size( :Box Size ) );


```

### [Fit ZI Negative Binomial](#fit-zi-negative-binomial)

**Syntax:** obj \<< Fit ZI Negative Binomial

**Description:** Fits a zero-inflated negative binomial distribution to data that contain values of zero.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << Distribution( Column( :satell ), Fit ZI Negative Binomial );


```

### [Fit ZI Poisson](#fit-zi-poisson)

**Syntax:** obj \<< Fit ZI Poisson

**Description:** Fits a zero-inflated Poisson distribution to data that contain values of zero.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << Distribution( Column( :satell ), Fit ZI Poisson );


```

### [Fit ZI SHASH](#fit-zi-shash)

**Syntax:** obj \<< Fit ZI SHASH

**Description:** Fits a SHASH distribution with a point mass at zero to the data.

```

Random Reset( 18 );
d = J( 250, 1, Random SHASH( 0, 1, 3, 5 ) );
For( i = 1, i <= 250, i++,
    If( Random Uniform() < .2,
        d[i] = 0
    )
);
As Table( d );
Column( 1 ) << set name( "X" );
Distribution( Column( :X ), Fit ZI SHASH, Fit SHASH );


```

### [Frequencies](#frequencies)

**Syntax:** obj \<< Frequencies( state=0|1 )

**Description:** Shows or hides the Frequencies report, which lists the counts and probabilities for each level. On by default.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
Wait( 1 );
obj << Frequencies( 0 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
Wait( 1 );
obj << Frequencies( 0 );


```

### [Histogram](#histogram)

**Syntax:** obj \<< Histogram( state=0|1 )

**Description:** Shows or hides the histogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Histogram( 0 );


```

### [Histogram Color](#histogram-color)

**Syntax:** obj \<< Histogram Color( color )

**Description:** Changes the color of the histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Histogram Color( "Red" );


```

### [Horizontal Layout](#horizontal-layout)

**Syntax:** obj \<< Horizontal Layout( state=0|1 )

**Description:** Changes the orientation of the histogram and the reports to be horizontal.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Horizontal Layout( 1 );


```

### [Mosaic Plot](#mosaic-plot)

**Syntax:** obj \<< Mosaic Plot( state=0|1 )

**Description:** Shows or hides a mosaic bar chart for each nominal or ordinal response variable. A mosaic plot is a stacked bar chart where each segment is proportional to its group's frequency count.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Mosaic Plot( 1 );


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();


```

### [Normal Quantile Plot](#normal-quantile-plot)

**Syntax:** obj \<< Normal Quantile Plot( state=0|1 )

**Description:** Shows or hides a plot that can be used to visualize the extent to which a variable is normally distributed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Normal Quantile Plot( 1 );


```

### [Order By](#order-by)

**Syntax:** obj \<< Order By( "Default"|"Count Descending"|"Count Ascending" )

**Description:** Orders the histogram, mosaic plot, and Frequencies report in ascending or descending order, by count. You can also revert back to the default ordering.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Order By( "Count Descending" );


```

### [Outlier Box Plot](#outlier-box-plot)

**Syntax:** obj \<< Outlier Box Plot( state=0|1 )

**Description:** Shows or hides a box plot that enables you to see the distribution and identify possible outliers. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Outlier Box Plot( 0 );


```

### [Outlier Box Plot Row Cutoff](#outlier-box-plot-row-cutoff)

**Syntax:** obj \<< Outlier Box Plot Row Cutoff( number )

**Description:** Sets the launch option for the maximum number of rows before the outlier box plot is turned off initially. "100000" by default.

```

dt = Open( "$SAMPLE_DATA/Seasonal Flu.jmp" );
obj = dt << Distribution( Column( :Flu Cases ) );
obj << Outlier Box Plot Row Cutoff( 10000 );


```

### [PpK Capability Labeling](#ppk-capability-labeling)

**Syntax:** obj \<< PpK Capability Labeling( state=0|1 )

**Description:** In Process Capability output, switches the labeling of the overall capability indices to use the prefix Pp instead of Cp. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :PM10 ) );
obj << PpK Capability Labeling( 0 );
obj << Process Capability( LSL( 5 ), Target( 40 ), USL( 75 ) );


```

### [Prediction Interval](#prediction-interval)

**Syntax:** obj \<< Prediction Interval( Alpha, N Samples, \<Lower | Upper> )

**Description:** Computes the prediction intervals for an individual future observation and the mean of a specified number (N Samples) of future observations. You can create one-sided or two-sided prediction intervals.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Prediction Interval( 0.95, 20 );


```

### [Prob Axis](#prob-axis)

**Syntax:** obj \<< Prob Axis( state=0|1 )

**Description:** Shows or hides the probability or proportion axis for this histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Prob Axis( 1 );


```

### [Process Capability](#process-capability)

**Syntax:** obj \<< Process Capability( LSL( number ), Target( number ), USL( number ) )

**Description:** Computes a process capability analysis given the lower specification limit (LSL), target, and upper specification limit (USL). The Process Capability report includes a histogram, summary details, capability indices, and nonconformance statistics.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :PM10 ) );
obj << Process Capability( LSL( 5 ), Target( 40 ), USL( 75 ) );


```

### [Quantile Box Plot](#quantile-box-plot)

**Syntax:** obj \<< Quantile Box Plot( state=0|1 )

**Description:** Shows or hides a box plot with the following quantiles: 0%, 0.5%, 2.5%, 10%, 25%, 50%, 75%, 90%, 97.5%, 99%, and 100%.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Outlier Box Plot( 0 );
obj << Quantile Box Plot( 1 );


```

### [Quantiles](#quantiles)

**Syntax:** obj \<< Quantiles( state=0|1 )

**Description:** Shows or hides the Quantiles report, which lists the values of selected quantiles. By default, the quantiles listed are 0%, 0.5%, 2.5%, 10%, 25%, 50%, 75%, 90%, 97.5%, 99.5%, and 100%. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Quantiles( 0 );


```

### [Save](#save)

**Syntax:** obj \<< Save( "Level Numbers"|"Level Midpoints"|"Ranks"|"Ranks averaged"|"Prob Scores"|"Normal Quantiles"|"Standardized"|"Centered"|"Robust Standardized"|"Robust Centered"|"Spec Limits"|"Script to Log" )

**Description:** Saves the specified observation-specific statistic to a new column in the data table. There is also an option to print the script commands that generate the current report to the log window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Save( "Ranks" );


```

### [Separate Bars](#separate-bars)

**Syntax:** obj \<< Separate Bars( state=0|1 )

**Description:** Adds space between the bars of the histogram. This option is available only for categorical variables.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Separate Bars( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Separate Bars( 1 );


```

### [Set Bin Width](#set-bin-width)

**Syntax:** obj \<< Set Bin Width( number )

**Description:** Sets the histogram bin width, using the axis as the origin. This option is available only for continuous variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Set Bin Width( 5 );


```

### [Set Quantile Increment](#set-quantile-increment)

**Syntax:** obj \<< Set Quantile Increment( fraction | "revert to default quantiles" )

**Description:** Sets the increment used in the Quantiles report to the specified fraction or changes back to the default quantiles. This option is available only for continuous variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Set Quantile Increment( 0.05 );
Wait( 1 );
obj << Set Quantile Increment( "revert to default quantiles" );


```

### [Shadowgram](#shadowgram)

**Syntax:** obj \<< Shadowgram( state=0|1 )

**Description:** Shows or hides a smooth shadowgram in place of the histogram. A shadowgram overlays histograms with different bin widths. This option is available only for continuous variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Shadowgram( 1 );


```

### [Show Counts](#show-counts)

**Syntax:** obj \<< Show Counts( state=0|1 )

**Description:** Shows or hides the bar counts on the histogram, which give the frequency of column values represented by each histogram bar.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Show Counts( 1 );


```

### [Show Percents](#show-percents)

**Syntax:** obj \<< Show Percents( state=0|1 )

**Description:** Shows or hides the bar percents on the histogram, which give the percentage of column values represented by each histogram bar.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Show Percents( 1 );


```

### [Stack](#stack)

**Syntax:** obj \<< Stack( state=0|1 )

**Description:** Changes the orientation of the histogram and reports to horizontal and stacks the individual distribution reports vertically.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Distribution( Column( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W ) );
obj << Stack( 1 );


```

### [Std Error Bars](#std-error-bars)

**Syntax:** obj \<< Std Error Bars( state=0|1 )

**Description:** Shows or hides standard error bars on each of the histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Std Error Bars( 1 );


```

### [Stem and Leaf](#stem-and-leaf)

**Syntax:** obj \<< Stem and Leaf( state=0|1 )

**Description:** Shows or hides a stem-and-leaf plot.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Stem and Leaf( 1 );


```

### [Summary Statistics](#summary-statistics)

**Syntax:** obj \<< Summary Statistics( state=0|1 )

**Description:** Shows or hides the Summary Statistics report, which lists the mean, standard deviation, and other summary statistics for continuous variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Summary Statistics( 0 );


```

### [Test Equivalence](#test-equivalence)

**Syntax:** obj \<< Test Equivalence( Target( number ), Practical Difference( number ), \<Confidence( fraction )> )

**Description:** Tests whether the sample mean is equivalent to a hypothesized value (Target) using the Two One-Sided Tests (TOST) approach.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Test Equivalence( Target( 62 ), Practical Difference( 1 ), Confidence( 0.95 ) );


```

### [Test Mean](#test-mean)

**Syntax:** obj \<< Test Mean( number, \<Sigma( number )>, < Wilcoxon Signed Rank( 0|1 ) >, <PValue Animation>, <Power Animation> )

**Description:** Performs a one-sample test for the mean. If you specify a value for the standard deviation (Sigma), a z test is performed. Otherwise, the sample standard deviation is used to perform a t test. There is also an option to perform an additional nonparametric Wilcoxon Signed-Rank test.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Test Mean( 60 ); 

obj << Test Mean( 60, Sigma( 4 ) ); 

obj << Test Mean( 60, Wilcoxon Signed Rank( 1 ) );


```

### [Test Probabilities](#test-probabilities)

**Syntax:** obj \<< Test Probabilities( Test( Hypothesized|Greater than|Less than ), Fix( Hypothesized|Omitted ), p1, <f>, p2, <f>, p3, <f>, etc. )

**Description:** Tests the estimated probabilities of the levels of a categorical variable against the specified hypothesized probabilities (p1, p2, p3, and so on). For variables with two levels, use the Test option to specify the sign for the alternative hypothesis of the test. For variables with more than two levels, use the Fix option to specify how missing hypothesized values are handled. Note that f is an optional argument that specifies that the preceding level is treated as fixed.

**Multiple Levels Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :age ) ) );
obj << Test Probabilities(
    Test( Hypothesized ),
    0.8,
    0.04375,
    0.075,
    0.04375,
    0.01875,
    0.01875
);


```

**Two Level, One-Sided Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :sex ) ) );
obj << Test Probabilities( Test( Less than ), 0.5, f, 0.5 );


```

**Two Level, Two-Sided Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :sex ) ) );
obj << Test Probabilities( Test( Hypothesized ), 0.4, f, 0.6, f );


```

### [Test Std Dev](#test-std-dev)

**Syntax:** obj \<< Test Std Dev( number )

**Description:** Performs a chi-squared test for the standard deviation, given the hypothesized value (number).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Test Std Dev( 3 );


```

### [Tolerance Interval](#tolerance-interval)

**Syntax:** obj \<< Tolerance Interval( Alpha(number), Proportion(number), \<Lower | Upper>, \<Normal|Lognormal|Gamma|Exponential|Weibull|Smallest Extreme Value|Largest Extreme Value|Nonparametric> )

**Description:** Computes an interval that contains at least a specified portion of the population. A standard normal distribution is assumed. You can also specify other nonnormal distributions including lognormal, Gamma, exponential, Weibull, smallest extreme value, largest extreme value, and nonparametric distributions. There are also options for computing one-sided intervals.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.85 ) );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.9 ), Lower );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.9 ), Upper, Lognormal );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.8 ), Lower, Nonparametric );


```

### [Uniform Scaling](#uniform-scaling)

**Syntax:** obj \<< Uniform Scaling( state=0|1 )

**Description:** Sets all histogram axes to the same minimum, maximum, and increment values so that distributions can be easily compared.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Distribution( Column( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W ) );
obj << Uniform Scaling( 1 );


```

### [Vertical](#vertical)

**Syntax:** obj \<< Vertical( state=0|1 )

**Description:** Changes the orientation of the histogram, box plots, and quantile plots to be vertical. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Vertical( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Distribution(
    Column( :Age, :Weight ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Age, :Weight ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Distribution(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Capability Analysis](#capability-analysis_1)

### [Item Messages](#item-messages_1)

#### [Capability Animation](#capability-animation)

**Syntax:** obj \<< Capability Animation

**Description:** Opens a separate window that shows an animation of a normal distribution that uses parameters and capability statistics from the current sample.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = Distribution( Column( :Weight ) );
obj << Capability Analysis( LSL( 16 ), USL( 24 ), Target( 20 ), Capability Animation );


```

#### [Z Bench](#z-bench)

**Syntax:** obj \<< Z Bench( state=0|1 )

**Description:** Shows or hides Z statistics, which are described by AIAG as the number of standard deviation units from the process average to a specification.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = Distribution( Column( :Weight ) );
obj << Capability Analysis( LSL( 16 ), USL( 24 ), Target( 20 ), Z Bench( 1 ) );


```

## [Confidence Interval](#confidence-interval_1)

### [Item Messages](#item-messages_2)

#### [Remove](#remove)

**Syntax:** obj \<< Remove

**Description:** Removes the Confidence Interval report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Confidence Interval( 0.98 );
Wait( 2 );
scrobj = (Report( obj )["Confidence Intervals"] << get scriptable object);
scrobj << Remove;


```

## [Continuous Distribution](#continuous-distribution)

### [Columns](#columns_1)

#### [Column](#column_1)

**Syntax:** obj = Quantiles(...\<Column( column(s) )>...)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Quantiles( 0 );


```

### [Item Messages](#item-messages_3)

#### [Apply Preset](#apply-preset_1)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();
dt2 = Open( "$SAMPLE_DATA/Aircraft Incidents.jmp" );
obj2 = dt2 << Distribution(
    Nominal Distribution( Column( :Aircraft Damage ) ),
    Continuous Distribution( Column( :Total Minor Injuries ) )
);
Wait( 1 );
obj2[2] << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
Wait( 1 );
obj[1] << Apply Preset( "Sample Presets", "Check Normality" );


```

#### [Axes on Left](#axes-on-left_1)

**Syntax:** obj \<< Axes on Left( state=0|1 )

**Description:** Moves the count, probability, density, and normal quantile plot axes to the left side of a horizontal graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ), Horizontal Layout( 1 ), Count Axis( 1 ) );
obj << Axes on Left( 1 );


```

#### [CDF Plot](#cdf-plot_1)

**Syntax:** obj \<< CDF Plot( state=0|1 )

**Description:** Shows or hides a plot of the empirical cumulative distribution function.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << CDF Plot( 1 );


```

#### [Capability Analysis](#capability-analysis_2)

**Syntax:** obj \<< Capability Analysis( LSL( number ), Target( number ), USL( number ) )

**Description:** Performs a capability analysis given the stated lower specification limit (LSL), target, and upper specification limit (USL).

```

dt = Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
obj = dt << Distribution( Column( :Weight ) );
obj << Capability Analysis( LSL( 16 ), USL( 24 ), Target( 20 ) );


```

#### [Confidence Interval](#confidence-interval_2)

**Syntax:** obj \<< Confidence Interval( number, \<Upper | Lower>, \<Sigma( number )> )

**Description:** Computes the specified confidence intervals around both the mean and the standard deviation. If you specify sigma, the specified value is used to compute the confidence interval around the mean.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Confidence Interval( 0.98 ); 

obj << Confidence Interval( 0.95, Lower ); 

obj << Confidence Interval( 0.95, Sigma( 4 ) );


```

#### [Count Axis](#count-axis_1)

**Syntax:** obj \<< Count Axis( state=0|1 )

**Description:** Shows or hides the count axis for the histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Count Axis( 1 );


```

#### [Custom Quantiles](#custom-quantiles_1)

**Syntax:** obj \<< Custom Quantiles( fraction, [quantile1, quantile2, ... quantileN] )

**Description:** Creates a report of the quantile rank estimates and a report of the smoothed empirical likelihood quantile estimates for the specified quantiles. Uses the fraction as the confidence level for confidence intervals in both reports.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Custom Quantiles( 0.975, [0.075, 0.1, 0.125, 0.975, 0.99] );


```

#### [Customize Summary Statistics](#customize-summary-statistics_1)

**Syntax:** obj \<< Customize Summary Statistics(statistic1( state=0|1 ), statistic2( state=0|1 ), ..., statisticN( state=0|1 ), \<Set Trimmed Mean Percent(number)>, \<Set Alpha Level(number)>)

**Description:** Customizes the summary statistics that are displayed in the Summary Statistics report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Customize Summary Statistics( N( 0 ), Variance( 1 ), Skewness( 1 ) );


```

#### [Density Axis](#density-axis_1)

**Syntax:** obj \<< Density Axis( state=0|1 )

**Description:** Shows or hides the density axis for the density curve on the histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Density Axis( 1 );


```

#### [Fit All](#fit-all_1)

**Syntax:** obj \<< Fit All

**Description:** Compares all possible distributions.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit All;


```

#### [Fit Beta](#fit-beta_1)

**Syntax:** obj \<< Fit Beta

**Description:** Fits a two-parameter beta distribution to data between 0 and 1 (not inclusive).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :OZONE ) );
obj << Fit Beta;


```

#### [Fit Beta Binomial](#fit-beta-binomial_1)

**Syntax:** obj \<< Fit Beta Binomial( Sample Size( n | column ) )

**Description:** Fits a beta binomial distribution given a specified constant sample size or a column that contains the sample sizes. This distribution is a more flexible version of the binomial distribution.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit Beta Binomial( Sample Size( 10 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit Beta Binomial( Sample Size( :Box Size ) );


```

#### [Fit Binomial](#fit-binomial_1)

**Syntax:** obj \<< Fit Binomial( Sample size( n | column ) )

**Description:** Fits a binomial distribution given a specified constant sample size or a column that contains the sample sizes. This distribution models the total number of successes in n independent trials.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit Binomial( Sample Size( :Box Size ) );


```

#### [Fit Cauchy](#fit-cauchy_1)

**Syntax:** obj \<< Fit Cauchy

**Description:** Fits a Cauchy distribution to the data. The Cauchy distribution is robust to outliers and is equivalent to a t distribution with one degree of freedom.

**JMP Version Added:** 15

```

Random Reset( 15 );
d = J( 75, 1, Random Normal() );
d[1] = 10;
d[2] = 9;
d[3] = 8;
As Table( d );
Column( 1 ) << set name( "X" );
Distribution( Column( :X ), Fit Normal, Fit Cauchy );


```

#### [Fit ExGaussian](#fit-exgaussian_1)

**Syntax:** obj \<< Fit ExGaussian

**Description:** Fits an exponentially modified Gaussian distribution to the data.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit ExGaussian;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit ExGaussian;
obj << Fit Normal;
obj << Fit Exponential;


```

#### [Fit Exponential](#fit-exponential_1)

**Syntax:** obj \<< Fit Exponential

**Description:** Fits an exponential distribution to nonnegative data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :POP ) );
obj << Fit Exponential;


```

#### [Fit Gamma](#fit-gamma_1)

**Syntax:** obj \<< Fit Gamma

**Description:** Fits a two-parameter gamma distribution to positive data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :Max deg. F Jan ) );
obj << Fit Gamma;


```

#### [Fit Handle](#fit-handle_1)

**Syntax:** obj \<< (Fit Handle[number] \<< {option}); obj \<< (Fit Handle["Distribution Name"] \<< {option})

**Description:** Array of handles to the fitted distributions. This enables you to send commands to specific distributions that have been fit.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Lognormal;
obj << Fit Weibull;
obj << (Fit Handle[2] << Goodness of Fit( 1 ));
obj << (Fit Handle["Lognormal"] << QQ Plot( 1 ));


```

#### [Fit Johnson](#fit-johnson_1)

**Syntax:** obj \<< Fit Johnson

**Description:** Fits a Johnson distribution to the data. The most appropriate of the three types of Johnson distributions (Su, Sb, and Sl) is chosen based on the quantiles.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit Johnson;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Johnson;


```

#### [Fit Largest Extreme Value](#fit-largest-extreme-value_1)

**Syntax:** obj \<< Fit Largest Extreme Value

**Description:** Fits a largest extreme value distribution to the data.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :NO ) );
obj << Fit Largest Extreme Value;


```

#### [Fit Lognormal](#fit-lognormal_1)

**Syntax:** obj \<< Fit Lognormal

**Description:** Fits a lognormal distribution to positive data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Lognormal;


```

#### [Fit Negative Binomial](#fit-negative-binomial_1)

**Syntax:** obj \<< Fit Negative Binomial

**Description:** Fits a negative binomial distribution to the data. This distribution is equivalent to the Gamma Poisson distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Airport.jmp" );
obj = dt << Distribution( Column( :Delay ) );
obj << Fit Negative Binomial;


```

#### [Fit Normal](#fit-normal_1)

**Syntax:** obj \<< Fit Normal

**Description:** Fits a normal distribution to the data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Weight ) );
obj << Fit Normal;


```

#### [Fit Normal 2 Mixture](#fit-normal-2-mixture_1)

**Syntax:** obj \<< Fit Normal 2 Mixture

**Description:** Fits a mixture of two normal distributions. This distribution is capable of fitting bimodal data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Distribution( Column( :CD8 ) );
obj << Fit Normal 2 Mixture;


```

#### [Fit Normal 3 Mixture](#fit-normal-3-mixture_1)

**Syntax:** obj \<< Fit Normal 3 Mixture

**Description:** Fits a mixture of three normal distributions. This distribution is capable of fitting multi-modal data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Distribution( Column( :CD8 ) );
obj << Fit Normal 3 Mixture;


```

#### [Fit Poisson](#fit-poisson_1)

**Syntax:** obj \<< Fit Poisson

**Description:** Fits a Poisson distribution to the data. This distribution is a popular choice for count data. The fitted mean of the Poisson distribution is equal to the variance.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Airport.jmp" );
obj = dt << Distribution( Column( :Delay ) );
obj << Fit Poisson;


```

#### [Fit SHASH](#fit-shash_1)

**Syntax:** obj \<< Fit Shash

**Description:** Fits a sinh-arcsinh (SHASH) distribution to the data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :CO ) );
obj << Fit Shash;


```

#### [Fit Smallest Extreme Value](#fit-smallest-extreme-value_1)

**Syntax:** obj \<< Fit Smallest Extreme Value

**Description:** Fits a smallest extreme value distribution to the data.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :NO ) );
obj << Fit Smallest Extreme Value;


```

#### [Fit Smooth Curve](#fit-smooth-curve_1)

**Syntax:** obj \<< Fit Smooth Curve( \<Bandwidth( number )> )

**Description:** Fits a smooth curve to the data using nonparametric density estimation. You can set the smoothness by specifying the bandwidth.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :SO2 ) );
obj << Fit Smooth Curve;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :SO2 ) );
obj << Fit Smooth Curve( Bandwidth( 0.02 ) );


```

#### [Fit Student's t](#fit-students-t_1)

**Syntax:** obj \<< Fit Student's t

**Description:** Fits a Student's t distribution to the data. This distribution is a robust option that spans the space between a normal distribution and a Cauchy distribution.

**JMP Version Added:** 16

```

Random Reset( 15 );
d = J( 75, 1, Random Normal() );
d[1] = 10;
d[2] = 9;
d[3] = 8;
As Table( d );
Column( 1 ) << set name( "X" );
Distribution( Column( :X ), Fit Normal, Fit Student's t );


```

#### [Fit Weibull](#fit-weibull_1)

**Syntax:** obj \<< Fit Weibull

**Description:** Fits a two-parameter Weibull distribution to positive data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :NO ) );
obj << Fit Weibull;


```

#### [Fit ZI Beta Binomial](#fit-zi-beta-binomial_1)

**Syntax:** obj \<< Fit ZI Beta Binomial( Sample Size( n | column ) )

**Description:** Fits a zero inflated beta binomial distribution given the specified constant sample size or a column that contains the sample size. This distribution models the total number of successes in n independent trials where there are more zeros observed than would be expected for the beta binomial distribution.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit ZI Beta Binomial( Sample Size( :Box Size ) );


```

#### [Fit ZI Binomial](#fit-zi-binomial_1)

**Syntax:** obj \<< Fit ZI Binomial( Sample Size( n | column ) )

**Description:** Fits a zero inflated binomial distribution given the specified constant sample size or a column that contains the sample size. This distribution models the total number of successes in n independent trials where there are more zeros observed than would be expected for the binomial distribution.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Shirts.jmp" );
obj = dt << Distribution( Column( :"# Defects"n ) );
obj << Fit ZI Binomial( Sample Size( :Box Size ) );


```

#### [Fit ZI Negative Binomial](#fit-zi-negative-binomial_1)

**Syntax:** obj \<< Fit ZI Negative Binomial

**Description:** Fits a zero-inflated negative binomial distribution to data that contain values of zero.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << Distribution( Column( :satell ), Fit ZI Negative Binomial );


```

#### [Fit ZI Poisson](#fit-zi-poisson_1)

**Syntax:** obj \<< Fit ZI Poisson

**Description:** Fits a zero-inflated Poisson distribution to data that contain values of zero.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << Distribution( Column( :satell ), Fit ZI Poisson );


```

#### [Fit ZI SHASH](#fit-zi-shash_1)

**Syntax:** obj \<< Fit ZI SHASH

**Description:** Fits a SHASH distribution with a point mass at zero to the data.

```

Random Reset( 18 );
d = J( 250, 1, Random SHASH( 0, 1, 3, 5 ) );
For( i = 1, i <= 250, i++,
    If( Random Uniform() < .2,
        d[i] = 0
    )
);
As Table( d );
Column( 1 ) << set name( "X" );
Distribution( Column( :X ), Fit ZI SHASH, Fit SHASH );


```

#### [Histogram](#histogram_1)

**Syntax:** obj \<< Histogram( state=0|1 )

**Description:** Shows or hides the histogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Histogram( 0 );


```

#### [Histogram Color](#histogram-color_1)

**Syntax:** obj \<< Histogram Color( color )

**Description:** Changes the color of the histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Histogram Color( "Red" );


```

#### [Horizontal Layout](#horizontal-layout_1)

**Syntax:** obj \<< Horizontal Layout( state=0|1 )

**Description:** Changes the orientation of the histogram and the reports to be horizontal.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Horizontal Layout( 1 );


```

#### [New Preset](#new-preset_1)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();


```

#### [Normal Quantile Plot](#normal-quantile-plot_1)

**Syntax:** obj \<< Normal Quantile Plot( state=0|1 )

**Description:** Shows or hides a plot that can be used to visualize the extent to which a variable is normally distributed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Normal Quantile Plot( 1 );


```

#### [Outlier Box Plot](#outlier-box-plot_1)

**Syntax:** obj \<< Outlier Box Plot( state=0|1 )

**Description:** Shows or hides a box plot that enables you to see the distribution and identify possible outliers. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Outlier Box Plot( 0 );


```

#### [Outlier Box Plot Row Cutoff](#outlier-box-plot-row-cutoff_1)

**Syntax:** obj \<< Outlier Box Plot Row Cutoff( number )

**Description:** Sets the launch option for the maximum number of rows before the outlier box plot is turned off initially. "100000" by default.

```

dt = Open( "$SAMPLE_DATA/Seasonal Flu.jmp" );
obj = dt << Distribution( Column( :Flu Cases ) );
obj << Outlier Box Plot Row Cutoff( 10000 );


```

#### [PpK Capability Labeling](#ppk-capability-labeling_1)

**Syntax:** obj \<< PpK Capability Labeling( state=0|1 )

**Description:** In Process Capability output, switches the labeling of the overall capability indices to use the prefix Pp instead of Cp. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :PM10 ) );
obj << PpK Capability Labeling( 0 );
obj << Process Capability( LSL( 5 ), Target( 40 ), USL( 75 ) );


```

#### [Prediction Interval](#prediction-interval_1)

**Syntax:** obj \<< Prediction Interval( Alpha, N Samples, \<Lower | Upper> )

**Description:** Computes the prediction intervals for an individual future observation and the mean of a specified number (N Samples) of future observations. You can create one-sided or two-sided prediction intervals.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Prediction Interval( 0.95, 20 );


```

#### [Prob Axis](#prob-axis_1)

**Syntax:** obj \<< Prob Axis( state=0|1 )

**Description:** Shows or hides the probability or proportion axis for this histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Prob Axis( 1 );


```

#### [Process Capability](#process-capability_1)

**Syntax:** obj \<< Process Capability( LSL( number ), Target( number ), USL( number ) )

**Description:** Computes a process capability analysis given the lower specification limit (LSL), target, and upper specification limit (USL). The Process Capability report includes a histogram, summary details, capability indices, and nonconformance statistics.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :PM10 ) );
obj << Process Capability( LSL( 5 ), Target( 40 ), USL( 75 ) );


```

#### [Quantile Box Plot](#quantile-box-plot_1)

**Syntax:** obj \<< Quantile Box Plot( state=0|1 )

**Description:** Shows or hides a box plot with the following quantiles: 0%, 0.5%, 2.5%, 10%, 25%, 50%, 75%, 90%, 97.5%, 99%, and 100%.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Outlier Box Plot( 0 );
obj << Quantile Box Plot( 1 );


```

#### [Quantiles](#quantiles_1)

**Syntax:** obj \<< Quantiles( state=0|1 )

**Description:** Shows or hides the Quantiles report, which lists the values of selected quantiles. By default, the quantiles listed are 0%, 0.5%, 2.5%, 10%, 25%, 50%, 75%, 90%, 97.5%, 99.5%, and 100%. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Quantiles( 0 );


```

#### [Save](#save_1)

**Syntax:** obj \<< Save( "Level Numbers"|"Level Midpoints"|"Ranks"|"Ranks averaged"|"Prob Scores"|"Normal Quantiles"|"Standardized"|"Centered"|"Robust Standardized"|"Robust Centered"|"Spec Limits"|"Script to Log" )

**Description:** Saves the specified observation-specific statistic to a new column in the data table. There is also an option to print the script commands that generate the current report to the log window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Save( "Ranks" );


```

#### [Set Bin Width](#set-bin-width_1)

**Syntax:** obj \<< Set Bin Width( number )

**Description:** Sets the histogram bin width, using the axis as the origin. This option is available only for continuous variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Set Bin Width( 5 );


```

#### [Set Quantile Increment](#set-quantile-increment_1)

**Syntax:** obj \<< Set Quantile Increment( fraction | "revert to default quantiles" )

**Description:** Sets the increment used in the Quantiles report to the specified fraction or changes back to the default quantiles. This option is available only for continuous variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Set Quantile Increment( 0.05 );
Wait( 1 );
obj << Set Quantile Increment( "revert to default quantiles" );


```

#### [Shadowgram](#shadowgram_1)

**Syntax:** obj \<< Shadowgram( state=0|1 )

**Description:** Shows or hides a smooth shadowgram in place of the histogram. A shadowgram overlays histograms with different bin widths. This option is available only for continuous variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Shadowgram( 1 );


```

#### [Show Counts](#show-counts_1)

**Syntax:** obj \<< Show Counts( state=0|1 )

**Description:** Shows or hides the bar counts on the histogram, which give the frequency of column values represented by each histogram bar.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Show Counts( 1 );


```

#### [Show Percents](#show-percents_1)

**Syntax:** obj \<< Show Percents( state=0|1 )

**Description:** Shows or hides the bar percents on the histogram, which give the percentage of column values represented by each histogram bar.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Show Percents( 1 );


```

#### [Std Error Bars](#std-error-bars_1)

**Syntax:** obj \<< Std Error Bars( state=0|1 )

**Description:** Shows or hides standard error bars on each of the histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Std Error Bars( 1 );


```

#### [Stem and Leaf](#stem-and-leaf_1)

**Syntax:** obj \<< Stem and Leaf( state=0|1 )

**Description:** Shows or hides a stem-and-leaf plot.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Stem and Leaf( 1 );


```

#### [Summary Statistics](#summary-statistics_1)

**Syntax:** obj \<< Summary Statistics( state=0|1 )

**Description:** Shows or hides the Summary Statistics report, which lists the mean, standard deviation, and other summary statistics for continuous variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
Wait( 1 );
obj << Summary Statistics( 0 );


```

#### [Test Equivalence](#test-equivalence_1)

**Syntax:** obj \<< Test Equivalence( Target( number ), Practical Difference( number ), \<Confidence( fraction )> )

**Description:** Tests whether the sample mean is equivalent to a hypothesized value (Target) using the Two One-Sided Tests (TOST) approach.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Test Equivalence( Target( 62 ), Practical Difference( 1 ), Confidence( 0.95 ) );


```

#### [Test Mean](#test-mean_1)

**Syntax:** obj \<< Test Mean( number, \<Sigma( number )>, < Wilcoxon Signed Rank( 0|1 ) >, <PValue Animation>, <Power Animation> )

**Description:** Performs a one-sample test for the mean. If you specify a value for the standard deviation (Sigma), a z test is performed. Otherwise, the sample standard deviation is used to perform a t test. There is also an option to perform an additional nonparametric Wilcoxon Signed-Rank test.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Test Mean( 60 ); 

obj << Test Mean( 60, Sigma( 4 ) ); 

obj << Test Mean( 60, Wilcoxon Signed Rank( 1 ) );


```

#### [Test Std Dev](#test-std-dev_1)

**Syntax:** obj \<< Test Std Dev( number )

**Description:** Performs a chi-squared test for the standard deviation, given the hypothesized value (number).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Test Std Dev( 3 );


```

#### [Tolerance Interval](#tolerance-interval_1)

**Syntax:** obj \<< Tolerance Interval( Alpha(number), Proportion(number), \<Lower | Upper>, \<Normal|Lognormal|Gamma|Exponential|Weibull|Smallest Extreme Value|Largest Extreme Value|Nonparametric> )

**Description:** Computes an interval that contains at least a specified portion of the population. A standard normal distribution is assumed. You can also specify other nonnormal distributions including lognormal, Gamma, exponential, Weibull, smallest extreme value, largest extreme value, and nonparametric distributions. There are also options for computing one-sided intervals.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.85 ) );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.9 ), Lower );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.9 ), Upper, Lognormal );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.8 ), Lower, Nonparametric );


```

#### [Vertical](#vertical_1)

**Syntax:** obj \<< Vertical( state=0|1 )

**Description:** Changes the orientation of the histogram, box plots, and quantile plots to be vertical. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Vertical( 0 );


```

## [Distribution Fit](#distribution-fit)

### [Item Messages](#item-messages_4)

#### [Density Curve](#density-curve)

**Syntax:** obj \<< Fit Distribution Name( Density Curve( state=0|1 ) ); obj \<< ( Fit Handle[number] \<< Density Curve( state=0|1 ))

**Description:** Shows or hides a density curve on the histogram. The estimated parameters from the specified fit are used to create the density curve. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Density Curve( 0 ) );


```

#### [Distribution Profiler](#distribution-profiler)

**Syntax:** obj \<< Fit Distribution Name( Distribution Profiler( state=0|1 ) ); obj \<< ( Fit Handle[number] \<< Distribution Profiler( state=0|1 ) )

**Description:** Shows or hides a prediction profiler of the cumulative distribution function for the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Distribution Profiler( 1 ) );


```

#### [Fitted CDF](#fitted-cdf)

**Syntax:** obj \<< Fit Distribution Name( Fitted CDF( vector )); obj \<< ( Fit Handle[number] \<< Fitted CDF( vector ))

**Description:** Shows or hides the specified fitted probabilities for the fitted distribution.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Fitted CDF( [5 8 11] ) );


```

#### [Fitted Quantiles](#fitted-quantiles)

**Syntax:** obj \<< Fit Distribution Name( Fitted Quantiles( vector )); obj \<< ( Fit Handle[number] \<< Fitted Quantiles( vector ))

**Description:** Shows or hides the specified quantiles for the specified fitted distribution.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Fitted Quantiles( [.9 .95 .99] ) );


```

#### [Fix Parameters](#fix-parameters)

**Syntax:** obj \<< Fit Distribution Name( Fix Parameters( vector )); obj \<< ( Fit Handle[number] \<< Fix Parameters( vector ))

**Description:** Fixes the specified parameters as constants and re-estimates the non-fixed parameters.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Normal( Fix Parameters( [. 2.8] ) );


```

#### [Goodness of Fit](#goodness-of-fit)

**Syntax:** obj \<< Fit Distribution Name( Goodness of Fit( state=0|1 )); obj \<< ( Fit Handle[number] \<< Goodness of Fit( state=0|1 ))

**Description:** Shows or hides a report that contains a goodness-of-fit test for the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Goodness of Fit( 1 ) );


```

#### [PP Plot](#pp-plot)

**Syntax:** obj \<< Fit Distribution Name( PP Plot( state=0|1 ) ); obj \<< (Fit Handle[ number ] \<< PP Plot( state=0|1 ) )

**Description:** Shows or hides a percentile-percentile (PP) plot that shows the relationship between the empirical cumulative distribution function (CDF) and the CDF of the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit Gamma( PP Plot( 1 ) );


```

#### [Process Capability](#process-capability_2)

**Syntax:** obj \<< Fit Distribution Name( Process Capability( LSL( number ), Target( number ), USL( number ))); obj \<< (Fit Handle[number] \<< ( Process Capability( LSL( number ), Target( number ), USL( number ))))

**Description:** Computes a process capability analysis given the lower specification limit (LSL), target, and upper specification limit (USL). The Process Capability report includes a histogram, summary details, capability indices, and nonconformance statistics.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Distribution( Column( :OZONE ) );
obj << Fit Lognormal( Process Capability( LSL( .03 ), Target( .15 ), USL( .27 ) ) );


```

#### [QQ Plot](#qq-plot)

**Syntax:** obj \<< Fit Distribution Name( QQ Plot( state=0|1 ) ); obj \<< ( Fit Handle[number] \<< QQ Plot( state=0|1 ) )

**Description:** Shows or hides a quantile-quantile (QQ) plot that shows the relationship between the observed data and the quantiles of the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Distribution( Column( :Y ) );
obj << Fit Gamma( QQ Plot( 1 ) );


```

#### [Quantile Profiler](#quantile-profiler)

**Syntax:** obj \<< Fit Distribution Name( Quantile Profiler( state=0|1 ) ); obj \<< ( Fit Handle[number] \<< Quantile Profiler( state=0|1 ) )

**Description:** Shows or hides a prediction profiler of the quantile function for the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Quantile Profiler( 1 ) );


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (Fit Handle[number] \<< Remove Fit )

**Description:** Removes the fit and JSL object of the specified distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Weibull;
obj << Fit Lognormal;
Wait( 1 );
obj << (Fit Handle[1] << Remove Fit);


```

#### [Save Density Formula](#save-density-formula)

**Syntax:** obj \<< Fit Distribution Name( Save Density Formula ) ; obj \<< ( Fit Handle[number] \<< Save Density Formula )

**Description:** Saves a column to the data table that contains the density formula of the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Save Density Formula );


```

#### [Save Distribution Formula](#save-distribution-formula)

**Syntax:** obj \<< Fit Distribution Name( Save Distribution Formula ) ; obj \<< ( Fit Handle[number] \<< Save Distribution Formula )

**Description:** Saves a column to the data table that contains the cumulative distribution function of the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Save Distribution Formula );


```

#### [Save Simulation Formula](#save-simulation-formula)

**Syntax:** obj \<< Fit Distribution Name( Save Simulation Formula ) ; obj \<< ( Fit Handle[number] \<< Save Simulation Formula )

**Description:** Saves a column to the data table that contains a formula that generates simulated values from the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Lognormal( Save Simulation Formula );


```

#### [Save Transformed](#save-transformed)

**Syntax:** obj \<< Fit Distribution Name( Save Transformed ); obj \<< ( Fit Handle[number] \<< Save Transformed )

**Description:** Saves a column to the data table that contains a formula used to transform the analysis column to normality using the specified fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :CO ) );
obj << Fit Shash( Save Transformed );


```

## [Distribution Process Capability](#distribution-process-capability)

### [Item Messages](#item-messages_5)

#### [Color Out of Spec Values](#color-out-of-spec-values)

**Syntax:** obj \<< Color Out of Spec Values

**Description:** Colors the cells in the data table for values that are out of spec. Cells with values below the lower specification limit (LSL) are colored red, and cells with values above the upper specification limit (USL) are colored blue.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Process Capability(
    LSL( 0.12 ),
    Target( 0.18 ),
    USL( 0.24 ),
    Color Out of Spec Values
);


```

#### [Remove](#remove_1)

**Syntax:** obj \<< Remove( LSL, Target, USL )

**Description:** Removes the process capability analysis.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Process Capability( LSL( 0.12 ), Target( 0.18 ), USL( 0.24 ) );
Wait( 2 );
scrobj = (Report( obj )["Process Capability"] << get scriptable object);
scrobj << Remove;


```

#### [Save Distribution as a Column Property](#save-distribution-as-a-column-property)

**Syntax:** obj \<< Process Capability( Save Distribution as a Column Property )

**Description:** Saves the Process Capability Distribution type as a column property within the column of the original data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Process Capability(
    LSL( 0.03 ),
    Target( 0.15 ),
    USL( 0.27 ),
    Dist( Lognormal ),
    Save Distribution as a Column Property
);


```

#### [Save In Spec Indicator Formula](#save-in-spec-indicator-formula)

**Syntax:** obj \<< Save In Spec Indicator Formula

**Description:** Creates a new formula column in the data table. The new column contains a value that indicates whether or not a row is within the specification limits.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Process Capability(
    LSL( 0.12 ),
    Target( 0.18 ),
    USL( 0.24 ),
    Save In Spec Indicator Formula
);


```

#### [Save Spec Limits and Distribution to Column Properties without Report](#save-spec-limits-and-distribution-to-column-properties-without-report)

**Syntax:** obj \<< Fit Distribution Name( Process Capability(Save Spec Limits and Distribution to Column Properties without Report))

**Description:** Saves the calculated specification limits and process capability distribution type for the fitted distribution as column properties within the column of the original data table and shows no capability report.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Fit Lognormal(
    Process Capability(
        Set Sigma Multiplier for Quantile Spec Limits( 4 ),
        Save Spec Limits and Distribution to Column Properties without Report
    )
);


```

#### [Save Spec Limits as a Column Property](#save-spec-limits-as-a-column-property)

**Syntax:** obj \<< Fit Distribution Name( Process Capability( Save Spec Limits as a Column Property )); obj \<< Process Capability( Save Spec Limits as a Column Property )

**Description:** Saves the specification limits as a column property within the column of the original data table.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Fit Lognormal(
    Process Capability(
        LSL( 0.03 ),
        Target( 0.15 ),
        USL( 0.27 ),
        Save Spec Limits as a Column Property
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Process Capability(
    LSL( 0.03 ),
    Target( 0.15 ),
    USL( 0.27 ),
    Save Spec Limits as a Column Property
);


```

#### [Set Probabilities for Quantile Spec Limits](#set-probabilities-for-quantile-spec-limits)

**Syntax:** obj \<< Fit Distribution Name( Process Capability(Set Probabilties for Quantile Spec Limits( LSL Prob(p1), Target Prob(p2), USL Prob(p3)))); obj \<< Process Capability(Set Probabilties for Quantile Spec Limits( LSL Prob(p1), Target Prob(p2), USL Prob(p3)))

**Description:** Sets the probabilities that are used to calculate the quantile specification limits for the fitted distribution.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Fit Lognormal(
    Process Capability(
        Set Probabilities for Quantile Spec Limits(
            LSL Prob( .0001 ),
            Target Prob( .5 ),
            USL Prob( .9999 )
        )
    )
);


```

#### [Set Sigma Multiplier for Quantile Spec Limits](#set-sigma-multiplier-for-quantile-spec-limits)

**Syntax:** obj \<< Fit Distribution Name( Process Capability(Set Sigma Multiplier for Quantile Spec Limits(K, \<sided=1|2>))); obj \<< Process Capability(Set Sigma Multiplier for Quantile Spec Limits(K, \<sided=1|2>))

**Description:** Sets a sigma multiplier, K, that is used to calculate the quantile specification limits for the fitted distribution. The optional sided argument equals 1 for LSL only or 2 for USL only.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Distribution( Column( :OZONE ) );
obj << Fit Lognormal(
    Process Capability( Set Sigma Multiplier for Quantile Spec Limits( 4 ) )
);


```

## [Distribution Summary Statistics](#distribution-summary-statistics)

### [Item Messages](#item-messages_6)

#### [Customize Summary Statistics](#customize-summary-statistics_2)

**Syntax:** obj \<< Customize Summary Statistics(statistic1( state=0|1 ), statistic2( state=0|1 ), ..., statisticN( state=0|1 ), \<Set Trimmed Mean Percent(number)>, \<Set Alpha Level(number)>)

**Description:** Customizes the summary statistics that are displayed in the Summary Statistics report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Distribution( Column( :Height ) );
obj << Customize Summary Statistics( N( 0 ), Variance( 1 ), Skewness( 1 ) );


```

#### [Show All Modes](#show-all-modes)

**Syntax:** obj \<< Customize Summary Statistics( Show all Modes( state=0|1 ))

**Description:** Shows or hides all modes in the Summary Statistics report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Distribution( Column( :Height ) );
obj << Customize Summary Statistics( Mode( 1 ), Show All Modes( 1 ) );


```

## [Multiple Response Distribution](#multiple-response-distribution)

### [Item Messages](#item-messages_7)

#### [Apply Preset](#apply-preset_2)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();
dt2 = Open( "$SAMPLE_DATA/Aircraft Incidents.jmp" );
obj2 = dt2 << Distribution(
    Nominal Distribution( Column( :Aircraft Damage ) ),
    Continuous Distribution( Column( :Total Minor Injuries ) )
);
Wait( 1 );
obj2[2] << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
Wait( 1 );
obj[1] << Apply Preset( "Sample Presets", "Check Normality" );


```

#### [Axes on Left](#axes-on-left_2)

**Syntax:** obj \<< Axes on Left( state=0|1 )

**Description:** Moves the count, probability, density, and normal quantile plot axes to the left side of a horizontal graph.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution(
    Multiple Response Distribution(
        Column( :Brush Delimited ),
        Horizontal Layout( 1 ),
        Count Axis( 1 )
    )
);
obj << Axes on Left( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Nominal Distribution( Column( :Age ), Horizontal Layout( 1 ), Count Axis( 1 ) )
);
obj << Axes on Left( 1 );


```

#### [Confidence Interval](#confidence-interval_3)

**Syntax:** obj \<< Confidence Interval( "0.90"|"0.95"|"0.99"|"Other…" )

**Description:** Computes score confidence intervals about the probabilities.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Confidence Interval( 0.95 );


```

#### [Count Axis](#count-axis_2)

**Syntax:** obj \<< Count Axis( state=0|1 )

**Description:** Shows or hides the count axis for the histogram.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Count Axis( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Count Axis( 1 );


```

#### [Density Axis](#density-axis_2)

**Syntax:** obj \<< Density Axis( state=0|1 )

**Description:** Shows or hides the density axis for the density curve on the histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Density Axis( 1 );


```

#### [Frequencies](#frequencies_1)

**Syntax:** obj \<< Frequencies( state=0|1 )

**Description:** Shows or hides the Frequencies report, which lists the counts and probabilities for each level. On by default.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
Wait( 1 );
obj << Frequencies( 0 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
Wait( 1 );
obj << Frequencies( 0 );


```

#### [Histogram](#histogram_2)

**Syntax:** obj \<< Histogram( state=0|1 )

**Description:** Shows or hides the histogram. On by default.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
Wait( 1 );
obj << Histogram( 0 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
Wait( 1 );
obj << Histogram( 0 );


```

#### [Histogram Color](#histogram-color_2)

**Syntax:** obj \<< Histogram Color( color )

**Description:** Changes the color of the histogram bars.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Histogram Color( "Blue" );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Histogram Color( "Red" );


```

#### [Horizontal Layout](#horizontal-layout_2)

**Syntax:** obj \<< Horizontal Layout( state=0|1 )

**Description:** Changes the orientation of the histogram and the reports to be horizontal.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Horizontal Layout( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Horizontal Layout( 1 );


```

#### [Mosaic Plot](#mosaic-plot_1)

**Syntax:** obj \<< Mosaic Plot( state=0|1 )

**Description:** Shows or hides a mosaic bar chart for each nominal or ordinal response variable. A mosaic plot is a stacked bar chart where each segment is proportional to its group's frequency count.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Mosaic Plot( 1 );


```

#### [New Preset](#new-preset_2)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();


```

#### [Order By](#order-by_1)

**Syntax:** obj \<< Order By( "Default"|"Count Descending"|"Count Ascending" )

**Description:** Orders the histogram, mosaic plot, and Frequencies report in ascending or descending order, by count. You can also revert back to the default ordering.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Order By( "Count Descending" );


```

#### [Prob Axis](#prob-axis_2)

**Syntax:** obj \<< Prob Axis( state=0|1 )

**Description:** Shows or hides the probability or proportion axis for this histogram.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Prob Axis( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Prob Axis( 1 );


```

#### [Save](#save_2)

**Syntax:** obj \<< Save( "Level Numbers"|"Value Ordering"|"Script to Log" )

**Description:** Saves the Level Numbers to a new column in the data table or the script to the log.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Save( "Level Numbers" );


```

#### [Separate Bars](#separate-bars_1)

**Syntax:** obj \<< Separate Bars( state=0|1 )

**Description:** Adds space between the bars of the histogram. This option is available only for categorical variables.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Separate Bars( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Separate Bars( 1 );


```

#### [Show Counts](#show-counts_2)

**Syntax:** obj \<< Show Counts( state=0|1 )

**Description:** Shows or hides the bar counts on the histogram, which give the frequency of column values represented by each histogram bar.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Show Counts( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Show Counts( 1 );


```

#### [Show Percents](#show-percents_2)

**Syntax:** obj \<< Show Percents( state=0|1 )

**Description:** Shows or hides the bar percents on the histogram, which give the percentage of column values represented by each histogram bar.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Show Percents( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Show Percents( 1 );


```

#### [Std Error Bars](#std-error-bars_2)

**Syntax:** obj \<< Std Error Bars( state=0|1 )

**Description:** Shows or hides standard error bars on each of the histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Std Error Bars( 1 );


```

#### [Test Probabilities](#test-probabilities_1)

**Syntax:** obj \<< Test Probabilities( Test( Hypothesized|Greater than|Less than ), Fix( Hypothesized|Omitted ), p1, <f>, p2, <f>, p3, <f>, etc. )

**Description:** Tests the estimated probabilities of the levels of a categorical variable against the specified hypothesized probabilities (p1, p2, p3, and so on). For variables with two levels, use the Test option to specify the sign for the alternative hypothesis of the test. For variables with more than two levels, use the Fix option to specify how missing hypothesized values are handled. Note that f is an optional argument that specifies that the preceding level is treated as fixed.

**Multiple Levels Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :age ) ) );
obj << Test Probabilities(
    Test( Hypothesized ),
    0.8,
    0.04375,
    0.075,
    0.04375,
    0.01875,
    0.01875
);


```

**Two Level, One-Sided Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :sex ) ) );
obj << Test Probabilities( Test( Less than ), 0.5, f, 0.5 );


```

**Two Level, Two-Sided Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :sex ) ) );
obj << Test Probabilities( Test( Hypothesized ), 0.4, f, 0.6, f );


```

#### [Vertical](#vertical_2)

**Syntax:** obj \<< Vertical( state=0|1 )

**Description:** Changes the orientation of the histogram, box plots, and quantile plots to be vertical. On by default.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Vertical( 0 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Vertical( 0 );


```

## [Nominal Distribution](#nominal-distribution)

### [Item Messages](#item-messages_8)

#### [Apply Preset](#apply-preset_3)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();
dt2 = Open( "$SAMPLE_DATA/Aircraft Incidents.jmp" );
obj2 = dt2 << Distribution(
    Nominal Distribution( Column( :Aircraft Damage ) ),
    Continuous Distribution( Column( :Total Minor Injuries ) )
);
Wait( 1 );
obj2[2] << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
Wait( 1 );
obj[1] << Apply Preset( "Sample Presets", "Check Normality" );


```

#### [Axes on Left](#axes-on-left_3)

**Syntax:** obj \<< Axes on Left( state=0|1 )

**Description:** Moves the count, probability, density, and normal quantile plot axes to the left side of a horizontal graph.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution(
    Multiple Response Distribution(
        Column( :Brush Delimited ),
        Horizontal Layout( 1 ),
        Count Axis( 1 )
    )
);
obj << Axes on Left( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Nominal Distribution( Column( :Age ), Horizontal Layout( 1 ), Count Axis( 1 ) )
);
obj << Axes on Left( 1 );


```

#### [Confidence Interval](#confidence-interval_4)

**Syntax:** obj \<< Confidence Interval( "0.90"|"0.95"|"0.99"|"Other…" )

**Description:** Computes score confidence intervals about the probabilities.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Confidence Interval( 0.95 );


```

#### [Count Axis](#count-axis_3)

**Syntax:** obj \<< Count Axis( state=0|1 )

**Description:** Shows or hides the count axis for the histogram.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Count Axis( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Count Axis( 1 );


```

#### [Density Axis](#density-axis_3)

**Syntax:** obj \<< Density Axis( state=0|1 )

**Description:** Shows or hides the density axis for the density curve on the histogram.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Density Axis( 1 );


```

#### [Frequencies](#frequencies_2)

**Syntax:** obj \<< Frequencies( state=0|1 )

**Description:** Shows or hides the Frequencies report, which lists the counts and probabilities for each level. On by default.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
Wait( 1 );
obj << Frequencies( 0 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
Wait( 1 );
obj << Frequencies( 0 );


```

#### [Histogram](#histogram_3)

**Syntax:** obj \<< Histogram( state=0|1 )

**Description:** Shows or hides the histogram. On by default.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
Wait( 1 );
obj << Histogram( 0 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
Wait( 1 );
obj << Histogram( 0 );


```

#### [Histogram Color](#histogram-color_3)

**Syntax:** obj \<< Histogram Color( color )

**Description:** Changes the color of the histogram bars.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Histogram Color( "Blue" );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Histogram Color( "Red" );


```

#### [Horizontal Layout](#horizontal-layout_3)

**Syntax:** obj \<< Horizontal Layout( state=0|1 )

**Description:** Changes the orientation of the histogram and the reports to be horizontal.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Horizontal Layout( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Horizontal Layout( 1 );


```

#### [Mosaic Plot](#mosaic-plot_2)

**Syntax:** obj \<< Mosaic Plot( state=0|1 )

**Description:** Shows or hides a mosaic bar chart for each nominal or ordinal response variable. A mosaic plot is a stacked bar chart where each segment is proportional to its group's frequency count.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Mosaic Plot( 1 );


```

#### [New Preset](#new-preset_3)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution(
    Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) ),
    Nominal Distribution( Column( :age ), Mosaic Plot( 1 ) )
);
preset = obj[1] << New Preset();


```

#### [Order By](#order-by_2)

**Syntax:** obj \<< Order By( "Default"|"Count Descending"|"Count Ascending" )

**Description:** Orders the histogram, mosaic plot, and Frequencies report in ascending or descending order, by count. You can also revert back to the default ordering.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Order By( "Count Descending" );


```

#### [Prob Axis](#prob-axis_3)

**Syntax:** obj \<< Prob Axis( state=0|1 )

**Description:** Shows or hides the probability or proportion axis for this histogram.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Prob Axis( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Prob Axis( 1 );


```

#### [Save](#save_3)

**Syntax:** obj \<< Save( "Level Numbers"|"Value Ordering"|"Script to Log" )

**Description:** Saves the Level Numbers to a new column in the data table or the script to the log.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Save( "Level Numbers" );


```

#### [Separate Bars](#separate-bars_2)

**Syntax:** obj \<< Separate Bars( state=0|1 )

**Description:** Adds space between the bars of the histogram. This option is available only for categorical variables.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Separate Bars( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Separate Bars( 1 );


```

#### [Show Counts](#show-counts_3)

**Syntax:** obj \<< Show Counts( state=0|1 )

**Description:** Shows or hides the bar counts on the histogram, which give the frequency of column values represented by each histogram bar.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Show Counts( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Show Counts( 1 );


```

#### [Show Percents](#show-percents_3)

**Syntax:** obj \<< Show Percents( state=0|1 )

**Description:** Shows or hides the bar percents on the histogram, which give the percentage of column values represented by each histogram bar.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Show Percents( 1 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Show Percents( 1 );


```

#### [Std Error Bars](#std-error-bars_3)

**Syntax:** obj \<< Std Error Bars( state=0|1 )

**Description:** Shows or hides standard error bars on each of the histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Std Error Bars( 1 );


```

#### [Test Probabilities](#test-probabilities_2)

**Syntax:** obj \<< Test Probabilities( Test( Hypothesized|Greater than|Less than ), Fix( Hypothesized|Omitted ), p1, <f>, p2, <f>, p3, <f>, etc. )

**Description:** Tests the estimated probabilities of the levels of a categorical variable against the specified hypothesized probabilities (p1, p2, p3, and so on). For variables with two levels, use the Test option to specify the sign for the alternative hypothesis of the test. For variables with more than two levels, use the Fix option to specify how missing hypothesized values are handled. Note that f is an optional argument that specifies that the preceding level is treated as fixed.

**Multiple Levels Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :age ) ) );
obj << Test Probabilities(
    Test( Hypothesized ),
    0.8,
    0.04375,
    0.075,
    0.04375,
    0.01875,
    0.01875
);


```

**Two Level, One-Sided Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :sex ) ) );
obj << Test Probabilities( Test( Less than ), 0.5, f, 0.5 );


```

**Two Level, Two-Sided Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :sex ) ) );
obj << Test Probabilities( Test( Hypothesized ), 0.4, f, 0.6, f );


```

#### [Vertical](#vertical_3)

**Syntax:** obj \<< Vertical( state=0|1 )

**Description:** Changes the orientation of the histogram, box plots, and quantile plots to be vertical. On by default.

**Multiple Response Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Distribution( Multiple Response Distribution( Column( :Brush Delimited ) ) );
obj << Vertical( 0 );


```

**Nominal Distribution Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Nominal Distribution( Column( :Age ) ) );
obj << Vertical( 0 );


```

## [Prediction Interval](#prediction-interval_2)

### [Item Messages](#item-messages_9)

#### [Remove](#remove_2)

**Syntax:** obj \<< Remove

**Description:** Removes the Prediction Interval report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Prediction Interval( 0.95, 20 );
Wait( 2 );
scrobj = (Report( obj )["Prediction Interval"] << get scriptable object);
scrobj << Remove;


```

## [Test Equivalence](#test-equivalence_2)

### [Item Messages](#item-messages_10)

#### [Remove](#remove_3)

**Syntax:** obj \<< Remove

**Description:** Removes the Test Equivalence report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Test Equivalence( Target( 62 ), Practical Difference( 1 ), Confidence( 0.95 ) );
Wait( 2 );
scrobj = (Report( obj )["Test Equivalence"] << get scriptable object);
scrobj << Remove;


```

## [Test Mean](#test-mean_2)

### [Item Messages](#item-messages_11)

#### [PValue animation](#pvalue-animation)

**Syntax:** obj \<< Test Mean( PValue Animation )

**Description:** Opens a separate window that shows an animation of how p-values change as the mean changes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Distribution( Column( :Height ) );
obj << Test Mean( 60, PValue Animation );


```

#### [Power animation](#power-animation)

**Syntax:** obj \<< Test Mean( Power Animation )

**Description:** Opens a separate window that shows an animation of how the power changes as the mean changes and whether the test is one-sided or two-sided.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Distribution( Column( :Height ) );
obj << Test Mean( 60, Power Animation );


```

#### [Remove Test](#remove-test)

**Syntax:** obj \<< Remove Test

**Description:** Removes the Test Mean report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Distribution( Column( :Height ) );
obj << Test Mean( 60 );
Wait( 2 );
scrobj = (Report( obj )["Test Mean"] << get scriptable object);
scrobj << Remove Test;


```

## [Tolerance Interval](#tolerance-interval_2)

### [Item Messages](#item-messages_12)

#### [Remove](#remove_4)

**Syntax:** obj \<< Remove

**Description:** Removes the Tolerance Interval report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Tolerance Interval( Alpha( 0.95 ), Proportion( 0.85 ) );
Wait( 2 );
scrobj = (Report( obj )["Normal Distribution Tolerance Intervals"] << get scriptable object);
scrobj << Remove;


```

#### [Save Distribution as a Column Property](#save-distribution-as-a-column-property_1)

**Syntax:** obj \<< Tolerance Interval( Save Distribution as a Column Property )

**Description:** Saves the Tolerance Interval Distribution type as a column property within the column of the original data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Distribution( Column( :Height ) );
obj << Tolerance Interval(
    Alpha( 0.95 ),
    Proportion( 0.90 ),
    Lognormal,
    Save Distribution as a Column Property
);


```

#### [Save to Spec Limits Column Property](#save-to-spec-limits-column-property)

**Syntax:** obj \<< Save to Spec Limits Column Property( Alpha(number), Proportion(number), \<Lower | Upper>, <Nonparametric>, <Save to Spec Limits Column Property> )

**Description:** Saves the tolerance interval as specification limits in the Spec Limits column property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Distribution( Column( :Height ) );
obj << Tolerance Interval(
    Alpha( 0.95 ),
    Proportion( 0.85 ),
    Save to Spec Limits Column Property
);


```

# [EMP Measurement Systems Analysis](#emp-measurement-systems-analysis)

## [Associated Constructors](#associated-constructors)

### [EMP Measurement Systems Analysis](#emp-measurement-systems-analysis_1)

**Syntax:** EMP Measurement Systems Analysis( Y( column ), X( columns ), Part(column), Model(Main|Crossed|Crossed with Two Factor Interactions|Nested|Crossed then Nested|Nested then Crossed), Dispersion Chart Type(Range|Standard Deviation) )

**Description:** Launches the EMP (Evaluating the Measurement Process) method for Measurement Systems Analysis. The average and dispersion (range or standard deviation) charts are displayed by default.

#### [Crossed Effects Model, Range Chart](#crossed-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Crossed Effects Model, Std Dev Chart](#crossed-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Crossed then Nested Effects Model, Range Chart](#crossed-then-nested-effects-model-range-chart)

```

dt = New Table( "3 Factors Crossed then Nested",
    Add Rows( 81 ),
    New Column( "Operator",
        Character( 7 ),
        "Nominal",
        Set Values(
            {"Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Instrument",
        Character( 1 ),
        "Nominal",
        Set Values(
            {"A", "A", "A", "A", "A", "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B",
            "B", "B", "C", "C", "C", "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A",
            "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C",
            "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A", "A", "A", "A", "A", "B",
            "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C", "C", "C", "C", "C", "C",
            "C"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Part",
        Numeric,
        "Nominal",
        Format( "Best", 8 ),
        Set Values(
            [1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4, 5, 5, 5, 6, 6, 6, 7, 7, 7, 8, 8, 8, 9, 9, 9,
            10, 10, 10, 11, 11, 11, 12, 12, 12, 13, 13, 13, 14, 14, 14, 15, 15, 15, 16, 16,
            16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20, 20, 20, 21, 21, 21, 22, 22, 22, 23,
            23, 23, 24, 24, 24, 25, 25, 25, 26, 26, 26, 27, 27, 27]
        ),
        Set Display Width( 0 )
    ),
    New Column( "Y",
        Numeric,
        "Continuous",
        Format( "Best", 8 ),
        Set Values(
            [0.5, 0.6, 0.2, 0.8, 0.6, 0.6, 1.6, 1.1, 1, 0.4, 0.2, 0.1, 0.1, 0.5, 0, 0.3, 0.6,
            0.8, 0.1, 0.1, 0.2, 0.4, 0.9, 1.8, 0.1, 0.3, 0.4, 0.1, 0.3, 0.1, 0.9, 0.4, 0, 0.6,
            0.7, 0.7, 0.3, 0.1, 0.2, 0.3, 0.6, 0.2, 0.2, 0.4, 0.4, 0.8, 0.3, 0.3, 2.6, 0.4,
            1.6, 0.5, 0.3, 2.9, 0, 0, 0.5, 0.1, 0, 0.3, 0.5, 0, 0, 0.4, 0, 0.4, 0.3, 0.2, 0,
            0, 0.5, 0.1, 0.1, 0.2, 0.3, 1.1, 0.2, 0.1, 0.6, 0.3, 0.6]
        ),
        Set Display Width( 68 )
    )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed then Nested (3 Factors Only)"n ),
    Dispersion Chart Type( Range ),
    Variance Components( 1 )
);


```

#### [Crossed then Nested Effects Model, Std Dev Chart](#crossed-then-nested-effects-model-std-dev-chart)

```

dt = New Table( "3 Factors Crossed then Nested",
    Add Rows( 81 ),
    New Column( "Operator",
        Character( 7 ),
        "Nominal",
        Set Values(
            {"Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Instrument",
        Character( 1 ),
        "Nominal",
        Set Values(
            {"A", "A", "A", "A", "A", "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B",
            "B", "B", "C", "C", "C", "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A",
            "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C",
            "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A", "A", "A", "A", "A", "B",
            "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C", "C", "C", "C", "C", "C",
            "C"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Part",
        Numeric,
        "Nominal",
        Format( "Best", 8 ),
        Set Values(
            [1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4, 5, 5, 5, 6, 6, 6, 7, 7, 7, 8, 8, 8, 9, 9, 9,
            10, 10, 10, 11, 11, 11, 12, 12, 12, 13, 13, 13, 14, 14, 14, 15, 15, 15, 16, 16,
            16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20, 20, 20, 21, 21, 21, 22, 22, 22, 23,
            23, 23, 24, 24, 24, 25, 25, 25, 26, 26, 26, 27, 27, 27]
        ),
        Set Display Width( 0 )
    ),
    New Column( "Y",
        Numeric,
        "Continuous",
        Format( "Best", 8 ),
        Set Values(
            [0.5, 0.6, 0.2, 0.8, 0.6, 0.6, 1.6, 1.1, 1, 0.4, 0.2, 0.1, 0.1, 0.5, 0, 0.3, 0.6,
            0.8, 0.1, 0.1, 0.2, 0.4, 0.9, 1.8, 0.1, 0.3, 0.4, 0.1, 0.3, 0.1, 0.9, 0.4, 0, 0.6,
            0.7, 0.7, 0.3, 0.1, 0.2, 0.3, 0.6, 0.2, 0.2, 0.4, 0.4, 0.8, 0.3, 0.3, 2.6, 0.4,
            1.6, 0.5, 0.3, 2.9, 0, 0, 0.5, 0.1, 0, 0.3, 0.5, 0, 0, 0.4, 0, 0.4, 0.3, 0.2, 0,
            0, 0.5, 0.1, 0.1, 0.2, 0.3, 1.1, 0.2, 0.1, 0.6, 0.3, 0.6]
        ),
        Set Display Width( 68 )
    )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed then Nested (3 Factors Only)"n ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Crossed with Two Factor Interaction Effects Model, Range Chart](#crossed-with-two-factor-interaction-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :new Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed with Two Factor Interactions" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Crossed with Two Factor Interaction Effects Model, Std Dev Chart](#crossed-with-two-factor-interaction-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :new Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Crossed with Two Factor Interactions" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Main Effects Model, Range Chart](#main-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Main" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Main Effects Model, Std Dev Chart](#main-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Main" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Nested Effects Model, Range Chart](#nested-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Nested" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Nested Effects Model, Std Dev Chart](#nested-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Nested" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

#### [Nested then Crossed Effects Model, Range Chart](#nested-then-crossed-effects-model-range-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Nested & Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Nested then Crossed (3 Factors Only)"n ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);


```

#### [Nested then Crossed Effects Model, Std Dev Chart](#nested-then-crossed-effects-model-std-dev-chart)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Nested & Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model( "Nested then Crossed (3 Factors Only)"n ),
    Dispersion Chart Type( "Standard Deviation" ),
    Variance Components( 1 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = EMP Measurement Systems Analysis(...\<By( column(s) )>...)

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Crossed.jmp" );
EMP Measurement Systems Analysis(
    Y( :new Y ),
    X( :Operator ),
    Part( :Part ),
    Model( Crossed ),
    Dispersion Chart Type( Range ),
    By( :Instrument )
);


```

### [Grouping](#grouping)

**Syntax:** obj = EMP Measurement Systems Analysis(...\<Grouping( column(s) )>...)

**Description:** Specifies categorical column(s) as grouping variables.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    Grouping( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

### [Measurement](#measurement)

**Syntax:** obj = EMP Measurement Systems Analysis(...Measurement( column(s) )...)

**Description:** Specifies the continuous column(s) of measurements.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Measurement( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

### [Part](#part)

**Syntax:** obj = EMP Measurement Systems Analysis(...Part( column )...)

**Description:** Specifies the categorical column designating the part or unit.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Sample ID( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

### [Sample ID](#sample-id)

**Syntax:** obj = EMP Measurement Systems Analysis(...Sample ID( column )...)

**Description:** Specifies the categorical column designating the part or unit.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Sample ID( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

### [Standard](#standard)

**Syntax:** obj = EMP Measurement Systems Analysis(...\<Standard( column )>...)

**Description:** Specifies a standard or reference column that contains the known values for the measured part.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Response ),
    Part( :Part ),
    Standard( :Standard ),
    Model( "Main" ),
    Dispersion Chart Type( "Range" )
);


```

### [X](#x)

**Syntax:** obj = EMP Measurement Systems Analysis(...\<X( column(s) )>...)

**Description:** Specifies categorical column(s) as grouping variables.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    Grouping( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

### [Y](#y)

**Syntax:** obj = EMP Measurement Systems Analysis(...Y( column(s) )...)

**Description:** Specifies the continuous column(s) of measurements.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Measurement( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);


```

## [Item Messages](#item-messages)

### [Conv Limit](#conv-limit)

**Syntax:** obj = EMP Measurement Systems Analysis(...Conv Limit( number )...)

**Description:** Sets the convergence limit that is used for computing variance components. This option affects only REML analyses.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << Select Rows( 5 ) << Exclude( 1 );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Conv Limit( 1e-7 )
);
obj << (EMP MSA Analysis[1] << Variance Components( 1 ));


```

### [EMP MSA Analysis](#emp-msa-analysis)

**Syntax:** obj = EMP Measurement Systems Analysis(...EMP MSA Analysis( )...)

**Description:** Specifies the EMP MSA Analysis report options for each measurement response.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    EMP MSA Analysis(
        "Y",
        EMP Results( 1 ),
        Variance Components( 1 ),
        "EMP Gauge R&R Results"n( 1 )
    )
);


```

### [Edit MSA Metadata](#edit-msa-metadata)

**Syntax:** obj \<< Edit MSA Metadata( :column( Lower Tolerance( number ), Upper Tolerance( number ), \<Historical Mean( number ), Historical Process Sigma( number )> ) )

**Description:** Opens a window that enables you to add or edit the tolerance range, tolerance limits, historical mean, and historical process sigma for all analyses. The reports are automatically updated.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    EMP MSA Analysis( "Y", Dispersion Chart( 0 ), "AIAG Gauge R&R Results"n( 1 ) )
);
Wait( 1 );
obj << Edit MSA Metadata( :Y( Lower Tolerance( 130 ), Upper Tolerance( 230 ) ) );


```

### [Include Interactions in Reproducibility](#include-interactions-in-reproducibility)

**Syntax:** obj = EMP Measurement Systems Analysis(...Include Interactions in Reproducibility( state=0|1 )...)

**Description:** Includes interactions in the calculation of the Reproducibility statistic.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Include Interactions in Reproducibility( 1 )
);
obj << (EMP MSA Analysis[1] << "EMP Gauge R&R Results"n( 1 ));


```

### [Max Iter](#max-iter)

**Syntax:** obj = EMP Measurement Systems Analysis(...Max Iter( number )...)

**Description:** Sets the maximum number of iterations that are used for computing variance components. This option affects only REML analyses.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << Select Rows( 5 ) << Exclude( 1 );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Max Iter( 200 )
);
obj << (EMP MSA Analysis[1] << Variance Components( 1 ));


```

### [Save All Metadata to Table](#save-all-metadata-to-table)

**Syntax:** obj \<< Save All Metadata to Table( < MSA( state=0|1 ) >, < Measurement Sigma( state=0|1 ) >, < Tolerance as Specs( state=0|1 ) > )

**Description:** Creates a new data table that contains the MSA metadata and Measurement Sigma for each column of measurement data. The table is in a tall format and contains a row for each measurement variable. There is an option to save the lower and upper tolerance values as additional columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << Save All Metadata to Table;


```

### [Save Metadata as Column Properties](#save-metadata-as-column-properties)

**Syntax:** obj \<< Save Metadata as Column Properties( < MSA( state=0|1 ) >, < Measurement Sigma( state=0|1 ) >, < Tolerance as Specs( state=0|1 ) > )

**Description:** For each column of measurement data, saves the MSA metadata and Measurement Sigma as column properties within the column of the original data table. There is an option to save the lower and upper tolerance values as Spec Limits column properties.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << Save Metadata as Column Properties;


```

### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj = EMP Measurement Systems Analysis(...Set Alpha Level( number )...)

**Description:** Specifies the alpha level that is used for the bias comparison and test-retest error comparison reports. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Set Alpha Level( .01 )
);
obj << (EMP MSA Analysis[1] << Bias Comparison( 1 ));


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = EMP Measurement Systems Analysis(...Set Random Seed( number )...)

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    Set Random Seed( 12345 )
);
obj << (EMP MSA Analysis[1] << "Test-Retest Error Comparison"n( 1 ));


```

### [Sigma Multiplier](#sigma-multiplier)

**Syntax:** obj = EMP Measurement Systems Analysis(...Sigma Multiplier( number=6 )...)

**Description:** Specifies a constant value that is multiplied by sigma. "6" by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Sigma Multiplier( 5.15 ),
    EMP MSA Analysis( "Y", "AIAG Gauge R&R Results"n( 1 ) )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = EMP Measurement Systems Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [EMP MSA Analysis > EMP AIAG Gauge Results](#emp-msa-analysis-emp-aiag-gauge-results)

### [Item Messages](#item-messages_1)

#### [AIAG Labels](#aiag-labels)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< "AIAG Gauge R&R Results"n(1, AIAG Labels( state=0|1 )))

**Description:** Shows or hides labels in the AIAG Gauge R&R Results table. The labels are defined by the Automotive Industry Action Group (AIAG). On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << "AIAG Gauge R&R Results"n( 1, AIAG Labels( 0 ) ));


```

#### [Discrimination Ratio](#discrimination-ratio)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< "AIAG Gauge R&R Results"n(1, Discrimination Ratio( state=0|1 )))

**Description:** Shows or hides the discrimination ratio for the given model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << "AIAG Gauge R&R Results"n( 1, Discrimination Ratio( 1 ) ));


```

## [EMP MSA Analysis > EMP Average Chart](#emp-msa-analysis-emp-average-chart)

### [Item Messages](#item-messages_2)

#### [Show Connected Means](#show-connected-means)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Average Chart( 1, Show Connected Means( state=0|1 )))

**Description:** Shows or hides lines that connect the average measurement values on the Average Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 1, Show Connected Means( 0 ) ));


```

#### [Show Control Limits](#show-control-limits)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Average Chart( 1, Show Control Limits( state=0|1 )))

**Description:** Shows or hides control limits on the Average Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 1, Show Control Limits( 0 ) ));


```

#### [Show Control Limits Shading](#show-control-limits-shading)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Average Chart( 1, Show Control Limits Shading( state=0|1 )))

**Description:** Shows or hides shading between the control limits on the Average Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 1, Show Control Limits Shading( 0 ) ));


```

#### [Show Data](#show-data)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Average Chart( 1, Show Data( state=0|1 )))

**Description:** Shows or hides the data points on the Average Chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 1, Show Data( 1 ) ));


```

#### [Show Grand Mean](#show-grand-mean)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Average Chart( 1, Show Grand Mean( state=0|1 )))

**Description:** Shows or hides the overall mean of the Y variable on the Average Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 1, Show Grand Mean( 0 ) ));


```

#### [Show Separators](#show-separators)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Average Chart( 1, Show Separators( state=0|1 )))

**Description:** Shows or hides vertical lines that separate the X variables on the Average Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 1, Show Separators( 0 ) ));


```

## [EMP MSA Analysis > EMP Dispersion Chart](#emp-msa-analysis-emp-dispersion-chart)

### [Item Messages](#item-messages_3)

#### [Show Average Dispersion](#show-average-dispersion)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Dispersion Chart( 1, Show Average Dispersion( state=0|1 )))

**Description:** Shows or hides the average range or standard deviation on the dispersion chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Dispersion Chart( 1, Show Average Dispersion( 0 ) ));


```

#### [Show Connected Points](#show-connected-points)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Dispersion Chart( 1, Show Connected Points( state=0|1 )))

**Description:** Shows or hides lines that connect all of the ranges or standard deviations on the dispersion chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Dispersion Chart( 1, Show Connected Points( 0 ) ));


```

#### [Show Control Limits](#show-control-limits_1)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Dispersion Chart( 1, Show Control Limits( state=0|1 )))

**Description:** Shows or hides the control limits on the dispersion chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Dispersion Chart( 1, Show Control Limits( 0 ) ));


```

#### [Show Control Limits Shading](#show-control-limits-shading_1)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Dispersion Chart( 1, Show Control Limits Shading( state=0|1 )))

**Description:** Shows or hides shading between the control limits on the dispersion chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Dispersion Chart( 1, Show Control Limits Shading( 0 ) ));


```

#### [Show Separators](#show-separators_1)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Dispersion Chart( 1, Show Separators( state=0|1 )))

**Description:** Shows or hides vertical lines that separate the X variables on the dispersion chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Dispersion Chart( 1, Show Separators( 0 ) ));


```

## [EMP MSA Analysis > EMP Linearity and Bias Results](#emp-msa-analysis-emp-linearity-and-bias-results)

### [Item Messages](#item-messages_4)

#### [Show Avg Bias Points](#show-avg-bias-points)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Linearity and Bias Results( 1, Show Avg Bias Points( state=0|1 )))

**Description:** Shows or hides the average bias points on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Measurement ),
    X( :Operator ),
    Part( :part# ),
    Standard( :Standard ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    EMP MSA Analysis( :Measurement, Average Chart( 0 ), Dispersion Chart( 0 ) )
);
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Avg Bias Points( 1 ) ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Avg Bias Points( 0 ) ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Avg Bias Points( 1 ) ));


```

#### [Show Bias Points](#show-bias-points)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Linearity and Bias Results( 1, Show Bias Points( state=0|1 )))

**Description:** Shows or hides the bias points on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Measurement ),
    X( :Operator ),
    Part( :part# ),
    Standard( :Standard ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    EMP MSA Analysis( :Measurement, Average Chart( 0 ), Dispersion Chart( 0 ) )
);
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Bias Points( 1 ) ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Bias Points( 0 ) ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Bias Points( 1 ) ));


```

#### [Show Fit Confidence Curves](#show-fit-confidence-curves)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Linearity and Bias Results( 1, Show Fit Confidence Curves( state=0|1 )))

**Description:** Shows or hides the line of fit confidence curves on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Measurement ),
    X( :Operator ),
    Part( :part# ),
    Standard( :Standard ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    EMP MSA Analysis( :Measurement, Average Chart( 0 ), Dispersion Chart( 0 ) )
);
obj << (EMP MSA Analysis[1] << Linearity and Bias Results(
    1,
    Show Fit Confidence Curves( 1 )
));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results(
    1,
    Show Fit Confidence Curves( 0 )
));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results(
    1,
    Show Fit Confidence Curves( 1 )
));


```

#### [Show Line of Fit](#show-line-of-fit)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Linearity and Bias Results( 1, Show Line of Fit( state=0|1 )))

**Description:** Shows or hides the line of fit on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Measurement ),
    X( :Operator ),
    Part( :part# ),
    Standard( :Standard ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    EMP MSA Analysis( :Measurement, Average Chart( 0 ), Dispersion Chart( 0 ) )
);
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Line of Fit( 1 ) ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Line of Fit( 0 ) ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1, Show Line of Fit( 1 ) ));


```

#### [Show Overall Avg Bias Line](#show-overall-avg-bias-line)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Linearity and Bias Results( 1, Show Overall Avg Bias Line( state=0|1 )))

**Description:** Shows or hides the overall average bias line on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Measurement ),
    X( :Operator ),
    Part( :part# ),
    Standard( :Standard ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" ),
    EMP MSA Analysis( :Measurement, Average Chart( 0 ), Dispersion Chart( 0 ) )
);
obj << (EMP MSA Analysis[1] << Linearity and Bias Results(
    1,
    Show Overall Avg Bias Line( 1 )
));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results(
    1,
    Show Overall Avg Bias Line( 0 )
));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Linearity and Bias Results(
    1,
    Show Overall Avg Bias Line( 1 )
));


```

## [EMP MSA Analysis](#emp-msa-analysis_1)

### [Item Messages](#item-messages_5)

#### [AIAG Gauge R&R Results](#aiag-gauge-rr-results)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< "AIAG Gauge R&R Results"n( state=0|1 ))

**Description:** Shows or hides a report that partitions the variability in the measurements into part variation and measurement system variation. The calculation for Reproducibility includes interactions.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    MSA Metadata(
        :Y(
            Lower Tolerance( 120 ),
            Upper Tolerance( 240 ),
            Tolerance Range( 120 ),
            Historical Process Sigma( 25 )
        )
    ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << "AIAG Gauge R&R Results"n( 1 ));


```

#### [Apply Preset](#apply-preset_1)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 0 ));
obj << (EMP MSA Analysis[1] << Effective Resolution( 1 ));
obj << (EMP MSA Analysis[1] << Dispersion Chart( 1, Show Control Limits Shading( 0 ) ));
preset = obj << (EMP MSA Analysis[1] << New Preset);
dt2 = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj2 = dt2 << EMP Measurement Systems Analysis(
    Y( :Measurement ),
    MSA Metadata( :Measurement( Historical Process Sigma( 0.25 ) ) ),
    X( :Operator ),
    Part( :part# ),
    Standard( :Standard ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" )
);
Wait( 1 );
obj2 << (EMP MSA Analysis[1] << Apply Preset( preset ));


```

#### [Average Chart](#average-chart)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Average Chart( state=0|1 ))

**Description:** Shows or hides a plot of the average measurement values for each combination of the part and X variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 0 ));


```

#### [Bias Comparison](#bias-comparison)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Bias Comparison( state=0|1 ))

**Description:** Shows or hides an Analysis of Means chart for testing if the X variables have different averages.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Bias Comparison( 1 ));


```

#### [Dispersion Chart](#dispersion-chart)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Dispersion Chart( state=0|1 ))

**Description:** Shows or hides the specified dispersion chart. The default dispersion chart is the Range Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Dispersion Chart( 0 ));


```

#### [EMP Gauge R&R Results](#emp-gauge-rr-results)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< "EMP Gauge R&R Results"n( state=0|1 ))

**Description:** Shows or hides a report that partitions the variability in the measurements into part variation and measurement system variation. The calculations in this report are based on variances, not ranges.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << "EMP Gauge R&R Results"n( 1 ));


```

#### [EMP Results](#emp-results)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< EMP Results( state=0|1 ))

**Description:** Shows or hides a report that computes several statistics to help you assess and classify your measurement system.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << EMP Results( 1 ));


```

#### [Edit MSA Metadata](#edit-msa-metadata_1)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Linearity and Bias Results( state=0|1 ))

**Description:** Opens a window that enables you to add or edit the tolerance range, tolerance limits, historical mean, and historical process sigma for all analyses. The reports are automatically updated.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    EMP MSA Analysis( "Y", Misclassification Probabilities( 1 ) )
);
Wait( 1 );
obj << (EMP MSA Analysis[1] << Edit MSA Metadata(
    Lower Tolerance( 120 ),
    Upper Tolerance( 240 )
));


```

#### [Effective Resolution](#effective-resolution)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Effective Resolution( state=0|1 ))

**Description:** Shows or hides a table that contains results for the resolution of a measurement system, which helps you determine how well your measurement increments are working.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Effective Resolution( 1 ));


```

#### [Linearity and Bias Results](#linearity-and-bias-results)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Linearity and Bias Results( state=0|1 ))

**Description:** Shows or hides a graph and summary from a regression analysis using the standard column as the X variable and the bias as the Y variable.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Measurement ),
    MSA Metadata( :Measurement( Historical Process Sigma( 0.25 ) ) ),
    X( :Operator ),
    Part( :part# ),
    Standard( :Standard ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Standard Deviation" )
);
obj << (EMP MSA Analysis[1] << Linearity and Bias Results( 1 ));


```

#### [Misclassification Probabilities](#misclassification-probabilities)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Misclassification Probabilties( state=0|1 ))

**Description:** Shows or hides a report that contains the probabilities of misclassification for the given model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    MSA Metadata( :Y( Lower Tolerance( 140 ), Upper Tolerance( 220 ) ) ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Misclassification Probabilities( 1 ));


```

#### [New Preset](#new-preset_1)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Average Chart( 0 ));
obj << (EMP MSA Analysis[1] << Effective Resolution( 1 ));
obj << (EMP MSA Analysis[1] << Dispersion Chart( 1, Show Control Limits Shading( 0 ) ));
preset = obj << (EMP MSA Analysis[1] << New Preset);


```

#### [Parallelism Plots](#parallelism-plots)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Parallelism Plots( state=0|1 ))

**Description:** Shows or hides an overlay plot that reflects the average measurement values for each part.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Parallelism Plots( 1 ));


```

#### [Shift Detection Profiler](#shift-detection-profiler)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Shift Detection Profiler( state=0|1 ))

**Description:** Shows or hides an interactive set of charts that you can adjust to see the probabilities of getting warnings on your process behavior chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Shift Detection Profiler( 1 ));


```

#### [Show Monitor Classification Legend](#show-monitor-classification-legend)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Show Monitor Classification Legend( state=0|1 ))

**Description:** Shows or hides the monitor classification legend in the EMP Results report. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << EMP Results( 1 ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Show Monitor Classification Legend( 0 ));


```

#### [Show Part Legend](#show-part-legend)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Show Part Legend( state=0|1 ))

**Description:** Shows or hides the part legend for the average and dispersion charts. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Show Part Legend( 0 ));


```

#### [Show Shift Detection Profiler Legend](#show-shift-detection-profiler-legend)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Show Shift Detection Profiler Legend( state=0|1 ))

**Description:** Shows or hides the legend in the Shift Detection Profiler. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Shift Detection Profiler( 1 ));
Wait( 1 );
obj << (EMP MSA Analysis[1] << Show Shift Detection Profiler Legend( 0 ));


```

#### [Test-Retest Error Comparison](#test-retest-error-comparison)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< "Test-Retest Error Comparison"n( state=0|1 ))

**Description:** Shows or hides an Analysis of Means for Variances or Analysis of Means Ranges chart for testing if any of the groups have different test-retest error levels.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << "Test-Retest Error Comparison"n( 1 ));


```

#### [Variance Components](#variance-components)

**Syntax:** obj \<< (EMP MSA Analysis[number] \<< Variance Components( state=0|1 ))

**Description:** Shows or hides a report that contains the estimates of the variance components for the given model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Gasket.jmp" );
obj = dt << EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Part ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" )
);
obj << (EMP MSA Analysis[1] << Variance Components( 1 ));


```

# [EWMA Control Chart](#ewma-control-chart)

## [Associated Constructors](#associated-constructors)

### [EWMA Control Chart](#ewma-control-chart_1)

**Syntax:** EWMA Control Chart( Y( column ), \<Subgroup( column )>, \<By( column )>, \<Center Data( 1 )> )

**Description:** Creates a chart that plots the exponentially weighted moving averages and a chart that plots either the individual observations or the subgroup means. An EWMA chart is also known as a feedback control chart.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = EWMA Control Chart(...\<By( column(s) )>...)

**Description:** Specifies the By column during launch.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Subgroup](#subgroup)

**Syntax:** obj = EWMA Control Chart(...\<Subgroup( column )>...)

**Description:** Specifies the Subgroup column during launch.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ), Subgroup( :Sample ) );


```

### [Y](#y)

**Syntax:** obj = EWMA Control Chart(...Y( column(s) )...)

**Description:** Specifies the Y column during launch.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );


```

## [Item Messages](#item-messages)

### [Alarm Script](#alarm-script)

**Syntax:** Alarm Script(Write("...")|Speak("...")|Mail(address, subject,"...") )

**Description:** Sends a message whenever a point on a control chart fails a given test. The message can be sent to the log, can be spoken, or can be emailed.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart(
    Alarm Script(
        Write(
            "Out of Control for test ",
            qc_test,
            " in column ",
            qc_col,
            " in sample ",
            qc_sample,
            ". \!N"
        )
    ),
    Y( :Gap ),
    Subgroup( :Sample )
);
obj << Test Beyond Limits( 1 );


```

### [Center Data](#center-data)

**Syntax:** obj = EWMA Control Chart(...Center Data( state=0|1 )...)

**Description:** Specifies that the data are centered by subtracting the target from each observation.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ), Lambda( 0.2 ), Center Data( 1 ) );


```

### [Connect Thru Missing](#connect-thru-missing)

**Syntax:** obj \<< Connect Thru Missing( state=0|1 )

**Description:** Connects points when some samples have missing values or excluded rows.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
Wait( 1 );
obj << Connect Thru Missing( 1 );


```

### [Constant Limits](#constant-limits)

**Syntax:** obj \<< Constant Limits( state=0|1 )

**Description:** Uses an asymptotic expression to form constant EWMA limits.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
Wait();
obj << Constant Limits( 1 );


```

### [Control Panel](#control-panel)

**Syntax:** obj \<< Control Panel( state=0|1 )

**Description:** Shows or hides a report that contains the current values of the parameters and enables you to change them. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Control Panel( 0 );


```

### [Get Limits](#get-limits)

**Syntax:** obj \<< Get Limits( filename )

**Description:** Imports control limits from a selected data table and replaces calculated limits on the chart.

**JMP Version Added:** 17

```

dtLimits = New Table( "EWMA Limits",
    New Column( "_LimitsKey",
        Character,
        Set Values( {"_KSigma", "_Weight", "_Mean", "_Std Dev"} )
    ),
    New Column( "Gap", Set Values( [4, 0.3, 15, 0.2655555] ) )
);
dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
Wait( 1 );
obj << Get Limits( dtLimits );


```

### [K Sigma](#k-sigma)

**Syntax:** obj \<< K Sigma( K value=3 )

**Description:** Sets the K value to be multiplied by sigma to form the control limits about the average. "3" by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
Wait( 1 );
obj << K Sigma( 4 );


```

### [Lambda](#lambda)

**Syntax:** obj \<< Lambda( number=0.2 )

**Description:** Specifies the smoothing constant for weighting prior samples. "0.2" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Lambda( 0.5 );


```

### [Lambda Slider](#lambda-slider)

**Syntax:** obj \<< Lambda Slider( state=0|1 )

**Description:** Shows or hides the lambda slider on the control panel.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Lambda Slider( 1 );


```

### [Overlay Charts](#overlay-charts)

**Syntax:** obj \<< Overlay Charts( state=0|1 )

**Description:** Overlays individual points, or XBar points if the data are summarized, on the EWMA chart.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Overlay Charts( 1 );


```

### [Parameters Report](#parameters-report)

**Syntax:** obj \<< Parameters Report( state=0|1 )

**Description:** Shows or hides the parameters report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Parameters Report( 1 );


```

### [Reset to Defaults](#reset-to-defaults)

**Syntax:** obj \<< Reset to Defaults

**Description:** Resets all parameters back to the default values.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Lambda( .9 );
Wait( 1 );
obj << Reset to Defaults();


```

### [Restart EWMA after Empty Subgroup](#restart-ewma-after-empty-subgroup)

**Syntax:** obj \<< Restart EWMA after Empty Subgroup( state=0|1 )

**Description:** Restarts calculation of the EWMA statistic after each missing or excluded subgroup.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << Select Rows( {31, 32, 33, 34, 35} ) << exclude << hide;
Wait();
obj = dt << EWMA Control Chart( Y( :Gap ), Subgroup( :Sample ) );
Wait( 1 );
obj << Restart EWMA after empty subgroup( 1 );


```

### [Save Limits](#save-limits)

**Syntax:** obj \<< Save Limits( "in Column"|"in New Table" )

**Description:** Saves chart parameters to either a column property or a new data table.

If in Column is specified, the average value is saved in an EWMA Control Limits column property.

If in New Table is specified, Lambda (or weight), the standard deviation, and the mean for each chart are saved to a new data table.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Limits( "in Column" );
obj << Save Limits( "in New Table" );


```

### [Save Sigma](#save-sigma)

**Syntax:** obj \<< Save Sigma

**Description:** Saves the sigma used in the control chart as a column property in the data table.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Sigma;


```

### [Save Summaries](#save-summaries)

**Syntax:** obj \<< Save Summaries

**Description:** Creates a new table that contains summary statistics and limits for each subgroup.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Summaries;


```

### [Show ARL](#show-arl)

**Syntax:** obj \<< Show ARL( state=0|1 )

**Description:** Shows or hides a report with the Average Run Length computed from the associated EWMA and X charts.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Show ARL( 1 );


```

### [Show Center Line](#show-center-line)

**Syntax:** obj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line on the graph. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Show Center Line( 0 );


```

### [Show Excluded Region](#show-excluded-region)

**Syntax:** obj = EWMA Control Chart(...Show Excluded Region( state=0|1 )...)

**Description:** Shows or hides the excluded region on the subgroup axis. Applies only for subgroup variables.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << Select Rows( {31, 32, 33, 34, 35, 36, 37, 38, 39, 40} ) << exclude << hide;
obj = dt << EWMA Control Chart( Y( :Gap ), Subgroup( :Sample ), Show Excluded Region( 0 ) );


```

### [Show Limits](#show-limits)

**Syntax:** obj \<< Show Limits( state=0|1 )

**Description:** Shows or hides the limits. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Show Limits( 0 );


```

### [Show Residuals Chart](#show-residuals-chart)

**Syntax:** obj \<< Show Residuals Chart( state=0|1 )

**Description:** Shows or hides a chart of residuals.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Show Residuals Chart( 0 );


```

### [Show Shift Lines](#show-shift-lines)

**Syntax:** obj \<< Show Shift Lines( state=0|1 )

**Description:** Shows or hides vertical lines that designate shifts in the chart. Shift lines are drawn at the start of a shift. Available only when there is a shift detected in the data. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
Wait( 1 );
obj << Show Shift Lines( 0 );


```

### [Show X Chart](#show-x-chart)

**Syntax:** obj \<< Show X Chart( state=0|1 )

**Description:** Shows or hides the Location chart below the EWMA chart. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Show X Chart( 0 );


```

### [Show X Limits on Overlay Charts](#show-x-limits-on-overlay-charts)

**Syntax:** obj \<< Show X Limits on Overlay Charts( state=0|1 )

**Description:** Overlays limits from the location chart on the EWMA chart when the Overlay Charts option is selected.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    Show X Limits On Overlay Charts( 1 ),
    Overlay Charts( 1 )
);


```

### [Sigma](#sigma)

**Syntax:** obj \<< Sigma( number )

**Description:** Specifies the known value of the standard deviation. By default, this parameter is set to the average moving range of the Y column. If there is a Subgroup variable, the Sigma parameter is set to the average of the moving ranges of the subgroup means.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Sigma( 2 );


```

### [Target](#target)

**Syntax:** obj \<< Target( number )

**Description:** Specifies the known value of the mean. This is the value of the center line in the chart. By default, this parameter is set to the Target value in the Spec Limits column property for the Y column. If the Y column does not have a Target value in the Spec Limits column property, this parameter is set to the overall average of the Y column.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Target( 14.65 );


```

### [Test Beyond Limits](#test-beyond-limits)

**Syntax:** obj \<< Test Beyond Limits( state=0|1 )

**Description:** Shows or hides a red circle around any point that is above the upper limit or below the lower limit in the EWMA and X charts.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Test Beyond Limits( 1 );


```

### [Use Overall Mean for Target](#use-overall-mean-for-target)

**Syntax:** obj \<< Use Overall Mean for Target( state=0|1 )

**Description:** Sets the Target at the overall mean. Note: Applicable only when the Target is set using a Spec Limits column property for Target.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ), Subgroup( :Date ) );
Wait( 1 );
obj << Use Overall Mean for Target();


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Relaunch Analysis;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << EWMA Control Chart(
    Y( :Gap ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips1.jmp" );
obj = dt << EWMA Control Chart( Y( :Gap ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = EWMA Control Chart(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Excel Profiler](#excel-profiler)

## [Associated Constructors](#associated-constructors)

### [Excel Profiler](#excel-profiler_1)

**Syntax:** Excel Profiler( Workbook( filename ), \<Model( string )> ) )

**Description:** Provides a mechanism for transferring Excel data into JMP to be analyzed using the profilers.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );


```

## [Columns](#columns)

### [Noise Factors](#noise-factors)

**Syntax:** obj = Excel Profiler(...\<Noise Factors( column(s) )>...)

**Description:** Specifies noise factors, which must be columns that are ingredients to the formula columns. Noise factors are used to study robustness (or flatness) with respect to transmitted variation from these factors. The resulting profiler includes derivatives of the formulas with respect to the noise factors.

**Contour Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Custom Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Mixture Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Noise Factors( :p1 ) );


```

**Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

### [Prediction Formula](#prediction-formula)

**Syntax:** obj = Excel Profiler(...Prediction Formula( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );


```

### [Y](#y)

**Syntax:** obj = Excel Profiler(...Y( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );


```

## [Item Messages](#item-messages)

### [Formulas for OPTMODEL](#formulas-for-optmodel)

**Syntax:** obj \<< Formulas for OPTMODEL

**Description:** Saves the prediction formulas from the model in a new file as SAS statements for PROC OPTMODEL.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Formulas for OPTMODEL;


```

### [Model](#model)

**Syntax:** obj \<< Model( string )

**Description:** Identifies which model to run within the workbook. If no model is specified and there is only one model in the workbook, the Excel Profiler will run the model.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ), Model( "Demand" ) );


```

### [Prediction Profiler](#prediction-profiler)

**Syntax:** obj \<< Prediction Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Prediction Profiler( 1 );


```

### [Save Expanded Formulas](#save-expanded-formulas)

**Syntax:** obj \<< Save Expanded Formulas

**Description:** Saves a new formula column to the data table. The new column contains resolved formula references within the formulas used as Y variables to see the underlying variables. This is available only after the Expand Intermediate Formulas option is selected in the launch window or the Expand message is specified in the Profiler script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Profiler( Y( :GP Fit, :NL Fit, :Difference ), Expand, Contour Profiler( 1 ) );
obj << Save Expanded Formulas;


```

### [Show Formulas](#show-formulas)

**Syntax:** obj \<< Show Formulas

**Description:** Opens a script window that contains JSL for all formulas that are being profiled.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Show Formulas;


```

### [Workbook](#workbook)

**Syntax:** obj \<< Workbook( text )

**Description:** Specifies the Excel spreadsheet that contains the model to use for the profiler.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

obj = Excel Profiler(
    Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

obj = Excel Profiler(
    Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

obj = Excel Profiler( Workbook( "$SAMPLE_IMPORT_DATA/Demand.xlsx" ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Explore Missing Values](#explore-missing-values)

## [Associated Constructors](#associated-constructors)

### [Explore Missing Values](#explore-missing-values_1)

**Syntax:** Explore Missing Values( Y( columns ) )

**Description:** Find patterns of missing values and conduct imputation.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );


```

## [Item Messages](#item-messages)

### [ADI Loading Matrix](#adi-loading-matrix)

**Syntax:** obj \<< ADI Loading Matrix( state=0|1 )

**Description:** Shows or hides a report that shows the columns that correspond to the factor loading for each component.

**JMP Version Added:** 14

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Set Random Seed( 123 ),
    Automated Data Imputation
);
obj << ADI Loading Matrix( 1 );


```

### [Automated Data Imputation](#automated-data-imputation)

**Syntax:** obj \<< Automated Data Imputation

**Description:** Imputes missing values using a low-rank matrix approximation method. This method automatically selects the best dimension for the low-rank approximation based on the data.

**JMP Version Added:** 15

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Automated Data Imputation;


```

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Closes the Missing Columns report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :POP, :OZONE, :CO, :SO2, :NO, :PM10 ),
    Missing Value Report
);
Wait( 2 );
obj << Close;


```

### [Color Cells](#color-cells)

**Syntax:** obj \<< Color Cells( ALL or column1, column2, ... )

**Description:** Colors the cells in the data table that contain missing values for the column(s) that you select in the Missing Columns report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Color cells( :OZONE );


```

### [Color Rows](#color-rows)

**Syntax:** obj \<< Color Rows( ALL or column1, column2, ... )

**Description:** Colors the rows in the data table that contain missing values for the column(s) that you select in the Missing Columns report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Color rows( :OZONE );


```

### [Exclude Rows](#exclude-rows)

**Syntax:** obj \<< Exclude Rows( ALL or column1, column2, ... )

**Description:** Applies the excluded row state for rows in the data table that contain missing values for the column(s) that you select in the Missing Columns report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Exclude rows( :OZONE );


```

### [Get U V Sigma ADI Matrices](#get-u-v-sigma-adi-matrices)

**Syntax:** obj \<< Get U V Sigma ADI Matrices

**Description:** Returns the U, V, and Sigma matrices from the low-rank approximation in the ADI method.

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Set Random Seed( 123 ),
    Automated Data Imputation
);
obj << Get U V Sigma ADI Matrices;


```

### [Maximum Dimension](#maximum-dimension)

**Syntax:** obj \<< Maximum Dimension( number )

**Description:** Sets the maximum dimension for Automated Data Imputation.

**JMP Version Added:** 14

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Maximum Dimension( 3 ),
    Automated Data Imputation
);


```

### [Maximum Iteration](#maximum-iteration)

**Syntax:** obj \<< Maximum Iteration( number=10 )

**Description:** Sets the maximum number of iterations for Automated Data Imputation. "10" by default.

**JMP Version Added:** 14

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Maximum Iteration( 8 ),
    Automated Data Imputation
);


```

### [Missing Value Clustering](#missing-value-clustering)

**Syntax:** obj \<< Missing Value Clustering

**Description:** Provides a hierarchical clustering analysis of the missing data.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Missing Value Clustering;


```

### [Missing Value Report](#missing-value-report)

**Syntax:** obj \<< Missing Value Report

**Description:** Opens the Missing Columns report, which lists the name of each column and the number of missing values in that column.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Missing Value Report;


```

### [Missing Value Snapshot](#missing-value-snapshot)

**Syntax:** obj \<< Missing Value Snapshot

**Description:** Shows a cell plot for the missing values. A black cell indicates a missing value.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Missing Value Snapshot;


```

### [Multivariate Normal Imputation](#multivariate-normal-imputation)

**Syntax:** obj \<< Multivariate Normal Imputation( Shrink Covariances( state=0|1 ) )

**Description:** Imputes missing values based on the multivariate normal distribution. To improve the estimation of the covariance matrix, use the shrinkage estimator option.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Multivariate Normal Imputation( Shrink Covariances( 1 ) );


```

### [Multivariate RPCA Imputation](#multivariate-rpca-imputation)

**Syntax:** obj \<< Multivariate RPCA Imputation( Lambda( number ), Tolerance( number = 1e-7 ), MaxIt( number ) )

**Description:** Imputes missing values using robust principal components, which replaces missing values using a low-rank matrix factorization (SVD) that is robust to outliers. This method is useful for wide problems. The default value for lambda is 2/sqrt(max(n, p)), where n is the number of rows and p is the number of columns. If min(n, p) < 100, the default value for the maximum number of iterations (MaxIt) is 75. If 100\<= min(n, p) < 1000, the default value for MaxIt is 100. If min(n,p) >= 1000, the default value for MaxIt is 200. If the algorithm does not converge after the specified maximum number of iterations, the solution at MaxIt is accepted and shown in the report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Multivariate RPCA Imputation;


```

### [Multivariate SVD Imputation](#multivariate-svd-imputation)

**Syntax:** obj \<< Multivariate SVD Imputation( Number of Singular Vectors( number ), Maximum Iterations( number ), Show Iteration Log( state=0|1 ) )

**Description:** Imputes missing values quickly for large problems using an iterated low-rank SVD matrix completion method.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Multivariate SVD Imputation(
    Number of Singular Vectors( 3 ),
    Maximum Iterations( 10 ),
    Show Iteration Log( 1 ),

);


```

### [Options for Saving Imputed Values](#options-for-saving-imputed-values)

**Syntax:** obj \<< Options for Saving Imputed Values(1|2|3)

**Description:** Specifies the method by which to save the imputed values for the ADI method. Input 1 to specify the Create New Data Table option, 2 to specify the Save Scoring Formula to Current Data Table option, and 3 to specify the Impute Values in Place option.

**JMP Version Added:** 14

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Options for Saving Imputed Values( 1 ),
    Set Random Seed( 123 ),
    Automated Data Imputation
);


```

### [Select Rows](#select-rows)

**Syntax:** obj \<< Select Rows( ALL or column1, column2, ... )

**Description:** Selects the rows in the data table that contain missing values for the column(s) that you select in the Missing Columns report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Select rows( :OZONE );


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number=0 )

**Description:** Sets the random seed for Automated Data Imputation. "0" by default.

**JMP Version Added:** 14

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Set Random Seed( 1234 ),
    Automated Data Imputation
);


```

### [Show only columns with missing](#show-only-columns-with-missing)

**Syntax:** obj \<< Show only columns with missing( state=0|1 )

**Description:** Removes columns from the list that do not have missing values.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :POP, :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Show Only Columns With Missing( 1 );


```

### [Undo Imputation](#undo-imputation)

**Syntax:** obj \<< Undo Imputation

**Description:** Replaces the most recent imputed data with missing values.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Multivariate Normal Imputation
);
Wait( 2 );
obj << Undo Imputation;


```

### [Validation Proportion](#validation-proportion)

**Syntax:** obj \<< Validation Proportion( number=0.3 )

**Description:** Sets the proportion of rows to use as validation rows for Automated Data Imputation. "0.3" by default.

**JMP Version Added:** 14

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Validation Proportion( 0.25 ),
    Automated Data Imputation
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$Sample_Data/Cities.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Missing Values(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$Sample_Data/Cities.jmp" );
obj = dt << Explore Missing Values( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Explore Missing Values(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Explore Outliers](#explore-outliers)

## [Associated Constructors](#associated-constructors)

### [Explore Outliers](#explore-outliers_1)

**Syntax:** Explore Outliers( Y( columns ) )

**Description:** Identifies, explores, and manages outliers in univariate or multivariate data.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Label](#label)

**Syntax:** obj \<< Label( column )

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );


```

## [Item Messages](#item-messages)

### [K Nearest Neighbor Outliers](#k-nearest-neighbor-outliers)

**Syntax:** obj \<< K Nearest Neighbor Outliers

**Description:** For each point, finds the distance to its kth nearest neighbor.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << k Nearest Neighbor Outliers( K( 5 ) );


```

### [Multivariate k Nearest Neighbor Outliers](#multivariate-k-nearest-neighbor-outliers)

**Syntax:** obj \<< Multivariate k Nearest Neighbor Outliers

**JMP Version Added:** 14

### [Quantile Range Outliers](#quantile-range-outliers)

**Syntax:** obj \<< Quantile Range Outliers

**Description:** Finds values more than a scale multiple of an interquantile range beyond the quantiles.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers;


```

### [Robust Fit Outliers](#robust-fit-outliers)

**Syntax:** obj \<< Robust Fit Outliers

**Description:** Finds values more than a multiple of the scale away from the center using robust estimates of the center and scale.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;


```

### [Robust PCA Outliers](#robust-pca-outliers)

**Syntax:** obj \<< Robust PCA Outliers

**Description:** Robustly decomposes data into a low-rank matrix and a sparse matrix of residuals. Outliers are detected in the residuals. It can also impute missing values.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( 2 :: 10 ) );
obj << Robust PCA Outliers;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Explore Outliers(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [K Nearest Neighbor Outliers](#k-nearest-neighbor-outliers_1)

### [Item Messages](#item-messages_1)

#### [Close](#close)

**Syntax:** obj \<< Close

**JMP Version Added:** 16

#### [Exclude Selected Rows](#exclude-selected-rows)

**Syntax:** obj \<< Exclude Selected Rows

**JMP Version Added:** 16

#### [Impute Missing](#impute-missing)

**Syntax:** obj \<< Impute Missing( state=0 )

**Description:** If there are missing values, Robust PCA is used to impute them before analyzing with K Nearest Neighbors. On by default.

**JMP Version Added:** 16

#### [K](#k)

**Syntax:** obj \<< K( number=8 )

**Description:** The number of near-neighbor rows to find for each row in the table. "8" by default.

**JMP Version Added:** 16

#### [Save NN Distances](#save-nn-distances)

**Syntax:** obj \<< Save NN Distances

**Description:** Saves new columns to the data table containing distances to the kth nearest neighbor.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( 2 :: 10 ) );
obj << k Nearest Neighbor Outliers( K( 4 ) );
obj << Save NN Distances;


```

#### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** obj \<< Scatterplot Matrix

**Description:** Opens a window containing a scatterplot matrix for all columns.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( 2 :: 10 ) );
obj << k Nearest Neighbor Outliers( K( 4 ) );
obj << Scatterplot Matrix;


```

## [Multivariate Robust Outliers](#multivariate-robust-outliers)

### [Item Messages](#item-messages_2)

#### [Close](#close_1)

**Syntax:** obj \<< Close

**JMP Version Added:** 16

#### [Exclude Selected Rows](#exclude-selected-rows_1)

**Syntax:** obj \<< Exclude Selected Rows

**JMP Version Added:** 16

## [Quantile Range Outliers](#quantile-range-outliers_1)

### [Item Messages](#item-messages_3)

#### [Add Highest Nines to Missing Value Codes](#add-highest-nines-to-missing-value-codes)

**Syntax:** obj \<< Add Highest Nines to Missing Value Codes( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments and finds the highest nines in each column. Creates a Missing Value Codes property for these values in each selected column.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Responses" ) ),
    Quantile Range Outliers( Show only columns with outliers( 1 ) )
);
obj << Add Highest Nines to Missing Value Codes( :PS_RPNBR );
dt:PS_RPNBR << Get Column Properties;
//See Log for Missing Value Codes column property


```

#### [Add to Missing Value Codes](#add-to-missing-value-codes)

**Syntax:** obj \<< Add to Missing Value Codes( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments and adds a Missing Value Code property in those columns for outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers;
obj << Add to Missing Value Codes( :"Q-E"n, :"ZN-E"n );


```

#### [Change Highest Nines to Missing](#change-highest-nines-to-missing)

**Syntax:** obj \<< Change Highest Nines to Missing( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments and finds the highest nines in these columns. Changes the highest nines to missing. Note that this changes the data table.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Responses" ) ),
    Quantile Range Outliers( Show only columns with outliers( 1 ) )
);
obj << Change Highest Nines to Missing( :PS_RPNBR );


```

#### [Change to Missing](#change-to-missing)

**Syntax:** obj \<< Change to Missing( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, changes the values identified as outliers to missing values.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Tail Quantile( 0.3 ) );
Wait( 2 );
obj << Change to Missing( :"Q-E"n, :"ZN-E"n );


```

#### [Close](#close_2)

**Syntax:** obj \<< Close

**Description:** Removes a section of the analysis and reopens the command outline.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers;
obj << Robust Fit Outliers;
Wait( 2 );
obj << Close;


```

#### [Color Cells](#color-cells)

**Syntax:** obj \<< Color Cells( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, colors the cells that correspond to outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Tail Quantile( 0.3 ) );
obj << Color Cells( :"Q-E"n, :"ZN-E"n );


```

#### [Color Rows](#color-rows)

**Syntax:** obj \<< Color Rows( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, assigns the Color row state to the rows that correspond to outliers.

**JMP Version Added:** 16

#### [Exclude Rows](#exclude-rows)

**Syntax:** obj \<< Exclude Rows( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, excludes the rows containing values identified as outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Tail Quantile( 0.3 ) );
obj << Exclude Rows( :"Q-E"n, :"ZN-E"n );


```

#### [Formula Columns](#formula-columns)

**Syntax:** obj \<< Formula Columns( ALL or column1, column2, ... )

**Description:** Creates new formula columns from the selected columns by changing the outliers to missing.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Tail Quantile( 0.3 ) );
Wait( 2 );
obj << Formula Columns( Suffix( "Culled" ) );


```

#### [Formula Script](#formula-script)

**Syntax:** obj \<< Formula Script( ALL or column1, column2, ... )

**Description:** Creates a script to make new formula columns from the selected columns by changing the outliers to missing.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Tail Quantile( 0.3 ) );
Wait( 2 );
obj << Formula Script( Suffix( "Culled" ) );


```

#### [Get Quantile Outliers](#get-quantile-outliers)

**Syntax:** obj \<< Get Quantile Outliers

**Description:** Returns a list containing a list of the columns that contain outliers and a list of vectors that contain outlier values in those columns.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers;
obj << Get Quantile Outliers;


```

#### [Q](#q)

**Syntax:** obj \<< Q( number=3 )

**Description:** Sets the scale multiple, Q, for the interquantile distance. Values that fall more than Q times the interquantile distance beyond the tail quantiles are considered outliers. Use Rescan to apply the setting. "3" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Q( 4 ) );


```

#### [Rescan](#rescan)

**Syntax:** obj \<< Rescan

**Description:** Use after changing settings to recompute the criteria and rescan the data to obtain outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers;
obj << Tail Quantile( 0.2 );
obj << Rescan;


```

#### [Restrict search to integers](#restrict-search-to-integers)

**Syntax:** obj \<< Restrict search to integers( state=0|1 )

**Description:** Restricts outlier values to only integer values. This setting limits the search for outliers in order to find industry-specific missing value codes and error codes. Available for the Quantile Range Outliers and Robust Fit Outliers methods. Off by default.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    Quantile Range Outliers( Restrict search to integers( 1 ) )
);


```

#### [Save Quantile Outlier Limits](#save-quantile-outlier-limits)

**Syntax:** obj \<< Save Quantile Outlier Limits

**Description:** Opens a new data table containing the Quantile Range Outliers report information and a column of outlier values.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers;
obj << Save Quantile Outlier Limits;


```

#### [Select Rows](#select-rows)

**Syntax:** obj \<< Select Rows( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments and selects the rows that have outlying values in any of those columns.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Tail Quantile( 0.3 ) );
obj << Select Rows( :"Q-E"n, :"ZN-E"n );


```

#### [Show only columns with outliers](#show-only-columns-with-outliers)

**Syntax:** obj \<< Show only columns with outliers( state=0|1 )

**Description:** Limits the list of columns in the report to those that contain outliers. Available for the Quantile Range Outliers and Robust Fit Outliers methods. Off by default.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    Quantile Range Outliers( Show only columns with outliers( 1 ) )
);


```

#### [Tail Quantile](#tail-quantile)

**Syntax:** obj \<< Tail Quantile( number=.10 )

**Description:** Sets the quantile value for each tail. The quantiles are used in computing the interquantile distance. Use Rescan to apply the setting. ".10" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Quantile Range Outliers( Tail Quantile( 0.2 ) );


```

## [Robust Fit Outliers](#robust-fit-outliers_1)

### [Item Messages](#item-messages_4)

#### [Add to Missing Value Codes](#add-to-missing-value-codes_1)

**Syntax:** obj \<< Add to Missing Value Codes( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments and adds a Missing Value Code property in those columns for outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
obj << Add to Missing Value Codes( :"Q-E"n, :"ZN-E"n );


```

#### [Cauchy](#cauchy)

**Syntax:** obj \<< Cauchy( state=0|1 )

**Description:** Uses a Cauchy distribution to estimate the robust center and scale of the values. The robust center and scale are used to determine outliers.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;
obj << Cauchy( 1 );
obj << Rescan;


```

#### [Change to Missing](#change-to-missing_1)

**Syntax:** obj \<< Change to Missing( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, changes the values identified as outliers to missing values.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
Wait( 2 );
obj << Change to Missing( :"Q-E"n, :"ZN-E"n );


```

#### [Close](#close_3)

**Syntax:** obj \<< Close

**Description:** Removes a section of the analysis and reopens the command outline.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;
Wait( 2 );
obj << Close;


```

#### [Color Cells](#color-cells_1)

**Syntax:** obj \<< Color Cells( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, colors the cells that correspond to outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
obj << Color Cells( :"Q-E"n, :"ZN-E"n );


```

#### [Color Rows](#color-rows_1)

**Syntax:** obj \<< Color Rows( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, assigns the Color row state to the rows that correspond to outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
dt << Clear Row States;
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
obj << Color Rows( :"Q-E"n, :"ZN-E"n );


```

#### [Exclude Rows](#exclude-rows_1)

**Syntax:** obj \<< Exclude Rows( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments. In selected columns, excludes the rows containing values identified as outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
obj << Exclude Rows( :"Q-E"n, :"ZN-E"n );


```

#### [Formula Columns](#formula-columns_1)

**Syntax:** obj \<< Formula Columns( ALL or column1, column2, ... )

**Description:** Creates new formula columns from the selected columns by changing the outliers to missing.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
Wait( 2 );
obj << Formula Columns( Suffix( "Culled" ) );


```

#### [Formula Script](#formula-script_1)

**Syntax:** obj \<< Formula Script( ALL or column1, column2, ... )

**Description:** Creates a script to make new formula columns from the selected columns by changing the outliers to missing.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
Wait( 2 );
obj << Formula Script( Suffix( "Culled" ) );


```

#### [Huber](#huber)

**Syntax:** obj \<< Huber( state=0|1 )

**Description:** Uses Huber estimation to estimate the robust center and scale of the values. The robust center and scale are used to determine outliers.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;
obj << Huber( 1 );
obj << Rescan;


```

#### [K Sigma](#k-sigma)

**Syntax:** obj \<< K Sigma( number=4 )

**Description:** Sets the K Sigma value where outliers are defined to be K times the robust scale values away from the robust center. "4" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;
obj << K Sigma( 3 );
obj << Rescan;


```

#### [Quartile](#quartile)

**Syntax:** obj \<< Quartile( state=0|1 )

**Description:** Uses the median to estimate the robust center and the interquartile range divided by 1.349 to estimate the robust scale. The robust center and scale are used to determine outliers.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;
obj << Quartile( 1 );
obj << Rescan;


```

#### [Rescan](#rescan_1)

**Syntax:** obj \<< Rescan

**Description:** Use after changing settings to recompute the criteria and rescan the data to obtain outliers.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;
obj << K Sigma( 2.5 );
obj << Rescan;


```

#### [Save Robust Outlier Limits](#save-robust-outlier-limits)

**Syntax:** obj \<< Save Robust Outlier Limits

**Description:** Opens a new data table that contains information from the Robust Estimates and Outliers report.

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers;
obj << Save Robust Outlier Limits;


```

#### [Select Rows](#select-rows_1)

**Syntax:** obj \<< Select Rows( ALL or column1, column2, ... )

**Description:** Selects the columns listed as arguments and selects the rows that have outlying values in any of those columns.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers( Y( Column Group( "Sensor Measurements" ) ) );
obj << Robust Fit Outliers( K Sigma( 2 ) );
obj << Select Rows( :"Q-E"n, :"ZN-E"n );


```

## [Robust PCA Outliers](#robust-pca-outliers_1)

### [Item Messages](#item-messages_5)

#### [Center](#center)

**Syntax:** obj \<< Center( state=1 )

**Description:** Specifies whether to center the data by the median before the analysis. On by default.

**JMP Version Added:** 16

#### [Close](#close_4)

**Syntax:** obj \<< Close

**Description:** Removes the RPCA analysis from the platform report.

**JMP Version Added:** 16

#### [Lambda](#lambda)

**Syntax:** obj \<< Lambda( number )

**Description:** Robust PCA tuning with lower values making it more sensitive to declaring outliers. Default Lambda=2/sqrt(max(nRow,nCol))

**JMP Version Added:** 16

#### [MaxIt](#maxit)

**Syntax:** obj \<< MaxIt( number )

**Description:** The maximum number of SVD iterations allowed before failing to converge.

**JMP Version Added:** 16

#### [Outlier Threshold](#outlier-threshold)

**Syntax:** obj \<< Outlier Threshold( number=2 )

**Description:** Specifies that any scaled residual larger in absolute value than this threshold is shown as it is shown in the outlier report. "2" by default.

**JMP Version Added:** 16

#### [Randomized SVD Dim](#randomized-svd-dim)

**Syntax:** obj \<< Randomized SVD Dim( state=0|1 )

**Description:** Specifies the number of dimensions in the randomized SVD to which to reduce the wide problem.

**JMP Version Added:** 17

#### [Save Cleaned](#save-cleaned)

**Syntax:** obj \<< Save Cleaned( Trim(<threshold>),Impute(<threshold>),Make Missing(<threshold>),Color Impute(0|1)--if none specified it will prompt with dialog )

**Description:** Creates a new set of columns that contain missing values imputed and outliers modified. Trim(arg) finds scaled residuals greater than arg and changes the scaled residuals in the corresponding cells to the signed arg. Impute(arg) finds scaled residuals greater than arg and changes the scaled residuals in the corresponding cells to the low-rank approximation. Make Missing(value) finds any scaled residual greater than arg and changes scaled residuals in the corresponding cells to missing.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    Robust PCA Outliers
);
obj << Save Cleaned( Trim( 25 ), Impute( 50 ), Make Missing( 100 ) );


```

#### [Save Large Outliers](#save-large-outliers)

**Syntax:** obj \<< Save Large Outliers

**Description:** Creates a new data table that contains the outliers in the report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    Robust PCA Outliers
);
obj << Save Large Outliers;


```

#### [Save Low Rank Approx](#save-low-rank-approx)

**Syntax:** obj \<< Save Low Rank Approx

**Description:** Creates a new set of columns that contain the low-rank approximation, which is obtained from the singular value decomposition.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    Robust PCA Outliers
);
obj << Save Low Rank Approx;


```

#### [Save Residuals](#save-residuals)

**Syntax:** obj \<< Save Residuals

**Description:** Creates a new set of columns that contain the residuals, which are the observations minus the low-rank approximation.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    Robust PCA Outliers
);
obj << Save Residuals;


```

#### [Save Scaled Residuals](#save-scaled-residuals)

**Syntax:** obj \<< Save Scaled Residuals

**Description:** Creates a new set of columns that contain the scaled residuals, which are the scaled observations minus the low-rank approximation.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Water Treatment.jmp" );
obj = dt << Explore Outliers(
    Y( Column Group( "Sensor Measurements" ) ),
    Robust PCA Outliers
);
obj << Save Scaled Residuals;


```

#### [Scale](#scale)

**Syntax:** obj \<< Scale( state=1 )

**Description:** Specifies whether to scale the data by an interquantile range analog to the standard deviation before the analysis. On by default.

**JMP Version Added:** 16

#### [Tolerance](#tolerance)

**Syntax:** obj \<< Tolerance( number )

**Description:** Specifies the convergence criterion, which determines when to stop the algorithm. The default convergence criterion values are set based on the number of columns specified in the launch.

**JMP Version Added:** 16

#### [Use Randomized SVD](#use-randomized-svd)

**Syntax:** obj \<< Use Randomized SVD( state=0|1 )

**Description:** Reduces the dimensionality using the randomized SVD. This approach can speed up computations for very wide problems.

**JMP Version Added:** 17

# [Explore Patterns](#explore-patterns)

## [Associated Constructors](#associated-constructors)

### [Explore Patterns](#explore-patterns_1)

**Syntax:** Explore Patterns( Y( columns ) )

**Description:** Searches for unusual features in the data, including long runs, duplicate long sequences, unusual formatted values, and runs of linear relationships.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ), By( :SITEID ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );


```

## [Item Messages](#item-messages)

### [Clear Cell Colors](#clear-cell-colors)

**Syntax:** obj \<< Clear Cell Colors

**Description:** Clears the cell colors for selected columns or for all columns if no columns are selected. In JSL, you can specify a list of column names.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Rows for Linear Relationship( 3 ),
    Linear Relationships( 1 )
);
obj << Colorize Linear Relationships;
Wait( 2 );
obj << Clear Cell Colors;


```

### [Colorize Duplicates Across Columns](#colorize-duplicates-across-columns)

**Syntax:** obj \<< Colorize Duplicates Across Columns

**Description:** Colors cells in the data table to correspond to the duplicate matches found in the Duplicates Across Columns report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Duplicates Across Columns( 1 )
);
obj << Colorize Duplicates Across Columns;


```

### [Colorize Linear Relationships](#colorize-linear-relationships)

**Syntax:** obj \<< Colorize Linear Relationships

**Description:** Colors cells in the data table to correspond to the linear relationships found in the Linear relationships between variables table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Rows for Linear Relationship( 3 ),
    Linear Relationships( 1 )
);
obj << Colorize Linear Relationships;


```

### [Distribution wrt Spec Limits](#distribution-wrt-spec-limits)

**Syntax:** obj \<< Distribution wrt Spec Limits( state=0|1 )

**Description:** Shows or hides a table of observed versus expected observations that are outside of the specification limits.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Processes" ) ),
    Distribution wrt Spec Limits( 1 )
);


```

### [Duplicates Across Columns](#duplicates-across-columns)

**Syntax:** obj \<< Duplicates Across Columns( state=0|1 )

**Description:** Shows or hides a report that contains a table of sequences of values that appear in the same rows across more than one column.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Duplicates Across Columns( 1 )
);


```

### [Formatted Widths](#formatted-widths)

**Syntax:** obj \<< Formatted Widths( state=0|1 )

**Description:** Shows or hides overall widths and decimal widths of the formatted values.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Formatted Widths( 1 )
);


```

### [Fraction Length](#fraction-length)

**Syntax:** obj \<< Fraction Length( state=0|1 )

**Description:** Shows or hides how long continued fractions are for the values. Random numbers show as 15, which is the limit. Irrational numbers tend to have higher fraction lengths, depending on how close to a fraction they are.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Fraction Length( 1 )
);


```

### [Include Missing](#include-missing)

**Syntax:** obj = Explore Patterns(...Include Missing( state=0|1 )...)

**Description:** Specifies that missing values be included in pattern detection.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Include Missing( 1 )
);


```

### [Leading and Trailing Digits](#leading-and-trailing-digits)

**Syntax:** obj \<< Leading and Trailing Digits( state=0|1 )

**Description:** Shows or hides a table of counts for each leading and trailing digit, 1 through 9.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Leading and Trailing Digits( 1 )
);


```

### [Linear Relationships](#linear-relationships)

**Syntax:** obj \<< Linear Relationships( state=0|1 )

**Description:** Shows or hides a report of columns that are linearly related to other columns over a specified number of sequential rows.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Rows for Linear Relationship( 3 ),
    Linear Relationships( 1 )
);


```

### [Longest Duplicated Sequences](#longest-duplicated-sequences)

**Syntax:** obj \<< Longest Duplicated Sequences( state=0|1 )

**Description:** Shows or hides a table of the longest sequence of values that appears more than once in the same column. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Longest Duplicated Sequences( 0 )
);
Wait( 2 );
obj << Longest Duplicated Sequences( 1 );


```

### [Longest Runs](#longest-runs)

**Syntax:** obj \<< Longest Runs( state=0|1 )

**Description:** Shows or hides longest runs of the same value. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ), Longest Runs( 0 ) );
Wait( 2 );
obj << Longest Runs( 1 );


```

### [Minimum Cross Column Duplicate Run Size](#minimum-cross-column-duplicate-run-size)

**Syntax:** obj = Explore Patterns(...Minimum Cross Column Duplicate Run Size( number=2 )...)

**Description:** Specifies the minimum length of a sequence for it to be reported as a duplicate sequence across columns. "2" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Cross Column Duplicate Run Size( 3 ),
    Duplicates Across Columns( 1 )
);


```

### [Minimum Longest Duplicate Size](#minimum-longest-duplicate-size)

**Syntax:** obj = Explore Patterns(...Minimum Longest Duplicate Size( number=2 )...)

**Description:** Specifies the minimum length of a sequence for it to be reported as a duplicate sequence within a column. "2" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Longest Duplicate Size( 5 ),

);


```

### [Minimum Rows for Linear Relationship](#minimum-rows-for-linear-relationship)

**Syntax:** obj = Explore Patterns(...Minimum Rows for Linear Relationship( number=10 )...)

**Description:** Specifies the minimum number of rows used for detecting linear relationships between columns across groups of rows. "10" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Rows for Linear Relationship( 3 ),
    Linear Relationships( 1 )
);


```

### [Minimum Run Size](#minimum-run-size)

**Syntax:** obj = Explore Patterns(...Minimum Run Size( number=2 )...)

**Description:** Specifies the minimum number of values in a row for a sequence to be reported as a run. "2" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Run Size( 3 )
);


```

### [Most Duplicated Values](#most-duplicated-values)

**Syntax:** obj \<< Most Duplicated Values( state=0|1 )

**Description:** Shows or hides the most duplicated values. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Most Duplicated Values( 0 )
);
Wait( 2 );
obj << Most Duplicated Values( 1 );


```

### [Order by Column Name](#order-by-column-name)

**Syntax:** obj \<< Order by Column Name

**Description:** Orders the column list in alphabetical order by column name.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
Wait( 2 );
obj << Order by Column Name;


```

### [Order by Runs Rarity](#order-by-runs-rarity)

**Syntax:** obj \<< Order by Runs Rarity

**Description:** Orders the column list by the rarity values of the longest runs. Higher rarity values appear at the top.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
Wait( 2 );
obj << Order by Runs Rarity;


```

### [Order by Sequence Rarity](#order-by-sequence-rarity)

**Syntax:** obj \<< Order by Sequence Rarity

**Description:** Orders the column list by the rarity values of the longest duplicate sequences. Higher rarity values appear at the top.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
Wait( 2 );
obj << Order by Sequence Rarity;


```

### [Original Order](#original-order)

**Syntax:** obj \<< Original Order

**Description:** Orders the column list in the original order in which the columns were specified in the launch window.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Order by Sequence Rarity
);
Wait( 2 );
obj << Original Order;


```

### [Save Duplicates Across Columns](#save-duplicates-across-columns)

**Syntax:** obj \<< Save Duplicates Across Columns

**Description:** Saves the Duplicates Across Columns table to a new data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Duplicates Across Columns( 1 )
);
obj << Save Duplicates Across Columns;


```

### [Save Linear Relationships](#save-linear-relationships)

**Syntax:** obj \<< Save Linear Relationships

**Description:** Saves the linear relationships between values table to a new data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    Minimum Rows for Linear Relationship( 3 ),
    Linear Relationships( 1 )
);
obj << Save Linear Relationships;


```

### [Save Table of Duplicate Sequences](#save-table-of-duplicate-sequences)

**Syntax:** obj \<< Save Table of Duplicate Sequences

**Description:** Saves the longest duplicate sequences for all columns to a new data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Save Table of Duplicate Sequences;


```

### [Save Table of Runs](#save-table-of-runs)

**Syntax:** obj \<< Save Table of Runs

**Description:** Saves the longest runs for all columns to a new data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Save Table of Runs;


```

### [Select Columns](#select-columns)

**Syntax:** obj \<< Select Columns( {list of columns} or ALL )

**Description:** Specifies the columns that are shown in the Univariate Patterns report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Select Columns( {:BUN, :Creatinine, :Glucose} );


```

### [Spec Limit Matches](#spec-limit-matches)

**Syntax:** obj \<< Spec Limit Matches( state=0|1 )

**Description:** Shows or hides values that are exactly equal to the lower specification limit, upper specification limit, or target.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Processes" ) ), Spec Limit Matches( 1 ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Explore Patterns(
    Y( Column Group( "Laboratory Results" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Nicardipine Lab Patterns.jmp" );
obj = dt << Explore Patterns( Y( Column Group( "Laboratory Results" ) ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Explore Patterns(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Factor Analysis](#factor-analysis)

## [Associated Constructors](#associated-constructors)

### [Factor Analysis](#factor-analysis_1)

**Syntax:** Factor Analysis( Y( columns ) )

**Description:** Uncovers the underlying structure of data by extracting unobserved variables, or factors, that represent the common variability across observed variables. Factor rotation is used to increase their interpretability.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);


```

## [Columns](#columns)

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    Freq( :_freqcol )
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    Weight( :_weightcol )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);


```

## [Item Messages](#item-messages)

### [Bartlett's Test of Sphericity](#bartletts-test-of-sphericity)

**Syntax:** obj \<< Bartlett's Test of Sphericity( state=0|1 )

**Description:** Shows or hides a report of the homogeneity test that determines whether the eigenvalues have equal variances.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Estimation( "REML" ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Bartlett's Test of Sphericity( 1 );


```

### [Eigenvalues](#eigenvalues)

**Syntax:** obj \<< Eigenvalues( state=0|1 )

**Description:** Shows or hides a table of the eigenvalues of the original correlation, covariance, or unscaled matrix. The table includes the percent of the total variance represented by each eigenvalue, a bar chart illustrating the percent contribution, and the cumulative percent contributed by each successive eigenvalue. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Estimation( "REML" ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
Wait( 1 );
obj << Eigenvalues( 0 );


```

### [Fit](#fit)

**Syntax:** obj \<< Fit( "PC"|"ML", "ONE"|"SMC", number, rotation method )

**Description:** Fits a factor analysis model using the specified factoring method, prior communality, number of factors, and rotation method. The available factoring methods are Principal Axis (PC) and Maximum Likelihood (ML). You can set all of the prior communalities equal to one (ONE) or equal to the squared multiple correlation (SMC) coefficients. The available rotation methods are Varimax, Biquartimax, Equamax, Factorparsimax, Orthomax, Parsimax, Quartimax, Biquartimin, Covarimin, Obbiquartimax, Obequamax, Obfactorparsimax, Oblimin, Obparsimax, Obquartimax, Obvarimax, and Promax.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" )
);
obj << Fit( "ML", "SMC", 2, "Varimax" );


```

### [Kaiser-Meyer-Olkin Test](#kaiser-meyer-olkin-test)

**Syntax:** obj \<< "Kaiser-Meyer-Olkin Test"n( state=0|1 )

**Description:** Shows or hides the results of the Kaiser-Meyer-Olkin (KMO) test. The test is an indicator of the proportion of variance that might be common variance, potentially due to underlying factors.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Estimation( "REML" ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << "Kaiser-Meyer-Olkin Test"n( 1 );


```

### [Scree Plot](#scree-plot)

**Syntax:** obj \<< Scree Plot( state=0|1 )

**Description:** Shows or hides a line plot of the eigenvalues for each component. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Estimation( "REML" ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
Wait( 1 );
obj << Scree Plot( 0 );


```

### [Variance Estimation](#variance-estimation)

**Syntax:** obj = Factor Analysis(...Variance Estimation( "REML"| "ML"| "Robust"| "Row-wise"| "Pairwise" )...)

**Description:** Sets the estimation method for computing the correlations.

If there are no missing values, then the default is Row-wise.

If there are missing values, and the number of variables \<= 10 and the number of rows \<=5000, then the default is REML.

If there are missing values, and the number of variables > 10 or number of rows > 5000, then the default is Pairwise.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Estimation( "Robust" ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);


```

### [Variance Scaling](#variance-scaling)

**Syntax:** obj = Factor Analysis(...Variance Scaling( "Correlations"| "Covariances"| "Unscaled")...)

**Description:** Specifies the method that is used for variance scaling.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Estimation( "REML" ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Factor Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Factor Analysis Fit Options](#factor-analysis-fit-options)

### [Item Messages](#item-messages_1)

#### [Arrow Lines](#arrow-lines)

**Syntax:** obj \<< (Fit[number] \<< Arrow Lines( state=0|1 ))

**Description:** Shows or hides the arrow lines in the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
Wait( 1 );
obj << (Fit[1] << Arrow Lines( 0 ));


```

#### [Copy Model Specification for SEM](#copy-model-specification-for-sem)

**Syntax:** obj \<< (Fit[number] \<< Copy Model Specification for SEM)

**Description:** Copies the factor definitions to the clipboard. You can then paste the factor definitions into the SEM platform with independent data to confirm the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Factor Analysis(
    Y( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit( "ML", "SMC", 1, "Varimax" )
);
obj << (Fit[1] << Copy Model Specification for SEM);
obj2 = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L )
);
obj2 << Paste Model Specification;


```

#### [Eigenvalues](#eigenvalues_1)

**Syntax:** obj \<< (Fit[number] \<< Eigenvalues( state=0|1 ))

**Description:** Shows or hides the eigenvalues of the reduced correlation matrix and the percent of the common variance for which they account.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Eigenvalues( 1 ));


```

#### [Factor Loading Plot](#factor-loading-plot)

**Syntax:** obj \<< (Fit[number] \<< Factor Loading Plot( state=0|1 ))

**Description:** Shows or hides a plot of the rotated factor loadings. When more than two factors are modeled, the Factor Loading Plot is a matrix of plots. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
Wait( 1 );
obj << (Fit[1] << Factor Loading Plot( 0 ));


```

#### [Factor Structure](#factor-structure)

**Syntax:** obj \<< (Fit[number] \<< Factor Structure( state=0|1 ))

**Description:** Shows or hides the matrix of correlations between variables and common factors. This option is available only for oblique rotations. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Promax" ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
Wait( 1 );
obj << (Fit[1] << Factor Structure( 0 ));


```

#### [Final Communality Estimates](#final-communality-estimates)

**Syntax:** obj \<< (Fit[number] \<< Final Communality Estimates( state=0|1 ))

**Description:** Shows or hides estimates of the communalities after the factor model has been fit. When the factors are orthogonal, the final communality estimate for a variable equals the sum of the squared loadings for that variable. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
Wait( 1 );
obj << (Fit[1] << Final Communality Estimates( 0 ));


```

#### [Interfactor Correlations](#interfactor-correlations)

**Syntax:** obj \<< (Fit[number] \<< Interfactor Correlations( state=0|1 ))

**Description:** Shows or hides the matrix of correlations between factors. This option is available only for oblique rotations.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Quartimin" )
);
obj << (Fit[1] << Interfactor Correlations( 1 ));


```

#### [Measures of Factor Scores](#measures-of-factor-scores)

**Syntax:** obj \<< (Fit[number] \<< Measures of Factor Scores( state=0|1 ))

**Description:** Shows or hides the measures of factor score determinacy, including Multiple R, Multiple R Square, and Minimum Correlation scores.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
obj << (Fit[1] << Measures of Factor Scores( 1 ));


```

#### [Measures of Fit](#measures-of-fit)

**Syntax:** obj \<< (Fit[number] \<< Measures of Fit( state=0|1 ))

**Description:** Shows or hides the measures of fit, including Chi-Square without Bartlett's Correction, AIC, BIC, Tucker-Lewis's Index, and the root mean square error of approximation. This option is available only when Maximum Likelihood is selected as the Factoring Method. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
Wait( 1 );
obj << (Fit[1] << Measures of Fit( 0 ));


```

#### [Prior Communality](#prior-communality)

**Syntax:** obj \<< (Fit[number] \<< Prior Communality( state=0|1 ))

**Description:** Shows or hides an initial estimate of the communality for each variable.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Prior Communality( 1 ));


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (Fit[number] \<< Remove Fit)

**Description:** Removes the specified fit from the report.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
Wait( 1 );
obj << (Fit[1] << Remove Fit);


```

#### [Rotated Factor Loading](#rotated-factor-loading)

**Syntax:** obj \<< (Fit[number] \<< Rotated Factor Loading( state=0|1 ))

**Description:** Shows or hides the factor loading matrix after rotation. If the rotation is orthogonal, these values are the correlations between the variables and the rotated factors. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
Wait( 1 );
obj << (Fit[1] << Rotated Factor Loading( 0 ));


```

#### [Rotation Matrix](#rotation-matrix)

**Syntax:** obj \<< (Fit[number] \<< Rotation Matrix( state=0|1 ))

**Description:** Shows or hides the values that are used for rotating the factor loading plot and the factor loading matrix.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Rotation Matrix( 1 ));


```

#### [Save Factor Scores](#save-factor-scores)

**Syntax:** obj \<< (Fit[number] \<< Save Factor Scores( state=0|1 ))

**Description:** Saves new formula columns to the original data table. The new columns contain the formulas for the factor scores, which are estimated using the Thurstone method.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Save Factor Scores);


```

#### [Save Factor Scores with Imputation](#save-factor-scores-with-imputation)

**Syntax:** obj \<< (Fit[number] \<< Save Factor Scores with Imputation( state=0|1 ))

**Description:** Saves new formula columns to the original data table. The new columns contain the formulas for the factor scores with imputed values for missing values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Factor Analysis(
    Y( :CO, :SO2, :NO, :PM10 ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Save Factor Scores with Imputation);


```

#### [Score Plot](#score-plot)

**Syntax:** obj \<< (Fit[number] \<< Score Plot( state=0|1 ))

**Description:** Shows or hides a scatterplot of the estimated factor scores. When more than two factors are modeled, the Score Plot is a matrix of plots.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax", Rotated Factor Loading( 0 ), Factor Loading Plot( 0 ) ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
obj << (Fit[1] << Score Plot( 1 ));


```

#### [Score Plot with Imputation](#score-plot-with-imputation)

**Syntax:** obj \<< (Fit[number] \<< Score Plot with Imputation( state=0|1 ))

**Description:** Shows or hides a scatterplot of the estimated factor scores with imputed values for missing values.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Factor Analysis(
    Y( :CO, :SO2, :NO, :PM10 ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax", Rotated Factor Loading( 0 ), Factor Loading Plot( 0 ) ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
obj << (Fit[1] << Score Plot with Imputation( 1 ));


```

#### [Significance Test](#significance-test)

**Syntax:** obj \<< (Fit[number] \<< Significance Test( state=0|1 ))

**Description:** Shows or hides the results from two significance tests. The first tests the null hypothesis that there are no common factors and the second tests the null hypothesis that a specified number of factors are sufficient. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
Wait( 1 );
obj << (Fit[1] << Significance Test( 0 ));


```

#### [Standard Score Coefficients](#standard-score-coefficients)

**Syntax:** obj \<< (Fit[number] \<< Standard Score Coefficients( state=0|1 ))

**Description:** Shows or hides a table of the multipliers that are used to estimate factor scores when saving rotated factors to the source data table.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Standard Score Coefficients( 1 ));


```

#### [Target Matrix](#target-matrix)

**Syntax:** obj \<< (Fit[number] \<< Target Matrix( state=0|1 ))

**Description:** Shows or hides the matrix to which the varimax factor pattern is rotated. This option is available only for the Promax rotation.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Promax" )
);
obj << (Fit[1] << Target Matrix( 1 ));


```

#### [Unrotated Factor Loading](#unrotated-factor-loading)

**Syntax:** obj \<< (Fit[number] \<< Unrotated Factor Loading( state=0|1 ))

**Description:** Shows or hides the factor loading matrix prior to rotation.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Unrotated Factor Loading( 1 ));


```

#### [Unsorted and Rotated Factor Loading](#unsorted-and-rotated-factor-loading)

**Syntax:** obj \<< (Fit[number] \<< Unsorted and Rotated Factor Loading( state=0|1 ))

**Description:** Shows or hides the unsorted factor loading matrix after rotation.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" ),
    Eigenvalues( 0 ),
    Scree Plot( 0 )
);
obj << (Fit[1] << Unsorted and Rotated Factor Loading( 1 ));


```

#### [Unsorted and Unrotated Factor Loading](#unsorted-and-unrotated-factor-loading)

**Syntax:** obj \<< (Fit[number] \<< Unsorted and Unrotated Factor Loading( state=0|1 ))

**Description:** Shows or hides the factor loading matrix prior to sorting and rotation.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
obj << (Fit[1] << Unsorted and Unrotated Factor Loading( 1 ));


```

#### [Variance Explained by Each Factor](#variance-explained-by-each-factor)

**Syntax:** obj \<< (Fit[number] \<< Variance Explained by Each Factor( state=0|1 ))

**Description:** Shows or hides the variance, percent, and cumulative percent, of common variance that is explained by each rotated factor. This option is available only for orthogonal rotations. On by default.

```

dt = Open( "$SAMPLE_DATA/Socioeconomic.jmp" );
obj = dt << Factor Analysis(
    Y(
        :Total Population, :Median School Years, :Total Employment, :Professional Services,
        :Median House Value
    ),
    Variance Scaling( "Correlations" ),
    Fit( "ML", "SMC", 2, "Varimax" )
);
Wait( 1 );
obj << (Fit[1] << Variance Explained by Each Factor( 0 ));


```

# [Fatigue Model](#fatigue-model)

## [Associated Constructors](#associated-constructors)

### [Fatigue Model](#fatigue-model_1)

**Syntax:** Fatigue Model( N( column ), X( column ), \<Freq( column )>, \<Censor( column ), Censor Code( value )> )

**Description:** Analyzes fatigue data, also known as S-N curve modeling.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);


```

## [Columns](#columns)

### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    Freq( :_freqcol )
);


```

### [Life or Cycles](#life-or-cycles)

**Syntax:** obj \<< Life or Cycles( column(s) )

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);


```

### [N](#n)

**Syntax:** obj \<< N( column(s) )

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);


```

### [S](#s)

**Syntax:** obj \<< S( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);


```

### [Strain or Stress](#strain-or-stress)

**Syntax:** obj \<< Strain or Stress( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);


```

## [Item Messages](#item-messages)

### [Fit All Models](#fit-all-models)

**Syntax:** obj \<< Fit All Models

**Description:** Fit All Models

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    Fit All Models
);


```

### [Fit Model](#fit-model)

**Syntax:** obj \<< Fit Model

**Description:** Fit Model

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    Fit Model( "Box-Cox Loglinear Sigma", "Lognormal" ),
    Fit Model( "Coffin-Manson", "Lognormal" ),
    Fit Model( "Coffin-Manson Zero Elastic Slope", "Lognormal" ),
    Fit Model( "Basquin (Inverse Power)", "Lognormal" ),
    Fit Model( "Nishijima", "Lognormal" ),
    Fit Model( "Rectangular Hyperbola", "Lognormal" )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Reliability/Metal Wire Z.jmp" );
obj = dt << Fatigue Model(
    N( :Cycles ),
    S( :Stress ),
    Censor( :Censoring Indicator ),
    Censor Code( "Runout" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Fatigue Model(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Fit Curve](#fit-curve)

## [ANOM for Estimates](#anom-for-estimates)

### [Item Messages](#item-messages)

#### [Point Options](#point-options)

**Syntax:** obj \<< ANOM( 1, Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" ) ); scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Point Options( "Show Only Points" ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Point Options( "Show Connected Points" );


```

#### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj \<< ANOM( 1, Set Alpha Level( alpha ) ); scrobj \<< Set Alpha Level( alpha )

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Set Alpha Level( 0.1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Set Alpha Level( 0.05 );


```

#### [Show Center Line](#show-center-line)

**Syntax:** obj \<< ANOM( 1, Show Center Line( state=0|1 ) ); scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line (overall mean) on the ANOM chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Center Line( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading)

**Syntax:** obj \<< ANOM( 1, Show Decision Limit Shading( state=0|1 ) ); scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading for the ANOM chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Decision Limit Shading( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits)

**Syntax:** obj \<< ANOM( 1, Show Decision Limits( state=0|1 ) ); scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines for the ANOM chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Decision Limits( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report)

**Syntax:** obj \<< ANOM( 1, Show Summary Report( state=0|1 ) ); scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the group means and the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Summary Report( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Summary Report( 0 );


```

## [Associated Constructors](#associated-constructors)

### [Fit Curve](#fit-curve_1)

**Syntax:** Fit Curve( Y( column ), X( column ) )

**Description:** Fits a variety of built-in nonlinear models.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Fit Curve(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;


```

### [Freq](#freq)

**Syntax:** obj = Fit Curve(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    Freq( :_freqcol )
);
obj << Fit Logistic 4P;


```

### [Group](#group)

**Syntax:** obj = Fit Curve(...\<Group( column )>...)

**Description:** Specifies a grouping variable. The fitted model has separate parameters for each level of the grouping variable.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

### [Regressor](#regressor)

**Syntax:** obj = Fit Curve(...\<Regressor( column )>...)

**Description:** Specifies the predictor variables.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

### [Response](#response)

**Syntax:** obj = Fit Curve(...Response( column(s) )...)

**Description:** Specifies the response variables.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

### [Supplementary](#supplementary)

**Syntax:** obj = Fit Curve(...\<Supplementary( column(s) )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ), Z( :sex ) );
obj << Fit Cubic;


```

### [Weight](#weight)

**Syntax:** obj = Fit Curve(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    Weight( :_weightcol )
);
obj << Fit Logistic 4P;


```

### [X](#x)

**Syntax:** obj = Fit Curve(...\<X( column )>...)

**Description:** Specifies the predictor variables.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

### [Y](#y)

**Syntax:** obj = Fit Curve(...Y( column(s) )...)

**Description:** Specifies the response variables.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

### [Z](#z)

**Syntax:** obj = Fit Curve(...\<Z( column(s) )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ), Z( :sex ) );
obj << Fit Cubic;


```

## [Item Messages](#item-messages_1)

### [F1 Analysis](#f1-analysis)

**Syntax:** obj \<< F1 Analysis( Alpha( number ), Reference Level( level ), Bootstrap Samples( number ), Random Seed( number ))

**Description:** Performs a dissolution curve analysis using the F1 difference factor, which measures the percent difference between the curves of the reference tablet and the curves of the test tablet at each time point.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, Dissolution 360 ),
    Group( :Batch ),
    Z( :Polymer A, :Polymer B, :Total Polymer, :Compression Force )
);
obj << F1 Analysis(
    Alpha( 0.05 ),
    Reference Level( "R01" ),
    Bootstrap Samples( 2000 ),
    Random Seed( 1234 )
);


```

### [F2 Analysis](#f2-analysis)

**Syntax:** obj \<< F2 Analysis( Alpha( number ), Reference Level( level ), Bootstrap Samples( number ), Random Seed( number ))

**Description:** Performs a dissolution curve analysis using the F2 similarity factor, which measures the similarity of percent dissolution between the curves of the reference tablet and the curves of the test tablet.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, Dissolution 360 ),
    Group( :Batch ),
    Z( :Polymer A, :Polymer B, :Total Polymer, :Compression Force )
);
obj << F2 Analysis(
    Alpha( 0.1 ),
    Reference Level( "R01" ),
    Bootstrap Samples( 3000 ),
    Random Seed( 4321 )
);


```

### [Fit Antoine Equation](#fit-antoine-equation)

**Syntax:** obj \<< Fit Antoine Equation

**Description:** Fits the Antoine model to the data. This model is often used to model vapor pressure as a function of temperature.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Algae Mitscherlich.jmp" );
obj = dt << Fit Curve( Y( :Algae Density ), X( :Days ), Group( :Treatment ) );
obj << Fit Antoine Equation;


```

### [Fit Asymmetric Gaussian Peak](#fit-asymmetric-gaussian-peak)

**Syntax:** obj \<< Fit Asymmetric Gaussian Peak

### [Fit Biexponential 4P](#fit-biexponential-4p)

**Syntax:** obj \<< Fit Biexponential 4P

**Description:** Fits a four-parameter biexponential model to the data.

```

Random Reset( 7483 );
xd = [.25, .5, .75, 1, 1.5, 2, 3, 4, 6, 12, 24];
yd = J( 11, 1, . );
For( i = 1, i <= 11, i++,
    yd[i] = 170 * Exp( -.15 * xd[i] ) + 80 * Exp( -1.4 * xd[i] ) + .1 * Random Normal()
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "time" );
Column( dt, 2 ) << set name( "concentration" );
obj = dt << Fit Curve( Y( :concentration ), X( :time ) );
obj << Fit Biexponential 4P;


```

### [Fit Biexponential 5P](#fit-biexponential-5p)

**Syntax:** obj \<< Fit Biexponential 5P

**Description:** Fits a five-parameter biexponential model to the data.

```

Random Reset( 7483 );
xd = [.25, .5, .75, 1, 1.5, 2, 3, 4, 6, 12, 24];
yd = J( 11, 1, . );
For( i = 1, i <= 11, i++,
    yd[i] = 170 * Exp( -.15 * xd[i] ) + 80 * Exp( -1.4 * xd[i] ) + .1 * Random Normal()
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "time" );
Column( dt, 2 ) << set name( "concentration" );
obj = dt << Fit Curve( Y( :concentration ), X( :time ) );
obj << Fit Biexponential 5P;


```

### [Fit Cell Growth 4P](#fit-cell-growth-4p)

**Syntax:** obj \<< Fit Cell Growth 4P

**Description:** Fits a four-parameter growth and decay model to the data.

```

Random Reset( 7483 );
xd = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
yd = J( 12, 1, . );
For( i = 1, i <= 12, i++,
    yd[i] = 10 * Normal Density( (xd[i] - 6) / 2 ) + Random Normal() * .1
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "x" );
Column( dt, 2 ) << set name( "y" );
obj = dt << Fit Curve( Y( :Y ), X( :X ) );
obj << Fit Cell Growth 4P;


```

### [Fit Cubic](#fit-cubic)

**Syntax:** obj \<< Fit Cubic

**Description:** Fits a cubic model to the data.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ) );
obj << Fit Cubic;


```

### [Fit ExGaussian Peak](#fit-exgaussian-peak)

**Syntax:** obj \<< Fit ExGaussian Peak

**Description:** Fits an exponentially modified Gaussian peak model to the data.

```

Random Reset( 7483 );
xd = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
yd = J( 12, 1, . );
For( i = 1, i <= 12, i++,
    yd[i] = 10 * Normal Density( (xd[i] - 6) / 2 ) + Random Normal() * .1
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "x" );
Column( dt, 2 ) << set name( "y" );
obj = dt << Fit Curve( Y( :Y ), X( :X ) );
obj << Fit ExGaussian Peak;


```

### [Fit Exponential 2P](#fit-exponential-2p)

**Syntax:** obj \<< Fit Exponential 2P

**Description:** Fits a two-parameter exponential model to the data. The fitted response has an asymptote at zero.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Fit Curve( Y( :pop ), X( :year ) );
obj << Fit Exponential 2P;


```

### [Fit Exponential 3P](#fit-exponential-3p)

**Syntax:** obj \<< Fit Exponential 3P

**Description:** Fits a three-parameter exponential model to the data. The fitted response is bounded by an estimated asymptote.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Fit Curve( Y( :pop ), X( :year ) );
obj << Fit Exponential 3P;


```

### [Fit First Order Rate](#fit-first-order-rate)

**Syntax:** obj \<< Fit First Order Rate

**Description:** Fits a first order rate model to the data. This is useful in modeling chemical reactions and is available only when the X values are nonnegative.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Fit Curve( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Fit First Order Rate;


```

### [Fit First Order with Equilibrium](#fit-first-order-with-equilibrium)

**Syntax:** obj \<< Fit First Order with Equilibrium

**Description:** Fits a first order rate model with equilibrium to the data. This is useful in modeling chemical reactions and is available only when the X values are nonnegative.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Fit Curve( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Fit First Order with Equilibrium;


```

### [Fit First Order with Limits](#fit-first-order-with-limits)

**Syntax:** obj \<< Fit First Order with Limits

**Description:** Fits a first order rate model with limits to the data. This is useful in modeling chemical reactions and is available only when the X values are nonnegative.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Fit Curve( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Fit First Order with Limits;


```

### [Fit Gaussian Peak](#fit-gaussian-peak)

**Syntax:** obj \<< Fit Gaussian Peak

**Description:** Fits a Gaussian peak model to the data.

```

Random Reset( 7483 );
xd = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
yd = J( 12, 1, . );
For( i = 1, i <= 12, i++,
    yd[i] = 10 * Normal Density( (xd[i] - 6) / 2 ) + Random Normal() * .1
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "x" );
Column( dt, 2 ) << set name( "y" );
obj = dt << Fit Curve( Y( :Y ), X( :X ) );
obj << Fit Gaussian Peak;


```

### [Fit Gompertz 3P](#fit-gompertz-3p)

**Syntax:** obj \<< Fit Gompertz 3P

**Description:** Fits a three-parameter Gompertz curve to the data. The fitted response is bounded between zero and an estimated asymptote.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dat = dt << get as matrix;
maxy = Max( dat[0, 3] );
newy = dat[0, 3] / maxy;
form = Column( 3 ) << get values;
Close( dt, no save );
newtab = As Table( dat[0, 2] || newy );
Column( 1 ) << set name( "log conc" );
Column( 2 ) << set name( "toxicity" );
New Column( "formulation", character, nominal );
Column( 3 ) << set values( form );
obj = Fit Curve( Y( :toxicity ), X( :log conc ), Group( :formulation ) );
obj << Fit Gompertz 3P;


```

### [Fit Gompertz 4P](#fit-gompertz-4p)

**Syntax:** obj \<< Fit Gompertz 4P

**Description:** Fits a four-parameter Gompertz curve to the data. The fitted response is bounded between two estimated asymptotes.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Gompertz 4P;


```

### [Fit Higuchi](#fit-higuchi)

**Syntax:** obj \<< Fit Higuchi

**Description:** Fits a Higuchi model to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << Fit Higuchi;


```

### [Fit Higuchi with Burst](#fit-higuchi-with-burst)

**Syntax:** obj \<< Fit Higuchi with Burst

**Description:** Fits a Higuchi model with a burst component to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << Fit Higuchi with Burst;


```

### [Fit Higuchi with Lag](#fit-higuchi-with-lag)

**Syntax:** obj \<< Fit Higuchi with Lag

**Description:** Fits a Higuchi model with a lag component to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << Fit Higuchi with Lag;


```

### [Fit Hixson-Crowell](#fit-hixson-crowell)

**Syntax:** obj \<< "Fit Hixson-Crowell"n

**Description:** Fits a Hixson-Crowell model to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << "Fit Hixson-Crowell"n;


```

### [Fit Hixson-Crowell with Lag](#fit-hixson-crowell-with-lag)

**Syntax:** obj \<< "Fit Hixson-Crowell with Lag"n

**Description:** Fits a Hixson-Crowell model with a lag component to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << "Fit Hixson-Crowell with Lag"n;


```

### [Fit Hybrid Exponential](#fit-hybrid-exponential)

**Syntax:** obj \<< Fit Hybrid Exponential

**Description:** Fits a Hybrid Exponential model to the data.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Negative Exponential.jmp" );
obj = dt << Fit Curve( Y( :Y ), X( :X ) );
obj << Fit Hybrid Exponential;


```

### [Fit Inverse Michaelis-Menten](#fit-inverse-michaelis-menten)

**Syntax:** obj \<< Fit Inverse Michaelis Menten; obj \<< "Fit Inverse Michaelis-Menten"n

**Description:** Fits the inverse Michaelis-Menten enzyme kinetics model to the data.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Fit Curve( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Fit Inverse Michaelis Menten;


```

### [Fit Korsmeyer-Peppas](#fit-korsmeyer-peppas)

**Syntax:** obj \<< "Fit Korsmeyer-Peppas"n

**Description:** Fits a Korsmeyer-Peppas model to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << "Fit Korsmeyer-Peppas"n;


```

### [Fit Korsmeyer-Peppas with Burst](#fit-korsmeyer-peppas-with-burst)

**Syntax:** obj \<< "Fit Korsmeyer-Peppas with Burst"n

**Description:** Fits a Korsmeyer-Peppas model with a burst component to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << "Fit Korsmeyer-Peppas with Burst"n;


```

### [Fit Korsmeyer-Peppas with Lag](#fit-korsmeyer-peppas-with-lag)

**Syntax:** obj \<< "Fit Korsmeyer-Peppas with Lag"n

**Description:** Fits a Korsmeyer-Peppas model with a lag component to the data. This is a parametric technique to compare dissolution curves.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << "Fit Korsmeyer-Peppas with Lag"n;


```

### [Fit Linear](#fit-linear)

**Syntax:** obj \<< Fit Linear

**Description:** Fits a least squares regression model to the data. The fit line is shown on the plot and a fit report is provided.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ) );
obj << Fit Linear;


```

### [Fit Logistic 2P](#fit-logistic-2p)

**Syntax:** obj \<< Fit Logistic 2P

**Description:** Fits a two-parameter logistic curve to the data. The fitted response is bounded between asymptotes zero and one.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dat = dt << get as matrix;
miny = Min( dat[0, 3] );
maxy = Max( dat[0, 3] );
newy = (dat[0, 3] - miny) / (maxy - miny);
form = Column( 3 ) << get values;
Close( dt, no save );
newtab = As Table( dat[0, 2] || newy );
Column( 1 ) << set name( "log conc" );
Column( 2 ) << set name( "toxicity" );
New Column( "formulation", character, nominal );
Column( 3 ) << set values( form );
obj = Fit Curve( Y( :toxicity ), X( :log conc ), Group( :formulation ) );
obj << Fit Logistic 2P;


```

### [Fit Logistic 3P](#fit-logistic-3p)

**Syntax:** obj \<< Fit Logistic 3P

**Description:** Fits a three-parameter logistic curve to the data. The fitted response is bounded between zero and an estimated asymptote.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dat = dt << get as matrix;
maxy = Max( dat[0, 3] );
newy = dat[0, 3] / maxy;
form = Column( 3 ) << get values;
Close( dt, no save );
newtab = As Table( dat[0, 2] || newy );
Column( 1 ) << set name( "log conc" );
Column( 2 ) << set name( "toxicity" );
New Column( "formulation", character, nominal );
Column( 3 ) << set values( form );
obj = Fit Curve( Y( :toxicity ), X( :log conc ), Group( :formulation ) );
obj << Fit Logistic 3P;


```

### [Fit Logistic 4P](#fit-logistic-4p)

**Syntax:** obj \<< Fit Logistic 4P

**Description:** Fits a four-parameter logistic model to the data. The fitted response is bounded between two estimated asymptotes.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;


```

### [Fit Logistic 4P Hill](#fit-logistic-4p-hill)

**Syntax:** obj \<< Fit Logistic 4P Hill

**Description:** Fits a four-parameter logistic model to the data. The fitted response is bounded between two estimated asymptotes.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P Hill;


```

### [Fit Logistic 4P Rodbard](#fit-logistic-4p-rodbard)

**Syntax:** obj \<< Fit Logistic 4P Rodbard

**Description:** Fits a four-parameter logistic model to the data. The fitted response is bounded between two estimated asymptotes.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :Concentration ), Group( :formulation ) );
obj << Fit Logistic 4P Rodbard;


```

### [Fit Logistic 5P](#fit-logistic-5p)

**Syntax:** obj \<< Fit Logistic 5P

**Description:** Fits a five-parameter logistic model to the data. The fitted response is bounded between two estimated asymptotes. Unlike the other logistic curves, the five-parameter logistic is not symmetric.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 5P;


```

### [Fit Lorentzian Peak](#fit-lorentzian-peak)

**Syntax:** obj \<< Fit Lorentzian Peak

**Description:** Fits a Lorentzian peak model to the data.

```

Random Reset( 7483 );
xd = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
yd = J( 12, 1, . );
For( i = 1, i <= 12, i++,
    yd[i] = 10 * (5 / ((xd[i] - 6) ^ 2 + 25)) + Random Normal() * .1
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "x" );
Column( dt, 2 ) << set name( "y" );
obj = dt << Fit Curve( Y( :Y ), X( :X ) );
obj << Fit Lorentzian Peak;


```

### [Fit Mechanistic Growth](#fit-mechanistic-growth)

**Syntax:** obj \<< Fit Mechanistic Growth

**Description:** Fits the mechanistic growth model to the data. This is a reparameterization of the Exponential 3P model.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Corn.jmp" );
obj = dt << Fit Curve( Y( :yield ), X( :nitrate ) );
obj << Fit Mechanistic Growth;


```

### [Fit Michaelis-Menten](#fit-michaelis-menten)

**Syntax:** obj \<< Fit Michaelis Menten; obj \<< "Fit Michaelis-Menten"n

**Description:** Fits the Michaelis-Menten enzyme kinetics model to the data.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Fit Curve( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Fit Michaelis Menten;


```

### [Fit One Compartment Oral Dose](#fit-one-compartment-oral-dose)

**Syntax:** obj \<< Fit One Compartment Oral Dose

**Description:** Fits a One Compartment Oral Dose model to the data. This model is appropriate for modeling the concentration of drug in the body after an oral dose.

```

dat = [0 0, .27 1.72, .52 7.91, 1 8.31, 1.92 8.33, 3.5 6.85, 5.02 6.08, 7.03 5.4, 9 4.55, 12
3.01, 24.3 .9];
dt = As Table( dat );
Column( dt, 1 ) << set name( "time" );
Column( dt, 2 ) << set name( "concentration" );
obj = dt << Fit Curve( Y( :concentration ), X( :time ) );
obj << Fit One Compartment Oral Dose;


```

### [Fit Pearson VII Peak](#fit-pearson-vii-peak)

**Syntax:** obj \<< Fit Pearson VII Peak

### [Fit Power Model](#fit-power-model)

**Syntax:** obj \<< Fit Power Model

**Description:** Fits a power model to the data.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ) );
obj << Fit Power Model;


```

### [Fit Probit 2P](#fit-probit-2p)

**Syntax:** obj \<< Fit Probit 2P

**Description:** Fits a two-parameter probit curve to the data. The fitted response is bounded between asymptotes zero and one.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dat = dt << get as matrix;
miny = Min( dat[0, 3] );
maxy = Max( dat[0, 3] );
newy = (dat[0, 3] - miny) / (maxy - miny);
form = Column( 3 ) << get values;
Close( dt, no save );
newtab = As Table( dat[0, 2] || newy );
Column( 1 ) << set name( "log conc" );
Column( 2 ) << set name( "toxicity" );
New Column( "formulation", character, nominal );
Column( 3 ) << set values( form );
obj = Fit Curve( Y( :toxicity ), X( :log conc ), Group( :formulation ) );
obj << Fit Probit 2P;


```

### [Fit Probit 3P](#fit-probit-3p)

**Syntax:** obj \<< Fit Probit 3P

**Description:** Fits a three-parameter probit curve to the data. The fitted response is bounded between zero and an estimated asymptote.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dat = dt << get as matrix;
maxy = Max( dat[0, 3] );
newy = dat[0, 3] / maxy;
form = Column( 3 ) << get values;
Close( dt, no save );
newtab = As Table( dat[0, 2] || newy );
Column( 1 ) << set name( "log conc" );
Column( 2 ) << set name( "toxicity" );
New Column( "formulation", character, nominal );
Column( 3 ) << set values( form );
obj = Fit Curve( Y( :toxicity ), X( :log conc ), Group( :formulation ) );
obj << Fit Probit 3P;


```

### [Fit Probit 4P](#fit-probit-4p)

**Syntax:** obj \<< Fit Probit 4P

**Description:** Fits a four-parameter probit model to the data. The fitted response is bounded between two estimated asymptotes.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = Fit Curve( Y( :toxicity ), X( :log conc ), Group( :formulation ) );
obj << Fit Probit 4P;


```

### [Fit Pseudo-Voigt](#fit-pseudo-voigt)

**Syntax:** obj \<< Fit Pseudo-Voigt

### [Fit Quadratic](#fit-quadratic)

**Syntax:** obj \<< Fit Quadratic

**Description:** Fits a quadratic model to the data.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ) );
obj << Fit Quadratic;


```

### [Fit Quartic](#fit-quartic)

**Syntax:** obj \<< Fit Quartic

**Description:** Fits a fourth-order polynomial to the data.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ) );
obj << Fit Quartic;


```

### [Fit Quintic](#fit-quintic)

**Syntax:** obj \<< Fit Quintic

**Description:** Fits a fifth-order polynomial to the data.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Curve( Y( :height ), X( :weight ) );
obj << Fit Quintic;


```

### [Fit Second Order](#fit-second-order)

**Syntax:** obj \<< Fit Second Order

**Description:** Fits a second order rate model to the data. This is useful in modeling chemical reactions and is available only when the X values are nonnegative.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Fit Curve( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Fit Second Order;


```

### [Fit Second Order with Two Components](#fit-second-order-with-two-components)

**Syntax:** obj \<< Fit Second Order with Two Components

**Description:** Fits a second order rate model with two components to the data. This is useful in modeling chemical reactions and is available only when the X values are nonnegative.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Fit Curve( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Fit Second Order with Two Components;


```

### [Fit Skew Normal Peak](#fit-skew-normal-peak)

**Syntax:** obj \<< Fit Skew Normal Peak

### [Fit Two Compartment IV Bolus Dose](#fit-two-compartment-iv-bolus-dose)

**Syntax:** obj \<< Fit Two Compartment IV Bolus Dose

**Description:** Fits a Two Compartment IV Bolus Dose model to the data. This model is appropriate for modeling the concentration of drug in the body after an intravenous bolus dose.

```

Random Reset( 7483 );
xd = [.25, .5, .75, 1, 1.5, 2, 3, 4, 6, 12, 24];
yd = J( 11, 1, . );
For( i = 1, i <= 11, i++,
    yd[i] = 170 * Exp( -.15 * xd[i] ) + 80 * Exp( -1.4 * xd[i] ) + .1 * Random Normal()
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "time" );
Column( dt, 2 ) << set name( "concentration" );
obj = dt << Fit Curve( Y( :concentration ), X( :time ) );
obj << Fit Two Compartment IV Bolus Dose;


```

### [Fit Weibull Growth](#fit-weibull-growth)

**Syntax:** obj \<< Fit Weibull Growth

**Description:** Fits a three-parameter Weibull Growth model to the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :Concentration ), Group( :formulation ) );
obj << Fit Weibull Growth;


```

### [Multivariate Distance](#multivariate-distance)

**Syntax:** obj \<< Multivariate Distance( Alpha( number ), Reference Level( level ))

**Description:** Performs a dissolution curve analysis using the Mahalanobis distance M, which measures the multivariate distance between the curves of the reference tablet and the curves of the test tablet.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, Dissolution 360 ),
    Group( :Batch ),
    Z( :Polymer A, :Polymer B, :Total Polymer, :Compression Force )
);
obj << Multivariate Distance( Alpha( 0.1 ), Reference Level( "R01" ) );


```

### [T2EQ](#t2eq)

**Syntax:** obj \<< T2EQ( Alpha( number ), Reference Level( level ))

**Description:** Performs a dissolution curve analysis using the T2EQ equivalence test, which measures the multivariate distance between the curves of the reference tablet and the curves of the test tablet.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, Dissolution 360 ),
    Group( :Batch ),
    Z( :Polymer A, :Polymer B, :Total Polymer, :Compression Force )
);
obj << T2EQ( Alpha( 0.05 ), Reference Level( "R01" ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Logistic 4P;
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Fit Curve(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Equivalence with Ratios](#equivalence-with-ratios)

### [Item Messages](#item-messages_2)

#### [Set Alpha Level](#set-alpha-level_1)

**Syntax:** obj \<< Fit Command( Equivalence Test(..., Equivalence with Ratios( 1, Set Alpha Level( number )))); obj \<< (Fit[name|number] \<< Equivalence Test(..., Equivalence with Ratios( 1, Set Alpha Level( number ))))

**Description:** Sets the alpha level that is used to compute the confidence intervals on the equivalence chart.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P(
    Equivalence Test(
        Reference Group( "Standard" ),
        Equivalence with Ratios( 1, Set Alpha Level( 0.1 ) ),
        Equivalence with Ratios( 1, Set Alpha Level( 0.1 ) ),
        Equivalence with Ratios( 1, Set Alpha Level( 0.1 ) )
    )
);


```

#### [Set Decision Lines](#set-decision-lines)

**Syntax:** obj \<< Fit Command( Equivalence Test(..., Equivalence with Ratios( 1, Set Decision Lines( lower, upper )))); obj \<< (Fit[name|number] \<< Equivalence Test(..., Equivalence with Ratios( 1, Set Decision Lines( lower, upper ))))

**Description:** Sets the lower and upper decision lines on the equivalence chart.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P(
    Equivalence Test(
        Reference Group( "Standard" ),
        Equivalence with Ratios( 1, Set Decision Lines( 0.9, 1.1 ) ),
        Equivalence with Ratios( 1, Set Decision Lines( 0.9, 1.1 ) ),
        Equivalence with Ratios( 1, Set Decision Lines( 0.9, 1.1 ) )
    )
);


```

#### [Show Center Line](#show-center-line_1)

**Syntax:** obj \<< Fit Command( Equivalence Test(..., Equivalence with Ratios( 1, Show Center Line( state=0|1 )))); obj \<< (Fit[name|number] \<< Equivalence Test(..., Equivalence with Ratios( 1, Show Center Line( state=0|1 ))))

**Description:** Shows or hides the center line on the equivalence chart. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P(
    Equivalence Test(
        Reference Group( "Standard" ),
        Equivalence with Ratios( 1, Show Center Line( 0 ) ),
        Equivalence with Ratios( 1, Show Center Line( 1 ) ),
        Equivalence with Ratios( 1, Show Center Line( 0 ) )
    )
);


```

#### [Show Decision Limit Shading](#show-decision-limit-shading_1)

**Syntax:** obj \<< Fit Command( Equivalence Test(..., Equivalence with Ratios( 1, Show Decision Limit Shading( state=0|1 )))); obj \<< (Fit[name|number] \<< Equivalence Test(..., Equivalence with Ratios( 1, Show Decision Limit Shading( state=0|1 ))))

**Description:** Shows or hides the decision limit shading on the equivalence chart. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P(
    Equivalence Test(
        Reference Group( "Standard" ),
        Equivalence with Ratios( 1, Show Decision Limit Shading( 0 ) ),
        Equivalence with Ratios( 1, Show Decision Limit Shading( 1 ) ),
        Equivalence with Ratios( 1, Show Decision Limit Shading( 0 ) )
    )
);


```

#### [Show Decision Limits](#show-decision-limits_1)

**Syntax:** obj \<< Fit Command( Equivalence Test(..., Equivalence with Ratios( 1, Show Decision Limits( state=0|1 )))); obj \<< (Fit[name|number] \<< Equivalence Test(..., Equivalence with Ratios(1, Show Decision Limits( state=0|1 ))))

**Description:** Shows or hides the decision limit lines on the equivalence chart. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P(
    Equivalence Test(
        Reference Group( "Standard" ),
        Equivalence with Ratios( 1, Show Decision Limits( 0 ) ),
        Equivalence with Ratios( 1, Show Decision Limits( 1 ) ),
        Equivalence with Ratios( 1, Show Decision Limits( 0 ) )
    )
);


```

#### [Show Summary Report](#show-summary-report_1)

**Syntax:** obj \<< Fit Command( Equivalence Test(..., Equivalence with Ratios( 1, Show Summary Report( state=0|1 )))); obj \<< (Fit[name|number] \<< Equivalence Test(..., Equivalence with Ratios( 1, Show Summary Report( state=0|1 ))))

**Description:** Shows or hides the Equivalence Summary report that contains the parameter estimates, the decision limits, and whether the parameter exceeded the limits.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P(
    Equivalence Test(
        Reference Group( "Standard" ),
        Equivalence with Ratios( 1, Show Summary Report( 1 ) ),
        Equivalence with Ratios( 1, Show Summary Report( 1 ) ),
        Equivalence with Ratios( 1, Show Summary Report( 1 ) )
    )
);


```

## [Fit Curve CDOE](#fit-curve-cdoe)

### [Item Messages](#item-messages_3)

#### [CDOE Fit Plot](#cdoe-fit-plot)

**Syntax:** scrobj \<< CDOE Fit Plot( state=0|1 )

**Description:** Shows or hides a plot of the fitted values. If a Group variable is specified, there is also a grid of plots of the fitted values for each level of the Group variable. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = Fit Curve(
    Y( :"Size/nm"n ),
    X( :Time ),
    Group( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    Fit Biexponential 5P,
    SendToReport(
        Dispatch( {"Fit Curve"}, "Model Comparison", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Group Summary", OutlineBox,
            {Close( 1 )}
        ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Plot", OutlineBox, {Close( 1 )} )
    )
);
obj << (Fit["Biexponential 5P"] << Curve DOE Analysis( 1 ));
Report( obj )["CDOE Fit"] << Close( 0 );
Wait( 2 );
scrobj = (Report( obj )["Curve DOE Analysis"] << get scriptable object);
scrobj << CDOE Fit Plot( 0 );


```

#### [CDOE Profiler](#cdoe-profiler)

**Syntax:** scrobj \<< CDOE Profiler( state=0|1 )

**Description:** Shows or hides the CDOE Profiler, which enables you to explore how the response changes based on the supplementary variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = Fit Curve(
    Y( :"Size/nm"n ),
    X( :Time ),
    Group( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    Fit Biexponential 5P,
    SendToReport(
        Dispatch( {"Fit Curve"}, "Model Comparison", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Group Summary", OutlineBox,
            {Close( 1 )}
        ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Plot", OutlineBox, {Close( 1 )} )
    )
);
obj << (Fit["Biexponential 5P"] << Curve DOE Analysis( 1 ));
Wait( 2 );
scrobj = (Report( obj )["Curve DOE Analysis"] << get scriptable object);
scrobj << CDOE Profiler( 0 );


```

#### [Diagnostic Plots](#diagnostic-plots)

**Syntax:** scrobj \<< Diagnostic Plots( state=0|1 )

**Description:** Shows or hides actual by predicted and residual plots for the response variable. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = Fit Curve(
    Y( :"Size/nm"n ),
    X( :Time ),
    Group( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    Fit Biexponential 5P,
    SendToReport(
        Dispatch( {"Fit Curve"}, "Model Comparison", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Group Summary", OutlineBox,
            {Close( 1 )}
        ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Plot", OutlineBox, {Close( 1 )} )
    )
);
obj << (Fit["Biexponential 5P"] << Curve DOE Analysis( 1 ));
Report( obj )["Diagnostic Plots"] << Close( 0 );
Wait( 2 );
scrobj = (Report( obj )["Curve DOE Analysis"] << get scriptable object);
scrobj << Diagnostic Plots( 0 );


```

#### [Generalized Regression for Model Parameters](#generalized-regression-for-model-parameters)

**Syntax:** scrobj \<< Generalized Regression for Model Parameters( state=0|1 )

**Description:** Shows or hides the Generalized Regression reports for each model parameter. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = Fit Curve(
    Y( :"Size/nm"n ),
    X( :Time ),
    Group( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    Fit Biexponential 5P,
    SendToReport(
        Dispatch( {"Fit Curve"}, "Model Comparison", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Group Summary", OutlineBox,
            {Close( 1 )}
        ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Plot", OutlineBox, {Close( 1 )} )
    )
);
obj << (Fit["Biexponential 5P"] << Curve DOE Analysis( 1 ));
Report( obj )["Generalized Regression for Model Parameters"] << Close( 0 );
Wait( 2 );
scrobj = (Report( obj )["Curve DOE Analysis"] << get scriptable object);
scrobj << Generalized Regression for Model Parameters( 0 );


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** scrobj \<< Save Prediction Formula

**Description:** Saves a new formula column to the original data table. The new column contains the prediction formula for the response.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = Fit Curve(
    Y( :"Size/nm"n ),
    X( :Time ),
    Group( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    Fit Biexponential 5P,
    SendToReport(
        Dispatch( {"Fit Curve"}, "Model Comparison", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Group Summary", OutlineBox,
            {Close( 1 )}
        ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Plot", OutlineBox, {Close( 1 )} )
    )
);
obj << (Fit["Biexponential 5P"] << Curve DOE Analysis( 1 ));
scrobj = (Report( obj )["Curve DOE Analysis"] << get scriptable object);
scrobj << Save Prediction Formula;


```

## [Fit](#fit)

### [Item Messages](#item-messages_4)

#### [Area Under Curve](#area-under-curve)

**Syntax:** obj \<< Fit Command( Area Under Curve( state=0|1 )); obj \<< (Fit[number|name] \<< Area Under Curve( state=0|1 ))

**Description:** Calculates the area under the fitted prediction function.

```

Random Reset( 7483 );
xd = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
yd = J( 12, 1, . );
For( i = 1, i <= 12, i++,
    yd[i] = 10 * Normal Density( (xd[i] - 6) / 2 ) + Random Normal() * .1
);
dt = As Table( xd || yd );
Column( dt, 1 ) << set name( "x" );
Column( dt, 2 ) << set name( "y" );
obj = dt << Fit Curve( Y( :Y ), X( :X ) );
obj << Fit Gaussian Peak( Area Under Curve( 1 ) );


```

#### [Compare Parameter Estimates](#compare-parameter-estimates)

**Syntax:** obj \<< Fit Command( Compare Parameter Estimates( state=0|1 )); obj \<< (Fit[number|name] \<< Compare Parameter Estimates( state=0|1 ))

**Description:** Compares the parameter estimate from each group to the overall mean. This comparison is done for each parameter.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Compare Parameter Estimates( 1 ) );


```

#### [Curve DOE Analysis](#curve-doe-analysis)

**Syntax:** obj \<< (Fit[number|name] \<< Curve DOE Analysis( state=0|1 ))

**Description:** Launches a Generalized Regression report within the Fit Curve platform. A generalized regression model is fit to each parameter of the model using the supplementary variables as model effects.

**JMP Version Added:** 16

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, Dissolution 360 ),
    Group( :Batch ),
    Z( :Polymer A, :Polymer B, :Total Polymer, :Compression Force ),
    Multivariate Distance( Alpha( 0.1 ), Reference Level( "R01" ) ),
    SendToReport(
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "Multivariate Distance"}, "Comparisons", OutlineBox,
            {Close( 1 )}
        )
    )
);
obj << (fit[1] << Curve DOE Analysis( 1 ));


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = Fit Curve(
    Y( :"Size/nm"n ),
    X( :Time ),
    Group( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    Fit Biexponential 5P,
    SendToReport(
        Dispatch( {"Fit Curve"}, "Model Comparison", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Group Summary", OutlineBox,
            {Close( 1 )}
        ),
        Dispatch( {"Fit Curve", "Biexponential 5P"}, "Plot", OutlineBox, {Close( 1 )} )
    )
);
obj << (Fit["Biexponential 5P"] << Curve DOE Analysis( 1 ));


```

#### [Custom Inverse Prediction](#custom-inverse-prediction)

**Syntax:** obj \<< Fit Command( Custom Inverse Prediction( Response( value ))); obj \<< (Fit[number|name] \<< Custom Inverse Prediction( Response( value )))

**Description:** Predicts an X value for the specified response value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Custom Inverse Prediction( Response( 0.9 ) ) );


```

#### [Equivalence Test](#equivalence-test)

**Syntax:** obj \<< Fit Command( Equivalence Test( Reference Group( column ))); obj \<< (Fit[number|name] \<< Equivalence Test( Reference Group( column )))

**Description:** Tests whether the fitted curve for each group is practically equivalent to the fitted curve from a reference group.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Equivalence Test( Reference Group( "Standard" ) ) );


```

#### [Inflection Point](#inflection-point)

**Syntax:** obj \<< Fit Command( Inflection Point( state=0|1 )); obj \<< (Fit[number|name] \<< Inflection Point( state=0|1 ))

**Description:** Shows or hides a report of the inflection point estimates for the model. This option is available only for Weibull Growth, Logistic 4P Rodbard, and Logistic 5P models.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 5P( Inflection Point( 1 ) );


```

#### [Make Parameter Table](#make-parameter-table)

**Syntax:** obj \<< Fit Command( Make Parameter Table ); obj \<< (Fit[number|name] \<< Make Parameter Table)

**Description:** Creates a summary table of parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Make Parameter Table );


```

#### [Peak Response](#peak-response)

**Syntax:** obj \<< Fit Command( Peak Response( state=0|1 ); obj \<< (Fit[number|name] \<< Peak Response( state=0|1 ))

**Description:** Calculates the estimate of the Y variable at the peak of the fitted curve. This option is available for Cell Growth 4P and One Compartment models.

**JMP Version Added:** 15

```

dat = [0 0, .27 1.72, .52 7.91, 1 8.31, 1.92 8.33, 3.5 6.85, 5.02 6.08, 7.03 5.4, 9 4.55, 12
3.01, 24.3 .9];
dt = As Table( dat );
Column( dt, 1 ) << set name( "time" );
Column( dt, 2 ) << set name( "concentration" );
obj = dt << Fit Curve( Y( :concentration ), X( :time ) );
obj << Fit One Compartment Oral Dose( Peak Response( 1 ) );


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Fit Command( Plot Actual by Predicted( state=0|1 ); obj \<< (Fit[number|name] \<< Plot Actual by Predicted( state=0|1 ))

**Description:** Shows or hides a plot with the actual response values on the vertical axis and the predicted values on the horizontal axis. In good fits, points are near the diagonal. You can see which points are far from the diagonal, look for patterns, and visualize the test.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
fc = Fit Curve( Y( :weight ), X( :height ), Fit Linear() );
fc << (fit[1] << Plot Actual by Predicted( 1 ));


```

#### [Plot Residual by Predicted](#plot-residual-by-predicted)

**Syntax:** obj \<< Fit Command( Plot Residual by Predicted( state=0|1 ); obj \<< (Fit[number|name] \<< Plot Residual by Predicted( state=0|1 ))

**Description:** Shows or hides a plot with the residuals on the vertical axis and the row number of the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
fc = Fit Curve( Y( :weight ), X( :height ), Fit Linear() );
fc << (fit[1] << Plot Residual by Predicted( 1 ));


```

#### [Profiler](#profiler)

**Syntax:** obj \<< Fit Command( Profiler( state=0|1 )); obj \<< (Fit[number|name] \<< Profiler( state=0|1 ))

**Description:** Shows or hides a profiler of the fitted prediction function and its first and second derivatives.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    Fit Logistic 4P
);
obj << (Fit["Logistic 4P"] << Profiler( 1 ));


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (Fit[number|name]\<<Remove Fit)

**Description:** Removes the specified fit from the report.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P;
Wait( 2 );
obj << (Fit[1] << Remove Fit);


```

#### [Save Bootstrap Results](#save-bootstrap-results)

**Syntax:** obj \<< Fit Command( Save Bootstrap Results ); obj \<< (Fit[number] \<< Save Bootstrap Results)

**Description:** Saves columns to a new data table. The data table contains the bootstrap results from either an F1 or an F2 analysis.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, Dissolution 360 ),
    Group( :Batch ),
    Z( :Polymer A, :Polymer B, :Total Polymer, :Compression Force ),
    F2 Analysis(
        Alpha( 0.1 ),
        Reference Level( "R01" ),
        Bootstrap Samples( 2500 ),
        Random Seed( 1234 )
    ),
    SendToReport(
        Dispatch( {"Fit Curve"}, "Plot", OutlineBox, {Close( 1 )} ),
        Dispatch( {"Fit Curve", "F2 Analysis"}, "Comparisons", OutlineBox, {Close( 1 )} )
    )
);
obj << (fit[1] << Save Bootstrap Results);


```

#### [Save First Derivative](#save-first-derivative)

**Syntax:** obj \<< Fit Command( Save First Derivative ); obj \<< (Fit[number|name] \<< Save First Derivative)

**Description:** Saves a new formula column to the original data table. The new column contains the formula for the first derivative of the prediction.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Save First Derivative );


```

#### [Save Inverse Prediction Formula](#save-inverse-prediction-formula)

**Syntax:** obj \<< Fit Command( Save Inverse Prediction Formula ); obj \<< (Fit[number|name] \<< Save Inverse Prediction Formula)

**Description:** Saves a new formula column to the original data table. The new column contains the formula for the inverse function of the fitted model.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Save Inverse Prediction Formula );


```

#### [Save Parametric Prediction Formula](#save-parametric-prediction-formula)

**Syntax:** obj \<< Fit Command( Save Parametric Prediction Formula ); obj \<< (Fit[number|name] \<< Save Parametric Prediction Formula)

**Description:** Saves a new formula column to the original data table. The new column contains the prediction formula expressed in a way that can be used by the Nonlinear platform.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    Fit Logistic 4P
);
obj << (Fit["Logistic 4P"] << Save Parametric Prediction Formula);


```

#### [Save Prediction Formula](#save-prediction-formula_1)

**Syntax:** obj \<< Fit Command( Save Prediction Formula ); obj \<< (Fit[number|name] \<< Save Prediction Formula)

**Description:** Saves a new formula column to the original data table. The new column contains the prediction formula for the current parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve(
    Y( :Toxicity ),
    X( :log Conc ),
    Group( :formulation ),
    Fit Logistic 4P
);
obj << (Fit[1] << Save Prediction Formula);


```

#### [Save Residual Formula](#save-residual-formula)

**Syntax:** obj \<< Fit Command( Save Residual Formula ); obj \<< (Fit[number|name] \<< Save Residual Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the residuals.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Save Residual Formula );


```

#### [Save Stacked Data](#save-stacked-data)

**Syntax:** obj \<< Fit Command( Save Stacked Data ); obj \<< (Fit[number|name] \<< Save Stacked Data)

**Description:** Saves columns to a new data table. The data table contains the original data in the stacked format as well as a column for the predicted values of the response and a column for the residuals.

```

dt = Open( "$SAMPLE_DATA/Dissolution DoE.jmp" );
obj = dt << Fit Curve(
    Data Format( Row ),
    Y( :Dissolution 60, :Dissolution 120, :Dissolution 240, :Dissolution 360 ),
    Group( :Batch )
);
obj << Fit Higuchi( Save Stacked Data );


```

#### [Save Std Error of First Derivative](#save-std-error-of-first-derivative)

**Syntax:** obj \<< Fit Command( Save Std Error of First Derivative ); obj \<< (Fit[number|name] \<< Save Std Error of First Derivative)

**Description:** Saves a new column to the original data table. The new column contains the formula for the standard error of the first derivative of the prediction.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Save First Derivative, Save Std Error of First Derivative );


```

#### [Save Std Error of Predicted](#save-std-error-of-predicted)

**Syntax:** obj \<< Fit Command( Save Std Error of Predicted ); obj \<< (Fit[number|name] \<< Save Std Error of Predicted)

**Description:** Saves a new formula column to the original data table. The new column contains the formula to calculate the standard errors of the predictions.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Save Prediction Formula, Save Std Error of Predicted );


```

#### [Save Studentized Residual Formula](#save-studentized-residual-formula)

**Syntax:** obj \<< Fit Command( Save Studentized Residual Formula ); obj \<< (Fit[number|name] \<< Save Studentized Residual Formula)

**Description:** Saves a new formula column to the original data table. The new column contains the formula for the Studentized residuals, which are standard residuals divided by their estimated standard deviations.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Save Studentized Residual Formula );


```

#### [Test Parallelism](#test-parallelism)

**Syntax:** obj \<< Fit Command( Test Parallelism( state=0|1 )); obj \<< (Fit[number|name] \<< Test Parallelism( state=0|1 ))

**Description:** Tests whether the fitted curves have a similar shape across groups.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
obj = dt << Fit Curve( Y( :Toxicity ), X( :log Conc ), Group( :formulation ) );
obj << Fit Logistic 4P( Test Parallelism( 1 ) );


```

#### [Time to Peak Response](#time-to-peak-response)

**Syntax:** obj \<< Fit Command( Time to Peak Response( state=0|1 )); obj \<< (Fit[number|name] \<< Time to Peak Response( state=0|1 ))

**Description:** Calculates the estimate of the X variable at the peak of the fitted curve. This option is available only for Cell Growth 4P and One Compartment models.

**JMP Version Added:** 15

```

dat = [0 0, .27 1.72, .52 7.91, 1 8.31, 1.92 8.33, 3.5 6.85, 5.02 6.08, 7.03 5.4, 9 4.55, 12
3.01, 24.3 .9];
dt = As Table( dat );
Column( dt, 1 ) << set name( "time" );
Column( dt, 2 ) << set name( "concentration" );
obj = dt << Fit Curve( Y( :concentration ), X( :time ) );
obj << Fit One Compartment Oral Dose( Time to Peak Response( 1 ) );


```

# [Fit Definitive Screening](#fit-definitive-screening)

## [Associated Constructors](#associated-constructors)

### [Fit Definitive Screening](#fit-definitive-screening_1)

**Syntax:** Fit Definitive Screening( Y( column ), X( columns ) )

**Description:** Analyzes definitive screening designs (DSDs) using a methodology called Effective Model Selection for DSDs. This algorithm uses the unique structure of the design to identify main and second-order effects.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);


```

## [Item Messages](#item-messages)

### [Interactions Obey Strong Heredity](#interactions-obey-strong-heredity)

**Syntax:** obj \<< Interactions Obey Strong Heredity( state=0|1 )

**JMP Version Added:** 14

### [Make Model Callback](#make-model-callback)

**Syntax:** obj \<< Make Model Callback

**JMP Version Added:** 14

### [Quadratic Terms Obey Strong Heredity](#quadratic-terms-obey-strong-heredity)

**Syntax:** obj \<< Quadratic Terms Obey Strong Heredity( state=0|1 )

**JMP Version Added:** 14

### [Run Model Callback](#run-model-callback)

**Syntax:** obj \<< Run Model Callback

**JMP Version Added:** 14

### [Set Stage 1 p value](#set-stage-1-p-value)

**Syntax:** obj \<< Set Stage 1 p value

**JMP Version Added:** 15

### [Set Stage 2 ratio](#set-stage-2-ratio)

**Syntax:** obj \<< Set Stage 2 ratio

**JMP Version Added:** 15

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Extraction Data.jmp" );
obj = dt << Fit Definitive Screening(
    Y( :Yield ),
    X( :Methanol, :Ethanol, :Propanol, :Butanol, :pH, :Time )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Fit Group Orthogonal Supersaturated](#fit-group-orthogonal-supersaturated)

## [Associated Constructors](#associated-constructors)

### [Fit Group Orthogonal Supersaturated](#fit-group-orthogonal-supersaturated_1)

**Syntax:** Fit Group Orthogonal Supersaturated( Y( column ), X( columns ) )

**Description:** Analyzes a group orthogonal supersaturated design. A group orthogonal supersaturated design is one with fewer observations than model parameters, where the main effects cannot all be estimated simultaneously.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );


```

## [Columns](#columns)

### [X](#x)

**Syntax:** obj \<< X( column(s) )

**JMP Version Added:** 15

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

**JMP Version Added:** 15

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

d = DOE(
    Group Orthogonal Supersaturated Design,
    Make Design,
    Simulate Responses( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated(
    X( 1 :: 7 ),
    Y( :Response ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

d = DOE(
    Group Orthogonal Supersaturated Design,
    Make Design,
    Simulate Responses( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated(
    X( 1 :: 7 ),
    Y( :Response ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

d = DOE( Group Orthogonal Supersaturated Design, Make Design, Simulate Responses( 1 ) );
dt = d << make table;
Wait( 1 );
dt << Fit Group Orthogonal Supersaturated( X( 1 :: 7 ), Y( :Response ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Fit Group](#fit-group)

## [Associated Constructors](#associated-constructors)

### [Fit Group](#fit-group_1)

**Syntax:** Fit Group( model1, model2, ... ); Fit Group( model1; model2; ... )

**Description:** Groups separate least squares, nonlinear, neural, gaussian processing, and mixed model fits in the same output window with a shared profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);


```

## [Item Messages](#item-messages)

### [Arrange in Rows](#arrange-in-rows)

**Syntax:** obj \<< Arrange in Rows( number )

**Description:** Rearranges the reports for the platform analyses in a specified number of rows.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
Wait( 1 );
obj << Arrange in Rows( 2 );


```

### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides a contour profiler for all responses. You can explore the effects of model terms on all responses simultaneously.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Contour Profiler( 1 );


```

### [Order by Goodness of Fit](#order-by-goodness-of-fit)

**Syntax:** obj \<< Order by Goodness of Fit

**Description:** Sorts the reports by significance of fit, where significance is measured by the R-square statistic for each model. This option is applicable only for platforms that surface the R-square statistic to the platform level.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Bivariate( Y( :HARDNESS ), X( :SILICA, :SILANE, :SULFUR ), Fit Line( 1 ) ),
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    )
);
Wait( 1 );
obj << Order by Goodness of Fit;


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides a prediction profiler for all responses. You can view the effects of model terms on all responses simultaneously. You can also perform multiple optimizations across the responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Profiler( 1 );


```

### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides separate surface profiler reports for each response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Surface Profiler( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Group(
    Fit Model(
        Y( :ABRASION ),
        Effects(
            :SILICA & RS, :SILANE & RS, :SULFUR & RS, :SILICA * :SILICA, :SILICA * :SILANE,
            :SILANE * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR, :SULFUR * :SULFUR
        ),
        Personality( "Standard Least Squares" ),
        Emphasis( "Minimal Report" ),
        Run
    ),
    Gaussian Process(
        Y( :HARDNESS ),
        X( :SILICA, :SILANE, :SULFUR ),
        Set Correlation Function( "Cubic" )
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Fit Life by X](#fit-life-by-x)

## [Associated Constructors](#associated-constructors)

### [Fit Life by X](#fit-life-by-x_1)

**Syntax:** Fit Life by X( Y( column ), X( column ), Relationship( string ), Distribution( string ), \<Censor( column )> )

**Description:** Analyzes the distribution of time-to-event data parameterized by a single regression factor. Analysis options include accelerated failure models, life distributions across groups, and transformations of regression factors.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    Freq( :_freqcol )
);


```

### [Time to Event](#time-to-event)

**Syntax:** obj \<< Time to Event( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);


```

### [X](#x)

**Syntax:** obj \<< X( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);


```

## [Item Messages](#item-messages)

### [Add Density Curve to Scatterplot](#add-density-curve-to-scatterplot)

**Syntax:** obj \<< Add Density Curve to Scatterplot( number )

**Description:** Adds a density curve to the scatterplot at the specified value of the X variable. Density curves are drawn for each distribution that is selected in the legend. The legend is located to the right of the scatterplot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
Wait( 1 );
obj << Add Density Curve to Scatterplot( 50 );


```

### [Add Quantile Line to Scatterplot](#add-quantile-line-to-scatterplot)

**Syntax:** obj \<< Add Quantile Line to Scatterplot( quantile )

**Description:** Adds a line to the scatterplot at the specified quantile. A quantile line is drawn for each distribution that is selected in the legend. The legend is located to the right of the scatterplot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
Wait( 1 );
obj << Add Quantile Line to Scatterplot( 0.1 );


```

### [Censor Code](#censor-code)

**Syntax:** obj = Fit Life by X(...Censor Code( value=1 )...)

**Description:** Identifies the value in the Censor column that designates right-censored observations. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Status ),
    Freq( :Weight ),
    Censor Code( "Censored" ),
    Relationship( Arrhenius Celsius )
);


```

### [Confidence Interval Method](#confidence-interval-method)

**Syntax:** obj = Fit Life by X(...Confidence Interval Method( method="Wald" )...)

**Description:** Specifies the method that is used to compute confidence intervals for the parameters. Choose between the Wald and Likelihood methods. The Wald method is an approximation and runs faster. The Likelihood method provides more precise parameters but takes longer to compute. "Wald" by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    Confidence Interval Method( "Likelihood" )
);


```

### [Density](#density)

**Syntax:** obj \<< Density( Weibull|Lognormal|Loglogistic|Frechet| SEV|Normal|Logistic|LEV, t, x )

**Description:** Returns the density for a specified distribution at a life value of t and covariate value of x.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
d = obj << Density( Lognormal, 30000, 10 );
Show( d );


```

### [Distribution](#distribution)

**Syntax:** obj = Fit Life by X(...Distribution( Weibull|Lognormal|Loglogistic|Frechet |SEV|Log|Normal|Logistic|LEV )...)

**Description:** Specifies the distribution that is used to model the relationship between the X and Y variables.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Frechet ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);


```

### [Fit All Distributions](#fit-all-distributions)

**Syntax:** obj \<< Fit All Distributions

**Description:** Fits all available distributions to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit All Distributions;


```

### [Fit Exponential](#fit-exponential)

**Syntax:** obj \<< Fit Exponential

**Description:** Fits an exponential distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit Exponential;


```

### [Fit Frechet](#fit-frechet)

**Syntax:** obj \<< Fit Frechet

**Description:** Fits a Fréchet distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit Frechet;


```

### [Fit LEV](#fit-lev)

**Syntax:** obj \<< Fit LEV

**Description:** Fits a largest extreme value (LEV) distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit LEV;


```

### [Fit Logistic](#fit-logistic)

**Syntax:** obj \<< Fit Logistic

**Description:** Fits a logistic distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit Logistic;


```

### [Fit Loglogistic](#fit-loglogistic)

**Syntax:** obj \<< Fit Loglogistic

**Description:** Fits a loglogistic distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit Loglogistic;


```

### [Fit Lognormal](#fit-lognormal)

**Syntax:** obj \<< Fit Lognormal

**Description:** Fits a lognormal distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Weibull ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit Lognormal;


```

### [Fit Normal](#fit-normal)

**Syntax:** obj \<< Fit Normal

**Description:** Fits a normal distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit Normal;


```

### [Fit SEV](#fit-sev)

**Syntax:** obj \<< Fit SEV

**Description:** Fits a smallest extreme value (SEV) distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit SEV;


```

### [Fit Weibull](#fit-weibull)

**Syntax:** obj \<< Fit Weibull

**Description:** Fits a Weibull distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Inverse Power ),
    Freq( :Weight ),
    Show Density Curves( 1 )
);
Wait( 1 );
obj << Fit Weibull;


```

### [Get Results](#get-results)

**Syntax:** obj \<< Get Results

**Description:** Returns the estimates, standard errors, covariance matrix, and convergence results for each distribution fit.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Nested Model Tests( Regression )
);
r = obj << Get Results;
Show( r );


```

### [Hazard](#hazard)

**Syntax:** obj \<< Hazard( Weibull|Lognormal|Loglogistic|Frechet| SEV|Normal|Logistic|LEV, t, x )

**Description:** Returns the hazard for a specified distribution at a life value of t and covariate value of x.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
h = obj << Hazard( Lognormal, 30000, 10 );
Show( h );


```

### [Maximum Iterations](#maximum-iterations)

**Syntax:** obj \<< Maximum Iterations( number )

**Description:** Specifies the maximum number of iterations that are used to find convergence.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Frechet ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Maximum Iterations( 20 ),
    Nested Model Tests( Regression )
);


```

### [Nested Model Tests](#nested-model-tests)

**Syntax:** obj \<< Nested Model Tests( Saturated Location|Location|Location and Scale|Saturated Location and Scale|Regression|No Effect )

**Description:** Appends a nonparametric overlay plot, nested model tests, and a multiple probability plot to the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    Nested Model Tests( Regression )
);


```

### [Probability](#probability)

**Syntax:** obj \<< Probability( Weibull|Lognormal|Loglogistic|Frechet| SEV|Normal|Logistic|LEV, t, x )

**Description:** Returns the probability for a specified distribution at a life value of t and covariate value of x.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
p = obj << Probability( Lognormal, 30000, 10 );
Show( p );


```

### [Quantile](#quantile)

**Syntax:** obj \<< Quantile( Weibull|Lognormal|Loglogistic|Frechet| SEV|Normal|Logistic|LEV, p, x )

**Description:** Returns the quantile for a specified distribution at a probability of p and covariate value of x.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
q = obj << Quantile( Lognormal, 0.005, 10 );
Show( q );


```

### [Rejection Sampler Maximum Trials](#rejection-sampler-maximum-trials)

**Syntax:** obj \<< Rejection Sampler Maximum Trials( number=10000 )

**Description:** "10000" by default.

**JMP Version Added:** 14

### [Relationship](#relationship)

**Syntax:** obj = Fit Life by X(...Relationship( Arrhenius Celsius|Arrhenius Fahrenheit|Arrhenius Kelvin|Inverse Power|Linear|Log|Logit|Reciprocal|Square Root|Box-Cox|Custom|No Effect|Location|Location and Scale )...)

**Description:** Identifies the transformation relationship between the event and the factor.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Frechet ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Inverse Power )
);


```

### [Set Level of Quantile Line CI Bands](#set-level-of-quantile-line-ci-bands)

**Syntax:** obj \<< Set Level of Quantile Line CI Bands( alpha=0.95 )

**Description:** Specifies the confidence level for the confidence intervals around the quantile lines.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
obj << Add Quantile Line to Scatterplot( 0.1 );
obj << Show Quantile Line CI Bands( 1 );
Wait( 1 );
obj << Set Level of Quantile Line CI Bands( .90 );


```

### [Set Scale](#set-scale)

**Syntax:** obj \<< Set Scale( Weibull|Lognormal|Loglogistic|Frechet|SEV |Normal|Logistic|LEV|Linear )

**Description:** Specifies the scale that is used for the Nonparametric Overlay plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Nested Model Tests( Regression )
);
Wait( 1 );
obj << Set Scale( Logistic );


```

### [Set Scriptables](#set-scriptables)

**Syntax:** obj \<< Set Scriptables( {\<Distribution Comparisons( options )>, \<Quantile Comparisons( options )>, \<Hazard Comparisons( options )>, \<Density Comparisons( options )>} )

**Description:** Sets scriptable options within the profilers in different sections of the output.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
obj << Set Scriptables(
    {Distribution Comparisons( Profiler( 1, Term Value( Temp( 50 ), Hours( 2600 ) ) ) )}
);


```

### [Show Density Curves](#show-density-curves)

**Syntax:** obj \<< Show Density Curves( state=0|1 )

**Description:** Shows or hides density curves on the scatterplot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
Wait( 1 );
obj << Show Density Curves( 1 );


```

### [Show Overlay by Levels](#show-overlay-by-levels)

**Syntax:** obj \<< Show Overlay by Levels( state=0|1 )

**Description:** Shows or hides the Overlay by Levels plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Location ),
    Freq( :Weight )
);
rpt = obj << report;
rpt["Scatterplot"] << Close( 1 );
rpt["Nonparametric Overlay"] << Close( 1 );
rpt["Comparisons"] << Close( 1 );
rpt[TabListBox( 2 )] << SetSelected( 2 );
rpt["Overlay by Levels"] << Close( 0 );
Wait( 1 );
obj << Show Overlay by Levels( 0 );
Wait( 1 );
obj << Show Overlay by Levels( 1 );


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the data points in the Nonparametric Overlay plot and in the Multiple Probability Plots. If the points are hidden, step functions are shown instead. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Nested Model Tests( Regression )
);
Wait( 1 );
obj << Show Points( 0 );
Wait( 1 );
obj << Show Points( 1 );


```

### [Show Quantile Line CI Bands](#show-quantile-line-ci-bands)

**Syntax:** obj \<< Show Quantile Line CI Bands( state=0|1 )

**Description:** Shows or hides confidence intervals around the quantile lines.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
obj << Add Quantile Line to Scatterplot( 0.1 );
Wait( 1 );
obj << Show Quantile Line CI Bands( 1 );


```

### [Show Surface Plot](#show-surface-plot)

**Syntax:** obj \<< Show Surface Plot( state=0|1 )

**Description:** Shows or hides the surface plots in the individual distribution results section of the report. Surface plots appear in the Distribution, Quantile, Hazard, and Density sections for the individual distributions.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
rpt = obj << report;
rpt["Scatterplot"] << Close( 1 );
rpt["Comparisons"] << Close( 1 );
rpt[TabListBox( 2 )] << SetSelected( 2 );
rpt["Lognormal"] << Close( 0 );
Wait( 1 );
obj << Show Surface Plot( 0 );
Wait( 1 );
obj << Show Surface Plot( 1 );


```

### [TAF](#taf)

**Syntax:** obj \<< TAF( Weibull|Lognormal|Loglogistic|Frechet, value, x )

**Description:** Returns the Time Acceleration Factor for a specified distribution, acceleration condition x, and baseline condition value.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
af = obj << TAF( Lognormal, 10, 40 );
Show( af );


```

### [Tabbed Individual Report](#tabbed-individual-report)

**Syntax:** obj \<< Tabbed Individual Report( state=0|1 )

**Description:** Organizes the individual reports into tab panels. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Nested Model Tests( Regression )
);
rpt = obj << report;
rpt["Scatterplot"] << Close( 1 );
rpt["Comparisons"] << Close( 1 );
Wait( 1 );
obj << Tabbed Individual Report( 0 );


```

### [Tabbed Overall Report](#tabbed-overall-report)

**Syntax:** obj \<< Tabbed Overall Report( state=0|1 )

**Description:** Organizes the overall report into tab panels for the plots, comparisons, and results sections of the overall report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight ),
    Nested Model Tests( Regression )
);
Wait( 1 );
obj << Tabbed Overall Report( 1 );


```

### [Time Acceleration Baseline](#time-acceleration-baseline)

**Syntax:** obj \<< Time Acceleration Baseline( number )

**Description:** Specifies the use condition for the acceleration factor.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
obj << Time Acceleration Baseline( 20 );


```

### [Transposed Axes](#transposed-axes)

**Syntax:** obj \<< Transposed Axes( state=0|1 )

**Description:** Specifies that the accelerating factor appears on the vertical axis instead of the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
Wait( 1 );
obj << Transposed Axes( 1 );


```

### [Use Transformation Scale](#use-transformation-scale)

**Syntax:** obj \<< Use Transformation Scale( state=0|1 )

**Description:** Specifies that the transformation scale is used for the accelerating factor axis in the scatterplot. This option switches between the linear and nonlinear scales for the accelerating factor axis. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Relationship( Arrhenius Celsius ),
    Freq( :Weight )
);
Wait( 1 );
obj << Use Transformation Scale( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Fit Life by X(
    Y( :Hours ),
    X( :Temp ),
    Distribution( Lognormal ),
    Censor( :Censor ),
    Freq( :Weight ),
    Relationship( Arrhenius Celsius )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Fit Life by X(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Fit Model](#fit-model)

## [Fit Causal Treatment](#fit-causal-treatment)

### [Associated Constructors](#associated-constructors)

#### [Fit Causal Treatment](#fit-causal-treatment_1)

**Syntax:** Fit Model( Y( columns ), \<Effects( columns )>, Treatment( column ), Personality( "Causal Treatment" ) )

**Description:** Fits models for a causal treatment where adjustments are made for the probability of a treatment.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);


```

### [Item Messages](#item-messages)

#### [Fit](#fit)

**Syntax:** Fit Model(...Run( Fit( options ) )...); obj \<< Fit( options ); obj \<< (Fit[number] \<< option)

**Description:** Enables you to send messages to the platform. This option can be used in a model launch script or to generate a handle to a specific model in the report.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
fm = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run( Fit )
);


```

#### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Enables you to modify some parameter values and run the analysis again. This option is available only for IPWR and AIPW models.

**JMP Version Added:** 19

#### [Model Dialog](#model-dialog)

**Syntax:** obj \<< Model Dialog

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
fm = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
fm << Model Dialog;


```

#### [Show Tips and Interpretations](#show-tips-and-interpretations)

**Syntax:** obj \<< Show Tips and Interpretations( state=0|1 )

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
fm = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
fm << Show Tips and Interpretations;


```

### [Shared Item Messages](#shared-item-messages)

#### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Treatment( :Treatment ),
    Effects( :Age, :Diag Time ),
    Treatment Effects( :Age, :Diag Time, :Cell Type ),
    Personality( "Causal Treatment" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view)

**Syntax:** obj = Fit Causal Treatment(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Generalized Linear Model](#fit-generalized-linear-model)

### [Associated Constructors](#associated-constructors_1)

#### [Generalized Linear Model](#generalized-linear-model)

**Syntax:** Fit Model( Y( column ), Effects( columns ), Personality( "Generalized Linear Model" ), GLM Distribution( distribution name ), Link Function( link type ) )

**Description:** Fits a generalized linear model using various distribution and link functions. Techniques include logistic, Poisson, and exponential regression.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);


```

### [Item Messages](#item-messages_1)

#### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Contour Profiler( 1 );


```

#### [Contrast](#contrast)

**Syntax:** obj \<< (effect name \<< Contrast( [l1 l2 l3 ...] ))

**Description:** Runs a customized F test for the statistical contrasts of treatment levels for an effect in the model. Specify each contrast as a row vector. Note: Specify the effect name as a string.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Overdispersion Tests and Intervals( 0 ),
    "Firth Bias-Adjusted Estimates"n( 0 ),
    Run
);
obj << ("color" << Contrast( [1 0 -0.5 -0.5] ));


```

#### [Correlation of Estimates](#correlation-of-estimates)

**Syntax:** obj \<< Correlation of Estimates( state=0|1 )

**Description:** Shows or hides the matrix of correlations between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Binomial" ),
    Link Function( "Logit" ),
    Run
);
obj << Correlation of Estimates( 1 );


```

#### [Covariance of Estimates](#covariance-of-estimates)

**Syntax:** obj \<< Covariance of Estimates( state=0|1 )

**Description:** Shows or hides the matrix of covariances between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Covariance of Estimates( 1 );


```

#### [Custom Test](#custom-test)

**Syntax:** obj \<< Custom Test( [ l1 l2 l3 ... ], \<Label( name )> )

**Description:** Runs a customized F test that contrasts the different effects in the model.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Overdispersion Tests and Intervals( 0 ),
    "Firth Bias-Adjusted Estimates"n( 0 ),
    Run
);
obj << Custom Test( [0 .5 0 0 0 0 0 .5 -1], Label( "Test 1" ) );


```

#### [Deviance Residuals](#deviance-residuals)

**Syntax:** obj \<< Deviance Residuals

**Description:** Saves a new column to the data table. The new column contains the deviance residuals.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Deviance Residuals;


```

#### [Deviance Residuals by Predicted](#deviance-residuals-by-predicted)

**Syntax:** obj \<< Deviance Residuals by Predicted( state=0|1 )

**Description:** Shows or hides a plot of the deviance residuals on the vertical axis and the predicted response values on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Deviance Residuals by Predicted( 1 );


```

#### [Effect Summary](#effect-summary)

**Syntax:** obj \<< Effect Summary( state=0|1 )

**Description:** Shows or hides the Effect Summary report, which enables you to interactively update the effects in the model. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Effect Summary( 0 );
Wait( 1 );
obj << Effect Summary( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [FDR](#fdr)

**Syntax:** obj \<< FDR( state=0|1 )

**Description:** Specifies whether the logworth values and their corresponding p-values in the Effect Summary table are adjusted using the false discovery rate (FDR).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << FDR( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Firth Bias-Adjusted Estimates](#firth-bias-adjusted-estimates)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), "Firth Bias-Adjusted Estimates"n( state=0|1 )...)

**Description:** Specifies that the Firth bias-adjusted method is used to fit the model. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);


```

#### [GLM Distribution](#glm-distribution)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), GLM Distribution( distribution name )...)

**Description:** Specifies a probability distribution for the response variable. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Binomial" ),
    Link Function( "Logit" ),
    Run
);


```

#### [Inverse Prediction](#inverse-prediction)

**Syntax:** obj \<< Inverse Prediction( Response( p1, p2, ... ), Term Value( effect1( value ), effect2( value ), ... ) )

**Description:** Generates a predicted X value and confidence interval based on the specified values of Y and all other factors.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Overdispersion Tests and Intervals( 0 ),
    "Firth Bias-Adjusted Estimates"n( 0 ),
    Run
);
// Exactly one term value must be set to missing.
obj << Inverse Prediction(
    Response( 5, 6 ),
    Term Value(
        color( "Dark" ),
        spine( "Both Good" ),
        width( 26.2988439306358 ),
        weight( . )
    )
);


```

#### [Linear Predictor Plot](#linear-predictor-plot)

**Syntax:** obj \<< Linear Predictor Plot( state=0|1 )

**Description:** Shows or hides a plot of responses transformed by the inverse link function on the vertical axis and the continuous predictor on the horizontal axis. Available only when there is one continuous predictor and no more than one categorical predictor.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :weight, :color ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run()
);
obj << Linear Predictor Plot( 1 );


```

#### [Link Function](#link-function)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), Link Function( link type )...)

**Description:** Specifies the link function for the model. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);


```

#### [Mean Confidence Interval](#mean-confidence-interval)

**Syntax:** obj \<< Mean Confidence Interval

**Description:** Saves new columns to the data table. The new columns contain the 95% confidence limits for the prediction equation for the model.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Mean Confidence Interval;


```

#### [Model Dialog](#model-dialog_1)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Model Dialog;


```

#### [Overdispersion Tests and Intervals](#overdispersion-tests-and-intervals)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), Overdispersion Tests and Intervals( state=0|1 )...)

**Description:** Specifies that an overdispersion parameter should be included in the model. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    Overdispersion Tests and Intervals( 1 ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);


```

#### [Pearson Residuals](#pearson-residuals)

**Syntax:** obj \<< Pearson Residuals

**Description:** Saves a new column to the data table. The new column contains the Pearson residuals.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Pearson Residuals;


```

#### [Pearson Residuals by Predicted](#pearson-residuals-by-predicted)

**Syntax:** obj \<< Pearson Residuals by Predicted( state=0|1 )

**Description:** Shows or hides a plot of the Pearson residuals on the vertical axis and the predicted response values on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Pearson Residuals by Predicted( 1 );


```

#### [Power Link Parameter](#power-link-parameter)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), Power Link Parameter( value=1 )...)

**Description:** Specifies the parameter for the Power link function. Available only when Power is specified as the link function in the Generalized Linear Model personality. "1" by default.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    Overdispersion Tests and Intervals( 1 ),
    GLM Distribution( "Poisson" ),
    Link Function( "Power" ),
    Power Link Parameter( 0.5 ),
    Run
);


```

#### [Predicted Values](#predicted-values)

**Syntax:** obj \<< Predicted Values

**Description:** Saves a new column to the data table. The new column contains the values predicted by the model.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Predicted Values;


```

#### [Prediction Formula](#prediction-formula)

**Syntax:** obj \<< Prediction Formula

**Description:** Saves a new formula column to the data table. The new column contains a formula for the predicted values for the mean, as computed by the specified model.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Prediction Formula;


```

#### [Prediction and Interval Formulas](#prediction-and-interval-formulas)

**Syntax:** obj \<< Prediction and Interval Formulas

**Description:** Saves new columns to the data table. The columns contain formulas for the predictions and confidence limits. The limits columns that are created by this option contain properties that are used by the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Prediction and Interval Formulas;


```

#### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Binomial" ),
    Link Function( "Logit" ),
    Run
);
obj << Profiler( 1 );


```

#### [Regression Plot](#regression-plot)

**Syntax:** obj \<< Regression Plot( state=0|1 )

**Description:** Shows or hides a plot of the response on the vertical axis and the continuous predictor on the horizontal axis. Available only when there is one continuous predictor and no more than one categorical predictor. On by default.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :weight, :color ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run( Regression Plot( 0 ) )
);
Wait( 1 );
obj << Regression Plot( 1 );


```

#### [Save Indiv Confid Limits](#save-indiv-confid-limits)

**Syntax:** obj \<< Save Indiv Confid Limits

**Description:** Saves new columns to the data table. The new columns contain the 95% confidence limits for a given individual value for the model.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Save Indiv Confid Limits;


```

#### [Studentized Deviance Residuals](#studentized-deviance-residuals)

**Syntax:** obj \<< Studentized Deviance Residuals

**Description:** Saves a new column to the data table. The new column contains the studentized deviance residuals.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Studentized Deviance Residuals;


```

#### [Studentized Deviance Residuals by Predicted](#studentized-deviance-residuals-by-predicted)

**Syntax:** obj \<< Studentized Deviance Residuals by Predicted( state=0|1 )

**Description:** Shows or hides a plot of studentized deviance residuals on the vertical axis and the predicted response values on the horizontal axis. On by default.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run( Studentized Deviance Residuals by Predicted( 0 ) )
);
Wait( 1 );
obj << Studentized Deviance Residuals by Predicted( 1 );


```

#### [Studentized Pearson Residuals](#studentized-pearson-residuals)

**Syntax:** obj \<< Studentized Pearson Residuals

**Description:** Saves a new column to the data table. The new column contains the studentized Pearson residuals.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Studentized Pearson Residuals;


```

#### [Studentized Pearson Residuals by Predicted](#studentized-pearson-residuals-by-predicted)

**Syntax:** obj \<< Studentized Pearson Residuals by Predicted( state=0|1 )

**Description:** Shows or hides a plot of the studentized Pearson residuals on the vertical axis and the predicted response values on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Studentized Pearson Residuals by Predicted( 1 );


```

#### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides an interactive surface plot for the response.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Surface Profiler( 1 );


```

### [Shared Item Messages](#shared-item-messages_1)

#### [Action](#action_1)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_1)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Broadcast](#broadcast_1)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_1)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_1)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_1)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_1)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_1)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_1)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_1)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_1)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_1)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_1)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_1)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_1)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_1)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_1)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_1)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_1)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_1)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_1)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_1)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_1)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_1)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_1)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_1)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_1)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_1)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_1)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_1)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_1)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_1)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_1)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_1)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_1)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_1)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_1)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_1)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_1)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_1)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_1)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_1)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_1)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_1)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_1)

**Syntax:** obj = Generalized Linear Model(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Least Squares > Effect Fit > Control Differences Chart](#fit-least-squares-effect-fit-control-differences-chart)

### [Item Messages](#item-messages_2)

#### [Point Options](#point-options)

**Syntax:** scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Drug << {LSMeans Dunnett(
            .05,
            Control Level( "a" ),
            Control Differences Chart( 1, Point Options( "Show Only Points" ) )
        )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["Control Differences"] << get scriptable object);
scrobj << Point Options( "Show Connected Points" );


```

#### [Show Center Line](#show-center-line)

**Syntax:** scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line (overall mean) on the Control Differences chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Drug << {LSMeans Dunnett(
            .05,
            Control Level( "a" ),
            Control Differences Chart( 1, Show Center Line( 0 ) )
        )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["Control Differences"] << get scriptable object);
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading)

**Syntax:** scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading for the Control Differences chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Drug << {LSMeans Dunnett(
            .05,
            Control Level( "a" ),
            Control Differences Chart( 1, Show Decision Limit Shading( 0 ) )
        )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["Control Differences"] << get scriptable object);
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits)

**Syntax:** scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines for the Control Differences chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Drug << {LSMeans Dunnett(
            .05,
            Control Level( "a" ),
            Control Differences Chart( 1, Show Decision Limits( 0 ) )
        )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["Control Differences"] << get scriptable object);
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report)

**Syntax:** scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the group means and the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Drug << {LSMeans Dunnett(
            .05,
            Control Level( "a" ),
            Control Differences Chart( 1 )
        )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["Control Differences"] << get scriptable object);
scrobj << Show Summary Report( 1 );


```

## [Fit Least Squares > Effect Fit](#fit-least-squares-effect-fit)

### [Item Messages](#item-messages_3)

#### [LSMeans Contrast](#lsmeans-contrast)

**Syntax:** scrobj \<< LSMeans Contrast( [ l1, l2, l3, ... ] ); obj \<< ( effect \<< {LSMeans Contrast( [ l1, l2, l3, ... ] )} )

**Description:** Runs a customized F test for the statistical contrasts of different levels of an effect.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
Wait( 1 );
obj << (:Drug << {LSMeans Contrast( [1 0 -1] )});


```

#### [LSMeans Dunnett](#lsmeans-dunnett)

**Syntax:** scrobj \<< LSMeans Dunnett( state=0|1|<alpha>, Control Level( level ), <comparison options> ); obj \<< ( effect \<< {LSMeans Dunnett( state=0|1|<alpha>, Control Level( level ), <comparison options> )} )

**Description:** Shows or hides tests and confidence intervals for pairwise comparisons against the specified control level.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
obj << (:Drug << {LSMeans Dunnett( 1, Control Level( "a" ) )});


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
obj << (:Drug << {LSMeans Dunnett( .01, Control Level( "a" ) )});


```

#### [LSMeans Plot](#lsmeans-plot)

**Syntax:** scrobj \<< LSMeans Plot; obj \<< ( effect \<< {LSMeans Plot} )

**Description:** Shows plots of least squares means for nominal and ordinal effects. If the effect is an interaction, this option shows the Least Squares Means Plot Options window.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
Wait( 1 );
obj << (:Drug << {LSMeans Plot});


```

#### [LSMeans Student's t](#lsmeans-students-t)

**Syntax:** scrobj \<< Student's t( state=0|1|<alpha>, <comparison options> ); obj \<< ( effect \<< {Student's t( state=0|1|<alpha>, <comparison options> )} )

**Description:** Shows or hides tests and confidence intervals for pairwise comparisons of least squares means using Student's t tests.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
obj << (:Drug << {LSMeans Student's t( 1 )});


```

#### [LSMeans Table](#lsmeans-table)

**Syntax:** scrobj \<< LSMeans Table( state=0|1 ); obj \<< ( effect \<< {LSMeans Table( state=0|1 )} )

**Description:** Shows or hides a table of the statistics that are compared when effects are tested. This option is not available for continuous effects. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( :Drug << {LSMeans Table( 0 )} )
);
Wait( 1 );
obj << (:Drug << {LSMeans Table( 1 )});


```

#### [LSMeans Tukey HSD](#lsmeans-tukey-hsd)

**Syntax:** scrobj \<< LSMeans Tukey HSD( state=0|1|<alpha>, <comparison options> ); obj \<< ( effect \<< {LSMeans Tukey HSD( state=0|1|<alpha>, <comparison options> )} )

**Description:** Shows or hides tests and confidence intervals for pairwise comparisons of least squares means using the Tukey-Kramer honestly significant difference (HSD) test.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
obj << (:Drug << {LSMeans Tukey HSD( 1 )});


```

#### [Power Analysis](#power-analysis)

**Syntax:** scrobj \<< Power Analysis( Alpha(from, to, by), Sigma(from, to, by), Delta(from, to, by), Number(from, to, by), objective, <Power Plot>, <Done>); obj \<< ( effect \<< {Power Analysis( Alpha(from, to, by), Sigma(from, to, by), Delta(from, to, by), Number(from, to, by), objective, <Power Plot>, <Done>)} )

**Description:** Shows the Power Details report, which enables you to analyze the power for the effect test.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
Wait( 1 );
obj << (:Drug << {Power Analysis(
    Alpha( 0.05 ),
    Sigma( 4.00577754367453 ),
    Delta( 1.51166255719209 ),
    Number( 10, 100, 10 ),
    Solve for Power,
    Power Plot,
    Done
)});


```

#### [Test Slices](#test-slices)

**Syntax:** scrobj \<< Test Slices( state=0|1 ); obj \<< ( response \<< { effect1 * effect2 \<< {Test Slices( state=0|1 )} } )

**Description:** Runs a customized F test for each level of both factors in an interaction term. This option is available only for interactions that involve nominal and ordinal effects.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Model(
    Y( :height ),
    Effects( :age, :sex, :age * :sex ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
Wait( 1 );
obj << (:height << {:age * :sex << {Test Slices( 1 )}});


```

## [Fit Least Squares > LSMeans Comparisons](#fit-least-squares-lsmeans-comparisons)

### [Item Messages](#item-messages_4)

#### [Connecting Letters Report](#connecting-letters-report)

**Syntax:** scrobj \<< Connecting Letters Report( state=0|1 )

**Description:** Shows or hides significant and non-significant comparisons with connecting letters. Levels that are not connected by the same letter are significantly different. Levels that are connected by the same letter are not significantly different. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( :Drug << {LSMeans Tukey HSD( 1, Connecting Letters Report( 0 ) )} )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Tukey HSD"] << get scriptable object);
scrobj << Connecting Letters Report( 1 );


```

#### [Control Differences Chart](#control-differences-chart)

**Syntax:** scrobj \<< Control Differences Chart( state=0|1 )

**Description:** Shows or hides a chart that contains a point for each level of the effect other than the control. Each point shows the least squares mean for that level in relation to the least squares mean for the control level. Upper decision limits (UDL) and lower decision limits (LDL) are plotted.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Drug << {LSMeans Dunnett(
            .05,
            Control Level( "a" ),
            Control Differences Chart( 0 )
        )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Dunnett"] << get scriptable object);
scrobj << Control Differences Chart( 1 );


```

#### [Control Differences Report](#control-differences-report)

**Syntax:** scrobj \<< Control Differences Report( state=0|1 )

**Description:** Shows or hides a table that contains a row for each level of the effect other than the control. Each row contains the level being compared to the control level, the estimated difference, the standard error of the difference, a confidence interval, and the p-value for the comparison. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Drug << {LSMeans Dunnett(
            .05,
            Control Level( "a" ),
            Control Differences Report( 0 )
        )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Dunnett"] << get scriptable object);
scrobj << Control Differences Report( 1 );


```

#### [Crosstab Report](#crosstab-report)

**Syntax:** scrobj \<< Crosstab Report( state=0|1 )

**Description:** Shows or hides a crosstab report that contains the difference in each combination of least squares means, the standard error of the difference, and confidence limits for the difference. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( :Drug << {LSMeans Student's t( 1, Crosstab Report( 0 ) )} )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Student's t"] << get scriptable object);
scrobj << Crosstab Report( 1 );


```

#### [Detailed Comparisons](#detailed-comparisons)

**Syntax:** scrobj \<< Detailed Comparisons( state=0|1 )

**Description:** Shows or hides a detailed report for each combination of least squares means. The report also contains a graph that shows the significance of each comparison.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( :Drug << {LSMeans Student's t( .05 )} )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Student's t"] << get scriptable object);
scrobj << Detailed Comparisons( 1 );


```

#### [Equivalence Test](#equivalence-test)

**Syntax:** scrobj \<< Equivalence Test( difference )

**Description:** Tests that the means do not differ by more than the specified difference that is deemed to be practically equivalent. This is the reverse of the usual significance test.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( :Drug << {LSMeans Student's t( .05 )} )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Student's t"] << get scriptable object);
scrobj << Equivalence Test( 1.5 );


```

#### [Ordered Differences Report](#ordered-differences-report)

**Syntax:** scrobj \<< Ordered Differences Report( state=0|1 )

**Description:** Shows or hides a report that ranks the differences for each level of least squares means from largest to smallest. The report also contains the standard errors of the differences, confidence limits, and p-values.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( :Drug << {LSMeans Tukey HSD( .05 )} )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Tukey HSD"] << get scriptable object);
scrobj << Ordered Differences Report( 1 );


```

#### [Save Connecting Letters Table](#save-connecting-letters-table)

**Syntax:** scrobj \<< Save Connecting Letters Table

**Description:** Creates a data table with columns that contain the levels of the effect, the connecting letters, the least squares means, their standard errors, and confidence intervals.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( :Drug << {LSMeans Student's t( 1 )} )
);
Wait( 1 );
scrobj = (Report( obj )["LSMeans Differences Student's t"] << get scriptable object);
scrobj << Save Connecting Letters Table;


```

## [Fit Least Squares > Multiple Comparisons > All Pairwise Comparisons > Equivalence Tests](#fit-least-squares-multiple-comparisons-all-pairwise-comparisons-equivalence-tests)

### [Item Messages](#item-messages_5)

#### [Forest Plot](#forest-plot)

**Syntax:** scrobj \<< Forest Plot( state=0|1 )

**Description:** Shows or hides the Equivalence Tests Forest Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( Drug ), Equivalence Tests( 5, Forest Plot( 0 ) ) );
Wait( 1 );
scrobj = Report( obj )["Equivalence Tests"] << get scriptable object;
scrobj << Forest Plot( 1 );


```

#### [Remove](#remove)

**Syntax:** scrobj \<< Remove

**Description:** Removes the Equivalence Tests report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( Drug ), Equivalence Tests( 5, Forest Plot( 0 ) ) );
Wait( 2 );
scrobj = Report( obj )["Equivalence Tests"] << get scriptable object;
scrobj << Remove;


```

#### [Scatterplot](#scatterplot)

**Syntax:** scrobj \<< Scatterplot( state=0|1 )

**Description:** Shows or hides the Equivalence Tests Scatterplot. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( Drug ), Equivalence Tests( 5, Scatterplot( 0 ) ) );
Wait( 1 );
scrobj = Report( obj )["Equivalence Tests"] << get scriptable object;
scrobj << Scatterplot( 1 );


```

#### [Test Report](#test-report)

**Syntax:** scrobj \<< Test Report( state=0|1 )

**Description:** Shows or hides the Equivalence Tests report, which contains results of the two one-sided tests (TOST) method that is used to test for a practical difference between the means. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( Drug ), Equivalence Tests( 5, Test Report( 0 ) ) );
Wait( 1 );
scrobj = Report( obj )["Equivalence Tests"] << get scriptable object;
scrobj << Test Report( 1 );


```

## [Fit Least Squares > Multiple Comparisons > All Pairwise Comparisons > Mean Mean Scatterplot](#fit-least-squares-multiple-comparisons-all-pairwise-comparisons-mean-mean-scatterplot)

### [Item Messages](#item-messages_6)

#### [Show Reference Lines](#show-reference-lines)

**Syntax:** scrobj \<< Show Reference Lines( state=0|1 )

**Description:** Shows or hides reference grid lines for the points in the scatterplot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( Drug ), Tukey HSD( 1 ) );
Wait( 1 );
scrobj = Report( obj )["All Pairwise Comparisons Scatterplot"] << get scriptable object;
scrobj << Show Reference Lines( 1 );


```

## [Fit Least Squares > Multiple Comparisons > All Pairwise Comparisons](#fit-least-squares-multiple-comparisons-all-pairwise-comparisons)

### [Item Messages](#item-messages_7)

#### [All Pairwise Comparisons Scatterplot](#all-pairwise-comparisons-scatterplot)

**Syntax:** scrobj \<< All Pairwise Comparisons Scatterplot( state=0|1 )

**Description:** Shows or hides the All Pairwise Comparisons Scatterplot. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( Drug ),
    Tukey HSD( 1, All Pairwise Comparisons Scatterplot( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["Tukey HSD All Pairwise Comparisons"] << get scriptable object);
scrobj << All Pairwise Comparisons Scatterplot( 1 );


```

#### [All Pairwise Differences](#all-pairwise-differences)

**Syntax:** scrobj \<< All Pairwise Differences( state=0|1 )

**Description:** Shows or hides the All Pairwise Differences report. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( Drug ), Tukey HSD( 1, All Pairwise Differences( 0 ) ) );
Wait( 1 );
scrobj = (Report( obj )["Tukey HSD All Pairwise Comparisons"] << get scriptable object);
scrobj << All Pairwise Differences( 1 );


```

#### [All Pairwise Differences Connecting Letters](#all-pairwise-differences-connecting-letters)

**Syntax:** scrobj \<< All Pairwise Differences Connecting Letters( state=0|1 )

**Description:** Shows or hides the All Pairwise Differences Connecting Letters report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Analgesics.jmp" );
obj = dt << Fit Model(
    Y( :pain ),
    Effects( :gender, :drug, :gender * :drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( Drug ),
    Tukey HSD( 1, All Pairwise Differences Connecting Letters( 1 ) )
);


```

#### [Save All Pairwise Differences Connecting Letters Table](#save-all-pairwise-differences-connecting-letters-table)

**Syntax:** scrobj \<< Save All Pairwise Differences Connecting Letters Table

**Description:** Creates a data table with columns that contain the levels of the effect, the connecting letters, the least squares means, their standard errors, and confidence intervals.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Analgesics.jmp" );
obj = dt << Fit Model(
    Y( :pain ),
    Effects( :gender, :drug, :gender * :drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run(
        Multiple Comparisons(
            Effect( Drug ),
            Tukey HSD( 1, All Pairwise Comparisons Scatterplot( 0 ) )
        )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Tukey HSD All Pairwise Comparisons"] << get scriptable object);
scrobj << Save All Pairwise Differences Connecting Letters Table;


```

## [Fit Least Squares > Multiple Comparisons > Comparisons with Control](#fit-least-squares-multiple-comparisons-comparisons-with-control)

### [Item Messages](#item-messages_8)

#### [Calculate Adjusted P-Values](#calculate-adjusted-p-values)

**Syntax:** scrobj \<< "Calculate Adjusted P-Values"n( state=0|1 )

**Description:** Shows or hides a column of p-values in the Differences from Control report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Comparisons with Control( 1, Control Level( "Drug:a" ) )
);
Wait( 1 );
scrobj = (Report( obj )["Comparisons with Control"] << get scriptable object);
scrobj << "Calculate Adjusted P-Values"n( 1 );


```

#### [Comparisons with Control Decision Chart](#comparisons-with-control-decision-chart)

**Syntax:** scrobj \<< Comparisons with Control Decision Chart( state=0|1 )

**Description:** Shows or hides the Comparisons with Control Decision Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Comparisons with Control(
        1,
        Control Level( "Drug:a" ),
        Comparisons with Control Decision Chart( 0 )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Comparisons with Control"] << get scriptable object);
scrobj << Comparisons with Control Decision Chart( 1 );


```

#### [Differences from Control](#differences-from-control)

**Syntax:** scrobj \<< Differences from Control( state=0|1 )

**Description:** Shows or hides the Differences from Control report. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Comparisons with Control( 1, Control Level( "Drug:a" ), Differences from Control( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["Comparisons with Control"] << get scriptable object);
scrobj << Differences from Control( 1 );


```

## [Fit Least Squares > Multiple Comparisons > Comparisons with Overall Average](#fit-least-squares-multiple-comparisons-comparisons-with-overall-average)

### [Item Messages](#item-messages_9)

#### [Calculate Adjusted P-Values](#calculate-adjusted-p-values_1)

**Syntax:** scrobj \<< "Calculate Adjusted P-Values"n( state=0|1 )

**Description:** Shows or hides a column of p-values in the Differences from Overall Averages report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( :Drug ), Comparisons with Overall Average( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Comparisons with Overall Average"] << get scriptable object);
scrobj << "Calculate Adjusted P-Values"n( 1 );


```

#### [Comparisons with Overall Average Decision Chart](#comparisons-with-overall-average-decision-chart)

**Syntax:** scrobj \<< Comparisons with Overall Average Decision Chart( state=0|1 )

**Description:** Shows or hides the Comparisons with Overall Average Decision Chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Comparisons with Overall Average(
        1,
        Comparisons with Overall Average Decision Chart( 0 )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Comparisons with Overall Average"] << get scriptable object);
scrobj << Comparisons with Overall Average Decision Chart( 1 );


```

#### [Differences from Overall Average](#differences-from-overall-average)

**Syntax:** scrobj \<< Differences from Overall Average( state=0|1 )

**Description:** Shows or hides the Differences from Overall Average report. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Comparisons with Overall Average( 1, Differences from Overall Average( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["Comparisons with Overall Average"] << get scriptable object);
scrobj << Differences from Overall Average( 1 );


```

## [Fit Least Squares > Multiple Comparisons > Least Squares Means Plot](#fit-least-squares-multiple-comparisons-least-squares-means-plot)

### [Item Messages](#item-messages_10)

#### [Remove](#remove_1)

**Syntax:** scrobj \<< Remove

**Description:** Removes the Least Squares Means plot from the report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Least Squares Means Plot( Show Connected Points( 0 ) )
);
Wait( 2 );
scrobj = (Report( obj )["Least Squares Means Plot"] << get scriptable object);
scrobj << Remove;


```

#### [Show Confidence Limits](#show-confidence-limits)

**Syntax:** scrobj \<< Show Confidence Limits( state=0|1 )

**Description:** Shows or hides confidence limits for each estimate in the plot. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Least Squares Means Plot( Show Confidence Limits( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["Least Squares Means Plot"] << get scriptable object);
scrobj << Show Confidence Limits( 1 );


```

#### [Show Connected Points](#show-connected-points)

**Syntax:** scrobj \<< Show Connected Points( state=0|1 )

**Description:** Shows or hides one or more lines that connect the least squares means for each level in the plot. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Least Squares Means Plot( Show Connected Points( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["Least Squares Means Plot"] << get scriptable object);
scrobj << Show Connected Points( 1 );


```

## [Fit Least Squares > Multiple Comparisons](#fit-least-squares-multiple-comparisons)

### [Item Messages](#item-messages_11)

#### [Comparisons with Control](#comparisons-with-control)

**Syntax:** scrobj \<< Comparisons with Control( state=0|1, Control Level( level ), <options> ); obj \<< Multiple Comparisons( Effect( effect ), Comparisons with Control( state=0|1, Control Level( level ), <options> ) )

**Description:** Shows or hides a multiple comparisons test that compares each effect least squares mean with the least squares mean of a control level. This is also known as Dunnett's test.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Comparisons with Control( 1, Control Level( "Drug:a" ) )
);


```

#### [Comparisons with Overall Average](#comparisons-with-overall-average)

**Syntax:** scrobj \<< Comparisons with Overall Average( state=0|1, <options> ); obj \<< Multiple Comparisons( Effect( effect ), Comparisons with Overall Average( state=0|1, <options> ) )

**Description:** Shows or hides a multiple comparisons test that compares each effect least squares mean with the overall average least squares mean. This is also known as an analysis of means test.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Multiple Comparisons( Effect( :Drug ), Comparisons with Overall Average( 1 ) );


```

#### [Equivalence Tests](#equivalence-tests)

**Syntax:** scrobj \<< Equivalence Tests( number ); obj \<< Multiple Comparisons( Effect( effect ), Equivalence Tests( number ) )

**Description:** Shows or hides a multiple comparisons test of all pairwise least squares means comparisons against a specified difference that is deemed practically equivalent.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Multiple Comparisons( Effect( :Drug ), Equivalence Tests( 5 ) );


```

#### [Least Squares Means Plot](#least-squares-means-plot)

**Syntax:** scrobj \<< Least Squares Means Plot; obj \<< Multiple Comparisons( Effect( effect ), Least Squares Means Plot )

**Description:** Shows a plot of the least squares means with standard error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Multiple Comparisons( Effect( :Drug ), Least Squares Means Plot );


```

#### [Remove](#remove_2)

**Syntax:** scrobj \<< Remove

**Description:** Removes the Multiple Comparisons report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons( Effect( :Drug ), Least Squares Means Plot );
Wait( 2 );
scrobj = (Report( obj )["Multiple Comparisons for Drug"] << get scriptable object);
scrobj << Remove;


```

#### [Slice F Test](#slice-f-test)

**Syntax:** scrobj \<< Slice F Test( state=0|1 ); obj \<< Multiple Comparisons( Sliced Effect Estimates( Sliced Effect( effect1 * effect2 ), Slice Term List( effect_level ) ), Slice F Test( state=0|1 ) )

**Description:** Shows or hides the F test for the sliced effect. On by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Fit Model(
    Y( :height ),
    Effects( :age, :sex, :age * :sex ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run
);
Wait( 0 );
obj << Multiple Comparisons(
    Sliced Effect Estimates( Sliced Effect( :age * :sex ), Slice Term List( :age( "12" ) ) ),
    Slice F Test( 1 )
);
Wait( 1 );
scrobj = (Report( obj )["Multiple Comparisons for Slice of age*sex where age = 12"] <<
get scriptable object);
scrobj << Slice F Test( 0 );
Wait( 1 );
scrobj << Slice F Test( 1 );


```

#### [Student's t](#students-t)

**Syntax:** scrobj \<< Student's t( state=0|1, <options> ); obj \<< Multiple Comparisons( Effect( effect ), Student's t( state=0|1, <options> ) )

**Description:** Shows or hides a multiple comparisons test of all pairwise least squares means comparisons using the Student's t test.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Student's t( 1, All Pairwise Differences Connecting Letters( 1 ) )
);


```

#### [Tukey HSD](#tukey-hsd)

**Syntax:** scrobj \<< Tukey HSD( state=0|1, <options> ); obj \<< Multiple Comparisons( Effect( effect ), Tukey HSD( state=0|1, <options> ) )

**Description:** Shows or hides a multiple comparisons test of all pairwise least squares means comparisons using the Tukey-Kramer honestly significant differences (HSD) test.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Multiple Comparisons(
    Effect( :Drug ),
    Tukey HSD( 1, All Pairwise Differences Connecting Letters( 1 ) )
);


```

## [Fit Least Squares > REML](#fit-least-squares-reml)

### [Item Messages](#item-messages_12)

#### [Convergence Limit](#convergence-limit)

**Syntax:** obj = Fit Model(...Convergence Limit( number=0.00000001 )...)

**Description:** Specifies the convergence limit for the model fitting. If your model does not readily converge, you might want to increase the convergence limit. By default, the convergence limit is 0.00000001.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Convergence Limit( 0.0001 ),
    Run
);


```

#### [Maximum Iterations](#maximum-iterations)

**Syntax:** obj = Fit Model(...Maximum Iterations( number=100 )...)

**Description:** Specifies the maximum number of iterations that are used in the model fitting. By default, the maximum number of iterations is 100.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Maximum Iterations( 150 ),
    Run
);


```

#### [Method](#method)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Squares" ), Method( "EMS" | "REML" )...)

**Description:** Specifies the method that is used for fitting mixed models in the Standard Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    NoBounds( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

#### [NoBounds](#nobounds)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Squares" ), NoBounds( state=0|1 )...)

**Description:** Removes the limits for variance estimations. When off, the lower limit for variance estimations is set to zero. Available only for the Standard Least Squares personality. On by default.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    NoBounds( 0 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

## [Fit Least Squares > Response Fit](#fit-least-squares-response-fit)

### [Item Messages](#item-messages_13)

#### [AICc](#aicc)

**Syntax:** obj \<< AICc( state=0|1 )

**Description:** Shows or hides the corrected Akaike's Information Criterion (AICc) and the Bayesian Information Criterion (BIC) values in the Summary of Fit report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << AICc( 1 );


```

#### [Analysis of Variance](#analysis-of-variance)

**Syntax:** obj \<< Analysis of Variance( state=0|1 )

**Description:** Shows or hides a report that contains statistics for comparing the fitted model to a simple mean model.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Analysis of Variance( 0 ) )
);
Wait( 1 );
obj << Analysis of Variance( 1 );


```

#### [Apply Preset](#apply-preset_2)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Lack of Fit( 0 );
obj << Effect Details( 0 );
Report( obj )["Parameter Estimates"] << Close( 1 );
preset = obj << (:y << New Preset);

dt2 = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj2 = dt2 << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj2 << (:Oxy << Apply Preset( preset ));


```

#### [Bayes Plot](#bayes-plot)

**Syntax:** obj \<< Bayes Plot( K( number ), Priors( p1, p2, p3, ... ), Go )

**Description:** Shows or hides a plot that computes posterior probabilities for all model terms using a Bayesian approach.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Bayes Plot( K( 10 ), Priors( 0.2, 0.2, 0.2, 0.2, 0.2 ), Go );


```

#### [Box Cox Y Transformation](#box-cox-y-transformation)

**Syntax:** obj \<< Box Cox Y Transformation( state=0|1, \<Save Best Transformation( state=0|1 )>, \<Save Specific Transformation( number )>, \<Table of Estimates( state=0|1 )> )

**Description:** Shows or hides the Box-Cox Transformations report, which shows how the fit would change if you refit the model with a power (Box-Cox) transformation on the response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Box Cox Y Transformation( 1, Save Best Transformation( 1 ) );


```

#### [Compare Slopes](#compare-slopes)

**Syntax:** obj \<< Compare Slopes( Effect( effect ), <options> )

**Description:** Generates an analysis of means (ANOM) report that compares interaction slopes with the average slope for an analysis of covariance (ANCOVA) model. This option is available only when there is one nominal effect, one continuous effect, and their interaction effect for the fixed effects.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/US Demographics.jmp" );
obj = dt << Fit Model(
    Y( :Eighth Grade Math ),
    Effects( :Region, :High School Graduates, :Region * :High School Graduates ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Compare Slopes(
    Effect( :Region * :High School Graduates ),
    Student's t( 1, All Pairwise Comparisons Scatterplot( 0 ) )
);


```

#### [Conditional Indiv CI](#conditional-indiv-ci)

**Syntax:** obj \<< Conditional Indiv CI( \<alpha=0.05> )

**Description:** Saves a new column to the data table. The new column contains the confidence interval for the individual value from conditional prediction. The confidence intervals include random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Indiv CI( 0.001 );


```

#### [Conditional Mean CI](#conditional-mean-ci)

**Syntax:** obj \<< Conditional Mean CI( \<alpha=0.05> )

**Description:** Saves a new column to the data table. The new column contains the confidence interval for the expected value from conditional prediction. The confidence intervals include random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Mean CI( 0.01 );


```

#### [Conditional Pred Formula](#conditional-pred-formula)

**Syntax:** obj \<< Conditional Pred Formula

**Description:** Saves a new formula column to the data table. The new column contains a formula that includes random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Pred Formula;


```

#### [Conditional Pred Values](#conditional-pred-values)

**Syntax:** obj \<< Conditional Pred Values

**Description:** Saves a new column to the data table. The new column contains the conditional predicted values that are calculated using the best linear unbiased predictors (BLUPs) for the random effects coefficients. This option is available only for REML analysis methods. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Pred Values;


```

#### [Conditional Residuals](#conditional-residuals)

**Syntax:** obj \<< Conditional Residuals

**Description:** Saves a new column to the data table. The new column contains the residuals from conditional prediction. The residual values include random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Residuals;


```

#### [Contour Profiler](#contour-profiler_1)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time. Available only when the model contains more than one continuous factor.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Contour Profiler( 1 );


```

#### [Cook's D Influence](#cooks-d-influence)

**Syntax:** obj \<< Cook's D Influence

**Description:** Saves a new column to the data table. The new column contains a measure of how much influence each observation has in estimating the model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Cook's D Influence;


```

#### [Correlation of Estimates](#correlation-of-estimates_1)

**Syntax:** obj \<< Correlation of Estimates( state=0|1 )

**Description:** Shows or hides the matrix of correlations between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Correlation of Estimates( 1 );


```

#### [Cox Mixtures](#cox-mixtures)

**Syntax:** obj \<< Cox Mixtures( p1(percentile), p2(percentile), p3(percentile) )

**Description:** Shows or hides parameter estimates for the Cox mixture model based on the specified reference mixture values. This option is available only when the model contains mixture effects.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :p1 & RS & Mixture, :p2 & RS & Mixture, :p3 & RS & Mixture, :p2 * :p1, :p3 * :p1,
        :p3 * :p2
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Cox Mixtures( p1( 0.6615 ), p2( 0.126 ), p3( 0.2125 ) );


```

#### [Cube Plots](#cube-plots)

**Syntax:** obj \<< Cube Plots( state=0|1 )

**Description:** Shows or hides the predicted values for the extremes of the factor ranges laid out in one or more cubes.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Cube Plots( 1 );


```

#### [Custom Test](#custom-test_1)

**Syntax:** obj \<< Custom Test( [l1, l2, l3, ... ], \<Label( text )> )

**Description:** Runs a customized F test that contrasts the different effects in the model.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Custom Test( [0 0 2 1], Label( "Comparison of intercepts for drug a vs. drug" ) );


```

#### [Durbin Watson Test](#durbin-watson-test)

**Syntax:** obj \<< Durbin Watson Test( state=0|1 )

**Description:** Shows or hides the Durbin-Watson report, which contains a statistic to test whether the residuals have first-order autocorrelation. The report also shows the autocorrelation of the residuals and the exact probability associated with the statistic. This option is appropriate only for time series data and assumes that your observations are in time order.

```

dt = Open( "$SAMPLE_DATA/Time Series/CO2.jmp" );
obj = dt << Fit Model(
    Y( :CO2 ),
    Effects( :Year, :Month ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Durbin Watson Test( 1 );


```

#### [Effect Details](#effect-details)

**Syntax:** obj \<< Effect Details( state=0|1 )

**Description:** Shows or hides detailed reports for each effect in the model, including the LS Means table for each categorical effect. Additional information can be shown by sending messages to model effects. See the Effect Fit object under Fit Model for more information. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( Effect Details( 0 ) )
);
Wait( 1 );
obj << Effect Details( 1 );


```

#### [Effect Leverage Pairs](#effect-leverage-pairs)

**Syntax:** obj \<< Effect Leverage Pairs

**Description:** Saves new columns to the data table. The new columns contain the X and Y values that are plotted in effect leverage plots. The Y value is the partial residual. The X value is the regressor shrinkage in the effect leverage plots. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Effect Leverage Pairs;


```

#### [Effect Summary](#effect-summary_1)

**Syntax:** obj \<< Effect Summary( state=0|1 )

**Description:** Shows or hides the Effect Summary report, which enables you to interactively update the effects in the model. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Effect Summary( 0 );
Wait( 1 );
obj << Effect Summary( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Effect Tests](#effect-tests)

**Syntax:** obj \<< Effect Tests( state=0|1 )

**Description:** Shows or hides a report that contains tests for the fixed effects in the model. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Effect Tests( 0 ) )
);
Wait( 1 );
obj << Effect Tests( 1 );


```

#### [Error Specification](#error-specification)

**Syntax:** obj \<< Error Specification( "Default Estimate"|"Pure Error"|"Specified" )

**Description:** Specifies the error variance and the error degrees of freedom that are used for standard errors and tests in the Fit Least Squares report. This option is available only when the model contains no random effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Error Specification( "Pure Error" );


```

#### [Expanded Estimates](#expanded-estimates)

**Syntax:** obj \<< Expanded Estimates( state=0|1 )

**Description:** Shows or hides the parameter estimates for all levels of a nominal model effect. For a nominal effect with k levels, the Parameter Estimates table contains coefficients for the k-1 parameters, and the Expanded Estimates table contains the effect coefficients for all k levels. This option is available only when at least one of the effects is not continuous.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Expanded Estimates( 1 );


```

#### [Externally Studentized Residuals](#externally-studentized-residuals)

**Syntax:** obj \<< Externally Studentized Residuals

**Description:** Saves a new column to the data table. The new column contains the externally studentized residuals. These are the residuals divided by standard error estimates that exclude the current row. Hold down the shift key to enter suffix.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Externally Studentized Residuals;


```

#### [FDR](#fdr_1)

**Syntax:** obj \<< FDR( state=0|1 )

**Description:** Specifies whether the logworth values and their corresponding p-values in the Effect Summary table are adjusted using the false discovery rate (FDR).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << FDR( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Get Conditional Formula](#get-conditional-formula)

**Syntax:** obj \<< Get Conditional Formula

**Description:** Returns a prediction formula that includes random effect estimates.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get Conditional Formula;


```

#### [Get Effect Names](#get-effect-names)

**Syntax:** obj \<< Get Effect Names

**Description:** Returns the effect names.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Effect Names;
Show( G );


```

#### [Get Effect PValues](#get-effect-pvalues)

**Syntax:** obj \<< Get Effect PValues

**Description:** Returns the effect p-values.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Effect PValues;
Show( G );


```

#### [Get Estimates](#get-estimates)

**Syntax:** obj \<< Get Estimates

**Description:** Returns the estimates.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Estimates;
Show( G );


```

#### [Get Indiv Confid Limit Formula](#get-indiv-confid-limit-formula)

**Syntax:** obj \<< Get Indiv Confid Limit Formula

**Description:** Returns a formula for the individual confidence limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get Indiv Confid Limit Formula;


```

#### [Get MM SAS DATA Step](#get-mm-sas-data-step)

**Syntax:** obj \<< Get MM SAS DATA Step

**Description:** Creates SAS code that you can register in the SAS Model Manager.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get MM SAS Data Step;


```

#### [Get Mean Confid Limit Formula](#get-mean-confid-limit-formula)

**Syntax:** obj \<< Get Mean Confid Limit Formula

**Description:** Returns a formula for the mean confidence limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get Mean Confid Limit Formula;


```

#### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Get Measures;


```

#### [Get Parameter Names](#get-parameter-names)

**Syntax:** obj \<< Get Parameter Names

**Description:** Returns the parameter names.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Parameter Names;
Show( G );


```

#### [Get Parameterized Formula](#get-parameterized-formula)

**Syntax:** obj \<< Get Parameterized Formula

**Description:** Returns a prediction formula that uses parameters instead of constants.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get Parameterized Formula;


```

#### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< Get Prediction Formula

**Description:** Constructs a script to create a prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get Prediction Formula;


```

#### [Get Random Effect Names](#get-random-effect-names)

**Syntax:** obj \<< Get Random Effect Names

**Description:** Returns the names of the random effects. Available for REML analysis methods.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
G = obj << Get Random Effect Names;
Show( G );


```

#### [Get SAS DATA Step](#get-sas-data-step)

**Syntax:** obj \<< Get SAS DATA Step

**Description:** Creates SAS code that you can use to score a new data set.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get SAS Data Step;


```

#### [Get SQL prediction expression](#get-sql-prediction-expression)

**Syntax:** obj \<< Get SQL prediction expression

**Description:** Creates an SQL expression that you can paste into an SQL Select statement to predict a response.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get SQL prediction expression;


```

#### [Get Standard Error Formula](#get-standard-error-formula)

**Syntax:** obj \<< Get Standard Error Formula

**Description:** Returns a formula for the standard error.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Get Standard Error Formula;


```

#### [Get Std Errors](#get-std-errors)

**Syntax:** obj \<< Get Std Errors

**Description:** Returns the standard errors.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Std Errors;
Show( G );


```

#### [Get Variance Components](#get-variance-components)

**Syntax:** obj \<< Get Variance Components

**Description:** Returns the variance components. Available for REML analysis methods.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
G = obj << Get Variance Components;
Show( G );


```

#### [Get X Matrix](#get-x-matrix)

**Syntax:** obj \<< Get X Matrix

**Description:** Returns the design matrix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get X Matrix;
Show( G );


```

#### [Get XPX Inverse](#get-xpx-inverse)

**Syntax:** obj \<< Get XPX Inverse

**Description:** Returns the X'X inverse matrix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get XPX Inverse;
Show( G );


```

#### [Get Y Matrix](#get-y-matrix)

**Syntax:** obj \<< Get Y Matrix

**Description:** Returns the Y matrix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Y Matrix;
Show( G );


```

#### [Hats](#hats)

**Syntax:** obj \<< Hats

**Description:** Saves a new column to the data table. The new column contains the diagonal values of the matrix xInv(x`x)x`. These values are also called hat or leverage values. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Hats;


```

#### [Indicator Parameterization Estimates](#indicator-parameterization-estimates)

**Syntax:** obj \<< Indicator Parameterization Estimates( state=0|1 )

**Description:** Shows or hides the Indicator Function Parameterization report, which contains parameter estimates with the nominal effects in the model parameterized using the classical indicator functions. This option is available only when there are nominal columns and an intercept among the model effects.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Indicator Parameterization Estimates( 1 );


```

#### [Indiv Confidence Interval](#indiv-confidence-interval)

**Syntax:** obj \<< Indiv Confidence Interval( \<alpha=0.05> )

**Description:** Saves new columns to the data table. The new columns contain the bounds for the confidence interval for an individual realization of the response. This encompasses the variation in both the response and its estimation. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Indiv Confidence Interval( .001 );


```

#### [Indiv Confidence Limit Formula](#indiv-confidence-limit-formula)

**Syntax:** obj \<< Indiv Confidence Limit Formula( \<alpha=0.05> )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for an individual prediction that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
ref = obj << Indiv Confidence Limit Formula( .001 );
Show( ref );


```

#### [Interaction Plots](#interaction-plots)

**Syntax:** obj \<< Interaction Plots( state=0|1 )

**Description:** Shows or hides a matrix of interaction plots. This option is available only when there are interaction effects in the model.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Run
);
Wait( 1 );
obj << Interaction Plots( 1 );


```

#### [Inverse Prediction](#inverse-prediction_1)

**Syntax:** obj \<< Inverse Prediction( Response( p1, p2, ... ), Term Value( effect1( value ), effect2( value ), ... ) )

**Description:** Generates a predicted X value and confidence interval based on the specified values of Y and all other factors.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :RunTime ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Inverse Prediction( Response( 40, 45, 50, 55 ), Term Value( RunTime( . ) ) );


```

#### [Joint Factor Tests](#joint-factor-tests)

**Syntax:** obj \<< Joint Factor Tests( state=0|1 )

**Description:** Shows or hides a joint test for each main effect in the model. The joint test is for all of the parameters that involve that main effect. This option is available only when the model contains interactions.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Joint Factor Tests( 1 );


```

#### [Lack of Fit](#lack-of-fit)

**Syntax:** obj \<< Lack of Fit( state=0|1 )

**Description:** Shows or hides a test that assesses if the model has the appropriate effects. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Lack Of Fit( 0 ) )
);
Wait( 1 );
obj << Lack Of Fit( 1 );


```

#### [Mean Confidence Interval](#mean-confidence-interval_1)

**Syntax:** obj \<< Mean Confidence Interval( \<alpha=0.05> )

**Description:** Saves new columns to the data table. The new columns contain the bounds for the confidence interval for the expected value. This encompasses the variation in the estimation, but not in the response. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Mean Confidence Interval( .01 );


```

#### [Mean Confidence Limit Formula](#mean-confidence-limit-formula)

**Syntax:** obj \<< Mean Confidence Limit Formula( \<alpha=0.05> )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for the mean response that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
r = obj << Mean Confidence Limit Formula( .01 );
Show( r );


```

#### [Mixture Profiler](#mixture-profiler)

**Syntax:** obj \<< Mixture Profiler( state=0|1 )

**Description:** Shows or hides a mixture profiler that shows the contours of the response on a ternary plot. This option is available only if the Mixture Effect attribute is applied to three or more factors in the model or the Mixture property is applied to three or more factor columns.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :p1 & RS & Mixture, :p2 & RS & Mixture, :p3 & RS & Mixture, :p2 * :p1, :p3 * :p1,
        :p3 * :p2
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Mixture Profiler( 1 );


```

#### [Model Dialog](#model-dialog_2)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Model Dialog;


```

#### [Multiple Comparisons](#multiple-comparisons)

**Syntax:** obj \<< Multiple Comparisons( Effect(...)|Estimate List(...)|Sliced Effect Estimates(...), <options> )

**Description:** Generates least squares means estimates or user-defined estimates. The multiple comparisons report enables comparisons with the overall average, comparisons with a control, or pairwise comparisons.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Multiple Comparisons( Effect( :Drug ) );


```

#### [New Preset](#new-preset_2)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Lack of Fit( 0 );
obj << Effect Details( 0 );
Report( obj )["Parameter Estimates"] << Close( 1 );
preset = obj << (:y << New Preset);


```

#### [Normal Plot](#normal-plot)

**Syntax:** obj \<< Normal Plot( state=0|1 )

**Description:** Shows or hides a plot that identifies parameter estimates that deviate from normality. This can help you determine which effects are active.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Normal Plot( 1 );


```

#### [Parameter Estimates](#parameter-estimates)

**Syntax:** obj \<< Parameter Estimates( state=0|1 )

**Description:** Shows or hides a report that contains the parameter estimates and t tests for the hypothesis that each parameter is equal to zero.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Parameter Estimates( 0 ) )
);
Wait( 1 );
obj << Parameter Estimates( 1 );


```

#### [Parameter Power](#parameter-power)

**Syntax:** obj \<< Parameter Power( state=0|1 )

**Description:** Adds or removes columns to the Parameter Estimates report. These columns contain power and other details that relate to the corresponding hypothesis tests.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Parameter Power( 1 );


```

#### [Parameterized Formula](#parameterized-formula)

**Syntax:** obj \<< Parameterized Formula

**Description:** Saves a new formula column to the data table. The new column contains a prediction formula that uses table parameters instead of constants.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Parameterized Formula;


```

#### [Pareto Plot](#pareto-plot)

**Syntax:** obj \<< Pareto Plot( state=0|1 )

**Description:** Shows or hides a plot of the absolute values of the orthogonalized and standardized parameter estimates. This plot shows their composition relative to the sum of the absolute values.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Pareto Plot( 1 );


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides the Actual by Predicted plot, which plots the observed values of the response against the predicted values of the response.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Actual by Predicted( 1 );


```

#### [Plot Effect Leverage](#plot-effect-leverage)

**Syntax:** obj \<< Plot Effect Leverage( state=0|1 )

**Description:** Shows or hides the Leverage Plot report for each effect in the model. The plot shows how observations influence the test for that effect and gives insight about multicollinearity.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run( Plot Effect Leverage( 0 ) )
);
Wait( 1 );
obj << Plot Effect Leverage( 1 );


```

#### [Plot Regression](#plot-regression)

**Syntax:** obj \<< Plot Regression( state=0|1 )

**Description:** Shows or hides the Regression Plot report, which contains a scatterplot of the data and regression lines for each level of the categorical effect. This option is available only if there is exactly one continuous effect and no more than one categorical effect in the model. If these conditions are met, the Regression Plot report is provided by default. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Plot Regression( 0 ) )
);
Wait( 1 );
obj << Plot Regression( 1 );


```

#### [Plot Residual by Normal Quantiles](#plot-residual-by-normal-quantiles)

**Syntax:** obj \<< Plot Residual by Normal Quantiles( state=0|1 )

**Description:** Shows or hides a plot with the residuals on the vertical axis and the normal quantiles of the residuals on the horizontal axis. This option is not available when the Method is REML.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Residual by Normal Quantiles( 1 );


```

#### [Plot Residual by Predicted](#plot-residual-by-predicted)

**Syntax:** obj \<< Plot Residual by Predicted( state=0|1 )

**Description:** Shows or hides a plot with the residuals on the vertical axis and the predicted values of the response on the horizontal axis. This option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Residual by Predicted( 1 );


```

#### [Plot Residual by Row](#plot-residual-by-row)

**Syntax:** obj \<< Plot Residual by Row( state=0|1 )

**Description:** Shows or hides a plot with the residuals on the vertical axis and the row number on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Residual by Row( 1 );


```

#### [Plot Studentized Residuals](#plot-studentized-residuals)

**Syntax:** obj \<< Plot Studentized Residuals( state=0|1 )

**Description:** Shows or hides a plot with the studentized residuals on the vertical axis and the row number on the horizontal axis. Each point on the plot is computed using an estimate of its standard deviation obtained with the current observation deleted.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Studentized Residuals( 1 );


```

#### [Predicted Values](#predicted-values_1)

**Syntax:** obj \<< Predicted Values

**Description:** Saves a new column to the data table. The new column contains the predicted values for the fitted model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Predicted Values;


```

#### [Prediction Formula](#prediction-formula_1)

**Syntax:** obj \<< Prediction Formula

**Description:** Saves a new formula column to the data table. The new column contains the prediction formula for the fitted model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Prediction Formula;


```

#### [Prediction and Interval Formulas](#prediction-and-interval-formulas_1)

**Syntax:** obj \<< Prediction and Interval Formulas( \<alpha=0.05> )

**Description:** Saves new columns to the data table. The columns contain formulas for the predictions, confidence limits, and prediction limits. The limits columns that are created by this option contain properties that are used by the Prediction Profiler. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Prediction and Interval Formulas;
dt << Profiler(
    Y( :Pred Formula y ),
    Profiler( 1, Confidence Intervals( 1 ), Prediction Intervals( 1 ) )
);
Wait( 2 );
obj << Prediction and Interval Formulas( 0.01 );
dt << Profiler(
    Y( :Pred Formula y2 ),
    Profiler( 1, Confidence Intervals( 1 ), Prediction Intervals( 1 ) )
);


```

#### [Press](#press)

**Syntax:** obj \<< Press( state=0|1 )

**Description:** Shows or hides the prediction error sum of squares (Press) statistic and its root mean square error (RMSE). The Press statistic is useful when comparing multiple models. Models with lower Press statistics are favored.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Press( 1 );


```

#### [Profiler](#profiler_1)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Profiler( 1 );


```

#### [Publish Conditional Formula](#publish-conditional-formula)

**Syntax:** obj \<< Publish Conditional Formula

**Description:** Creates a prediction formula that includes random effect estimates and publishes it as a formula column script in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Publish Conditional Formula;


```

#### [Publish Indiv Confid Limit Formula](#publish-indiv-confid-limit-formula)

**Syntax:** obj \<< Publish Indiv Confid Limit Formula

**Description:** Creates formulas for the individual confidence limits and publishes them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Publish Indiv Confid Limit Formula;


```

#### [Publish Mean Confid Limit Formula](#publish-mean-confid-limit-formula)

**Syntax:** obj \<< Publish Mean Confid Limit Formula

**Description:** Creates formulas for the mean confidence limits and publishes them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Publish Mean Confid Limit Formula;


```

#### [Publish Parameterized Formula](#publish-parameterized-formula)

**Syntax:** obj \<< Publish Parameterized Formula

**Description:** Creates a prediction formula that uses parameters instead of constants and publishes it as a formula column script in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Publish Parameterized Formula;


```

#### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Creates a prediction formula and publishes it as a formula column script in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Publish Prediction Formula;


```

#### [Publish Standard Error Formula](#publish-standard-error-formula)

**Syntax:** obj \<< Publish Standard Error Formula

**Description:** Creates a standard error formula and publishes it as a formula column script in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
code = obj << Publish Standard Error Formula;


```

#### [Residuals](#residuals)

**Syntax:** obj \<< Residuals

**Description:** Saves a new column to the data table. The new column contains the residual values for the fitted model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Residuals;


```

#### [Save Coding Table](#save-coding-table)

**Syntax:** obj \<< Save Coding Table

**Description:** Creates a new data table that contains the JMP coding for all model parameters. The last column shows the values of the response variable.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Save Coding Table;


```

#### [Scaled Estimates](#scaled-estimates)

**Syntax:** obj \<< Scaled Estimates( state=0|1 )

**Description:** Shows or hides parameter estimates that correspond to factors that are scaled to have a mean of zero and a range of two.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Scaled Estimates( 1 );


```

#### [Sequential Tests](#sequential-tests)

**Syntax:** obj \<< Sequential Tests( state=0|1 )

**Description:** Shows or hides the Sequential (Type 1) Tests report, which contains the sums of squares as effects are added to the model sequentially.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Sequential Tests( 1 );


```

#### [Show All Confidence Intervals](#show-all-confidence-intervals)

**Syntax:** obj \<< Show All Confidence Intervals( state=0|1 )

**Description:** Shows or hides confidence intervals for parameter estimates and least squares mean estimates.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Show All Confidence Intervals( 1 );


```

#### [Show CV](#show-cv)

**Syntax:** obj \<< Show CV( state=0|1 )

**Description:** Shows or hides the Coefficient of Variation column in the REML Variance Component Estimates report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
Wait( 1 );
obj << Show CV( 1 );


```

#### [Show Prediction Expression](#show-prediction-expression)

**Syntax:** obj \<< Show Prediction Expression( state=0|1 )

**Description:** Shows or hides the Prediction Expression report, which contains the equation for the estimated model.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Show Prediction Expression( 1 );


```

#### [Show Sqrt Variance Component](#show-sqrt-variance-component)

**Syntax:** obj \<< Show Sqrt Variance Component( state=0|1 )

**Description:** Shows or hides the Sqrt Variance Component column in the REML Variance Component Estimates report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
Wait( 1 );
obj << Show Sqrt Variance Component( 1 );


```

#### [Show VIF](#show-vif)

**Syntax:** obj \<< Show VIF( state=0|1 )

**Description:** Shows or hides the values of the variance inflation factor (VIF) in the Parameter Estimates report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Show VIF( 1 );


```

#### [Sorted Estimates](#sorted-estimates)

**Syntax:** obj \<< Sorted Estimates( state=0|1 )

**Description:** Shows or hides the Sorted Parameter Estimates report, which can be useful in screening situations. This report contains the parameter estimates sorted by the absolute value of the t ratio for each estimate.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Sorted Estimates( 1 );


```

#### [Std Error of Individual](#std-error-of-individual)

**Syntax:** obj \<< Std Error of Individual

**Description:** Saves a new column to the data table. The new column contains the standard error of an individual predicted value. This is used to compute the individual confidence interval. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Std Error of Individual;


```

#### [Std Error of Predicted](#std-error-of-predicted)

**Syntax:** obj \<< Std Error of Predicted

**Description:** Saves a new column to the data table. The new column contains the standard error for predicted values. This is used to compute the mean confidence interval. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Std Error of Predicted;


```

#### [Std Error of Residual](#std-error-of-residual)

**Syntax:** obj \<< Std Error of Residual

**Description:** Saves a new column to the data table. The new column contains the standard error for residual values. This is used to compute the studentized residuals. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Std Error of Residual;


```

#### [StdErr Pred Formula](#stderr-pred-formula)

**Syntax:** obj \<< StdErr Pred Formula

**Description:** Saves a new formula column to the data table. The new column contains the formula for the standard error for predicted values as a function of the regressors. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << StdErr Pred Formula;


```

#### [Studentized Residuals](#studentized-residuals)

**Syntax:** obj \<< Studentized Residuals

**Description:** Saves a new column to the data table. The new column contains the studentized residual, which is the residual divided by its standard error. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Studentized Residuals;


```

#### [Summary of Fit](#summary-of-fit)

**Syntax:** obj \<< Summary of Fit( state=0|1 )

**Description:** Shows or hides a report that contains a summary of model fit statistics.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );


```

#### [Surface Profiler](#surface-profiler_1)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides a three-dimensional surface plot of the response surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Surface Profiler( 1 );


```

### [Shared Item Messages](#shared-item-messages_2)

#### [Action](#action_2)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Automatic Recalc](#automatic-recalc_1)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_2)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_2)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_2)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_2)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_2)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_2)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_2)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_2)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_2)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_2)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_2)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_2)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_2)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_2)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_2)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_2)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_2)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [Paste Local Data Filter](#paste-local-data-filter_2)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_2)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_2)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_2)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_2)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_2)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_2)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_2)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_2)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_2)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_2)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_2)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_2)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_2)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_2)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_2)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_2)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_2)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_2)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_2)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_2)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_2)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_2)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_2)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_2)

**Syntax:** obj = Summary of Fit(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Least Squares](#fit-least-squares)

### [Associated Constructors](#associated-constructors_2)

#### [Fit Least Squares](#fit-least-squares_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Standard Least Squares" ), Emphasis( "Effect Leverage"|"Effect Screening"|"Minimal Report" )

**Description:** Fits a linear regression model for a continuous response. Techniques include regression, analysis of variance, analysis of covariance, mixed models, and analysis of designed experiments. The Emphasis option enables you to specify the report layout.

**Fit Multiple Random Effects**

```


dt = Open( "$Sample_Data/Split Plot.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Tenderizer, :Roasting Time, :Tenderizer * :Roasting Time ),
    Random Effects( :Carcass, :Carcass * :Tenderizer ),
    Center Polynomials( 0 ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

**Fit Multiple Regression**

```


dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Standard Least Squares" ),
    Run
);


```

**Fit Parallel Slopes (ANCOVA)**

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);


```

**Fit Quadratic Response Surface**

```


dt = Open( "$Sample_Data/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :HARDNESS ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILICA, :SILANE * :SILICA, :SILANE * :SILANE,
        :SULFUR * :SILICA, :SULFUR * :SILANE, :SULFUR * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Run
);


```

**Fit Random Slopes Mixed Model**

```


dt = Open( "$Sample_Data/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects( :Variety, :Moisture[:Variety] ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

**Fit Screening Design with Interactions**

```


dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Screening" ),
    Run
);


```

**Fit Separate Slopes Crossed**

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x, :Drug * :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

**Fit Separate Slopes Nested**

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x[:Drug] ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

**Fit Several Responses**

```

dt = Open( "$Sample_Data/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILICA, :SILANE * :SILICA, :SILANE * :SILANE,
        :SULFUR * :SILICA, :SULFUR * :SILANE, :SULFUR * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Run
);


```

**Fit Split Plot**

```


dt = Open( "$Sample_Data/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :season, :species * :season ),
    Random Effects( :subject[:species] ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

**Fit Treatment Effect Blocked**

```


dt = Open( "$Sample_Data/Snapdragon.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Soil ),
    Random Effects( :Block ),
    Personality( "Standard Least Squares" ),
    Run
);


```

**Fit Two-Way Crossed**

```


dt = Open( "$Sample_Data/Analgesics.jmp" );
obj = dt << Fit Model(
    Y( :pain ),
    Effects( :gender, :drug, :gender * :drug ),
    Personality( "Standard Least Squares" ),
    Run
);


```

### [Item Messages](#item-messages_14)

#### [AICc](#aicc_1)

**Syntax:** obj \<< AICc( state=0|1 )

**Description:** Shows or hides the corrected Akaike's Information Criterion (AICc) and the Bayesian Information Criterion (BIC) values in the Summary of Fit report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << AICc( 1 );


```

#### [Analysis of Variance](#analysis-of-variance_1)

**Syntax:** obj \<< Analysis of Variance( state=0|1 )

**Description:** Shows or hides a report that contains statistics for comparing the fitted model to a simple mean model.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Analysis of Variance( 0 ) )
);
Wait( 1 );
obj << Analysis of Variance( 1 );


```

#### [Apply Preset](#apply-preset_3)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Lack of Fit( 0 );
obj << Effect Details( 0 );
Report( obj )["Parameter Estimates"] << Close( 1 );
preset = obj << (:y << New Preset);

dt2 = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj2 = dt2 << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj2 << (:Oxy << Apply Preset( preset ));


```

#### [Bayes Plot](#bayes-plot_1)

**Syntax:** obj \<< Bayes Plot( K( number ), Priors( p1, p2, p3, ... ), Go )

**Description:** Shows or hides a plot that computes posterior probabilities for all model terms using a Bayesian approach.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Bayes Plot( K( 10 ), Priors( 0.2, 0.2, 0.2, 0.2, 0.2 ), Go );


```

#### [Box Cox Y Transformation](#box-cox-y-transformation_1)

**Syntax:** obj \<< Box Cox Y Transformation( state=0|1, \<Save Best Transformation( state=0|1 )>, \<Save Specific Transformation( number )>, \<Table of Estimates( state=0|1 )> )

**Description:** Shows or hides the Box-Cox Transformations report, which shows how the fit would change if you refit the model with a power (Box-Cox) transformation on the response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Box Cox Y Transformation( 1, Save Best Transformation( 1 ) );


```

#### [Compare Slopes](#compare-slopes_1)

**Syntax:** obj \<< Compare Slopes( Effect( effect ), <options> )

**Description:** Generates an analysis of means (ANOM) report that compares interaction slopes with the average slope for an analysis of covariance (ANCOVA) model. This option is available only when there is one nominal effect, one continuous effect, and their interaction effect for the fixed effects.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/US Demographics.jmp" );
obj = dt << Fit Model(
    Y( :Eighth Grade Math ),
    Effects( :Region, :High School Graduates, :Region * :High School Graduates ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Compare Slopes(
    Effect( :Region * :High School Graduates ),
    Student's t( 1, All Pairwise Comparisons Scatterplot( 0 ) )
);


```

#### [Conditional Indiv CI](#conditional-indiv-ci_1)

**Syntax:** obj \<< Conditional Indiv CI( \<alpha=0.05> )

**Description:** Saves a new column to the data table. The new column contains the confidence interval for the individual value from conditional prediction. The confidence intervals include random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Indiv CI( 0.001 );


```

#### [Conditional Mean CI](#conditional-mean-ci_1)

**Syntax:** obj \<< Conditional Mean CI( \<alpha=0.05> )

**Description:** Saves a new column to the data table. The new column contains the confidence interval for the expected value from conditional prediction. The confidence intervals include random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Mean CI( 0.01 );


```

#### [Conditional Pred Formula](#conditional-pred-formula_1)

**Syntax:** obj \<< Conditional Pred Formula

**Description:** Saves a new formula column to the data table. The new column contains a formula that includes random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Pred Formula;


```

#### [Conditional Pred Values](#conditional-pred-values_1)

**Syntax:** obj \<< Conditional Pred Values

**Description:** Saves a new column to the data table. The new column contains the conditional predicted values that are calculated using the best linear unbiased predictors (BLUPs) for the random effects coefficients. This option is available only for REML analysis methods. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Pred Values;


```

#### [Conditional Residuals](#conditional-residuals_1)

**Syntax:** obj \<< Conditional Residuals

**Description:** Saves a new column to the data table. The new column contains the residuals from conditional prediction. The residual values include random effect estimates for models with random effects. This option is available only for REML analysis methods. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Conditional Residuals;


```

#### [Contour Profiler](#contour-profiler_2)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time. Available only when the model contains more than one continuous factor.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Contour Profiler( 1 );


```

#### [Cook's D Influence](#cooks-d-influence_1)

**Syntax:** obj \<< Cook's D Influence

**Description:** Saves a new column to the data table. The new column contains a measure of how much influence each observation has in estimating the model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Cook's D Influence;


```

#### [Correlation of Estimates](#correlation-of-estimates_2)

**Syntax:** obj \<< Correlation of Estimates( state=0|1 )

**Description:** Shows or hides the matrix of correlations between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Correlation of Estimates( 1 );


```

#### [Cox Mixtures](#cox-mixtures_1)

**Syntax:** obj \<< Cox Mixtures( p1(percentile), p2(percentile), p3(percentile) )

**Description:** Shows or hides parameter estimates for the Cox mixture model based on the specified reference mixture values. This option is available only when the model contains mixture effects.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :p1 & RS & Mixture, :p2 & RS & Mixture, :p3 & RS & Mixture, :p2 * :p1, :p3 * :p1,
        :p3 * :p2
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Cox Mixtures( p1( 0.6615 ), p2( 0.126 ), p3( 0.2125 ) );


```

#### [Cube Plots](#cube-plots_1)

**Syntax:** obj \<< Cube Plots( state=0|1 )

**Description:** Shows or hides the predicted values for the extremes of the factor ranges laid out in one or more cubes.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Cube Plots( 1 );


```

#### [Custom Test](#custom-test_2)

**Syntax:** obj \<< Custom Test( [l1, l2, l3, ... ], \<Label( text )> )

**Description:** Runs a customized F test that contrasts the different effects in the model.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Custom Test( [0 0 2 1], Label( "Comparison of intercepts for drug a vs. drug" ) );


```

#### [Durbin Watson Test](#durbin-watson-test_1)

**Syntax:** obj \<< Durbin Watson Test( state=0|1 )

**Description:** Shows or hides the Durbin-Watson report, which contains a statistic to test whether the residuals have first-order autocorrelation. The report also shows the autocorrelation of the residuals and the exact probability associated with the statistic. This option is appropriate only for time series data and assumes that your observations are in time order.

```

dt = Open( "$SAMPLE_DATA/Time Series/CO2.jmp" );
obj = dt << Fit Model(
    Y( :CO2 ),
    Effects( :Year, :Month ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Durbin Watson Test( 1 );


```

#### [Effect Details](#effect-details_1)

**Syntax:** obj \<< Effect Details( state=0|1 )

**Description:** Shows or hides detailed reports for each effect in the model, including the LS Means table for each categorical effect. Additional information can be shown by sending messages to model effects. See the Effect Fit object under Fit Model for more information. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Leverage" ),
    Run( Effect Details( 0 ) )
);
Wait( 1 );
obj << Effect Details( 1 );


```

#### [Effect Leverage Pairs](#effect-leverage-pairs_1)

**Syntax:** obj \<< Effect Leverage Pairs

**Description:** Saves new columns to the data table. The new columns contain the X and Y values that are plotted in effect leverage plots. The Y value is the partial residual. The X value is the regressor shrinkage in the effect leverage plots. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Effect Leverage Pairs;


```

#### [Effect Summary](#effect-summary_2)

**Syntax:** obj \<< Effect Summary( state=0|1 )

**Description:** Shows or hides the Effect Summary report, which enables you to interactively update the effects in the model. On by default.

**JMP Version Added:** 15

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Effect Summary( 0 );
Wait( 1 );
obj << Effect Summary( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Effect Tests](#effect-tests_1)

**Syntax:** obj \<< Effect Tests( state=0|1 )

**Description:** Shows or hides a report that contains tests for the fixed effects in the model. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Effect Tests( 0 ) )
);
Wait( 1 );
obj << Effect Tests( 1 );


```

#### [Error Specification](#error-specification_1)

**Syntax:** obj \<< Error Specification( "Default Estimate"|"Pure Error"|"Specified" )

**Description:** Specifies the error variance and the error degrees of freedom that are used for standard errors and tests in the Fit Least Squares report. This option is available only when the model contains no random effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Error Specification( "Pure Error" );


```

#### [Expanded Estimates](#expanded-estimates_1)

**Syntax:** obj \<< Expanded Estimates( state=0|1 )

**Description:** Shows or hides the parameter estimates for all levels of a nominal model effect. For a nominal effect with k levels, the Parameter Estimates table contains coefficients for the k-1 parameters, and the Expanded Estimates table contains the effect coefficients for all k levels. This option is available only when at least one of the effects is not continuous.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Expanded Estimates( 1 );


```

#### [Externally Studentized Residuals](#externally-studentized-residuals_1)

**Syntax:** obj \<< Externally Studentized Residuals

**Description:** Saves a new column to the data table. The new column contains the externally studentized residuals. These are the residuals divided by standard error estimates that exclude the current row. Hold down the shift key to enter suffix.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Externally Studentized Residuals;


```

#### [FDR](#fdr_2)

**Syntax:** obj \<< FDR( state=0|1 )

**Description:** Specifies whether the logworth values and their corresponding p-values in the Effect Summary table are adjusted using the false discovery rate (FDR).

**JMP Version Added:** 15

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << FDR( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Get Conditional Formula](#get-conditional-formula_1)

**Syntax:** obj \<< Get Conditional Formula

**Description:** Returns a prediction formula that includes random effect estimates.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get Conditional Formula;


```

#### [Get Effect Names](#get-effect-names_1)

**Syntax:** obj \<< Get Effect Names

**Description:** Returns the effect names.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Effect Names;
Show( G );


```

#### [Get Effect PValues](#get-effect-pvalues_1)

**Syntax:** obj \<< Get Effect PValues

**Description:** Returns the effect p-values.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Effect PValues;
Show( G );


```

#### [Get Estimates](#get-estimates_1)

**Syntax:** obj \<< Get Estimates

**Description:** Returns the estimates.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Estimates;
Show( G );


```

#### [Get Indiv Confid Limit Formula](#get-indiv-confid-limit-formula_1)

**Syntax:** obj \<< Get Indiv Confid Limit Formula

**Description:** Returns a formula for the individual confidence limits.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get Indiv Confid Limit Formula;


```

#### [Get MM SAS DATA Step](#get-mm-sas-data-step_1)

**Syntax:** obj \<< Get MM SAS DATA Step

**Description:** Creates SAS code that you can register in the SAS Model Manager.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get MM SAS Data Step;


```

#### [Get Mean Confid Limit Formula](#get-mean-confid-limit-formula_1)

**Syntax:** obj \<< Get Mean Confid Limit Formula

**Description:** Returns a formula for the mean confidence limits.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get Mean Confid Limit Formula;


```

#### [Get Measures](#get-measures_1)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Get Measures;


```

#### [Get Parameter Names](#get-parameter-names_1)

**Syntax:** obj \<< Get Parameter Names

**Description:** Returns the parameter names.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Parameter Names;
Show( G );


```

#### [Get Parameterized Formula](#get-parameterized-formula_1)

**Syntax:** obj \<< Get Parameterized Formula

**Description:** Returns a prediction formula that uses parameters instead of constants.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get Parameterized Formula;


```

#### [Get Prediction Formula](#get-prediction-formula_1)

**Syntax:** obj \<< Get Prediction Formula

**Description:** Constructs a script to create a prediction formula column and returns it.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get Prediction Formula;


```

#### [Get Random Effect Names](#get-random-effect-names_1)

**Syntax:** obj \<< Get Random Effect Names

**Description:** Returns the names of the random effects. Available for REML analysis methods.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
G = obj << Get Random Effect Names;
Show( G );


```

#### [Get SAS DATA Step](#get-sas-data-step_1)

**Syntax:** obj \<< Get SAS DATA Step

**Description:** Creates SAS code that you can use to score a new data set.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get SAS Data Step;


```

#### [Get SQL prediction expression](#get-sql-prediction-expression_1)

**Syntax:** obj \<< Get SQL prediction expression

**Description:** Creates an SQL expression that you can paste into an SQL Select statement to predict a response.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get SQL prediction expression;


```

#### [Get Standard Error Formula](#get-standard-error-formula_1)

**Syntax:** obj \<< Get Standard Error Formula

**Description:** Returns a formula for the standard error.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Get Standard Error Formula;


```

#### [Get Std Errors](#get-std-errors_1)

**Syntax:** obj \<< Get Std Errors

**Description:** Returns the standard errors.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Std Errors;
Show( G );


```

#### [Get Variance Components](#get-variance-components_1)

**Syntax:** obj \<< Get Variance Components

**Description:** Returns the variance components. Available for REML analysis methods.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
G = obj << Get Variance Components;
Show( G );


```

#### [Get X Matrix](#get-x-matrix_1)

**Syntax:** obj \<< Get X Matrix

**Description:** Returns the design matrix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get X Matrix;
Show( G );


```

#### [Get XPX Inverse](#get-xpx-inverse_1)

**Syntax:** obj \<< Get XPX Inverse

**Description:** Returns the X'X inverse matrix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get XPX Inverse;
Show( G );


```

#### [Get Y Matrix](#get-y-matrix_1)

**Syntax:** obj \<< Get Y Matrix

**Description:** Returns the Y matrix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
G = obj << Get Y Matrix;
Show( G );


```

#### [Hats](#hats_1)

**Syntax:** obj \<< Hats

**Description:** Saves a new column to the data table. The new column contains the diagonal values of the matrix xInv(x`x)x`. These values are also called hat or leverage values. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Hats;


```

#### [Indicator Parameterization Estimates](#indicator-parameterization-estimates_1)

**Syntax:** obj \<< Indicator Parameterization Estimates( state=0|1 )

**Description:** Shows or hides the Indicator Function Parameterization report, which contains parameter estimates with the nominal effects in the model parameterized using the classical indicator functions. This option is available only when there are nominal columns and an intercept among the model effects.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Indicator Parameterization Estimates( 1 );


```

#### [Indiv Confidence Interval](#indiv-confidence-interval_1)

**Syntax:** obj \<< Indiv Confidence Interval( \<alpha=0.05> )

**Description:** Saves new columns to the data table. The new columns contain the bounds for the confidence interval for an individual realization of the response. This encompasses the variation in both the response and its estimation. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Indiv Confidence Interval( .001 );


```

#### [Indiv Confidence Limit Formula](#indiv-confidence-limit-formula_1)

**Syntax:** obj \<< Indiv Confidence Limit Formula( \<alpha=0.05> )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for an individual prediction that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
ref = obj << Indiv Confidence Limit Formula( .001 );
Show( ref );


```

#### [Interaction Plots](#interaction-plots_1)

**Syntax:** obj \<< Interaction Plots( state=0|1 )

**Description:** Shows or hides a matrix of interaction plots. This option is available only when there are interaction effects in the model.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Run
);
Wait( 1 );
obj << Interaction Plots( 1 );


```

#### [Inverse Prediction](#inverse-prediction_2)

**Syntax:** obj \<< Inverse Prediction( Response( p1, p2, ... ), Term Value( effect1( value ), effect2( value ), ... ) )

**Description:** Generates a predicted X value and confidence interval based on the specified values of Y and all other factors.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :RunTime ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Inverse Prediction( Response( 40, 45, 50, 55 ), Term Value( RunTime( . ) ) );


```

#### [Joint Factor Tests](#joint-factor-tests_1)

**Syntax:** obj \<< Joint Factor Tests( state=0|1 )

**Description:** Shows or hides a joint test for each main effect in the model. The joint test is for all of the parameters that involve that main effect. This option is available only when the model contains interactions.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Joint Factor Tests( 1 );


```

#### [Lack of Fit](#lack-of-fit_1)

**Syntax:** obj \<< Lack of Fit( state=0|1 )

**Description:** Shows or hides a test that assesses if the model has the appropriate effects. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Lack Of Fit( 0 ) )
);
Wait( 1 );
obj << Lack Of Fit( 1 );


```

#### [Mean Confidence Interval](#mean-confidence-interval_2)

**Syntax:** obj \<< Mean Confidence Interval( \<alpha=0.05> )

**Description:** Saves new columns to the data table. The new columns contain the bounds for the confidence interval for the expected value. This encompasses the variation in the estimation, but not in the response. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Mean Confidence Interval( .01 );


```

#### [Mean Confidence Limit Formula](#mean-confidence-limit-formula_1)

**Syntax:** obj \<< Mean Confidence Limit Formula( \<alpha=0.05> )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for the mean response that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
r = obj << Mean Confidence Limit Formula( .01 );
Show( r );


```

#### [Mixture Profiler](#mixture-profiler_1)

**Syntax:** obj \<< Mixture Profiler( state=0|1 )

**Description:** Shows or hides a mixture profiler that shows the contours of the response on a ternary plot. This option is available only if the Mixture Effect attribute is applied to three or more factors in the model or the Mixture property is applied to three or more factor columns.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :p1 & RS & Mixture, :p2 & RS & Mixture, :p3 & RS & Mixture, :p2 * :p1, :p3 * :p1,
        :p3 * :p2
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Mixture Profiler( 1 );


```

#### [Model Dialog](#model-dialog_3)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Model Dialog;


```

#### [Multiple Comparisons](#multiple-comparisons_1)

**Syntax:** obj \<< Multiple Comparisons( Effect(...)|Estimate List(...)|Sliced Effect Estimates(...), <options> )

**Description:** Generates least squares means estimates or user-defined estimates. The multiple comparisons report enables comparisons with the overall average, comparisons with a control, or pairwise comparisons.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :x, :Drug ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Multiple Comparisons( Effect( :Drug ) );


```

#### [New Preset](#new-preset_3)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Lack of Fit( 0 );
obj << Effect Details( 0 );
Report( obj )["Parameter Estimates"] << Close( 1 );
preset = obj << (:y << New Preset);


```

#### [Normal Plot](#normal-plot_1)

**Syntax:** obj \<< Normal Plot( state=0|1 )

**Description:** Shows or hides a plot that identifies parameter estimates that deviate from normality. This can help you determine which effects are active.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Normal Plot( 1 );


```

#### [Parameter Estimates](#parameter-estimates_1)

**Syntax:** obj \<< Parameter Estimates( state=0|1 )

**Description:** Shows or hides a report that contains the parameter estimates and t tests for the hypothesis that each parameter is equal to zero.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Parameter Estimates( 0 ) )
);
Wait( 1 );
obj << Parameter Estimates( 1 );


```

#### [Parameter Power](#parameter-power_1)

**Syntax:** obj \<< Parameter Power( state=0|1 )

**Description:** Adds or removes columns to the Parameter Estimates report. These columns contain power and other details that relate to the corresponding hypothesis tests.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Parameter Power( 1 );


```

#### [Parameterized Formula](#parameterized-formula_1)

**Syntax:** obj \<< Parameterized Formula

**Description:** Saves a new formula column to the data table. The new column contains a prediction formula that uses table parameters instead of constants.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Parameterized Formula;


```

#### [Pareto Plot](#pareto-plot_1)

**Syntax:** obj \<< Pareto Plot( state=0|1 )

**Description:** Shows or hides a plot of the absolute values of the orthogonalized and standardized parameter estimates. This plot shows their composition relative to the sum of the absolute values.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Pareto Plot( 1 );


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted_1)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides the Actual by Predicted plot, which plots the observed values of the response against the predicted values of the response.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Actual by Predicted( 1 );


```

#### [Plot Effect Leverage](#plot-effect-leverage_1)

**Syntax:** obj \<< Plot Effect Leverage( state=0|1 )

**Description:** Shows or hides the Leverage Plot report for each effect in the model. The plot shows how observations influence the test for that effect and gives insight about multicollinearity.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run( Plot Effect Leverage( 0 ) )
);
Wait( 1 );
obj << Plot Effect Leverage( 1 );


```

#### [Plot Regression](#plot-regression_1)

**Syntax:** obj \<< Plot Regression( state=0|1 )

**Description:** Shows or hides the Regression Plot report, which contains a scatterplot of the data and regression lines for each level of the categorical effect. This option is available only if there is exactly one continuous effect and no more than one categorical effect in the model. If these conditions are met, the Regression Plot report is provided by default. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Plot Regression( 0 ) )
);
Wait( 1 );
obj << Plot Regression( 1 );


```

#### [Plot Residual by Normal Quantiles](#plot-residual-by-normal-quantiles_1)

**Syntax:** obj \<< Plot Residual by Normal Quantiles( state=0|1 )

**Description:** Shows or hides a plot with the residuals on the vertical axis and the normal quantiles of the residuals on the horizontal axis. This option is not available when the Method is REML.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Residual by Normal Quantiles( 1 );


```

#### [Plot Residual by Predicted](#plot-residual-by-predicted_1)

**Syntax:** obj \<< Plot Residual by Predicted( state=0|1 )

**Description:** Shows or hides a plot with the residuals on the vertical axis and the predicted values of the response on the horizontal axis. This option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Residual by Predicted( 1 );


```

#### [Plot Residual by Row](#plot-residual-by-row_1)

**Syntax:** obj \<< Plot Residual by Row( state=0|1 )

**Description:** Shows or hides a plot with the residuals on the vertical axis and the row number on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Residual by Row( 1 );


```

#### [Plot Studentized Residuals](#plot-studentized-residuals_1)

**Syntax:** obj \<< Plot Studentized Residuals( state=0|1 )

**Description:** Shows or hides a plot with the studentized residuals on the vertical axis and the row number on the horizontal axis. Each point on the plot is computed using an estimate of its standard deviation obtained with the current observation deleted.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Plot Studentized Residuals( 1 );


```

#### [Predicted Values](#predicted-values_2)

**Syntax:** obj \<< Predicted Values

**Description:** Saves a new column to the data table. The new column contains the predicted values for the fitted model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Predicted Values;


```

#### [Prediction Formula](#prediction-formula_2)

**Syntax:** obj \<< Prediction Formula

**Description:** Saves a new formula column to the data table. The new column contains the prediction formula for the fitted model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Prediction Formula;


```

#### [Prediction and Interval Formulas](#prediction-and-interval-formulas_2)

**Syntax:** obj \<< Prediction and Interval Formulas( \<alpha=0.05> )

**Description:** Saves new columns to the data table. The columns contain formulas for the predictions, confidence limits, and prediction limits. The limits columns that are created by this option contain properties that are used by the Prediction Profiler. Hold down the shift key to enter alpha level or suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Prediction and Interval Formulas;
dt << Profiler(
    Y( :Pred Formula y ),
    Profiler( 1, Confidence Intervals( 1 ), Prediction Intervals( 1 ) )
);
Wait( 2 );
obj << Prediction and Interval Formulas( 0.01 );
dt << Profiler(
    Y( :Pred Formula y2 ),
    Profiler( 1, Confidence Intervals( 1 ), Prediction Intervals( 1 ) )
);


```

#### [Press](#press_1)

**Syntax:** obj \<< Press( state=0|1 )

**Description:** Shows or hides the prediction error sum of squares (Press) statistic and its root mean square error (RMSE). The Press statistic is useful when comparing multiple models. Models with lower Press statistics are favored.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Press( 1 );


```

#### [Profiler](#profiler_2)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Profiler( 1 );


```

#### [Publish Conditional Formula](#publish-conditional-formula_1)

**Syntax:** obj \<< Publish Conditional Formula

**Description:** Creates a prediction formula that includes random effect estimates and publishes it as a formula column script in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Publish Conditional Formula;


```

#### [Publish Indiv Confid Limit Formula](#publish-indiv-confid-limit-formula_1)

**Syntax:** obj \<< Publish Indiv Confid Limit Formula

**Description:** Creates formulas for the individual confidence limits and publishes them as formula column scripts in the Formula Depot platform.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Publish Indiv Confid Limit Formula;


```

#### [Publish Mean Confid Limit Formula](#publish-mean-confid-limit-formula_1)

**Syntax:** obj \<< Publish Mean Confid Limit Formula

**Description:** Creates formulas for the mean confidence limits and publishes them as formula column scripts in the Formula Depot platform.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Publish Mean Confid Limit Formula;


```

#### [Publish Parameterized Formula](#publish-parameterized-formula_1)

**Syntax:** obj \<< Publish Parameterized Formula

**Description:** Creates a prediction formula that uses parameters instead of constants and publishes it as a formula column script in the Formula Depot platform.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Publish Parameterized Formula;


```

#### [Publish Prediction Formula](#publish-prediction-formula_1)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Creates a prediction formula and publishes it as a formula column script in the Formula Depot platform.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Publish Prediction Formula;


```

#### [Publish Standard Error Formula](#publish-standard-error-formula_1)

**Syntax:** obj \<< Publish Standard Error Formula

**Description:** Creates a standard error formula and publishes it as a formula column script in the Formula Depot platform.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
code = obj << Publish Standard Error Formula;


```

#### [Residuals](#residuals_1)

**Syntax:** obj \<< Residuals

**Description:** Saves a new column to the data table. The new column contains the residual values for the fitted model. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Residuals;


```

#### [Save Coding Table](#save-coding-table_1)

**Syntax:** obj \<< Save Coding Table

**Description:** Creates a new data table that contains the JMP coding for all model parameters. The last column shows the values of the response variable.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Save Coding Table;


```

#### [Scaled Estimates](#scaled-estimates_1)

**Syntax:** obj \<< Scaled Estimates( state=0|1 )

**Description:** Shows or hides parameter estimates that correspond to factors that are scaled to have a mean of zero and a range of two.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILANE, :SILICA * :SULFUR, :SILANE * :SULFUR
    ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Scaled Estimates( 1 );


```

#### [Sequential Tests](#sequential-tests_1)

**Syntax:** obj \<< Sequential Tests( state=0|1 )

**Description:** Shows or hides the Sequential (Type 1) Tests report, which contains the sums of squares as effects are added to the model sequentially.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Sequential Tests( 1 );


```

#### [Show All Confidence Intervals](#show-all-confidence-intervals_1)

**Syntax:** obj \<< Show All Confidence Intervals( state=0|1 )

**Description:** Shows or hides confidence intervals for parameter estimates and least squares mean estimates.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Show All Confidence Intervals( 1 );


```

#### [Show CV](#show-cv_1)

**Syntax:** obj \<< Show CV( state=0|1 )

**Description:** Shows or hides the Coefficient of Variation column in the REML Variance Component Estimates report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
Wait( 1 );
obj << Show CV( 1 );


```

#### [Show Prediction Expression](#show-prediction-expression_1)

**Syntax:** obj \<< Show Prediction Expression( state=0|1 )

**Description:** Shows or hides the Prediction Expression report, which contains the equation for the estimated model.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Show Prediction Expression( 1 );


```

#### [Show Sqrt Variance Component](#show-sqrt-variance-component_1)

**Syntax:** obj \<< Show Sqrt Variance Component( state=0|1 )

**Description:** Shows or hides the Sqrt Variance Component column in the REML Variance Component Estimates report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Run
);
Wait( 1 );
obj << Show Sqrt Variance Component( 1 );


```

#### [Show VIF](#show-vif_1)

**Syntax:** obj \<< Show VIF( state=0|1 )

**Description:** Shows or hides the values of the variance inflation factor (VIF) in the Parameter Estimates report.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Show VIF( 1 );


```

#### [Sorted Estimates](#sorted-estimates_1)

**Syntax:** obj \<< Sorted Estimates( state=0|1 )

**Description:** Shows or hides the Sorted Parameter Estimates report, which can be useful in screening situations. This report contains the parameter estimates sorted by the absolute value of the t ratio for each estimate.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Sorted Estimates( 1 );


```

#### [Std Error of Individual](#std-error-of-individual_1)

**Syntax:** obj \<< Std Error of Individual

**Description:** Saves a new column to the data table. The new column contains the standard error of an individual predicted value. This is used to compute the individual confidence interval. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Std Error of Individual;


```

#### [Std Error of Predicted](#std-error-of-predicted_1)

**Syntax:** obj \<< Std Error of Predicted

**Description:** Saves a new column to the data table. The new column contains the standard error for predicted values. This is used to compute the mean confidence interval. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Std Error of Predicted;


```

#### [Std Error of Residual](#std-error-of-residual_1)

**Syntax:** obj \<< Std Error of Residual

**Description:** Saves a new column to the data table. The new column contains the standard error for residual values. This is used to compute the studentized residuals. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Std Error of Residual;


```

#### [StdErr Pred Formula](#stderr-pred-formula_1)

**Syntax:** obj \<< StdErr Pred Formula

**Description:** Saves a new formula column to the data table. The new column contains the formula for the standard error for predicted values as a function of the regressors. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << StdErr Pred Formula;


```

#### [Studentized Residuals](#studentized-residuals_1)

**Syntax:** obj \<< Studentized Residuals

**Description:** Saves a new column to the data table. The new column contains the studentized residual, which is the residual divided by its standard error. Hold down the shift key to enter suffix.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Studentized Residuals;


```

#### [Summary of Fit](#summary-of-fit_1)

**Syntax:** obj \<< Summary of Fit( state=0|1 )

**Description:** Shows or hides a report that contains a summary of model fit statistics.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run( Summary of Fit( 0 ) )
);
Wait( 1 );
obj << Summary of Fit( 1 );


```

#### [Surface Profiler](#surface-profiler_2)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides a three-dimensional surface plot of the response surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
Wait( 1 );
obj << Surface Profiler( 1 );


```

### [Shared Item Messages](#shared-item-messages_3)

#### [Action](#action_3)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Automatic Recalc](#automatic-recalc_2)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_3)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_3)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_3)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_3)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_3)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_3)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_3)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_3)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_3)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_3)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_3)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_3)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_3)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_3)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_3)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_3)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_3)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [Paste Local Data Filter](#paste-local-data-filter_3)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_3)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_3)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_3)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_3)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_3)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_3)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_3)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$Sample_Data/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_3)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_3)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_3)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_3)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$Sample_Data/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$Sample_Data/Drug.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_3)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_3)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_3)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_3)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_3)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_3)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_3)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_3)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_3)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_3)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$Sample_Data/Drug.jmp" );
obj = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality( "Standard Least Squares" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_3)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_3)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_3)

**Syntax:** obj = Fit Least Squares(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit LogVariance > Response Fit LogVariance](#fit-logvariance-response-fit-logvariance)

### [Item Messages](#item-messages_15)

#### [Apply Preset](#apply-preset_4)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Pressure, :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << (:Pressure << Plot Actual By Predicted( 0 ));
Report( obj )["Response Pressure", "Variance Model For Pressure"] << Close( 1 );
Wait( 1 );
preset = obj << (1 << New Preset);
obj << (2 << Apply Preset( preset ));


```

#### [Contour Profiler](#contour-profiler_3)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
Wait( 0 );
obj << Contour Profiler( 1 );


```

#### [Indiv Confidence Interval](#indiv-confidence-interval_2)

**Syntax:** obj \<< Indiv Confidence Interval

**Description:** Saves new columns to the data table. The new columns contain confidence limits for individual response values.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Indiv Confidence Interval;


```

#### [Mean Confidence Interval](#mean-confidence-interval_3)

**Syntax:** obj \<< Mean Confidence Interval

**Description:** Saves new columns to the data table. The new columns contain the bounds for a confidence interval for the prediction mean.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Mean Confidence Interval;


```

#### [Model Dialog](#model-dialog_4)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Model Dialog;


```

#### [New Preset](#new-preset_4)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Pressure, :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << (:Pressure << Plot Actual By Predicted( 0 ));
Report( obj )["Response Pressure", "Variance Model For Pressure"] << Close( 1 );
Wait( 1 );
preset = obj << (1 << New Preset);


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted_2)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides a diagnostic plot with the actual values on the vertical axis and predicted values on the horizontal axis. On by default.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run( Plot Actual by Predicted( 0 ) )
);
Wait( 1 );
obj << Plot Actual by Predicted( 1 );


```

#### [Plot Studentized Residual by Predicted](#plot-studentized-residual-by-predicted)

**Syntax:** obj \<< Plot Studentized Residual by Predicted( state=0|1 )

**Description:** Shows or hides a diagnostic plot with the Studentized residuals on the vertical axis and the predicted values on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Plot Studentized Residual by Predicted( 1 );


```

#### [Plot Studentized Residual by Row](#plot-studentized-residual-by-row)

**Syntax:** obj \<< Plot Studentized Residual by Row( state=0|1 )

**Description:** Shows or hides a diagnostic plot with the Studentized residuals on the vertical axis and the row number on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Plot Studentized Residual by Row( 1 );


```

#### [Prediction Formula](#prediction-formula_3)

**Syntax:** obj \<< Prediction Formula

**Description:** Saves a new formula column to the data table. The new column contains the predicted values for the mean, as computed by the specified model.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;


```

#### [Profiler](#profiler_3)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
Wait( 0 );
obj << Profiler( 1 );


```

#### [Residuals](#residuals_2)

**Syntax:** obj \<< Residuals

**Description:** Saves a new column to the data table. The new column contains the residuals, which are the observed response values minus predicted values.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Residuals;


```

#### [Std Dev Formula](#std-dev-formula)

**Syntax:** obj \<< Std Dev Formula

**Description:** Saves a new formula column to the data table. The new column contains the predicted values for the standard deviation, as computed by the specified model.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Std Dev Formula;


```

#### [Std Error of Individual](#std-error-of-individual_2)

**Syntax:** obj \<< Std Error of Individual

**Description:** Saves a new column to the data table. The new column contains the standard errors of the individual predicted values.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Std Error of Individual;


```

#### [Std Error of Predicted](#std-error-of-predicted_2)

**Syntax:** obj \<< Std Error of Predicted

**Description:** Saves a new column to the data table. The new column contains the standard errors of the predicted values.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Std Error of Predicted;


```

#### [Studentized Residuals](#studentized-residuals_2)

**Syntax:** obj \<< Studentized Residuals

**Description:** Saves a new column to the data table. The new column values are the residuals divided by their standard error.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Studentized Residuals;


```

#### [Surface Profiler](#surface-profiler_3)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides interactive surface plots for the response and the response standard deviation.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
Wait( 0 );
obj << Surface Profiler( 1 );


```

#### [Variance Formula](#variance-formula)

**Syntax:** obj \<< Variance Formula

**Description:** Saves a new formula column to the data table. The new column contains the predicted values for the variance, as computed by the specified model.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Variance Formula;


```

### [Shared Item Messages](#shared-item-messages_4)

#### [Action](#action_4)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Automatic Recalc](#automatic-recalc_3)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_4)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_4)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_4)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Prediction Formula;
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_4)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_4)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_4)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_4)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Prediction Formula;
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_4)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_4)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_4)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_4)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_4)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_4)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_4)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_4)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_4)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_4)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [Paste Local Data Filter](#paste-local-data-filter_4)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_4)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_4)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_4)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_4)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_4)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_4)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_4)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Prediction Formula;
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_4)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Prediction Formula;
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_4)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Prediction Formula;
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_4)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_4)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Prediction Formula;
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Prediction Formula;
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_4)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_4)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_4)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_4)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_4)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_4)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_4)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_4)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_4)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_4)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Prediction Formula;
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_4)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_4)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_4)

**Syntax:** obj = Prediction Formula(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit LogVariance](#fit-logvariance)

### [Associated Constructors](#associated-constructors_3)

#### [Fit LogVariance](#fit-logvariance_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Loglinear Variance" ) )

**Description:** Fits a model for both the mean and the variance of a continuous response variable. You can specify different sets of effects for the two models.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);


```

### [Item Messages](#item-messages_16)

#### [Contour Profiler](#contour-profiler_4)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
Wait( 0 );
obj << Contour Profiler( 1 );


```

#### [Model Dialog](#model-dialog_5)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Model Dialog;


```

#### [Profiler](#profiler_4)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
Wait( 0 );
obj << Profiler( 1 );


```

#### [Surface Profiler](#surface-profiler_4)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides interactive surface plots for the response and the response standard deviation.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
Wait( 0 );
obj << Surface Profiler( 1 );


```

### [Shared Item Messages](#shared-item-messages_5)

#### [Action](#action_5)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_5)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Column Switcher](#column-switcher_5)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy Script](#copy-script_5)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_5)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_5)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get Container](#get-container_5)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_5)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Script](#get-script_5)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_5)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_5)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_5)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_5)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_5)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_5)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_5)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_5)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_5)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_5)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_5)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_5)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_5)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_5)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save Script for All Objects](#save-script-for-all-objects_5)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_5)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_5)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_5)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_5)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_5)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_5)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_5)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_5)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_5)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_5)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_5)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/InjectionMolding.jmp" );
obj = dt << Fit Model(
    Y( :Shrinkage ),
    Effects( :MoldTemp, :Screw Speed, :MoldTemp * :Screw Speed, :Hold Time & LogVariance ),
    Personality( "Loglinear Variance" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [View Web XML](#view-web-xml_5)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [Fit Manova > Effect](#fit-manova-effect)

### [Item Messages](#item-messages_17)

#### [Centroid Plot](#centroid-plot)

**Syntax:** obj \<< (Response[i] \<< (Effect[j] \<< Centroid Plot( state=0|1 )))

**Description:** Shows or hides a table of centroid values and a plot of the centroids (multivariate least squares means) on the first two canonical variables formed from the test space. Note: The Intercept term is specified as Effect[0].

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run( Response Function( "Sum" ) )
);
Wait( 0 );
obj << (Response[1] << (Effect[1] << Centroid Plot( 1 )));


```

#### [Contrast](#contrast_1)

**Syntax:** obj \<< (Response[i] \<< (Effect[j] \<< Contrast( [ l1 l2 l3 ... ] )))

**Description:** Runs a customized F test for the statistical contrasts of treatment levels for an effect in the model. Specify the contrasts as a vector argument. Note: The Intercept term is specified as Effect[0].

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run( Response Function( "Sum" ) )
);
Wait( 0 );
obj << (Response[1] << (Effect[3] << Contrast( [0.5 0.5 -0.5 -0.5] )));


```

#### [Save Canonical Scores](#save-canonical-scores)

**Syntax:** obj \<< (Response[i] \<< (Effect[j] \<< Save Cannonical Scores

**Description:** Saves new columns to the data table. The new columns contain the canonical scores for the specified effect. Note: The Intercept term is specified as Effect[0].

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run( Response Function( "Sum" ) )
);
Wait( 0 );
obj << (Response[1] << (Effect[1] << Save Canonical Scores));


```

#### [Test Details](#test-details)

**Syntax:** obj \<< (Response[i] \<< (Effect[j] \<< Test Details( state=0|1 )))

**Description:** Shows or hides canonical details about the test for the specified effect. Note: The Intercept term is specified as Effect[0].

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run( Response Function( "Sum" ) )
);
Wait( 0 );
obj << (Response[1] << (Effect[1] << Test Details( 1 )));


```

## [Fit Manova > Response](#fit-manova-response)

### [Item Messages](#item-messages_18)

#### [Custom Test](#custom-test_3)

**Syntax:** obj \<< (Response[i] \<< Custom Test( [ l1 l2 l3 ... ], \<Label( name )> ))

**Description:** Runs a customized F test that contrasts the different effects in the model.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run( Response Function( "Sum" ), Response Function( "Contrast" ) )
);
Wait( 0 );
obj << (Response[2] << Custom Test( [0 1 0 -1 0], Label( "Test 1" ) ));


```

#### [Effect](#effect)

**Syntax:** obj \<< (Response[i] \<< (Effect[j] \<< effect options))

**Description:** Enables you to send messages to a specific effect within a specific response in the report window. For more information about messages that can be sent to an effect, select Objects > Fit Model > Fit Manova > Effect in the Scripting Index. Note: The Intercept term is specified as Effect[0].

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run( Response Function( "Sum" ) )
);
obj << (Response[1] << (Effect[1] << Centroid Plot( 1 )));


```

## [Fit Manova](#fit-manova)

### [Associated Constructors](#associated-constructors_4)

#### [Fit Manova](#fit-manova_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Manova" ) )

**Description:** Fits a model that involves multiple continuous response variables. Techniques include multivariate analysis of variance, repeated measures, discriminant analysis, and canonical correlations.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);


```

### [Item Messages](#item-messages_19)

#### [Model Dialog](#model-dialog_6)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Model Dialog;


```

#### [Response Function](#response-function)

**Syntax:** obj \<< Response Function( matrix type, <Univariate Tests Also> )

**Description:** Specifies the matrix type for the response function. This matrix is the M matrix, the columns of which define a set of transformation variables for the multivariate analysis. The optional Univariate Tests Also argument specifies that the report include adjusted and unadjusted univariate repeated measures tests and multivariate tests.

**Basic Example**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Response Function( "Sum" );


```

**Include Univariate Tests**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
Wait( 0 );
obj << Response Function( "Contrast", Univariate Tests Also );


```

#### [Save Discrim](#save-discrim)

**Syntax:** obj \<< Save Discrim

**Description:** Saves new columns to the data table. The new columns contain the Mahalanobis distances, the probability for membership in each level of the effect, and the predicted level with the highest probability. This option is available only when one categorical effect is present in the model.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Fit Model(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Effects( :Species ),
    Personality( "Manova" ),
    Run
);
obj << Save Discrim;


```

#### [Save Predicted](#save-predicted)

**Syntax:** obj \<< Save Predicted

**Description:** Saves new columns to the data table. The new columns contain the predicted values for each response in the model.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Save Predicted;


```

#### [Save Residuals](#save-residuals)

**Syntax:** obj \<< Save Residuals

**Description:** Saves new columns to the data table. The new columns contain residuals for each response in the model.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Save Residuals;


```

### [Shared Item Messages](#shared-item-messages_6)

#### [Action](#action_6)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_6)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_4)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_5)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_6)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_5)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_6)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_6)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_6)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_5)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_6)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_6)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_5)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_6)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_6)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_6)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_6)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_6)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_6)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_6)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_6)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_6)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_6)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_6)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_6)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_6)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_6)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_6)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_5)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_5)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_5)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_6)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_6)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_6)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_6)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_6)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_6)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_6)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_6)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_6)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_6)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_6)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_6)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Fit Model(
    Y( :LogHist0, :LogHist1, :LogHist3, :LogHist5 ),
    Effects( :drug, :dep1, :drug * :dep1 ),
    Personality( "Manova" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_5)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_6)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_5)

**Syntax:** obj = Fit Manova(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Mixed](#fit-mixed)

### [Associated Constructors](#associated-constructors_5)

#### [Fit Mixed](#fit-mixed_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Random Effects( columns ), Repeated Effects( columns ), Repeated Structure( type ), Personality( "Mixed Model" ) )

**Description:** Fits a linear mixed model for a variety of complex covariance structures using REML. These models can be used for random coefficients, repeated measures, split-plots, spatial data, and data with multiple correlated responses.

**Random Block Model**

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
obj = dt << Fit Model(
    Y( :Calories ),
    Effects( :Sugars, :Fiber Gr, :Sugars * :Fiber Gr ),
    Random Effects( :Manufacturer ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Run
);


```

**Random Coefficient Model**

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);


```

**Repeated Measures Model**

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Treatment, :Month, :Month * :Treatment ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Subject( :Patient ),
    Repeated Effects( :Time ),
    Repeated Structure( "Unstructured" ),
    Run
);


```

**Spatial Model**

```

dt = Open( "$SAMPLE_DATA/Uniformity Trial.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects,
    Center Polynomials( 0 ),
    Personality( "Mixed Model" ),
    Repeated Effects( :Row, :Column ),
    Repeated Structure( "Spatial" ),
    Repeated Structure Type( "Spherical" ),
    Run
);


```

**Split Plot Model**

```

dt = Open( "$SAMPLE_DATA/Split Plot.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Tenderizer, :Roasting Time, :Tenderizer * :Roasting Time ),
    Random Effects( :Carcass, :Carcass * :Tenderizer ),
    Personality( "Mixed Model" ),
    Run
);


```

### [Item Messages](#item-messages_20)

#### [Actual by Conditional Predicted Plot](#actual-by-conditional-predicted-plot)

**Syntax:** obj \<< Actual by Conditional Predicted Plot( state=0|1 )

**Description:** Shows or hides a plot of actual values versus values that are predicted by the model, while accounting for the random effects. This option is available only when the model contains at least one random effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Actual by Conditional Predicted Plot( 0 ) )
);
Wait( 1 );
obj << Actual by Conditional Predicted Plot( 1 );


```

#### [Actual by Predicted Plot](#actual-by-predicted-plot)

**Syntax:** obj \<< Actual by Predicted Plot( state=0|1 )

**Description:** Shows or hides a plot of actual values versus values that are predicted by the model, without accounting for the random effects. This option is available only when the model contains at least one fixed effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Actual by Predicted Plot( 0 ) )
);
Wait( 1 );
obj << Actual by Predicted Plot( 1 );


```

#### [Between-Within Degrees of Freedom](#between-within-degrees-of-freedom)

**Syntax:** obj \<< Between-Within Degrees of Freedom( state=0|1)

**Description:** Replaces the standard errors with unadjusted estimates and degrees of freedom to between-within based throughout the report. To use between-within degrees of freedom in a multiple comparisons report, you must select this option prior to adding a multiple comparisons report.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Treatment, :Month, :Month * :Treatment ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Subject( :Patient ),
    Repeated Effects( :Time ),
    Repeated Structure( "Unstructured" ),
    Run
);
Wait( 1 );
obj << "Between-Within Degrees of Freedom"n( 1 );


```

#### [Compare Slopes](#compare-slopes_2)

**Syntax:** obj \<< Compare Slopes( Effect( effect ), <options> )

**Description:** Shows or hides a report that enables you to compare the slopes of each level of the interaction effect in an analysis of covariance (ANCOVA) model. This option is available only when there is one nominal term, one continuous term, and their interaction effect for the fixed effects.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
obj = dt << Fit Model(
    Y( :Calories ),
    Effects( :Sugars, :Fiber Gr, :Sugars * :Fiber Gr ),
    Random Effects( :Manufacturer ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Compare Slopes(
    Effect( :Sugars * :Fiber Gr ),
    Student's t( 1, All Pairwise Comparisons Scatterplot( 0 ) )
);


```

#### [Conditional Contour Profiler](#conditional-contour-profiler)

**Syntax:** obj \<< Conditional Contour Profiler( state=0|1 )

**Description:** Shows or hides a contour profiler of the conditional response graphically for two factors at a time. This option is available only when the model contains at least two continuous effects and at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
obj = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept,
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Conditional Contour Profiler( 1 );


```

#### [Conditional Mean CI](#conditional-mean-ci_2)

**Syntax:** obj \<< Conditional Mean CI

**Description:** Saves two new columns to the data table. The new columns contain the lower and upper confidence limits for the expected value of the conditional prediction. The confidence intervals include random effects estimates for models that contain random effects. This option is available only when the model contains at least one random effect.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects( :Variety, :Variety * :Moisture ),
    Personality( "Mixed Model" ),
    Run
);
obj << Conditional Mean CI;


```

#### [Conditional Mixture Profiler](#conditional-mixture-profiler)

**Syntax:** obj \<< Conditional Mixture Profiler( state=0|1 )

**Description:** Shows or hides a mixture profiler that shows the contours of the conditional response on a ternary plot. This option is available only when the model contains at least one random effect and if the Mixture Effect attribute is applied to three or more factors in the model or the Mixture property is applied to three or more factor columns.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
obj = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept,
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Conditional Mixture Profiler( 1 );


```

#### [Conditional Prediction Formula](#conditional-prediction-formula)

**Syntax:** obj \<< Conditional Prediction Formula

**Description:** Saves a new formula column to the data table. The new column contains the prediction formula for the conditional mean. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Conditional Prediction Formula;


```

#### [Conditional Predictions](#conditional-predictions)

**Syntax:** obj \<< Conditional Predictions

**Description:** Saves a new column to the data table. The new column contains the predicted values for the conditional mean. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Conditional Predictions;


```

#### [Conditional Profiler](#conditional-profiler)

**Syntax:** obj \<< Conditional Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the conditional prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Split Plot.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Tenderizer, :Roasting Time, :Tenderizer * :Roasting Time ),
    Random Effects( :Carcass, :Carcass * :Tenderizer ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Conditional Profiler( 1 );


```

#### [Conditional Residual Plots](#conditional-residual-plots)

**Syntax:** obj \<< Conditional Residual Plots( state=0|1 )

**Description:** Shows or hides residual plots that assess model fit, while accounting for the random effects. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Conditional Residual Plots( 1 );


```

#### [Conditional Residuals](#conditional-residuals_2)

**Syntax:** obj \<< Conditional Residuals

**Description:** Saves a new formula column to the data table.The new column contains a formula for the conditional residuals, given in the form of the observed response values minus the prediction formula.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Conditional Residuals;


```

#### [Conditional Surface Profiler](#conditional-surface-profiler)

**Syntax:** obj \<< Conditional Surface Profiler( state=0|1 )

**Description:** Shows or hides a three-dimensional surface plot of the conditional response. This option is available only when the model contains at least two effects and at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Split Plot.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Tenderizer, :Roasting Time, :Tenderizer * :Roasting Time ),
    Random Effects( :Carcass, :Carcass * :Tenderizer ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Conditional Surface Profiler( 1 );


```

#### [Containment Degrees of Freedom](#containment-degrees-of-freedom)

**Syntax:** obj \<< Containment Degrees of Freedom( state=0|1 )

**Description:** Replaces the standard errors with unadjusted estimates and degrees of freedom to containment-based throughout the report. To use containment degrees of freedom in a multiple comparisons report, you must select this option prior to adding a multiple comparisons report.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Fixed Effects Tests( 0 ) )
);
Wait( 1 );
obj << Containment Degrees of Freedom( 1 );


```

#### [Contour Profiler](#contour-profiler_5)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides a contour profiler of the marginal response graphically for two factors at a time. This option is available only when the model contains at least two continuous fixed effects.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
obj = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept,
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Contour Profiler( 1 );


```

#### [Correlation of Fixed Effects](#correlation-of-fixed-effects)

**Syntax:** obj \<< Correlation of Fixed Effects( state=0|1 )

**Description:** Shows or hides the correlation matrix for the fixed effects in the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Treatment, :Month, :Month * :Treatment ),
    Random Effects( :Patient[:Treatment] ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Subject( :Patient ),
    Repeated Effects( :Days ),
    Repeated Structure( "AR(1)" ),
    Run
);
Wait( 1 );
obj << Correlation of Fixed Effects( 1 );


```

#### [Covariance of All Parameters](#covariance-of-all-parameters)

**Syntax:** obj \<< Covariance of All Parameters( state=0|1 )

**Description:** Shows or hides the covariance matrix for all effects in the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Treatment, :Month, :Month * :Treatment ),
    Random Effects( :Patient[:Treatment] ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Subject( :Patient ),
    Repeated Effects( :Days ),
    Repeated Structure( "AR(1)" ),
    Run
);
Wait( 1 );
obj << Covariance of All Parameters( 1 );


```

#### [Covariance of Covariance Parameters](#covariance-of-covariance-parameters)

**Syntax:** obj \<< Covariance of Covariance Parameters( state=0|1 )

**Description:** Shows or hides the covariance matrix for the random effects in the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Treatment, :Month, :Month * :Treatment ),
    Random Effects( :Patient[:Treatment] ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Subject( :Patient ),
    Repeated Effects( :Days ),
    Repeated Structure( "AR(1)" ),
    Run
);
Wait( 1 );
obj << Covariance of Covariance Parameters( 1 );


```

#### [Covariance of Fixed Effects](#covariance-of-fixed-effects)

**Syntax:** obj \<< Covariance of Fixed Effects( state=0|1 )

**Description:** Shows or hides the covariance matrix for the fixed effects in the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Treatment, :Month, :Month * :Treatment ),
    Random Effects( :Patient[:Treatment] ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Subject( :Patient ),
    Repeated Effects( :Days ),
    Repeated Structure( "AR(1)" ),
    Run
);
Wait( 1 );
obj << Covariance of Fixed Effects( 1 );


```

#### [Dispose Reports](#dispose-reports)

**Syntax:** obj = Fit Model(...Dispose Reports( state=0|1 )...)

**Description:** Specifies that no individual model reports are shown and that they are removed from memory after fitting. When there are many thousands of responses, this option reduces computation time and saves memory. Use this option with the Results in Data Tables option to collect the results from the fitted models.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( :Trait1, :Trait2, :Trait3 ),
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Mixed Model" ),
    Results in Data Tables( 1 ),
    Dispose Reports( 1 ),
    Run
);


```

#### [Empirical Standard Errors](#empirical-standard-errors)

**Syntax:** obj \<< Empirical Standard Errors( state=0|1 )

**Description:** Replaces the standard errors with sandwich estimates throughout the report. To use sandwich estimates in a multiple comparisons report, you must select this option prior to adding a multiple comparisons report.

**JMP Version Added:** 19

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :season, :species * :season ),
    Random Effects( :subject[:species] ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Empirical Standard Errors( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :season, :species * :season ),
    Random Effects( :subject[:species] ),
    Personality( "Mixed Model" ),
    Run( Empirical Standard Errors( 1 ) )
);
Wait( 1 );
obj << Multiple Comparisons(
    Effect( :species ),
    Comparisons with Control( 1, Control Level( "species:COYOTE" ) )
);


```

#### [Fit Statistics](#fit-statistics)

**Syntax:** obj \<< Fit Statistics( state=0|1 )

**Description:** Shows or hides a report for model fit statistics. On by default.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Fit Statistics( 0 ) )
);
Wait( 1 );
obj << Fit Statistics( 1 );


```

#### [Fixed Effects Parameter Estimates](#fixed-effects-parameter-estimates)

**Syntax:** obj \<< Fixed Effects Parameter Estimates( state=0|1 )

**Description:** Shows or hides a table of fixed effects parameter estimates. On by default.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Fixed Effects Parameter Estimates( 0 ) )
);
Wait( 1 );
obj << Fixed Effects Parameter Estimates( 1 );


```

#### [Fixed Effects Tests](#fixed-effects-tests)

**Syntax:** obj \<< Fixed Effects Tests( state=0|1 )

**Description:** Shows or hides the tests of fixed effects. This option is available only when the model contains at least one fixed effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Fixed Effects Tests( 0 ) )
);
Wait( 1 );
obj << Fixed Effects Tests( 1 );


```

#### [Homogeneity of Variance Test](#homogeneity-of-variance-test)

**Syntax:** obj \<< Homogeneity of Variance Test( state=0|1 )

**Description:** Computes a homogeneity of variance test across the specified grouping variable.

```

dt = Open( "$SAMPLE_DATA/Split Plot.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Tenderizer, :Roasting Time, :Tenderizer * :Roasting Time ),
    Random Effects( :Carcass, :Carcass * :Tenderizer ),
    Personality( "Mixed Model" ),
    Repeated Effects( :Tenderizer ),
    Repeated Structure( "Unequal Variances" ),
    Run
);
Wait( 1 );
obj << Homogeneity of Variance Test( 1 );


```

#### [Indiv Confidence Interval](#indiv-confidence-interval_3)

**Syntax:** obj \<< Indiv Confidence Interval

**Description:** Saves two new columns to the data table. The new columns contain confidence limits for individual response values.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects( :Variety, :Variety * :Moisture ),
    Personality( "Mixed Model" ),
    Run
);
obj << Indiv Confidence Interval;


```

#### [Inverse Prediction](#inverse-prediction_3)

**Syntax:** obj \<< Inverse Prediction( Response( p1, p2, ... ), Term Value( effect1( value ), effect2( value ), ... ) )

**Description:** Generates a predicted X value and confidence interval based on the specified values of Y and all other factors.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Inverse Prediction( Response( 75 ), Term Value( Moisture( . ), Variety( All ) ) );


```

#### [Linear Combination of Variance Components](#linear-combination-of-variance-components)

**Syntax:** obj \<< Linear Combination of Variance Components( [l1, l2, l3, ... ], \<Label( text )> )

**Description:** Shows a report that enables you to compute confidence intervals for linear combinations of variance components. This option is available only when there are G-side effects.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Nested.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects,
    Random Effects( :Operator, :Instrument[:Operator], :Part[:Operator, :Instrument] ),
    NoBounds( 0 ),
    Personality( "Mixed Model" ),
    Run(
        Repeated Effects Covariance Parameter Estimates( 0 ),
        Linear Combination of Variance Components( [1 1 0 1], Label( " " ) )
    )
);


```

#### [Mean Confidence Interval](#mean-confidence-interval_4)

**Syntax:** obj \<< Mean Confidence Interval

**Description:** Saves two new columns to the data table. The new columns contain the lower and upper confidence limits for the mean response.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects( :Variety, :Variety * :Moisture ),
    Personality( "Mixed Model" ),
    Run
);
obj << Mean Confidence Interval;


```

#### [Mixture Profiler](#mixture-profiler_2)

**Syntax:** obj \<< Mixture Profiler( state=0|1 )

**Description:** Shows or hides a mixture profiler that shows the contours of the marginal response on a ternary plot. This option is available only if the Mixture Effect attribute is applied to three or more factors in the model or the Mixture property is applied to three or more factor columns.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
obj = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept,
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Mixture Profiler( 1 );


```

#### [Model Dialog](#model-dialog_7)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :season, :species * :season ),
    Random Effects( :subject[:species] ),
    Personality( "Mixed Model" ),
    Run
);
obj << Model Dialog;


```

#### [Multiple Comparisons](#multiple-comparisons_2)

**Syntax:** obj \<< Multiple Comparisons( Effect( effect ), <options> )

**Description:** Generates least squares means estimates or user-defined estimates. These estimates enable you to do comparisons with the overall average, comparisons with a control, or pairwise comparisons. This option is available only when the model contains at least one fixed effect.

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :Treatment, :Month, :Treatment * :Month, :"AM/PM"n, :Treatment * :"AM/PM"n,
        :Month * :"AM/PM"n, :Treatment * :Month * :"AM/PM"n
    ),
    Random Effects( :Patient[:Treatment] ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Multiple Comparisons(
    Effect( :Treatment ),
    Comparisons with Control( 1, Control Level( "Treatment:Control" ) )
);


```

#### [Prediction Formula](#prediction-formula_4)

**Syntax:** obj \<< Prediction Formula

**Description:** Saves a new formula column to the data table. The new column contains the prediction formula for the marginal mean.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Prediction Formula;


```

#### [Prediction and Interval Formulas](#prediction-and-interval-formulas_3)

**Syntax:** obj \<< Prediction and Interval Formulas

**Description:** Saves new columns to the data table. The columns contain formulas for the predictions and confidence limits. The limits columns that are created by this option contain properties that are used by the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Prediction and Interval Formulas;
Wait( 1 );
Profiler( Y( :Pred Formula Yield 2 ) );


```

#### [Predictions](#predictions)

**Syntax:** obj \<< Predictions

**Description:** Saves a new column to the data table. The new column contains the predicted values for the marginal mean.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Predictions;


```

#### [Profiler](#profiler_5)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the marginal prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization. This option is available only when the model contains at least one fixed effect.

```

dt = Open( "$SAMPLE_DATA/Split Plot.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Tenderizer, :Roasting Time, :Tenderizer * :Roasting Time ),
    Random Effects( :Carcass, :Carcass * :Tenderizer ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Profiler( 1 );


```

#### [Random Coefficients](#random-coefficients)

**Syntax:** obj \<< Random Coefficients( state=0|1 )

**Description:** Shows or hides a report of the estimates for the random coefficients. This option is available only when the model contains at least one random effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Random Coefficients( 0 ) )
);
Wait( 1 );
obj << Random Coefficients( 1 );


```

#### [Random Effects Covariance Parameter Estimates](#random-effects-covariance-parameter-estimates)

**Syntax:** obj \<< Random Effects Covariance Parameter Estimates( state=0|1 )

**Description:** Shows or hides a table of random effects covariance parameter estimates. This option is available only when the model contains at least one random effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run( Random Effects Covariance Parameter Estimates( 0 ) )
);
Wait( 1 );
obj << Random Effects Covariance Parameter Estimates( 1 );


```

#### [Random Effects Predictions](#random-effects-predictions)

**Syntax:** obj \<< Random Effects Predictions( state=0|1 )

**Description:** Shows or hides a table of random effect predictions. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Random Effects Predictions( 1 );


```

#### [Repeated Effects Covariance Parameter Estimates](#repeated-effects-covariance-parameter-estimates)

**Syntax:** obj \<< Repeated Effects Covariance Parameter Estimates( state=0|1 )

**Description:** Shows or hides a table of repeated effects covariance parameter estimates. This option is available only when the model contains at least one repeated effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :Treatment, :Month, :Treatment * :Month, :"AM/PM"n, :Treatment * :"AM/PM"n,
        :Month * :"AM/PM"n, :Treatment * :Month * :"AM/PM"n
    ),
    Subject( :Patient ),
    Repeated Effects( :Time ),
    Repeated Structure( "Unstructured" ),
    Personality( "Mixed Model" ),
    Run( Repeated Effects Covariance Parameter Estimates( 0 ) )
);
Wait( 1 );
obj << Repeated Effects Covariance Parameter Estimates( 1 );


```

#### [Repeated Measures Covariance Diagnostics](#repeated-measures-covariance-diagnostics)

**Syntax:** obj \<< Repeated Measures Covariance Diagnostics( state=0|1 )

**Description:** Shows or hides a report that contains diagnostic tools to help determine candidate covariance structures for the repeated measures analysis. This option is available only for models that specify an unstructured repeated covariance structure.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Cholesterol Stacked.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Treatment, :Month, :Month * :Treatment ),
    NoBounds( 1 ),
    Personality( "Mixed Model" ),
    Subject( :Patient ),
    Repeated Effects( :Time ),
    Repeated Structure( "Unstructured" ),
    Run
);
Wait( 1 );
obj << Repeated Measures Covariance Diagnostics( 1 );


```

#### [Residual Plots](#residual-plots)

**Syntax:** obj \<< Residual Plots( state=0|1 )

**Description:** Shows or hides residual plots that assess model fit, without accounting for the random effects. This option is available only when the model contains at least one fixed effect.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Residual Plots( 1 );


```

#### [Residuals](#residuals_3)

**Syntax:** obj \<< Residuals

**Description:** Saves a new column to the data table. The new column contains the residuals, which are the observed response values minus their marginal mean predicted values.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Residuals;


```

#### [Results in Data Tables](#results-in-data-tables)

**Syntax:** obj = Fit Model(...Results in Data Tables( state=0|1 )...)

**Description:** Saves the individual model results across many responses into data tables. The contents and number of output data tables depend on the model being fit.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( :Trait1, :Trait2, :Trait3 ),
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Mixed Model" ),
    Results in Data Tables( 1 ),
    Run
);


```

#### [Save Simulation Formula](#save-simulation-formula)

**Syntax:** obj \<< Save Simulation Formula

**Description:** Saves a new formula column to the data table. The new column can be used to create random response values from the fitted model. You can use the formula column with the Simulate feature in JMP Pro. This option is not available if a By variable is used. Use subset data tables if By group simulation formulas are needed.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Save Simulation Formula;


```

#### [Sequential Tests](#sequential-tests_2)

**Syntax:** obj \<< Sequential Tests( state=0|1 )

**Description:** Shows or hides the Sequential (Type 1) Tests report that contains the sums of squares as effects are added to the model sequentially. This option is available only when the model contains at least one fixed effect.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Sequential Tests( 1 );


```

#### [Show Sqrt Variance Component](#show-sqrt-variance-component_2)

**Syntax:** obj \<< Show Sqrt Variance Component( state=0|1 )

**Description:** Shows or hides the Sqrt Variance Component column in the REML Variance Component Estimates report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :season, :species * :season ),
    Random Effects( :subject[:species] ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Show Sqrt Variance Component( 1 );


```

#### [Show VIF](#show-vif_2)

**Syntax:** obj \<< Show VIF( state=0|1 )

**Description:** Shows or hides the values of the variance inflation factor (VIF) in the Effect Coding tab of the Fixed Effects Parameter Estimates report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :season, :species * :season ),
    Random Effects( :subject[:species] ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Show VIF( 1 );


```

#### [Stability Analysis](#stability-analysis)

**Syntax:** obj \<< Stability Analysis

```

dt = Open( "$SAMPLE_DATA/Reliability/Stability.jmp" );
obj = dt << Fit Model(
    Y( :"Concentration (mg/Kg)"n ),
    Effects( :Time ),
    Random Effects( :Batch Number, :Batch Number * :Time ),
    NoBounds( 0 ),
    Personality( "Mixed Model" ),
    Run( Repeated Effects Covariance Parameter Estimates( 0 ) )
);
obj << Stability Analysis( Quantile( 0.1 ), Lower Spec Limit( 99 ) );


```

#### [Standard Error of Conditional Predicted](#standard-error-of-conditional-predicted)

**Syntax:** obj \<< Standard Error of Conditional Predicted

**Description:** Saves a new column to the data table. The new column contains the standard errors of the conditional mean predictions. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Standard Error of Conditional Predicted;


```

#### [Standard Error of Predicted](#standard-error-of-predicted)

**Syntax:** obj \<< Standard Error of Predicted

**Description:** Saves a new column to the data table. The new column contains the standard errors of the marginal mean predictions.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run
);
obj << Standard Error of Predicted;


```

#### [Suppress Reports](#suppress-reports)

**Syntax:** obj = Fit Model(...Suppress Reports( state=0|1 )...)

**Description:** Specifies that the individual model reports are hidden. When there are thousands of responses, this option reduces computation time. The fitting objects and some menu items are still available. Use the Results in Data Tables option to collect the results from the model reports.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( :Trait1, :Trait2, :Trait3 ),
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Mixed Model" ),
    Results in Data Tables( 1 ),
    Suppress Reports( 1 ),
    Run
);


```

#### [Surface Profiler](#surface-profiler_5)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides a three-dimensional surface plot of the marginal response. This option is available only when the model contains at least two effects.

```

dt = Open( "$SAMPLE_DATA/Split Plot.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Tenderizer, :Roasting Time, :Tenderizer * :Roasting Time ),
    Random Effects( :Carcass, :Carcass * :Tenderizer ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Surface Profiler( 1 );


```

#### [Variogram](#variogram)

**Syntax:** obj \<< Variogram( \<X( columns )>, \<Model 1, Model 2, ...> )

**Description:** Shows or hides a variogram plot that shows the change in covariance as the distance between observations increases. When the Residual structure is selected, you can select the columns to use as temporal or spatial coordinates.

```

dt = Open( "$SAMPLE_DATA/Time Series/Air.jmp" );
obj = dt << Fit Model(
    Y( :Ozone Concentration ),
    Effects,
    Center Polynomials( 0 ),
    Personality( "Mixed Model" ),
    Run
);
Wait( 1 );
obj << Variogram( X( :month ), Exponential, Exponential with Nugget );


```

### [Shared Item Messages](#shared-item-messages_7)

#### [Action](#action_7)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_7)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Broadcast](#broadcast_6)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_7)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_6)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_7)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_7)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_7)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_6)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_7)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_7)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_6)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_7)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_7)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_7)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_7)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_7)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_7)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_7)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_7)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_7)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_7)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_7)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_7)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_7)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_7)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_7)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_6)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_6)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_6)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_7)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_7)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_7)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_7)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_7)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_7)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_7)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_7)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_7)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_7)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_7)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_7)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Wheat.jmp" );
obj = dt << Fit Model(
    Y( :Yield ),
    Effects( :Moisture ),
    Random Effects(
        Intercept[:Variety] & Random Coefficients( 1 ),
        :Moisture[:Variety] & Random Coefficients( 1 )
    ),
    Personality( "Mixed Model" ),
    Run()
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_6)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_7)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_6)

**Syntax:** obj = Fit Mixed(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Nominal Logistic](#fit-nominal-logistic)

### [Associated Constructors](#associated-constructors_6)

#### [Fit Nominal Logistic](#fit-nominal-logistic_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Nominal Logistic" ) )

**Description:** Fits a logistic regression model of nominal response categories for both continuous and categorical predictors.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);


```

### [Item Messages](#item-messages_21)

#### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< Confidence Intervals( \<state=0|1> | <fraction> )

**Description:** Shows or hides profile-likelihood (1 - fraction)% confidence intervals for the model parameters. The fraction argument overrides the alpha level set in the platform launch.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Confidence Intervals( 0.01 );
Wait( 1 );
obj << Confidence Intervals( 0 );


```

#### [Confusion Matrix](#confusion-matrix)

**Syntax:** obj \<< Confusion Matrix( state=0|1 )

**Description:** Shows or hides a crosstabulation matrix of actual and predicted responses.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Confusion Matrix( 1 );


```

#### [Contour Profiler](#contour-profiler_6)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time. Available only when the model contains more than one continuous factor.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Fit Model(
    Y( :Species ),
    Effects(
        :Sepal length, :Sepal width, :Petal length, :Petal width,
        :Sepal length * :Petal width, :Petal width * :Petal width
    ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Contour Profiler( 1 );


```

#### [Decision Threshold](#decision-threshold)

**Syntax:** obj \<< Decision Threshold( state = 0|1, Set Probability Threshold( number=0.5 ) )

**Description:** Shows or hides the distribution of fitted probabilities and actual versus predicted tables for each model. You can change the probability threshold to explore how different thresholds affect the classification results.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Decision Threshold( 1, Set Probability Threshold( 0.33 ) );


```

#### [Dispose Reports](#dispose-reports_1)

**Syntax:** obj = Fit Model(...Dispose Reports( state=0|1 )...)

**Description:** Specifies that no individual model reports are shown and that they are removed from memory after fitting. When there are many thousands of responses, this option reduces computation time and saves memory. Use this option with the Results in Data Tables option to collect the results from the fitted models.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Fit Model(
    Y(
        :grain screened, :proof on ctd ink, :blade mfg, :paper type, :ink type, :direct steam,
        :solvent type, :type on cylinder, :press type, :unit number, :cylinder size,
        :paper mill location, :plating tank
    ),
    Effects( "Banding?"n ),
    Personality( "Nominal Logistic" ),
    Results in Data Tables( 1 ),
    Dispose Reports( 1 ),
    Run
);


```

#### [Effect Summary](#effect-summary_3)

**Syntax:** obj \<< Effect Summary( state=0|1 )

**Description:** Shows or hides the Effect Summary report, which enables you to interactively update the effects in the model. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Effect Summary( 0 );
Wait( 1 );
obj << Effect Summary( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [FDR](#fdr_3)

**Syntax:** obj \<< FDR( state=0|1 )

**Description:** Specifies whether the logworth values and their corresponding p-values in the Effect Summary table are adjusted using the false discovery rate (FDR).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << FDR( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Get Confusion Matrix Test](#get-confusion-matrix-test)

**Syntax:** obj \<< Get Confusion Matrix Test

**Description:** Returns the confusion matrix for the test set.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :BAD ),
    Effects(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Personality( "Nominal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Matrix Test;


```

#### [Get Confusion Matrix Training](#get-confusion-matrix-training)

**Syntax:** obj \<< Get Confusion Matrix Training

**Description:** Returns the confusion matrix for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Binary ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Nominal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Matrix Training;


```

#### [Get Confusion Matrix Validation](#get-confusion-matrix-validation)

**Syntax:** obj \<< Get Confusion Matrix Validation

**Description:** Returns the confusion matrix for the validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Binary ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Nominal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Matrix Validation;


```

#### [Get Confusion Rates Test](#get-confusion-rates-test)

**Syntax:** obj \<< Get Confusion Rates Test

**Description:** Returns the confusion rates for the test set.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :BAD ),
    Effects(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Personality( "Nominal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Rates Test;


```

#### [Get Confusion Rates Training](#get-confusion-rates-training)

**Syntax:** obj \<< Get Confusion Rates Training

**Description:** Returns the confusion rates for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Binary ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Nominal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Rates Training;


```

#### [Get Confusion Rates Validation](#get-confusion-rates-validation)

**Syntax:** obj \<< Get Confusion Rates Validation

**Description:** Returns the confusion rates for the validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Binary ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Nominal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Rates Validation;


```

#### [Get MM SAS DATA Step](#get-mm-sas-data-step_2)

**Syntax:** obj \<< Get MM SAS DATA Step

**Description:** Creates SAS code that you can register in the SAS Model Manager.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
code = obj << Get MM SAS Data Step;


```

#### [Get Measures](#get-measures_2)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Get Measures;


```

#### [Get Probability Formulas](#get-probability-formulas)

**Syntax:** obj \<< Get Probability Formulas

**Description:** Returns a script to create probability formulas.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Get Probability Formulas;


```

#### [Get SAS DATA Step](#get-sas-data-step_2)

**Syntax:** obj \<< Get SAS DATA Step

**Description:** Creates SAS code that you can use to score a new data set.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
code = obj << Get SAS Data Step;


```

#### [Indicator Parameterization Estimates](#indicator-parameterization-estimates_2)

**Syntax:** obj \<< Indicator Parameterization Estimates( state=0|1 )

**Description:** Shows or hides the Indicator Function Parameterization report. This report contains parameter estimates for the model where nominal columns are coded using indicator (SAS GLM) parameterization and are treated as continuous.

```

dt = Open( "$Sample_Data/Detergent.jmp" );
obj = dt << Fit Model(
    Freq( :count ),
    Y( :brand ),
    Effects( :softness, :previous use, :temperature ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Indicator Parameterization Estimates( 1 );


```

#### [Inverse Prediction](#inverse-prediction_4)

**Syntax:** obj \<< Inverse Prediction( Response( p1, p2, ... ), Term Value( effect1( value ), effect2( value ), ... ) )

**Description:** Generates a predicted X value and confidence interval based on the specified values of Y and all other factors.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Inverse Prediction( Response( 0.5, 0.75, 0.9 ) );


```

#### [Lift Curve](#lift-curve)

**Syntax:** obj \<< Lift Curve( state=0|1 )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Lift Curve( 1 );


```

#### [Likelihood Ratio Tests](#likelihood-ratio-tests)

**Syntax:** obj \<< Likelihood Ratio Tests( state=0|1 )

**Description:** Shows or hides likelihood ratio tests for each effect. Each test compares the log-likelihood for the fitted model to the log-likelihood for the model that removes an effect.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Likelihood Ratio Test( 1 );


```

#### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Enables you to select the color of the plot curves.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 1 );
obj << Line Color( "Magenta" );


```

#### [Logistic Plot](#logistic-plot)

**Syntax:** obj \<< Logistic Plot( state=0|1 )

**Description:** Shows or hides the Logistic Plot report. Available only if the model consists of a single continuous effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Logistic Plot( 0 );
Wait( 1 );
obj << Logistic Plot( 1 );


```

#### [Model Dialog](#model-dialog_8)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Model Dialog;


```

#### [Odds Ratios](#odds-ratios)

**Syntax:** obj \<< Odds Ratios( state=0|1 )

**Description:** Shows or hides an Odds Ratios report that contains Unit Odds Ratios and Range Odds Ratios. Not available for nominal responses with more than two levels.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Odds Ratios( 1 );


```

#### [Positive Level](#positive-level)

**Syntax:** obj \<< Positive Level

**Description:** Sets the level identified as positive for use in the ROC curves.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Positive Level( "Cured" );
obj << ROC Curve( 1 );


```

#### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Positive Level( "Cured" );
Wait( 0 );
obj << Precision Recall Curve( 1 );


```

#### [Profiler](#profiler_6)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler, which shows the fitted values for a specified response probability as the values of the factors in the model are changed.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Profiler( 1 );


```

#### [Publish Probability Formulas](#publish-probability-formulas)

**Syntax:** obj \<< Publish Probability Formulas

**Description:** Builds probability formulas and publishes them as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Publish Probability Formulas;


```

#### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Positive Level( "Cured" );
Wait( 0 );
obj << ROC Curve( 1 );


```

#### [Results in Data Tables](#results-in-data-tables_1)

**Syntax:** obj = Fit Model(...Results in Data Tables( state=0|1 )...)

**Description:** Saves the individual model results across many responses into data tables. The contents and number of output data tables depend on the model being fit.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Fit Model(
    Y(
        :grain screened, :proof on ctd ink, :blade mfg, :paper type, :ink type, :direct steam,
        :solvent type, :type on cylinder, :press type, :unit number, :cylinder size,
        :paper mill location, :plating tank
    ),
    Effects( "Banding?"n ),
    Personality( "Nominal Logistic" ),
    Results in Data Tables( 1 ),
    Run
);


```

#### [Save Probability Formula](#save-probability-formula)

**Syntax:** obj \<< Save Probability Formula

**Description:** Saves new columns to the data table. The new columns contain formulas for linear combinations of the response levels, prediction formulas for the response levels, and a prediction formula that gives the most likely response.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Save Probability Formula;


```

#### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the points in the logistic plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 1 );
obj << Show Points( 0 );


```

#### [Show Rate Curve](#show-rate-curve)

**Syntax:** obj \<< Show Rate Curve( state=0|1 )

**Description:** Shows or hides the rate curve in the logistic plot. The rate curve is useful only if you have several points for each value of the X variable.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 1 );
obj << Show Rate Curve( 1 );


```

#### [Specify Profit Matrix](#specify-profit-matrix)

**Syntax:** obj \<< Specify Profit Matrix( matrix, level1, level2, ... )

**Description:** Enables you to specify profits or costs associated with correct or incorrect classification decisions.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y Binary ),
    Effects( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Nominal Logistic" ),
    Run
);
Wait( 0 );
obj << Specify Profit Matrix( [0 -1, -1 0, . .], "High", "Low", "Undecided" );


```

#### [Suppress Reports](#suppress-reports_1)

**Syntax:** obj = Fit Model(...Suppress Reports( state=0|1 )...)

**Description:** Specifies that the individual model reports are hidden. When there are thousands of responses, this option reduces computation time. The fitting objects and some menu items are still available. Use the Results in Data Tables option to collect the results from the model reports.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Fit Model(
    Y(
        :grain screened, :proof on ctd ink, :blade mfg, :paper type, :ink type, :direct steam,
        :solvent type, :type on cylinder, :press type, :unit number, :cylinder size,
        :paper mill location, :plating tank
    ),
    Effects( "Banding?"n ),
    Personality( "Nominal Logistic" ),
    Results in Data Tables( 1 ),
    Suppress Reports( 1 ),
    Run
);


```

#### [Wald Tests](#wald-tests)

**Syntax:** obj \<< Wald Tests( state=0|1 )

**Description:** Shows or hides chi-square test statistics and p-values for Wald tests of whether each parameter is zero.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Wald Tests( 1 );


```

### [Shared Item Messages](#shared-item-messages_8)

#### [Action](#action_8)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_8)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_5)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_7)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_8)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_7)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_8)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_8)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_8)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_7)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_8)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_8)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_7)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_8)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_8)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_8)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_8)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_8)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_8)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_8)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_8)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_8)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_8)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_8)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_8)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_8)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_8)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_8)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_7)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_7)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_7)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_8)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_8)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_8)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_8)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_8)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_8)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_8)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_8)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_8)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_8)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_8)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_8)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_7)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_8)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_7)

**Syntax:** obj = Fit Nominal Logistic(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Ordinal Logistic](#fit-ordinal-logistic)

### [Associated Constructors](#associated-constructors_7)

#### [Fit Ordinal Logistic](#fit-ordinal-logistic_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Ordinal Logistic" ) )

**Description:** Fits a logistic regression model of ordinal response categories for both continuous and categorical predictors.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);


```

### [Columns](#columns)

#### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);


```

### [Item Messages](#item-messages_22)

#### [Confidence Intervals](#confidence-intervals_1)

**Syntax:** obj \<< Confidence Intervals( \<state=0|1> | <fraction> )

**Description:** Shows or hides profile-likelihood (1 - fraction)% confidence intervals for the model parameters. The fraction argument overrides the alpha level set in the platform launch.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Confidence Intervals( 0.01 );
Wait( 1 );
obj << Confidence Intervals( 0 );


```

#### [Confusion Matrix](#confusion-matrix_1)

**Syntax:** obj \<< Confusion Matrix( state=0|1 )

**Description:** Shows or hides a crosstabulation matrix of actual and predicted responses.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
Wait( 0 );
obj << Confusion Matrix( 1 );


```

#### [Contour Profiler](#contour-profiler_7)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time. Available only when the model contains more than one continuous factor.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Fit Model(
    Y( :Job Satisfaction ),
    Effects(
        :Years at Current Employer, :Salary, :Single Status, :Age in Years,
        :Age in Years * :Years at Current Employer
    ),
    Personality( "Ordinal Logistic" ),
    Run
);
Wait( 0 );
obj << Contour Profiler( 1 );


```

#### [Dispose Reports](#dispose-reports_2)

**Syntax:** obj = Fit Model(...Dispose Reports( state=0|1 )...)

**Description:** Specifies that no individual model reports are shown and that they are removed from memory after fitting. When there are many thousands of responses, this option reduces computation time and saves memory. Use this option with the Results in Data Tables option to collect the results from the fitted models.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Fit Model(
    Y( :Employee Tenure, :Position Tenure, :Job Satisfaction ),
    Effects( :Gender, :Birth Year, :Single Status, :School Age Children ),
    Personality( "Ordinal Logistic" ),
    Results in Data Tables( 1 ),
    Dispose Reports( 1 ),
    Run
);


```

#### [Effect Summary](#effect-summary_4)

**Syntax:** obj \<< Effect Summary( state=0|1 )

**Description:** Shows or hides the Effect Summary report, which enables you to interactively update the effects in the model. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Effect Summary( 0 );
Wait( 1 );
obj << Effect Summary( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [FDR](#fdr_4)

**Syntax:** obj \<< FDR( state=0|1 )

**Description:** Specifies whether the logworth values and their corresponding p-values in the Effect Summary table are adjusted using the false discovery rate (FDR).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << FDR( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Get Confusion Matrix Test](#get-confusion-matrix-test_1)

**Syntax:** obj \<< Get Confusion Matrix Test

**Description:** Returns the confusion matrix for the test set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Fit Model(
    Validation( :Validation 2 ),
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Ordinal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Matrix Test;


```

#### [Get Confusion Matrix Training](#get-confusion-matrix-training_1)

**Syntax:** obj \<< Get Confusion Matrix Training

**Description:** Returns the confusion matrix for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Ordinal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Matrix Training;


```

#### [Get Confusion Matrix Validation](#get-confusion-matrix-validation_1)

**Syntax:** obj \<< Get Confusion Matrix Validation

**Description:** Returns the confusion matrix for the validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Ordinal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Matrix Validation;


```

#### [Get Confusion Rates Test](#get-confusion-rates-test_1)

**Syntax:** obj \<< Get Confusion Rates Test

**Description:** Returns the confusion rates for the test set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Fit Model(
    Validation( :Validation 2 ),
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Ordinal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Rates Test;


```

#### [Get Confusion Rates Training](#get-confusion-rates-training_1)

**Syntax:** obj \<< Get Confusion Rates Training

**Description:** Returns the confusion rates for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Ordinal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Rates Training;


```

#### [Get Confusion Rates Validation](#get-confusion-rates-validation_1)

**Syntax:** obj \<< Get Confusion Rates Validation

**Description:** Returns the confusion rates for the validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Ordinal Logistic" ),
    Run( Confusion Matrix( 1 ) )
);
obj << Get Confusion Rates Validation;


```

#### [Get MM SAS DATA Step](#get-mm-sas-data-step_3)

**Syntax:** obj \<< Get MM SAS DATA Step

**Description:** Creates SAS code that you can register in the SAS Model Manager.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
code = obj << Get MM SAS Data Step;


```

#### [Get Measures](#get-measures_3)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Get Measures;


```

#### [Get Probability Formulas](#get-probability-formulas_1)

**Syntax:** obj \<< Get Probability Formulas

**Description:** Returns a script to create probability formulas.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Get Probability Formulas;


```

#### [Get SAS DATA Step](#get-sas-data-step_3)

**Syntax:** obj \<< Get SAS DATA Step

**Description:** Creates SAS code that you can use to score a new data set.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
code = obj << Get SAS Data Step;


```

#### [Lift Curve](#lift-curve_1)

**Syntax:** obj \<< Lift Curve( state=0|1 )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Cheese.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :Cheese ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Lift Curve( 1 );


```

#### [Likelihood Ratio Tests](#likelihood-ratio-tests_1)

**Syntax:** obj \<< Likelihood Ratio Tests( state=0|1 )

**Description:** Shows or hides likelihood ratio tests for each effect. Each test compares the log-likelihood for the fitted model to the log-likelihood for the model that removes an effect.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Likelihood Ratio Tests( 1 );


```

#### [Logistic Plot](#logistic-plot_1)

**Syntax:** obj \<< Logistic Plot( state=0|1 )

**Description:** Shows or hides the Logistic Plot report. Available only if the model consists of a single continuous effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Logistic Plot( 0 );
Wait( 1 );
obj << Logistic Plot( 1 );


```

#### [Model Dialog](#model-dialog_9)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Model Dialog;


```

#### [Odds Ratios](#odds-ratios_1)

**Syntax:** obj \<< Odds Ratios( state=0|1 )

**Description:** Shows or hides an Odds Ratios report that contains Unit Odds Ratios and Range Odds Ratios.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Ordinal Logistic" ),
    Run
);
Wait( 0 );
obj << Odds Ratios( 1 );


```

#### [Precision Recall Curve](#precision-recall-curve_1)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Precision Recall Curve( 1 );


```

#### [Profiler](#profiler_7)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler, which shows the fitted values for a specified response probability as the values of the factors in the model are changed.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
Wait( 0 );
obj << Profiler( 1 );


```

#### [Publish Probability Formulas](#publish-probability-formulas_1)

**Syntax:** obj \<< Publish Probability Formulas

**Description:** Builds probability formulas and publishes them as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Publish Probability Formulas;


```

#### [ROC Curve](#roc-curve_1)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << ROC Curve( 1 );


```

#### [Results in Data Tables](#results-in-data-tables_2)

**Syntax:** obj = Fit Model(...Results in Data Tables( state=0|1 )...)

**Description:** Saves the individual model results across many responses into data tables. The contents and number of output data tables depend on the model being fit.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Fit Model(
    Y( :Employee Tenure, :Position Tenure, :Job Satisfaction ),
    Effects( :Gender, :Birth Year, :Single Status, :School Age Children ),
    Personality( "Ordinal Logistic" ),
    Results in Data Tables( 1 ),
    Run
);


```

#### [Save Expected Value](#save-expected-value)

**Syntax:** obj \<< Save Expected Value

**Description:** Saves a new column to the data table. The new column contains the linear combination of the response values with the fitted response probabilities for each row and gives the expected value.

```

dt = Open( "$SAMPLE_DATA/Cheese.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :Cheese ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Expected Value;


```

#### [Save Probability Formula](#save-probability-formula_1)

**Syntax:** obj \<< Save Probability Formula

**Description:** Saves new columns to the data table. The new columns contain formulas for linear combinations of the response levels, prediction formulas for the response levels, and a prediction formula that gives the most likely response.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Probability Formula;


```

#### [Save Quantiles](#save-quantiles)

**Syntax:** obj \<< Save Quantiles

**Description:** Saves new columns to the data table. The new columns are named OrdQ.05, OrdQ.50, and OrdQ.95, and they contain values that fit the quantiles for the corresponding probabilities.

```

dt = Open( "$SAMPLE_DATA/Cheese.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :Cheese ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Quantiles;


```

#### [Suppress Reports](#suppress-reports_2)

**Syntax:** obj = Fit Model(...Suppress Reports( state=0|1 )...)

**Description:** Specifies that the individual model reports are hidden. When there are thousands of responses, this option reduces computation time. The fitting objects and some menu items are still available. Use the Results in Data Tables option to collect the results from the model reports.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Fit Model(
    Y( :Employee Tenure, :Position Tenure, :Job Satisfaction ),
    Effects( :Gender, :Birth Year, :Single Status, :School Age Children ),
    Personality( "Ordinal Logistic" ),
    Results in Data Tables( 1 ),
    Suppress Reports( 1 ),
    Run
);


```

#### [Wald Tests](#wald-tests_1)

**Syntax:** obj \<< Wald Tests( state=0|1 )

**Description:** Shows or hides chi-square test statistics and p-values for Wald tests of whether each parameter is zero.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Wald Tests( 1 );


```

### [Shared Item Messages](#shared-item-messages_9)

#### [Action](#action_9)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_9)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_6)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_8)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_9)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_8)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_9)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_9)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_9)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_8)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_9)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_9)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_8)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_9)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_9)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_9)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_9)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_9)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_9)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_9)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_9)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_9)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_9)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_9)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_9)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_9)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_9)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_9)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_8)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_8)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_8)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_9)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_9)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_9)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_9)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_9)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_9)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_9)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_9)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_9)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_9)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_9)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_9)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Denim.jmp" );
obj = dt << Fit Model(
    Y( :Thread Wear ),
    Effects( :"Size of Load (lbs)"n ),
    Personality( "Ordinal Logistic" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_8)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_9)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_8)

**Syntax:** obj = Fit Ordinal Logistic(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Parametric Survival](#fit-parametric-survival)

### [Associated Constructors](#associated-constructors_8)

#### [Fit Parametric Survival](#fit-parametric-survival_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Parametric Survival" ), Censor( columns ) )

**Description:** Fits a general linear regression model to survival times. These models can be used for survival times that can be expressed as a function of one or more explanatory variables. Takes into account various survival distributions and censoring.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);


```

### [Item Messages](#item-messages_23)

#### [Correlation of Estimates](#correlation-of-estimates_3)

**Syntax:** obj \<< Correlation of Estimates( state=0|1 )

**Description:** Shows or hides the matrix of correlations between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Correlation of Estimates( 1 );


```

#### [Covariance of Estimates](#covariance-of-estimates_1)

**Syntax:** obj \<< Covariance of Estimates( state=0|1 )

**Description:** Shows or hides the matrix of covariances between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Covariance of Estimates( 1 );


```

#### [Distribution](#distribution)

**Syntax:** obj = Fit Model(...Distribution("Weibull"|"Lognormal"|"Exponential"|"Frechet"|"Loglogistic"|"All Distributions"|"SEV"|"Normal"|"LEV"|"Logistic"...)

**Description:** Specifies the distribution to use in modeling the Time to Event response. The "All Distributions" option fits all of the available distributions.

**All Distributions**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "All Distributions" ),
    Censor( :censor ),
    Run Model
);


```

**Single Distribution**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Lognormal" ),
    Censor( :censor ),
    Run Model
);


```

#### [Distribution Plot by Level Combinations](#distribution-plot-by-level-combinations)

**Syntax:** obj \<< Distribution Plot by Level Combinations( state=0|1 )

**Description:** Shows or hides a report that compares three nested models based on the levels of the X variable. This report contains three probability plots for assessing model fit. The plots show different lines for each combination of the X levels.

```

dt = Open( "$SAMPLE_DATA/reliability/Devalt.jmp" );
dt << Fit Model(
    Censor( :Censor ),
    Censor Code( "1" ),
    Freq( :Weight ),
    Y( :Hours ),
    Effects( :x ),
    Personality( "Parametric Survival" ),
    Distribution( "Lognormal" ),
    Run( Likelihood Ratio Tests( 1 ), Distribution Plot by Level Combinations( 1 ), )
);


```

#### [Distribution Profiler](#distribution-profiler)

**Syntax:** obj \<< Distribution Profiler( state=0|1 )

**Description:** Shows or hides a profiler of the cumulative distribution function of the predictors and the response. The response is shown in the right-most cell.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Distribution Profiler( 1 );


```

#### [Effect Summary](#effect-summary_5)

**Syntax:** obj \<< Effect Summary( state=0|1 )

**Description:** Shows or hides the Effect Summary report, which enables you to interactively update the effects in the model. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Effect Summary( 0 );
Wait( 1 );
obj << Effect Summary( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Estimate Quantile](#estimate-quantile)

**Syntax:** obj \<< Estimate Quantile( x1 = [number, ...], x2 = [number, ...], [p1, p2, ...], Alpha( fraction ) )

**Description:** Estimates the quantiles for specified effect values and probabilities. Use a vector to specify more than one value for an effect or more than one probability value.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Estimate Quantile(
    :Age = [55, 60],
    :Diag Time = [8.77],
    [0.5, 0.10, 0.05],
    Alpha( 0.05 )
);


```

#### [Estimate Survival Probability](#estimate-survival-probability)

**Syntax:** obj \<< Estimate Survival Probability( x1 = [number, ...], x2 = [number, ...], [time1, time2, ...], Alpha( fraction ) )

**Description:** Estimates the failure and survival probabilities for specified effect values and time values. Use a vector to specify more than one value for an effect or more than one time value.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Estimate Survival Probability(
    :Age = [55, 60],
    :Diag Time = [8.77],
    [50, 100, 150],
    Alpha( 0.05 )
);


```

#### [FDR](#fdr_5)

**Syntax:** obj \<< FDR( state=0|1 )

**Description:** Specifies whether the logworth values and their corresponding p-values in the Effect Summary table are adjusted using the false discovery rate (FDR).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << FDR( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Get Effect Names](#get-effect-names_2)

**Syntax:** obj \<< Get Effect Names

**Description:** Returns the effect names used in the model.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
n = obj << Get Effect Names;
Show( n );


```

#### [Get Effect PValues](#get-effect-pvalues_2)

**Syntax:** obj \<< Get Effect PValues

**Description:** Returns the p-values for each effect in the model.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
p = obj << Get Effect PValues;
Show( p );


```

#### [Get Estimates](#get-estimates_2)

**Syntax:** obj \<< Get Estimates

**Description:** Returns the parameter estimates in the model.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
e = obj << Get Estimates;
Show( e );


```

#### [Get Parameter Names](#get-parameter-names_2)

**Syntax:** obj \<< Get Parameter Names

**Description:** Returns the parameter names used in the model.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
n = obj << Get Parameter Names;
Show( n );


```

#### [Get Std Errors](#get-std-errors_2)

**Syntax:** obj \<< Get Std Errors

**Description:** Returns the standard errors for the parameter estimates in the model.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
std = obj << Get Std Errors;
Show( std );


```

#### [Hazard Profiler](#hazard-profiler)

**Syntax:** obj \<< Hazard Profiler( state=0|1 )

**Description:** Shows or hides a profiler that shows the hazard rate as a function of the predictors and the response. The response is shown in the right-most cell.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Hazard Profiler( 1 );


```

#### [Likelihood Confidence Intervals](#likelihood-confidence-intervals)

**Syntax:** obj \<< Likelihood Confidence Intervals( state=0|1 )

**Description:** Specifies the type of confidence intervals that are shown in the Parameter Estimates table. When this option is selected, a profile likelihood confidence interval appears. Otherwise, a Wald interval appears. This option is on by default when the computational time for the profile likelihood confidence intervals is not large.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Likelihood Confidence Intervals( 1 );


```

#### [Likelihood Ratio Tests](#likelihood-ratio-tests_2)

**Syntax:** obj \<< Likelihood Ratio Tests( state=0|1 )

**Description:** Shows or hides likelihood ratio tests for each effect. Each test compares the log-likelihood for the fitted model to the log-likelihood for the model that removes an effect. On by default.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Likelihood Ratio Tests( 1 );


```

#### [Model Dialog](#model-dialog_10)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Model Dialog;


```

#### [Publish Probability Formula](#publish-probability-formula)

**Syntax:** obj \<< Publish Probability Formula

**Description:** Creates a probability formula and publishes it as a formula column script in the Formula Depot platform.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Publish Probability Formula;


```

#### [Publish Quantile Formula](#publish-quantile-formula)

**Syntax:** obj \<< Publish Quantile Formula( probability )

**Description:** Creates a quantile formula and publishes it as a formula column script in the Formula Depot platform.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Publish Quantile Formula( 0.1 );


```

#### [Quantile Profiler](#quantile-profiler)

**Syntax:** obj \<< Quantile Profiler( state=0|1 )

**Description:** Shows or hides a profiler that shows the predicted response as a function of the predictors and the quantile of the cumulative distribution function. The quantile is called Failure Probability and is shown in the right-most cell.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Quantile Profiler( 1 );


```

#### [Residual Probability Plot](#residual-probability-plot)

**Syntax:** obj \<< Residual Probability Plot( state=0|1 )

**Description:** Shows or hides a probability plot of the standardized residuals with confidence intervals.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Residual Probability Plot( 1 );


```

#### [Response versus Fitted Median](#response-versus-fitted-median)

**Syntax:** obj \<< Response versus Fitted Median( state=0|1 )

**Description:** Shows or hides a plot of the responses on the vertical axis and the fitted median on the horizontal axis.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Response versus Fitted Median( 1 );


```

#### [Save Probability Formula](#save-probability-formula_2)

**Syntax:** obj \<< Save Probability Formula

**Description:** Saves a new formula column to the data table. The new column contains a formula for the estimated probability of failure.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Probability Formula;


```

#### [Save Quantile Formula](#save-quantile-formula)

**Syntax:** obj \<< Save Quantile Formula( probability )

**Description:** Saves a new formula column to the data table. The new column contains a formula for the estimated quantile for the specified probability value.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Quantile Formula( 0.8 );


```

#### [Save Residuals](#save-residuals_1)

**Syntax:** obj \<< Save Residuals

**Description:** Saves one or two new columns to the data table. The number of residual columns matches the number of Time to Event columns in the model.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Residuals;


```

#### [Standardized Residuals versus Fitted Median](#standardized-residuals-versus-fitted-median)

**Syntax:** obj \<< Standardized Residuals versus Fitted Median( state=0|1 )

**Description:** Shows or hides a plot of the standardized residuals on the vertical axis and the fitted median on the horizontal axis.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Standardized Residuals versus Fitted Median( 1 );


```

#### [Survival Profiler](#survival-profiler)

**Syntax:** obj \<< Survival Profiler( state=0|1 )

**Description:** Shows or hides a profiler of the survival function of the predictors and the response. The response is shown in the right-most cell.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Survival Profiler( 1 );


```

#### [Wald Tests](#wald-tests_2)

**Syntax:** obj \<< Wald Tests( state=0|1 )

**Description:** Shows or hides chi-square test statistics and p-values for Wald tests of whether each parameter is zero.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Wald Tests( 0 );
Wait( 2 );
obj << Wald Tests( 1 );


```

### [Shared Item Messages](#shared-item-messages_10)

#### [Action](#action_10)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_10)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_7)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_9)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_10)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_9)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_10)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_10)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_10)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_9)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_10)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_10)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_9)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_10)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_10)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_10)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_10)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_10)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_10)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_10)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_10)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_10)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_10)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_10)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_10)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_10)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_10)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_10)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_9)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_9)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_9)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_10)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_10)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_10)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_10)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_10)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_10)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_10)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_10)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_10)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_10)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_10)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_10)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Parametric Survival" ),
    Distribution( "Weibull" ),
    Censor( :censor ),
    Run Model
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_9)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_10)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_9)

**Syntax:** obj = Fit Parametric Survival(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Proportional Hazards](#fit-proportional-hazards)

### [Associated Constructors](#associated-constructors_9)

#### [Fit Proportional Hazards](#fit-proportional-hazards_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Proportional Hazard" ), Censor( columns ) )

**Description:** Fits a semiparametric regression model (the Cox proportional hazards model) to assess the effect of explanatory variables on survival times while taking censoring into account.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);


```

### [Columns](#columns_1)

#### [By](#by_1)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);


```

### [Item Messages](#item-messages_24)

#### [Effect Summary](#effect-summary_6)

**Syntax:** obj \<< Effect Summary( state=0|1 )

**Description:** Shows or hides the Effect Summary report, which enables you to interactively update the effects in the model. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Effect Summary( 0 );
Wait( 1 );
obj << Effect Summary( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [FDR](#fdr_6)

**Syntax:** obj \<< FDR( state=0|1 )

**Description:** Specifies whether the logworth values and their corresponding p-values in the Effect Summary table are adjusted using the false discovery rate (FDR).

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << FDR( 1 );
Report( obj )["Effect Summary"] << Close( 0 );


```

#### [Hazard Ratios](#hazard-ratios)

**Syntax:** obj \<< Hazard Ratios( state=0|1 )

**Description:** Shows or hides the hazard ratios for the effects.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Hazard Ratios( 1 );


```

#### [Likelihood Confidence Intervals](#likelihood-confidence-intervals_1)

**Syntax:** obj \<< Likelihood Confidence Intervals( state=0|1 )

**Description:** Specifies the type of confidence intervals that are shown in the Parameter Estimates table. When this option is selected, a profile likelihood confidence interval appears. Otherwise, a Wald interval appears. This option is on by default when the computational time for the profile likelihood confidence intervals is not large.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Likelihood Confidence Intervals( 1 );


```

#### [Likelihood Ratio Tests](#likelihood-ratio-tests_3)

**Syntax:** obj \<< Likelihood Ratio Tests( state=0|1 )

**Description:** Shows or hides likelihood ratio tests for each effect. Each test compares the log-likelihood for the fitted model to the log-likelihood for the model that removes an effect.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Likelihood Ratio Tests( 1 );


```

#### [Model Dialog](#model-dialog_11)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Model Dialog;


```

#### [Wald Tests](#wald-tests_3)

**Syntax:** obj \<< Wald Tests( state=0|1 )

**Description:** Shows or hides chi-square test statistics and p-values for Wald tests of whether each parameter is zero. On by default.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Wald Tests( 0 );
Wait( 2 );
obj << Wald Tests( 1 );


```

### [Shared Item Messages](#shared-item-messages_11)

#### [Action](#action_11)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_11)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Broadcast](#broadcast_10)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_11)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_10)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_11)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_11)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_11)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_10)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_11)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_11)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_10)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_11)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_11)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_11)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_11)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_11)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_11)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_11)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_11)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_11)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_11)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_11)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_11)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_11)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_11)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_11)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_10)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_10)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_10)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_11)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_11)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run Model
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_11)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_11)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_11)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_11)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_11)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_11)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_11)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_11)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_11)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_11)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Run Model
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_10)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_11)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_10)

**Syntax:** obj = Fit Proportional Hazards(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Response Screening](#fit-response-screening)

### [Associated Constructors](#associated-constructors_10)

#### [Fit Response Screening](#fit-response-screening_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Response Screening" ) )

**Description:** Automates the process of conducting tests for linear model effects across a large number of responses. Test results and summary statistics are presented in data tables and plots. The false discovery rate (FDR) guards against incorrect declarations of significance. A robust estimation method reduces the sensitivity of tests to outliers.

**Fit a Few Columns with Many Switched Predictors**

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Switch( Column Group( "Markers" ) ),
    Effects( :Disease Status ),
    Personality( "Response Screening" ),
    Run
);


```

**Fit Many Columns on Four Predictors**

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);


```

**Fit Many Columns with Sliced LSMeans Differences**

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Father, :Mother, :Sex, :Disease Status ),
    Personality( "Response Screening" ),
    Run( (Sliced LSMeans Differences( 1 )) )
);


```

**Fit Many Columns with Subgroups**

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Subgroup( :Father, :Mother, :Sex, :Disease Status ),
    Run
);


```

**Fit with a Random Effect**

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Effects( :Sex, :Disease Status ),
    Random Effects( :Sample ),
    Personality( "Response Screening" ),
    Run( (Sliced LSMeans Differences( 1 )) )
);


```

### [Item Messages](#item-messages_25)

#### [Effect Plots](#effect-plots)

**Syntax:** obj \<< Effect Plots( state=0|1 )

**Description:** Shows or hides the FDR PValue Plot for Effects and the FDR Logworth by Effect Size plot. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run( Effect Plots( 0 ) )
);
Wait( 1 );
obj << Effect Plots( 1 );


```

#### [Effect Tests](#effect-tests_2)

**Syntax:** obj \<< Effect Tests( state=0|1 )

**Description:** Shows or hides the Effect Tests table. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run( Effect Tests( 0 ) )
);
Wait( 1 );
obj << Effect Tests( 1 );


```

#### [Force G Side](#force-g-side)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Response Screening" ), Run( Force G Side ) )

**Description:** Forces the random effects to be estimated on the G side, even if the random effects matrix has more columns than rows.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :season, :species * :season ),
    Random Effects( :subject[:species] ),
    Personality( "Response Screening" ),
    Run( Force G Side )
);


```

#### [Force R Side](#force-r-side)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Response Screening" ), Run( Force R Side ) )

**Description:** Forces the random effects to be estimated on the R side, even if the random effects matrix has more rows than columns.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Response Screening" ),
    Y( :Trait1 ),
    Run( Force R Side )
);


```

#### [Least Squares Means](#least-squares-means)

**Syntax:** obj \<< Least Squares Means( state=0|1 )

**Description:** Calculates all least squares (marginal) means.

```

dt = Open( "$Sample_Data/Popcorn.jmp" );
obj = dt << Fit Model(
    Y( :yield ),
    Effects(
        :popcorn, :oil amt, :popcorn * :oil amt, :batch, :popcorn * :batch, :oil amt * :batch,
        :popcorn * :oil amt * :batch
    ),
    Personality( "Response Screening" ),
    Run
);
Wait( 0 );
obj << Least Squares Means( 1 );


```

#### [Model Dialog](#model-dialog_12)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run
);
obj << Model Dialog;


```

#### [Overall Plots](#overall-plots)

**Syntax:** obj \<< Overall Plots( state=0|1 )

**Description:** Shows or hides the Overall FDR PValue Plot and the FDR Logworth by RSquare plot.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run
);
obj << Overall Plots( 1 );


```

#### [Overall Report](#overall-report)

**Syntax:** obj \<< Overall Report( state=0|1 )

**Description:** Shows or hides the Overall Fit table.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run
);
Wait( 0 );
obj << Overall Report( 1 );


```

#### [Save BLUPs](#save-blups)

**Syntax:** obj \<< Save BLUPs

**Description:** Creates a new data table that contains the best linear unbiased predictors (BLUPs) for the random effects in the model.

```


Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = Fit Model(
    Y( :Trait1, :Trait2, :Trait3 ),
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Response Screening" ),
    Run
);
obj << Save BLUPs;


```

#### [Save Conditional Predicted Values](#save-conditional-predicted-values)

**Syntax:** obj \<< Save Conditional Predicted Values

**Description:** Saves a new column for each response to the data table. The column contains the conditional predicted values that are calculated using the best linear unbiased predictors (BLUPs) for the random effects coefficients.

```


Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = Fit Model(
    Y( :Trait1, :Trait2, :Trait3 ),
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Conditional Predicted Values;


```

#### [Save Conditional Prediction Formula](#save-conditional-prediction-formula)

**Syntax:** obj \<< Save Conditional Prediction Formula

**Description:** Saves a new formula column for each response to the data table. The new column contains a formula that includes random effect estimates for models with random effects. Available only for REML analysis methods.

```


Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = Fit Model(
    Y( :Trait1, :Trait2, :Trait3 ),
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Conditional Prediction Formula;


```

#### [Save Effect Tests](#save-effect-tests)

**Syntax:** obj \<< Save Effect Tests

**Description:** Creates a new data table that contains a row for each effect test.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Effect Tests;


```

#### [Save Estimates](#save-estimates)

**Syntax:** obj \<< Save Estimates

**Description:** Creates a new data table that contains a row for each response variable and a column for each model term.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Estimates;


```

#### [Save LSMeans Differences](#save-lsmeans-differences)

**Syntax:** obj \<< Save LSMeans Differences

**Description:** Creates a new data table that contains all of the sliced least squares means differences.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
obj = dt << Fit Model(
    Effects( :age, :sex, :age * :sex ),
    Personality( "Response Screening" ),
    Y( :height, :weight ),
    Sliced LSMeans Differences( 1 ),
    Run
);
obj << Save LSMeans Differences;


```

#### [Save Least Squares Means](#save-least-squares-means)

**Syntax:** obj \<< Save Least Squares Means

**Description:** Creates a new data table that contains all of the least squares means.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
obj = dt << Fit Model(
    Y( :height, :weight ),
    Effects( :age, :sex ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Least Squares Means;


```

#### [Save Overall Fit](#save-overall-fit)

**Syntax:** obj \<< Save Overall Fit

**Description:** Creates a new data table that contains one row per response variable. For each Y, the columns in the table summarize information about the model fit.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Overall Fit;


```

#### [Save Predicted Values](#save-predicted-values)

**Syntax:** obj \<< Save Predicted Values

**Description:** Saves a new column for each response to the data table. Each column contains the predicted values for the corresponding response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run( Save Predicted Values )
);


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves a new formula column for each response to the data table. Each column contains a prediction equation for the corresponding response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run( Save Prediction Formula )
);


```

#### [Select Effects Where](#select-effects-where)

**Syntax:** obj \<< Select Effects Where( condition )

**Description:** Opens the Select Where window, which enables you to select rows in the Effects Tests table that correspond to the particular condition specified in the Select Where window.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run
);
obj << Select Effects Where( FDR Logworth > 4 );


```

#### [Select Responses for Selected Effects](#select-responses-for-selected-effects)

**Syntax:** obj \<< Select Responses for Selected Effects

**Description:** Selects response columns in the original table that correspond to selected effects.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Response Screening" ),
    Run()
);
obj << Select Effects Where( FDR Logworth > 4 );
obj << Select Responses for Selected Effects;


```

#### [Sliced LSMeans Differences](#sliced-lsmeans-differences)

**Syntax:** obj \<< Sliced LSMeans Differences( state=0|1 )

**Description:** Calculates tests comparing all least squares means on main effects and slices of 2-factor and 3-factor interactions.

```

dt = Open( "$Sample_Data/Popcorn.jmp" );
obj = dt << Fit Model(
    Y( :yield ),
    Effects(
        :popcorn, :oil amt, :popcorn * :oil amt, :batch, :popcorn * :batch, :oil amt * :batch,
        :popcorn * :oil amt * :batch
    ),
    Personality( "Response Screening" ),
    Run
);
Wait( 0 );
obj << Sliced LSMeans Differences( 1 );


```

#### [Unthreaded](#unthreaded)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Response Screening" ), Run( Unthreaded ) )

**Description:** Suppresses multithreading across responses (and Switch variables).

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Effects( :Sex ),
    Random Effects( Grouped( Column Group( "Markers" ) ) ),
    Personality( "Response Screening" ),
    Y( :Trait1 ),
    Run( Unthreaded )
);


```

### [Shared Item Messages](#shared-item-messages_12)

#### [Action](#action_12)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_12)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_8)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_11)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_12)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_11)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_12)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_12)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_12)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_11)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_12)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_12)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_11)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_12)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_12)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_12)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_12)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_12)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_12)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_12)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_12)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_12)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_12)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_12)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_12)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_12)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_12)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_12)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_11)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_11)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_11)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_12)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_12)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_12)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_12)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_12)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_12)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_12)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_12)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_12)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_12)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_12)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_12)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Fit Model(
    Y( Column Group( "Markers" ) ),
    Effects( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Personality( "Response Screening" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_11)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_12)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_11)

**Syntax:** obj = Fit Response Screening(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Stepwise](#fit-stepwise)

### [Associated Constructors](#associated-constructors_11)

#### [Fit Stepwise](#fit-stepwise_1)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Stepwise" ) )

**Description:** Fits stepwise regression models, which facilitate variable selection for standard least squares and ordinal logistic models, as well as nominal logistic models with a binary response.

**All Possible Models**

```


dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Stepwise" ),
    Run
);
obj << All Possible Models( 10, 5, Heredity Restriction( 1 ) );


```

**Categorical Predictors**

```


dt = Open( "$Sample_Data/Tablet Production.jmp" );
obj = dt << Fit Model(
    Y( :Dissolution ),
    Effects(
        :Mill Time, :Screen Size, :Mag. Stearate Supplier, :Lactose Supplier, :Sugar Supplier,
        :Talc Supplier, :Blend Time, :Blend Speed, :Compressor, :Force, :Coating Supplier,
        :Coating Viscosity, :Inlet Temp, :Exhaust Temp, :Spray Rate, :Atomizer Pressure
    ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;


```

**Forward Selection**

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;


```

**Interactions That Respect Effect Heredity**

```


dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Stepwise" ),
    Run( Rules( "Whole Effects Respecting Heredity" ) )
);
obj << Finish;


```

**Model Averaging**

```


dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Stepwise" ),
    Run
);
obj << Model Averaging( 10, 0.95 );


```

### [Columns](#columns_2)

#### [By](#by_2)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;


```

### [Item Messages](#item-messages_26)

#### [All Possible Models](#all-possible-models)

**Syntax:** obj \<< All Possible Models( max_terms, max_models, \<Heredity Restriction( state=0|1 )> )

**Description:** Fits all possible models up to the specified limits and shows the best models for each number of terms. Specify the maximum number of terms to fit in any one model. Specify the maximum number of model results to show for each number of model terms. You can restrict the models that appear to those that satisfy strong effect heredity. The All Possible Models option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
Wait( 1 );
obj << All Possible Models( 5, 10 );


```

#### [Backward Step](#backward-step)

**Syntax:** obj \<< Backward Step

**Description:** Removes the term with the largest p-value. If the P-value Threshold stopping rule is selected, that term must not be significant at the level specified by the Prob to Leave option.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Enter All;
Wait( 1 );
obj << Backward Step;


```

#### [Clear History](#clear-history)

**Syntax:** obj \<< Clear History

**Description:** Clears and resets the step history.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
Wait( 1 );
obj << Clear History;


```

#### [Direction](#direction)

**Syntax:** obj \<< Direction( "Forward"|"Backward"|"Mixed" )

**Description:** Specifies the direction that is used for stepping through the term selection process. The direction can be forward, backward, or a mixture of the two. The Mixed direction option requires that the P-value Threshold stopping rule be selected.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Stopping Rule( "P-value Threshold" );
obj << Direction( "Mixed" );
obj << Finish;


```

#### [Enter](#enter)

**Syntax:** obj \<< Enter( term )

**Description:** Enters a term into the model. This option does not affect locked terms.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Enter( :Runtime );


```

#### [Enter All](#enter-all)

**Syntax:** obj \<< Enter All

**Description:** Enters all the terms into the model, if possible.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run( Direction( "Backward" ) )
);
obj << Enter All;


```

#### [Export Model With Validation](#export-model-with-validation)

**Syntax:** obj \<< Export Model With Validation( state=0|1 )

**Description:** Adds the Validation column to the Model Specification window when you select the Make Model option. This option also runs the model with the Validation column when you select the Run Model option. This option is available only when you have specified a Validation column. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Validation( :Validation ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Make Model;
Wait( 1 );
obj << Export Model With Validation( 0 );
obj << Make Model;


```

#### [Finish](#finish)

**Syntax:** obj \<< Finish

**Description:** Completes the term selection process immediately. In scripts, the Finish option is recommended instead of the Go option.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;


```

#### [Forward Step](#forward-step)

**Syntax:** obj \<< Forward Step

**Description:** Enters the term with the smallest p-value. If the P-value Threshold stopping rule is selected, that term must be significant at the level specified by the Prob to Enter option.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
Wait( 1 );
obj << Forward Step;


```

#### [Get Measures](#get-measures_4)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Get Measures;


```

#### [Get Prospectives](#get-prospectives)

**Syntax:** obj \<< Get Prospectives

**Description:** Returns an associative array that contains estimates and confidence intervals. For terms that are in the model, the values are the values obtained from the current model. For terms that are not in the current model, the values are the estimates and confidence intervals from a model that includes the corresponding term.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
Show(
    obj << Enter( :Runtime );
    obj << Get Prospectives;
);


```

#### [Go](#go_1)

**Syntax:** obj \<< Go

**Description:** Starts a background task for the term selection process. In scripts, the Finish option is recommended instead of the Go option.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Go;


```

#### [K-Fold Crossvalidation](#k-fold-crossvalidation)

**Syntax:** obj \<< "K-Fold Crossvalidation"n( <k> )

**Description:** Performs k-fold cross validation in the variable selection process. When selected, this option enables the Max K-Fold RSquare stopping rule in the control panel. K-fold cross validation in the Stepwise platform divides the sample into k subsets and uses of the subsets as a validation set. The K-Fold Crossvalidation option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << "K-Fold Crossvalidation"n( 5 );
obj << Finish;


```

#### [Lock](#lock)

**Syntax:** obj \<< Lock( term )

**Description:** Locks a term in or out of the model. A locked term that is not in the model cannot be entered into the model, and a locked term that is in the model cannot be removed from the model.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Enter( :Runtime );
obj << Lock( :Runtime );


```

#### [Make Model](#make-model)

**Syntax:** obj \<< Make Model

**Description:** Opens a Fit Model launch window for the model that is specified in the Current Estimates table. In cases where there are nominal or ordinal terms, the Make Model option creates temporary transform columns that contain terms that are needed for the model.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Make Model;


```

#### [Model Averaging](#model-averaging)

**Syntax:** obj \<< Model Averaging( max_terms, AICc_cutoff )

**Description:** Enables you to average the fits for a number of models, instead of selecting a single best model.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
Wait( 1 );
obj << Model Averaging( 5, .90 );


```

#### [Model Dialog](#model-dialog_13)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
Wait( 1 );
obj << Model Dialog;


```

#### [Plot Criterion History](#plot-criterion-history)

**Syntax:** obj \<< Plot Criterion History( state=0|1 )

**Description:** Creates a plot of AICc and BIC versus the number of parameters.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Stopping Rule( "P-value Threshold" );
obj << Direction( "Mixed" );
obj << Finish;
obj << Plot Criterion History( 1 );


```

#### [Plot RSquare History](#plot-rsquare-history)

**Syntax:** obj \<< Plot RSquare History( state=0|1 )

**Description:** Creates a plot of training and validation R-square versus the number of parameters. This option is available only for continuous response models that have validation data.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << "K-Fold Crossvalidation"n( 5 );
obj << Finish;
obj << Plot RSquare History( 1 );


```

#### [Prob to Enter](#prob-to-enter)

**Syntax:** obj \<< Prob to Enter( number )

**Description:** Specifies the maximum p-value that an effect must have to be entered into the model during a forward step.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Stopping Rule( "P-value Threshold" );
obj << Prob to Enter( .20 );
obj << Finish;


```

#### [Prob to Leave](#prob-to-leave)

**Syntax:** obj \<< Prob to Leave( number )

**Description:** Specifies the minimum p-value that an effect must have to be removed from the model during a backward step.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Stopping Rule( "P-value Threshold" );
obj << Prob to Leave( .20 );
obj << Enter All;
obj << Direction( "Backward" );
obj << Finish;


```

#### [Remove](#remove_3)

**Syntax:** obj \<< Remove( term )

**Description:** Removes a term from the model. This option does not affect locked terms.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Remove( :RunPulse );


```

#### [Remove All](#remove-all)

**Syntax:** obj \<< Remove All

**Description:** Removes all the terms from the model.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
Wait( 1 );
obj << Remove All;


```

#### [Rules](#rules)

**Syntax:** obj \<< Rules( "Combine"|"Restrict"|"No Rules"|"Whole Effects"|"Whole Effects Respecting Heredity" )

**Description:** Specifies the rules that are applied when there is a hierarchy of terms in the model. This option appears only if your model contains hierarchical terms.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects(
        :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse, :Weight * :Runtime,
        :Weight * :RunPulse, :Weight * :RstPulse, :Weight * :MaxPulse, :Runtime * :RunPulse,
        :RunPulse * :MaxPulse
    ),
    Personality( "Stepwise" ),
    Run
);
obj << Rules( "Whole Effects" );
obj << Stopping Rule( "P-value Threshold" );
obj << Direction( "Mixed" );
obj << Finish;


```

#### [Run Model](#run-model)

**Syntax:** obj \<< Run Model

**Description:** Opens a Standard Least Squares report for the model that is specified in the Current Estimates table. In cases where there are nominal or ordinal terms, the Run Model option creates temporary transform columns that contain terms that are needed for the model.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Run Model;


```

#### [Step](#step)

**Syntax:** obj \<< Step

**Description:** Takes the next step in the term selection process. The Step option enters terms one-by-one in the forward direction or removes them one-by one in the backward direction.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
Wait( 1 );
obj << Step;


```

#### [Stop](#stop)

**Syntax:** obj \<< Stop

**Description:** Stops the automatic selection process that is started by the Go or Finish options.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Stop;


```

#### [Stopping Rule](#stopping-rule)

**Syntax:** obj \<< Stopping Rule( "P-value Threshold"|"Minimum AICc"|"Minimum BIC"|"Max Validation RSquare"|"Max K-Fold RSquare" )

**Description:** Specifies the rule that is used to stop the term selection process when the Go or Finish options are specified.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects(
        :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse, :Weight * :Runtime,
        :Weight * :RunPulse, :Weight * :RstPulse, :Weight * :MaxPulse, :Runtime * :RunPulse,
        :RunPulse * :MaxPulse
    ),
    Personality( "Stepwise" ),
    Run Model( Stopping Rule( "Minimum AICc" ) )
);
obj << Finish;


```

#### [Unlock](#unlock)

**Syntax:** obj \<< Unlock( term )

**Description:** Unlocks a previously locked term in the model.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Enter( :Runtime );
obj << Lock( :Runtime );
Wait( 1 );
obj << Unlock( :Runtime );


```

### [Shared Item Messages](#shared-item-messages_13)

#### [Action](#action_13)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_13)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_9)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_12)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_13)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_12)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_13)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_13)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_13)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_12)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_13)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_13)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_12)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_13)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_13)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_13)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_13)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_13)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_13)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_13)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_13)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_13)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_13)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_13)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_13)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_13)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_13)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_13)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_12)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_12)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_12)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_13)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_13)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj << Finish;
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_13)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_13)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_13)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_13)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_13)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_13)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_13)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_13)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_13)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_13)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Stepwise" ),
    Run
);
obj << Finish;
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_12)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_13)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_12)

**Syntax:** obj = Fit Stepwise(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Fit Varcomp](#fit-varcomp)

### [Associated Constructors](#associated-constructors_12)

#### [Estimate Only Variance Components](#estimate-only-variance-components)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Standard Least Squares" ), Method( "REML" ), Estimate Only Variance Components( 1 ) )

**Description:** Runs a REML analysis using the specified model and displays the variance components from the model.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);


```

### [Columns](#columns_3)

#### [By](#by_3)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);


```

### [Item Messages](#item-messages_27)

#### [Get Random Effect Names](#get-random-effect-names_2)

**Syntax:** obj \<< Get Random Effect Names

**Description:** Returns the names of the random effects. Available for REML analysis methods.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
vn = obj << Get Random Effect Names;
Show( vn );


```

#### [Get Variance Components](#get-variance-components_2)

**Syntax:** obj \<< Get Variance Components

**Description:** Returns the variance components generated by Fit Model for a specified model.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
vc = obj << Get Variance Components;
Show( vc );


```

### [Shared Item Messages](#shared-item-messages_14)

#### [Action](#action_14)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_14)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Broadcast](#broadcast_13)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_14)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_13)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_14)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_14)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_14)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_13)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_14)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_14)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_13)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_14)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_14)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_14)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_14)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_14)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_14)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_14)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_14)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_14)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_14)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_14)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_14)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_14)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_14)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_14)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_13)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_13)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_13)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_14)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_14)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Run
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_14)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_14)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_14)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_14)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_14)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_14)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_14)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_14)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_14)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_14)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_13)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_14)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_13)

**Syntax:** obj = Estimate Only Variance Components(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Generalized Linear Mixed Model > Fit GLMM](#generalized-linear-mixed-model-fit-glmm)

### [Item Messages](#item-messages_28)

#### [Between-Within Degrees of Freedom](#between-within-degrees-of-freedom_1)

**Syntax:** obj \<< (fit[number] \<< Between-Within Degrees of Freedom( state=0|1 ))

**Description:** Replaces the standard errors with unadjusted estimates and degrees of freedom to between-within based throughout the report. To use between-within degrees of freedom in a multiple comparisons report, you must select this option prior to adding a multiple comparisons report.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Repeated Measures Binomial.jmp" );
fm = Fit Model(
    Y( :No Headache, :Number of Patients ),
    Effects( :Treatment, :Week, :Treatment * :Week ),
    Personality( "Generalized Linear Mixed Model" ),
    Subject( :"Treatment(Clinic)"n ),
    Repeated Effects( :Week Continuous ),
    Repeated Structure( "AR(1)" ),
    Generalized Distribution( "Binomial" ),
    Link Function( "Logit" ),
    Run()
);
Wait( 1 );
fm << (Fit[1] << "Between-Within Degrees of Freedom"n( 1 ));


```

#### [Conditional Contour Profiler](#conditional-contour-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Conditional Contour Profiler( state=0|1 ))

**Description:** Shows or hides a contour profiler of the conditional response graphically for two factors at a time. This option is available only when the model contains at least two continuous effects and at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
fm = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept( 1 ),
    Center Polynomials( 0 ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
Wait( 0 );
fm << (Fit[1] << Conditional Contour Profiler( 1 ));


```

#### [Conditional Diagnostic Bundle](#conditional-diagnostic-bundle)

**Syntax:** obj \<< (fit[number] \<< Conditional Diagnostic Bundle( state=0|1 ))

**Description:** Shows or hides a group of diagnostic plots that are helpful in deciding how well a regression model fits the observed data. This option is not available if Binomial is selected as the Distribution or if there are no random effects in the model.

```

dt = Open( "$SAMPLE_DATA/Manufacturing Defect Counts.jmp" );
fm = dt << Fit Model(
    Y( :Defect ),
    Effects( :Finishing Treatment ),
    Random Effects( :Lot, :Lot * :Finishing Treatment, :Lot * :Unit in Lot ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
Wait( 1 );
fm << (fit[1] << Conditional Diagnostic Bundle( 1 ));


```

#### [Conditional Mean CI](#conditional-mean-ci_3)

**Syntax:** obj \<< (fit[number] \<< Conditional Mean CI)

**Description:** Saves two new columns to the data table. The new columns contain the lower and upper confidence limits for the expected value of the conditional prediction. The confidence intervals include random effects estimates for models that contain random effects. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Conditional Mean CI);


```

#### [Conditional Mixture Profiler](#conditional-mixture-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Conditional Mixture Profiler( state=0|1 ))

**Description:** Shows or hides a mixture profiler that shows the contours of the conditional response on a ternary plot. This option is available only when the model contains at least one random effect and if the Mixture Effect attribute is applied to three or more factors in the model or the Mixture property is applied to three or more factor columns.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
fm = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept( 1 ),
    Center Polynomials( 0 ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
Wait( 0 );
fm << (Fit[1] << Conditional Mixture Profiler( 1 ));


```

#### [Conditional Prediction Formula](#conditional-prediction-formula_1)

**Syntax:** obj \<< (fit[number] \<< Conditional Prediction Formula)

**Description:** Saves a new formula column to the data table. The new column contains the prediction formula for the conditional mean. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Conditional Prediction Formula);


```

#### [Conditional Profiler](#conditional-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Conditional Profiler( state=0|1 ))

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the conditional prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Conditional Profiler( 1 ));


```

#### [Conditional Surface Profiler](#conditional-surface-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Conditional Surface Profiler( state=0|1 ))

**Description:** Shows or hides a three-dimensional surface plot of the conditional response. This option is available only when the model contains at least two effects and at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Conditional Surface Profiler( 1 ));


```

#### [Containment Degrees of Freedom](#containment-degrees-of-freedom_1)

**Syntax:** obj \<< (fit[number] \<< Containment Degrees of Freedom( state=0|1 ))

**Description:** Replaces the standard errors with unadjusted estimates and degrees of freedom to containment-based throughout the report. To use containment degrees of freedom in a multiple comparisons report, you must select this option prior to adding a multiple comparisons report.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Containment Degrees of Freedom( 1 ));


```

#### [Contour Profiler](#contour-profiler_8)

**Syntax:** obj \<< (fit[number] \<< Contour Profiler( state=0|1 ))

**Description:** Shows or hides a contour profiler of the marginal response graphically for two factors at a time. This option is available only when the model contains at least two continuous fixed effects.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
fm = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept( 1 ),
    Center Polynomials( 0 ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
Wait( 0 );
fm << (Fit[1] << Contour Profiler( 1 ));


```

#### [Correlation of Fixed Effects](#correlation-of-fixed-effects_1)

**Syntax:** obj \<< (fit[number] \<< Correlation of Fixed Effects( state=0|1 ))

**Description:** Shows or hides the correlation matrix for the fixed effects in the model.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Correlation of Fixed Effects( 1 ));


```

#### [Covariance of All Parameters](#covariance-of-all-parameters_1)

**Syntax:** obj \<< (fit[number] \<< Covariance of All Parameters( state=0|1 ))

**Description:** Shows or hides the covariance matrix for all effects in the model.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Covariance of All Parameters( 1 ));


```

#### [Covariance of Covariance Parameters](#covariance-of-covariance-parameters_1)

**Syntax:** obj \<< (fit[number] \<< Covariance of Covariance Parameters( state=0|1 ))

**Description:** Shows or hides the covariance matrix for the random effects in the model.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Covariance of Covariance Parameters( 1 ));


```

#### [Covariance of Fixed Effects](#covariance-of-fixed-effects_1)

**Syntax:** obj \<< (fit[number] \<< Covariance of Fixed Effects( state=0|1 ))

**Description:** Shows or hides the covariance matrix for the fixed effects in the model.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Covariance of Fixed Effects( 1 ));


```

#### [Diagnostic Bundle](#diagnostic-bundle)

**Syntax:** obj \<< (fit[number] \<< Diagnostic Bundle( state=0|1 ))

**Description:** Shows or hides a group of diagnostic plots that are helpful in deciding how well a regression model fits the observed data. This option is not available if Binomial is selected as the Distribution or if there are random effects in the model.

```

dt = Open( "$SAMPLE_DATA/Manufacturing Defect Counts.jmp" );
fm = dt << Fit Model(
    Y( :Defect ),
    Effects( :Finishing Treatment ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
Wait( 1 );
fm << (fit[1] << Diagnostic Bundle( 1 ));


```

#### [Empirical Standard Errors](#empirical-standard-errors_1)

**Syntax:** obj \<< (fit[number] \<< Empirical Standard Errors( state=0|1 ))

**Description:** Replaces the standard errors with sandwich estimates throughout the report. To use sandwich estimates in a multiple comparisons report, you must select this option prior to adding a multiple comparisons report.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Empirical Standard Errors( 1 ));


```

#### [Fit Statistics](#fit-statistics_1)

**Syntax:** obj \<< (fit[number] \<< Fit Statistics( state=0|1 ))

**Description:** Shows or hides the Fit Statistics and Model Summary reports that include information about the specification and goodness of fit statistics for the model. On by default.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Fit Statistics( 0 ) ) )
);
Wait( 1 );
fm << (Fit[1] << Fit Statistics( 1 ));


```

#### [Fixed Effects Parameter Estimates](#fixed-effects-parameter-estimates_1)

**Syntax:** obj \<< (fit[number] \<< Fixed Effects Parameter Estimates( state=0|1 ))

**Description:** Shows or hides a table of fixed effects parameter estimates. On by default.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Fixed Effects Parameter Estimates( 0 ) ) )
);
Wait( 1 );
fm << (Fit[1] << Fixed Effects Parameter Estimates( 1 ));


```

#### [Fixed Effects Tests](#fixed-effects-tests_1)

**Syntax:** obj \<< (fit[number] \<< Fixed Effects Tests( state=0|1 ))

**Description:** Shows or hides the tests of fixed effects. This option is available only when the model contains at least one fixed effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Fixed Effects Tests( 0 ) ) )
);
Wait( 1 );
fm << (Fit[1] << Fixed Effects Tests( 1 ));


```

#### [Mean Confidence Interval](#mean-confidence-interval_5)

**Syntax:** obj \<< (fit[number] \<< Mean Confidence Interval)

**Description:** Saves two new columns to the data table. The new columns contain the lower and upper confidence limits for the mean response.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Mean Confidence Interval);


```

#### [Mixture Profiler](#mixture-profiler_3)

**Syntax:** obj \<< (fit[number] \<< Mixture Profiler( state=0|1 ))

**Description:** Shows or hides a mixture profiler that shows the contours of the marginal response on a ternary plot. This option is available only if the Mixture Effect attribute is applied to three or more factors in the model or the Mixture property is applied to three or more factor columns.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Vinyl Data.jmp" );
fm = dt << Fit Model(
    Y( :thickness ),
    Effects(
        :m1 & RS & Mixture, :m2 & RS & Mixture, :m3 & RS & Mixture, :m1 * :m2, :m1 * :m3,
        :m1 * :extrusion rate, :m1 * :temperature, :m2 * :m3, :m2 * :extrusion rate,
        :m2 * :temperature, :m3 * :extrusion rate, :m3 * :temperature,
        :extrusion rate * :temperature
    ),
    Random Effects( :Whole Plots ),
    No Intercept( 1 ),
    Center Polynomials( 0 ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
Wait( 0 );
fm << (Fit[1] << Mixture Profiler( 1 ));


```

#### [Multiple Comparisons](#multiple-comparisons_3)

**Syntax:** obj \<< (fit[number] \<< Multiple Comparisons( Effect( effect ), <options> ))

**Description:** Generates least squares means estimates or user-defined estimates. These estimates enable you to do comparisons with the overall average, comparisons with a control, or pairwise comparisons. This option is available only when the model contains at least one fixed effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Target Level( "Pass" ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (fit[1] << Multiple Comparisons(
    Effect( :Program ),
    Least Squares Means Plot,
    Student's t( 1 )
));


```

#### [Odds Ratios](#odds-ratios_2)

**Syntax:** obj \<< (fit[number] \<< Odds Ratios( state=0|1 ))

**Description:** Shows or hides a report that contains odds ratios for categorical predictors, and unit odds ratios and range odds ratios for continuous predictors.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y Ordinal ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Linear Mixed Model" ),
    Run
);
Wait( 0 );
obj << (fit[1] << Odds Ratios( 1 ));


```

#### [Prediction Formula](#prediction-formula_5)

**Syntax:** obj \<< (fit[number] \<< Prediction Formula)

**Description:** Saves a new formula column to the data table. The new column contains the prediction formula for the marginal mean.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Prediction Formula);


```

#### [Prediction and Interval Formulas](#prediction-and-interval-formulas_4)

**Syntax:** obj \<< (fit[number] \<< Prediction and Interval Formulas)

**Description:** Saves new columns to the data table. The columns contain formulas for the predictions and confidence limits. The limits columns that are created by this option contain properties that are used by the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Prediction and Interval Formulas);


```

#### [Profiler](#profiler_8)

**Syntax:** obj \<< (fit[number] \<< Profiler( state=0|1 ))

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the marginal prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization. This option is available only when the model contains at least one fixed effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Profiler( 1 ));


```

#### [Random Coefficients](#random-coefficients_1)

**Syntax:** obj \<< (fit[number] \<< Random Coefficients( state=0|1 ))

**Description:** Shows or hides a report of the estimates for the random coefficients. This option is available only when the model contains at least one random effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Random Coefficients( 0 ) ) )
);
Wait( 1 );
fm << (Fit[1] << Random Coefficients( 1 ));
Report( fm )["Random Coefficients"] << Close( 0 );


```

#### [Random Effects Covariance Parameter Estimates](#random-effects-covariance-parameter-estimates_1)

**Syntax:** obj \<< (fit[number] \<< Random Effects Covariance Parameter Estimates( state=0|1 ))

**Description:** Shows or hides a table of random effects covariance parameter estimates. This option is available only when the model contains at least one random effect. On by default.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Random Effects Covariance Parameter Estimates( 0 ) ) )
);
Wait( 1 );
fm << (Fit[1] << Random Effects Covariance Parameter Estimates( 1 ));


```

#### [Random Effects Predictions](#random-effects-predictions_1)

**Syntax:** obj \<< (fit[number] \<< Random Effects Predictions( state=0|1 ))

**Description:** Shows or hides a table of random effect predictions. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Random Effects Predictions( 1 ));


```

#### [Save Conditional Residual Formula](#save-conditional-residual-formula)

**Syntax:** obj \<< (fit[number] \<< Save Conditional Residual Formula )

**Description:** Saves a new formula column to the data table. The new column contains a formula for the conditional residuals, given in the form Y minus the prediction formula. This option is not available if Binomial is selected as the Distribution or if there are random effects in the model.

```

dt = Open( "$SAMPLE_DATA/Manufacturing Defect Counts.jmp" );
fm = dt << Fit Model(
    Y( :Defect ),
    Effects( :Finishing Treatment ),
    Random Effects( :Lot, :Lot * :Finishing Treatment, :Lot * :Unit in Lot ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
fm << (fit[1] << Save Conditional Residual Formula);


```

#### [Save Residual Formula](#save-residual-formula)

**Syntax:** obj \<< (fit[number] \<< Save Residual Formula )

**Description:** Saves a new formula column to the data table. The new column contains a formula for the marginal residuals, given in the form Y minus the prediction formula. This option is not available if Binomial is selected as the Distribution.

```

dt = Open( "$SAMPLE_DATA/Manufacturing Defect Counts.jmp" );
fm = dt << Fit Model(
    Y( :Defect ),
    Effects( :Finishing Treatment ),
    Random Effects( :Lot, :Lot * :Finishing Treatment, :Lot * :Unit in Lot ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Poisson" ),
    Run
);
fm << (fit[1] << Save Residual Formula);


```

#### [Save Simulation Formula](#save-simulation-formula_1)

**Syntax:** obj \<< (fit[number] \<< Save Simulation Formula)

**Description:** Saves a new formula column to the data table. The new column can be used to create random response values from the fitted model. You can use the formula column with the Simulate feature in JMP Pro. This option is not available if a By variable is used. Use subset data tables if By group simulation formulas are needed.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Save Simulation Formula);


```

#### [Sequential Tests](#sequential-tests_3)

**Syntax:** obj \<< (fit[number] \<< Sequential Tests( state=0|1 ))

**Description:** Shows or hides the Sequential (Type 1) Tests report that contains the sums of squares as effects are added to the model sequentially. This option is available only when the model contains at least one fixed effect.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
Wait( 1 );
fm << (Fit[1] << Sequential Tests( 1 ));


```

#### [Standard Error of Conditional Predicted](#standard-error-of-conditional-predicted_1)

**Syntax:** obj \<< (fit[number] \<< Standard Error of Conditional Predicted)

**Description:** Saves a new column to the data table. The new column contains the standard errors of the conditional mean predictions. This option is available only when the model contains at least one random effect.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Standard Error of Conditional Predicted);


```

#### [Standard Error of Predicted](#standard-error-of-predicted_1)

**Syntax:** obj \<< (fit[number] \<< Standard Error of Predicted)

**Description:** Saves a new column to the data table. The new column contains the standard errors of the marginal mean predictions.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Standard Error of Predicted);


```

#### [Surface Profiler](#surface-profiler_6)

**Syntax:** obj \<< (fit[number] \<< Surface Profiler( state=0|1 ))

**Description:** Shows or hides a three-dimensional surface plot of the marginal response. This option is available only when the model contains at least two effects.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << (Fit[1] << Surface Profiler( 1 ));


```

## [Generalized Linear Mixed Model](#generalized-linear-mixed-model)

### [Associated Constructors](#associated-constructors_13)

#### [Fit GLMM Platform](#fit-glmm-platform)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Random Effects( columns ), Repeated Effects( columns ), Repeated Structure( type ), Personality( "Generalized Linear Mixed Model" ) )

**Description:** Fits a generalized linear mixed model. These models can be used for random coefficients, split-plots, and blocked designs when the response is non-Gaussian. The response distributions can accommodate continuous, categorical, count, and time-to-event response data.

**Nested Random Effect Model**

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);


```

**Random Coefficient Model**

```

dt = Open( "$SAMPLE_DATA/Manufacturing Defect Counts.jmp" );
fm = dt << Fit Model(
    Y( :Defect ),
    Effects( :Finishing Treatment ),
    Random Effects( :Lot, :Lot * :Finishing Treatment ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Negative Binomial" ),
    Run()
);


```

**Repeated Measures Model**

```

dt = Open( "$SAMPLE_DATA/Repeated Measures Binomial.jmp" );
fm = Fit Model(
    Y( :No Headache, :Number of Patients ),
    Effects( :Treatment, :Week, :Treatment * :Week ),
    Personality( "Generalized Linear Mixed Model" ),
    Subject( :"Treatment(Clinic)"n ),
    Repeated Effects( :Week Continuous ),
    Repeated Structure( "AR(1)" ),
    Generalized Distribution( "Binomial" ),
    Link Function( "Logit" ),
    Run()
);


```

**Spatial Model**

```

dt = Open( "$SAMPLE_DATA/Hessian Fly.jmp" );
fm = Fit Model(
    Y( :Y, :N ),
    Effects( :Entry ),
    Personality( "Generalized Linear Mixed Model" ),
    Repeated Effects( :Latitude, :Longitude ),
    Repeated Structure( "Spatial" ),
    Repeated Structure Type( "Exponential" ),
    Generalized Distribution( "Binomial" ),
    Link Function( "Logit" ),
    Run()
);


```

**Split Plot Model**

```

dt = Open( "$SAMPLE_DATA/Time to Flower.jmp" );
fm = dt << Fit Model(
    Y( :Days ),
    Effects( :A, :B, :A * :B ),
    Random Effects( :Block, :Block * :A ),
    NoBounds( 1 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Gamma" ),
    Run()
);


```

### [Columns](#columns_4)

#### [By](#by_4)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Item Messages](#item-messages_29)

#### [Fit](#fit_1)

**Syntax:** Fit Model(...Run( Fit( options ) )...); obj \<< Fit( options ); obj \<< (Fit[number] \<< option)

**Description:** Enables you to send messages to the platform. This option can be used in a model launch script or to generate a handle to a specific model in the report.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Fit Statistics( 0 ) ) )
);
Wait( 1 );
fm << (Fit[1] << Fit Statistics( 1 ));


```

#### [Model Dialog](#model-dialog_14)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run
);
fm << Model Dialog;


```

### [Shared Item Messages](#shared-item-messages_15)

#### [Action](#action_15)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_15)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Broadcast](#broadcast_14)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_15)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_14)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_15)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_15)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_15)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_14)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_15)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_15)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_14)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_15)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_15)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_15)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_15)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_15)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_15)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_15)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_15)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_15)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_15)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_15)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_15)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_15)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_15)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_15)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_14)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_14)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_14)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_15)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_15)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_15)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_15)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_15)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_15)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_15)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_15)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_15)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_15)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_15)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_15)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Student Testing.jmp" );
fm = dt << Fit Model(
    Y( :Grade ),
    Effects( :Program ),
    Random Effects( :School, :Class[:School] ),
    NoBounds( 0 ),
    Personality( "Generalized Linear Mixed Model" ),
    Generalized Distribution( "Binomial" ),
    Run()
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_14)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_15)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_14)

**Syntax:** obj = Fit GLMM Platform(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Generalized Regression > Generalized Regression Fit](#generalized-regression-generalized-regression-fit)

### [Item Messages](#item-messages_30)

#### [Active Parameter Estimates](#active-parameter-estimates)

**Syntax:** obj \<< (fit[number] \<< Active Parameter Estimates( state=0|1 ))

**Description:** Shows or hides a table of active, or nonzero, parameter estimates for the currently selected model. This option is not available for Maximum Likelihood or Ridge Regression models.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 1 );
fm << (fit[1] << Active Parameter Estimates( 1 ));


```

#### [Confusion Matrix](#confusion-matrix_2)

**Syntax:** obj \<< (fit[number] \<< Confusion Matrix( \<probability=0.5> ))

**Description:** Generates a crosstabulation matrix of actual and predicted responses. Use the optional argument to specify a threshold probability other than 0.5. This option is available only when the specified Distribution is Binomial, Multinomial, or Ordinal Logistic. "0.5" by default.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run(
        Fit(
            Estimation Method( "Logistic Regression" ),
            Validation Method( "None" ),
            Confusion Matrix( 0.5 )
        )
    )
);


```

#### [Cook's D Influence](#cooks-d-influence_2)

**Syntax:** obj \<< (fit[number] \<< Cook's D Influence)

**Description:** Saves a new column to the original data table. The new column contains the values for Cook's D Influence statistic. This option is available only if the specified Distribution is Normal and the specified Estimation Method is Standard Least Squares.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Standard Least Squares" ) ) )
);
fm << (fit[1] << Cook's D Influence);


```

#### [Correlation of Estimates](#correlation-of-estimates_4)

**Syntax:** obj \<< (fit[number] \<< Correlation of Estimates( state=0|1 ))

**Description:** Shows or hides the matrix of correlations between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Correlation of Estimates);


```

#### [Covariance of Estimates](#covariance-of-estimates_2)

**Syntax:** obj \<< (fit[number] \<< Covariance Of Estimates( state=0|1 ))

**Description:** Shows or hides the matrix of covariances between the parameter estimates for the specified fit.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Covariance of Estimates);


```

#### [Custom Test](#custom-test_4)

**Syntax:** obj \<< (fit[number] \<< Custom Test( [l1, l2, l3, ... ], \<Label( text )> ))

**Description:** Shows or hides a Custom Test report that enables you to test a custom hypothesis. If the model has a Solution Path, the custom test results update as you update the solution.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :BMI, :BP, :LDL, :HDL, :TCH ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Standard Least Squares" ) ) )
);
fm << (fit[1] << Custom Test( [0 0 0 1 -1 0], Label() ));


```

#### [Decision Threshold](#decision-threshold_1)

**Syntax:** obj \<< (fit[number] \<< Decision Threshold( state=0|1, Set Probability Threshold( number=0.5 ))

**Description:** Shows or hides Decision Thresholds reports for the Training, Validation, and Test sets, if specified. Each report contains a graph of the distribution of fitted probabilities for each model, confusion matrices for each model, and classification graphs to compare the model fits. This option is available only for binary categorical responses.

```

dt = Open( "$SAMPLE_DATA/Liver Cancer.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Severity ),
    Effects(
        :BMI, :Age, :Time, :Markers, :Hepatitis, :Jaundice, :BMI * :Age, :BMI * :Time,
        :BMI * :Markers, :BMI * :Hepatitis, :BMI * :Jaundice, :Age * :Time, :Age * :Markers,
        :Age * :Hepatitis, :Age * :Jaundice, :Time * :Markers, :Time * :Hepatitis,
        :Time * :Jaundice, :Markers * :Hepatitis, :Markers * :Jaundice,
        :Hepatitis * :Jaundice
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 0 );
fm << (fit[1] << Decision Threshold( 1 ));


```

#### [Diagnostic Bundle](#diagnostic-bundle_1)

**Syntax:** obj \<< (fit[number] \<< Diagnostic Bundle( state=0|1 ))

**Description:** Shows or hides a group of diagnostic plots that are helpful in deciding how well a regression model fits the observed data. A set of plots is available for the Training set, and for the Validation and Test sets if you are using these. Not available when the specified Distribution is Binomial, Multinomial, Ordinal Logistic, or Cox Proportional Hazards.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
Wait( 1 );
fm << (fit[1] << Diagnostic Bundle( 1 ));


```

#### [Distribution Profiler](#distribution-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Distribution Profiler( state=0|1 ))

**Description:** Shows or hides a profiler of the cumulative distribution function of the predictors and the response. The response is shown in the right-most cell. This option is not available when the specified Distribution is Binomial or Quantile Regression.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
Fit Model(
    Y( :satell ),
    Effects(
        :color, :spine, :width, :weight, :color * :spine, :color * :width, :color * :weight,
        :spine * :width, :spine * :weight, :width * :weight
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Poisson" ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "BIC" ),
            Distribution Profiler( 1 )
        )
    )
);


```

#### [Effect Tests](#effect-tests_3)

**Syntax:** obj \<< (fit[number] \<< Effect Tests( state=0|1 ))

**Description:** Shows or hides tests for each effect. Each effect test is testing the null hypothesis that all parameters associated with that effect are zero. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 1 );
fm << (fit[1] << Effect Tests( 0 ));


```

#### [Get Prediction Formula](#get-prediction-formula_2)

**Syntax:** obj \<< (fit[number] \<< Get Prediction Formula)

**Description:** Constructs a script to create a prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Get Prediction Formula);


```

#### [Hats](#hats_2)

**Syntax:** obj \<< (fit[number] \<< Hats)

**Description:** Saves a new column to the original data table. The new column contains the diagonal elements of the hat matrix, which are sometimes called hat values. This option is available only if the specified Distribution is Normal and the specified Estimation Method is Standard Least Squares.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Standard Least Squares" ) ) )
);
fm << (fit[1] << Hats);


```

#### [Hazard Profiler](#hazard-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Hazard Profiler( state=0|1 ))

**Description:** Shows or hides a profiler that shows the hazard rate as a function of the predictors and the response. The response is shown in the right-most cell. This option is available only when the specified Distribution is Normal, Exponential, Weibull, Lognormal, or Cox Proportional Hazards.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Cell Type, :Treatment, :Prior, :Age, :Diag Time, :KPS ),
    No Intercept,
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run(
        Fit(
            Estimation Method( "Maximum Likelihood" ),
            Validation Method( "None" ),
            Hazard Profiler( 1 )
        )
    )
);


```

#### [Hazard Ratios](#hazard-ratios_1)

**Syntax:** obj \<< (fit[number] \<< Hazard Ratios( state=0|1 ))

**Description:** Shows or hides a report that contains hazard ratios for categorical predictors, and unit hazard ratios and range hazard ratios for continuous predictors. A hazard ratio is the ratio of the hazard rate for two events. This option is available only when the specified Distribution is Cox Proportional Hazards.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Cell Type, :Treatment, :Prior, :Age, :Diag Time, :KPS ),
    No Intercept,
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run(
        Fit(
            Estimation Method( "Maximum Likelihood" ),
            Validation Method( "None" ),
            Hazard Ratios( 1 )
        )
    )
);


```

#### [Hide Inactive Paths](#hide-inactive-paths)

**Syntax:** obj \<< (fit[number] \<< Hide Inactive Paths( state=0|1 ))

**Description:** Adjusts the transparency of the inactive paths in the Solution Path Parameter Estimates plot so that the paths that are not currently active appear faded.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Hide Inactive Paths);


```

#### [Incidence Rate Ratios](#incidence-rate-ratios)

**Syntax:** obj \<< (fit[number] \<< Incidence Rate Ratios( state=0|1 ))

**Description:** Shows or hides a report that contains incidence rate ratios for categorical predictors, and unit incidence rate ratios and range incidence rate ratios for continuous predictors. This option is available only when the specified Distribution is Poisson or Negative Binomial and the model contains an intercept.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Poisson" ),
    Run(
        Fit(
            Estimation Method( "Maximum Likelihood" ),
            Validation Method( "None" ),
            Incidence Rate Ratios( 1 )
        )
    )
);


```

#### [Inverse Prediction](#inverse-prediction_5)

**Syntax:** obj \<< (fit[number] \<< Inverse Prediction( Response( p1, p2, ... ), Term Value( effect1( value ), effect2( value ), ... ) ))

**Description:** Generates a predicted X value and confidence interval based on the specified values of Y and all other factors. This option is not available for models that contain a predictor that has the Vector modeling type.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Inverse Prediction(
    Response( 200, 250, 300 ),
    Term Value(
        Age( 48.5181 ),
        Gender( "1" ),
        BMI( . ),
        BP( 94.6470135746607 ),
        Total Cholesterol( 189.140271493213 ),
        LDL( 115.439140271493 ),
        HDL( 49.7884615384615 ),
        TCH( 4.07024886877828 ),
        LTG( 4.64141085972851 ),
        Glucose( 91.2601809954751 )
    )
));


```

#### [Lift Curve](#lift-curve_2)

**Syntax:** obj \<< (fit[number] \<< Lift Curve( state=0|1 ))

**Description:** Shows or hides the lift curve for the model. If you used validation, a lift curve is shown for each of the Training, Validation, and Test sets. This option is available only when the specified Distribution is Binomial, Multinomial, or Ordinal Logistic.

```

dt = Open( "$SAMPLE_DATA/Liver Cancer.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Severity ),
    Effects(
        :BMI, :Age, :Time, :Markers, :Hepatitis, :Jaundice, :BMI * :Age, :BMI * :Time,
        :BMI * :Markers, :BMI * :Hepatitis, :BMI * :Jaundice, :Age * :Time, :Age * :Markers,
        :Age * :Hepatitis, :Age * :Jaundice, :Time * :Markers, :Time * :Hepatitis,
        :Time * :Jaundice, :Markers * :Hepatitis, :Markers * :Jaundice,
        :Hepatitis * :Jaundice
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 0 );
fm << (fit[1] << Lift Curve( 1 ));


```

#### [Mean Confidence Interval](#mean-confidence-interval_6)

**Syntax:** obj \<< (fit[number] \<< Mean Confidence Interval)

**Description:** Saves two new formula columns to the original data table. The new columns contain the lower and upper 95% confidence limits for the mean response.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Save Prediction Formula);
fm << (fit[1] << Mean Confidence Interval);


```

#### [Model Summary](#model-summary)

**Syntax:** obj \<< (fit[number] \<< Model Summary( state=0|1 ))

**Description:** Shows or hides the Model Summary report that includes information about the specification and goodness of fit statistics for the model. This option also shows the Estimation Details report for applicable models. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 1 );
fm << (fit[1] << Model Summary( 0 ));


```

#### [Multiple Comparisons](#multiple-comparisons_4)

**Syntax:** obj \<< (fit[number] \<< Multiple Comparisons( Effect( effect ), <options> ))

**Description:** Generates least squares means estimates or user-defined estimates. These estimates enable you to do comparisons with the overall average, comparisons with a control, or pairwise comparisons. This option is not available for models that contain a predictor that has the Vector modeling type or for models that do not contain any categorical predictors.

```

dt = Open( "$SAMPLE_DATA/Hollywood Movies.jmp" );
fm = dt << Fit Model(
    Y( :World Gross ),
    Effects( :Rotten Tomatoes Score, :Audience Score, :Theme, :Genre ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Gamma" ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "BIC" ),
            Multiple Comparisons(
                Effect( :Genre ),
                Comparisons with Overall Average(
                    1,
                    Comparisons with Overall Average Decision Chart(
                        ANOM( 1, Point Options( "Show Needles" ) )
                    )
                )
            )
        )
    ),
    SendToReport(
        Dispatch( {}, "Parameter Estimates for Original Predictors", OutlineBox, Close( 1 ) )
    )
);


```

#### [Normal Quantile Plot](#normal-quantile-plot)

**Syntax:** obj \<< (fit[number] \<< Normal Quantile Plot( state=0|1 ))

**Description:** Shows or hides a plot of normal quantiles on the vertical axis and standardized residuals on the horizontal axis. If you used validation, a plot is shown for each of the Training, Validation, and Test sets. This option is available only when the specified Distribution is Normal and there is no censoring.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Standard Least Squares" ) ) )
);
fm << (fit[1] << Normal Quantile Plot);


```

#### [Odds Ratios](#odds-ratios_3)

**Syntax:** obj \<< (fit[number] \<< Odds Ratios( state=0|1 ))

**Description:** Shows or hides a report that contains odds ratios for categorical predictors, and unit odds ratios and range odds ratios for continuous predictors. This option is available only when the specified Distribution is Binomial and the model contains an intercept. This option is not available for models that contain a predictor that has the Vector modeling type.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run(
        Fit(
            Estimation Method( "Logistic Regression" ),
            Validation Method( "None" ),
            Odds Ratios( 1 )
        )
    )
);


```

#### [Parameter Estimates for Centered and Scaled Predictors](#parameter-estimates-for-centered-and-scaled-predictors)

**Syntax:** obj \<< (fit[number] \<< Parameter Estimates for Centered and Scaled Predictors( state=0|1 ))

**Description:** Shows or hides a table of centered and scaled parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 1 );
fm << (fit[1] << Parameter Estimates for Centered and Scaled Predictors( 1 ));


```

#### [Parameter Estimates for Original Predictors](#parameter-estimates-for-original-predictors)

**Syntax:** obj \<< (fit[number] \<< Parameter Estimates for Original Predictors( state=0|1 ))

**Description:** Shows or hides a table of parameter estimates in the original scale of the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 1 );
fm << (fit[1] << Parameter Estimates for Original Predictors( 0 ));


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted_3)

**Syntax:** obj \<< (fit[number] \<< Plot Actual By Predicted( state=0|1 ))

**Description:** Shows or hides a plot for the training set with actual values on the vertical axis and predicted values on the horizontal axis. If you used validation, a plot is shown for each of the Training, Validation, and Test sets. This option is not available when the specified Distribution is Binomial, Multinomial, Ordinal Logistic, or Cox Proportional Hazards.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
fm << (fit[1] << Plot Actual by Predicted( 1 ));


```

#### [Plot Baseline Survival and Hazard](#plot-baseline-survival-and-hazard)

**Syntax:** obj \<< (fit[number] \<< Plot Baseline Survival and Hazard( state=0|1 ))

**Description:** Shows or hides the Baseline Survival and Hazard plots, which plot the survival and hazard functions for the baseline proportional hazards function versus the response variable. Below the plots, there is a table that contains the plotted values. This option is available only when the specified Distribution is Cox Proportional Hazards.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Cell Type, :Treatment, :Prior, :Age, :Diag Time, :KPS ),
    No Intercept,
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run(
        Fit(
            Estimation Method( "Maximum Likelihood" ),
            Validation Method( "None" ),
            Plot Baseline Survival and Hazard( 1 )
        )
    )
);


```

#### [Plot Residual by Predicted](#plot-residual-by-predicted_2)

**Syntax:** obj \<< (fit[number] \<< Plot Residual By Predicted( state=0|1 ))

**Description:** Shows or hides a plot for the training set with residual values on the vertical axis and predicted values on the horizontal axis. If you used validation, a plot is shown for each of the Training, Validation, and Test sets. This option is not available when the specified Distribution is Binomial, Multinomial, Ordinal Logistic, or Cox Proportional Hazards.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
fm << (fit[1] << Plot Residual by Predicted( 1 ));


```

#### [Plot Residual by Predictor](#plot-residual-by-predictor)

**Syntax:** obj \<< (fit[number] \<< Plot Actual By Predictor( state=0|1 ))

**Description:** Shows or hides a plot of the residual values on the vertical axis and predictor values on the horizontal axis. If you used validation, a plot is shown for each of the Training, Validation, and Test sets. This option is not available when the specified Distribution is Binomial, Multinomial, Ordinal Logistic, or Cox Proportional Hazards. This option is not available for models that contain a predictor that has the Vector modeling type.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
fm << (fit[1] << Plot Residual by Predictor( 1 ));


```

#### [Precision Recall Curve](#precision-recall-curve_2)

**Syntax:** obj \<< (fit[number] \<< Precision Recall Curve( state=0|1 ))

**Description:** Shows or hides the Precision-Recall Curve plot. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Liver Cancer.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Severity ),
    Effects(
        :BMI, :Age, :Time, :Markers, :Hepatitis, :Jaundice, :BMI * :Age, :BMI * :Time,
        :BMI * :Markers, :BMI * :Hepatitis, :BMI * :Jaundice, :Age * :Time, :Age * :Markers,
        :Age * :Hepatitis, :Age * :Jaundice, :Time * :Markers, :Time * :Hepatitis,
        :Time * :Jaundice, :Markers * :Hepatitis, :Markers * :Jaundice,
        :Hepatitis * :Jaundice
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 0 );
fm << (fit[1] << Precision Recall Curve( 1 ));


```

#### [Profiler](#profiler_9)

**Syntax:** obj \<< (fit[number] \<< Profiler( state=0|1 ))

**Description:** Shows or hides the Prediction Profiler. Predictors that have parameter estimates of zero and that are not involved in any interaction terms with nonzero coefficients do not appear in the profiler.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
Fit Model(
    Y( :satell ),
    Effects(
        :color, :spine, :width, :weight, :color * :spine, :color * :width, :color * :weight,
        :spine * :width, :spine * :weight, :width * :weight
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Poisson" ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "BIC" ),
            Profiler( 1 )
        )
    )
);


```

#### [Publish Prediction Formula](#publish-prediction-formula_2)

**Syntax:** obj \<< (fit[number] \<< Publish Prediction Formula)

**Description:** Creates a prediction formula and publishes it as a formula column script in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Publish Prediction Formula);


```

#### [Quantile Profiler](#quantile-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Quantile Profiler( state=0|1 ))

**Description:** Shows or hides a profiler that shows the predicted response as a function of the predictors and the quantile of the cumulative distribution function. The quantile is called Probability and is shown in the right-most cell. This option is not available when the specified Distribution is Binomial or Quantile Regression.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
Fit Model(
    Y( :satell ),
    Effects(
        :color, :spine, :width, :weight, :color * :spine, :color * :width, :color * :weight,
        :spine * :width, :spine * :weight, :width * :weight
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Poisson" ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "BIC" ),
            Quantile Profiler( 1 )
        )
    )
);


```

#### [ROC Curve](#roc-curve_2)

**Syntax:** obj \<< (fit[number] \<< ROC Curve( state=0|1 ))

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve. If you used validation, an ROC curve is shown for each of the Training, Validation, and Test sets. This option is available only when the specified Distribution is Binomial, Multinomial, or Ordinal Logistic.

```

dt = Open( "$SAMPLE_DATA/Liver Cancer.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Severity ),
    Effects(
        :BMI, :Age, :Time, :Markers, :Hepatitis, :Jaundice, :BMI * :Age, :BMI * :Time,
        :BMI * :Markers, :BMI * :Hepatitis, :BMI * :Jaundice, :Age * :Time, :Age * :Markers,
        :Age * :Hepatitis, :Age * :Jaundice, :Time * :Markers, :Time * :Hepatitis,
        :Time * :Jaundice, :Markers * :Hepatitis, :Markers * :Jaundice,
        :Hepatitis * :Jaundice
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 0 );
fm << (fit[1] << ROC Curve( 1 ));


```

#### [Relaunch Active Main Effects and Full Factorial](#relaunch-active-main-effects-and-full-factorial)

**Syntax:** obj \<< (fit[number] \<< Relaunch Active Main Effects and Full Factorial)

**Description:** Opens a Fit Model launch window where the Construct Model Effects list contains a set of terms based on the terms that have nonzero parameter estimates. These terms are the active effects. All other specifications in the launch window are those used in the original analysis. The Construct Model Effects list is populated with a full factorial constructed with the active effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Relaunch Active Main Effects and Full Factorial);


```

#### [Relaunch Active Main Effects and Response Surface Model](#relaunch-active-main-effects-and-response-surface-model)

**Syntax:** obj \<< (fit[number] \<< Relaunch Active Main Effects and Response Surface Model)

**Description:** Opens a Fit Model launch window where the Construct Model Effects list contains a set of terms based on the terms that have nonzero parameter estimates. These terms are the active effects. All other specifications in the launch window are those used in the original analysis. The Construct Model Effects list is populated with a response surface model constructed with the active effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Relaunch Active Main Effects and Response Surface Model);


```

#### [Relaunch Active Main Effects and Second Degree Factorial](#relaunch-active-main-effects-and-second-degree-factorial)

**Syntax:** obj \<< (fit[number] \<< Relaunch Active Main Effects and Second Degree Factorial)

**Description:** Opens a Fit Model launch window where the Construct Model Effects list contains a set of terms based on the terms that have nonzero parameter estimates. These terms are the active effects. All other specifications in the launch window are those used in the original analysis. The Construct Model Effects list is populated with a second degree factorial constructed with the active effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Relaunch Active Main Effects and Second Degree Factorial);


```

#### [Relaunch Active Main Effects and Second Degree Polynomial](#relaunch-active-main-effects-and-second-degree-polynomial)

**Syntax:** obj \<< (fit[number] \<< Relaunch Active Main Effects and Second Degree Polynomial)

**Description:** Opens a Fit Model launch window where the Construct Model Effects list contains a set of terms based on the terms that have nonzero parameter estimates. These terms are the active effects. All other specifications in the launch window are those used in the original analysis. The Construct Model Effects list is populated with a second degree polynomial constructed with the active effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Relaunch Active Main Effects and Second Degree Polynomial);


```

#### [Relaunch Active Main Effects and Third Degree Factorial](#relaunch-active-main-effects-and-third-degree-factorial)

**Syntax:** obj \<< (fit[number] \<< Relaunch Active Main Effects and Third Degree Factorial)

**Description:** Opens a Fit Model launch window where the Construct Model Effects list contains a set of terms based on the terms that have nonzero parameter estimates. These terms are the active effects. All other specifications in the launch window are those used in the original analysis. The Construct Model Effects list is populated with a third degree factorial constructed with the active effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Relaunch Active Main Effects and Third Degree Factorial);


```

#### [Relaunch Active Main Effects and Third Degree Polynomial](#relaunch-active-main-effects-and-third-degree-polynomial)

**Syntax:** obj \<< (fit[number] \<< Relaunch Active Main Effects and Third Degree Polynomial)

**Description:** Opens a Fit Model launch window where the Construct Model Effects list contains a set of terms based on the terms that have nonzero parameter estimates. These terms are the active effects. All other specifications in the launch window are those used in the original analysis. The Construct Model Effects list is populated with a third degree polynomial constructed with the active effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Relaunch Active Main Effects and Third Degree Polynomial);


```

#### [Relaunch with Active Effects](#relaunch-with-active-effects)

**Syntax:** obj \<< (fit[number] \<< Relaunch with Active Effects)

**Description:** Opens a Fit Model launch window where the Construct Model Effects list contains a set of terms based on the terms that have nonzero parameter estimates. These terms are the active effects. All other specifications in the launch window are those used in the original analysis. The Construct Model Effects list is populated only with the active effects.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Relaunch with Active Effects);


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (fit[number] \<< Remove Fit)

**Description:** Removes the specified fit from the report.

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
fm = dt << Fit Model(
    Y( :Oxy ),
    Effects(
        :Weight, :Runtime, :RunPulse, :RstPulse, :MaxPulse, :Weight * :Runtime,
        :Weight * :RunPulse, :Weight * :RstPulse, :Weight * :MaxPulse, :Runtime * :RunPulse,
        :Runtime * :RstPulse, :Runtime * :MaxPulse, :RunPulse * :RstPulse,
        :RunPulse * :MaxPulse, :RstPulse * :MaxPulse
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( "Adaptive" ) ), Validation Method( "BIC" ) ) )
);
Wait( 2 );
fm << (fit[1] << Remove Fit);


```

#### [Reset Solution](#reset-solution)

**Syntax:** obj \<< (fit[number] \<< Reset Solution)

**Description:** Resets the model in the solution path to the original model.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
Wait( 1 );
fm << (Fit[1] << Set Solution ID( 122 ));
Wait( 1 );
fm << (Fit[1] << Reset Solution);


```

#### [Save Cox Snell Residual Formula](#save-cox-snell-residual-formula)

**Syntax:** obj \<< (fit[number] \<< Save Cox Snell Residual Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the Cox-Snell residuals.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
fm = dt << Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);
fm << (fit[1] << Save Cox Snell Residual Formula);


```

#### [Save Distribution Formula](#save-distribution-formula)

**Syntax:** obj \<< (fit[number] \<< Save Distribution Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the cumulative distribution function.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( "Adaptive" ) ), Validation Method( "KFold", 5 ) ) )
);
fm << (Fit[1] << Save Distribution Formula);


```

#### [Save Functional Prediction Formulas](#save-functional-prediction-formulas)

**Syntax:** obj \<< (fit[number] \<< Save Functional Prediction Formulas)

**Description:** Saves new columns to the original data table. A new column is added for each FDE principal component response. Each new column contains a prediction formula for each functional principal component. A final column is added that contains a model prediction formula that is a linear combination of the prediction formulas and the eigenfunction columns from the Functional Data Explorer platform. This option is available only when the response columns contain the FDE FPC Num column property.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Simple Linear Functional Data.jmp" );
fobj = Functional Data Explorer(
    Y( :Y ),
    X( :T ),
    ID( :ID ),
    Z( :X1, :X2, :X3 ),
    B Splines( 1 )
);
dtsum = (Report( fobj )["Function Summaries"] << get scriptable object) << Save Summaries;
fobj << close window;
fm = dtsum << Fit Model(
    Y( :Y FPC 1, :Y FPC 2 ),
    Effects( :X1, :X2, :X3, :X1 * :X2, :X1 * :X3, :X2 * :X3 ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( "Best Subset" ),
            Validation Method( "AICc" ),
            Enforce Heredity( 1 )
        )
    )
);
(Report( fm[1] )["Generalized Regression for Y FPC 1"][
"Normal Best Subset with AICc Validation"] << get scriptable object) <<
Save Functional Prediction Formulas;


```

#### [Save Linear Predictor](#save-linear-predictor)

**Syntax:** obj \<< (fit[number] \<< Save Linear Predictor)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the product of the design matrix and the vector of parameter estimates.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
fm = dt << Fit Model(
    Y( :satell ),
    Effects(
        :color, :spine, :width, :weight, :color * :spine, :color * :width, :color * :weight,
        :spine * :width, :spine * :weight, :width * :weight
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Poisson" ),
    Run( Fit( Estimation Method( Lasso( "Adaptive" ) ), Validation Method( "BIC" ) ) )
);
fm << (fit[1] << Save Prediction Formula);
fm << (fit[1] << Save Linear Predictor);


```

#### [Save Martingale Residual Formula](#save-martingale-residual-formula)

**Syntax:** obj \<< (fit[number] \<< Save Martingale Residual Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the martingale residuals.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
fm = dt << Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);
fm << (fit[1] << Save Martingale Residual Formula);


```

#### [Save Prediction Formula](#save-prediction-formula_1)

**Syntax:** obj \<< (fit[number] \<< Save Prediction Formula)

**Description:** Saves a new formula column to the original data table. The new column contains the prediction formula, given in terms of the observed (unstandardized) data values. The prediction formula does not contain zeroed terms.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Save Prediction Formula);


```

#### [Save Resample Formulas](#save-resample-formulas)

**Syntax:** obj \<< (fit[number] \<< Save Resample Formulas)

**Description:** Saves multiple formula columns to the original data table. A column group called SVEM Samples contains one formula column per individual model. These columns are saved as hidden columns. The next column is a prediction formula for the self-validated ensemble model. The next column contains the standard error formula for the self-validated ensemble model. The final column contains the median prediction from the self-validated ensemble model for each row.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run( Fit( Estimation Method( SVEM Forward Selection( Samples( 100 ) ) ) ) )
);
fm << (fit[1] << Save Resample Formulas);


```

#### [Save Residual Formula](#save-residual-formula_1)

**Syntax:** obj \<< (fit[number] \<< Save Residual Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the residuals, given in the form Y minus the prediction formula. The residual formula does not contain zeroed terms.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Save Residual Formula);


```

#### [Save Simulation Formula](#save-simulation-formula_2)

**Syntax:** obj \<< (fit[number] \<< Save Simulation Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula that generates simulated values using the estimated parameters for the model that you fit. This column can be used in the Simulate utility as a Column to Switch In.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( "Adaptive" ) ), Validation Method( "KFold", 5 ) ) )
);
fm << (fit[1] << Save Simulation Formula);


```

#### [Save Survival Formula](#save-survival-formula)

**Syntax:** obj \<< (fit[number] \<< Save Survival Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the probability of survival at the observed time. The survival function is equal to 1 minus the cumulative distribution function.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
fm = dt << Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);
fm << (fit[1] << Save Survival Formula);


```

#### [Save Validation Column](#save-validation-column)

**Syntax:** obj \<< (fit[number] \<< Save Validation Column)

**Description:** Saves a new column to the original data table. The new column describes the assignment of rows to folds. For KFold, the column lists the fold to which the row was assigned. For Holdback, each row is identified as belonging to the Training or Validation set. For Leave-One-Out, the row's value indicates its order in being left out.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( "Adaptive" ) ), Validation Method( "KFold", 5 ) ) )
);
fm << (fit[1] << Save Validation Column);


```

#### [Save Variance Formula](#save-variance-formula)

**Syntax:** obj \<< (fit[number] \<< Save Variance Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the variance of the prediction.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
fm = dt << Fit Model(
    Y( :satell ),
    Effects(
        :color, :spine, :width, :weight, :color * :spine, :color * :width, :color * :weight,
        :spine * :width, :spine * :weight, :width * :weight
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Poisson" ),
    Run( Fit( Estimation Method( Lasso( "Adaptive" ) ), Validation Method( "BIC" ) ) )
);
fm << (fit[1] << Save Variance Formula);


```

#### [Select Nonzero Terms](#select-nonzero-terms)

**Syntax:** obj \<< (fit[number] \<< Select Nonzero Terms)

**Description:** Highlights terms with nonzero coefficients in the report. Also selects all associated columns in the data table. This option is not available when the specified Estimation Method is Ridge Regression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Select Nonzero Terms);


```

#### [Select Zeroed Terms](#select-zeroed-terms)

**Syntax:** obj \<< (fit[number] \<< Select Zeroed Terms)

**Description:** Highlights terms with zero coefficients in the report. Also selects all associated columns in the data table. This option is not available when the specified Estimation Method is Ridge Regression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Select Zeroed Terms);


```

#### [Set Solution ID](#set-solution-id)

**Syntax:** obj \<< (fit[number] \<< Set Solution ID( number ))

**Description:** Changes the specified model to a different model in the solution path.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
Wait( 1 );
fm << (Fit[1] << Set Solution ID( 122 ));


```

#### [Show Prediction Expression](#show-prediction-expression_2)

**Syntax:** obj \<< (fit[number] \<< Show Prediction Expression( state=0|1 ))

**Description:** Shows or hides the Prediction Expression report that contains the equation for the estimated model.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Show Prediction Expression);


```

#### [Show Solution Path Summary](#show-solution-path-summary)

**Syntax:** obj \<< (fit[number] \<< Show Solution Path Summary( state=0|1 ))

**Description:** Shows or hides a report that contains a table of fit statistics for the points on the Solution Path and Validation Path plots where the active set changes. The statistics that are available depend on the estimation method. This option is not available for Maximum Likelihood or Ridge Regression models.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 1 );
fm << (fit[1] << Show Solution Path Summary( 1 ));


```

#### [Solution Path](#solution-path)

**Syntax:** obj \<< (fit[number] \<< Solution Path( state=0|1 ))

**Description:** Shows or hides the Solution Path and Validation Path plots. This option is not available for Maximum Likelihood models. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
Wait( 1 );
fm << (fit[1] << Solution Path( 0 ));


```

#### [Std Error of Predicted](#std-error-of-predicted_3)

**Syntax:** obj \<< (fit[number] \<< Std Error of Predicted)

**Description:** Saves a new column to the original data table. The new column contains the standard errors of the predicted mean response.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
fm << (fit[1] << Save Prediction Formula);
fm << (fit[1] << Std Error of Predicted);


```

#### [Std Error of Predicted Formula](#std-error-of-predicted-formula)

**Syntax:** obj \<< (fit[number] \<< Std Error of Predicted Formula)

**Description:** Saves a new formula column to the original data table. The new column contains a formula for the standard errors of the predicted mean response.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit( Estimation Method( Lasso( Adaptive ) ), Validation Method( Validation Column ) )
    )
);
fm << (fit[1] << Save Prediction Formula);
fm << (fit[1] << Std Error of Predicted Formula);


```

#### [Step Backward](#step-backward)

**Syntax:** obj \<< (fit[number] \<< Step Backward)

**Description:** Moves to the next smallest model in the solution path.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
Wait( 1 );
fm << (Fit[1] << Step Backward);
Wait( 1 );
fm << (Fit[1] << Step Backward);


```

#### [Step Forward](#step-forward)

**Syntax:** obj \<< (fit[number] \<< Step Forward)

**Description:** Moves to the next largest model in the solution path.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "Validation Column" ) ) )
);
Wait( 1 );
fm << (Fit[1] << Step Forward);
Wait( 1 );
fm << (Fit[1] << Step Forward);


```

#### [Survival Profiler](#survival-profiler_1)

**Syntax:** obj \<< (fit[number] \<< Survival Profiler( state=0|1 ))

**Description:** Shows or hides a profiler that shows the survival function as a function of the predictors and the response. The response is shown in the right-most cell. This option is available only when the specified Distribution is Normal, Exponential, Weibull, Lognormal, or Cox Proportional Hazards.

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
fm = dt << Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Age, :Diag Time ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);
fm << (fit[1] << Survival Profiler( 1 ));


```

## [Generalized Regression](#generalized-regression)

### [Associated Constructors](#associated-constructors_14)

#### [Fit Generalized](#fit-generalized)

**Syntax:** Fit Model( Y( columns ), Effects( columns ), Personality( "Generalized Regression" ) )

**Description:** Fits generalized linear models using penalized regression techniques, which help automate variable selection in a way that avoids overfitting. The penalized regression techniques include the lasso, the adaptive lasso, the elastic net, the adaptive elastic net, and ridge regression. The response distributions can accommodate continuous, categorical, count, and time-to-event response data. This is the recommended personality for most regression settings.

**Adaptive Lasso**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( "Adaptive" ) ), Validation Method( "BIC" ) ) )
);


```

**Backward Elimination**

```

dt = Open( "$SAMPLE_DATA/VA Lung Cancer.jmp" );
obj = dt << Fit Model(
    Censor( :censor ),
    Censor Code( "1" ),
    Y( :Time ),
    Effects( :Cell Type, :Treatment, :Prior, :Age, :Diag Time, :KPS ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Weibull" ),
    Run( Fit( Estimation Method( "Backward Elimination" ), Validation Method( "AICc" ) ) )
);


```

**Best Subset**

```

dt = Open( "$SAMPLE_DATA/Fishing.jmp" );
obj = dt << Fit Model(
    Y( :Fish Caught ),
    Effects( :Live Bait, :Fishing Poles, :Camper, :People, :Children ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "ZI Poisson" ),
    Run( Fit( Estimation Method( "Best Subset" ), Validation Method( "AICc" ) ) )
);


```

**Dantzig Selector**

```

dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Dantzig Selector ), Validation Method( "AICc" ) ) )
);


```

**Double Lasso**

```

dt = Open( "$SAMPLE_DATA/Prostate Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Status ),
    Effects( ColumnGroup( "Proteins" ) ),
    Target Level( "CCD" ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Estimation Method( "Double Lasso" ), Validation Method( "AICc" ) ) )
);


```

**Elastic Net**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);


```

**Elastic Net with Early Stopping**

```

dt = Open( "$SAMPLE_DATA/Prostate Cancer.jmp" );
obj = dt << Fit Model(
    Y( :Status ),
    Effects( :PSA, :PSA * :PSA, ColumnGroup( "Proteins" ) ),
    Target Level( "CCD" ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run(
        Fit(
            Estimation Method( "Elastic Net" ),
            Validation Method( "AICc" ),
            Early Stopping( 1 )
        )
    )
);


```

**Forward Selection**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Forward Selection ), Validation Method( "AICc" ) ) )
);


```

**Lasso**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run( Fit( Estimation Method( Lasso ), Validation Method( "Validation Column" ) ) )
);


```

**Logistic Regression**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y Binary ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Target Level( "High" ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Binomial" ),
    Run( Fit( Estimation Method( "Logistic Regression" ), Validation Method( "None" ) ) )
);


```

**Maximum Likelihood**

```

dt = Open( "$SAMPLE_DATA/Fishing.jmp" );
obj = dt << Fit Model(
    Y( :Fish Caught ),
    Effects( :Live Bait, :Fishing Poles, :Camper, :People, :Children ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "ZI Poisson" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);


```

**Pruned Forward Selection**

```

dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Pruned Forward Selection ), Validation Method( "AICc" ) ) )
);


```

**Pruned Forward Selection with Forced Terms**

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( "Pruned Forward Selection" ),
            Validation Method( "AICc" ),
            Force( [1 0 0 0 0 1 0 0 0 0 0] )
        )
    )
);


```

**Pruned Forward Selection with Heredity**

```

dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Pruned Forward Selection ),
            Validation Method( "AICc" ),
            Enforce Heredity( 1 )
        )
    )
);


```

**Quantile Regression**

```

dt = Open( "$SAMPLE_DATA/fitness.jmp" );
fm = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Quantile Regression" ),
    Quantile( 0.5 ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);


```

**Ridge**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run( Fit( Estimation Method( Ridge ), Validation Method( "Validation Column" ) ) )
);


```

**Standard Least Squares**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Standard Least Squares" ), Validation Method( "None" ) ) )
);


```

**SVEM Forward Selection**

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Model(
    Y( :Percent Reacted ),
    Effects(
        :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration,
        :Feed Rate * :Catalyst, :Feed Rate * :Stir Rate, :Feed Rate * :Temperature,
        :Feed Rate * :Concentration, :Catalyst * :Stir Rate, :Catalyst * :Temperature,
        :Catalyst * :Concentration, :Stir Rate * :Temperature, :Stir Rate * :Concentration,
        :Temperature * :Concentration
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit( Estimation Method( SVEM Forward Selection( Samples( 200 ) ) ), Profiler( 1 ) )
    )

);


```

**SVEM Lasso**

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Model(
    Y( :Percent Reacted ),
    Effects(
        :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration,
        :Feed Rate * :Catalyst, :Feed Rate * :Stir Rate, :Feed Rate * :Temperature,
        :Feed Rate * :Concentration, :Catalyst * :Stir Rate, :Catalyst * :Temperature,
        :Catalyst * :Concentration, :Stir Rate * :Temperature, :Stir Rate * :Concentration,
        :Temperature * :Concentration
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( SVEM Lasso( Samples( 200 ) ) ), Profiler( 1 ) ) )

);


```

**Two Stage Forward Selection**

```

dt = Open( "$Sample_Data/Reactor.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        :F, :Ct, :A, :T, :Cn, :F * :Ct, :F * :A, :F * :T, :F * :Cn, :Ct * :A, :Ct * :T,
        :Ct * :Cn, :A * :T, :A * :Cn, :T * :Cn
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Two Stage Forward Selection ),
            Validation Method( "AICc" ),
            Enforce Heredity( 1 )
        )
    )
);


```

### [Columns](#columns_5)

#### [By](#by_5)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Item Messages](#item-messages_31)

#### [Estimation Method](#estimation-method)

**Syntax:** obj = Fit Model(...Run( Fit( Estimation Method( method ) ) )... )

**Description:** Specifies the estimation method or variable selection that is used to fit the model.

**Double Lasso**

```

dt = Open( "$SAMPLE_DATA/Hollywood Movies.jmp" );
fm = dt << Fit Model(
    Y( :World Gross ),
    Effects( :Rotten Tomatoes Score, :Audience Score, :Theme, :Genre ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Double Lasso" ), Validation Method( "AICc" ), Profiler ) )
);


```

**Elastic Net**

```

dt = Open( "$SAMPLE_DATA/Hollywood Movies.jmp" );
fm = dt << Fit Model(
    Y( :World Gross ),
    Effects( :Rotten Tomatoes Score, :Audience Score, :Theme, :Genre ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Gamma" ),
    Run( Fit( Estimation Method( "Elastic Net" ), Validation Method( "AICc" ), Profiler ) )
);


```

**Forward Selection**

```

dt = Open( "$SAMPLE_DATA/Hollywood Movies.jmp" );
fm = dt << Fit Model(
    Y( :World Gross ),
    Effects( :Rotten Tomatoes Score, :Audience Score, :Theme, :Genre ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( "Forward Selection" ),
            Validation Method( "AICc" ),
            Profiler
        )
    )
);


```

**Lasso**

```

dt = Open( "$SAMPLE_DATA/Hollywood Movies.jmp" );
fm = dt << Fit Model(
    Y( :World Gross ),
    Effects( :Rotten Tomatoes Score, :Audience Score, :Theme, :Genre ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Lasso" ), Validation Method( "AICc" ), Profiler ) )
);


```

**Pruned Forward Selection**

```

dt = Open( "$SAMPLE_DATA/flrpaste.jmp" );
fm = dt << Fit Model(
    Y( :Strength ),
    Effects( :Liquid, :Sugar, :Flour, :Sifted, :Type, :Temp, :Salt, :Clamp, :Coat ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit( Estimation Method( "Pruned Forward Selection" ), Validation Method( "AICc" ) )
    )
);


```

#### [Fit](#fit_2)

**Syntax:** obj \<< Fit( Estimation Method( Emethod( estim_options ) ), Validation Method( Vmethod( valid_options ) ), <Early Stopping>, <Enforce Heredity>, \<Force( vector )> )

**Description:** Specifies the Estimation Method and options, the Validation Method and options, and other fitting options for your model. Available estimation options depend on the specified estimation method. Validation options are available for the KFold and Holdback methods. The other fitting options control early stopping, enforcing heredity of terms, and forcing terms into the model.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    ),
    SendToReport( Dispatch( {}, "Model Launch", OutlineBox, Close( 0 ) ) )
);


```

#### [Generalized Distribution](#generalized-distribution)

**Syntax:** obj = Fit Model(...Generalized Distribution( distribution )... )

**Description:** Specifies the distribution of the response column, given the predictor columns, that is used to fit the model.

**Cauchy**

```

dt = Open( "$SAMPLE_DATA/fitness.jmp" );
fm = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( Cauchy ),
    Run( Fit( Estimation Method( Maximum Likelihood ), Validation Method( None ) ) )
);


```

**Cox Proportional Hazards**

```

dt = Open( "$SAMPLE_DATA/rats.jmp" );
fm = dt << Fit Model(
    Censor( :Censor ),
    Censor Code( "1" ),
    Y( :days ),
    Effects( :Group ),
    No Intercept( 1 ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Cox Proportional Hazards" ),
    Run(
        Fit(
            Estimation Method( "Maximum Likelihood" ),
            Validation Method( "None" ),
            Plot Baseline Survival and Hazard( 1 )
        )
    )
);


```

**Exponential**

```

dt = Open( "$SAMPLE_DATA/reliability/tobit2.jmp" );
fm = dt << Fit Model(
    Y( :YLow, :YHigh ),
    Effects( :age, :liquidity ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Exponential" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);


```

**Gamma**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
fm = dt << Fit Model(
    Y( :HARDNESS ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILICA, :SILANE * :SILICA, :SILANE * :SILANE,
        :SULFUR * :SILICA, :SULFUR * :SILANE, :SULFUR * :SULFUR
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Gamma" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);


```

**Lognormal**

```

dt = Open( "$SAMPLE_DATA/reliability/tobit2.jmp" );
fm = dt << Fit Model(
    Y( :YLow, :YHigh ),
    Effects( :age, :liquidity ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "LogNormal" ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);


```

**Multinomial**

```

dt = Open( "$SAMPLE_DATA/Penguins.jmp" );
fm = dt << Fit Model(
    Y( :Species ),
    Effects(
        :Region, :Culmen Length, :Culmen Depth, :Flipper Length, :Body Mass, :Sex,
        :Culmen Length * :Culmen Depth, :Culmen Length * :Flipper Length,
        :Culmen Length * :Body Mass, :Culmen Length * :Sex, :Culmen Depth * :Flipper Length,
        :Culmen Depth * :Body Mass, :Culmen Depth * :Sex, :Flipper Length * :Body Mass,
        :Flipper Length * :Sex, :Body Mass * :Sex
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Multinomial" ),
    Run(
        Fit(
            Estimation Method( "Elastic Net" ),
            Validation Method( "AICc" ),
            Confusion Matrix
        )
    )
);


```

**Negative Binomial**

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
fm = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( Negative Binomial ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);


```

**Normal**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
fm = dt << Fit Model(
    Y( :HARDNESS ),
    Effects(
        :SILICA, :SILANE, :SULFUR, :SILICA * :SILICA, :SILANE * :SILICA, :SILANE * :SILANE,
        :SULFUR * :SILICA, :SULFUR * :SILANE, :SULFUR * :SULFUR
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( "Standard Least Squares" ), Validation Method( "None" ) ) )
);


```

**Poisson**

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
fm = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( Poisson ),
    Run( Fit( Estimation Method( Forward Selection ), Validation Method( AICc ) ) )
);


```

**Robust Regression**

```

dt = Open( "$SAMPLE_DATA/fitness.jmp" );
fm = dt << Fit Model(
    Y( :Oxy ),
    Effects( Factorial To Degree( :Runtime, :Weight, :RunPulse, :RstPulse, :MaxPulse ) ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "t(5)" ),
    Run(
        Fit( Estimation Method( "Pruned Forward Selection" ), Validation Method( "AICc" ) )
    )
);


```

**ZI Negative Binomial**

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
fm = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( ZI Negative Binomial ),
    Run( Fit( Estimation Method( "Maximum Likelihood" ), Validation Method( "None" ) ) )
);


```

#### [Get X Matrix](#get-x-matrix_2)

**Syntax:** obj \<< Get X Matrix

**Description:** Returns the design matrix (also called the X matrix).

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Validation( :Validation ),
    Run(
        Fit(
            Estimation Method( Lasso( "Adaptive" ) ),
            Validation Method( "Validation Column" )
        )
    )
);
As Table( fm << Get X Matrix );


```

#### [Model Dialog](#model-dialog_15)

**Syntax:** obj \<< Model Dialog

**Description:** Shows the completed Fit Model launch window for the current analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Model Dialog;


```

#### [Save Coding Table](#save-coding-table_2)

**Syntax:** obj \<< Save Coding Table

**Description:** Creates a new data table that contains the JMP coding for all model parameters. The last column shows the values of the response variable.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fm = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run
);
fm << Save Coding Table;


```

#### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Fit Model(...Run( Set Random Seed( number ) )...)

**Description:** Sets the seed for the randomization process that is used for KFold and Holdback validation.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Set Random Seed( 1111 ),
        Fit( Estimation Method( "Lasso" ), Validation Method( "Holdback", 0.3 ) )
    )
);


```

#### [Validation Method](#validation-method)

**Syntax:** obj \<< Validation Method( "KFold"|"Holdback"|"Leave-One-Out"|"BIC"|"AICc"|"ERIC"|"None"|"Validation Column" )

**Description:** Specifies the validation method that is used for modeling.

**AICc**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso ), Validation Method( AICc ) ) )
);


```

**BIC**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso ), Validation Method( BIC ) ) )
);


```

**ERIC**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( Adaptive ) ), Validation Method( ERIC ) ) )
);


```

**Holdback**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Gamma" ),
    Run( Fit( Estimation Method( Lasso ), Validation Method( Holdback( .3 ) ) ) )
);


```

**Validation Column**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y Ordinal ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Ordinal Logistic" ),
    Run( Fit( Estimation Method( Elastic Net ), Validation Method( Validation Column ) ) )
);


```

### [Shared Item Messages](#shared-item-messages_16)

#### [Action](#action_16)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_16)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_10)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_15)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_16)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_15)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_16)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_16)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_16)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_15)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_16)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_16)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_15)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_16)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_16)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_16)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_16)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_16)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_16)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_16)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_16)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_16)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_16)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_16)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_16)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_16)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_16)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_16)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_15)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_15)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_15)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_16)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_16)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_16)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_16)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_16)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_16)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_16)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_16)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_16)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_16)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_16)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_16)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Fit Model(
    Y( :Y ),
    Effects(
        Factorial To Degree(
            :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose
        )
    ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( Elastic Net( N Grid Points( 250 ), Min Ratio( .0001 ) ) ),
            Validation Method( "AICc" )
        )
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_15)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_16)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_15)

**Syntax:** obj = Fit Generalized(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Model Dialog](#model-dialog_16)

### [Columns](#columns_6)

#### [ID](#id)

**Syntax:** obj = Run(...\<ID( column )>...)

**Description:** Column that identifies the genetic relationship matrix.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" ),
    Run( Show Prediction Expression( 1 ) )
);
obj << Run;


```

#### [Subgroup](#subgroup)

**Syntax:** obj = Fit Model(...Personality( "Response Screening" ), Subgroup( column(s) )...)

**Description:** Specifies one or more subgroup variables. When a subgroup variable is defined, additional fits are performed for each category of the subgroup variable.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Fit Model(
    Y( :age ),
    Effects( :sex, :type ),
    Subgroup( :country, :marital status ),
    Personality( "Response Screening" ),
    Subgroup Twoway( 1 ),
    Run
);


```

#### [Switch](#switch)

**Syntax:** obj = Fit Model(...Switch( column(s) )...)

**Description:** Specifies columns that can be switched, one at a time, into the model.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" ),
    Run( Show Prediction Expression( 1 ) )
);
obj << Run;


```

### [Item Messages](#item-messages_32)

#### [Cauchy Fit](#cauchy-fit)

**Syntax:** obj = Fit Model(...Personality( "Response Screening" ), Cauchy Fit( state=0|1 )...)

**Description:** Assumes that the errors have a Cauchy distribution. A Cauchy distribution has fatter tails than the normal distribution, resulting in a reduced emphasis on outliers. Available only for the Response Screening personality. This message corresponds to the Very Robust Fit option in the Fit Model launch window.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Fit Model(
    Effects( :Process, :Site, :Process * :Site ),
    Personality( "Response Screening" ),
    Y( 8 :: 394 ),
    Cauchy Fit( 1 ),
    Run
);


```

#### [Censor Code](#censor-code)

**Syntax:** obj = Fit Model(...Censor Code( string )...)

**Description:** Identifies the value in the Censor column that designates right-censored observations.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << Fit Model(
    Y( :days ),
    Effects( :Group ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Censor Code( "1" ),
    Run( Likelihood Ratio Tests( 1 ), Likelihood Confidence Intervals( 1 ) )
);


```

#### [Center Polynomials](#center-polynomials)

**Syntax:** obj = Fit Model(...Center Polynomials( state=0|1 )...)

**Description:** Centers the effects in polynomial models. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE, :SILICA * :SILANE ),
    Center Polynomials( 0 ),
    Personality( "Standard Least Squares" ),
    Run
);


```

#### [Centering](#centering)

**Syntax:** obj = Fit Model(...Personality( "Partial Least Squares" ), Centering( state=0|1 )...)

**Description:** Centers all response variables and model effects by subtracting the mean from each column. Available only for the Partial Least Squares personality. On by default.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
dt << Fit Model(
    Y( :ls, :ha, :dt ),
    Effects( 5 :: 31 ),
    No Intercept( 1 ),
    Personality( "Partial Least Squares" ),
    Centering( 0 ),
    Run( Validation Method( KFold( 7 ) ), Fit( Method( NIPALS ) ), Number of Factors( 5 ) )
);


```

#### [Choose High Target](#choose-high-target)

**Syntax:** obj = Fit Model(...Personality( "Nominal Logistic" ), Choose High Target( state=0|1 )...)

**Description:** Specifies that the larger value of a binary nominal response be used as the target response. Available only for a binary response column in the Nominal Logistic personality. This message corresponds to the Target Level option in the Fit Model launch window.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Choose High Target( 1 ),
    Run( Likelihood Ratio Tests( 1 ), Wald Tests( 0 ), Logistic Plot( 1 ) )
);


```

#### [Convergence Limit](#convergence-limit_1)

**Syntax:** obj = Fit Model(...Convergence Limit( number=0.00000001 )...)

**Description:** Specifies the convergence limit for the model fitting. If your model does not readily converge, you might want to increase the convergence limit. By default, the convergence limit is 0.00000001.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Convergence Limit( 0.0001 ),
    Run
);


```

#### [Create SAS Job](#create-sas-job)

**Syntax:** obj \<< Create SAS Job

**Description:** Saves SAS code for the current model specification to a SAS Program window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" )
);
obj << Create SAS Job;


```

#### [Dispose Reports](#dispose-reports_3)

**Syntax:** obj = Fit Model(...Dispose Reports( state=0|1 )...)

**Description:** Specifies that no individual model reports are shown and that they are removed from memory after fitting. When there are many thousands of responses, this option reduces computation time and saves memory. Use this option with the Results in Data Tables option to collect the results from the fitted models.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Fit Model(
    Y(
        :grain screened, :proof on ctd ink, :blade mfg, :paper type, :ink type, :direct steam,
        :solvent type, :type on cylinder, :press type, :unit number, :cylinder size,
        :paper mill location, :plating tank
    ),
    Effects( "Banding?"n ),
    Personality( "Nominal Logistic" ),
    Results in Data Tables( 1 ),
    Dispose Reports( 1 ),
    Run
);


```

#### [Effects](#effects)

**Syntax:** obj = Run(...Effects( col, col, ... )...); obj = Run(...Effects( macro( col, col, ... ) )...)

**Description:** Assigns explanatory terms to the Effects role. You can specify effects individually or using the macros that are available in the Fit Model launch window. See various examples below.

**Effects**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model( Y( :height ), Effects( :sex, :age, :weight ) );


```

**Factorial Sorted**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model( Y( :height ), Effects( Factorial Sorted( :sex, :age, :weight ) ) );


```

**Factorial to Degree**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model(
    Y( :height ),
    Set Degree( 2 ),
    Effects( Factorial to Degree( :sex, :age, :weight ) )
);


```

**Full Factorial**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model( Y( :height ), Effects( Full Factorial( :sex, :age, :weight ) ) );


```

**Grouped Regressors**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model( Y( :height ), Effects( Grouped Regressors( :height, :weight ) ) );


```

**Mixture Response Surface**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model(
    Y( :height ),
    Effects( Mixture Response Surface( :weight, :age ) )
);


```

**Partial Cubic**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model( Y( :height ), Effects( Partial Cubic( :height, :weight ) ) );


```

**Polynomial to Degree**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model(
    Y( :height ),
    Set Degree( 5 ),
    Effects( Polynomial to Degree( :height, :weight ) )
);


```

**Response Surface**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model( Y( :height ), Effects( Response Surface( :weight, :age ) ) );


```

**Scheffe Cubic**

```


dt = Open( "$SAMPLE_DATA\Big Class.jmp" );
dialog = dt << Fit Model( Y( :height ), Effects( Scheffe Cubic( :height, :weight ) ) );


```

#### [Emphasis](#emphasis)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Squares" ), Emphasis( "Effect Leverage" | "Effect Screening" | "Minimal Report" )...)

**Description:** Specifies the types of plots and statistics that appear in the default report for the Standard Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Screening" )
);
obj << Run Model;


```

#### [Error Specification](#error-specification_2)

**Syntax:** obj = Fit Model(...Personality("Standard Least Squares" ), Error Specification( "Default Estimate" | "Pure Error" | "Specified" )...)

**Description:** Specifies the error variance and the error degrees of freedom that are used for standard errors and tests in the Fit Least Squares report. This option is available only for the Standard Least Squares personality when there are no random effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Center Polynomials( 0 ),
    Personality( "Standard Least Squares" ),
    Error Specification( "Pure Error" ),
    Run
);


```

#### [Estimate Only Variance Components](#estimate-only-variance-components_1)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Squares" ), Estimate Only Variance Components( state=0|1 )...)

**Description:** Runs a REML analysis using the specified model and shows a report that contains only the variance components from the model. Available only for the Standard Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Estimate Only Variance Components( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Run
);


```

#### [Firth Bias-Adjusted Estimates](#firth-bias-adjusted-estimates_1)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), "Firth Bias-Adjusted Estimates"n( state=0|1 )...)

**Description:** Specifies that the Firth bias-adjusted method is used to fit the model. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);


```

#### [Fit Separately](#fit-separately)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Squares" ), Fit Separately( state=0|1 )...)

**Description:** Fits a separate model for each Y variable using all rows that are nonmissing. This option is available only in the Standard Least Squares personality with models that have multiple Y variables and do not contain random effects.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION, :HARDNESS ),
    Effects( :SILICA, :SILANE, :SULFUR ),
    Personality( "Standard Least Squares" ),
    Fit Separately( 1 ),
    Run
);


```

#### [GLM Distribution](#glm-distribution_1)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), GLM Distribution( distribution name )...)

**Description:** Specifies a probability distribution for the response variable. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Binomial" ),
    Link Function( "Logit" ),
    Run
);


```

#### [Generalized Distribution](#generalized-distribution_1)

**Syntax:** obj = Fit Model(...Personality( "Generalized Regression" ), Generalized Distribution( distribution name )...)

**Description:** Specifies the response probability distribution. Available only for the Generalized Regression personality.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Fit Model(
    Y( :height ),
    Effects( :weight, :sex ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run(
        Fit(
            Estimation Method( "Maximum Likelihood" ),
            Validation Method( "None" ),
            Profiler( 1 )
        )
    )
);


```

#### [Imputation Method](#imputation-method)

**Syntax:** obj = Fit Model(...Personality( "Partial Least Squares" ), Imputation Method( "Mean" | "EM" )...)

**Description:** Specifies the method for imputation. By default, the Mean method is used. Available only for the Partial Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Fit Model(
    Y( :POP, :Max deg. F Jan ),
    Effects( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    No Intercept( 1 ),
    Center Polynomials( 0 ),
    Personality( "Partial Least Squares" ),
    Impute Missing Data( 1 ),
    Imputation Method( "EM" ),
    Run(
        Initial Number of Factors( 6 ),
        Validation Method( KFold( 7 ), Initial Number of Factors( 6 ) ),
        Fit( Method( NIPALS ), Number of Factors( 2 ) )
    )
);


```

#### [Impute Missing Data](#impute-missing-data)

**Syntax:** obj = Fit Model(...Personality( "Partial Least Squares" ), Impute Missing Data( state=0|1 )...)

**Description:** Replaces missing data values in the Y or X columns with nonmissing values using the specified Imputation Method. Available only for the Partial Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Fit Model(
    Y( :POP, :Max deg. F Jan ),
    Effects( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    No Intercept( 1 ),
    Center Polynomials( 0 ),
    Personality( "Partial Least Squares" ),
    Impute Missing Data( 1 ),
    Run(
        Initial Number of Factors( 6 ),
        Validation Method( KFold( 7 ), Initial Number of Factors( 6 ) ),
        Fit( Method( NIPALS ), Number of Factors( 2 ) )
    )
);


```

#### [Informative Missing](#informative-missing)

**Syntax:** obj = Fit Model(...Informative Missing( state=0|1 )...)

**Description:** Enables missing value imputation and coding. When this option is not selected, rows with missing values are ignored.

For continuous variables, missing values are replaced by the mean of the variable. Also, a missingness indicator variable is created and included in the model.

For categorical variables, the missing values are not imputed, but are treated as another level of the variable in the model.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:height[3] = dt:age[2] = .;
dt << Fit Model(
    Y( :weight ),
    Effects( :height, :age ),
    Informative Missing( 1 ),
    Personality( "Standard Least Squares" ),
    Run
);


```

#### [Keep dialog open](#keep-dialog-open)

**Syntax:** obj \<< Keep dialog open( state=0|1 )

**Description:** Specifies whether the Fit Model launch window stays open or is closed after the specified model is run.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" ),
    Keep dialog open( 1 ),
    Run
);


```

#### [Link Function](#link-function_1)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), Link Function( link type )...)

**Description:** Specifies the link function for the model. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);


```

#### [Max Iterations](#max-iterations)

**Syntax:** obj = Fit Model(...Personality( "Partial Least Squares" ), Max Iterations( number=1 )...)

**Description:** Specifies the maximum number of iterations that are used by the algorithm. The algorithm terminates if the maximum difference between the current and previous estimates of missing values is bounded by 10^-8. Available only for the Partial Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt << Fit Model(
    Y( :POP, :Max deg. F Jan ),
    Effects( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    No Intercept( 1 ),
    Center Polynomials( 0 ),
    Personality( "Partial Least Squares" ),
    Impute Missing Data( 1 ),
    Imputation Method( "EM" ),
    Max Iterations( 5 ),
    Run(
        Initial Number of Factors( 6 ),
        Validation Method( KFold( 7 ), Initial Number of Factors( 6 ) ),
        Fit( Method( NIPALS ), Number of Factors( 2 ) )
    )
);


```

#### [Maximum Iterations](#maximum-iterations_1)

**Syntax:** obj = Fit Model(...Maximum Iterations( number=100 )...)

**Description:** Specifies the maximum number of iterations that are used in the model fitting. By default, the maximum number of iterations is 100.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Maximum Iterations( 150 ),
    Run
);


```

#### [Method](#method_1)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Squares" ), Method( "EMS" | "REML" )...)

**Description:** Specifies the method that is used for fitting mixed models in the Standard Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    NoBounds( 1 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

#### [No Intercept](#no-intercept)

**Syntax:** obj = Fit Model(...No Intercept( state=0|1 )...)

**Description:** Sets the intercept to zero for the model.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    No Intercept( 1 ),
    Personality( "Standard Least Squares" ),
    Run
);


```

#### [NoBounds](#nobounds_1)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Squares" ), NoBounds( state=0|1 )...)

**Description:** Removes the limits for variance estimations. When off, the lower limit for variance estimations is set to zero. Available only for the Standard Least Squares personality. On by default.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj = dt << Fit Model(
    Y( :miles ),
    Effects( :species, :subject[:species] & Random, :season, :species * :season ),
    NoBounds( 0 ),
    Personality( "Standard Least Squares" ),
    Method( "REML" ),
    Emphasis( "Minimal Report" ),
    Run
);


```

#### [Nominal Coding](#nominal-coding)

**Syntax:** obj = Fit Model(...Nominal Coding( "Average Level" | "Last Level" )...)

**Description:** Specifies whether the coding for nominal effects estimates differences from the average across the levels (the default) or from the last level.

```

dt = Open( "$SAMPLE_DATA/Tablet Production.jmp" );
dt << Fit Model(
    Y( :Disso ),
    Effects(
        :Mill Time, :Screen Size, :Blend Time, :Blend Speed, :Compressor, :Coating Viscosity,
        :Spray Rate
    ),
    Personality( "Standard Least Squares" ),
    Nominal Coding( "Last Level" ),
    Emphasis( "Effect Leverage" ),
    Run
);


```

#### [Overdispersion Tests and Intervals](#overdispersion-tests-and-intervals_1)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), Overdispersion Tests and Intervals( state=0|1 )...)

**Description:** Specifies that an overdispersion parameter should be included in the model. Available only for the Generalized Linear Model personality.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    Overdispersion Tests and Intervals( 1 ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Run
);


```

#### [Personality](#personality)

**Syntax:** obj = Fit Model(...Personality( "Standard Least Sqaures" | "Stepwise" | "Generalized Regression" | "Mixed Model" | "Generalized Linear Mixed Model" | "Manova" | "Loglinear Variance" | "Nominal Logistic" | "Ordinal Logistic" | "Proportional Hazard" | "Parametric Survival" | "Generalized Linear Model" | "Partial Least Squares" | "Response Screening" )...)

**Description:** Specifies the type of analysis that is used to fit the model.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" )
);
obj << Run Model;


```

#### [Power Link Parameter](#power-link-parameter_1)

**Syntax:** obj = Fit Model(...Personality( "Generalized Linear Model" ), Power Link Parameter( value=1 )...)

**Description:** Specifies the parameter for the Power link function. Available only when Power is specified as the link function in the Generalized Linear Model personality. "1" by default.

```

dt = Open( "$SAMPLE_DATA/CrabSatellites.jmp" );
obj = dt << Fit Model(
    Y( :satell ),
    Effects( :color, :spine, :width, :weight ),
    Center Polynomials( 0 ),
    Personality( "Generalized Linear Model" ),
    Overdispersion Tests and Intervals( 1 ),
    GLM Distribution( "Poisson" ),
    Link Function( "Power" ),
    Power Link Parameter( 0.5 ),
    Run
);


```

#### [Quantile](#quantile)

**Syntax:** obj = Fit Model(...Personality( "Generalized Regression" ), Generalized Distribution( "Quantile Regression" ), Quantile( q=0.5 )...)

**Description:** Specifies the quantile of the response to be modeled. Available only for the Generalized Regression personality.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Fit Model(
    Y( :height ),
    Effects( :weight, :sex ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Quantile Regression" ),
    Quantile( 0.75 ),
    Run(
        Fit(
            Estimation Method( "Maximum Likelihood" ),
            Validation Method( "None" ),
            Profiler( 1 )
        )
    )
);


```

#### [Results in Data Tables](#results-in-data-tables_3)

**Syntax:** obj = Fit Model(...Results in Data Tables( state=0|1 )...)

**Description:** Saves the individual model results across many responses into data tables. The contents and number of output data tables depend on the model being fit.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Fit Model(
    Y(
        :grain screened, :proof on ctd ink, :blade mfg, :paper type, :ink type, :direct steam,
        :solvent type, :type on cylinder, :press type, :unit number, :cylinder size,
        :paper mill location, :plating tank
    ),
    Effects( "Banding?"n ),
    Personality( "Nominal Logistic" ),
    Results in Data Tables( 1 ),
    Run
);


```

#### [Robust Fit](#robust-fit)

**Syntax:** obj = Fit Model(...Personality( "Response Screening" ), Robust Fit( state=0|1 )...)

**Description:** Uses robust (Huber) estimation to down weight outliers. If there are no outliers, these estimates are close to the least squares estimates. Available only for the Response Screening personality. This message corresponds to the Robust Fit option in the Fit Model launch window.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Fit Model(
    Effects( :Process, :Site, :Process * :Site ),
    Personality( "Response Screening" ),
    Y( 8 :: 394 ),
    Robust Fit( 1 ),
    Run
);


```

#### [Run](#run)

**Syntax:** obj = Fit Model(...Run( <options> )...); obj \<< Run( <options> )

**Description:** Runs the model that is specified in the Fit Model launch window and then closes the launch window.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" ),
    Run( Show Prediction Expression( 1 ) )
);
obj << Run;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" )
);
obj << Run;


```

#### [Run Model](#run-model_1)

**Syntax:** obj \<< Run Model

**Description:** Runs the model that is specified in the Fit Model launch window and keeps the launch window open.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" )
);
obj << Run Model;


```

#### [Save to Data Table](#save-to-data-table)

**Syntax:** obj \<< Save to Data Table

**Description:** Saves the model as JSL to the current data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" )
);
obj << Save to DataTable;


```

#### [Save to Script Window](#save-to-script-window)

**Syntax:** obj \<< Save to Script Window

**Description:** Saves the model as JSL to the script window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Personality( "Standard Least Squares" )
);
obj << Save to Script Window;


```

#### [Scaling](#scaling)

**Syntax:** obj = Fit Model(...Personality( "Partial Least Squares" ), Scaling( state=0|1 )...)

**Description:** Scales all response variables and model effects by dividing each column by its standard deviation. Available only for the Partial Least Squares personality. On by default.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
dt << Fit Model(
    Y( :ls, :ha, :dt ),
    Effects( 5 :: 31 ),
    No Intercept( 1 ),
    Personality( "Partial Least Squares" ),
    Scaling( 0 ),
    Run( Validation Method( KFold( 7 ) ), Fit( Method( NIPALS ) ), Number of Factors( 5 ) )
);


```

#### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj = Fit Model(...Set Alpha Level( state=0|1 )...)

**Description:** Specifies the alpha level for confidence intervals in the model reports.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Fit Model(
    Y( :ABRASION ),
    Effects( :SILICA, :SILANE ),
    Center Polynomials( 0 ),
    Personality( "Standard Least Squares" ),
    Set Alpha Level( 0.01 ),
    Run
);


```

#### [Standardize X](#standardize-x)

**Syntax:** obj = Fit Model(...Personality( "Partial Least Squares" ), Standardize X( state=0|1 )...)

**Description:** Centers and scales all columns that are used in the construction of model effects. If this option is not selected, higher-order effects are constructed using the original data table columns. Then each higher-order effect is centered or scaled, based on the selected Centering and Scaling options. Note that Standardize X does not center or scale Y variables. Available only for the Partial Least Squares personality. On by default.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
dt << Fit Model(
    Y( :ls, :ha, :dt ),
    Effects( 5 :: 31 ),
    No Intercept( 1 ),
    Personality( "Partial Least Squares" ),
    Standardize X( 0 ),
    Run( Validation Method( KFold( 7 ) ), Fit( Method( NIPALS ) ), Number of Factors( 5 ) )
);


```

#### [Subgroup Twoway](#subgroup-twoway)

**Syntax:** obj = Fit Model(...Personality( "Response Screening" ), Subgroup( column(s) ), Subgroup Twoway( state=0|1 )...)

**Description:** Fits all of the two-way subgroup combinations. This option is available only when at least one Subgroup variable is defined in the Response Screening personality.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Fit Model(
    Y( :age ),
    Effects( :sex, :type ),
    Subgroup( :country, :marital status ),
    Personality( "Response Screening" ),
    Subgroup Twoway( 1 ),
    Run
);


```

#### [Suppress Coding](#suppress-coding)

**Syntax:** obj = Fit Model(...Suppress Coding( state=0|1 )...)

**Description:** Suppresses any Coding column property so that estimates are for the original scale. The Coding column property enables you to more easily compare estimates and is helpful in making lower order effect tests meaningful. The Suppress Coding option is not recommended unless you need it.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
obj = dt << Fit Model(
    Y( :Stretch ),
    Effects( :Silica, :Sulfur, :Silane ),
    Suppress Coding( 1 ),
    Personality( "Standard Least Squares" ),
    Run
);


```

#### [Suppress Reports](#suppress-reports_3)

**Syntax:** obj = Fit Model(...Suppress Reports( state=0|1 )...)

**Description:** Specifies that the individual model reports are hidden. When there are thousands of responses, this option reduces computation time. The fitting objects and some menu items are still available. Use the Results in Data Tables option to collect the results from the model reports.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Fit Model(
    Y(
        :grain screened, :proof on ctd ink, :blade mfg, :paper type, :ink type, :direct steam,
        :solvent type, :type on cylinder, :press type, :unit number, :cylinder size,
        :paper mill location, :plating tank
    ),
    Effects( "Banding?"n ),
    Personality( "Nominal Logistic" ),
    Results in Data Tables( 1 ),
    Suppress Reports( 1 ),
    Run
);


```

#### [Suppress Warning for Missing Effects](#suppress-warning-for-missing-effects)

**Syntax:** obj = Fit Model(...Suppress Warning for Missing Effects( state=0|1 )...)

**Description:** Suppresses warning alerts that lower-order effects implied by higher-order effects are not in the model. This option is useful when experimenting with many subset models.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Bounce Data.jmp" );
obj = dt << Fit Model(
    Y( :Stretch ),
    Effects( :Silica, :Sulfur * :Silane ),
    Suppress Warning for Missing Effects( 1 ),
    Personality( "Standard Least Squares" ),
    Run
);


```

#### [Target Level](#target-level)

**Syntax:** obj = Fit Model(...Target Level( level )...)

**Description:** Specifies the level whose probability you want to model. The default value is the higher of the two levels based on the order of the levels. Available only in certain personalities and when the Y variable is binary and has a Nominal modeling type.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :"ln(dose)"n ),
    Personality( "Nominal Logistic" ),
    Target Level( "Cured" ),
    Run( Likelihood Ratio Tests( 1 ), Wald Tests( 0 ), Logistic Plot( 1 ) )
);


```

# [Fit Two Level Screening](#fit-two-level-screening)

## [Associated Constructors](#associated-constructors)

### [Fit Two Level Screening](#fit-two-level-screening_1)

**Syntax:** Fit Two Level Screening( Y( column ), X( columns ) )

**Description:** Analyzes definitive screening designs (DSDs) using a methodology called Effective Model Selection for DSDs. This algorithm uses the unique structure of the design to identify main and second-order effects.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reactor Half Fraction.jmp" );
obj = dt << Fit Two Level Screening(
    Y( :Percent Reacted ),
    X( :Feed Rate, :Catalyst, :Stir Rate, :Temperature, :Concentration )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Fit Two Level Screening(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Fit Y by X Group](#fit-y-by-x-group)

## [Bivariate > Bivariate Curve](#bivariate-bivariate-curve)

### [Associated Constructors](#associated-constructors)

#### [Curve](#curve)

**Syntax:** obj \<< ( Curve[number] )

**Description:** Accesses an individual curve for routing further messages.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ), Fit Line );
obj << (curve[1] << Line of Fit( 1 ));
Wait( 1 );
obj << (curve[1] << Line of Fit( 0 ));


```

### [Item Messages](#item-messages)

#### [Confid Curves Fit](#confid-curves-fit)

**Syntax:** obj \<< ( Curve[number] \<< Confid Curves Fit( state=0|1 ) ); obj \<< Fit Name( {Confid Curves Fit( state=0|1 )} )

**Description:** Shows or hides the confidence curves for the fitted line.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Fit( 1 )} );
Wait( 1 );
obj << Fit Polynomial( 3 );
obj << (curve[2] << Confid Curves Fit( 1 ));


```

#### [Confid Curves Indiv](#confid-curves-indiv)

**Syntax:** obj \<< ( Curve[number] \<< Confid Curves Indiv( state=0|1 ) ); obj \<< Fit Name( {Confid Curves Indiv( state=0|1 )} )

**Description:** Shows or hides the confidence curves for an individual predicted value.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Line( {Confid Curves Indiv( 1 )} ) );
Wait( 1 );
obj << Fit Polynomial( 3 );
obj << (curve[2] << Confid Curves Indiv( 1 ));


```

#### [Confid Shaded Fit](#confid-shaded-fit)

**Syntax:** obj \<< ( Curve[number] \<< Confid Shaded Fit( state=0|1 ) ); obj \<< Fit Name( {Confid Shaded Fit( state=0|1 )} )

**Description:** Shades the area between the confidence curves and the fitted line.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Fit( 1 ), Confid Shaded Fit( 1 )} );
Wait( 1 );
obj << (curve[1] << Confid Shaded Fit( 0 ));


```

#### [Confid Shaded Indiv](#confid-shaded-indiv)

**Syntax:** obj \<< ( Curve[number] \<< Confid Shaded Indiv( state=0|1 ) ); obj \<< Fit Name( {Confid Shaded Indiv( state=0|1 )} )

**Description:** Shades the area between the confidence curves for an individual predicted value and the fitted line.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Indiv( 1 ), Confid Shaded Indiv( 1 )} );
Wait( 1 );
obj << (curve[1] << Confid Shaded Indiv( 0 ));


```

#### [Indiv Confidence Limit Formula](#indiv-confidence-limit-formula)

**Syntax:** obj \<< ( Curve[number] \<< Indiv Confidence Limit Formula( <alpha> ) ); obj \<< Fit Name( {Indiv Confidence Limit Formula( <alpha> ) )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for an individual prediction that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Indiv Confidence Limit Formula( .001 ));
Wait( 1 );
obj << Fit Line( {Indiv Confidence Limit Formula( 0.01 )} );


```

#### [Line Color](#line-color)

**Syntax:** obj \<< ( Curve[number] \<< Line Color( "color" ) ); obj \<< Fit Name( {Line Color( "color" )} ) obj \<< Density Ellipse( {Line Color( "color" )} )

**Description:** Changes the line color of the fitted line, confidence curves, and shaded confidence regions.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Indiv, Line Color( "Medium Dark BlueGreen" )} );
Wait( 1 );
obj << (curve[1] << Line Color( "black" ));


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.95, {Line Color( "Medium Dark BlueGreen" )} );
Wait( 1 );
obj << (curve[1] << Line Color( "black" ));


```

#### [Line Style](#line-style)

**Syntax:** obj \<< ( Curve[number] \<< Line Style( "pen style" ) ); obj \<< Fit Name( {Line Styel( "pen style" )} ) obj \<< Density Ellipse( {Line Style( "pen style" )} )

**Description:** Changes the line style of the fitted line.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Line( {Confid Curves Fit} ) );
Wait( 1 );
obj << (Curve[1] << Line Style( "DashDot" ));
obj << Fit Polynomial( 3, {Line Style( "Dense Dash" )} );


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Density Ellipse( 0.95 ) );
Wait( 1 );
obj << (Curve[1] << Line Style( "DashDot" ));
obj << Density Ellipse( 0.90, {Line Style( "Dense Dash" )} );


```

#### [Line Width](#line-width)

**Syntax:** obj \<< ( Curve[number] \<< Line Width( number ) ); obj \<< Fit Name( {Line Width( number )} ) obj \<< Density Ellipse( {Line Width( number )} )

**Description:** Changes the line width of both the fitted line and any confidence curves.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Line Width( 3 )} );
Wait( 1 );
obj << (curve[1] << Line Width( 1 ));


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.99, {Line Width( 3 )} );
Wait( 1 );
obj << (curve[1] << Line Width( 1 ));


```

#### [Line of Fit](#line-of-fit)

**Syntax:** obj \<< ( Curve[number] \<< Line of Fit( state=0|1 ) ); obj \<< Fit Name( {Line of Fit( state=0|1 )} ) obj \<< Density Ellipse( {Line of Fit( state=0|1 )} )

**Description:** Shows or hides the line of fit. On by default.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Line );
Wait( 1 );
obj << (Curve[1] << Line of Fit( 0 ));
obj << Fit Polynomial( 3, {Line of Fit( 0 )} );


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Density Ellipse( 0.95 ) );
Wait( 1 );
obj << (Curve[1] << Line of Fit( 0 ));
obj << Density Ellipse( 0.90, {Line of Fit( 0 )} );


```

#### [Mean Confidence Limit Formula](#mean-confidence-limit-formula)

**Syntax:** obj \<< ( Curve[number] \<< Mean Confidence Limit Formula( <alpha> ) ); obj \<< Fit Name( {Mean Confidence Limit Formula( <alpha> ) )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for the mean response that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Mean Confidence Limit Formula( .01 ));
Wait( 1 );
obj << Fit Line( {Mean Confidence Limit Formula( 0.05 )} );


```

#### [Plot Residuals](#plot-residuals)

**Syntax:** obj \<< ( Curve[number] \<< Plot Residuals( state=0|1 ) ); obj \<< Fit Name( {Plot Residuals( state=0|1 )} )

**Description:** Shows or hides five diagnostic plots.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( 1, {Plot Residuals( 1 )} );
Wait( 1 );
obj << (curve[1] << Plot Residuals( 0 ));


```

#### [Profiler](#profiler)

**Syntax:** obj \<< ( Curve[number] \<< Profiler( state=0|1 ) ); obj \<< Fit Name( {Profiler( state=0|1 )} )

**Description:** Shows or hides a prediction profiler for the selected outcome given the selected predictor and the specified model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Polynomial( 3, {Profiler( 1 )} );
Wait( 1 );
obj << (Curve[1] << Profiler( 0 ));


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< ( Curve[number] \<< Remove Fit )

**Description:** Removes the fitted curve.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( 1 );
obj << Fit Polynomial( 3 );
Wait( 1 );
obj << (Curve[2] << Remove Fit);


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.95 );
obj << Density Ellipse( 0.90 );
Wait( 1 );
obj << (Curve[2] << Remove Fit);


```

#### [Report](#report)

**Syntax:** obj \<< ( Curve[number] \<< Report( state=0|1 ) ); obj \<< Fit Name( {Report( state=0|1 )} ) obj \<< Density Ellipse( {Report( state=0|1 )} )

**Description:** Shows or hides the reports for summary of fit, lack of fit, ANOVA, and parameter estimates. On by default.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Report( 0 )} );
Wait( 1 );
obj << (Curve[1] << Report( 1 ));


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.95, {Report( 0 )} );
Wait( 1 );
obj << (Curve[1] << Report( 1 ));


```

#### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< ( Curve[number] \<< Save Predicteds ); obj \<< Fit Name( {Save Predicteds} )

**Description:** Saves a new column to the original data table. The column contains the predicted values for the specified fitted curve.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Polynomial( 3, {Save Predicteds} );
Wait( 1 );
obj << Fit Line( 1 );
obj << (curve[2] << Save Predicteds);


```

#### [Save Residuals](#save-residuals)

**Syntax:** obj \<< ( Curve[number] \<< Save Residuals ); obj \<< Fit Name( {Save Residuals} )

**Description:** Saves a new column to the original data table. The column contains the residual values for the specified fitted curve.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Save Residuals);
Wait( 1 );
obj << Fit Line( {Save Residuals} );


```

#### [Save Studentized Residuals](#save-studentized-residuals)

**Syntax:** obj \<< ( Curve[number] \<< Save Studentized Residuals ); obj \<< Fit Name( {Save Studentized Residuals} )

**Description:** Saves a new column to the original data table. The column contains the Studentized residuals for the specified fitted curve.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Save Studentized Residuals);
Wait( 1 );
obj << Fit Line( {Save Studentized Residuals} );


```

#### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj \<< ( Curve[number] \<< Set Alpha Level( alpha ) ); obj \<< Fit Name( {Set Alpha Level( alpha )} )

**Description:** Changes the alpha level used for the confidence curves.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Fit( 1 ), Set Alpha Level( 0.001 )} );
obj << Fit Polynomial( 2, {Confid Curves Fit( 1 )} );
Wait( 1 );
obj << (curve[2] << Set Alpha Level( 0.01 ));


```

#### [Set α Level](#set-level)

**Syntax:** obj \<< ( Curve[number] \<< Set Alpha Level( alpha ) ); obj \<< Fit Name( {Set Alpha Level( alpha )} )

**Description:** Changes the alpha level used for the confidence curves.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Fit( 1 ), Set Alpha Level( 0.001 )} );
obj << Fit Polynomial( 2, {Confid Curves Fit( 1 )} );
Wait( 1 );
obj << (curve[2] << Set Alpha Level( 0.01 ));


```

## [Bivariate > Bivariate Nonpar Density](#bivariate-bivariate-nonpar-density)

### [Item Messages](#item-messages_1)

#### [5% Contours](#5-contours)

**Syntax:** obj \<< ( Curve[number] \<< "5% Contours"n( state=0|1 ) ); obj \<< Nonpar Density( {"5% Contours"n( state=0|1 )} )

**Description:** Shows or hides the 5% contour lines. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {"5% Contours"n( 0 )} );
Wait( 1 );
obj << (curve[1] << "5% Contours"n( 1 ));


```

#### [Color By Density Quantile](#color-by-density-quantile)

**Syntax:** obj \<< ( Curve[number] \<< Color By Density Quantile ); obj \<< Nonpar Density( {Color by Density Quantile} )

**Description:** Colors the points and rows according to the density.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Nonpar Density );
Wait( 1 );
obj << (curve[1] << Color By Density Quantile);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Color By Density Quantile} );


```

#### [Color Theme](#color-theme)

**Syntax:** obj \<< ( Curve[number] \<< Color Theme( "theme"(state=0|1 ) ) ); obj \<< Nonpar Density( {Color Theme( "theme"( state=0|1 ) )} )

**Description:** Sets the color theme for the quantile density contour lines.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Nonpar Density );
obj << (curve[1] << Color Theme( "Jet"(1) ));


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Color Theme( "White to Black"(1) )} );


```

#### [Contour Fill](#contour-fill)

**Syntax:** obj \<< ( Curve[number] \<< Contour Fill( state=0|1 ) ); obj \<< Nonpar Density( {Contour Fill( state=0|1 )} )

**Description:** Shows or hides the filled contours.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Nonpar Density( {Contour Lines( 0 )} ) );
obj << (curve[1] << Contour Fill( 1 ));


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Contour Fill( 1 )} );


```

#### [Contour Lines](#contour-lines)

**Syntax:** obj \<< ( Curve[number] \<< Contour Lines( state=0|1 ) ); obj \<< Nonpar Density( {Contour Lines( state=0|1 )} )

**Description:** Shows or hides the contour lines. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Contour Lines( 0 )} );
Wait( 1 );
obj << (curve[1] << Contour Lines( 1 ));


```

#### [Kernel Control](#kernel-control)

**Syntax:** obj \<< ( Curve[number] \<< Kernel Control( state=0|1 ) ); obj \<< Nonpar Density( {Kernel Control( state=0|1 )} )

**Description:** Shows or hides a slider to control the standard deviation for each variable. The standard deviation defines the range of X and Y values for determining the density of contour lines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Kernel Control( 1 )} );
Wait( 1 );
obj << (curve[1] << Kernel Control( 0 ));


```

#### [Mesh Plot](#mesh-plot)

**Syntax:** obj \<< ( Curve[number] \<< Mesh Plot( state=0|1 ) ); obj \<< Nonpar Density( {Mesh Plot( state=0|1 )} )

**Description:** Shows or hides a three-dimensional plot of the density over a grid of the two analysis variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Mesh Plot( 1 )} );
Wait( 1 );
obj << (curve[1] << Mesh Plot( 0 ));


```

#### [Modal Clustering](#modal-clustering)

**Syntax:** obj \<< ( Curve[number] \<< Modal Clustering( state=0|1 ) ); obj \<< Nonpar Density( {Modal Clustering( state=0|1 )} )

**Description:** Shows or hides the results for a modal clustering of the data, which identifies cluster assignments based on the current contours. This option also saves the cluster numbers to a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Modal Clustering( 1 )} );
Wait( 1 );
obj << (curve[1] << Modal Clustering( 0 ));


```

#### [Remove Fit](#remove-fit_1)

**Syntax:** obj \<< ( Curve[number] \<< Remove Fit )

**Description:** Removes the nonparametric density.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density();
Wait( 1 );
obj << (curve[1] << Remove Fit);


```

#### [Report](#report_1)

**Syntax:** obj \<< ( Curve[number] \<< Report( state=0|1 ) ); obj \<< Nonpar Density( {Report( state=0|1 )} )

**Description:** Shows or hides the Quantile Density Contours report. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Report( 0 )} );
Wait( 1 );
obj << (curve[1] << Report( 1 ));


```

#### [Save Density Grid](#save-density-grid)

**Syntax:** obj \<< ( Curve[number] \<< Save Density Grid ); obj \<< Nonpar Density( {Save Density Grid} )

**Description:** Saves columns to a new data table. The columns contain the density estimates and corresponding quantiles.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Save Density Grid} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Nonpar Density );
obj << (curve[1] << Save Density Grid);


```

#### [Save Density Quantile](#save-density-quantile)

**Syntax:** obj \<< ( Curve[number] \<< Save Density Quantile ); obj \<< Nonpar( {Save Density Quantile} )

**Description:** Saves a new column to the original data table. The column contains a value that represents the density quantile that contains each point.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Nonpar Density );
obj << (curve[1] << Save Density Quantile);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Save Density Quantile} );


```

#### [Select Points by Density](#select-points-by-density)

**Syntax:** obj \<< ( Curve[number] \<< Select Points by Density( lower probability, upper probability ) ); obj \<< Nonpar Density( {Select Points by Density( lower probability, upper probability )} )

**Description:** Selects points between the specified lower and upper probabilities.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Select Points by Density( 0.2, 0.5 )} );
Wait( 1 );
obj << (curve[1] << Select Points by Density( 0.8, 1 ));


```

#### [Set Kernel](#set-kernel)

**Syntax:** obj \<< ( Curve[number] \<< Set Kernel( xStdDev, yStdDev )); obj \<< Nonpar Density( {Set Kernel( xStdDev, yStdDev )} )

**Description:** Sets the kernel standard deviations for both the X and Y values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density( {Kernel Control( 1 ), Set Kernel( 8.537, 1.7333 )} );
Wait( 1 );
obj << (curve[1] << Set Kernel( 8, 1 ));


```

## [Bivariate > Bivariate Normal Ellipse](#bivariate-bivariate-normal-ellipse)

### [Item Messages](#item-messages_2)

#### [Confid Curves Fit](#confid-curves-fit_1)

**Syntax:** obj \<< ( Curve[number] \<< Confid Curves Fit( state=0|1 ) ); obj \<< Fit Name( {Confid Curves Fit( state=0|1 )} )

**Description:** Shows or hides the confidence curves for the fitted line.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Fit( 1 )} );
Wait( 1 );
obj << Fit Polynomial( 3 );
obj << (curve[2] << Confid Curves Fit( 1 ));


```

#### [Confid Curves Indiv](#confid-curves-indiv_1)

**Syntax:** obj \<< ( Curve[number] \<< Confid Curves Indiv( state=0|1 ) ); obj \<< Fit Name( {Confid Curves Indiv( state=0|1 )} )

**Description:** Shows or hides the confidence curves for an individual predicted value.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Line( {Confid Curves Indiv( 1 )} ) );
Wait( 1 );
obj << Fit Polynomial( 3 );
obj << (curve[2] << Confid Curves Indiv( 1 ));


```

#### [Indiv Confidence Limit Formula](#indiv-confidence-limit-formula_1)

**Syntax:** obj \<< ( Curve[number] \<< Indiv Confidence Limit Formula( <alpha> ) ); obj \<< Fit Name( {Indiv Confidence Limit Formula( <alpha> ) )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for an individual prediction that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Indiv Confidence Limit Formula( .001 ));
Wait( 1 );
obj << Fit Line( {Indiv Confidence Limit Formula( 0.01 )} );


```

#### [Line Color](#line-color_1)

**Syntax:** obj \<< ( Curve[number] \<< Line Color( "color" ) ); obj \<< Fit Name( {Line Color( "color" )} ) obj \<< Density Ellipse( {Line Color( "color" )} )

**Description:** Changes the line color of the fitted line, confidence curves, and shaded confidence regions.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Confid Curves Indiv, Line Color( "Medium Dark BlueGreen" )} );
Wait( 1 );
obj << (curve[1] << Line Color( "black" ));


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.95, {Line Color( "Medium Dark BlueGreen" )} );
Wait( 1 );
obj << (curve[1] << Line Color( "black" ));


```

#### [Line Style](#line-style_1)

**Syntax:** obj \<< ( Curve[number] \<< Line Style( "pen style" ) ); obj \<< Fit Name( {Line Styel( "pen style" )} ) obj \<< Density Ellipse( {Line Style( "pen style" )} )

**Description:** Changes the line style of the fitted line.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Line( {Confid Curves Fit} ) );
Wait( 1 );
obj << (Curve[1] << Line Style( "DashDot" ));
obj << Fit Polynomial( 3, {Line Style( "Dense Dash" )} );


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Density Ellipse( 0.95 ) );
Wait( 1 );
obj << (Curve[1] << Line Style( "DashDot" ));
obj << Density Ellipse( 0.90, {Line Style( "Dense Dash" )} );


```

#### [Line Width](#line-width_1)

**Syntax:** obj \<< ( Curve[number] \<< Line Width( number ) ); obj \<< Fit Name( {Line Width( number )} ) obj \<< Density Ellipse( {Line Width( number )} )

**Description:** Changes the line width of both the fitted line and any confidence curves.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Line Width( 3 )} );
Wait( 1 );
obj << (curve[1] << Line Width( 1 ));


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.99, {Line Width( 3 )} );
Wait( 1 );
obj << (curve[1] << Line Width( 1 ));


```

#### [Line of Fit](#line-of-fit_1)

**Syntax:** obj \<< ( Curve[number] \<< Line of Fit( state=0|1 ) ); obj \<< Fit Name( {Line of Fit( state=0|1 )} ) obj \<< Density Ellipse( {Line of Fit( state=0|1 )} )

**Description:** Shows or hides the line of fit. On by default.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Line );
Wait( 1 );
obj << (Curve[1] << Line of Fit( 0 ));
obj << Fit Polynomial( 3, {Line of Fit( 0 )} );


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Density Ellipse( 0.95 ) );
Wait( 1 );
obj << (Curve[1] << Line of Fit( 0 ));
obj << Density Ellipse( 0.90, {Line of Fit( 0 )} );


```

#### [Mean Confidence Limit Formula](#mean-confidence-limit-formula_1)

**Syntax:** obj \<< ( Curve[number] \<< Mean Confidence Limit Formula( <alpha> ) ); obj \<< Fit Name( {Mean Confidence Limit Formula( <alpha> ) )

**Description:** Saves new formula columns to the original data table. There are columns for the lower and upper confidence limits for the mean response that are functions of the regressors. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Mean Confidence Limit Formula( .01 ));
Wait( 1 );
obj << Fit Line( {Mean Confidence Limit Formula( 0.05 )} );


```

#### [Remove Fit](#remove-fit_2)

**Syntax:** obj \<< ( Curve[number] \<< Remove Fit )

**Description:** Removes the fitted curve.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( 1 );
obj << Fit Polynomial( 3 );
Wait( 1 );
obj << (Curve[2] << Remove Fit);


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.95 );
obj << Density Ellipse( 0.90 );
Wait( 1 );
obj << (Curve[2] << Remove Fit);


```

#### [Report](#report_2)

**Syntax:** obj \<< ( Curve[number] \<< Report( state=0|1 ) ); obj \<< Fit Name( {Report( state=0|1 )} ) obj \<< Density Ellipse( {Report( state=0|1 )} )

**Description:** Shows or hides the reports for summary of fit, lack of fit, ANOVA, and parameter estimates. On by default.

**Curve Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( {Report( 0 )} );
Wait( 1 );
obj << (Curve[1] << Report( 1 ));


```

**Normal Ellipse Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.95, {Report( 0 )} );
Wait( 1 );
obj << (Curve[1] << Report( 1 ));


```

#### [Save Predicteds](#save-predicteds_1)

**Syntax:** obj \<< ( Curve[number] \<< Save Predicteds ); obj \<< Fit Name( {Save Predicteds} )

**Description:** Saves a new column to the original data table. The column contains the predicted values for the specified fitted curve.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Polynomial( 3, {Save Predicteds} );
Wait( 1 );
obj << Fit Line( 1 );
obj << (curve[2] << Save Predicteds);


```

#### [Save Residuals](#save-residuals_1)

**Syntax:** obj \<< ( Curve[number] \<< Save Residuals ); obj \<< Fit Name( {Save Residuals} )

**Description:** Saves a new column to the original data table. The column contains the residual values for the specified fitted curve.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Save Residuals);
Wait( 1 );
obj << Fit Line( {Save Residuals} );


```

#### [Save Studentized Residuals](#save-studentized-residuals_1)

**Syntax:** obj \<< ( Curve[number] \<< Save Studentized Residuals ); obj \<< Fit Name( {Save Studentized Residuals} )

**Description:** Saves a new column to the original data table. The column contains the Studentized residuals for the specified fitted curve.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Fit Polynomial( 3 ) );
obj << (Curve[1] << Save Studentized Residuals);
Wait( 1 );
obj << Fit Line( {Save Studentized Residuals} );


```

#### [Select Points Inside](#select-points-inside)

**Syntax:** obj \<< ( Curve[number] \<< Select Points Inside ); obj \<< Density Ellipse( {Select Points Inside} )

**Description:** Selects points inside the ellipse.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate(
    Y( :Weight ),
    X( :Height ),
    Density Ellipse( 0.95, {Line Color( {213, 72, 87} )} ),

);
obj << (curve[1] << Select Points Inside);
Wait( 1 );
obj << Density Ellipse( 0.8, {Select Points Inside} );


```

#### [Select Points Outside](#select-points-outside)

**Syntax:** obj \<< ( Curve[number] \<< Select Points Outside ); obj \<< Density Ellipse( {Select Points Outside} )

**Description:** Selects points outside the ellipse.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate(
    Y( :Weight ),
    X( :Height ),
    Density Ellipse( 0.8, {Line Color( {213, 72, 87} )} ),

);
obj << (curve[1] << Select Points Outside);
Wait( 1 );
obj << Density Ellipse( 0.95, {Select Points Outside} );


```

#### [Shaded Contour](#shaded-contour)

**Syntax:** obj \<< ( Curve[number] \<< Shaded Contour( state=0|1 ) ); obj \<< Density Ellipse( {Shaded Contour( state=0|1 )} )

**Description:** Shows or hides the shaded contour.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ), );
obj << Density Ellipse( 0.95, {Shaded Contour( 1 )} );
Wait( 1 );
obj << (Curve[1] << Shaded Contour( 0 ));


```

## [Bivariate](#bivariate)

### [Associated Constructors](#associated-constructors_1)

#### [Bivariate](#bivariate_1)

**Syntax:** Bivariate( Y( columns ), X( columns ) )

**Description:** Models a continuous response with respect to another continuous variable. Analysis methods include fitting lines, polynomials, splines, and bivariate densities.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );


```

### [Columns](#columns)

#### [By](#by)

**Syntax:** obj = Bivariate(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

#### [Freq](#freq)

**Syntax:** obj = Bivariate(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Freq( :_freqcol ) );


```

#### [Regressor](#regressor)

**Syntax:** obj = Bivariate(...Regressor( column(s) )...)

**Description:** Specifies the predictor variables. These variables must have a continuous modeling type.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );


```

#### [Response](#response)

**Syntax:** obj = Bivariate(...Response( column(s) )...)

**Description:** Specifies the continuous response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );


```

#### [Weight](#weight)

**Syntax:** obj = Bivariate(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Bivariate( Y( :Weight ), X( :Height ), Weight( :_weightcol ) );


```

#### [X](#x)

**Syntax:** obj = Bivariate(...X( column(s) )...)

**Description:** Specifies the predictor variables. These variables must have a continuous modeling type.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );


```

#### [Y](#y)

**Syntax:** obj = Bivariate(...Y( column(s) )...)

**Description:** Specifies the continuous response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );


```

### [Item Messages](#item-messages_3)

#### [Curve](#curve_1)

**Syntax:** obj \<< ( Curve[number] \<< option )

**Description:** Array of handles to the fitted lines. This enables you to send Bivariate Curve messages to specific curves that have been fit.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( 1 );
obj << Fit Polynomial( 3 );
obj << (curve[2] << Confid Curves Fit( 1 ));


```

#### [Density Ellipse](#density-ellipse)

**Syntax:** obj \<< Density Ellipse( percent )

**Description:** Fits a bivariate normal contour. The contour contains the specified percent of total data points.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Density Ellipse( 0.95 );


```

#### [Fit Cauchy](#fit-cauchy)

**Syntax:** obj \<< Fit Cauchy

**Description:** Fits a robust regression model where the parameters are estimated by maximum likelihood with a Cauchy link function.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Cauchy;


```

#### [Fit Each Value](#fit-each-value)

**Syntax:** obj \<< Fit Each Value

**Description:** Fits a line that goes through the mean Y value of each set of unique X values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Each Value;


```

#### [Fit Line](#fit-line)

**Syntax:** obj \<< Fit Line

**Description:** Fits a least squares regression model to the data. The fit line is shown on the plot and a fit report is provided.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line;


```

#### [Fit Mean](#fit-mean)

**Syntax:** obj \<< Fit Mean

**Description:** Fits the mean of the Y response variable. A flat line with a slope of zero is shown on the plot.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Mean;


```

#### [Fit Orthogonal](#fit-orthogonal)

**Syntax:** obj \<< Fit Orthogonal( Univariate Variances|Equal Variances|Fit X to Y|Specified Variance Ratio(number) )

**Description:** Fits the specified orthogonal regression model. Orthogonal regression models are useful when both the X and Y variables are measured with error. The Specified Variance Ratio argument enables you to specify the ratio of the variance of the error in the X variable to the error in the Y variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Orthogonal( Fit X to Y );


```

#### [Fit Passing Bablok](#fit-passing-bablok)

**Syntax:** obj \<< Fit Passing Bablok

**Description:** Fits a regression model using the Passing-Bablok procedure. This procedure is useful when both the X and Y variables are measured with error.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Passing Bablok;


```

#### [Fit Polynomial](#fit-polynomial)

**Syntax:** obj \<< Fit Polynomial( degree of model )

**Description:** Fits a polynomial curve of the specified degree using least squares regression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Polynomial( 3 );


```

#### [Fit Robust](#fit-robust)

**Syntax:** obj \<< Fit Robust

**Description:** Fits a regression model using the Huber M-estimation method, which is robust with respect to outliers. The Huber loss function penalizes outliers and increases as a quadratic function for small errors and as a linear function for large errors.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Robust;


```

#### [Fit Special](#fit-special)

**Syntax:** obj \<< Fit Special( xTran( "Log"|"Square Root"|"Square"|"Reciprocal"|"Exponential" ), yTran( "Log"|"Square Root"|"Square"|"Reciprocal"|"Exponential" ), \<Intercept( number )>, \<Slope( number )>, \<Degree( degree )>, Centered Polynomial> )

**Description:** Fits a regression model that contains transformations for the X and Y variables. You can also put constraints on the slope and intercept, as well as fit polynomial models using the degree argument.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Special( xTran( "Log" ) );
obj << Fit Special( xTran( "Square" ), yTran( "Reciprocal" ), Intercept( 0 ) );


```

#### [Fit Spline](#fit-spline)

**Syntax:** obj \<< Fit Spline( lambda, <Standardized> )

**Description:** Fits a penalized least squares model to the data, where the smoothing parameter, lambda, determines the degree of smoothness for the model fit.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Spline( 341.1929, Standardized );
obj << Fit Spline( 341.1929 );


```

#### [Fit Where](#fit-where)

**Syntax:** obj \<< Fit Where( column == level, command )

**Description:** Fits a curve to a single level of a categorical variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :weight ), X( :height ) );
obj << Fit Where( :sex == "F", Fit Line( 1 ) );


```

#### [Group By](#group-by)

**Syntax:** obj \<< Group By( column )

**Description:** Specifies a grouping variable. Once a grouping variable is specified, all analyses are performed separately for each level of the grouping variable.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Bivariate( Y( :LogHist1 ), X( :LogHist0 ) );
obj << Group By( :drug );
obj << Fit Line;


```

#### [Histogram Borders](#histogram-borders)

**Syntax:** obj \<< Histogram Borders( state=0|1 )

**Description:** Shows or hides histograms on the horizontal and vertical axes of the scatterplot.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Histogram Borders( 1 );


```

#### [Kernel Smoother](#kernel-smoother)

**Syntax:** obj \<< Kernel Smoother( lambda = 0|1|2, weight = 1|2|3|4|5, alpha, robust passes = 0|1|2|3|4, delta proportion )

**Description:** Applies a local fit over repeated subsets of the data where the subset range is determined by alpha, the smoothness of the fit by lambda, and the weight by the weight function. Outliers are weighted downward as robustness increases. This method is also known as a LOESS smoother.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
obj = dt << Bivariate( Y( :"Velocity (y)"n ), X( :Concentration ) );
obj << Kernel Smoother( 1, 1, 0.84615, 0 );


```

#### [Nonpar Density](#nonpar-density)

**Syntax:** obj \<< Nonpar Density

**Description:** Fits nonparametric bivariate density contours and draws the corresponding contours on the graph. The contours are in 5% intervals.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Nonpar Density;


```

#### [Paired t test](#paired-t-test)

**Syntax:** obj \<< Paired t test

**Description:** Runs a paired t-test, produces the report, and displays a 45-degree gray line on the scatterplot to represent where the two columns are equal.

This option has been promoted to the Matched Pairs platform. This option is also accessible from the Bivariate menu when you hold down the shift key.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Bivariate( Y( :LogHist1 ), X( :LogHist0 ) );
obj << Paired t test;


```

#### [Points Jittered](#points-jittered)

**Syntax:** obj \<< Points Jittered( "None"|"Auto"|"Random Uniform"|"Random Normal"|"Density Random"|"Packed"|"Grid"|"Hex Grid"|"Beeswarm"="Auto" )

**Description:** Specifies the spread of the data points. When selected, the data points are jittered to avoid overlapping markers. "Auto" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Oneway( Y( :Sepal length ), X( :Sepal width ) );
obj << Points Jittered( "Random Normal" );


```

#### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line( 1 );
Wait( 1 );
obj << Show Points( 0 );


```

#### [Summary Statistics](#summary-statistics)

**Syntax:** obj \<< Summary Statistics( state=0|1 )

**Description:** Shows or hides summary statistics tables.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Summary Statistics( 1 );


```

### [Shared Item Messages](#shared-item-messages)

#### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Copy Script;


```

#### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_3)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    Y( :Weight ),
    X( :Height ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
obj << Title( "My Platform" );


```

#### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view)

**Syntax:** obj = Bivariate(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Contingency > Analysis of Means for Proportions](#contingency-analysis-of-means-for-proportions)

### [Item Messages](#item-messages_4)

#### [Point Options](#point-options)

**Syntax:** obj \<< Analysis of Means for Proportions( 1, Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" ) ); scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the Analysis of Means for Proportions chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = Contingency( Y( :marital status ), X( :type ) );
obj << Analysis of Means for Proportions( 1, Point Options( "Show Only Points" ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Proportions"] << Get Scriptable Object;
scrobj << Point Options( "Show Connected Points" );


```

#### [Set Alpha Level](#set-alpha-level_1)

**Syntax:** obj \<< Analysis of Means for Proportions( 1, Set Alpha Level( alpha ) ); scrobj \<< Set Alpha Level( alpha )

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = Contingency( Y( :marital status ), X( :type ) );
obj << Analysis of Means for Proportions( 1, Set Alpha Level( 0.1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Proportions"] << Get Scriptable Object;
scrobj << Set Alpha Level( 0.05 );


```

#### [Show Center Line](#show-center-line)

**Syntax:** obj \<< Analysis of Means for Proportions( 1, Show Center Line( state=0|1 ) ); scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line for the Analysis of Means in Proportions chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = Contingency( Y( :marital status ), X( :type ) );
obj << Analysis of Means for Proportions( 1, Show Center Line( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Proportions"] << Get Scriptable Object;
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading)

**Syntax:** obj \<< Analysis of Means for Proportions( 1, Show Decision Limit Shading( state=0|1 ) ); scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading in the Analysis of Means for Proportions chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = Contingency( Y( :marital status ), X( :type ) );
obj << Analysis of Means for Proportions( 1, Show Decision Limit Shading( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Proportions"] << Get Scriptable Object;
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits)

**Syntax:** obj \<< Analysis of Means for Proportions( 1, Show Decision Limits( state=0|1 ) ); scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines in the Analysis of Means for Proportions chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = Contingency( Y( :marital status ), X( :type ) );
obj << Analysis of Means for Proportions( 1, Show Decision Limits( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Proportions"] << Get Scriptable Object;
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report)

**Syntax:** obj \<< Analysis of Means for Proportions( 1, Show Summary Report( state=0|1 ) ); scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the response proportions and decision limits for each level of the X variable. The report also indicates whether a limit has been exceeded.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = Contingency( Y( :marital status ), X( :type ) );
obj << Analysis of Means for Proportions( 1, Show Summary Report( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Proportions"] << Get Scriptable Object;
scrobj << Show Summary Report( 0 );


```

#### [Switch Response Level for Proportion](#switch-response-level-for-proportion)

**Syntax:** obj \<< Analysis of Means for Proportions( 1, Switch Response Level for Proportion( state=0|1 ) ); scrobj \<< Switch Response Level for Proportion( state=0|1 )

**Description:** Changes the response category that is used in the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = Contingency( Y( :marital status ), X( :type ) );
obj << Analysis of Means for Proportions( 1, Switch Response Level for Proportion( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Proportions"] << Get Scriptable Object;
scrobj << Switch Response Level for Proportion( 0 );


```

## [Contingency > Contingency Equivalence Tests](#contingency-contingency-equivalence-tests)

### [Item Messages](#item-messages_5)

#### [Forest Plot](#forest-plot)

**Syntax:** obj \<< Equivalence Tests( ..., Forest Plot( state=0|1 ) ); scobj \<< Forest Plot( state=0|1 )

**Description:** Shows or hides the Equivalence Tests Forest Plot. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Contingency Table( Count( 1 ), Total %( 0 ), Col %( 0 ), Row %( 1 ) ),
    Equivalence Tests of Risk Difference(
        0.1,
        0.05,
        "Equivalence",
        Response Group( "Cancer" ),
        Factor Group( "NonSmoker" )
    )
);
Wait( 2 );
scobj = (Report( obj )["Equivalence Tests for the Risk Difference"] << Get Scriptable Object);
scobj << Forest Plot( 0 );


```

#### [Remove](#remove)

**Syntax:** scobj \<< Remove

**Description:** Removes the Equivalence Tests report.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Contingency Table( Count( 1 ), Total %( 0 ), Col %( 0 ), Row %( 1 ) ),
    Equivalence Tests of Risk Difference(
        0.1,
        0.05,
        "Equivalence",
        Response Group( "Cancer" ),
        Factor Group( "NonSmoker" )
    )
);
Wait( 1 );
scobj = (Report( obj )["Equivalence Tests for the Risk Difference"] << Get Scriptable Object);
Wait( 1 );
scobj << Remove;


```

#### [Test Report](#test-report)

**Syntax:** obj \<< Equivalence Tests( ..., Test Report( state=0|1 ) ); scobj \<< Test Report( state=0|1 )

**Description:** Shows or hides a report that summarizes the equivalence tests, superiority tests, or noninferiority tests for risk differences or risk ratios. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Contingency Table( Count( 1 ), Total %( 0 ), Col %( 0 ), Row %( 1 ) ),
    Equivalence Tests of Risk Difference(
        0.1,
        0.05,
        "Equivalence",
        Response Group( "Cancer" ),
        Factor Group( "NonSmoker" )
    )
);
Wait( 2 );
scobj = (Report( obj )["Equivalence Tests for the Risk Difference"] << Get Scriptable Object);
scobj << Test Report( 0 );


```

## [Contingency > Contingency Table](#contingency-contingency-table)

### [Item Messages](#item-messages_6)

#### [Cell Chi Square](#cell-chi-square)

**Syntax:** obj \<< Contingency Table( Cell Chi Square( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the individual cell contribution to the chi-square statistic in the contingency table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Contingency Table( Cell Chi Square( 1 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Cell Chi Square( 1, Format( "Fixed Dec", 8, 5 ) ) );


```

#### [Col %](#col)

**Syntax:** obj \<< Contingency Table( Col %( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides each cells' percentage contribution to the column in the contingency table. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Col %( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Col %( 1, Format( "Fixed Dec", 7, 1 ) ) );


```

#### [Col Cum](#col-cum)

**Syntax:** obj \<< Contingency Table( Col Cum( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the cumulative column total in the contingency table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Contingency Table( Total %( 0 ), Col %( 0 ), Row %( 0 ), Col Cum( 1 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table(
    Total %( 0 ),
    Col %( 0 ),
    Row %( 0 ),
    Col Cum( 1, Format( "Fixed Dec", 7, 1 ) )
);


```

#### [Col Cum %](#col-cum_1)

**Syntax:** obj \<< Contingency Table( Col Cum %( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the cumulative column percentage in the contingency table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Contingency Table( Total %( 0 ), Col %( 0 ), Row %( 0 ), Col Cum %( 1 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table(
    Total %( 0 ),
    Col %( 0 ),
    Row %( 0 ),
    Col Cum %( 1, Format( "Fixed Dec", 7, 1 ) )
);


```

#### [Count](#count)

**Syntax:** obj \<< Contingency Table( Count( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the cell count in the contingency table. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Count( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Count( 1, Format( "Fixed Dec", 7, 1 ) ) );


```

#### [Deviation](#deviation)

**Syntax:** obj \<< Contingency Table( Deviation( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the individual cell deviation in the contingency table. The individual cell deviation is the actual cell count minus the expected cell count.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Contingency Table( Deviation( 1 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Deviation( 1, Format( "Fixed Dec", 7, 1 ) ) );


```

#### [Expected](#expected)

**Syntax:** obj \<< Contingency Table( Expected( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the expected cell count in the contingency table. The expected cell count is the product of the corresponding row total and column total divided by the grand total.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Contingency Table( Expected( 1 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Expected( 1, Format( "Fixed Dec", 7, 1 ) ) );


```

#### [Make Into Data Table](#make-into-data-table)

**Syntax:** obj \<< Contingency Table( Make Into Data Table )

**Description:** Creates a data table that contains the crosstabs data.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Contingency( Y( :Age ), X( :sex ), Contingency Table( Make into Data Table ) );


```

#### [Row %](#row)

**Syntax:** obj \<< Contingency Table( Row %( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides each cells' percentage contribution to the row in the contingency table. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Row %( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Row %( 1, Format( "Fixed Dec", 7, 1 ) ) );


```

#### [Row Cum](#row-cum)

**Syntax:** obj \<< Contingency Table( Row Cum( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the cumulative row total in the contingency table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Contingency Table( Total %( 0 ), Col %( 0 ), Row %( 0 ), Row Cum( 1 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table(
    Total %( 0 ),
    Col %( 0 ),
    Row %( 0 ),
    Row Cum( 1, Format( "Fixed Dec", 7, 1 ) )
);


```

#### [Row Cum %](#row-cum_1)

**Syntax:** obj \<< Contingency Table( Row Cum %( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the cumulative row percentage in the contingency table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Contingency Table( Total %( 0 ), Col %( 0 ), Row %( 0 ), Row Cum %( 1 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table(
    Total %( 0 ),
    Col %( 0 ),
    Row %( 0 ),
    Row Cum %( 1, Format( "Fixed Dec", 7, 1 ) )
);


```

#### [Total %](#total)

**Syntax:** obj \<< Contingency Table( Total %( state=0|1, \<Format(...)> ) )

**Description:** Shows or hides the cell total percentage in the contingency table. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Total %( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( Total %( 1, Format( "Fixed Dec", 7, 1 ) ) );


```

## [Contingency > Correspondence Analysis](#contingency-correspondence-analysis)

### [Item Messages](#item-messages_7)

#### [3D Correspondence Analysis](#3d-correspondence-analysis)

**Syntax:** obj \<< Correspondence Analysis( "3D Correspondence Analysis"( state=0|1 ) )

**Description:** Shows or hides a three-dimensional scatterplot.

```

dt = Open( "$SAMPLE_DATA/Cars 1993.jmp" );
obj = Contingency(
    Y( :Vehicle Category ),
    X( :Manufacturer ),
    Contingency Table( 0 ),
    Tests( 0 )
);
Wait( 1 );
obj << Correspondence Analysis( "3D Correspondence Analysis"(1) );


```

#### [Make Table](#make-table)

**Syntax:** obj \<< Correspondence Analysis( "Make Table" )

**Description:** Creates a data table that contains the correspondence analysis output.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
obj = Contingency( Y( :Fiber Gr ), X( :Manufacturer ) );
obj << Correspondence Analysis( "Make Table" );


```

#### [Save Value Order](#save-value-order)

**Syntax:** obj \<< Correspondence Analysis( "Save Value Order" )

**Description:** Saves a Value Ordering column property to both the X and Y variable columns in the data table. The column property specifies the order of the levels sorted by the first correspondence score coefficient.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
obj = Contingency( Y( :Fiber Gr ), X( :Manufacturer ) );
obj << Correspondence Analysis( "Save Value Order" );


```

## [Contingency](#contingency)

### [Associated Constructors](#associated-constructors_2)

#### [Contingency](#contingency_1)

**Syntax:** Contingency( Y( columns ), X( columns ) )

**Description:** Models a categorical response across a set of categorical groups. Analysis methods include chi-square tests and mosaic plots.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );


```

### [Columns](#columns_1)

#### [Block](#block)

**Syntax:** obj = Contingency(...\<Block( column )>...)

**Description:** Specifies a blocking variable. This identifies a second factor and performs a Cochran-Mantel-Haenszel test.

```

dt = Open( "$SAMPLE_DATA/Car Poll.JMP" );
obj = dt << Contingency( Y( :marital status ), X( :type ), Block( :sex ) );


```

#### [By](#by_1)

**Syntax:** obj = Contingency(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

#### [Freq](#freq_1)

**Syntax:** obj = Contingency(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Contingency( Y( :Age ), X( :sex ), Freq( :_freqcol ) );


```

#### [Grouping Category](#grouping-category)

**Syntax:** obj = Contingency(...Grouping Category( column(s) )...)

**Description:** Specifies the predictor variables. These variables must have an ordinal or nominal modeling type.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );


```

#### [Response Category](#response-category)

**Syntax:** obj = Contingency(...Response Category( column(s) )...)

**Description:** Specifies the categorical response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );


```

#### [Weight](#weight_1)

**Syntax:** obj = Contingency(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Contingency( Y( :Age ), X( :sex ), Weight( :_weightcol ) );


```

#### [X](#x_1)

**Syntax:** obj = Contingency(...X( column(s) )...)

**Description:** Specifies the predictor variables. These variables must have an ordinal or nominal modeling type.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );


```

#### [Y](#y_1)

**Syntax:** obj = Contingency(...Y( column(s) )...)

**Description:** Specifies the categorical response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );


```

### [Item Messages](#item-messages_8)

#### [Agreement Statistic](#agreement-statistic)

**Syntax:** obj \<< Agreement Statistic( state=0|1 )

**Description:** Shows or hides a report that contains statistics that measure the agreement between levels. The report includes the Kappa statistic, as well as the standard error, confidence interval, and hypothesis test for the statistic. The report also includes Bowker's test of symmetry, which is also known as McNemar's test. This option is available only when the X and Y variables have the same levels.

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Contingency(
    Y( :Second Survey ),
    X( :First Survey ),
    Freq( :Count ),
    Tests( 0 ),
    Agreement Statistic( 1 )
);


```

#### [Analysis of Means for Proportions](#analysis-of-means-for-proportions)

**Syntax:** obj \<< Analysis of Means for Proportions( state=0|1, <chart options> )

**Description:** Shows or hides an analysis of means for proportions (ANOMP) decision chart to compare group proportions. ANOMP is a multiple comparison procedure, which compares the response proportions for the levels of the X variable to the overall response proportion. This option is available only when the Y variable has exactly two levels.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency(
    Y( :marital status ),
    X( :type ),
    Analysis of Means for Proportions( 1 )
);


```

#### [Cochran Armitage Trend Test](#cochran-armitage-trend-test)

**Syntax:** obj \<< Cochran Armitage Trend Test( state=0|1 )

**Description:** Shows or hides a test for trends in binomial proportions across levels of a single variable. This option is available only when one variable has exactly two levels and the other variable is ordinal.

```

dt = Open( "$SAMPLE_DATA/Car Poll.JMP" );
obj = dt << Contingency( Y( :size ), X( :sex ), Mosaic Plot( 0 ) );
obj << Cochran Armitage Trend Test( 1 );


```

#### [Cochran Mantel Haenszel](#cochran-mantel-haenszel)

**Syntax:** obj \<< Cochran Mantel Haenszel( column ); obj \<< Cochran Mantel Haenszel( state=0|1 )

**Description:** Shows or hides a test that determines whether there is a relationship between two categorical variables after blocking across a third classification variable.

```

dt = Open( "$SAMPLE_DATA/Car Poll.JMP" );
obj = dt << Contingency( Y( :type ), X( :marital status ) );
obj << Cochran Mantel Haenszel( :country );
Wait( 2 );
obj << Cochran Mantel Haenszel( 0 );


```

#### [Contingency Table](#contingency-table)

**Syntax:** obj \<< Contingency Table( state=0|1 )

**Description:** Shows or hides a two-way frequency table. The table contains a row for each level of the X variable and a column for each level of the Y variable. On by default.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Contingency Table( 0 );


```

#### [Correspondence Analysis](#correspondence-analysis)

**Syntax:** obj \<< Correspondence Analysis( state=0|1 ); obj \<< Correspondence Analysis( correspondence chart options )

**Description:** Shows or hides a correspondence analysis, which identifies rows or columns of a frequency table that have similar patterns of counts. In the correspondence analysis plot, there is a point for each row and for each column of the contingency table.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
obj = dt << Contingency( Y( :Fiber Gr ), X( :Manufacturer ) );
obj << Correspondence Analysis( 1 );


```

#### [Equivalence Tests of Relative Risk](#equivalence-tests-of-relative-risk)

**Syntax:** obj \<< Equivalence Tests of Relative Risk( ratio, \<alpha=.05>, <test type>, \<Response Group( level )>, \<Factor Group( level )> )

**Description:** Tests that the relative risks do not differ by more than a ratio determined to be practically equivalent. This is the reverse of the usual significance test. Alpha, test type, and the group levels are optional arguments. The test type argument is "Equivalence" by default, but it can also be used to specify superiority or noninferiority tests.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Contingency Table( Count( 1 ), Total %( 0 ), Col %( 0 ), Row %( 1 ) ),
    Equivalence Tests of Relative Risk(
        0.8,
        0.05,
        "Equivalence",
        Response Group( "Cancer" ),
        Factor Group( "NonSmoker" )
    )
);


```

#### [Equivalence Tests of Risk Difference](#equivalence-tests-of-risk-difference)

**Syntax:** obj \<< Equivalence Tests of Risk Difference( difference, \<alpha=.05>, <test type>, \<Response Group( level )>, \<Factor Group( level )> )

**Description:** Tests that the risk differences do not differ by more than an amount (difference) determined to be practically equivalent. This is the reverse of the usual significance test. Alpha, test type, and the group levels are optional arguments. The test type argument is "Equivalence" by default, but it can also be used to specify superiority or noninferiority tests.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Contingency Table( Count( 1 ), Total %( 0 ), Col %( 0 ), Row %( 1 ) ),
    Equivalence Tests of Risk Difference(
        0.1,
        0.05,
        "Equivalence",
        Response Group( "Cancer" ),
        Factor Group( "NonSmoker" )
    )
);


```

#### [Exact Agreement Statistic](#exact-agreement-statistic)

**Syntax:** obj \<< Exact Agreement Statistic( state=0|1 )

**Description:** Shows or hides the exact version of the agreement statistic Kappa.

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Contingency(
    Y( :Second Survey ),
    X( :First Survey ),
    Freq( :Count ),
    Tests( 0 )
);
obj << Exact Agreement Statistic( 1 );


```

#### [Exact Cochran Armitage Trend Test](#exact-cochran-armitage-trend-test)

**Syntax:** obj \<< Exact Cochran Armitage Trend Test( state=0|1 )

**Description:** Shows or hides the exact version of the Cochran-Armitage trend test.

```

dt = Open( "$SAMPLE_DATA/Prime Minister Ratings.jmp" );
obj = dt << Contingency(
    Y( :Second Survey ),
    X( :First Survey ),
    Freq( :Count ),
    Tests( 0 )
);
obj << Exact Cochran Armitage Trend Test( 1 );


```

#### [Fisher's Exact Test](#fishers-exact-test)

**Syntax:** obj \<< Fisher's Exact Test( state=0|1 )

**Description:** Shows or hides Fisher's exact test for testing the association between two categorical variables. This test does not depend on any large-sample distributional assumptions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Fisher's Exact Test( 1 );


```

#### [Horizontal Mosaic](#horizontal-mosaic)

**Syntax:** obj \<< Horizontal Mosaic( state=0|1 )

**Description:** Rotates the mosaic plot horizontally (1) or vertically (0).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
Wait( 2 );
obj << Horizontal Mosaic( 1 );


```

#### [Jonckheere Terpstra Test](#jonckheere-terpstra-test)

**Syntax:** obj \<< Jonckheere Terpstra Test( state=0|1 )

**Description:** Shows or hides a report of the Jonckheere-Terpstra test, which is a nonparametric test for ordered differences among classes. It tests the null hypothesis that the distribution of the response variable does not differ among classes.

```

dt = Open( "$SAMPLE_DATA/Big Class.JMP" );
:height << Nominal( 1 );
obj = dt << Contingency(
    Y( :height ),
    X( :age ),
    Contingency Table(
        Count( 1 ),
        Total %( 0 ),
        Col %( 0 ),
        Row %( 0 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 ),
        Col Cum( 0 ),
        Col Cum %( 0 ),
        Row Cum( 0 ),
        Row Cum %( 0 )
    )
);
obj << Jonckheere Terpstra Test( 1 );


```

#### [Measures of Association](#measures-of-association)

**Syntax:** obj \<< Measures of Association( state=0|1 )

**Description:** Shows or hides a report that contains measures of the association between the variables in the contingency table.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Measures of Association( 1 )
);


```

#### [Mosaic Plot](#mosaic-plot)

**Syntax:** obj \<< Mosaic Plot( state=0|1 )

**Description:** Shows or hides a graphical representation of the contingency table. On by default.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Mosaic Plot( 0 );


```

#### [Odds Ratio](#odds-ratio)

**Syntax:** obj \<< Odds Ratio( state=0|1 )

**Description:** Shows or hides a report of the odds ratio. This option is available only when the X and Y variables each have exactly two levels.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ), Odds Ratio( 1 ) );


```

#### [Relative Risk](#relative-risk)

**Syntax:** obj \<< Relative Risk( state=0|1, \<Y variable level, X variable level> ); obj \<< Relative Risk( state=0|1, \<"All"> )

**Description:** Shows or hides the relative risk between the levels of the response. This option is available only when the X and Y variables each have exactly two levels.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Contingency Table( 0 )
);
obj << Relative Risk( 1, "Cancer", "Smoker" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Contingency Table( 0 )
);
obj << Relative Risk( 1, "All" );


```

#### [Set Alpha Level](#set-alpha-level_2)

**Syntax:** obj \<< Set Alpha Level( alpha=0.05 )

**Description:** Changes the alpha level used to compute the decision limits. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Set Alpha Level( 0.1 );
obj << Measures of Association( 1 );


```

#### [Set α Level](#set-level_1)

**Syntax:** obj \<< Set α Level( alpha=0.05 )

**Description:** Changes the alpha level used to compute the decision limits. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
obj << Set Alpha Level( 0.1 );
obj << Measures of Association( 1 );


```

#### [Tests](#tests)

**Syntax:** obj \<< Tests( state=0|1 )

**Description:** Shows or hides tests that measure if the response level rates are the same across the levels of the X variable. These tests are analogous to the Analysis of Variance table for continuous data. On by default.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency( Y( :Lung Cancer ), X( :Smoker ), Freq( :Count ) );
Wait( 2 );
obj << Tests( 0 );


```

#### [Two Sample Test for Proportions](#two-sample-test-for-proportions)

**Syntax:** obj \<< Two Sample Test for Proportions( state=0|1 )

**Description:** Show or hides a two-sample test for proportions. This test compares the proportions of the Y variable between the two levels of the X variable. This option is available only when the X and Y variables each have exactly two levels.

```

dt = Open( "$SAMPLE_DATA/Lung Cancer.jmp" );
obj = dt << Contingency(
    Y( :Lung Cancer ),
    X( :Smoker ),
    Freq( :Count ),
    Two Sample Test for Proportions( 1 )
);


```

### [Shared Item Messages](#shared-item-messages_1)

#### [Action](#action_1)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_1)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_1)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_1)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_1)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_1)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_1)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_1)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_1)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_1)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_1)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_1)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_1)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_1)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_1)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_1)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_1)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_1)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_1)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_1)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_1)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_1)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_1)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_1)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_1)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_1)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_4)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_1)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_1)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_1)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_1)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_1)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_1)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Contingency(
    Y( :Age ),
    X( :sex ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_1)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_1)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_1)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_1)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_1)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_1)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_1)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_1)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_1)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_1)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Contingency( Y( :Age ), X( :sex ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_1)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_1)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_1)

**Syntax:** obj = Contingency(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Logistic](#logistic)

### [Associated Constructors](#associated-constructors_3)

#### [Logistic](#logistic_1)

**Syntax:** Logistic( Y( columns ), X( columns ) )

**Description:** Models a categorical response with respect to a continuous variable. Analysis methods include logistic regression and ROC curves.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );


```

### [Columns](#columns_2)

#### [By](#by_2)

**Syntax:** obj = Logistic(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

#### [Categorical Response](#categorical-response)

**Syntax:** obj = Logistic(...Categorical Response( column(s) )...)

**Description:** Specifies the categorical response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );


```

#### [Continuous Regressor](#continuous-regressor)

**Syntax:** obj = Logistic(...Continuous Regressor( column(s) )...)

**Description:** Specifies the predictor variables. These variables must have a continuous modeling type.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );


```

#### [Freq](#freq_2)

**Syntax:** obj = Logistic(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );


```

#### [Weight](#weight_2)

**Syntax:** obj = Logistic(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    Weight( :_weightcol )
);


```

#### [X](#x_2)

**Syntax:** obj = Logistic(...X( column(s) )...)

**Description:** Specifies the predictor variables. These variables must have a continuous modeling type.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );


```

#### [Y](#y_2)

**Syntax:** obj = Logistic(...Y( column(s) )...)

**Description:** Specifies the categorical response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );


```

### [Item Messages](#item-messages_9)

#### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< Confidence Intervals( \<state=0|1> | <fraction> )

**Description:** Displays or hides confidence intervals in the parameter estimates table to the right of each effect.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Freq( :Count ), Y( :Response ), X( :"ln(dose)"n ) );
obj << Confidence Intervals( 0.01 );


```

#### [Inverse Prediction](#inverse-prediction)

**Syntax:** obj \<< Inverse Prediction( Response( prob1, prob2, ... ), \<Confidence Level( percent=0.95 )>, \<Two sided|Lower One Sided|Upper One Sided> )

**Description:** Enables you to predict values of the predictor variable for one or more values of the response variable. By default, two-sided 95% confidence limits are computed for each inverse prediction.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Inverse Prediction( Response( 0.5, 0.9 ) );


```

#### [Lift Curve](#lift-curve)

**Syntax:** obj \<< Lift Curve( state=0|1 )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Lift Curve( 1 );


```

#### [Line Color](#line-color_2)

**Syntax:** obj \<< Line Color( color )

**Description:** Enables you to select the color of the plot curves.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Line Color( "Magenta" );


```

#### [Logistic Plot](#logistic-plot)

**Syntax:** obj \<< Logistic Plot( state=0|1 )

**Description:** Shows or hides the logistic plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Logistic Plot( 0 );


```

#### [Odds Ratios](#odds-ratios)

**Syntax:** obj \<< Odds Ratios( state=0|1 )

**Description:** Adds or removes columns that contain odds ratios to the Parameter Estimates report.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Odds Ratios( 1 );


```

#### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    Target Level( "Cured" )
);
Wait( 1 );
obj << Precision Recall Curve( 1 );


```

#### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity).

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    Target Level( "Cured" )
);
Wait( 1 );
obj << ROC Curve( 1 );


```

#### [Save Probability Formula](#save-probability-formula)

**Syntax:** obj \<< Save Probability Formula

**Description:** Saves new columns to the data table. The new columns contain the formula for the probability that is predicted by the model.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Save Probability Formula;


```

#### [Show Points](#show-points_1)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the points in the logistic plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Show Points( 0 );


```

#### [Show Rate Curve](#show-rate-curve)

**Syntax:** obj \<< Show Rate Curve( state=0|1 )

**Description:** Shows or hides the rate curve in the logistic plot. The rate curve is useful only if you have several points for each value of the X variable.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
Wait( 1 );
obj << Show Rate Curve( 1 );


```

#### [Target Level](#target-level)

**Syntax:** obj = Logistic(...Target Level( level )...)

**Description:** Specifies the level of the response whose probability you want to model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    Target Level( "Cured" )
);
obj << ROC Curve( 1 );


```

### [Shared Item Messages](#shared-item-messages_2)

#### [Action](#action_2)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_2)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_2)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_2)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_2)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_2)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_2)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_2)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_2)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_2)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_2)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_2)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_2)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_2)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_2)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_2)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_2)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_2)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_2)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_2)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_2)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_2)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_2)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_2)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_2)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_2)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_5)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_2)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_2)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_2)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_2)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_2)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_2)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Logistic(
    Y( :Response ),
    X( :"ln(dose)"n ),
    Freq( :Count ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_2)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_2)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_2)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_2)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_2)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_2)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_2)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_2)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_2)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_2)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Penicillin.jmp" );
obj = dt << Logistic( Y( :Response ), X( :"ln(dose)"n ), Freq( :Count ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_2)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_2)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_2)

**Syntax:** obj = Logistic(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Oneway > ANOM for Ranges](#oneway-anom-for-ranges)

### [Item Messages](#item-messages_10)

#### [Point Options](#point-options_1)

**Syntax:** obj \<< ANOM for Ranges( 1, Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" ) ); scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Michelson.jmp" );
obj = dt << Oneway( Y( :Velocity ), X( :Trial# ) );
obj << ANOM for Ranges( 1, Point Options( "Show Connected Points" ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Ranges"] << Get Scriptable Object;
scrobj << Point Options( "Show Only Points" );


```

#### [Set Alpha Level](#set-alpha-level_3)

**Syntax:** obj \<< ANOM for Ranges( 1, Set Alpha Level( alpha ) ); scrobj \<< Set Alpha Level( alpha )

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Michelson.jmp" );
obj = dt << Oneway( Y( :Velocity ), X( :Trial# ) );
obj << ANOM for Ranges( 1, Set Alpha Level( 0.1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Ranges"] << Get Scriptable Object;
scrobj << Set Alpha Level( 0.05 );


```

#### [Show Center Line](#show-center-line_1)

**Syntax:** obj \<< ANOM for Ranges( 1, Show Center Line( state=0|1 ) ); scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line (overall average range). On by default.

```

dt = Open( "$SAMPLE_DATA/Michelson.jmp" );
obj = dt << Oneway( Y( :Velocity ), X( :Trial# ) );
obj << ANOM for Ranges( 1, Show Center Line( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Ranges"] << Get Scriptable Object;
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading_1)

**Syntax:** obj \<< ANOM for Ranges( 1, Show Decision Limit Shading( state=0|1 ) ); scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading for the Analysis of Means for Ranges chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Michelson.jmp" );
obj = dt << Oneway( Y( :Velocity ), X( :Trial# ) );
obj << ANOM for Ranges( 1, Show Decision Limit Shading( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Ranges"] << Get Scriptable Object;
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits_1)

**Syntax:** obj \<< ANOM for Ranges( 1, Show Decision Limits( state=0|1 ) ); scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines for the Analysis of Means for Ranges chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Michelson.jmp" );
obj = dt << Oneway( Y( :Velocity ), X( :Trial# ) );
obj << ANOM for Ranges( 1, Show Decision Limits( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Ranges"] << Get Scriptable Object;
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report_1)

**Syntax:** obj \<< ANOM for Ranges( 1, Show Summary Report( state=0|1 ) ); scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the group ranges and corresponding decision limits.

```

dt = Open( "$SAMPLE_DATA/Michelson.jmp" );
obj = dt << Oneway( Y( :Velocity ), X( :Trial# ) );
obj << ANOM for Ranges( 1, Show Summary Report( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Ranges"] << Get Scriptable Object;
scrobj << Show Summary Report( 0 );


```

## [Oneway > ANOM for Variances with Levene(ADM)](#oneway-anom-for-variances-with-leveneadm)

### [Item Messages](#item-messages_11)

#### [Point Options](#point-options_2)

**Syntax:** obj \<< "ANOM for Variances with Levene(ADM)"n( 1, Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" ) ); scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << "ANOM for Variances with Levene(ADM)"n( 1, Point Options( "Show Only Points" ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances-Levene(ADM)"] <<
Get Scriptable Object;
scrobj << Point Options( "Show Connected Points" );


```

#### [Set Alpha Level](#set-alpha-level_4)

**Syntax:** obj \<< "ANOM for Variances with Levene(ADM)"n( 1, Set Alpha Level( alpha ) ); scrobj \<< Set Alpha Level( alpha )

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << "ANOM for Variances with Levene(ADM)"n( 1, Set Alpha Level( 0.1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances-Levene(ADM)"] <<
Get Scriptable Object;
scrobj << Set Alpha Level( 0.05 );


```

#### [Show Center Line](#show-center-line_2)

**Syntax:** obj \<< "ANOM for Variances with Levene(ADM)"n( 1, Show Center Line( state=0|1 ) ); scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line (overall mean ADM). On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << "ANOM for Variances with Levene(ADM)"n( 1, Show Center Line( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances-Levene(ADM)"] <<
Get Scriptable Object;
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading_2)

**Syntax:** obj \<< "ANOM for Variances with Levene(ADM)"n( 1, Show Decision Limit Shading( state=0|1 ) ); scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading for the ANOMV-Levene (ADM) chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << "ANOM for Variances with Levene(ADM)"n( 1, Show Decision Limit Shading( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances-Levene(ADM)"] <<
Get Scriptable Object;
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits_2)

**Syntax:** obj \<< "ANOM for Variances with Levene(ADM)"n( 1, Show Decision Limits( state=0|1 ) ); scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines for the ANOMV-Levene (ADM) chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << "ANOM for Variances with Levene(ADM)"n( 1, Show Decision Limits( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances-Levene(ADM)"] <<
Get Scriptable Object;
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report_2)

**Syntax:** obj \<< "ANOM for Variances with Levene(ADM)"n( 1, Show Summary Report( state=0|1 ) ); scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the group mean ADMs and the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << "ANOM for Variances with Levene(ADM)"n( 1, Show Summary Report( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances-Levene(ADM)"] <<
Get Scriptable Object;
scrobj << Show Summary Report( 0 );


```

## [Oneway > ANOM for Variances](#oneway-anom-for-variances)

### [Item Messages](#item-messages_12)

#### [Graph in Variance Scale](#graph-in-variance-scale)

**Syntax:** obj \<< ANOM for Variances( 1, Graph in Variance Scale( state=0|1 ) ); scrobj \<< Graph in Variance Scale( state=0|1 )

**Description:** Specifies the scale of the vertical axis. You can choose between standard deviations and variances.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1, Graph in Variance Scale( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances"] << Get Scriptable Object;
scrobj << Graph in Variance Scale( 0 );


```

#### [Point Options](#point-options_3)

**Syntax:** obj \<< ANOM for Variances( 1, Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" ) ); scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1, Point Options( "Show Only Points" ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances"] << Get Scriptable Object;
scrobj << Point Options( "Show Connected Points" );


```

#### [Set Alpha Level](#set-alpha-level_5)

**Syntax:** obj \<< ANOM for Variances( 1, Set Alpha Level( alpha ) ); scrobj \<< Set Alpha Level( alpha )

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1, Set Alpha Level( 0.1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances"] << Get Scriptable Object;
scrobj << Set Alpha Level( 0.05 );


```

#### [Show Center Line](#show-center-line_3)

**Syntax:** obj \<< ANOM for Variances( 1, Show Center Line( state=0|1 ) ); scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line (RMSE or MSE depending on Y-scale). On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1, Show Center Line( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances"] << Get Scriptable Object;
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading_3)

**Syntax:** obj \<< ANOM for Variances( 1, Show Decision Limit Shading( state=0|1 ) ); scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading for the ANOMV chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1, Show Decision Limit Shading( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances"] << Get Scriptable Object;
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits_3)

**Syntax:** obj \<< ANOM for Variances( 1, Show Decision Limits( state=0|1 ) ); scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines for the ANOMV chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1, Show Decision Limits( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances"] << Get Scriptable Object;
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report_3)

**Syntax:** obj \<< ANOM for Variances( 1, Show Summary Report( state=0|1 ) ); scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the group standard deviations (or variances) and the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1, Show Summary Report( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means for Variances"] << Get Scriptable Object;
scrobj << Show Summary Report( 0 );


```

## [Oneway > ANOM with Transformed Ranks](#oneway-anom-with-transformed-ranks)

### [Item Messages](#item-messages_13)

#### [Point Options](#point-options_4)

**Syntax:** obj \<< ANOM with Transformed Ranks( 1, Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" ) ); scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM with Transformed Ranks( 1, Point Options( "Show Only Points" ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means-Transformed Ranks"] << Get Scriptable Object;
scrobj << Point Options( "Show Connected Points" );


```

#### [Set Alpha Level](#set-alpha-level_6)

**Syntax:** obj \<< ANOM with Transformed Ranks( 1, Set Alpha Level( alpha ) ); scrobj \<< Set Alpha Level( alpha )

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM with Transformed Ranks( 1, Set Alpha Level( 0.1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means-Transformed Ranks"] << Get Scriptable Object;
scrobj << Set Alpha Level( 0.05 );


```

#### [Show Center Line](#show-center-line_4)

**Syntax:** obj \<< ANOM with Transformed Ranks( 1, Show Center Line( state=0|1 ) ); scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line (overall mean). On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM with Transformed Ranks( 1, Show Center Line( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means-Transformed Ranks"] << Get Scriptable Object;
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading_4)

**Syntax:** obj \<< ANOM with Transformed Ranks( 1, Show Decision Limit Shading( state=0|1 ) ); scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading for the ANOM-TR chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM with Transformed Ranks( 1, Show Decision Limit Shading( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means-Transformed Ranks"] << Get Scriptable Object;
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits_4)

**Syntax:** obj \<< ANOM with Transformed Ranks( 1, Show Decision Limits( state=0|1 ) ); scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines for the ANOM-TR chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM with Transformed Ranks( 1, Show Decision Limits( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means-Transformed Ranks"] << Get Scriptable Object;
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report_4)

**Syntax:** obj \<< ANOM with Transformed Ranks( 1, Show Summary Report( state=0|1 ) ); scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the group mean transformed ranks and the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM with Transformed Ranks( 1, Show Summary Report( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means-Transformed Ranks"] << Get Scriptable Object;
scrobj << Show Summary Report( 0 );


```

## [Oneway > ANOM](#oneway-anom)

### [Item Messages](#item-messages_14)

#### [Point Options](#point-options_5)

**Syntax:** obj \<< ANOM( 1, Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" ) ); scrobj \<< Point Options( "Show Needles"|"Show Connected Points"|"Show Only Points" )

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Point Options( "Show Only Points" ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Point Options( "Show Connected Points" );


```

#### [Set Alpha Level](#set-alpha-level_7)

**Syntax:** obj \<< ANOM( 1, Set Alpha Level( alpha ) ); scrobj \<< Set Alpha Level( alpha )

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Set Alpha Level( 0.1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Set Alpha Level( 0.05 );


```

#### [Show Center Line](#show-center-line_5)

**Syntax:** obj \<< ANOM( 1, Show Center Line( state=0|1 ) ); scrobj \<< Show Center Line( state=0|1 )

**Description:** Shows or hides the center line (overall mean) on the ANOM chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Center Line( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Center Line( 1 );


```

#### [Show Decision Limit Shading](#show-decision-limit-shading_5)

**Syntax:** obj \<< ANOM( 1, Show Decision Limit Shading( state=0|1 ) ); scrobj \<< Show Decision Limit Shading( state=0|1 )

**Description:** Shows or hides the decision limit shading for the ANOM chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Decision Limit Shading( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Decision Limit Shading( 1 );


```

#### [Show Decision Limits](#show-decision-limits_5)

**Syntax:** obj \<< ANOM( 1, Show Decision Limits( state=0|1 ) ); scrobj \<< Show Decision Limits( state=0|1 )

**Description:** Shows or hides the decision limit lines for the ANOM chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Decision Limits( 0 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Decision Limits( 1 );


```

#### [Show Summary Report](#show-summary-report_5)

**Syntax:** obj \<< ANOM( 1, Show Summary Report( state=0|1 ) ); scrobj \<< Show Summary Report( state=0|1 )

**Description:** Shows or hides a report that contains the group means and the decision limits.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1, Show Summary Report( 1 ) );
Wait( 2 );
scrobj = Report( obj )["Analysis of Means"] << Get Scriptable Object;
scrobj << Show Summary Report( 0 );


```

## [Oneway > Oneway Equivalence Tests](#oneway-oneway-equivalence-tests)

### [Item Messages](#item-messages_15)

#### [Forest Plot](#forest-plot_1)

**Syntax:** obj \<< Equivalence Tests( ..., Forest Plot( state=0|1 ) ); scobj \<< Forest Plot( state=0|1 )

**Description:** Shows or hides the Equivalence Tests Forest Plot. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Equivalence Tests( 4, 0.05, "Pooled Variance", "Equivalence", Forest Plot( 1 ) );
Wait( 2 );
scobj = (Report( obj )["Equivalence Tests with Pooled Variance"] << Get Scriptable Object);
scobj << Forest Plot( 0 );


```

#### [Pairwise Comparisons](#pairwise-comparisons)

**Syntax:** obj \<< Equivalence Tests( ..., Equivalence Tests Pairwise Comparisons( state=0|1 ) ); scobj \<< Equivalence Tests Pairwise Comparisons( state=0|1 )

**Description:** Shows or hides the Equivalence Tests Pairwise Comparisons report for all pairwise comparisons.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Equivalence Tests(
    4,
    0.05,
    "Pooled Variance",
    "Equivalence",
    Equivalence Tests Pairwise Comparisons( 1 )
);
Wait( 2 );
scobj = (Report( obj )["Equivalence Tests with Pooled Variance"] << Get Scriptable Object);
scobj << Pairwise Comparisons( 0 );


```

#### [Remove](#remove_1)

**Syntax:** scobj \<< Remove

**Description:** Removes the Equivalence Tests report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Equivalence Tests(
    4,
    0.05,
    "Pooled Variance",
    "Equivalence",
    Equivalence Tests Pairwise Comparisons( 1 )
);
Wait( 1 );
scobj = (Report( obj )["Equivalence Tests with Pooled Variance"] << Get Scriptable Object);
Wait( 1 );
scobj << Remove;


```

#### [Scatterplot](#scatterplot)

**Syntax:** obj \<< Equivalence Tests( ..., Scatterplot( state=0|1 ) ); scobj \<< Scatterplot( state=0|1 )

**Description:** Shows or hides the Equivalence Tests Scatterplot. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Equivalence Tests( 4, 0.05, "Pooled Variance", "Equivalence", Scatterplot( 1 ) );
Wait( 2 );
scobj = (Report( obj )["Equivalence Tests with Pooled Variance"] << Get Scriptable Object);
scobj << Scatterplot( 0 );


```

#### [Test Report](#test-report_1)

**Syntax:** obj \<< Equivalence Tests( ..., Test Report( state=0|1 ) ); scobj \<< Test Report( state=0|1 )

**Description:** Shows or hides a report that summarizes the equivalence tests, superiority tests, or noninferiority tests for means or standard deviations. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Equivalence Tests( 4, 0.05, "Pooled Variance", "Equivalence", Test Report( 1 ) );
Wait( 2 );
scobj = (Report( obj )["Equivalence Tests with Pooled Variance"] << Get Scriptable Object);
scobj << Test Report( 0 );


```

## [Oneway > Oneway Means Comparisons](#oneway-oneway-means-comparisons)

### [Item Messages](#item-messages_16)

#### [Confidence Quantile](#confidence-quantile)

**Syntax:** obj \<< Each Pair( 1, Confidence Quantile( state=0|1 ) ); obj \<< All Pairs( 1, Confidence Quantile( state=0|1 ) ); obj \<< With Best( 1, Confidence Quantile( state=0|1 ) ); obj \<< With Control( 1, Confidence Quantile( state=0|1 ) ); obj \<< Each Pair Stepwise( 1, Confidence Quantile( state=0|1 ) )

**Description:** Shows or hides the critical value(s) and alpha level used for the means comparison.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1, Confidence Quantile( 1 ) );


```

#### [Connecting Letters Report](#connecting-letters-report)

**Syntax:** obj \<< Each Pair( 1, Connecting Letters Report( state=0|1 ) ); obj \<< All Pairs( 1, Connecting Letters Report( state=0|1 ) ); obj \<< Each Pair Stepwise( 1, Connecting Letters Report( state=0|1 ) )

**Description:** Shows or hides the traditional letter-coded report where means that do not share a letter are significantly different.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1, Connecting Letters Report( 1 ) );


```

#### [Detailed Comparisons Report](#detailed-comparisons-report)

**Syntax:** obj \<< Each Pair( 1, Detailed Comparisons Report( state=0|1 ) )

**Description:** Shows or hides a detailed report for each comparison. Each section shows the difference between the levels, standard error and confidence intervals, t-ratios, p-values, and degrees of freedom.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1, Detailed Comparisons Report( 1 ) );


```

#### [Difference Matrix](#difference-matrix)

**Syntax:** obj \<< Each Pair( 1, Difference Matrix( state=0|1 ) ); obj \<< All Pairs( 1, Difference Matrix( state=0|1 ) ); obj \<< With Best( 1, Difference Matrix( state=0|1 ) ); obj \<< With Control( 1, Difference Matrix( state=0|1 ) ); obj \<< Each Pair Stepwise( 1, Difference Matrix( state=0|1 ) )

**Description:** Shows or hides a table of all differences of means.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1, Difference Matrix( 1 ) );


```

#### [Dunnett's Lower](#dunnetts-lower)

**Syntax:** obj \<< Dunnett's Lower( state=0|1 )

**Description:** Shows or hides a Dunnett's lower one-tailed t test, which tests whether means are smaller than the mean of a control group.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << With Control( 1, {15}, Dunnett's Lower( 1 ) );


```

#### [Dunnett's Upper](#dunnetts-upper)

**Syntax:** obj \<< Dunnett's Upper( state=0|1 )

**Description:** Shows or hides a Dunnett's upper one-tailed t test, which tests whether means are larger than the mean of a control group.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << With Control( 1, {15}, Dunnett's Upper( 1 ) );


```

#### [LSD Threshold Matrix](#lsd-threshold-matrix)

**Syntax:** obj \<< Each Pair( 1, LSD Threshold Matrix( state=0|1 ) ); obj \<< All Pairs( 1, LSD Threshold Matrix( state=0|1 ) ); obj \<< With Best( 1, LSD Threshold Matrix( state=0|1 ) ); obj \<< With Control( 1, LSD Threshold Matrix( state=0|1 ) )

**Description:** Shows or hides a matrix of pairwise differences of means minus the least significant difference for those means. A positive value indicates a pair of means that are significantly different.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1, LSD Threshold Matrix( 1 ) );


```

#### [Ordered Differences Report](#ordered-differences-report)

**Syntax:** obj \<< Each Pair( 1, Ordered Differences Report( state=0|1 ) ); obj \<< All Pairs( 1, Ordered Differences Report( state=0|1 ) )

**Description:** Shows or hides all pairwise positive-side differences, standard error of the difference, confidence intervals, p-values, and a plot of the magnitude of the difference with overlaid confidence intervals.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1, Ordered Differences Report( 1 ) );


```

#### [Ordered Ratio Report](#ordered-ratio-report)

**Syntax:** obj \<< Each Pair( 1, Ordered Differences Report( state=0|1 ) ); obj \<< Ratio Comparison for Pooled Variance( 1, Ordered Differences Report( state=0|1 ) )

**Description:** Shows or hides all pairwise positive-side differences, standard error of the difference, confidence intervals, p-values, and a plot of the magnitude of the difference with overlaid confidence intervals.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Ratio Comparison for Pooled Variance( 1, Ordered Differences Report( 1 ) );


```

#### [Ratio Matrix](#ratio-matrix)

**Syntax:** obj \<< Ratios with Pooled Variance( 1, Ratio Matrix( state=0|1 ) ); obj \<< Ratio Comparison for Pooled Variance( 1, Ratio Matrix( state=0|1 ) )

**Description:** Shows or hides a table of all differences of means.

Each Pair is equivalent to Student's t. All Pairs is equivalent to Tukey HSD. With Best is equivalent to Hsu MCB. With Control is equivalent to Dunnett's. Each Pair Stepwise is equivalent to Newman-Keuls.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Oneway( Y( :Height ), X( :Age ) );
obj << Ratios with Pooled Variance( 1, Ratio Matrix( 1 ) );


```

## [Oneway > Post Hoc Analysis for Friedman's Test](#oneway-post-hoc-analysis-for-friedmans-test)

### [Item Messages](#item-messages_17)

#### [Nemenyi Test](#nemenyi-test)

**Syntax:** obj \<< Nemenyi Test( state=0|1 )

**Description:** Shows or hides a report of the Nemenyi test. The Nemenyi test is a pairwise post-hoc test for multiple comparisons of mean rank sums for unreplicated blocked data. This test is usually conducted post-hoc after significant results of the Friedman test.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Snapdragon.jmp" );
obj = dt << Oneway( Y( :Y ), X( :Soil ), Block( :Block ) );
obj << Friedman Rank Test( 1, Nemenyi Test( 1 ) );


```

## [Oneway](#oneway)

### [Associated Constructors](#associated-constructors_4)

#### [Oneway](#oneway_1)

**Syntax:** Oneway( Y( columns ), X( columns ) )

**Description:** Models a continuous response across a set of categorical groups. Analysis methods include ANOVA, means comparisons, analysis of means, and quantile plots.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );


```

### [Columns](#columns_3)

#### [Block](#block_1)

**Syntax:** obj \<< Block( column )

**Description:** Specifies a blocking variable. When this column is specified, the values of the response variable are centered by the block variable.

```

dt = Open( "$SAMPLE_DATA/Snapdragon.jmp" );
obj = dt << Oneway( Y( :Y ), X( :Soil ), Block( :Block ) );
obj << Friedman Rank Test( 1 );


```

#### [By](#by_3)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

#### [Freq](#freq_3)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Oneway( Y( :Height ), X( :Age ), Freq( :_freqcol ) );


```

#### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column(s) )

**Description:** Specifies the predictor variables. These variables must have an ordinal or nominal modeling type.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );


```

#### [Response](#response_1)

**Syntax:** obj \<< Response( column(s) )

**Description:** Specifies the continuous response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );


```

#### [Weight](#weight_3)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Oneway( Y( :Height ), X( :Age ), Weight( :_weightcol ) );


```

#### [X](#x_3)

**Syntax:** obj \<< X( column(s) )

**Description:** Specifies the predictor variables. These variables must have an ordinal or nominal modeling type.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );


```

#### [Y](#y_3)

**Syntax:** obj \<< Y( column(s) )

**Description:** Specifies the continuous response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );


```

### [Item Messages](#item-messages_18)

#### [ANOM](#anom)

**Syntax:** obj \<< ANOM( state=0|1, <chart options> )

**Description:** Compares each group mean to the overall mean.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM( 1 );


```

#### [ANOM for Ranges](#anom-for-ranges)

**Syntax:** obj \<< ANOM for Ranges( state=0|1, <chart options> )

**Description:** Test for unequal variance by comparing group ranges to the overall average range.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Ranges( 1 );


```

#### [ANOM for Variances](#anom-for-variances)

**Syntax:** obj \<< ANOM for Variances( state=0|1, <chart options> )

**Description:** Test for unequal variance by comparing group standard deviations to the root mean squared error.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM for Variances( 1 );


```

#### [ANOM for Variances with Levene(ADM)](#anom-for-variances-with-leveneadm)

**Syntax:** obj \<< "ANOM for Variances with Levene(ADM)"n( state=0|1, <chart options> )

**Description:** Test for unequal variance by comparing the group means of the absolute deviations from the median (ADM) to the overall mean ADM.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << "ANOM for Variances with Levene(ADM)"n( 1 );


```

#### [ANOM with Transformed Ranks](#anom-with-transformed-ranks)

**Syntax:** obj \<< ANOM with Transformed Ranks( state=0|1, <chart options> )

**Description:** Compares each group mean transformed rank to the overall mean transformed rank.

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
obj = dt << Oneway( Y( :y ), X( :Drug ) );
obj << ANOM with Transformed Ranks( 1 );


```

#### [All Graphs](#all-graphs)

**Syntax:** obj \<< All Graphs( state=0|1 )

**Description:** Shows or hides the Oneway plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
Wait( 2 );
obj << All Graphs( 0 );


```

#### [All Pairs](#all-pairs)

**Syntax:** obj \<< All Pairs( state=0|1 ); obj \<< Tukey HSD( state=0|1 ); obj \<< "All Pairs, Tukey HSD"n( state=0|1 )

**Description:** Computes the Tukey honestly significant difference (HSD) test; this test protects the overall error rate. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << All Pairs( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Tukey HSD( 1 );


```

#### [Box Plots](#box-plots)

**Syntax:** obj \<< Box Plots( state=0|1 )

**Description:** Shows or hides outlier box plots for each group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Box Plots( 1 );


```

#### [CDF Plot](#cdf-plot)

**Syntax:** obj \<< CDF Plot( state=0|1 )

**Description:** Shows or hides the cumulative distribution function for all of the groups in the Oneway report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << CDF Plot( 1 );


```

#### [Cauchy Fit](#cauchy-fit)

**Syntax:** obj \<< Cauchy Fit( state=0|1 )

**Description:** Assumes that the errors have a Cauchy distribution. The Cauchy fit is a robust method that can handle extreme outliers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Cauchy Fit( 1 );


```

#### [Compare Densities](#compare-densities)

**Syntax:** obj \<< Compare Densities( state=0|1 )

**Description:** Shows or hides a plot of overlaid probability density functions for each group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Compare Densities( 1 );


```

#### [Comparison Circles](#comparison-circles)

**Syntax:** obj \<< Comparison Circles( state=0|1 )

**Description:** Shows or hides comparison circles. This option is available only when a multiple comparison report is open. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << All Pairs( 1 );
Wait( 2 );
obj << Comparison Circles( 0 );


```

#### [Composition of Densities](#composition-of-densities)

**Syntax:** obj \<< Composition of Densities( state=0|1 )

**Description:** Shows or hides a plot of the summed densities, weighted by the count of each group. Across the range of the X variable, the Composition of Densities plot shows how each group contributes to the total density.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Composition of Densities( 1 );


```

#### [Connect Means](#connect-means)

**Syntax:** obj \<< Connect Means( state=0|1 )

**Description:** Shows or hides straight lines that connect the group means.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Connect Means( 1 );


```

#### [Dunn All Pairs for Joint Ranks](#dunn-all-pairs-for-joint-ranks)

**Syntax:** obj \<< Dunn All Pairs for Joint Ranks( state=0|1 )

**Description:** Shows or hides Dunn's test for all pairs by joint ranking. This test uses the Bonferroni adjustment, but it might not protect overall error rate.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Dunn All Pairs for Joint Ranks( 1 );


```

#### [Dunn With Control for Joint Ranks](#dunn-with-control-for-joint-ranks)

**Syntax:** obj \<< Dunn With Control for Joint Ranks( state = 0|1, {control level} )

**Description:** Shows or hides Dunn's test with a control group by joint ranking. This test uses the Bonferroni adjustment, but it might not protect overall error rate.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Dunn With Control for Joint Ranks( 1, {12} );


```

#### [Dunnett's](#dunnetts)

**Syntax:** obj \<< With Control( state=0|1, {control ID} ); obj \<< "Dunnett's"n( state=0|1, {control ID} ); obj \<< "With Control, Dunnett's"n( state=0|1, {control ID} )

**Description:** Computes Dunnett's test; this tests whether means are different from the mean of a control group. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << With Control( 1, {15} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Dunnett's"n( 1, {15} );


```

#### [Each Pair](#each-pair)

**Syntax:** obj \<< Each Pair( state=0|1 ); obj \<< "Student's t"n( state=0|1 ); obj \<< "Each Pair, Student's t"n( state=0|1 )

**Description:** Computes individual pairwise comparisons using Student's t tests with no adjustments made for multiple tests. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Student's t"n( 1 );


```

#### [Each Pair Stepwise](#each-pair-stepwise)

**Syntax:** obj \<< Each Pair Stepwise( state=0|1 ); obj \<< "Newman-Keuls"n( state=0|1 ); obj \<< "Each Pair Stepwise, Newman-Keuls"n( state=0|1 )

**Description:** Computes the Newman-Keuls test; this tests whether there are differences between the means using the Studentized range test in a stepwise procedure. Also known as the Student-Newman-Keuls method, this test is less conservative and more powerful than a Tukey HSD test. See the Oneway Means Comparisons messages for further display options.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair Stepwise( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Newman-Keuls"n( 1 );


```

#### [Equivalence Tests](#equivalence-tests)

**Syntax:** obj \<< Equivalence Tests( difference, \<alpha=.05>, \<"Pooled Variance"|"Unequal Variances">, <test type> )

**Description:** Tests that the means do not differ by more than an amount (difference) determined to be practically equivalent. This is the reverse of the usual significance test. Alpha, variance assumption, and test type are optional arguments. By default, the "Pooled Variance" assumption is used. The test type argument is "Equivalence" by default, but it can also be used to specify superiority or noninferiority tests.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Equivalence Tests( 4, 0.1, "Unequal Variances" );


```

#### [Equivalence Tests of Std Dev](#equivalence-tests-of-std-dev)

**Syntax:** obj \<< Equivalence Tests of Std Dev( ratio, \<alpha=.05>, <test type> )

**Description:** Tests that the standard deviations do not differ by more than a ratio determined to be practically equivalent. This is the reverse of the usual significance test. Alpha and test type are optional arguments. The test type argument is "Equivalence" by default, but it can also be used to specify superiority or noninferiority tests.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Equivalence Tests of Std Dev( 0.8, 0.05, "Equivalence" );


```

#### [Friedman Rank Test](#friedman-rank-test)

**Syntax:** obj \<< Friedman Rank Test( state=0|1 )

**Description:** Shows or hides a test based on Friedman Rank scores. The Friedman Rank scores are the ranks of the data within each level of the blocking variable. The parametric version of this test is a repeated measures ANOVA. This option is available only when a Block variable with an equal number of observations within each block is specified in the platform launch.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Snapdragon.jmp" );
obj = dt << Oneway( Y( :Y ), X( :Soil ), Block( :Block ) );
obj << Friedman Rank Test( 1 );


```

#### [Games-Howell](#games-howell)

**Syntax:** obj \<< "Games-Howell"n( state=0|1 );

**Description:** Shows or hides a Games-Howell multiple comparison of all pairs of means report. This test can be applied in settings when the individual group variances cannot be assumed to be equal.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Games-Howell"n( 1 );


```

#### [Grand Mean](#grand-mean)

**Syntax:** obj \<< Grand Mean( state=0|1 )

**Description:** Shows or hides the overall mean of the Y variable. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ), Grand Mean( 0 ) );
Wait( 2 );
obj << Grand Mean( 1 );


```

#### [Histograms](#histograms)

**Syntax:** obj \<< Histograms( state=0|1 )

**Description:** Shows or hides side-by-side histograms to the right of the original plot.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Histograms( 1 );


```

#### [Hsu MCB](#hsu-mcb)

**Syntax:** obj \<< With Best( state=0|1 ); obj \<< Hsu MCB( state=0|1 ); obj \<< "With Best, Hsu MCB"n( state=0|1 )

**Description:** Computes the Hsu multiple comparison with best (MCB) test; this tests whether means are less than the unknown maximum. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << With Best( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Hsu MCB( 1 );


```

#### [Jonckheere Terpstra Test](#jonckheere-terpstra-test_1)

**Syntax:** obj \<< Jonckheere Terpstra Test( state=0|1 )

**Description:** Shows or hides a report of the Jonckheere-Terpstra test, which is a nonparametric test for ordered differences among classes. It tests the null hypothesis that the distribution of the response variable does not differ among classes.

```

dt = Open( "$SAMPLE_DATA/Big Class.JMP" );
obj = dt << Oneway( Y( :Height ), X( :age ) );
obj << Jonckheere Terpstra Test( 1 );


```

#### [Kolmogorov Smirnov Exact Test](#kolmogorov-smirnov-exact-test)

**Syntax:** obj \<< Kolmogorov Smirnov Exact Test( state=0|1 )

**Description:** Shows or hides the Kolmogorov-Smirnov exact test, which is based on the empirical distribution function. This test determines whether the distribution of the response is the same across the groups. This option is available only when the X variable has exactly two levels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :sex ) );
obj << Kolmogorov Smirnov Exact Test( 1 );


```

#### [Kolmogorov Smirnov Test](#kolmogorov-smirnov-test)

**Syntax:** obj \<< Kolmogorov Smirnov Test( state=0|1 )

**Description:** Shows or hides a test based on the empirical distribution function, which tests whether the distribution of the response is the same across the groups. This option is available only when the X variable has exactly two levels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :sex ) );
obj << Kolmogorov Smirnov Test( 1 );


```

#### [Legend](#legend)

**Syntax:** obj \<< Legend( state=0|1 )

**Description:** Shows or hides a legend for the normal quantile, cumulative distribution function (CDF), and density plots. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ), Plot Quantile by Actual( 1 ), Legend( 0 ) );
Wait( 2 );
obj << Legend( 1 );


```

#### [Line of Fit](#line-of-fit_2)

**Syntax:** obj \<< Line of Fit( state=0|1 )

**Description:** Shows or hides a reference line fit to the data for each level of the X variable on each open quantile plot. This option is available only when a quantile plot is open. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Plot Quantile by Actual( 1 );
Wait( 2 );
obj << Line of Fit( 0 );


```

#### [Matching Column](#matching-column)

**Syntax:** obj \<< Matching Column( column )

**Description:** Shows or hides a matched fit line and a corresponding fit line on the Oneway plot based on a specified matching variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Weight ), X( :Age, :sex ) );
Wait( 2 );
obj[1] << Matching Column( :sex );
obj[2] << Matching Column( :Age );


```

#### [Matching Dotted Lines](#matching-dotted-lines)

**Syntax:** obj \<< Matching Dotted Lines( state=0|1 )

**Description:** Shows or hides dotted lines that connect the means through missing levels of the matching variable. The values used in place of the missing cell means are obtained using a two-way ANOVA model. This option is available only when the Matching Column option is selected and values of the matching variable are all missing for a level of the X variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:sex[6 :: 8] = "";
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Matching Column( :sex );
Wait( 2 );
obj << Matching Dotted Lines( 1 );


```

#### [Matching Lines](#matching-lines)

**Syntax:** obj \<< Matching Lines( state=0|1 )

**Description:** Shows or hides lines that connect the means of each level of the matching variable. This option is available only when the Matching Column option is selected.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Oneway( Y( :LogHist0 ), X( :drug ) );
obj << Matching Column( :LogHist1 );
Wait( 2 );
obj << Matching Lines( 0 );


```

#### [Mean CI Lines](#mean-ci-lines)

**Syntax:** obj \<< Mean CI Lines( state=0|1 )

**Description:** Shows or hides lines at the upper and lower 95% confidence levels for each group. The 95% confidence levels are calculated using the pooled standard deviation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Mean CI Lines( 1 );


```

#### [Mean Diamonds](#mean-diamonds)

**Syntax:** obj \<< Mean Diamonds( state=0|1 )

**Description:** Shows or hides mean diamonds on the Oneway plot. Each mean diamond spans a 95% confidence interval for the corresponding group mean, with a horizontal line at the mean. The 95% confidence intervals are calculated using the pooled standard deviation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Mean Diamonds( 1 );


```

#### [Mean Error Bars](#mean-error-bars)

**Syntax:** obj \<< Mean Error Bars( state=0|1 )

**Description:** Shows or hides the mean of each group with error bars that are one standard error above and below the mean.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Mean Error Bars( 1 );


```

#### [Mean Lines](#mean-lines)

**Syntax:** obj \<< Mean Lines( state=0|1 )

**Description:** Shows or hides a line at the mean of each group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Mean Lines( 1 );


```

#### [Mean of Means](#mean-of-means)

**Syntax:** obj \<< Mean of Means( state=0|1 )

**Description:** Shows or hides the mean of the group means.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Mean of Means( 1 );


```

#### [Means and Std Dev](#means-and-std-dev)

**Syntax:** obj \<< Means and Std Dev( state=0|1 )

**Description:** Shows or hides mean lines, error bars, and standard deviation lines on the Oneway plot and shows or hides a summary statistics table. The standard errors for the means use individual group standard deviations.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Means and Std Dev( 1 );


```

#### [Means/Anova](#meansanova)

**Syntax:** obj \<< Means( state=0|1 ); obj \<< "Means/Anova"n( state=0|1)

**Description:** Shows or hides mean diamonds on the Oneway plot and shows or hides an ANOVA report. This option is available only when the X variable has more than two levels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Means( 1 );


```

#### [Means/Anova/Pooled t](#meansanovapooled-t)

**Syntax:** obj \<< Means( state=0|1 ); obj \<< "Means/Anova/Pooled t"n( state=0|1)

**Description:** Shows or hides mean diamonds on the Oneway plot and shows or hides an ANOVA report. The ANOVA report includes a pooled t test report that assumes that the two groups have equal variances. This option is available only when the X variable has exactly two levels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :sex ) );
obj << Means( 1 );


```

#### [Median Exact Test](#median-exact-test)

**Syntax:** obj \<< Median Exact Test( state=0|1 )

**Description:** Shows or hides an analysis of median scores.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :sex ) );
obj << Median Exact Test( 1 );


```

#### [Median Test](#median-test)

**Syntax:** obj \<< Median Test( state=0|1 )

**Description:** Shows or hides a test based on median rank scores. The median rank scores are either 1 or 0, depending on whether a rank is above or below the median rank. The median test is the most powerful rank test for errors with double-exponential distributions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Median Test( 1 );


```

#### [Newman-Keuls](#newman-keuls)

**Syntax:** obj \<< Each Pair Stepwise( state=0|1 ); obj \<< "Newman-Keuls"n( state=0|1 ); obj \<< "Each Pair Stepwise, Newman-Keuls"n( state=0|1 )

**Description:** Computes the Newman-Keuls test; this tests whether there are differences between the means using the Studentized range test in a stepwise procedure. Also known as the Student-Newman-Keuls method, this test is less conservative and more powerful than a Tukey HSD test. See the Oneway Means Comparisons messages for further display options.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair Stepwise( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Newman-Keuls"n( 1 );


```

#### [Normal Quantile Label](#normal-quantile-label)

**Syntax:** obj \<< Normal Quantile Label( state=0|1 )

**Description:** Shows or hides the normal quantile scale on each open quantile plot. This option is available only when a quantile plot is open. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Plot Quantile by Actual( 1 );
Wait( 2 );
obj << Normal Quantile Label( 0 );


```

#### [Plot Actual by Quantile](#plot-actual-by-quantile)

**Syntax:** obj \<< Plot Actual by Quantile( state=0|1 )

**Description:** Shows or hides a quantile plot to the right of the Oneway Analysis plot.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Plot Actual by Quantile( 1 );


```

#### [Plot Quantile by Actual](#plot-quantile-by-actual)

**Syntax:** obj \<< Plot Quantile by Actual( state=0|1 )

**Description:** Shows or hides a quantile plot with the Y variable on the horizontal axis and cumulative probabilities on the vertical axis.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Plot Quantile by Actual( 1 );


```

#### [Points](#points)

**Syntax:** obj \<< Points( state=0|1 )

**Description:** Shows or hides data points on the Oneway plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
Wait( 2 );
obj << Points( 0 );


```

#### [Points Jittered](#points-jittered_1)

**Syntax:** obj \<< Points Jittered( "None"|"Auto"|"Random Uniform"|"Random Normal"|"Density Random"|"Packed"|"Grid"|"Hex Grid"|"Beeswarm"="Auto" )

**Description:** Specifies the spread of the data points. When selected, the data points are jittered to avoid overlapping markers. "Auto" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Oneway( Y( :Sepal length ), X( :Species ) );
obj << Points Jittered( "Binned" );


```

#### [Points Spread](#points-spread)

**Syntax:** obj \<< Points Spread( state=0|1 )

**Description:** Specifies the spread of the data points. When selected, the data points are spread across the width of the interval.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Points Spread( 1 );


```

#### [Pooled Variance](#pooled-variance)

**Syntax:** obj \<< Ratios with Pooled Variance( state=0|1 );

**Description:** Shows or hides a ratio comparison of each pairs of means report. Under the assumption of equal variances, the pooled confidence interval for the mean ratio is the Fieller confidence interval.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Ratios with Pooled Variance( 1 );


```

#### [Power](#power)

**Syntax:** obj \<< Power( Alpha( from, <to>, <by> ), Sigma( from, <to>, <by> ), Delta( from, <to>, <by> ), Number( from, <to>, <by> ), Solve for Power|Solve for Least Significant Number|Solve for Least Significant Value|Adjusted Power and Confidence Interval, Power Plot, Done )

**Description:** Reports statistical power calculations. The arguments allow ranges to be specified for the alpha, sigma, delta, and total sample size (Number). The fifth argument specifies the results of the report. The sixth argument requests a Power Plot, and the Done argument dismisses the Power Dialog.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ), All Graphs( 0 ) );
obj << Power(
    Alpha( 0.05 ),
    Sigma( 3.382, 3.73 ),
    Delta( 2.79679 ),
    Number( 10, 90, 5 ),
    Solve for Power,
    Power Plot,
    Done
);


```

#### [Proportion of Densities](#proportion-of-densities)

**Syntax:** obj \<< Proportion of Densities( state=0|1 )

**Description:** Shows or hides a plot of the contribution to the density made by each level of the X variable. The contribution is shown as a proportion of the total density across the range of the X variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Proportion of Densities( 1 );


```

#### [Quantiles](#quantiles)

**Syntax:** obj \<< Quantiles( state=0|1 )

**Description:** Shows or hides box plots on the Oneway plot and shows or hides a quantile report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Quantiles( 1 );


```

#### [Robust Fit](#robust-fit)

**Syntax:** obj \<< Robust Fit( state=0|1 )

**Description:** Produces Huber estimates that are equivalent to least squares residuals for small residuals, and equivalent to least absolute values for large residuals.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Robust Fit( 1 );


```

#### [Robust Means Lines](#robust-means-lines)

**Syntax:** obj \<< Robust Means Lines( state=0|1 )

**Description:** Shows or hides a line at the robust mean of each group. This option is available only when a Robust option is selected.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Robust Fit( 1 );
obj << Robust Means Lines( 1 );


```

#### [Save Normal Quantiles](#save-normal-quantiles)

**Syntax:** obj \<< Save Normal Quantiles

**Description:** Saves normal quantile values for each level of the X variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Normal Quantiles;


```

#### [Save Predicted](#save-predicted)

**Syntax:** obj \<< Save Predicted

**Description:** Saves the predicted mean of the Y variable for each level of the X variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Predicted;


```

#### [Save Residuals](#save-residuals_2)

**Syntax:** obj \<< Save Residuals

**Description:** Saves values computed as the Y variable minus the mean of the Y variable within each level of the X variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Residuals;


```

#### [Save Standardized](#save-standardized)

**Syntax:** obj \<< Save Standardized

**Description:** Saves standardized values of the Y variable for each level of the X variable. The standardized value is the centered response divided by the standard deviation within each level.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Standardized;


```

#### [Select Group](#select-group)

**Syntax:** obj \<< Select Group( X value )

**Description:** Selects a group so that its circle is highlighted.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Weight ), X( :Age ), Each Pair );
Wait( 2 );
obj << Select Group( 14 );


```

#### [Set Alpha Level](#set-alpha-level_8)

**Syntax:** obj \<< Set Alpha Level( alpha=0.05 )

**Description:** Changes the alpha level used for confidence limits, means diamonds, and confidence level values in reports. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Means( 1 );
Wait( 2 );
obj << Set Alpha Level( 0.01 );


```

#### [Set α Level](#set-level_2)

**Syntax:** obj \<< Set α Level( alpha=0.05 )

**Description:** Changes the alpha level used for confidence limits, means diamonds, and confidence level values in reports. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Means( 1 );
Wait( 2 );
obj << Set Alpha Level( 0.01 );


```

#### [Standard Deviations](#standard-deviations)

**Syntax:** obj \<< Standard Deviations

**Description:** Launches a window with options for equivalence, superiority, or noninferiority tests for standard deviations. Specify the critical ratio.

#### [Std Dev Lines](#std-dev-lines)

**Syntax:** obj \<< Std Dev Lines( state=0|1 )

**Description:** Shows or hides lines that are one standard deviation above and below the mean of each group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Std Dev Lines( 1 );


```

#### [Steel With Control](#steel-with-control)

**Syntax:** obj \<< Steel With Control( state = 0|1, {control level} )

**Description:** Shows or hides Steel's test, which protects the overall error rate for comparing all other groups with a control group. This is the nonparametric version of Dunnett's method.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Steel With Control( 1, {12} );


```

#### [Steel-Dwass All Pairs](#steel-dwass-all-pairs)

**Syntax:** obj \<< "Steel-Dwass All Pairs"n( state=0|1 )

**Description:** Shows or hides Steel-Dwass's test, which protects the overall error rate. This is the nonparametric version of Tukey's method.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Steel-Dwass All Pairs"n( 1 );


```

#### [Student's t](#students-t)

**Syntax:** obj \<< Each Pair( state=0|1 ); obj \<< "Student's t"n( state=0|1 ); obj \<< "Each Pair, Student's t"n( state=0|1 )

**Description:** Computes individual pairwise comparisons using Student's t tests with no adjustments made for multiple tests. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Each Pair( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Student's t"n( 1 );


```

#### [Tukey HSD](#tukey-hsd)

**Syntax:** obj \<< All Pairs( state=0|1 ); obj \<< Tukey HSD( state=0|1 ); obj \<< "All Pairs, Tukey HSD"n( state=0|1 )

**Description:** Computes the Tukey honestly significant difference (HSD) test; this test protects the overall error rate. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << All Pairs( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Tukey HSD( 1 );


```

#### [Unequal Variances](#unequal-variances)

**Syntax:** obj \<< Unequal Variances( state=0|1 )

**Description:** Shows or hides four tests for equality of group variances. This option also produces the Welch test, which is an ANOVA test for comparing means when the variances within groups are not equal.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Unequal Variances( 1 );


```

#### [Unpooled Variance](#unpooled-variance)

**Syntax:** obj \<< Ratios with Unpooled Variance( state=0|1 );

**Description:** Shows or hides a ratio comparison of each pairs of means report. Under the assumption of unequal variances, the unpooled Satterthwaite-based confidence interval for the mean ratio is computed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Ratios with Unpooled Variance( 1 );


```

#### [Van Der Waerden Exact Test](#van-der-waerden-exact-test)

**Syntax:** obj \<< Van Der Waerden Exact Test( state=0|1 )

**Description:** Shows or hides an analysis of Van der Waerden or normal scores.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :sex ) );
obj << Van Der Waerden Exact Test( 1 );


```

#### [Wilcoxon Each Pair](#wilcoxon-each-pair)

**Syntax:** obj \<< Wilcoxon Each Pair( state=0|1 )

**Description:** Shows or hides Wilcoxon's test for all possible individual comparisons with no adjustment for multiple tests. This is the nonparametric version of the Each Pair, Student's t method.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Wilcoxon Each Pair( 1 );


```

#### [Wilcoxon Exact Test](#wilcoxon-exact-test)

**Syntax:** obj \<< Wilcoxon Exact Test( state=0|1 )

**Description:** Shows or hides an analysis of Wilcoxon scores using exact methods for each pair of levels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :sex ) );
obj << Wilcoxon Exact Test( 1 );


```

#### [Wilcoxon Test](#wilcoxon-test)

**Syntax:** obj \<< Wilcoxon Test( state=0|1 )

**Description:** Shows or hides a test based on Wilcoxon rank scores. The Wilcoxon rank scores are the simple ranks of the data. The Wilcoxon test is the most powerful rank test for errors with logistic distributions. If the X variable has exactly two levels, the Wilcoxon test is equivalent to the Mann-Whitney test. If the X variable has more than two levels, the Kruskal-Wallis test is performed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Wilcoxon Test( 1 );


```

#### [With Best](#with-best)

**Syntax:** obj \<< With Best( state=0|1 ); obj \<< Hsu MCB( state=0|1 ); obj \<< "With Best, Hsu MCB"n( state=0|1 )

**Description:** Computes the Hsu multiple comparison with best (MCB) test; this tests whether means are less than the unknown maximum. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << With Best( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Hsu MCB( 1 );


```

#### [With Control](#with-control)

**Syntax:** obj \<< With Control( state=0|1, {control ID} ); obj \<< "Dunnett's"n( state=0|1, {control ID} ); obj \<< "With Control, Dunnett's"n( state=0|1, {control ID} )

**Description:** Computes Dunnett's test; this tests whether means are different from the mean of a control group. See the Oneway Means Comparisons messages for further display options.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << With Control( 1, {15} );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << "Dunnett's"n( 1, {15} );


```

#### [X Axis Proportional](#x-axis-proportional)

**Syntax:** obj \<< X Axis Proportional( state=0|1 )

**Description:** Specifies the spacing on the horizontal axis. When selected, the spacing is proportional to the number of observations at each level. This option is not available when the Matching Column option is selected. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ), X Axis Proportional( 0 ) );
Wait( 2 );
obj << X Axis Proportional( 1 );


```

#### [t Test](#t-test)

**Syntax:** obj \<< t Test( state=0|1 )

**Description:** Shows or hides a t test report assuming that the variances are not equal. This option is available only when the X variable has exactly two levels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :sex ) );
obj << t Test( 1 );


```

#### [van der Waerden Test](#van-der-waerden-test)

**Syntax:** obj \<< van der Waerden Test( state=0|1 )

**Description:** Shows or hides a test based on Van der Waerden rank scores. The Van der Waerden rank scores are the ranks of the data divided by one plus a score value. The score value is the number of observations transformed to a normal score by applying the inverse of the normal distribution function. The Van der Waerden test is the most powerful rank test for errors with normal distributions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << van der Waerden Test( 1 );


```

### [Shared Item Messages](#shared-item-messages_3)

#### [Action](#action_3)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_3)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_3)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_3)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_3)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_3)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_3)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_3)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_3)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_3)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_3)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_3)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_3)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_3)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_3)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_3)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_3)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_3)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_3)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_3)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_3)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_3)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_3)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_3)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_3)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_3)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_6)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_3)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_3)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_3)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_3)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_3)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_3)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Oneway(
    Y( :Height ),
    X( :Age ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_3)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_3)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_3)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_3)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_3)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_3)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_3)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_3)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_3)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_3)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :Height ), X( :Age ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_3)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_3)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_3)

**Syntax:** obj = Oneway(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Formula Depot](#formula-depot)

## [Associated Constructors](#associated-constructors)

### [Formula Depot](#formula-depot_1)

**Syntax:** Formula Depot

**Description:** A container for prediction models that supports model comparison, profiling, and scoring code generation. The Formula Depot is launched through the analyze menu, Publish commands in modeling platforms, Recode, and the Formula Editor.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];


```

## [Item Messages](#item-messages)

### [Add Formula from Column](#add-formula-from-column)

**Syntax:** Predictor = obj \<< Add Formula from Column( Table(name|reference), Columns(name|index|reference, ...), \<Expand Intermediate Formulas(number)> )

**Description:** Add an existing prediction formula column from the given table to the Formula Depot

```


dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
fd = Formula Depot();
model << Save Probability Formula;
mp = fd << Add Formula From Column( Table( dt ), Columns( 11 ) ); // "Most Likely Species"
mp << Generate Python Code;


```

### [Copy Formulas as Functions](#copy-formulas-as-functions)

**Syntax:** obj \<< Copy Formulas as Functions( \<Formulas(name|index|reference, ...)> )

**Description:** Copies the given models onto the clipboard as a scalar Function() statement.

**JMP Version Added:** 14

```


dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
fd = Formula Depot();
predictor = model << Publish Probability Formulas;
fd << Copy Formulas as Functions( Formulas( predictor ) );
Wait( 0 );
text = Get Clipboard();
Show( text );


```

### [Copy Formulas as Transforms](#copy-formulas-as-transforms)

**Syntax:** obj \<< Copy Formulas as Transforms( \<Table(name|reference)>, \<Formulas(name|index|reference, ...)> )

**Description:** Copies the given models onto the clipboard within a Transform Column() statement.

```


dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
fd = Formula Depot();
model << Publish Probability Formulas;
fd << Copy Formulas as Transforms(
    // English: Formulas("Fit Nominal Logistic - Species")
    Formulas( 1 )
);
Wait( 0 );
text = Get Clipboard();
Show( text );


```

### [Copy Scripts](#copy-scripts)

**Syntax:** obj \<< Copy Scripts( \<Formulas(name|index|reference, ...)> )

**Description:** Copies the scripts for the given formulas stored in the Formula Depot to the clipboard.

```


dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
fd = Formula Depot();
predictor = model << Publish Probability Formulas;
fd << Copy Scripts( Formulas( predictor ) );
Wait( 0 );
text = Get Clipboard();
Show( text );


```

### [Generate C Code](#generate-c-code)

**Syntax:** obj \<< Generate C Code( \<Formulas(name|index|reference, ...)>, <No Editor> )

**Description:** Generates C code for the given models stored in the Formula Depot. Output goes to an editor window or to a string variable if the 'No Editor' argument is given.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
md = dt << Run Script( "Nominal Logistic" );
predictor = md << Publish Probability Formulas;
// Save code to string 
c_code = fd << Generate C Code( Formulas( predictor ), No Editor );
// shortcut using predictor reference
// c_code = predictor << Generate C Code(No Editor);
Save Text File( "$TEMP\logist.c", c_code );
// Open code in editor window
fd << Generate C Code( Formulas( predictor ) );


```

### [Generate JavaScript Code](#generate-javascript-code)

**Syntax:** obj \<< Generate JavaScript Code( \<Formulas(name|index|reference, ...)>, <No Editor> )

**Description:** Generates JavaScript code for the given models stored in the Formula Depot. Output goes to an editor window or to a string variable if the 'No Editor' argument is given.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
md = dt << Run Script( "Nominal Logistic" );
predictor = md << Publish Probability Formulas;
// Save code to string 
js_code = fd << Generate JavaScript Code( Formulas( predictor ), No Editor );
// shortcut using predictor reference
// js_code = predictor << Generate JavaScript Code(No Editor);
Save Text File( "$TEMP\logist.js", js_code );
// Open code in editor window
fd << Generate JavaScript Code( Formulas( predictor ) );


```

### [Generate Python Code](#generate-python-code)

**Syntax:** obj \<< Generate Python Code( \<Formulas(name|index|reference, ...)>, <No Editor> )

**Description:** Generates Python code for the given models stored in the Formula Depot. Output goes to an editor window or to a string variable if the 'No Editor' argument is given.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
md = dt << Run Script( "Nominal Logistic" );
predictor = md << Publish Probability Formulas;
// Save code to string 
py_code = fd << Generate Python Code( Formulas( predictor ), No Editor );
// shortcut using predictor reference
// py_code = predictor << Generate Python Code(No Editor);
Save Text File( "$TEMP\logist.py", py_code );
// Open code in editor window
fd << Generate Python Code( Formulas( predictor ) );


```

### [Generate SAS Code](#generate-sas-code)

**Syntax:** obj \<< Generate SAS Code( \<Formulas(name|index|reference, ...)>, <No Editor> )

**Description:** Generates SAS (DS2) code for the given models stored in the Formula Depot. Output goes to an editor window or to a string variable if the 'No Editor' argument is given.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
md = dt << Run Script( "Nominal Logistic" );
predictor = md << Publish Probability Formulas;
// Save code to string 
sas_code = fd << Generate SAS Code( Formulas( predictor ), No Editor );
// shortcut using predictor reference
// sas_code = predictor << Generate SAS Code(No Editor);
Save Text File( "$TEMP\logist.sas", sas_code );
// Open code in editor window
fd << Generate SAS Code( Formulas( predictor ) );


```

### [Generate SQL Code](#generate-sql-code)

**Syntax:** obj \<< Generate SQL Code( \<Formulas(name|index|reference, ...)>, <No Editor>, \<QUOTE_STYLE> )

**Description:** Generates SQL code (column definitions suitable for use in an SQL Select statement) for the given models stored in the Formula Depot. Output goes to an editor window or to a string variable if the "No Editor" argument is given. QUOTE_STYLE is a string denoting one of the SQL databases supported by JMP (MySQL, Impala, Hive, and so on) or a SQL quoting type ("Underline", "Backquote", "Bracket" or "Doublequote").

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Liver Cancer.jmp" );
md = dt << Run Script( "Elastic Net Poisson, BIC" );
mp_obs = md << xpath( "//OutlineBox" );
scriptables = Filter Each( {ob}, mp_obs << Get Scriptable Object(), !Is Empty( ob ) );
mp = scriptables[2];
predictor = mp << Publish Prediction Formula;
// Save code to string 
sql_code = fd << Generate SQL Code( Formulas( 1 ), No Editor );
// shortcut using predictor reference
// sql_code = predictor << Generate SQL Code(No Editor);
Save Text File( "$TEMP\genreg.sql", sql_code );
// Open code in editor window
fd << Generate SQL Code( Formulas( predictor ), "MySQL" );


```

### [Model Comparison](#model-comparison)

**Syntax:** obj \<< Model Comparison( \<Table(name|reference)>, \<Formulas(name|index|reference, ...)> )

**Description:** Compares the given models stored in the Formula Depot using the model comparison utility, based on the contents of the given table.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
nl_md = dt << Run Script( "Nominal Logistic" );
nl_mp = nl_md << Publish Probability Formulas;
nn_md = Neural(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Informative Missing( 0 ),
    Validation Method( "Holdback", 0.3333 ),
    Fit( NTanH( 3 ) )
);
nn_mp = nn_md << Publish Prediction Formula;
mc_plat = fd << ModelComparison( Formulas( 1, 2 ) );
// Other options:
// mds = {"Fit Nominal Logistic - Species", "Neural - Species"};
// fd << ModelComparison( Formulas( mds ) );
// fd << ModelComparison( Formulas( 1 ), Formulas( 2 ) );
// fd << ModelComparison; // all models


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( \<Table(name|reference)>, \<Formulas(name|index|reference, ...)> )

**Description:** Profiles the given models stored in the Formula Depot using the Profiler utility, based on the contents of the given table.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
nl_md = dt << Run Script( "Nominal Logistic" );
nl_mp = nl_md << Publish Probability Formulas;
nn_md = Neural(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Informative Missing( 0 ),
    Validation Method( "Holdback", 0.3333 ),
    Fit( NTanH( 3 ) )
);
nn_mp = nn_md << Publish Prediction Formula;
fd << Profiler( Formulas( nl_mp, nn_mp ) );


```

### [Remove Model Comparison](#remove-model-comparison)

**Syntax:** obj \<< Remove Model Comparison

**Description:** Removes all Model Comparison reports from the current Formula Depot.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
nl_md = dt << Run Script( "Nominal Logistic" );
nl_md << Publish Probability Formulas;
fd << Model Comparison();
fd << Remove Model Comparison();


```

### [Remove Profiler](#remove-profiler)

**Syntax:** obj \<< Remove Profiler

**Description:** Removes all Profilers from the current Formula Depot.

```


fd = Formula Depot();
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
nl_md = dt << Run Script( "Nominal Logistic" );
nl_md << Publish Probability Formulas;
fd << Profiler();
fd << Remove Profiler();


```

### [Rename Formula Depot](#rename-formula-depot)

**Syntax:** obj \<< Rename Formula Depot( text )

```


fd = Formula Depot();
fd << Rename Formula Depot( "New Name" );


```

### [Run Scripts](#run-scripts)

**Syntax:** obj \<< Run Scripts( \<Table(name|reference)>, \<Formulas(name|index|reference, ...)> )

**Description:** Saves the given models to the current or given JMP data table as one or more formula columns.

```


// Create a Formula Depot to store the model
dt1 = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt1 << RunScript( "Nominal Logistic" );
fd1 = Formula Depot();
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
// Clean-up
Close( dt1, NoSave );
fd1 << Close Window;
// Read FD from disk
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
// Create columns from stored model; usually this is a new table with a compatible schema
dt2 = Open( "$SAMPLE_DATA\Iris.jmp" );
fd2 << Run Scripts( Table( dt2 ), Formulas( 1 ) );


```

### [Show Scripts](#show-scripts)

**Syntax:** obj \<< Show Scripts( \<Formulas(name|index|reference, ...)> )

**Description:** Opens a new Formula Window (or appends to an open Formula Window) that contains scripts for the given formulas stored in the Formula Depot.

```


dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
fd = Formula Depot();
model << Publish Probability Formulas;
fd << Show Scripts( Formulas( 1 ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj << Copy Script;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File(
    "$TEMP\fd.jrp",
    Char( Name Expr( fd_script ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File(
    "$TEMP\fd.jrp",
    Char( Name Expr( fd_script ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


fd1 = Formula Depot();
dt = Open( "$SAMPLE_DATA\Iris.jmp" );
model = dt << RunScript( "Nominal Logistic" );
model << Publish Probability Formulas;
fd_script = fd1 << Get Script;
Save Text File( "$TEMP\fd.jrp", Char( Name Expr( fd_script ) ) );
fd1 << Close Window;
Open( "$TEMP\fd.jrp" );
fd2 = Formula Depot[1];
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Functional Data Explorer Group](#functional-data-explorer-group)

## [Associated Constructors](#associated-constructors)

### [Functional Data Explorer Group](#functional-data-explorer-group_1)

**Syntax:** Functional Data Explorer Group( model1, model2, ... ) Functional Data Explorer Group( model1; model2; ... )

**Description:** Groups Functional Data Explorer models for multiple Y in the Stacked data format.

## [Item Messages](#item-messages)

### [AICc](#aicc)

**Syntax:** obj \<< Model Name( AICc ); scrobj \<< AICc

**Description:** Specifies the AICc as the model selection criterion for B-Spline, P-Spline, and Fourier Basis models.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines( AICc )
);


```

### [ARWLS Save Baselines](#arwls-save-baselines)

**Syntax:** obj \<< ARWLS Save Baselines

**JMP Version Added:** 19

### [ARWLS Save Corrected](#arwls-save-corrected)

**Syntax:** obj \<< ARWLS Save Corrected

**JMP Version Added:** 19

### [Align 0 to 1](#align-0-to-1)

**Syntax:** obj \<< Data Processing( Align 0 to 1 )

**Description:** Aligns the output functions (Y) over the range of the input (X) to be in 0 to 1.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align 0 to 1 )
);


```

### [Align Maximum](#align-maximum)

**Syntax:** obj \<< Data Processing( Align Maximum )

**Description:** Aligns the output functions (Y) using the observed maximum input value (X).

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align Maximum )
);


```

### [Align Minimum](#align-minimum)

**Syntax:** obj \<< Data Processing( Align Minimum )

**Description:** Aligns the output functions (Y) using the observed minimum input value (X).

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align Minimum )
);


```

### [Align by Function](#align-by-function)

**Syntax:** obj \<< Data Processing( Align by Function )

**Description:** Aligns the output functions (Y) so that the range of each function is over the range of the input (X).

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align by Function )
);


```

### [B Splines](#b-splines)

**Syntax:** obj \<< B Splines

**Description:** Fits a B-spline model to the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines
);


```

### [B Splines Model Controls](#b-splines-model-controls)

**Syntax:** obj \<< B Splines Model Controls

**Description:** Opens the Model Controls panel prior to fitting a B-Spline model. You can specify the number of knots and the spline degree.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines Model Controls
);


```

### [BIC](#bic)

**Syntax:** obj \<< Model Name( BIC ); scrobj \<< BIC

**Description:** Specifies the BIC as the model selection criterion for B-Spline, P-Spline, and Fourier Basis models.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    P Splines( BIC )
);


```

### [Baseline Correction](#baseline-correction)

**Syntax:** obj \<< Baseline Correction

**JMP Version Added:** 19

### [Center](#center)

**Syntax:** obj \<< Data Processing( Center )

**Description:** Centers the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Center )
);


```

### [Custom Save Corrected](#custom-save-corrected)

**Syntax:** obj \<< Custom Save Corrected

**JMP Version Added:** 19

### [Direct Functional PCA](#direct-functional-pca)

**Syntax:** obj \<< Direct Functional PCA

**Description:** Performs Functional PCA directly without fitting a basis function model. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Formulation for Homogeneity DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Homogeneity Grade ),
    X( :T ),
    ID( :Formulation ),
    Z( :Solvent, :Active, :Water ),
    Direct Functional PCA
);


```

### [Dynamic Time Warping](#dynamic-time-warping)

**Syntax:** obj \<< Data Processing( Dynamic Time Warping( Reference( number ) ) )

**Description:** Aligns the output functions using dynamic time warping (DTW). DTW is a function alignment technique that finds an optimal warping to align two or more functions together.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Ethanol ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Dynamic Time Warping( Reference( 1 ) ) )
);


```

### [Exp](#exp)

**Syntax:** obj \<< Data Processing( Exp )

**Description:** Transforms the data by computing the exponential function of the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Exp )
);


```

### [Filter X](#filter-x)

**Syntax:** obj \<< Data Processing( Filter X( [lower, upper] ) )

**Description:** Removes input (X) values that are outside of the specified interval.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Data Processing( Filter X( [5, 50] ) );


```

### [Filter Y](#filter-y)

**Syntax:** obj \<< Data Processing( Filter Y( [lower, upper] ) )

**Description:** Removes output (Y) values outside of the specified interval.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Data Processing( Filter Y( [., 100] ) );


```

### [Fourier Basis](#fourier-basis)

**Syntax:** obj \<< Fourier Basis

**Description:** Fits a penalized B-spline model to the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis
);


```

### [Fourier Basis Model Controls](#fourier-basis-model-controls)

**Syntax:** obj \<< Fourier Basis Model Controls

**Description:** Opens the Model Controls panel prior to fitting a Fourier basis model. You can specify the number of Fourier pairs and the period.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis Model Controls
);


```

### [GCV](#gcv)

**Syntax:** obj \<< Model Name( GCV ); scrobj \<< GCV

**Description:** Specifies the generalized cross validation (GCV) as the model selection criterion for B-Spline, P-Spline, and Fourier Basis models.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( GCV )
);


```

### [Load Targets](#load-targets)

**Syntax:** obj \<< Data Processing( Load Targets( "level" ) )

**Description:** Specifies a target function.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :ID ),
    Data Processing( Load Targets( "Bristol, TN" ) )
);


```

### [Log](#log)

**Syntax:** obj \<< Data Processing( Log )

**Description:** Transforms the data by computing the natural logarithm of the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Air ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Log )
);


```

### [Log X](#log-x)

**Syntax:** obj \<< Data Processing( Log X )

**Description:** Transforms the data by computing the natural logarithm of the input.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Air ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Log X )
);


```

### [Logit](#logit)

**Syntax:** obj \<< Data Processing( Logit )

**Description:** Transforms the data by computing the logit function of the output. The output values must be between 0 and 1.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Range 0 to 1 ),
    Data Processing( Logit )
);


```

### [MSC](#msc)

**Syntax:** obj \<< Data Processing( MSC )

**Description:** Applies the Multiplicative Scatter Correction method to the data. This method fits a simple linear regression for each individual function (level of the ID variable) where the response is the output values for the function and the regressor is the output values for the mean function.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( MSC )
);


```

### [Multivariate Curve Resolution](#multivariate-curve-resolution)

**Syntax:** obj \<< Multivariate Curve Resolution

**Description:** Performs multivariate curve resolution (MCR). This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Negation](#negation)

**Syntax:** obj \<< Data Processing( Negation )

**Description:** Transforms the data by negating the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Negation )
);


```

### [Nonnegative SVD](#nonnegative-svd)

**Syntax:** obj \<< Nonnegative SVD

**Description:** Performs a nonnegative singular value decomposition (SVD) on the stacked matrix of functions. A nonnegative SVD constrains the matrix decomposition so that the scores and loadings are greater than or equal to zero.

**JMP Version Added:** 18

### [P Splines](#p-splines)

**Syntax:** obj \<< P Splines

**Description:** Fits a penalized B-spline model to the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    P Splines
);


```

### [P Splines Model Controls](#p-splines-model-controls)

**Syntax:** obj \<< P Splines Model Controls

**Description:** Opens the Model Controls panel prior to fitting a P-Spline model. You can specify the number of knots and the spline degree.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    P Splines Model Controls
);


```

### [Parametric Save Baselines](#parametric-save-baselines)

**Syntax:** obj \<< Parametric Save Baselines

**JMP Version Added:** 19

### [Parametric Save Corrected](#parametric-save-corrected)

**Syntax:** obj \<< Parametric Save Corrected

**JMP Version Added:** 19

### [Peak Finding](#peak-finding)

**Syntax:** obj \<< Peak Finding

**Description:** Finds and summarizes peaks either directly or with a specified parametric model.

**JMP Version Added:** 17

### [Penalized Nonnegative SVD](#penalized-nonnegative-svd)

**Syntax:** obj \<< Penalized Nonnegative SVD

**Description:** Performs penalized nonnegative SVD to construct functional PCA. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Penalized SVD](#penalized-svd)

**Syntax:** obj \<< Penalized SVD

**Description:** Performs Penalized SVD to construct functional PCA. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Plot Mean Function](#plot-mean-function)

**Syntax:** obj \<< Plot Mean Function( state=0|1 )

**Description:** Shows or hides the Mean Function plot in the Summaries report. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Time Series/Raleigh Temps.jmp" );
obj = dt << Functional Data Explorer( Y( :Temperature ), X( :Month ), ID( :Year ) );
Wait( 1 );
obj << Plot Mean Function( 0 );


```

### [Plot Median Function](#plot-median-function)

**Syntax:** obj \<< Plot Median Function( state=0|1 )

**Description:** Shows or hides the Median Function plot in the Summaries report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Time Series/Raleigh Temps.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Temperature ),
    X( :Month ),
    ID( :Year ),
    Plot Median Function( 1 )
);


```

### [Plot Standard Deviation Function](#plot-standard-deviation-function)

**Syntax:** obj \<< Plot Standard Deviation Function( state=0|1 )

**Description:** Shows or hides the Standard Deviation Function plot in the Summaries report. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Time Series/Raleigh Temps.jmp" );
obj = dt << Functional Data Explorer( Y( :Temperature ), X( :Month ), ID( :Year ) );
Wait( 1 );
obj << Plot Standard Deviation Function( 0 );


```

### [Range 0 to 1](#range-0-to-1)

**Syntax:** obj \<< Data Processing( Range 0 to 1 )

**Description:** Scales the output to lie within the range 0 to 1.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Range 0 to 1 )
);


```

### [Reduce](#reduce)

**Syntax:** obj \<< Data Processing( Reduce( Grid( number ) ) ); obj \<< Data Processing( Reduce( Bin( number ) ) ); obj \<< Data Processing( Reduce( Thin( number ) ) )

**Description:** Reduces the data over the input (X) with one of a variety of techniques.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Data Processing( Reduce( Thin( 2 ) ) );


```

### [Remove Last Step](#remove-last-step)

**Syntax:** obj \<< Remove Last Step

**JMP Version Added:** 14

### [Remove Selected](#remove-selected)

**Syntax:** obj \<< Data Processing( Remove Selected )

**Description:** Removes the selected values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
dt << Select Where( :STATION == "USW00024024" );
Wait( 1 );
obj << Data Processing( Remove Selected );


```

### [Remove Unselected](#remove-unselected)

**Syntax:** obj \<< Data Processing( Remove Unselected )

**Description:** Removes the unselected values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
dt << Select Where( :STATION != "USW00024024" );
Wait( 1 );
obj << Data Processing( Remove Unselected );


```

### [Remove Value](#remove-value)

**Syntax:** obj \<< Data Processing( Remove Value( number ) )

**Description:** Removes observations that have the specified response value.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
Wait( 1 );
obj << Data Processing( Remove Value( 30 ) );


```

### [Remove Zeros](#remove-zeros)

**Syntax:** obj \<< Data Processing( Remove Zeros )

**Description:** Removes observations that have a response value of zero.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Ethanol ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Remove Zeros )
);


```

### [Row Alignment](#row-alignment)

**Syntax:** obj \<< Data Processing( Row Alignment )

**Description:** Replaces the input values with the row number.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Row Alignment )
);


```

### [SNIP Save Baselines](#snip-save-baselines)

**Syntax:** obj \<< SNIP Save Baselines

**JMP Version Added:** 19

### [SNIP Save Corrected](#snip-save-corrected)

**Syntax:** obj \<< SNIP Save Corrected

**JMP Version Added:** 19

### [SNV](#snv)

**Syntax:** obj \<< Data Processing( SNV )

**Description:** Applies the Standard Normal Variate method to the data. This method standardizes the output by centering and scaling each individual function (level of the ID variable) to have a mean of 0 and a standard deviation of 1.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( SNV )
);


```

### [Save Data](#save-data)

**Syntax:** obj \<< Save Data

**Description:** Saves the processed data to a separate data table, in the Stacked format.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Ethanol, :Temp, :Molasses Feed ),
    X( :Time ),
    ID( :BatchID ),
    B Splines
);
obj << Save Data;


```

### [Save Summaries](#save-summaries)

**Syntax:** obj \<< Save Summaries

**Description:** Saves the model summary statistics of each function (ID) for each output (Y).

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Ethanol, :Temp, :Molasses Feed ),
    X( :Time ),
    ID( :BatchID ),
    B Splines
);
obj << Save Summaries;


```

### [Savitzky-Golay Filter](#savitzky-golay-filter)

**Syntax:** obj \<< Data Processing( "Savitzky-Golay Filter"n )

**Description:** Applies the Savitzky-Golay filter to each function. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( "Savitzky-Golay Filter"n )
);


```

### [Savitzky-Golay First Derivative](#savitzky-golay-first-derivative)

**Syntax:** obj \<< Data Processing( "Savitzky-Golay First Derivative"n )

**Description:** Returns the first derivative from the Savitzky-Golay filter. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( "Savitzky-Golay First Derivative"n )
);


```

### [Savitzky-Golay Second Derivative](#savitzky-golay-second-derivative)

**Syntax:** obj \<< Data Processing( "Savitzky-Golay Second Derivative"n )

**Description:** Returns the second derivative from the Savitzky-Golay filter. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( "Savitzky-Golay Second Derivative"n )
);


```

### [Square](#square)

**Syntax:** obj \<< Data Processing( Square )

**Description:** Transforms the data by computing the square of the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Square )
);


```

### [Square Root](#square-root)

**Syntax:** obj \<< Data Processing( Square Root )

**Description:** Transforms the data by computing the square root of the output. The output values must be nonnegative.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Square Root )
);


```

### [Standardize](#standardize)

**Syntax:** obj \<< Data Processing( Standardize )

**Description:** Standardizes the output by centering and scaling.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Standardize )
);


```

### [Unconstrained MCR](#unconstrained-mcr)

**Syntax:** obj \<< Unconstrained MCR

**Description:** Performs unconstrained multivariate curve resolution (MCR). This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Wavelets](#wavelets)

**Syntax:** obj \<< Wavelets

**Description:** Fits several wavelets models to the data. This option requires that the input data be on an evenly spaced grid. If data are not evenly spaced, a grid is automatically created before the wavelet routine begins.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ), Wavelets );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Functional Data Explorer](#functional-data-explorer)

## [Associated Constructors](#associated-constructors)

### [Functional Data Explorer](#functional-data-explorer_1)

**Syntax:** Functional Data Explorer( Y(column), X(column), ID(column) )

**Description:** Fits functional models using a B-Spline, P-Spline, Fourier, or Wavelets basis model. A functional principal components analysis can be performed on the functional model to extract important features from the data. There is also an option to perform functional principal components analysis directly on the data, without fitting a basis function model first.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Functional Data Explorer(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Functional Data Explorer(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Freq( :_freqcol )
);


```

### [Function](#function)

**Syntax:** obj = Functional Data Explorer(...\<Function( column )>...)

**Description:** Specifies the ID variable, which identifies each individual function.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

### [ID](#id)

**Syntax:** obj = Functional Data Explorer(...\<ID( column )>...)

**Description:** Specifies the ID variable, which identifies each individual function.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

### [Input](#input)

**Syntax:** obj = Functional Data Explorer(...\<Input( column )>...)

**Description:** Specifies the input variable.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

### [Output](#output)

**Syntax:** obj = Functional Data Explorer(...Output( column(s) )...)

**Description:** Specifies the functional process variable. There must be at least two observed output values for each level of the ID variable.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

### [Supplementary](#supplementary)

**Syntax:** obj = Functional Data Explorer(...\<Supplementary( column(s) )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Formulation for Homogeneity DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Homogeneity Grade ),
    X( :T ),
    ID( :Formulation ),
    Z( :Solvent, :Active, :Water ),
    Direct Functional PCA
);


```

### [Validation](#validation)

**Syntax:** obj = Functional Data Explorer(...\<Validation( column )>...)

**Description:** Specifies a numeric column that defines the validation sets. This column should contain at most three distinct values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Validation( :Validation ),
    B Splines
);


```

### [X](#x)

**Syntax:** obj = Functional Data Explorer(...\<X( column )>...)

**Description:** Specifies the input variable.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

### [Y](#y)

**Syntax:** obj = Functional Data Explorer(...Y( column(s) )...)

**Description:** Specifies the functional process variable. There must be at least two observed output values for each level of the ID variable.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );


```

### [Z](#z)

**Syntax:** obj = Functional Data Explorer(...\<Z( column(s) )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Formulation for Homogeneity DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Homogeneity Grade ),
    X( :T ),
    ID( :Formulation ),
    Z( :Solvent, :Active, :Water ),
    Direct Functional PCA
);


```

## [Item Messages](#item-messages)

### [B Splines](#b-splines)

**Syntax:** obj \<< B Splines

**Description:** Fits a B-spline model to the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines
);


```

### [B Splines Model Controls](#b-splines-model-controls)

**Syntax:** obj \<< B Splines Model Controls

**Description:** Opens the Model Controls panel prior to fitting a B-Spline model. You can specify the number of knots and the spline degree.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines Model Controls
);


```

### [Data Processing](#data-processing)

**Syntax:** obj \<< Data Processing( <options> )

**Description:** Specifies Data Processing options that enable you to perform pre-processing steps on the data. The options include cleanup, transformation, alignment, spectral, and target function operations.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Square Root )
);


```

### [Direct Functional PCA](#direct-functional-pca)

**Syntax:** obj \<< Direct Functional PCA

**Description:** Performs Functional PCA directly without fitting a basis function model. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Formulation for Homogeneity DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Homogeneity Grade ),
    X( :T ),
    ID( :Formulation ),
    Z( :Solvent, :Active, :Water ),
    Direct Functional PCA
);


```

### [Fourier Basis](#fourier-basis)

**Syntax:** obj \<< Fourier Basis

**Description:** Fits a penalized B-spline model to the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis
);


```

### [Fourier Basis Model Controls](#fourier-basis-model-controls)

**Syntax:** obj \<< Fourier Basis Model Controls

**Description:** Opens the Model Controls panel prior to fitting a Fourier basis model. You can specify the number of Fourier pairs and the period.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis Model Controls
);


```

### [Multivariate Curve Resolution](#multivariate-curve-resolution)

**Syntax:** obj \<< Multivariate Curve Resolution

**Description:** Performs multivariate curve resolution (MCR). This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Nonnegative SVD](#nonnegative-svd)

**Syntax:** obj \<< Nonnegative SVD

**Description:** Performs a nonnegative singular value decomposition (SVD) on the stacked matrix of functions. A nonnegative SVD constrains the matrix decomposition so that the scores and loadings are greater than or equal to zero.

**JMP Version Added:** 18

### [P Splines](#p-splines)

**Syntax:** obj \<< P Splines

**Description:** Fits a penalized B-spline model to the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    P Splines
);


```

### [P Splines Model Controls](#p-splines-model-controls)

**Syntax:** obj \<< P Splines Model Controls

**Description:** Opens the Model Controls panel prior to fitting a P-Spline model. You can specify the number of knots and the spline degree.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    P Splines Model Controls
);


```

### [Peak Finding](#peak-finding)

**Syntax:** obj \<< Peak Finding

**Description:** Finds and summarizes peaks either directly or with a specified parametric model.

**JMP Version Added:** 17

### [Penalized Nonnegative SVD](#penalized-nonnegative-svd)

**Syntax:** obj \<< Penalized Nonnegative SVD

**Description:** Performs penalized nonnegative SVD to construct functional PCA. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Penalized SVD](#penalized-svd)

**Syntax:** obj \<< Penalized SVD

**Description:** Performs Penalized SVD to construct functional PCA. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Plot Mean Function](#plot-mean-function)

**Syntax:** obj \<< Plot Mean Function( state=0|1 )

**Description:** Shows or hides the Mean Function plot in the Summaries report. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Time Series/Raleigh Temps.jmp" );
obj = dt << Functional Data Explorer( Y( :Temperature ), X( :Month ), ID( :Year ) );
Wait( 1 );
obj << Plot Mean Function( 0 );


```

### [Plot Median Function](#plot-median-function)

**Syntax:** obj \<< Plot Median Function( state=0|1 )

**Description:** Shows or hides the Median Function plot in the Summaries report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Time Series/Raleigh Temps.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Temperature ),
    X( :Month ),
    ID( :Year ),
    Plot Median Function( 1 )
);


```

### [Plot Standard Deviation Function](#plot-standard-deviation-function)

**Syntax:** obj \<< Plot Standard Deviation Function( state=0|1 )

**Description:** Shows or hides the Standard Deviation Function plot in the Summaries report. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Time Series/Raleigh Temps.jmp" );
obj = dt << Functional Data Explorer( Y( :Temperature ), X( :Month ), ID( :Year ) );
Wait( 1 );
obj << Plot Standard Deviation Function( 0 );


```

### [Save Data](#save-data)

**Syntax:** obj \<< Save Data

**Description:** Saves the processed data to a separate data table, in the Stacked format.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process Row Functions.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( dt << Get Column Group( "Ethanol" ) )
);
obj << Save Data;


```

### [Unconstrained MCR](#unconstrained-mcr)

**Syntax:** obj \<< Unconstrained MCR

**Description:** Performs unconstrained multivariate curve resolution (MCR). This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 18

### [Wavelets](#wavelets)

**Syntax:** obj \<< Wavelets

**Description:** Fits several wavelets models to the data. This option requires that the input data be on an evenly spaced grid. If data are not evenly spaced, a grid is automatically created before the wavelet routine begins.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ), Wavelets );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Functional Data Explorer(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Functional Data Explorer Data Processing](#functional-data-explorer-data-processing)

### [Item Messages](#item-messages_1)

#### [ARWLS Save Baselines](#arwls-save-baselines)

**Syntax:** obj \<< ARWLS Save Baselines

**JMP Version Added:** 19

#### [ARWLS Save Corrected](#arwls-save-corrected)

**Syntax:** obj \<< ARWLS Save Corrected

**JMP Version Added:** 19

#### [Align 0 to 1](#align-0-to-1)

**Syntax:** obj \<< Data Processing( Align 0 to 1 )

**Description:** Aligns the output functions (Y) over the range of the input (X) to be in 0 to 1.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align 0 to 1 )
);


```

#### [Align Maximum](#align-maximum)

**Syntax:** obj \<< Data Processing( Align Maximum )

**Description:** Aligns the output functions (Y) using the observed maximum input value (X).

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align Maximum )
);


```

#### [Align Minimum](#align-minimum)

**Syntax:** obj \<< Data Processing( Align Minimum )

**Description:** Aligns the output functions (Y) using the observed minimum input value (X).

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align Minimum )
);


```

#### [Align by Function](#align-by-function)

**Syntax:** obj \<< Data Processing( Align by Function )

**Description:** Aligns the output functions (Y) so that the range of each function is over the range of the input (X).

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Align by Function )
);


```

#### [Baseline Correction](#baseline-correction)

**Syntax:** obj \<< Baseline Correction

**JMP Version Added:** 19

#### [Center](#center)

**Syntax:** obj \<< Data Processing( Center )

**Description:** Centers the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Center )
);


```

#### [Custom Save Corrected](#custom-save-corrected)

**Syntax:** obj \<< Custom Save Corrected

**JMP Version Added:** 19

#### [Dynamic Time Warping](#dynamic-time-warping)

**Syntax:** obj \<< Data Processing( Dynamic Time Warping( Reference( number ) ) )

**Description:** Aligns the output functions using dynamic time warping (DTW). DTW is a function alignment technique that finds an optimal warping to align two or more functions together.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Ethanol ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Dynamic Time Warping( Reference( 1 ) ) )
);


```

#### [Exp](#exp)

**Syntax:** obj \<< Data Processing( Exp )

**Description:** Transforms the data by computing the exponential function of the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Exp )
);


```

#### [Filter X](#filter-x)

**Syntax:** obj \<< Data Processing( Filter X( [lower, upper] ) )

**Description:** Removes input (X) values that are outside of the specified interval.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Data Processing( Filter X( [5, 50] ) );


```

#### [Filter Y](#filter-y)

**Syntax:** obj \<< Data Processing( Filter Y( [lower, upper] ) )

**Description:** Removes output (Y) values outside of the specified interval.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Data Processing( Filter Y( [., 100] ) );


```

#### [Load Targets](#load-targets)

**Syntax:** obj \<< Data Processing( Load Targets( "level" ) )

**Description:** Specifies a target function.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :ID ),
    Data Processing( Load Targets( "Bristol, TN" ) )
);


```

#### [Log](#log)

**Syntax:** obj \<< Data Processing( Log )

**Description:** Transforms the data by computing the natural logarithm of the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Air ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Log )
);


```

#### [Log X](#log-x)

**Syntax:** obj \<< Data Processing( Log X )

**Description:** Transforms the data by computing the natural logarithm of the input.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Air ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Log X )
);


```

#### [Logit](#logit)

**Syntax:** obj \<< Data Processing( Logit )

**Description:** Transforms the data by computing the logit function of the output. The output values must be between 0 and 1.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Range 0 to 1 ),
    Data Processing( Logit )
);


```

#### [MSC](#msc)

**Syntax:** obj \<< Data Processing( MSC )

**Description:** Applies the Multiplicative Scatter Correction method to the data. This method fits a simple linear regression for each individual function (level of the ID variable) where the response is the output values for the function and the regressor is the output values for the mean function.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( MSC )
);


```

#### [Negation](#negation)

**Syntax:** obj \<< Data Processing( Negation )

**Description:** Transforms the data by negating the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Negation )
);


```

#### [Parametric Save Baselines](#parametric-save-baselines)

**Syntax:** obj \<< Parametric Save Baselines

**JMP Version Added:** 19

#### [Parametric Save Corrected](#parametric-save-corrected)

**Syntax:** obj \<< Parametric Save Corrected

**JMP Version Added:** 19

#### [Range 0 to 1](#range-0-to-1)

**Syntax:** obj \<< Data Processing( Range 0 to 1 )

**Description:** Scales the output to lie within the range 0 to 1.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Range 0 to 1 )
);


```

#### [Reduce](#reduce)

**Syntax:** obj \<< Data Processing( Reduce( Grid( number ) ) ); obj \<< Data Processing( Reduce( Bin( number ) ) ); obj \<< Data Processing( Reduce( Thin( number ) ) )

**Description:** Reduces the data over the input (X) with one of a variety of techniques.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Data Processing( Reduce( Thin( 2 ) ) );


```

#### [Remove Selected](#remove-selected)

**Syntax:** obj \<< Data Processing( Remove Selected )

**Description:** Removes the selected values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
dt << Select Where( :STATION == "USW00024024" );
Wait( 1 );
obj << Data Processing( Remove Selected );


```

#### [Remove Unselected](#remove-unselected)

**Syntax:** obj \<< Data Processing( Remove Unselected )

**Description:** Removes the unselected values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
dt << Select Where( :STATION != "USW00024024" );
Wait( 1 );
obj << Data Processing( Remove Unselected );


```

#### [Remove Value](#remove-value)

**Syntax:** obj \<< Data Processing( Remove Value( number ) )

**Description:** Removes observations that have the specified response value.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
Wait( 1 );
obj << Data Processing( Remove Value( 30 ) );


```

#### [Remove Zeros](#remove-zeros)

**Syntax:** obj \<< Data Processing( Remove Zeros )

**Description:** Removes observations that have a response value of zero.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Ethanol ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Remove Zeros )
);


```

#### [Row Alignment](#row-alignment)

**Syntax:** obj \<< Data Processing( Row Alignment )

**Description:** Replaces the input values with the row number.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Row Alignment )
);


```

#### [SNIP Save Baselines](#snip-save-baselines)

**Syntax:** obj \<< SNIP Save Baselines

**JMP Version Added:** 19

#### [SNIP Save Corrected](#snip-save-corrected)

**Syntax:** obj \<< SNIP Save Corrected

**JMP Version Added:** 19

#### [SNV](#snv)

**Syntax:** obj \<< Data Processing( SNV )

**Description:** Applies the Standard Normal Variate method to the data. This method standardizes the output by centering and scaling each individual function (level of the ID variable) to have a mean of 0 and a standard deviation of 1.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( SNV )
);


```

#### [Savitzky-Golay Filter](#savitzky-golay-filter)

**Syntax:** obj \<< Data Processing( "Savitzky-Golay Filter"n )

**Description:** Applies the Savitzky-Golay filter to each function. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( "Savitzky-Golay Filter"n )
);


```

#### [Savitzky-Golay First Derivative](#savitzky-golay-first-derivative)

**Syntax:** obj \<< Data Processing( "Savitzky-Golay First Derivative"n )

**Description:** Returns the first derivative from the Savitzky-Golay filter. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( "Savitzky-Golay First Derivative"n )
);


```

#### [Savitzky-Golay Second Derivative](#savitzky-golay-second-derivative)

**Syntax:** obj \<< Data Processing( "Savitzky-Golay Second Derivative"n )

**Description:** Returns the second derivative from the Savitzky-Golay filter. This option requires that the input data be on an evenly spaced grid.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Data Processing( "Savitzky-Golay Second Derivative"n )
);


```

#### [Square](#square)

**Syntax:** obj \<< Data Processing( Square )

**Description:** Transforms the data by computing the square of the output.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Square )
);


```

#### [Square Root](#square-root)

**Syntax:** obj \<< Data Processing( Square Root )

**Description:** Transforms the data by computing the square root of the output. The output values must be nonnegative.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    Data Processing( Square Root )
);


```

#### [Standardize](#standardize)

**Syntax:** obj \<< Data Processing( Standardize )

**Description:** Standardizes the output by centering and scaling.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Data Processing( Standardize )
);


```

## [Functional Data Explorer FDOE](#functional-data-explorer-fdoe)

### [Item Messages](#item-messages_2)

#### [Diagnostic Plots](#diagnostic-plots)

**Syntax:** obj\<< Model Name( Functional DOE Analysis( Diagnostic Plots( state=0|1 ) ) ); scrobj \<< Diagnostic Plots( state=0|1 )

**Description:** Shows or hides actual by predicted and residual plots in the Functional DOE Analysis report. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis, Diagnostic Plots( 0 ) )
);
Wait( 2 );
scrobj = Report( obj )["Functional DOE Analysis"] << get scriptable object;
scrobj << Diagnostic Plots( 1 );
Report( obj )["FDOE Diagnostic Plots"] << Close( 0 );


```

#### [Generalized Regression FPC Model](#generalized-regression-fpc-model)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( Generalized Regression FPC Model( FPC Number( number ), commands )))

**Description:** Specifies the settings for the generalized regression model that is created with the Functional DOE Analysis option. Use this command to specify settings that differ from the default settings.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Formulation for Homogeneity DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Homogeneity Grade ),
    X( :T ),
    ID( :Formulation ),
    Z( :Solvent, :Active, :Water ),
    P Splines(
        Functional DOE Analysis(
            Generalized Regression FPC Model(
                FPC Number( 1 ),
                Estimation Method( "Best Subset" ),
                Validation Method( "BIC" )
            ),
            Generalized Regression FPC Model(
                FPC Number( 2 ),
                Estimation Method( "Elastic Net" ),
                Validation Method( "AICc" )
            )
        ),
        Customize Function Summaries( Number of FPCs( 2 ) )
    )
);
Report( obj )["Generalized Regression for FPC Scores"] << Close( 0 );


```

#### [Generalized Regression for FPC Scores](#generalized-regression-for-fpc-scores)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( Generalized Regression for FPC Scores( state=0|1 ) ) ); scrobj \<< Generalized Regression for FPC Scores( state=0|1 )

**Description:** Shows or hides the Generalized Regression reports for each FPC score. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis )
);
Report( obj )["Generalized Regression for FPC Scores"] << Close( 0 );
Wait( 2 );
scrobj = Report( obj )["Functional DOE Analysis"] << get scriptable object;
scrobj << Generalized Regression for FPC Scores( 0 );


```

#### [Profiler](#profiler)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( FDOE Profiler( state=0|1 ) ) ); scrobj \<< FDOE Profiler( state=0|1 )

**Description:** Shows or hides the FDOE Profiler, which enables you to explore how the response changes based on the values of the supplementary variables. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis( FDOE Profiler( 0 ) ) )
);
Report( obj )["Functional PCA"] << Close( 1 );
Report( obj )["Model Selection"] << Close( 1 );
Wait( 2 );
scrobj = Report( obj )["Functional DOE Analysis"] << get scriptable object;
scrobj << FDOE Profiler( 1 );


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( Save Prediction Formula ) ); obj \<< Wavelets( Wavelets DOE Analysis( 1, Save Prediction Formula ) ); scrobj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the current data table. If the original data format is Rows as Functions or Columns as Functions, this option creates a new data table that contains the original data in stacked format and a column for the Prediction Formula.

**JMP Version Added:** 16

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis( Save Prediction Formula ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Wavelets DOE Analysis( 1, Save Prediction Formula ) )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Wavelets DOE Analysis( 1 ) )
);
scrobj = Report( obj )["Wavelets DOE Analysis"] << get scriptable object;
scrobj << Save Prediction Formula;


```

#### [Save Residual Formula](#save-residual-formula)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( Save Residual Formula ) ); obj \<< Wavelets( Wavelets DOE Analysis( 1, Save Residual Formula ) ); scrobj \<< Save Residual Formula

**Description:** Saves the Residual Formula to a new column in the current data table. If the original data format is Rows as Functions or Columns as Functions, this option creates a new data table that contains the original data in stacked format and a column for the Residual Formula.

**JMP Version Added:** 16

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis( Save Residual Formula ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Wavelets DOE Analysis( 1, Save Residual Formula ) )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis )
);
scrobj = Report( obj )["Functional DOE Analysis"] << get scriptable object;
scrobj << Save Residual Formula;


```

## [Functional Data Explorer FPCA](#functional-data-explorer-fpca)

### [Item Messages](#item-messages_3)

#### [Customize Number of FPCs](#customize-number-of-fpcs)

**Syntax:** obj \<< Model Name( Functional PCA( 1, Customize Number of FPCs( number ) ) ); scrobj \<< Customize Number of FPCs( number )

**Description:** Specifies the number of FPC scores to show in the Functional PCA. Specifying the number of FPC scores also updates the Function Summaries report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Functional PCA( 1, Customize Number of FPCs( 3 ) ) ),
    Send to Report(
        Dispatch( {"Fourier Basis on Initial data"}, "Model Selection", OutlineBox,
            {Close( 1 )}
        )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Functional PCA"] << get scriptable object);
scrobj << Customize Number of FPCs( 2 );


```

#### [Diagnostic Plots](#diagnostic-plots_1)

**Syntax:** obj \<< Model Name( Functional PCA( 1, Diagnostic Plots( state=0|1 ) ); scrobj \<< Diagnostic Plots( state=0|1 )

**Description:** Shows or hides the FPCA Diagnostic Plots in the Functional PCA report. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Functional PCA( 1, Diagnostic Plots( 0 ) ) ),
    Send to Report(
        Dispatch( {"Fourier Basis on Initial data"}, "Model Selection", OutlineBox,
            {Close( 1 )}
        )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Functional PCA"] << get scriptable object);
scrobj << Diagnostic Plots( 1 );
Report( obj )["FPCA Diagnostic Plots"] << Close( 0 );


```

#### [FPC Profiler](#fpc-profiler)

**Syntax:** obj \<< Model Name( Functional PCA( 1, FPC Profiler( state=0|1 ) ) ); scrobj \<< FPC Profiler( state=0|1 )

**Description:** Shows or hides a profiler of the FPC scores. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Functional PCA( 1, FPC Profiler( 0 ) ) ),
    Send to Report(
        Dispatch( {"Fourier Basis on Initial data"}, "Model Selection", OutlineBox,
            {Close( 1 )}
        )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Functional PCA"] << get scriptable object);
scrobj << FPC Profiler( 1 );


```

#### [Score Plot](#score-plot)

**Syntax:** obj \<< Model Name( Functional PCA( 1, Score Plot( state=0|1 ) ) ); scrobj \<< Score Plot( state=0|1 )

**Description:** Shows or hides a plot of the FPC scores. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Functional PCA( 1, Score Plot( 0 ) ) ),
    Send to Report(
        Dispatch( {"Fourier Basis on Initial data"}, "Model Selection", OutlineBox,
            {Close( 1 )}
        )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Functional PCA"] << get scriptable object);
scrobj << Score Plot( 1 );


```

## [Functional Data Explorer Model](#functional-data-explorer-model)

### [Item Messages](#item-messages_4)

#### [AICc](#aicc)

**Syntax:** obj \<< Model Name( AICc ); scrobj \<< AICc

**Description:** Specifies the AICc as the model selection criterion for B-Spline, P-Spline, and Fourier Basis models.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines( AICc )
);


```

#### [BIC](#bic)

**Syntax:** obj \<< Model Name( BIC ); scrobj \<< BIC

**Description:** Specifies the BIC as the model selection criterion for B-Spline, P-Spline, and Fourier Basis models.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    P Splines( BIC )
);


```

#### [Basis Function Coefficients](#basis-function-coefficients)

**Syntax:** obj \<< Model Name( Basis Function Coefficients( state=0|1 ) ); scrobj \<< Basis Function Coefficients( state=0|1 )

**Description:** Shows or hides the Basis Function Coefficients report for the corresponding model fit. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Basis Function Coefficients( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["Fourier Basis on Initial data"] << get scriptable object);
scrobj << Basis Function Coefficients( 1 );
Report( obj )["Basis Function Coefficients"] << Close( 0 );


```

#### [Diagnostic Plots](#diagnostic-plots_2)

**Syntax:** obj \<< Model Name( Diagnostic Plots( state=0|1 ) ); scrobj \<< Diagnostic Plots( state=0|1 )

**Description:** Shows or hides the Diagnostic Plots report. This option is not available for Wavelets or Direction Functional PCA models. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
obj = dt << Functional Data Explorer(
    Y( :pH ),
    X( :Time ),
    ID( :BatchID ),
    B Splines( Diagnostic Plots( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["B-Spline on Initial data"] << get scriptable object);
scrobj << Diagnostic Plots( 1 );
Report( obj )["B-Spline Diagnostic Plots"] << Close( 0 );


```

#### [Function Summaries](#function-summaries)

**Syntax:** obj \<< Model Name( Function Summaries( state=0|1 ) ); scrobj \<< Function Summaries( state=0|1 )

**Description:** Shows or hides the Function Summaries report. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Function Summaries( 0 ) )
);
Wait( 1 );
scrobj = (Report( obj )["Fourier Basis on Initial data"] << get scriptable object);
scrobj << Function Summaries( 1 );
Report( obj )["Function Summaries"] << Close( 0 );


```

#### [Functional DOE Analysis](#functional-doe-analysis)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( ... ) ); scrobj \<< Functional DOE Analysis( ... )

**Description:** Launches a Generalized Regression report within the FDE platform. A generalized regression model is fit to each of the FPC score functions using the supplementary variables as model effects.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Formulation for Homogeneity DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :Homogeneity Grade ),
    X( :T ),
    ID( :Formulation ),
    Z( :Solvent, :Active, :Water ),
    P Splines( Functional DOE Analysis )
);


```

#### [Functional PCA](#functional-pca)

**Syntax:** obj \<< Model Name( Functional PCA( state= 0|1 ) ); scrobj \<< Functional PCA( state=0|1 )

**Description:** Shows or hides the Functional PCA report. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer( Y( :TMAX ), X( :Week of Year ), ID( :NAME ) );
obj << Fourier Basis( Functional PCA( 0 ) );
obj << Send to Report(
    Dispatch( {"Fourier Basis on Initial data"}, "Model Selection", OutlineBox,
        {Close( 1 )}
    )
);
Wait( 1 );
scrobj = (Report( obj )["Fourier Basis on Initial data"] << get scriptable object);
scrobj << Functional PCA( 1 );


```

#### [GCV](#gcv)

**Syntax:** obj \<< Model Name( GCV ); scrobj \<< GCV

**Description:** Specifies the generalized cross validation (GCV) as the model selection criterion for B-Spline, P-Spline, and Fourier Basis models.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( GCV )
);


```

#### [Plot Basis](#plot-basis)

**Syntax:** obj \<< Model Name( Plot Basis( state=0|1 ) ); scrobj \<< Plot Basis( state=0|1 )

**Description:** Shows or hides a plot of all the basis functions on one graph. This option is not available for Wavelets or Direct Functional PCA models.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Plot Basis( 1 ) )
);


```

#### [Random Coefficients](#random-coefficients)

**Syntax:** obj \<< Model Name( Random Coefficients( state=0|1 ) ); scrobj \<< Random Coefficients( state=0|1 )

**Description:** Shows or hides the Random Coefficients by Function report. The report contains a table of the estimated random coefficients for each basis function and functional process combination. This option is not available for Wavelets or Direction Functional PCA models. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis( Random Coefficients( 1 ) )
);
Report( obj )["Random Coefficients by Function"] << Close( 0 );


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (Model["B Splines" | "P Splines" | "Fourier Basis" | "Wavelets" | "Direct Functional PCA"] \<< Remove Fit)

**Description:** Removes the specified fit from the report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Fourier Basis,
    B Splines
);
Wait( 2 );
obj << (Model["Fourier Basis"] << Remove Fit);


```

#### [Save Data](#save-data_1)

**Syntax:** obj \<< Model Name( Save Data ); scrobj \<< Save Data

**Description:** Saves the processed data to a new data table. The processed data are saved in the stacked data format.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Fermentation Process Row Functions.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( dt << Get Column Group( "Ethanol" ) ),
    B Splines( Save Data )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets
);
scrobj = (Report( obj )["Wavelets on Initial data"] << get scriptable object);
scrobj << Save Data;


```

#### [Save Script Options](#save-script-options)

**Syntax:** obj \<< Save Script Options( "Save Script Saves Steps"|"Save Script Saves State"="Save Script Saves Steps" )

**Description:** Specifies the type of script that is saved for reproducing the peak finding results. "Save Script Saves Steps" by default.

#### [Wavelets DOE Analysis](#wavelets-doe-analysis)

**Syntax:** obj \<< Wavelets( Wavelets DOE Analysis( state=0|1 ) ); scrobj \<< Wavelets DOE Analysis( state=0|1 )

**Description:** Launches a Generalized Regression report within the FDE platform. Generalized regression models are fit to the wavelet coefficients using the supplementary variables as model effects.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Functional PCA( 0 ), Wavelets DOE Analysis( 1 ) )
);


```

## [Functional Data Explorer Peak Summaries](#functional-data-explorer-peak-summaries)

### [Item Messages](#item-messages_5)

#### [Customize Peak Summaries](#customize-peak-summaries)

**Syntax:** obj \<< Peak Finding( Customize Peak Summaries(stat1(0|1), ..., statN(0|1)) )

**Description:** Customizes the summary statistics displayed in the Function Summaries report.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Peak Finding( Customize Peak Summaries() )
);


```

#### [Save Summaries](#save-summaries)

**Syntax:** obj \<< Peak Finding( Save Summaries )

**Description:** Saves the model summary statistics for each function, including the functional principal component scores.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    Peak Finding( Save Summaries )
);


```

## [Functional Data Explorer Summaries](#functional-data-explorer-summaries)

### [Item Messages](#item-messages_6)

#### [Control Chart Builder](#control-chart-builder)

**Syntax:** obj \<< B Splines( Control Chart Builder ) obj \<< P Splines( Control Chart Builder ) obj \<< Fourier Basis( Control Chart Builder )

**Description:** Analyzes the functional principal components using the Control Chart Builder.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines( Control Chart Builder )
);


```

#### [Customize Function Summaries](#customize-function-summaries)

**Syntax:** obj \<< B Splines( Customize Function Summaries(stat1(0|1), ..., statN(0|1)) ) obj \<< P Splines( Customize Function Summaries(stat1(0|1), ..., statN(0|1)) ) obj \<< Fourier Basis( Customize Function Summaries(stat1(0|1), ..., statN(0|1)) )

**Description:** Customizes the summary statistics displayed in the Function Summaries report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines(
        Customize Function Summaries(
            Number of FPCs( 2 ),
            Mean( 0 ),
            Std Dev( 1 ),
            Integrated Difference( 0 ),
            Median( 1 ),
            Minimum( 1 ),
            Maximum( 1 )
        )
    )
);


```

#### [Save Summaries](#save-summaries_1)

**Syntax:** obj \<< B Splines( Save Summaries ) obj \<< P Splines( Save Summaries ) obj \<< Fourier Basis( Save Summaries )

**Description:** Saves the model summary statistics for each function, including the functional principal component scores.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Functional Data Explorer(
    Y( :TMAX ),
    X( :Week of Year ),
    ID( :NAME ),
    B Splines( Save Summaries )
);


```

## [Functional Data Explorer WDOE](#functional-data-explorer-wdoe)

### [Item Messages](#item-messages_7)

#### [Diagnostic Plots](#diagnostic-plots_3)

**Syntax:** obj \<< Wavelets( Wavelets DOE Analysis( 1, Diagnostic Plots( state=0|1 ) ) ); scrobj \<< Diagnostic Plots( state=0|1 )

**Description:** Shows or hides actual by predicted and residual plots in the Wavelets DOE Analysis report. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Functional PCA( 0 ), Wavelets DOE Analysis( 1, Diagnostic Plots( 0 ) ) )
);
Wait( 1 );
scrobj = (Report( obj )["Wavelets DOE Analysis"] << get scriptable object);
scrobj << Diagnostic Plots( 1 );
Report( obj )["FDOE Diagnostic Plots"] << Close( 0 );


```

#### [FDOE Profiler](#fdoe-profiler)

**Syntax:** obj \<< Wavelets( Wavelets DOE Analysis( 1, FDOE Profiler( state=0|1 ) ) ); scrobj \<< FDOE Profiler( state=0|1 )

**Description:** Shows or hides the FDOE Profiler, which enables you to explore how the response changes based on the values of the supplementary variables. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Functional PCA( 0 ), Wavelets DOE Analysis( 1, FDOE Profiler( 0 ) ) )
);
Wait( 1 );
scrobj = (Report( obj )["Wavelets DOE Analysis"] << get scriptable object);
scrobj << FDOE Profiler( 1 );


```

#### [Generalized Regression for Wavelets Coefficients](#generalized-regression-for-wavelets-coefficients)

**Syntax:** obj \<< Wavelets( Wavelets DOE Analysis( 1, Generalized Regression for Wavelets Coefficients( state=0|1 ) ) ); scrobj \<< Generalized Regression for Wavelets Coefficients( state=0|1 )

**Description:** Shows or hides the Generalized Regression reports for each wavelet coefficient. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets(
        Functional PCA( 0 ),
        Wavelets DOE Analysis( 1, Generalized Regression for Wavelets Coefficients( 0 ) )
    )
);
Wait( 1 );
scrobj = (Report( obj )["Wavelets DOE Analysis"] << get scriptable object);
scrobj << Generalized Regression for Wavelets Coefficients( 1 );
Report( obj )["Generalized Regression for Wavelets Coefficients"] << Close( 0 );


```

#### [Save Prediction Formula](#save-prediction-formula_1)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( Save Prediction Formula ) ); obj \<< Wavelets( Wavelets DOE Analysis( 1, Save Prediction Formula ) ); scrobj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the current data table. If the original data format is Rows as Functions or Columns as Functions, this option creates a new data table that contains the original data in stacked format and a column for the Prediction Formula.

**JMP Version Added:** 16

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis( Save Prediction Formula ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Wavelets DOE Analysis( 1, Save Prediction Formula ) )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Wavelets DOE Analysis( 1 ) )
);
scrobj = Report( obj )["Wavelets DOE Analysis"] << get scriptable object;
scrobj << Save Prediction Formula;


```

#### [Save Residual Formula](#save-residual-formula_1)

**Syntax:** obj \<< Model Name( Functional DOE Analysis( Save Residual Formula ) ); obj \<< Wavelets( Wavelets DOE Analysis( 1, Save Residual Formula ) ); scrobj \<< Save Residual Formula

**Description:** Saves the Residual Formula to a new column in the current data table. If the original data format is Rows as Functions or Columns as Functions, this option creates a new data table that contains the original data in stacked format and a column for the Residual Formula.

**JMP Version Added:** 16

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis( Save Residual Formula ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Functional Data/NMR DoE.jmp" );
obj = dt << Functional Data Explorer(
    Data Format( Row ),
    Y( Column Group( "NMR Spectra" ) ),
    ID( :NMR ID ),
    Z( :Propanol, :Butanol, :Pentanol ),
    Wavelets( Wavelets DOE Analysis( 1, Save Residual Formula ) )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Mill DOE.jmp" );
obj = dt << Functional Data Explorer(
    Y( :"Size/nm"n ),
    X( :Time ),
    ID( :Batch ),
    Z( :"%Beads"n, :"%Strength"n, :"Flow(g/min)"n ),
    B Splines( Functional DOE Analysis )
);
scrobj = Report( obj )["Functional DOE Analysis"] << get scriptable object;
scrobj << Save Residual Formula;


```

# [Gaussian Process](#gaussian-process)

## [Associated Constructors](#associated-constructors)

### [Gaussian Process](#gaussian-process_1)

**Syntax:** Gaussian Process( Y( column ), X( columns ) )

**Description:** Models the relationship between a continuous response and one or more continuous predictors as a spline with interpolation.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );


```

## [Item Messages](#item-messages)

### [Block Size](#block-size)

**Syntax:** obj \<< Block Size( number )

**Description:** Sets the number of observations to place in each block for Fast GASP.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ), Fast GASP( 1 ), Block Size( 32 ) );


```

### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the Contour Profiler.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Contour Profiler( 1 );


```

### [Estimate Nugget](#estimate-nugget)

**Syntax:** obj \<< Estimate Nugget( state=0|1 )

**Description:** Introduces a ridge parameter into the estimation procedure. This smooths over the noise instead of perfectly interpolating.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ), Estimate Nugget( 1 ) );


```

### [Fast GASP](#fast-gasp)

**Syntax:** obj \<< Fast GASP( state=0|1 )

**Description:** The Fast GASP option allows for fitting models with thousands of rows.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ), Fast GASP( 1 ) );


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Profiler( 1 );


```

### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Builds the prediction formula and publishes it as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Publish Prediction Formula;


```

### [Publish Variance Formula](#publish-variance-formula)

**Syntax:** obj \<< Publish Variance Formula

**Description:** Builds the variance formula and publishes it as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Publish Variance Formula;


```

### [Save Jackknife Predicted Values](#save-jackknife-predicted-values)

**Syntax:** obj \<< Save Jackknife Predicted Values

**Description:** Saves the jackknife predicted values to a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Jackknife Predicted Values;


```

### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the prediction formula to a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Prediction Formula;


```

### [Save Variance Formula](#save-variance-formula)

**Syntax:** obj \<< Save Variance Formula

**Description:** Saves the variance formula to a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Variance Formula;


```

### [Set Correlation Function](#set-correlation-function)

**Syntax:** obj \<< Set Correlation Function( structure=Gaussian )

**Description:** Sets the correlation structure used in the model.

Gaussian restricts the correlation between two responses to be nonzero.

Cubic allows the correlations to be zero for points far enough apart. "Gaussian" by default.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    Set Correlation Function( "Gaussian" )
);


```

### [Set Minimum Theta](#set-minimum-theta)

**Syntax:** obj \<< Set Minimum Theta( number )

**Description:** Sets the minimum theta value used in the fitted model.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ), Set Minimum Theta( 0.5 ) );


```

### [Set Nugget](#set-nugget)

**Syntax:** obj \<< Set Nugget( number )

**Description:** Sets the size of the nugget as a constant used as a ridge parameter into the estimation procedure.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ), Set Nugget( 0.2 ) );


```

### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides the Surface Profiler.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Surface Profiler( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/2D Gaussian Process Example.jmp" );
obj = dt << Gaussian Process( Y( :Y ), X( :X1, :X2 ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Gaussian Process(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Graph Builder](#graph-builder)

## [Area Element](#area-element)

### [Associated Constructors](#associated-constructors)

#### [Area Element](#area-element_1)

**Syntax:** Area Element

**Description:** Shows a response summarized by categories.

**100% stacked area chart**

```

Open( "$SAMPLE_DATA/Corn Wheat Soybean Production.jmp" );
// 100% stacked area
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Year ),
        Y( :Commodity Acres Planted ),
        Group X( :State, Show Title( 0 ) ),
        Overlay( :Commodity )
    ),
    Elements( Area( X, Y, Legend( 40 ), Summary Statistic( "% of Factor" ) ) ),
    Local Data Filter(
        Add Filter( columns( :State ), Where( :State == {"IOWA", "NEBRASKA", "OKLAHOMA"} ) )
    ),
    SendToReport(
        Dispatch( {}, "Commodity Acres Planted", ScaleBox,
            {Format( "Percent", 13, 0 ), Max( 1 )}
        ),
        Dispatch( {}, "400", LegendBox, {Legend Position( {40, [2, 1, 0, -3, -3, -3]} )} )
    )
);


```

**Overlaid area with fill patterns**

```

Open( "$SAMPLE_DATA/Corn Wheat Soybean Production.jmp" );
// overlaid area with fill patterns
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Year ),
        Y( :Commodity Acres Planted ),
        Group X( :State, Show Title( 0 ) ),
        Overlay( :Commodity )
    ),
    Elements( Area( X, Y, Legend( 40 ), Area Style( "Overlaid" ) ) ),
    Local Data Filter(
        Add Filter( columns( :State ), Where( :State == {"IOWA", "NEBRASKA", "OKLAHOMA"} ) )
    ),
    SendToReport(
        Dispatch( {}, "Commodity Acres Planted", ScaleBox, {Format( "Engineering SI", 13 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                40,
                Properties( 0, {Fill Pattern( "grid dots" )} ),
                Properties( 1, {Fill Pattern( "right slant medium" )} ),
                Properties( 2, {Fill Pattern( "left slant medium" )} )
            )}
        ),
        Dispatch( {}, "400", LegendBox, {Legend Position( {40, [2, 1, 0, -3, -3, -3]} )} )
    )
);


```

**Range area as custom interval around line**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// range area, custom interval, overlaid line, transparency
Graph Builder(
    Transform Column(
        "Quantile...=0.75[height][age]",
        Formula( Col Quantile( :height, 0.75, :age, :"@Exclude"n, :"@Filter"n ) )
    ),
    Transform Column(
        "Quantile...=0.25[height][age]",
        Formula( Col Quantile( :height, 0.25, :age, :"@Exclude"n, :"@Filter"n ) )
    ),
    Show Control Panel( 0 ),
    Variables(
        X( :age ),
        Y( :height ),
        Y( :"Quantile...=0.25[height][age]"n, Position( 1 ) ),
        Y( :"Quantile...=0.75[height][age]"n, Position( 1 ) )
    ),
    Elements(
        Area( X, Y( 2 ), Y( 3 ), Legend( 5 ), Area Style( "Range" ) ),
        Line( X, Y( 1 ), Legend( 6 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Level Name( 0, "IQR" ),
                Properties( 0, {Transparency( 0.33 )} )
            )}
        ),
        Dispatch( {}, "400", LegendBox, {Set Title( "" )} )
    )
);


```

**Stacked area chart**

```

Open( "$SAMPLE_DATA/Corn Wheat Soybean Production.jmp" );
// stacked area
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Year ),
        Y( :Commodity Acres Planted ),
        Group X( :State, Show Title( 0 ) ),
        Overlay( :Commodity )
    ),
    Elements( Area( X, Y, Legend( 40 ) ) ),
    Local Data Filter(
        Add Filter( columns( :State ), Where( :State == {"IOWA", "NEBRASKA", "OKLAHOMA"} ) )
    ),
    SendToReport(
        Dispatch( {}, "Commodity Acres Planted", ScaleBox, {Format( "Engineering SI", 13 )} ),
        Dispatch( {}, "400", LegendBox, {Legend Position( {40, [2, 1, 0, -3, -3, -3]} )} )
    )
);


```

### [Item Messages](#item-messages)

#### [Area Style](#area-style)

**Syntax:** obj \<< Area Style( "Stacked"|"Overlaid"|"Range"|"Stacked Range" )

#### [Connection](#connection)

**Syntax:** obj \<< Connection( "Line"|"Arrow"|"Curve"|"Step"|"Centered Step"|"Horizontal"|"Vertical" )

#### [Error Interval](#error-interval)

**Syntax:** obj \<< Error Interval( "Auto"|"None"|"Range"|"Interquartile Range"|"Standard Error"|"Standard Deviation"|"Confidence Interval"|"Median Absolute Deviation"|"Custom Interval"|"Two-way Interval" )

#### [Interval Style](#interval-style)

**Syntax:** obj \<< Interval Style( "Error Bar"|"Band"|"Hash Band"|"Arrow" )

#### [Missing Factors](#missing-factors)

**Syntax:** obj \<< Missing Factors( "Skip"|"Treat as Missing"|"Treat as Zero" )

**Description:** How to show connections that span missing factor levels

**JMP Version Added:** 15

#### [Missing Values](#missing-values)

**Syntax:** obj \<< Missing Values( "Connect Through"|"Connect Faded"|"Connect Dashed"|"No Connection" )

**Description:** How to show connections that span missing values.

#### [Ordering](#ordering)

**Syntax:** obj \<< Ordering( "Auto"|"Row Order"|"Summarized"|"Within Row" )

#### [Response Axis](#response-axis)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Row order](#row-order)

**Syntax:** obj \<< Row order( state=0|1 )

#### [Save Summary Formula](#save-summary-formula)

**Syntax:** obj \<< Save Summary Formula

#### [Smoothness](#smoothness)

**Syntax:** obj \<< Smoothness( number )

#### [Stack Negative](#stack-negative)

**Syntax:** obj \<< Stack Negative( "Overlap"|"Separate Negative"|"Treat as Zero" )

**Description:** Controls how negative data values are handled when stacked.

**JMP Version Added:** 17

#### [Summary Statistic](#summary-statistic)

**Syntax:** obj \<< Summary Statistic( "N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

## [Associated Constructors](#associated-constructors_1)

### [Graph Builder](#graph-builder_1)

**Syntax:** Graph Builder( Variables( X(column ), Y( column ), \<Group X( column )>, \<Group Y( column )>, \<Shape( column )>, \<Color( column )>, \<Overlay( column )>, \<Freq( column )> ), \<Elements(...)> ) )

**Description:** Provides an interactive graphical interface that enables you to explore your data. You can drag columns into graph zones to create a variety of graphs including scatterplots, contour plots, bar charts, area charts, box plots, histograms, heat maps, pie charts, treemaps, mosaic plots, and maps.

#### [100% stacked bar chart](#100-stacked-bar-chart)

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// 100% stacked bar chart, custom legend colors
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Age ), Y( :Cholesterol ), Overlay( :Alcohol Use ) ),
    Elements(
        Bar( X, Y, Legend( 55 ), Bar Style( "Stacked" ), Summary Statistic( "% of Factor" ) )
    ),
    SendToReport(
        Dispatch( {}, "Cholesterol", ScaleBox, {Max( 1 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                55,
                Properties( 0, {Fill Color( RGB Color( 0.9, 0.9, 0.9 ) )} ),
                Properties( 1, {Fill Color( RGB Color( 1.0, 0.8, 0.8 ) )} ),
                Properties( 2, {Fill Color( RGB Color( 1.0, 0.6, 0.6 ) )} ),
                Properties( 3, {Fill Color( RGB Color( 1.0, 0.3, 0.3 ) )} )
            )}
        )
    )
);


```

#### [Arrow lines, one per row](#arrow-lines-one-per-row)

```

Open( "$SAMPLE_DATA/Cholesterol.jmp" );
// arrow lines, one per row
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :April AM ),
        X( :April PM, Position( 1 ) ),
        Y( :June AM ),
        Y( :June PM, Position( 1 ) ),
        Overlay( :treatment )
    ),
    Elements(
        Line(
            X( 1 ),
            X( 2 ),
            Y( 1 ),
            Y( 2 ),
            Legend( 8 ),
            Ordering( "Within Row" ),
            Connection( "Arrow" )
        )
    )
);


```

#### [Axis summary table](#axis-summary-table)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// caption axis table
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :sex ), Y( :height ) ),
    Elements(
        Bar( X, Y, Legend( 4 ) ),
        Caption Box(
            X,
            Y,
            Legend( 5 ),
            Summary Statistic( "Mean" ),
            Summary Statistic 2( "N" ),
            Location( "Axis Table" )
        )
    )
);


```

#### [Bar chart and smooth trend line combination](#bar-chart-and-smooth-trend-line-combination)

```

Open( "$SAMPLE_DATA/Spring.jmp" );
// bar chart and smooth trend line combination, left and right y axes
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :April ), Y( :Temp ), Y( :Precip, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 12 ) ),
        Smoother( X, Y( 1 ), Legend( 13 ) ),
        Bar( X, Y( 2 ), Legend( 16 ) )
    ),
    SendToReport(
        Dispatch( {}, "Precip", ScaleBox,
            {Format( "Best", 12 ), Max( 5 ), Inc( 1 ), Minor Ticks( 1 )}
        )
    )
);


```

#### [Binomial proportion confidence interval](#binomial-proportion-confidence-interval)

```

Open( "$SAMPLE_DATA/Bands Data.jmp" );
// binomial proportion confidence interval
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Show Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables( X( :customer ), Y( :Banding? ) ),
    Elements(
        Points( X, Y, Legend( 3 ) ),
        Line Of Fit( X, Y, Legend( 4 ), Means and Std Devs( 1 ) )
    ),
    Local Data Filter(
        Add Filter(
            columns( :customer ),
            Where( :customer == {"MODMAT", "REI", "ROSES", "SHEPLERS", "TARGET"} )
        )
    ),
    SendToReport(
        Dispatch( {}, "Banding?", ScaleBox,
            {Min( -0.07 ), Max( 1.07 ), Label Row( Show Major Grid( 1 ) )}
        )
    )
);


```

#### [Bubble chart with overlaid curves](#bubble-chart-with-overlaid-curves)

```

Open( "$SAMPLE_DATA/SATByYear.jmp" );
// Smooth trend line, variable dot size, overlaid y variables, bubble chart. data filter
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :"% Taking (2004)"n ),
        Y( :SAT Verbal ),
        Y( :SAT Math, Position( 1 ) ),
        Size( :Population )
    ),
    Elements(
        Points( X, Y( 1 ), Y( 2 ), Legend( 7 ) ),
        Smoother( X, Y( 1 ), Y( 2 ), Legend( 8 ), Lambda( 0.45 ) )
    ),
    Local Data Filter( Add Filter( columns( :Year ), Where( :Year == 2004 ) ) ),
    SendToReport(
        Dispatch( {}, "% Taking (2004)", ScaleBox, {Format( "Percent", 12, 0 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 7, Properties( 0, {Marker Size( 6 )} ) )}
        )
    )
);


```

#### [Connected lines with overlaid dots](#connected-lines-with-overlaid-dots)

```

Open( "$SAMPLE_DATA/Time Series/M3C Quarterly Wide Format.jmp" );
// connected lines with overlaid dots, custom markers, nested date axis
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Time ), Y( :N 646 ), Y( :N 647, Position( 1 ) ) ),
    Elements(
        Line( X, Y( 1 ), Y( 2 ), Legend( 10 ) ),
        Points( X, Y( 1 ), Y( 2 ), Legend( 11 ) )
    ),
    SendToReport(
        Dispatch( {}, "Time", ScaleBox,
            {Min( 2515958948 ), Max( 2872394250 ), Interval( "Quarter" ), Inc( 1 ),
            Minor Ticks( 0 ), Label Row Nesting( 2 ), Label Row( 1, Set Font Size( 12 ) )}
        ),
        Dispatch( {}, "N 646", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                10,
                Properties( 0, {Line Label Properties( {Last Label( 1 )} )} ),
                Properties( 1, {Line Label Properties( {Last Label( 1 )} )} )
            ), Legend Model(
                11,
                Base( 0, 0, 0, Item ID( "N 646", 1 ) ),
                Base( 1, 0, 1, Item ID( "N 647", 1 ) ),
                Properties( 0, {Marker( "FilledCircle" )} ),
                Properties( 1, {Marker( "Filled Up Triangle" )} )
            )}
        ),
        Dispatch( {}, "Graph Builder", FrameBox,
            {DispatchSeg(
                Line Seg( "Line (N 646)" ),
                Label Offset( "Last", 45, {2843799627.0183, 6317.56810988166} )
            ), DispatchSeg(
                Line Seg( "Line (N 647)" ),
                Label Offset( "Last", 45, {2857099451.70628, 4518.71614237549} )
            )}
        )
    )
);


```

#### [Contour plot and scatter plot points](#contour-plot-and-scatter-plot-points)

```

Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
// contour plot and scatter plot points, smoothing, alpha shapes for non-convex hull
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Labor ), Y( :Capital ), Color( :Difference ) ),
    Elements(
        Contour(
            X,
            Y,
            Legend( 9 ),
            Boundary( 0 ),
            Number of Levels( 7 ),
            Alpha( 5 ),
            Smoothness( 0.2 )
        ),
        Points( X, Y, Color( 0 ), Legend( 10 ) )
    )
);


```

#### [Coplot-style trellis grouping](#coplot-style-trellis-grouping)

```

Open( "$SAMPLE_DATA/Design Experiment/Algorithm Data.jmp" );
// coplot style grouping using continuous grouping variables, smoother and scatter plot
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Alpha, Levels( 2 ) ),
        Y( :CPU Time ),
        Group X( :Beta, Levels( 2 ) ),
        Group Y( :Gamma, Levels( 2 ) ),
        Overlay( :Algorithm )
    ),
    Elements( Points( X, Y, Legend( 29 ) ), Smoother( X, Y, Legend( 30 ), Lambda( 0.25 ) ) )
);


```

#### [Independent charts using BY variable](#independent-charts-using-by-variable)

```

Open( "$SAMPLE_DATA/Financial.jmp" );
// by variable creates multiple Graph Builder instances
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :"Assets($Mil.)"n ), Y( :"Stockholder's Eq($Mil.)"n ), ),
    Elements( Points( X, Y, Legend( 17 ) ), Smoother( X, Y, Legend( 18 ) ) ),
    By( :Type )
);


```

#### [Left and right y axes](#left-and-right-y-axes)

```

Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
// left and right y axes sharing a graph, overlaid lines
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Time ), Y( :pH ), Y( :Tank Level, Position( 1 ), Side( "Right" ) ) ),
    Elements( Line( X, Y( 1 ), Legend( 41 ) ), Line( X, Y( 2 ), Legend( 46 ) ) ),
    SendToReport( Dispatch( {}, "Time", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ) )
);


```

#### [Line with custom band interval](#line-with-custom-band-interval)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// range area, custom interval, overlaid line, transparency
Graph Builder(
    Transform Column(
        "Quantile...=0.75[height][age]",
        Formula( Col Quantile( :height, 0.75, :age, :"@Exclude"n, :"@Filter"n ) )
    ),
    Transform Column(
        "Quantile...=0.25[height][age]",
        Formula( Col Quantile( :height, 0.25, :age, :"@Exclude"n, :"@Filter"n ) )
    ),
    Show Control Panel( 0 ),
    Variables(
        X( :age ),
        Y( :height ),
        Y( :"Quantile...=0.25[height][age]"n, Position( 1 ) ),
        Y( :"Quantile...=0.75[height][age]"n, Position( 1 ) )
    ),
    Elements(
        Area( X, Y( 2 ), Y( 3 ), Legend( 5 ), Area Style( "Range" ) ),
        Line( X, Y( 1 ), Legend( 6 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Level Name( 0, "IQR" ),
                Properties( 0, {Transparency( 0.33 )} )
            )}
        ),
        Dispatch( {}, "400", LegendBox, {Set Title( "" )} )
    )
);


```

#### [Linear regression panels](#linear-regression-panels)

```

Open( "$SAMPLE_DATA/Financial.jmp" );
// line of fit, regression, small multiples, custom group color, custom graph spacing
Graph Builder(
    Show Control Panel( 0 ),
    Grid Color( "Medium Light Gray" ),
    Grid Transparency( 0.25 ),
    Title Fill Color( "Medium Light Gray" ),
    Title Frame Color( "Medium Light Gray" ),
    Level Fill Color( {217, 217, 217} ),
    Level Frame Color( "Medium Light Gray" ),
    Level Spacing Color( "Medium Light Gray" ),
    Graph Spacing( 10 ),
    Variables( X( :"Assets($Mil.)"n ), Y( :"Stockholder's Eq($Mil.)"n ), Wrap( :Type ) ),
    Elements( Points( X, Y, Legend( 17 ) ), Line Of Fit( X, Y, Legend( 19 ) ) ),
    Local Data Filter(
        Add Filter( columns( :"Assets($Mil.)"n ), Where( :"Assets($Mil.)"n <= 60941 ) )
    )
);


```

#### [Mediterranean equal-area choropleth](#mediterranean-equal-area-choropleth)

```

Open( "$SAMPLE_DATA/World Demographics.jmp" );
// Mediterranean map, choropleth, equal area projection, grid lines
Graph Builder(
    Size( 1094, 586 ),
    Show Control Panel( 0 ),
    Variables( Color( :Total Median Age ), Shape( :Territory ) ),
    Elements( Map Shapes( Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "", ScaleBox,
            {Format( "Longitude DDD", "PUNDIR", 16 ), Min( -14.2917884823647 ),
            Max( 64.9684846475565 ), Inc( 20 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "", ScaleBox( 2 ),
            {Format( "Latitude DDD", "PUNDIR", 16 ), Min( 21.8020806509188 ),
            Max( 61.3932495299748 ), Inc( 10 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        )
    )
);


```

#### [Multiple x axes](#multiple-x-axes)

```

Open( "$SAMPLE_DATA/Design Experiment/Algorithm Data.jmp" );
// mutiple x variables in separate panels, smoother with confidence intervals and scatter plot
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Alpha ), X( :Beta ), X( :Gamma ), Y( :CPU Time ), Overlay( :Algorithm ) ),
    Elements(
        Position( 1, 1 ),
        Points( X, Y, Legend( 39 ) ),
        Smoother( X, Y, Legend( 40 ), Lambda( 1.5 ), Confidence of Fit( 1 ) )
    ),
    Elements(
        Position( 2, 1 ),
        Points( X, Y, Legend( 41 ) ),
        Smoother( X, Y, Legend( 42 ), Lambda( 1.5 ), Confidence of Fit( 1 ) )
    ),
    Elements(
        Position( 3, 1 ),
        Points( X, Y, Legend( 43 ) ),
        Smoother( X, Y, Legend( 44 ), Lambda( 1.5 ), Confidence of Fit( 1 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 40, Properties( 2, {Line Color( RGB Color( 0.4, 0.4, 0.4 ) )} ) )}
        )
    )
);


```

#### [Napoleon's March flow diagram](#napoleons-march-flow-diagram)

```

Open( "$SAMPLE_DATA/Napoleons March.jmp" );
// flow diagram
Graph Builder(
    Show Control Panel( 0 ),
    Show X Axis( 0 ),
    Show Y Axis( 0 ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables(
        X( :Longitude ),
        Y( :Latitude ),
        Overlay( :Group ),
        Color( :Direction ),
        Size( :Army Size )
    ),
    Elements(
        Line( X, Y, Legend( 3 ), Ordering( "Row Order" ), Missing Values( "No Connection" ) )
    ),
    SendToReport(
        Dispatch( {}, "Longitude", ScaleBox,
            {Min( 26.71 ), Max( 34.9 ), Inc( 2.5 ), Minor Ticks( 0 ),
            Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "Latitude", ScaleBox,
            {Min( 53.32 ), Max( 56.61 ), Inc( 0.5 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                3,
                Properties( 0, {Line Width( 10 )} ),
                Properties( 1, {RGB Color( 1, 0.69, 0.49 )} ),
                Properties( 2, {RGB Color( 0.47, 0.47, 0.47 )} )
            )}
        ),
        Dispatch( {}, "graph title", TextEditBox,
            {Set Text( "Napoleon's March to Moscow" )}
        ),
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Images( "Detailed Earth", Transparency( 0.75 ) ) )}
        )
    )
);


```

#### [Overlaid bivariate kernel density contours](#overlaid-bivariate-kernel-density-contours)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// overlaid bivariate kernel density contour
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Culmen Depth ), Y( :Culmen Length ), Overlay( :Species ) ),
    Elements(
        Contour( X, Y, Legend( 6 ), Line( 1 ), Number of Levels( 5 ), Smoothness( 0.2174 ) )
    )
);


```

#### [Overlaid empirical cumulative distribution function curves](#overlaid-empirical-cumulative-distribution-function-curves)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// CDF, empirical cumulative distribution function
Graph Builder(
    Transform Column(
        "Rank[Culmen Length]@Overlay",
        Formula(
            Col Rank( :Culmen Length, :"@Exclude"n, :"@Filter"n, :"@Graph"n, :"@Overlay"n )
             / Col Number(
                :Culmen Length,
                :"@Exclude"n,
                :"@Filter"n,
                :"@Graph"n,
                :"@Overlay"n
            )
        )
    ),
    Show Control Panel( 0 ),
    Legend Position( "Inside Bottom Right" ),
    Show Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables(
        X( :Culmen Length ),
        Y( :"Rank[Culmen Length]@Overlay"n ),
        Overlay( :Species )
    ),
    Elements( Line( X, Y, Legend( 15 ), Connection( "Step" ) ) ),
    SendToReport(
        Dispatch( {}, "Rank[Culmen Length]@Overlay", ScaleBox, {Max( 1.0117745954803 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                15,
                Level Name( 0, "Adelie" ),
                Level Name( 1, "Chinstrap" ),
                Level Name( 2, "Gentoo" )
            )}
        )
    )
);


```

#### [Panels with unaligned y axes](#panels-with-unaligned-y-axes)

```

Open( "$SAMPLE_DATA/US Regional Population.jmp" );
// panels with unaligned y axes
Graph Builder(
    Transform Column( "Transform[Year]", Continuous, Formula( Num( :Year ) ) ),
    Show Control Panel( 0 ),
    Extend Axis to Zero( 10 ),
    Link Page Axes( "X Only" ),
    Replicate Linked Page Axes( 0 ),
    Variables(
        X( :"Transform[Year]"n ),
        Y( :Population ),
        Page( :Region, Levels per Row( 3 ) )
    ),
    Elements( Points( X, Y, Legend( 3 ) ), Smoother( X, Y, Legend( 4 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :Region ),
            Where(
                :Region == {"AR,LA,OK,TX", "Great Lakes", "KY,TN,AL,MS", "Midwest",
                "Mountain", "New England", "NY,NJ,PA", "Pacific", "South Atlantic"}
            )
        )
    ),
    SendToReport(
        Dispatch( {}, "Population", ScaleBox, {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 2 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 3 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 4 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 5 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 6 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 7 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 8 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 9 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Population", ScaleBox( 10 ), {Format( "Engineering SI", 10 )} ),
        Dispatch( {}, "Transform[Year]", TextEditBox, {Set Text( "Year" )} ),
        Dispatch( {}, "Transform[Year]", Text Edit Box( 2 ), {Set Text( "Year" )} ),
        Dispatch( {}, "Transform[Year]", Text Edit Box( 3 ), {Set Text( "Year" )} )
    )
);


```

#### [Parallel y axes, overlaid lines](#parallel-y-axes-overlaid-lines)

```

Open( "$SAMPLE_DATA/Functional Data/Fermentation Process.jmp" );
// parallel y axes, multiple y scales sharing a graph, overlaid lines
Graph Builder(
    Show Control Panel( 0 ),
    Parallel Axes( "Y Only" ),
    Variables(
        X( :Time ),
        Y( :Temp ),
        Y( :NH3 Feed ),
        Y( :Air ),
        Y( :Tank Level ),
        Y( :pH )
    ),
    Elements( Position( 1, 1 ), Line( X, Y, Legend( 37 ) ) ),
    Elements( Position( 1, 2 ), Line( X, Y, Legend( 39 ) ) ),
    Elements( Position( 1, 3 ), Line( X, Y, Legend( 40 ) ) ),
    Elements( Position( 1, 4 ), Line( X, Y, Legend( 41 ) ) ),
    Elements( Position( 1, 5 ), Line( X, Y, Legend( 42 ) ) ),
    SendToReport( Dispatch( {}, "Time", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ) )
);


```

#### [Points and smoother](#points-and-smoother)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);


```

#### [Scatter plot with marginal box plots](#scatter-plot-with-marginal-box-plots)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// scatter plot with marginal box plots, custom graph sizes
Graph Builder(
    Transform Column( "dummy1", Nominal, Formula( 1 ) ),
    Transform Column( "dummy2", Nominal, Formula( 1 ) ),
    Show Control Panel( 0 ),
    Variables(
        X( :Delta 13 C ),
        X( :dummy1 ),
        Y( :dummy2 ),
        Y( :Delta 15 N ),
        Color( :Sex ),
        Size( :Body Mass )
    ),
    Relative Sizes( "X", [100 10] ),
    Relative Sizes( "Y", [10 100] ),
    Elements( Position( 1, 1 ), Box Plot( X, Y, Color( 0 ), Size( 0 ), Legend( 12 ) ) ),
    Elements( Position( 1, 2 ), Points( X, Y, Legend( 4 ) ) ),
    Elements( Position( 2, 1 ) ),
    Elements( Position( 2, 2 ), Box Plot( X, Y, Color( 0 ), Size( 0 ), Legend( 13 ) ) ),
    SendToReport(
        Dispatch( {}, "dummy1", ScaleBox, {Label Row( Show Major Labels( 0 ) )} ),
        Dispatch( {}, "dummy2", ScaleBox, {Label Row( Show Major Labels( 0 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                4,
                Properties( 1, {Transparency( 0.75 )} ),
                Properties( 2, {Transparency( 0.75 )} )
            )}
        ),
        Dispatch( {}, "dummy1", TextEditBox, {Set Text( "" )} ),
        Dispatch( {}, "dummy2", TextEditBox, {Set Text( "" )} ),
        Dispatch( {}, "400", LegendBox,
            {Legend Position( {12, [1, -3], 4, [0, 3, 4], 13, [2, -3]} )}
        )
    )
);


```

#### [Variability chart](#variability-chart)

```

Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
// variability chart, mean and range interval, nested axis
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Operator ), X( :Part, Position( 1 ) ), Y( :Y ) ),
    Elements(
        Points(
            X( 1 ),
            X( 2 ),
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Range" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Operator", ScaleBox, {Label Row( 2, Show Major Grid( 1 ) )} )
    )
);


```

#### [Violin plots with quartiles](#violin-plots-with-quartiles)

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// violin plots, overlaid median line and quartile intervals
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ) ),
    Elements(
        Contour( X, Y, Legend( 3 ) ),
        Bar(
            X,
            Y,
            Legend( 4 ),
            Bar Style( "Float" ),
            Summary Statistic( "Median" ),
            Error Interval( "Interquartile Range" )
        )
    )
);


```

#### [Wafer map](#wafer-map)

```

Open( "$SAMPLE_DATA/Wafer Stacked.jmp" );
// wafer map, heat map, trellis, wrap arrangement
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :X_Die ), Y( :Y_Die ), Wrap( :Wafer ), Color( :Defects ) ),
    Elements( Heatmap( X, Y, Legend( 8 ) ) ),
    SendToReport(
        Dispatch( {}, "X_Die", ScaleBox, {Minor Ticks( 9 )} ),
        Dispatch( {}, "Y_Die", ScaleBox, {Minor Ticks( 9 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                8,
                Properties( 0, {gradient( {Color Theme( "White to Orange" )} )} )
            )}
        )
    )
);


```

## [Item Messages](#item-messages_1)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( xposition, yposition, {Type(element name), X(i=1), Y(i=1), options...} )

**Description:** Adds a new graph element at the given X and Y positions. The element specification includes the element name, which data roles it uses its option values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 0.5 );
gb << Add Element( 1, 1, {Type( "Line Of Fit" ), X, Y, Degree( "Quadratic" )} );


```

### [Add Variable](#add-variable)

**Syntax:** obj \<< Add Variable( {column, Role(role), Position(p=1), Inner Position(i=1)}, < \<<Method("insert"|"merge"|"replace")> )

**Description:** Adds a new variable to the Graph Builder model, with a given role and position.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 0.5 );
gb << Add Variable( {:age, Role( "Wrap" )} );


```

### [Auto Stretching](#auto-stretching)

**Syntax:** obj \<< Auto Stretching( state=0|1 )

**Description:** Toggles the automatic stretching of the graph with the containing window. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Auto Stretching( 0 );


```

### [Back Color](#back-color)

**Syntax:** obj \<< Back Color( color )

**Description:** Sets the color for the entire background around the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Back Color( "Yellow" );


```

### [Categorical Color Theme](#categorical-color-theme)

**Syntax:** obj \<< Categorical Color Theme

**Description:** Sets the color theme used for categories.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Categorical Color Theme( "Pastel" );


```

### [Continuous Color Theme](#continuous-color-theme)

**Syntax:** obj \<< Continuous Color Theme

**Description:** Sets the color theme used for gradients.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Continuous Color Theme( "White to Black" );


```

### [Done](#done)

**Syntax:** obj \<< Done

**Description:** Hides the control panel and turns off any row sampling.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Done;


```

### [Elements](#elements)

**Syntax:** Elements( Points( X, Y )| Box plot( X, Y, Jitter( state=0|1 ), Outliers( state=0|1 ), Box Style( "Outlier"|"Quantile" ) )|Line( X, Y, Row Order( number ), Summary Statistic( ) )| Histogram( X, Y)| Bar( X, Y, Bar Style(), Summary Statistic() )| Contour(X, Y)| Smoother(X, Y)|Map Shapes(Summary Statistic() ))

**Description:** Identifies the elements of the visualization.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
gb = dt << Graph Builder(
    Variables( X( :"F Rate 0-19"n ), Y( :Region ) ),
    Elements( Box Plot( X, Y ), Line( X, Y, Summary Statistic( "Mean" ) ) )
);


```

### [Error Bar Offset](#error-bar-offset)

**Syntax:** obj \<< Error Bar Offset

**Description:** Opens a dialog to set the offset for error bars.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 1 );
gb << Error Bar Offset( 0.01 );


```

### [Extend Axis to Zero](#extend-axis-to-zero)

**Syntax:** obj \<< Extend Axis to Zero( multiplier=1 )

**Description:** Multiplier for the amount an axis scale is extended to include zero. "1" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Extend Axis to Zero( 10 ),
    Variables( X( :Weight ), Y( :Height ) ),
    Elements( Line( X, Y ) )
);


```

### [Extend Dual Axes to Zero](#extend-dual-axes-to-zero)

**Syntax:** obj \<< Extend Dual Axes to Zero( multiplier=2 )

**Description:** Multiplier for the amount an axis scale is extended to include zero when there are both left and right axes. "2" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Size( 513, 465 ),
    Extend Dual Axes to Zero( 10 ),
    Variables( X( :age ), Y( :weight, Side( "Right" ) ), Y( :height, Position( 1 ) ) ),
    Elements( Line( X, Y( 2 ) ), Line( X, Y( 1 ) ) )
);


```

### [Extend Parallel Y Axes to Zero](#extend-parallel-y-axes-to-zero)

**Syntax:** obj \<< Extend Parallel Y Axes to Zero( multiplier=3 )

**Description:** Multiplier for the amount an axis scale is extended to include zero when in Parallel Y Axes mode. "3" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Parallel Axes( "Y Only" ),
    Extend Parallel Y Axes to Zero( 0 ),
    Variables( X( :age ), Y( :height ), Y( :weight ) ),
    Elements( Position( 1, 1 ), Line( X, Y ) ),
    Elements( Position( 1, 2 ), Line( X, Y ) )
);


```

### [Fit to Window](#fit-to-window)

**Syntax:** obj \<< Fit to Window( "Auto"|"On"|"Off"|"Maintain Aspect Ratio" )

**Description:** Sets the auto stretching behavior of the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Fit to Window( "Off" );


```

### [Get Element](#get-element)

**Syntax:** obj \<< Get Element( xposition, yposition, i )

**Description:** Returns a graph element specifications for the given x and y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Get Element( 1, 1, 1 );


```

### [Get Elements](#get-elements)

**Syntax:** obj \<< Get Elements( xposition, yposition )

**Description:** Returns a list of element specifications for the given x and y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Get Elements( 1, 1 );


```

### [Get Legend Display](#get-legend-display)

**Syntax:** obj \<< Get Legend Display

**Description:** Returns the Legend Display Box for the graph that can be queried or modified.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 2, 1 );
item << Set Visible( 0 );


```

### [Get Legend Server](#get-legend-server)

**Syntax:** obj \<< Get Legend Server

**Description:** Returns an object holding information used by the Legend Display and corresponding Display Segs in the graph.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Server;
items = lgnd << Get Legend Items;
Show( items );


```

### [Get N Elements](#get-n-elements)

**Syntax:** obj \<< Get N Elements( xposition, yposition )

**Description:** Returns the number of graph elements for the given x and y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Get N Elements( 1, 1 );


```

### [Get N Positions](#get-n-positions)

**Syntax:** nrole

**Description:** Returns the number of positions in use for a given role.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Get N Positions( "X" );


```

### [Get N Variables](#get-n-variables)

**Syntax:** n = obj \<< Get N Variables

**Description:** Returns the number of variables in use.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Get N Variables();


```

### [Get Variable](#get-variable)

**Syntax:** obj \<< Get Variable( index )

**Description:** Returns a variable specification.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Get Variable( 1 );


```

### [Get Variables](#get-variables)

**Syntax:** list = obj \<< Get Variables

**Description:** Returns a list of variable specification lists for the variables in use.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Get Variables();


```

### [Graph Spacing](#graph-spacing)

**Syntax:** obj \<< Graph Spacing( gap=1 )

**Description:** Sets the amount of space between graph panels. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Add Variable( {:age, Role( "Wrap" )} );
gb << Graph Spacing( 3 );


```

### [Grid Color](#grid-color)

**Syntax:** obj \<< Grid Color( color )

**Description:** Sets the color for the grid lines on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Graph Spacing( 5 ),
    Variables( X( :height ), Y( :weight ), Wrap( :age ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Grid Color( "Red" );


```

### [Grid Transparency](#grid-transparency)

**Syntax:** obj \<< Grid Transparency( fraction=1 )

**Description:** Sets the transparency for the grid lines. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Graph Spacing( 5 ),
    Variables( X( :height ), Y( :weight ), Wrap( :age ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Grid Transparency( 0.2 );


```

### [Include Missing Categories](#include-missing-categories)

**Syntax:** obj \<< Include Missing Categories( state=0|1 )

**Description:** Treats missing values as a separate level for categorical variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
:age[{10, 20, 30}] = .;
gb << Add Variable( {:age, Role( "Wrap" )} );
gb << Include Missing Categories( 1 );


```

### [Launch Analysis](#launch-analysis)

**Syntax:** obj \<< Launch Analysis

**Description:** Launches an analysis using the current variables.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Launch Analysis;


```

### [Legend Floating Offset](#legend-floating-offset)

**Syntax:** obj \<< Legend Floating Offset

**Description:** Sets the offset in pixels for the legend when the Legend Position is set to "Floating"

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Legend Position( "Inside Floating" );


```

### [Legend Position](#legend-position)

**Syntax:** obj \<< Legend Position( "Right"|"Bottom"|"Inside Left"|"Inside Right"|"Inside Bottom Left"|"Inside Bottom Right"|"Inside Floating" )

**Description:** Sets the position of the legend.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Legend Position( "Bottom" );


```

### [Legend Settings](#legend-settings)

**Syntax:** obj \<< Legend Settings

**Description:** Opens a dialog to modify the properties of the legend.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 1 );
gb << Legend Settings();


```

### [Level Fill Color](#level-fill-color)

**Syntax:** obj \<< Level Fill Color( color )

**Description:** Sets the color for the level names on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Level Fill Color( {103, 214, 214} );


```

### [Level Frame Color](#level-frame-color)

**Syntax:** obj \<< Level Frame Color( color )

**Description:** Sets the color for the lines around the level names on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Level Frame Color( "Blue" );


```

### [Level Spacing Color](#level-spacing-color)

**Syntax:** obj \<< Level Spacing Color( color )

**Description:** Sets the color of the spacing between level labels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Level Spacing Color( "Blue" );


```

### [Level Spacing Transparency](#level-spacing-transparency)

**Syntax:** obj \<< Level Spacing Transparency( fraction=1 )

**Description:** Sets the transparency for the spacing between level labels. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Level Spacing Transparency( .2 );


```

### [Level Text Color](#level-text-color)

**Syntax:** obj \<< Level Text Color( color )

**Description:** Sets the color for the level name text on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Level Text Color( "Red" );


```

### [Level Transparency](#level-transparency)

**Syntax:** obj \<< Level Transparency( fraction=1 )

**Description:** Sets the transparency for the level name frame on the graph. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Level Transparency( .2 );


```

### [Level Underline](#level-underline)

**Syntax:** obj \<< Level Underline( state=0|1 )

**Description:** Underlines the level names or removes the underline on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Level Frame Color( "Blue" );
gb << Level Underline( 1 );


```

### [Lighten large fills](#lighten-large-fills)

**Syntax:** obj \<< Lighten large fills( state=0|1 )

**Description:** Automatically lighten colors for pie, treemap and mosaic elements, which fill large areas. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Lighten large fills( 1 );


```

### [Link Page Axes](#link-page-axes)

**Syntax:** obj \<< Link Page Axes( "None"|"X Only"|"Y Only"|"X and Y" )

**Description:** Sets which axes are linked across page group levels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Size( 470, 552 ),
    Variables( X( :height ), Y( :weight ), Page( :sex ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Link Page Axes( "Y Only" );


```

### [Lock Scales](#lock-scales)

**Syntax:** obj \<< Lock Scales( state=0|1 )

**Description:** Locks axis and gradient ranges so they do not change in response to data or filtering changes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Lock Scales( 1 );


```

### [Make into Data Table](#make-into-data-table)

**Syntax:** obj \<< Make into Data Table

**Description:** Creates a new data table containing images of graphs.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Make into Data Table;


```

### [Order Statistic](#order-statistic)

**Syntax:** obj \<< Order Statistic( "N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile"="Mean" )

**Description:** Sets the default order based on a summary statistic used when using the Order By message for a variable in the graph. "Mean" by default.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
gb = dt << Graph Builder(
    Order Statistic( "Max" ),
    Variables( X( :"F Rate 0-19"n ), Y( :Region, Order By( :"F Rate 0-19"n, Ascending ) ) ),
    Elements( Box Plot( X, Y ) )
);


```

### [Overlay Auto Line Styles Limit](#overlay-auto-line-styles-limit)

**Syntax:** obj \<< Overlay Auto Line Styles Limit( count=6 )

**Description:** Limits the number of overlay levels where the Overlay Encoding will use line styles for its Auto setting in the presence of a color variable. "6" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Overlay Auto Line Styles Limit( 0 ),
    Variables( X( :Weight ), Y( :Height ), Overlay( :sex ), Color( :Age ) ),
    Elements( Line( X, Y ) )
);


```

### [Overlay Auto Marker Styles Limit](#overlay-auto-marker-styles-limit)

**Syntax:** obj \<< Overlay Auto Marker Styles Limit( count=62 )

**Description:** Limits the number of overlay levels where the Overlay Encoding will use marker styles for its Auto setting in the presence of a color variable. "62" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Overlay Auto Marker Styles Limit( 0 ),
    Variables( X( :Weight ), Y( :Height ), Overlay( :sex ), Color( :Age ) ),
    Elements( Points( X, Y ) )
);


```

### [Page Count Limit](#page-count-limit)

**Syntax:** obj \<< Page Count Limit( count=200 )

**Description:** Sets the maximum number of pages created for the page variable, to avoid accidental performance degradation. "200" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Page( :Name ) ),
    Elements( Points( X, Y ) )
);
gb << Page Count Limit( 5 );


```

### [Page Gap Size](#page-gap-size)

**Syntax:** obj \<< Page Gap Size( gap=25 )

**Description:** Sets the amount of space between page groups. "25" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Page( :Sex ) ),
    Elements( Smoother( X, Y ) )
);
gb << Page Gap Size( 3 );


```

### [Page Level Fill Color](#page-level-fill-color)

**Syntax:** obj \<< Page Level Fill Color( color )

**Description:** Sets the color for the level names on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Page( :Sex ) ),
    Elements( Smoother( X, Y ) )
);
gb << Page Level Fill Color( {103, 214, 214} );


```

### [Page Level Frame Color](#page-level-frame-color)

**Syntax:** obj \<< Page Level Frame Color( color )

**Description:** Sets the color for the lines around the level names on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Page( :Sex ) ),
    Elements( Smoother( X, Y ) )
);
gb << Page Level Frame Color( "Blue" );


```

### [Page Level Text Color](#page-level-text-color)

**Syntax:** obj \<< Page Level Text Color( color )

**Description:** Sets the color for the level name text on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Page( :Sex ) ),
    Elements( Smoother( X, Y ) )
);
gb << Page Level Text Color( "Red" );


```

### [Page Level Transparency](#page-level-transparency)

**Syntax:** obj \<< Page Level Transparency( fraction=1 )

**Description:** Sets the transparency for the level name frame on the graph. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Page( :Sex ) ),
    Elements( Smoother( X, Y ) )
);
gb << Page Level Transparency( .2 );


```

### [Page Level Underline](#page-level-underline)

**Syntax:** obj \<< Page Level Underline( state=0|1 )

**Description:** Underlines the level names or removes the underline on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Page( :Sex ) ),
    Elements( Smoother( X, Y ) )
);
gb << Page Level Frame Color( "Blue" );
gb << Page Level Underline( 1 );


```

### [Parallel Axis Merging](#parallel-axis-merging)

**Syntax:** obj \<< Parallel Axis Merging( "Always"|"Low Similarity"|"Medium Similarity"|"High Similarity"|"Never" )

**Description:** Determines when the automatic Combine Scales setting should choose Parallel Merged instead of Parallel Independent.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Parallel Axis Merging( "Never" );


```

### [Parallel Y Axes](#parallel-y-axes)

**Syntax:** obj \<< Parallel Y Axes( state=0|1 )

**Description:** All Y axes share the same graph. Like parallel coordinates but supporting an X variable.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :age ), Y( :height ), Y( :weight ) ),
    Elements( Position( 1, 1 ), Points( X, Y ), Smoother( X, Y ) ),
    Elements( Position( 1, 2 ), Points( X, Y ), Smoother( X, Y ) )
);
gb << Parallel Y Axes( 1 );


```

### [Random Seed](#random-seed)

**Syntax:** obj \<< Random Seed( number )

**Description:** Sets a specific seed for random jitter.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Sex ), Y( :Height ) ),
    Elements( Points( X, Y, Jitter( "Random Uniform" ) ) )
);
Wait( 1 );
gb << Random Seed( 123456 );


```

### [Relative Sizes](#relative-sizes)

**Syntax:** Relative Sizes(axis, matrix of relative size values)

**Description:** Determines the proportion of space allotted to each of multiple axes in a series.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Graph Builder(
    Size( 435, 352 ),
    Show Control Panel( 0 ),
    Variables( X( :weight ), Y( :height ), Y( :sex ) ),
    Relative Sizes( "Y", [4 1] ),
    Elements( Position( 1, 1 ), Points( X, Y ) ),
    Elements( Position( 1, 2 ), Points( X, Y ) )
);


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( xposition, yposition, i )

**Description:** Removes a graph element at the given X and Y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 0.5 );
gb << Remove Element( 1, 1, 2 );


```

### [Remove Variable](#remove-variable)

**Syntax:** obj \<< Remove Variable( index | {column, Role(role), Position(p=1), Inner Position(i=1)} )

**Description:** Removes a variable from the Graph Builder model, specified by either the index or a given column name, role, and position.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 0.5 );
gb << Add Variable( {:age, Role( "Wrap" )} );
Wait( 0.5 );
gb << Remove Variable( 3 );


```

### [Replicate Linked Page Axes](#replicate-linked-page-axes)

**Syntax:** obj \<< Replicate Linked Page Axes( state=0|1 )

**Description:** Determines whether linked pages axis in a grid are displayed once for each graph or once for each row or column of graphs.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Size( 470, 552 ),
    Variables( X( :height ), Y( :weight ), Page( :age ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Link Page Axes( "X and Y" );
gb << Replicate Linked Page Axes( 1 );


```

### [Sampling](#sampling)

**Syntax:** obj \<< Sampling( number )

**Description:** Randomly selects a subset of the data using a specified proportion or count. This is useful when the data is large and the graph is still being changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Sampling( 20 );


```

### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj \<< Set Alpha Level( 0.10|0.05|0.01|Other... )

**Description:** Changes the alpha level used for the confidence curves.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Set Alpha Level( 0.10 );


```

### [Set α Level](#set-level)

**Syntax:** obj \<< Set α Level( 0.10|0.05|0.01|Other... )

**Description:** Changes the alpha level used for the confidence curves.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Set Alpha Level( 0.10 );


```

### [Show Control Panel](#show-control-panel)

**Syntax:** obj \<< Show Control Panel( state=0|1 )

**Description:** Displays or hides the control panel. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show Control Panel( 1 );


```

### [Show Excluded Rows](#show-excluded-rows)

**Syntax:** obj \<< Show Excluded Rows( state=0|1 )

**Description:** Shows or hides excluded rows on plots. When this option is selected, excluded rows are included in the count of out of control points, but excluded from numerical calculations.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
dt << Select Rows( 1 :: 5 );
dt << Exclude();
gb << Show Excluded Rows( 1 );


```

### [Show Footer](#show-footer)

**Syntax:** obj \<< Show Footer( state=0|1 )

**Description:** Displays or hides the footer text. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show Footer( 0 );


```

### [Show Legend](#show-legend)

**Syntax:** obj \<< Show Legend( state=0|1 )

**Description:** Displays or hides the legend to the right of the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show Legend( 1 );


```

### [Show Subtitle](#show-subtitle)

**Syntax:** obj \<< Show Subtitle( state=0|1 )

**Description:** Displays or hides the graph subtitle.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show Subtitle( 1 );


```

### [Show Title](#show-title)

**Syntax:** obj \<< Show Title( state=0|1 )

**Description:** Displays or hides the graph title. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show Title( 0 );


```

### [Show X Axis](#show-x-axis)

**Syntax:** obj \<< Show X Axis( state=0|1 )

**Description:** Displays or hides the X axis. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show X Axis( 0 );


```

### [Show X Axis Title](#show-x-axis-title)

**Syntax:** obj \<< Show X Axis Title( state=0|1 )

**Description:** Displays or hides the X axis title. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show X Axis Title( 0 );


```

### [Show Y Axis](#show-y-axis)

**Syntax:** obj \<< Show Y Axis( state=0|1 )

**Description:** Displays or hides the Y axis. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show Y Axis( 0 );


```

### [Show Y Axis Title](#show-y-axis-title)

**Syntax:** obj \<< Show Y Axis Title( state=0|1 )

**Description:** Displays or hides the Y axis title. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Show Y Axis Title( 0 );


```

### [Size](#size)

**Syntax:** obj \<< Size( width, height )

**Description:** Sets the size of the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Size( 808, 586 );


```

### [Spacing Borders](#spacing-borders)

**Syntax:** obj \<< Spacing Borders( 0|1=0 )

**Description:** Sets the borders for the internal graph panels. "0" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Spacing Borders( 1 );


```

### [Subtitle Alignment](#subtitle-alignment)

**Syntax:** obj \<< Subtitle Alignment( "Left"|"Center"|"Right"|"Auto" )

**Description:** Sets the alignment of the graph subtitle.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Subtitle Alignment( "Left" );


```

### [Subtitle Span](#subtitle-span)

**Syntax:** obj \<< Subtitle Span( "Full"|"Graph contents" )

**Description:** Sets the span of the graph subtitle.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Subtitle Span( "Graph" );


```

### [Summary Statistic](#summary-statistic_1)

**Syntax:** Summary Statistic( N|Mean|Min|Max|Sum|% of Total )

**Description:** Sets the default summary statistic used by the different elements in the graph. Mean by default for Bar and Line elements. "Mean" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Age ), Y( :Height ), Y( :weight, Position( 1 ) ) ),
    Summary Statistic( "Sum" ),
    Elements( Bar( X, Y( 1 ), Y( 2 ), Legend( 2 ) ) )
);


```

### [Title Alignment](#title-alignment)

**Syntax:** obj \<< Title Alignment( "Left"|"Center"|"Right" )

**Description:** Sets the alignment of the graph title.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Title Alignment( "Left" );


```

### [Title Fill Color](#title-fill-color)

**Syntax:** obj \<< Title Fill Color( color )

**Description:** Sets the color for the title background fill on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Title Fill Color( "Cyan" );


```

### [Title Frame Color](#title-frame-color)

**Syntax:** obj \<< Title Frame Color( color )

**Description:** Sets the color for the line around the title frame on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Title Frame Color( "Blue" );


```

### [Title Span](#title-span)

**Syntax:** obj \<< Title Span( "Full"|"Graph contents" )

**Description:** Sets the span of the graph title.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Title Span( "Graph" );


```

### [Title Text Color](#title-text-color)

**Syntax:** obj \<< Title Text Color( color )

**Description:** Sets the color for the title text on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Title Text Color( "Red" );


```

### [Title Transparency](#title-transparency)

**Syntax:** obj \<< Title Transparency( fraction=1 )

**Description:** Sets the transparency for the title frame on the graph. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Title Transparency( .2 );


```

### [Title Underline](#title-underline)

**Syntax:** obj \<< Title Underline( state=0|1 )

**Description:** Underlines the title or removes the underline on the graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Title Frame Color( "Blue" );
gb << Title Underline( 1 );


```

### [Update Element](#update-element)

**Syntax:** obj \<< Update Element( xposition, yposition, i, {options} )

**Description:** Modifies the properties of an existing element.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 0.5 );
gb << Update Element( 1, 1, 1, {Summary Statistic( "Mean" ), Error Bars( "Range" )} );


```

### [Use row colors for levels](#use-row-colors-for-levels)

**Syntax:** obj \<< Use row colors for levels( state=0|1 )

**Description:** Initialize legend levels with row colors when every level has a unique color. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb << Use row colors for levels( 1 );


```

### [Variables](#variables)

**Syntax:** Variables( X(column ), Y( column ), \<Group X( column )>, \<Group Y( column )>, \<Shape( column )>, \<Color( column )>, \<Overlay( column )>, \<Freq( column )> )

**Description:** Defines the variables used in the visualization.

```

dt = Open( "$SAMPLE_DATA/SATByYear.jmp" );
gb = dt << Graph Builder( Variables( Color( :SAT Verbal ), Shape( :State ) ) );


```

### [X Group Edge](#x-group-edge)

**Syntax:** obj \<< X Group Edge( "Top"|"Bottom" )

**Description:** Moves the axis for the X group to either the top or the bottom. "Top" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Wait( 1 );
gb << X Group Edge( "Bottom" );


```

### [Y Group Edge](#y-group-edge)

**Syntax:** obj \<< Y Group Edge( "Left"|"Right" )

**Description:** Moves the axis for the Y group to either the left or the right. "Right" by default.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Sex ), Y( :Height ), Group Y( :Age ) ),
    Elements( Smoother( X, Y ) )
);
Wait( 1 );
gb << Y Group Edge( "Left" );


```

### [Y Group Level Orientation](#y-group-level-orientation)

**Syntax:** obj \<< Y Group Level Orientation( "Horizontal"|"Vertical" )

**Description:** Determines whether the Y Group level label text is horizontal or vertical (rotated).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Sex ), Y( :Height ), Group Y( :Age ) ),
    Elements( Smoother( X, Y ) )
);
Wait( 1 );
gb << Y Group Level Orientation( "Horizontal" );


```

### [Y Group Title Orientation](#y-group-title-orientation)

**Syntax:** obj \<< Y Group Title Orientation( "Horizontal"|"Vertical" )

**Description:** Determines whether the Y Group title label text is horizontal or vertical (rotated).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Variables( X( :Sex ), Y( :Height ), Group Y( :Age ) ),
    Elements( Smoother( X, Y ) )
);
Wait( 1 );
gb << Y Group Title Orientation( "Horizontal" );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Graph Builder(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Bar Element](#bar-element)

### [Associated Constructors](#associated-constructors_2)

#### [Bar Element](#bar-element_1)

**Syntax:** Bar Element

**Description:** Shows a response summarized by categories.

**100% stacked bar chart**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// 100% stacked bar chart, custom legend colors
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Age ), Y( :Cholesterol ), Overlay( :Alcohol Use ) ),
    Elements(
        Bar( X, Y, Legend( 55 ), Bar Style( "Stacked" ), Summary Statistic( "% of Factor" ) )
    ),
    SendToReport(
        Dispatch( {}, "Cholesterol", ScaleBox, {Max( 1 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                55,
                Properties( 0, {Fill Color( RGB Color( 0.9, 0.9, 0.9 ) )} ),
                Properties( 1, {Fill Color( RGB Color( 1.0, 0.8, 0.8 ) )} ),
                Properties( 2, {Fill Color( RGB Color( 1.0, 0.6, 0.6 ) )} ),
                Properties( 3, {Fill Color( RGB Color( 1.0, 0.3, 0.3 ) )} )
            )}
        )
    )
);


```

**Bar and arrow chart**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// arrow and bar chart 
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Sex ), Y( :HDL ), Y( :LDL, Position( 1 ) ) ),
    Elements( Bar( X, Y( 1 ), Y( 2 ), Bar Style( "Arrow" ) ), Bar( X, Y( 1 ) ) )
);


```

**Bar chart ordered by count**

```

Open( "$SAMPLE_DATA/Airline Delays.jmp" );
// bar chart, ordered by count
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Airline, Order By( :Airline, "Descending", Order Statistic( "N" ) ) ) ),
    Elements( Bar( X, Legend( 4 ) ) )
);


```

**Bar chart with confidence intervals**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// bar chart with confidence intervals
Graph Builder(
    Size( 658, 555 ),
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ) ),
    Elements( Bar( X, Y, Legend( 6 ), Error Interval( "Confidence Interval" ) ) )
);


```

**Bar chart with labeled bars**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// bar chart, label by value
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Sex ), Y( :Cholesterol ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ), Label Format( "Fixed Dec", 9, 1 ) ) )
);


```

**Bars with overlaid lines**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// bar with floating lines, custom colors
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Sex ),
        Y( :Cholesterol ),
        Y( :HDL, Position( 1 ) ),
        Y( :LDL, Position( 1 ) )
    ),
    Elements( Bar( X, Y( 1 ), Y( 2 ), Y( 3 ), Legend( 5 ), Bar Style( "Single" ) ) ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Properties( 0, {Fill Color( "light gray" )} ),
                Properties( 1, {Line Color( "green" )} ),
                Properties( 2, {Line Color( "orange" )} )
            )}
        )
    )
);


```

**Bars with small values stacked as Other**

```

Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
// stacked other bar, packed bars, pareto
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Count ), Y( :Causes ) ),
    Elements(
        Bar(
            X,
            Y,
            Bar Style( "Packed" ),
            Packed Placement( "Separate stack" ),
            Packed Primary Labels( "On axis" )
        )
    )
);


```

**Bullet chart**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// bar chart, bullet, 2 y variables
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Sex ), Y( :HDL ), Y( :LDL, Position( 1 ) ) ),
    Elements( Bar( X, Y( 1 ), Y( 2 ), Legend( 1 ), Bar Style( "Bullet" ) ) ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 1, Properties( 1, {Fill Color( "light gray" )} ) )}
        )
    )
);


```

**Data-driven bar coloring**

```

Open( "$SAMPLE_DATA/Dogs.jmp" );
// data-driven bar coloring, diverging bars
Graph Builder(
    Transform Column(
        "hilo",
        Nominal,
        Formula(
            If(
                :diff == Col Minimum( :diff ), "min",
                :diff == Col Maximum( :diff ), "max",
                "other"
            )
        )
    ),
    Show Control Panel( 0 ),
    Variables( X( :ID ), Y( :diff ), Color( :hilo ) ),
    Elements( Bar( X, Y, Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "diff", ScaleBox, {Add Ref Line( 0, "Solid", "Black", "", 1, 0.75 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                3,
                Properties( 0, {Fill Color( RGB Color( 0.5, 0.5, 0.9 ) )} ),
                Properties( 1, {Fill Color( RGB Color( 0.95, 0.6, 0.6 ) )} ),
                Properties( 2, {Fill Color( RGB Color( 0.7, 0.7, 0.7 ) )} )
            )}
        ),
        Dispatch( {}, "400", LegendBox,
            {Set Title( "" ), Legend Position( {3, [0, 1, -1]} )}
        )
    )
);


```

**Diverging stacked bars with Likert scale**

```

Open( "$SAMPLE_DATA/Likert Survey.jmp" );
// diverging stacked bars, likert scale
Graph Builder(
    Transform Column( "neg sd", Formula( -:strongly disagree ) ),
    Transform Column( "neg d", Formula( -:disagree ) ),
    Transform Column( "neg n", Formula( -:neutral / 2 ) ),
    Transform Column( "pos n", Formula( :neutral / 2 ) ),
    Show Control Panel( 0 ),
    Legend Position( "Bottom" ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables(
        X( :neg n ),
        X( :neg d, Position( 1 ) ),
        X( :neg sd, Position( 1 ) ),
        X( :pos n, Position( 1 ) ),
        X( :agree, Position( 1 ) ),
        X( :strongly agree, Position( 1 ) ),
        Y( :question )
    ),
    Elements(
        Bar(
            X( 1 ),
            X( 2 ),
            X( 3 ),
            X( 4 ),
            X( 5 ),
            X( 6 ),
            Y,
            Legend( 4 ),
            Bar Style( "Stacked" )
        )
    ),
    SendToReport(
        Dispatch( {}, "neg n", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "question", ScaleBox, {Min( 19.6 ), Max( -0.6 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                4,
                Level Name( 0, "neutral" ),
                Level Name( 1, "disagree" ),
                Level Name( 2, "strongly disagree" ),
                Level Name( 3, "neutral" ),
                Properties( 0, {Fill Color( RGB Color( {0.9, 0.9, 0.9} ) )} ),
                Properties( 1, {Fill Color( RGB Color( {1.0, 0.7, 0.7} ) )} ),
                Properties( 2, {Fill Color( RGB Color( {1.0, 0.3, 0.3} ) )} ),
                Properties( 3, {Fill Color( RGB Color( {0.9, 0.9, 0.9} ) )} ),
                Properties( 4, {Fill Color( RGB Color( {0.8, 0.8, 1.0} ) )} ),
                Properties( 5, {Fill Color( RGB Color( {0.5, 0.5, 1.0} ) )} )
            )}
        )
    ),
    Dispatch( {}, "400", LegendBox, {Legend Position( {4, [2, 1, 0, -1, 3, 4]} )} )
);


```

**Float lines with overlaid points**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// float lines and overlaid points
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Sex ), Y( :LDL ), Y( :HDL, Position( 1 ) ) ),
    Elements(
        Bar( X, Y( 1 ), Y( 2 ), Legend( 1 ), Bar Style( "Float" ) ),
        Points( X, Y( 1 ), Y( 2 ), Legend( 3 ) )
    )
);


```

**Interval with dot using transforms**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// interval bar chart, transform columns
Graph Builder(
    Transform Column( "Maximum[HDL][Sex]", Formula( Col Maximum( :HDL, :Sex ) ) ),
    Transform Column( "Minimum[HDL][Sex]", Formula( Col Minimum( :HDL, :Sex ) ) ),
    Transform Column( "Mean[HDL][Sex]", Formula( Col Mean( :HDL, :Sex ) ) ),
    Show Control Panel( 0 ),
    Variables(
        X( :Sex ),
        Y( :"Minimum[HDL][Sex]"n ),
        Y( :"Maximum[HDL][Sex]"n, Position( 1 ) ),
        Y( :"Mean[HDL][Sex]"n, Position( 1 ) ),

    ),
    Elements( Bar( X, Y( 1 ), Y( 2 ), Y( 3 ), Bar Style( "Interval" ) ) )
);


```

**Needle chart**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// needle bar chart
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Age ), Y( :Cholesterol ) ),
    Elements( Bar( X, Y, Bar Style( "Needle" ), Summary Statistic( "Max" ) ) )
);


```

**Packed bars highlighting top ten categories**

```

Open( "$SAMPLE_DATA/Billion Dollar Events.jmp" );
// packed bar chart, top 10, custom axis format, subtitle
Graph Builder(
    Size( 813, 512 ),
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Title Alignment( "Left" ),
    Title Span( "Graph contents" ),
    Subtitle Alignment( "Left" ),
    Subtitle Span( "Graph contents" ),
    Show Subtitle( 1 ),
    Show Footer( 0 ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables( X( :Cost ), Y( :Unique Event ) ),
    Elements(
        Bar( X, Y, Bar Style( "Packed" ), Packed Primaries( 10 ), Packed Labeling( 0.4091 ) )
    ),
    SendToReport(
        Dispatch( {}, "Cost", ScaleBox,
            {Format(
                "Custom",
                Formula(
                    If( value == 0,
                        "0",
                        "$" || Format( value, "precision", Keep trailing zeroes( 0 ), 3 ) ||
                        "B"
                    )
                ),
                17
            ), Min( 0 ), Max( 164.25 ), Inc( 20 ), Minor Ticks( 0 )}
        ),
        Dispatch( {}, "graph title", TextEditBox,
            {Margin( {Left( 5 ), Top( 0 ), Right( 0 ), Bottom( 0 )} ),
            Set Text( "Billion-dollar disasters in the US, 1980-2017" ),
            Set Font Style( "Plain" )}
        ),
        Dispatch( {}, "graph 1 title", TextEditBox,
            {Margin( {Left( 5 ), Top( 0 ), Right( 0 ), Bottom( 0 )} ),
            Set Text( "CPI-adjusted estimated costs from NOAA, www.ncdc.noaa.gov/billions/" )
            }
        )
    )
);


```

**Range bar chart**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// range bar chart between two variables
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Sex ), Y( :HDL ), Y( :LDL, Position( 1 ) ) ),
    Elements( Bar( X, Y( 1 ), Y( 2 ), Bar Style( "Range" ) ) ),

);


```

**Side-by-side grouped bar chart using median**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// bar chart, side-by-side, 3 y variables, median, custom colors
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Sex ),
        Y( :Cholesterol ),
        Y( :HDL, Position( 1 ) ),
        Y( :LDL, Position( 1 ) )
    ),
    Elements( Bar( X, Y( 1 ), Y( 2 ), Y( 3 ), Summary Statistic( "Median" ), Legend( 5 ) ) ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Properties( 0, {Fill Color( "dark gray" )} ),
                Properties( 1, {Fill Color( "blue" )} ),
                Properties( 2, {Fill Color( "orange" )} )
            )}
        )
    )
);


```

**Sorted stacked bar chart**

```

Open( "$SAMPLE_DATA/Quality Control/Cabinet Defects.jmp" );
// bar chart, sorted stacked, filtered, custom legend colors
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Lot Number ), Overlay( :Type of Defect ) ),
    Elements( Bar( X, Legend( 3 ), Bar Style( "Sorted stacked" ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :Lot Number, :Type of Defect ),
            Where( :Lot Number <= 10.5 ),
            Where(
                :Type of Defect == {"Bruised veneer", "Checked veneer", "Chipped veneer",
                "Defective sanding", "Loose veneer", "Sand throughs", "Scratched veneer",
                "Split veneer"}
            ),
            Display( :Type of Defect, N Items( 9 ) )
        )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                3,
                Properties( 0, {Fill Color( RGB Color( 0.55, 0.83, 0.78 ) )} ),
                Properties( 1, {Fill Color( RGB Color( 0.75, 0.73, 0.85 ) )} ),
                Properties( 2, {Fill Color( RGB Color( 0.98, 0.50, 0.45 ) )} ),
                Properties( 3, {Fill Color( RGB Color( 0.50, 0.69, 0.83 ) )} ),
                Properties( 4, {Fill Color( RGB Color( 0.99, 0.71, 0.38 ) )} ),
                Properties( 5, {Fill Color( RGB Color( 0.70, 0.87, 0.41 ) )} ),
                Properties( 6, {Fill Color( RGB Color( 0.99, 0.80, 0.90 ) )} ),
                Properties( 7, {Fill Color( RGB Color( 0.74, 0.50, 0.74 ) )} )
            )}
        )
    )
);


```

**Stacked bar chart of 3 variables and custom colors**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// bar chart, stacked, 3 y variables, mean
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Sex ),
        Y( :Cholesterol ),
        Y( :HDL, Position( 1 ) ),
        Y( :LDL, Position( 1 ) )
    ),
    Elements(
        Bar(
            X,
            Y( 1 ),
            Y( 2 ),
            Y( 3 ),
            Bar Style( "Stacked" ),
            Summary Statistic( "Mean" ),
            Legend( 5 )
        )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Properties( 0, {Fill Color( "dark gray" )} ),
                Properties( 1, {Fill Color( "blue" )} ),
                Properties( 2, {Fill Color( "orange" )} )
            )}
        )
    )
);


```

**Variable width bars, ordered by value**

```

Open( "$SAMPLE_DATA/SAT.jmp" );
// variable width bars, ordered by value
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X(
            :State,
            Order By( :"2004 Verbal"n, "Descending", Order Statistic( "Mean" ) ),
            Size By( :"% Taking (2004)"n, Size Statistic( "Mean" ) )
        ),
        Y( :"2004 Verbal"n )
    ),
    Elements( Bar( X, Y, Legend( 4 ) ) )
);


```

### [Item Messages](#item-messages_2)

#### [Bar Style](#bar-style)

**Syntax:** obj \<< Bar Style( "Side by side"|"Stacked"|"Sorted stacked"|"Bullet"|"Nested"|"Range"|"Side by side ranges"|"Interval"|"Side by side intervals"|"Two-way interval"|"Arrow"|"Single"|"Stock"|"Box Plot"|"Needle"|"Float"|"Treemap"|"Packed" )

#### [Error Interval](#error-interval_1)

**Syntax:** obj \<< Error Interval( "Auto"|"None"|"Range"|"Interquartile Range"|"Standard Error"|"Standard Deviation"|"Confidence Interval"|"Median Absolute Deviation"|"Custom Interval"|"Two-way Interval" )

#### [Interval Style](#interval-style_1)

**Syntax:** obj \<< Interval Style( "Error Bar"|"Band"|"Hash Band"|"Arrow" )

#### [Label](#label)

**Syntax:** obj \<< Label( "No Labels"|"Label by Value"|"Label by Percent of Total Values"|"Label by Row" )

#### [Label Format](#label-format)

**Syntax:** obj \<< Label Format

**JMP Version Added:** 16

#### [Overlap](#overlap)

**Syntax:** obj \<< Overlap( "Auto"|"None"|"Half"|"Full" )

**JMP Version Added:** 16

#### [Packed Coloring](#packed-coloring)

**Syntax:** obj \<< Packed Coloring( "Bar color"|"Faded bar color"|"Grays" )

**JMP Version Added:** 14

#### [Packed Labeling](#packed-labeling)

**Syntax:** obj \<< Packed Labeling( number )

**JMP Version Added:** 14

#### [Packed Ordering](#packed-ordering)

**Syntax:** obj \<< Packed Ordering( "By size"|"By label" )

**JMP Version Added:** 14

#### [Packed Placement](#packed-placement)

**Syntax:** obj \<< Packed Placement( "Separate stack"|"Smallest stack"|"First stack" )

**JMP Version Added:** 14

#### [Packed Primaries](#packed-primaries)

**Syntax:** obj \<< Packed Primaries( number )

**JMP Version Added:** 14

#### [Packed Primary Labels](#packed-primary-labels)

**Syntax:** obj \<< Packed Primary Labels( "On axis"|"Inside bars" )

**JMP Version Added:** 14

#### [Response Axis](#response-axis_1)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Save Summary Formula](#save-summary-formula_1)

**Syntax:** obj \<< Save Summary Formula

#### [Summary Statistic](#summary-statistic_2)

**Syntax:** obj \<< Summary Statistic( "N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

## [Box Plot Element](#box-plot-element)

### [Associated Constructors](#associated-constructors_3)

#### [Box Plot Element](#box-plot-element_1)

**Syntax:** Box Plot Element

**Description:** Shows a compact view of a variable’s distribution with quartiles and outliers.

**Horizontal outlier box plots**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// horizontal outlier box plots
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :sex ) ),
    Elements( Box Plot( X, Y, Legend( 4 ) ) ),
    SendToReport( Dispatch( {}, "height", ScaleBox, {Min( 50 )} ) )
);


```

**Overlaid box plots**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// box plots, overlaid
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ), Overlay( :Sex ) ),
    Elements( Box Plot( X, Y, Legend( 2 ) ) )
);


```

**Solid box plots with data-driven color**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// solid box plots, colored by summary of a different variable
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ), Color( :Flipper Length ) ),
    Elements( Box Plot( X, Y, Legend( 2 ), Box Style( "Solid" ), Fences( 0 ) ) )
);


```

### [Item Messages](#item-messages_3)

#### [5 Number Summary](#5-number-summary)

**Syntax:** obj \<< 5 Number Summary( state=0|1 )

**JMP Version Added:** 14

#### [Box Placement](#box-placement)

**Syntax:** obj \<< Box Placement( "Offset"|"Align" )

**JMP Version Added:** 16

#### [Box Style](#box-style)

**Syntax:** obj \<< Box Style( "Normal"|"Solid"|"Thin" )

#### [Box Type](#box-type)

**Syntax:** obj \<< Box Type( "Quantile"|"Outlier" )

#### [Confidence Diamond](#confidence-diamond)

**Syntax:** obj \<< Confidence Diamond( state=0|1 )

**JMP Version Added:** 16

#### [Fences](#fences)

**Syntax:** obj \<< Fences( state=0|1 )

**JMP Version Added:** 16

#### [Jitter](#jitter)

**Syntax:** obj \<< Jitter( "None"|"Auto"|"Random Uniform"|"Random Normal"|"Density Random"|"Packed"|"Grid"|"Hex Grid"|"Beeswarm" )

#### [Notched](#notched)

**Syntax:** obj \<< Notched( state=0|1 )

**JMP Version Added:** 16

#### [Outliers](#outliers)

**Syntax:** obj \<< Outliers( state=0|1 )

#### [Response Axis](#response-axis_2)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Shortest Half](#shortest-half)

**Syntax:** obj \<< Shortest Half( state=0|1 )

**JMP Version Added:** 16

#### [Shortest Half Color](#shortest-half-color)

**Syntax:** obj \<< Shortest Half Color( color )

**JMP Version Added:** 16

#### [Width Proportion](#width-proportion)

**Syntax:** obj \<< Width Proportion( number=0 )

**Description:** "0" by default.

**JMP Version Added:** 15

## [Caption Element](#caption-element)

### [Associated Constructors](#associated-constructors_4)

#### [Caption Element](#caption-element_1)

**Syntax:** Caption Element

**Description:** Shows a summary statistic value for the data.

**Axis table summary statistics**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// caption axis table
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :sex ), Y( :height ) ),
    Elements(
        Bar( X, Y, Legend( 4 ) ),
        Caption Box(
            X,
            Y,
            Legend( 5 ),
            Summary Statistic( "Mean" ),
            Summary Statistic 2( "N" ),
            Location( "Axis Table" )
        )
    )
);


```

**Data-driven reference line**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// caption reference line, run chart
Graph Builder(
    Show Control Panel( 0 ),
    Variables( Y( :weight ) ),
    Elements(
        Caption Box(
            Y,
            Legend( 5 ),
            Summary Statistic( "Mean" ),
            Location( "Axis Reference Line" ),
            X Position( "Left" )
        ),
        Line( Y, Legend( 6 ), Ordering( "Row Order" ) )
    )
);


```

**Graph-level caption summary statistic**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// caption annotation per graph
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Group X( :sex ) ),
    Elements(
        Points( X, Y, Legend( 2 ) ),
        Line Of Fit( X, Y, Legend( 4 ) ),
        Caption Box( X, Y, Legend( 5 ), Summary Statistic( "N" ), X Position( "Left" ) )
    )
);


```

**Two caption statistics, per factor**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// caption per factor, mean and count, custom number format
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :sex ), Y( :height ) ),
    Elements(
        Bar( X, Y, Legend( 4 ) ),
        Caption Box(
            X,
            Y,
            Legend( 5 ),
            Summary Statistic( "Mean" ),
            Summary Statistic 2( "N" ),
            Location( "Graph per factor" ),
            Number Format( "Best", 5 )
        )
    )
);


```

### [Item Messages](#item-messages_4)

#### [Location](#location)

**Syntax:** obj \<< Location( "Graph"|"Graph per factor"|"Axis Table"|"Axis Reference Line" )

#### [Number Format](#number-format)

**Syntax:** obj \<< Number Format

**JMP Version Added:** 16

#### [Per Factor](#per-factor)

**Syntax:** obj \<< Per Factor( state=0|1 )

**JMP Version Added:** 14

#### [Response Axis](#response-axis_3)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Summary Statistic](#summary-statistic_3)

**Syntax:** obj \<< Summary Statistic( "None"|"N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile"|"5 Number Summary" )

#### [Summary Statistic 2](#summary-statistic-2)

**Syntax:** obj \<< Summary Statistic 2( "None"|"N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile"|"5 Number Summary" )

#### [Summary Statistic 3](#summary-statistic-3)

**Syntax:** obj \<< Summary Statistic 3( "None"|"N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile"|"5 Number Summary" )

#### [Summary Statistic 4](#summary-statistic-4)

**Syntax:** obj \<< Summary Statistic 4( "None"|"N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile"|"5 Number Summary" )

#### [Summary Statistic 5](#summary-statistic-5)

**Syntax:** obj \<< Summary Statistic 5( "None"|"N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile"|"5 Number Summary" )

#### [X Position](#x-position)

**Syntax:** obj \<< X Position( "Left"|"Middle"|"Right" )

#### [Y Position](#y-position)

**Syntax:** obj \<< Y Position( "Top"|"Middle"|"Bottom" )

## [Contour Element](#contour-element)

### [Associated Constructors](#associated-constructors_5)

#### [Contour Element](#contour-element_1)

**Syntax:** Contour Element

**Description:** Shows regions of data density (or value contours with a Color variable). Produces violin plots when X is categorical.

**Bivariate kernel density contour**

```

Open( "$SAMPLE_DATA/Airline Delays.jmp" );
// bivariate kernel density contour
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Distance ), Y( :Arrival Delay ), Wrap( :Airline ) ),
    Elements( Contour( X, Y, Legend( 6 ), Number of Levels( 6 ) ) )
);


```

**Geographic contour**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
// contour, geographic, background map, clipped to shapes, sequential colors, hidden axes
Graph Builder(
    Show Control Panel( 0 ),
    Show X Axis( 0 ),
    Show Y Axis( 0 ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ), Color( :PM10 ) ),
    Elements(
        Contour(
            X,
            Y,
            Legend( 5 ),
            Boundary( 0 ),
            Number of Levels( 5 ),
            Alpha( 0.04 ),
            Smoothness( 0.02 )
        )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Properties( 0, {gradient( {Color Theme( "White to Red" )} )} )
            )}
        ),
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 1 ),
            Reference Line Order( 4 ), Reorder Segs( {1, 3} ),
            DispatchSeg( Contour Seg( 1 ), {Clip Shape( Boundaries( "US States" ) )} )}
        )
    )
);


```

**HDR, highest denisty regions**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// HDR, highest denisty regions with mode line
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ) ),
    Elements( Contour( X, Y, Legend( 4 ), Smoothness( 0.113 ), Contour Type 1D( "HDR" ) ) )
);


```

**Paneled contour heatmap**

```

Open( "$SAMPLE_DATA/Design Experiment/Peanut Data.jmp" );
// paneled contour heatmap, trellis
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Ratio ),
        Y( :Agitation Speed ),
        Group X( :Hydrolyze ),
        Group Y( :"Pre-Soak"n ),
        Color( :Solids )
    ),
    Elements( Contour( X, Y, Legend( 28 ), Smoothness( 0.01 ) ) )
);


```

**Smooth contours**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// contour plot, smooth contours, alpha shapes for non-convex hull
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Culmen Length ), Y( :Flipper Length ), Color( :Body Mass ) ),
    Elements(
        Contour(
            X,
            Y,
            Legend( 7 ),
            Number of Levels( 5 ),
            Alpha( 0.1 ),
            Smoothness( 0.065 )
        )
    )
);


```

**Violin plots overlaid with thin box plots**

```

Open( "$SAMPLE_DATA/S4 Temps.jmp" );
// violin plots overlaid with thin box plots
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :type of space ), Y( :Y ) ),
    Elements(
        Contour( X, Y, Legend( 5 ), Violin Scaling( "Weighted Area" ) ),
        Box Plot( X, Y, Legend( 6 ), Outliers( 0 ), Box Style( "Thin" ), Fences( 0 ) )
    )
);


```

**Violin plots with median line and mean diamond**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// violin plots, overlaid median line and mean diamond marker
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ) ),
    Elements(
        Contour( X, Y, Legend( 3 ) ),
        Bar( X, Y, Legend( 4 ), Bar Style( "Float" ), Summary Statistic( "Median" ) ),
        Points( X, Y, Legend( 5 ), Summary Statistic( "Mean" ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 5, Properties( 0, {Marker( "Diamond" )} ) )}
        )
    )
);


```

**Violin plots with quartiles**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// violin plots, overlaid median line and quartile intervals
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ) ),
    Elements(
        Contour( X, Y, Legend( 3 ) ),
        Bar(
            X,
            Y,
            Legend( 4 ),
            Bar Style( "Float" ),
            Summary Statistic( "Median" ),
            Error Interval( "Interquartile Range" )
        )
    )
);


```

### [Item Messages](#item-messages_5)

#### [Adapt to Axis Scale](#adapt-to-axis-scale)

**Syntax:** obj \<< Adapt to Axis Scale( state=0|1 )

**Description:** For log and other axis transformations, apply computations on the transformed coordinates.

#### [Alpha](#alpha)

**Syntax:** obj \<< Alpha( number )

**Description:** Controls the shape of the boundary. A value of 0 results in the convex hull of the point set. Larger values eliminate triangles with long edges.

**JMP Version Added:** 15

#### [Boundary](#boundary)

**Syntax:** obj \<< Boundary( state=0|1 )

**Description:** Draw a line at the boundary of the defined data region. This boundary might be non-convex depending on the Alpha property.

**JMP Version Added:** 15

#### [Contour Placement](#contour-placement)

**Syntax:** obj \<< Contour Placement( "Offset"|"Align" )

**JMP Version Added:** 16

#### [Contour Type](#contour-type)

**Syntax:** obj \<< Contour Type( "Violin"|"HDR" )

**JMP Version Added:** 15

#### [Contour Type 1D](#contour-type-1d)

**Syntax:** obj \<< Contour Type 1D( "Violin"|"HDR" )

**JMP Version Added:** 15

#### [Contour Type 2D](#contour-type-2d)

**Syntax:** obj \<< Contour Type 2D( "Nonpar Density"|"Bagplot"|"HDR" )

**JMP Version Added:** 15

#### [Fill](#fill)

**Syntax:** obj \<< Fill( state=0|1 )

**Description:** Fill the regions between the contours using colors from the gradient.

**JMP Version Added:** 15

#### [Jitter](#jitter_1)

**Syntax:** obj \<< Jitter( "None"|"Auto"|"Random Uniform"|"Random Normal"|"Density Random"|"Packed"|"Grid"|"Hex Grid"|"Beeswarm" )

#### [Line](#line)

**Syntax:** obj \<< Line( state=0|1 )

**Description:** Draw a line at each contour level, colored by the gradient or by a separate line color.

**JMP Version Added:** 15

#### [Number of Levels](#number-of-levels)

**Syntax:** obj \<< Number of Levels( number )

**Description:** Set the number of filled contour regions to draw.

#### [Outliers](#outliers_1)

**Syntax:** obj \<< Outliers( state=0|1 )

#### [Smoothness](#smoothness_1)

**Syntax:** obj \<< Smoothness( number )

**Description:** Smooths the underlying data and the contours.

**JMP Version Added:** 14

#### [Transform](#transform)

**Syntax:** obj \<< Transform( "None"|"Range Normalized" )

**Description:** Optionally transform the points prior to computing triangulation, which is used for interpolation.

#### [Violin Scaling](#violin-scaling)

**Syntax:** obj \<< Violin Scaling( "Equal Area"|"Equal Width"|"Weighted Area" )

**JMP Version Added:** 14

## [Ellipse Element](#ellipse-element)

### [Associated Constructors](#associated-constructors_6)

#### [Ellipse Element](#ellipse-element_1)

**Syntax:** Ellipse Element

**Description:** Shows a bivariate normal density ellipse.

**Density ellipse in panels**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// density ellipse, correlation coefficient, panels, mean diamond
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Culmen Depth ),
        Y( :Culmen Length ),
        Group X( :Species ),
        Group Y( :Sex )
    ),
    Elements(
        Points( X, Y, Legend( 8 ) ),
        Ellipse( X, Y, Legend( 10 ), Correlation( 1 ), Mean Point( 1 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 8, Properties( 0, {Marker( "Circle" ), Transparency( 0.5 )} ) ),
            Legend Model(
                10,
                Properties( 1, {Marker( "Filled Diamond" ), Marker Size( 6 )} )
            )}
        )
    )
);


```

**Density ellipse with central mean marker**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// density ellipse, correlation, central mean
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Group Y( :sex ) ),
    Elements(
        Points( X, Y, Legend( 2 ) ),
        Ellipse( X, Y, Legend( 5 ), Coverage( "95%" ), Mean Point( 1 ) )
    )
);


```

**Density ellipse with correlation coefficient**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// density ellipse, correlation coefficient
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Culmen Depth ), Y( :Culmen Length ), Overlay( :Species ) ),
    Elements(
        Points( X, Y, Legend( 8 ) ),
        Ellipse( X, Y, Legend( 10 ), Coverage( "50%" ), Correlation( 1 ), Mean Point( 1 ) )
    )
);


```

**Overlaid density ellipses**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// overlaid density ellipse, correlation coefficient
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 2 ) ), Ellipse( X, Y, Legend( 5 ), Correlation( 1 ) ) )
);


```

### [Item Messages](#item-messages_6)

#### [Adapt to Axis Scale](#adapt-to-axis-scale_1)

**Syntax:** obj \<< Adapt to Axis Scale( state=0|1 )

**Description:** For log and other axis transformations, apply computations on the transformed coordinates.

#### [Correlation](#correlation)

**Syntax:** obj \<< Correlation( state=0|1 )

**Description:** Coefficient of correlation for the X and Y variables.

#### [Coverage](#coverage)

**Syntax:** obj \<< Coverage( "99%"|"95%"|"90%"|"50%" )

#### [Mean Point](#mean-point)

**Syntax:** obj \<< Mean Point( state=0|1 )

**Description:** Shows the mean point of the ellipse.

## [Formula Element](#formula-element)

### [Associated Constructors](#associated-constructors_7)

#### [Formula Element](#formula-element_1)

**Syntax:** Formula Element

**Description:** Shows a function defined by a column formula.

**Model comparison**

```

Open( "$SAMPLE_DATA/Nonlinear Examples/Corn.jmp" );
// function plot, non-linear functions piecewise linear, piecewise quadratic
Local( {obj},
    obj = Data Table( "Corn.jmp" ) << Nonlinear(
        Y( :yield ),
        X( :linear ),
        "Newton",
        Finish
    );
    obj << Save Prediction Formula;
    obj << Close Window;
);
Local( {obj},
    obj = Data Table( "Corn.jmp" ) << Nonlinear(
        Y( :yield ),
        X( :quad ),
        "QuasiNewton SR1",
        Finish
    );
    obj << Save Prediction Formula;
    obj << Close Window;
);
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :nitrate ),
        Y( :yield ),
        Y( :Fitted linear, Position( 1 ) ),
        Y( :Fitted quad, Position( 1 ) )
    ),
    Elements( Points( X, Y( 1 ), Legend( 8 ) ), Formula( X, Y( 2 ), Y( 3 ), Legend( 9 ) ) )
);


```

**Parametric equations**

```

New Table( "bowtie",
    New Column( "t", Set Values( [0, 10] ) ),
    New Column( "x", Formula( Cos( :t ) ) ),
    New Column( "y", Formula( Sine( :t * 2 ) ) )
);
// function plot, parametric equations
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :x ), Y( :y ) ),
    Elements( Formula( X, Y, Legend( 5 ) ) ),
    SendToReport(
        Dispatch( {}, "x", ScaleBox, {Min( -1.1 ), Max( 1.1 )} ),
        Dispatch( {}, "y", ScaleBox, {Min( -1.4 ), Max( 1.4 )} )
    )
);


```

### [Item Messages](#item-messages_7)

#### [Response Axis](#response-axis_4)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

## [Heatmap Element](#heatmap-element)

### [Associated Constructors](#associated-constructors_8)

#### [Heatmap Element](#heatmap-element_1)

**Syntax:** Heatmap Element

**Description:** Shows counts using color for X and Y categories.

**Categorical heatmap with custom gradient**

```

Open( "$SAMPLE_DATA/Airline Delays.jmp" );
// heat map, custom gradient
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Day of Week ), Y( :Month ), Color( :Arrival Delay ) ),
    Elements( Heatmap( X, Y, Legend( 17 ) ) ),
    Local Data Filter(
        Add Filter( columns( :Distance ), Where( :Distance >= 500 & :Distance <= 1500 ) )
    ),
    SendToReport(
        Dispatch( {}, "Month", ScaleBox, {Reversed Scale} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                17,
                Properties(
                    0,
                    {gradient(
                        {Color Theme(
                            {"Blue to Gray to Red Copy", {"Continuous", "Categorical",
                            "Diverging"}, {{42, 63, 255}, {166, 170, 203}, {192, 192, 192},
                            {201, 165, 165}, {252, 11, 11}, Missing( "Black" )}, {0, 0.33,
                            0.5, 0.67, 1}, {"Full Color", "Tritanopia"}}
                        ), Scale Values( [. 0 .] )}
                    )}
                )
            )}
        )
    )
);


```

**Data-driven background color**

```

Open( "$SAMPLE_DATA/Corn Wheat Soybean Production.jmp" );
// heat map as background color
Graph Builder(
    Transform Column(
        "Mean[Total Acres Planted][State]",
        Formula( Col Mean( :Total Acres Planted, :State ) )
    ),
    Transform Column(
        "delta",
        Formula(
            (Col At( :Total Acres Planted, -1, :State )
            -Col At( :Total Acres Planted, 1, :State )) /
            Col Mean( :Total Acres Planted, :State )
        )
    ),
    Show Control Panel( 0 ),
    Variables(
        X( :Year ),
        Y( :Total Acres Planted ),
        Wrap(
            :State,
            Order By( :Total Acres Planted, "Descending", Order Statistic( "Mean" ) )
        ),
        Color( :delta )
    ),
    Elements(
        Heatmap( Legend( 16 ) ),
        Points( X, Y, Color( 0 ), Legend( 14 ) ),
        Smoother( X, Y, Color( 0 ), Legend( 15 ) )
    ),
    Local Data Filter(
        Add Filter(
            columns( :"Mean[Total Acres Planted][State]"n ),
            Where( :"Mean[Total Acres Planted][State]"n >= 3245000 )
        )
    ),
    SendToReport(
        Dispatch( {}, "Total Acres Planted", ScaleBox,
            {Format( "Engineering SI", 13 ), Minor Ticks( 0 )}
        ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                16,
                Properties(
                    0,
                    {gradient(
                        {Scale Values( [-0.3 0 0.3] ), Label Format( "Percent", 12, 0 )}
                    )}
                )
            )}
        ),
        Dispatch( {}, "400", LegendBox, {Legend Position( {16, [2], 14, [0], 15, [1]} )} )
    )
);


```

**Heatmap with categorical color**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// heat map, categorical color
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Culmen Depth ), Y( :Culmen Length ), Color( :Species ) ),
    Elements( Heatmap( X, Y, Legend( 4 ) ) )
);


```

**Hexagonal heatmap of counts**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// hexagonal heatmap, color by count, sequential color gradient
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Culmen Depth ), Y( :Culmen Length ) ),
    Elements(
        Heatmap( X, Y, Legend( 4 ), Bin Shape( "Hexagonal" ), Hex Bin Radius( 24.61 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                4,
                Properties( 0, {gradient( {Color Theme( "White to Purple" )} )} )
            )}
        )
    )
);


```

**Labeled heatmap**

```

Open( "$SAMPLE_DATA/Design Experiment/Peanut Data.jmp" );
// labeled heatmap, treating continuous variables as categorical with transform
Graph Builder(
    Transform Column( "Ordinal Agitation Speed", Ordinal, Formula( :Agitation Speed ) ),
    Transform Column( "Ordinal Ratio", Ordinal, Formula( :Ratio ) ),
    Show Control Panel( 0 ),
    Variables( X( :Ordinal Agitation Speed ), Y( :Ordinal Ratio ), Color( :Solids ) ),
    Elements( Heatmap( X, Y, Legend( 29 ), Label( "Label by Value" ) ) )
);


```

**Wafer map**

```

Open( "$SAMPLE_DATA/Wafer Stacked.jmp" );
// wafer map, heat map, trellis, wrap arrangement
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :X_Die ), Y( :Y_Die ), Wrap( :Wafer ), Color( :Defects ) ),
    Elements( Heatmap( X, Y, Legend( 8 ) ) ),
    SendToReport(
        Dispatch( {}, "X_Die", ScaleBox, {Minor Ticks( 9 )} ),
        Dispatch( {}, "Y_Die", ScaleBox, {Minor Ticks( 9 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                8,
                Properties( 0, {gradient( {Color Theme( "White to Orange" )} )} )
            )}
        )
    )
);


```

### [Item Messages](#item-messages_8)

#### [Bin Shape](#bin-shape)

**Syntax:** obj \<< Bin Shape( "Rectangular"|"Hexagonal" )

**JMP Version Added:** 16

#### [Cell Outline](#cell-outline)

**Syntax:** obj \<< Cell Outline( state=0|1 )

**Description:** Defines the maximum increase in font size.

**JMP Version Added:** 16

#### [Hex Bin Radius](#hex-bin-radius)

**Syntax:** obj \<< Hex Bin Radius( number )

**JMP Version Added:** 16

#### [Label](#label_1)

**Syntax:** obj \<< Label( "No Labels"|"Label by Value"|"Label by Percent of Total Values"|"Label by Row" )

**JMP Version Added:** 14

#### [Label Format](#label-format_1)

**Syntax:** obj \<< Label Format

**JMP Version Added:** 16

#### [Max Label Size](#max-label-size)

**Syntax:** obj \<< Max Label Size( number )

## [Histogram Element](#histogram-element)

### [Associated Constructors](#associated-constructors_9)

#### [Histogram Element](#histogram-element_1)

**Syntax:** Histogram Element

**Description:** Shows a variable’s distribution using binning.

**Histogram with count axis**

```

Open( "$SAMPLE_DATA/Airline Delays.jmp" );
// histogram, count
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables( X( :Distance ), Wrap( :Airline, Show Title( 0 ) ) ),
    Elements( Histogram( X, Legend( 9 ) ) ),
    SendToReport(
        Dispatch( {}, "Distance", ScaleBox,
            {Min( -6 ), Max( 2900 ), Inc( 1000 ), Minor Ticks( 1 )}
        ),
        Dispatch( {}, "", ScaleBox, {Format( "Engineering SI", 12 ), Inc( 2000 )} ),
        Dispatch( {}, "graph title", TextEditBox,
            {Set Text( "Flight Distance by Airline" )}
        )
    )
);


```

**Histograms by factor level**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// histograms by level
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :sex ) ),
    Elements( Histogram( X, Y, Legend( 8 ) ) )
);


```

**Overlaid histograms, percent labels**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// overlaid histograms, percent labels
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Overlay( :sex ) ),
    Elements( Histogram( X, Legend( 8 ), Smoothness( -0.0833 ), Percents( 1 ) ) )
);


```

**Ridgeline plot**

```

Open( "$SAMPLE_DATA/NYC 311 Records.jmp" );
// ridgeline plot, overlapping kernel density estimate areas, KDE
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables( X( :Time ), Y( :Day of Week ) ),
    Elements(
        Histogram(
            X,
            Y,
            Legend( 3 ),
            Response Scale( "Percent" ),
            Overlap( 4.8 ),
            Histogram Style( "Kernel Density" ),
            Smoothness( -0.1 )
        )
    ),
    SendToReport(
        Dispatch( {}, "Time", ScaleBox, {Min( -2316 ), Max( 88403 ), Minor Ticks( 3 )} ),
        Dispatch( {}, "Day of Week", ScaleBox, {Max( 4.45 )} )
    )
);


```

**Smooth kernel density area**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// kernel density estimate KDE area chart
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :sex ) ),
    Elements(
        Histogram(
            X,
            Y,
            Legend( 8 ),
            Histogram Style( "Kernel Density" ),
            Smoothness( -0.08 )
        )
    )
);


```

### [Item Messages](#item-messages_9)

#### [Confid Percent](#confid-percent)

**Syntax:** obj \<< Confid Percent( number=. )

**Description:** Confidence interval for the mean, given the coverage in percent. "." by default.

**JMP Version Added:** 14

#### [Counts](#counts)

**Syntax:** obj \<< Counts( state=0|1 )

**JMP Version Added:** 15

#### [Histogram Style](#histogram-style)

**Syntax:** obj \<< Histogram Style( "Bar"|"Polygon"|"Kernel Density"|"Shadowgram" )

**JMP Version Added:** 15

#### [Horizontal](#horizontal)

**Syntax:** obj \<< Horizontal( state=0|1 )

#### [Means and Std Devs](#means-and-std-devs)

**Syntax:** obj \<< Means and Std Devs( state=0|1 )

**JMP Version Added:** 14

#### [Overlap](#overlap_1)

**Syntax:** obj \<< Overlap( number )

**JMP Version Added:** 15

#### [Percents](#percents)

**Syntax:** obj \<< Percents( state=0|1 )

**JMP Version Added:** 15

#### [Response Axis](#response-axis_5)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Response Scale](#response-scale)

**Syntax:** obj \<< Response Scale( "Count"|"Percent"|"Fill" )

**JMP Version Added:** 15

#### [Smoothness](#smoothness_2)

**Syntax:** obj \<< Smoothness( number )

**Description:** The bandwidth controls the amount of smoothing in the density curve. Decreasing the bandwidth makes the curve less smooth with more spikes. Increasing the bandwidth will smooth the curve but might obscure some detail.

**JMP Version Added:** 15

#### [Vertical](#vertical)

**Syntax:** obj \<< Vertical( state=0|1 )

**Description:** On by default.

#### [t Test for Mean At](#t-test-for-mean-at)

**Syntax:** obj \<< t Test for Mean At( number=. )

**Description:** Test that the mean is a specified value. "." by default.

**JMP Version Added:** 14

## [Line Element](#line-element)

### [Associated Constructors](#associated-constructors_10)

#### [Line Element](#line-element_1)

**Syntax:** Line Element

**Description:** Shows a response summarized by categories.

**Arrow lines, one per row**

```

Open( "$SAMPLE_DATA/Cholesterol.jmp" );
// arrow lines, one per row
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :April AM ),
        X( :April PM, Position( 1 ) ),
        Y( :June AM ),
        Y( :June PM, Position( 1 ) ),
        Overlay( :treatment )
    ),
    Elements(
        Line(
            X( 1 ),
            X( 2 ),
            Y( 1 ),
            Y( 2 ),
            Legend( 8 ),
            Ordering( "Within Row" ),
            Connection( "Arrow" )
        )
    )
);


```

**Bump chart, connected rankings**

```

Open( "$SAMPLE_DATA/SATByYear.jmp" );
// Bump chart, line chart of ranking, smooth connections, transform column
Graph Builder(
    Transform Column(
        "Rank",
        Formula(
            (Col Number( :SAT Verbal, :Year, :"@Exclude"n, :"@Filter"n )
            -Col Rank( :SAT Verbal, :Year, :"@Exclude"n, :"@Filter"n )) + 1
        )
    ),
    Show Control Panel( 0 ),
    Variables( X( :Year ), Y( :Rank ), Overlay( :State ) ),
    Elements( Line( X, Y, Legend( 4 ), Connection( "Curve" ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :Region ),
            Where(
                :Region == {"Midwest", "Mountain", "New England", "Northeast", "Pacific",
                "Plains", "South", "Southwest"}
            )
        )
    ),
    SendToReport( Dispatch( {}, "Rank", ScaleBox, {Reversed Scale} ) )
);


```

**Connected arrows**

```

Open( "$SAMPLE_DATA/SAT.jmp" );
// arrow chart, multiple x and y variables, overlaid
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :"1992 Verbal"n ),
        X( :"1999 Verbal"n, Position( 1 ) ),
        X( :"2004 Verbal"n, Position( 1 ) ),
        Y( :"1992 Math"n ),
        Y( :"1999 Math"n, Position( 1 ) ),
        Y( :"2004 Math"n, Position( 1 ) ),
        Overlay( :State )
    ),
    Elements(
        Line(
            X( 1 ),
            X( 2 ),
            X( 3 ),
            Y( 1 ),
            Y( 2 ),
            Y( 3 ),
            Legend( 7 ),
            Ordering( "Within Row" ),
            Connection( "Arrow" )
        )
    ),
    Local Data Filter(
        Add Filter( columns( :"% Taking (2004)"n ), Where( :"% Taking (2004)"n >= 0.57788 ) )
    ),
    SendToReport(
        Dispatch( {}, "1992 Verbal & 2 more", TextEditBox, {Set Text( "Verbal" )} ),
        Dispatch( {}, "1992 Math & 2 more", TextEditBox, {Set Text( "Math" )} )
    )
);


```

**Connected scatter plot**

```

New Table( "prey and predator",
    Add Rows( 48 ),
    New Column( "Month", Formula( Row() ) ),
    New Column( "Rabbits", Formula( 10 * Cos( :Month * 0.35 ) + Random Normal( 50, 1.5 ) ) ),
    New Column( "Foxes", Formula( 8 * Cos( :Month * 0.35 + 1 ) + Random Normal( 30, 1 ) ) ),

);
// connected scatter plot, smooth line connections, row order
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Foxes ), Y( :Rabbits ), Color( :Month ) ),
    Elements(
        Line( X, Y, Legend( 5 ), Ordering( "Row Order" ), Connection( "Curve" ) ),
        Points( X, Y, Color( 0 ), Legend( 6 ) )
    )
);


```

**Event spans**

```

Open( "$SAMPLE_DATA/Nic Adverse Events.jmp" );
// event spans, start and stop times, categorical color
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Study Day of Start of Adverse Event ),
        X( :Study Day of End of Adverse Event, Position( 1 ) ),
        Y( :Unique Subject Identifier ),
        Color( :"Severity/Intensity"n )
    ),
    Elements( Line( X( 1 ), X( 2 ), Y, Legend( 4 ), Ordering( "Within Row" ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :"Dictionary-Derived Term"n, :Action Taken with Study Treatment ),
            Where( :"Dictionary-Derived Term"n == "Hypertension" ),
            Where( :Action Taken with Study Treatment == "DRUG WITHDRAWN" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Unique Subject Identifier", ScaleBox,
            {Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                4,
                Properties( 0, {Line Color( RGB Color( 0.31, 0.61, 1 ) ), Line Width( 4 )} ),
                Properties(
                    1,
                    {Line Color( RGB Color( 0.69, 0.65, 0.01 ) ), Line Width( 4 )}
                ),
                Properties(
                    2,
                    {Line Color( RGB Color( 0.79, 0.09, 0.16 ) ), Line Width( 4 )}
                )
            )}
        )
    )
);


```

**Labeled lines**

```

Open( "$SAMPLE_DATA/Airline Delays.jmp" );
// overlaid line chart, labels in graph
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables( X( :Day of Week ), Y( :Arrival Delay ), Overlay( :Airline ) ),
    Elements( Line( X, Y, Legend( 11 ) ) ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                11,
                Type Properties( "H Line", {Line Label Properties( {Name Label( 1 )} )} ),
                Properties( 0, {Line Label Properties( {Name Label( 1 )} )} ),
                Properties( 1, {Line Label Properties( {Name Label( 1 )} )} ),
                Properties( 2, {Line Label Properties( {Name Label( 1 )} )} ),
                Properties( 3, {Line Label Properties( {Name Label( 1 )} )} ),
                Properties( 4, {Line Label Properties( {Name Label( 1 )} )} ),
                Properties( 5, {Line Label Properties( {Name Label( 1 )} )} )
            )}
        )
    )
);


```

**Line chart with error band**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// line chart, error band
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ) ),
    Elements(
        Line(
            X,
            Y,
            Legend( 4 ),
            Error Interval( "Confidence Interval" ),
            Interval Style( "Band" )
        )
    )
);


```

**Moving average line chart**

```

Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
// moving average line chart
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Pin ), Y( :Weight ), Color( :Product ) ),
    Elements(
        Points( X, Y, Legend( 11 ) ),
        Smoother( X, Y, Color( 0 ), Legend( 12 ), Method( "Moving Average" ) )
    ),
    SendToReport(
        Dispatch( {}, "Pin", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "Weight", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                12,
                Properties( 0, {Line Color( RGB Color( 0.25, 0.25, 0.25 ) )} )
            )}
        )
    )
);


```

**Run chart, by row order**

```

Open( "$SAMPLE_DATA/Time Series/Air.jmp" );
// Run chart, line chart by row, grid lines
Graph Builder(
    Show Control Panel( 0 ),
    Variables( Y( :Ozone Concentration ) ),
    Elements( Line( Y, Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "", ScaleBox,
            {Min( 0 ), Max( 220 ), Label Row( {Show Major Grid( 1 ), Show Minor Grid( 1 )} )}
        ),
        Dispatch( {}, "Ozone Concentration", ScaleBox, {Label Row( Show Major Grid( 1 ) )} )
    )
);


```

**Spaghetti plot**

```

Open( "$SAMPLE_DATA/Time Series/Air.jmp" );
// Spaghetti plot, line chart, smooth connections, mean line, transform column
Graph Builder(
    Transform Column( "Year", Nominal, Formula( Year( :date ) ) ),
    Show Control Panel( 0 ),
    Variables( X( :month ), Y( :Ozone Concentration ), Overlay( :Year ) ),
    Elements(
        Line( X, Y, Legend( 8 ), Connection( "Curve" ) ),
        Line( X, Y, Overlay( 0 ), Legend( 9 ), Connection( "Curve" ), Smoothness( 0.6 ) )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                8,
                Properties( 0, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 1, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 2, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 3, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 4, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 5, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 6, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 7, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 8, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 9, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 10, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 11, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 12, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 13, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 14, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 15, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 16, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 17, {Line Color( "gray" ), Transparency( 0.5 )} ),
                Properties( 18, {Line Color( "gray" ), Transparency( 0.5 )} )
            ), Legend Model( 9, Properties( 0, {Line Color( "black" ), Line Width( 4 )} ) )}
        )
    )
);


```

**Trailing moving average line chart**

```

Open( "$SAMPLE_DATA/Quality Control/Coating.jmp" );
// trailing moving average line chart
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Pin ), Y( :Weight ), Color( :Product ) ),
    Elements(
        Points( X, Y, Legend( 11 ) ),
        Smoother(
            X,
            Y,
            Color( 0 ),
            Legend( 12 ),
            Method( "Moving Average" ),
            Local Region( "Trailing" ),
            Local Width( 6 ),
            Trim( 0.6435 )
        )
    ),
    SendToReport(
        Dispatch( {}, "Pin", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "Weight", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                12,
                Properties( 0, {Line Color( RGB Color( 0.25, 0.25, 0.25 ) )} )
            )}
        )
    )
);


```

### [Item Messages](#item-messages_10)

#### [Connection](#connection_1)

**Syntax:** obj \<< Connection( "Line"|"Arrow"|"Curve"|"Step"|"Centered Step"|"Horizontal"|"Vertical" )

#### [Error Interval](#error-interval_2)

**Syntax:** obj \<< Error Interval( "Auto"|"None"|"Range"|"Interquartile Range"|"Standard Error"|"Standard Deviation"|"Confidence Interval"|"Median Absolute Deviation"|"Custom Interval"|"Two-way Interval" )

#### [Fill](#fill_1)

**Syntax:** obj \<< Fill( "None"|"Fill Below"|"Fill Between" )

**JMP Version Added:** 15

#### [Interval Style](#interval-style_2)

**Syntax:** obj \<< Interval Style( "Error Bar"|"Band"|"Hash Band"|"Arrow" )

#### [Missing Factors](#missing-factors_1)

**Syntax:** obj \<< Missing Factors( "Skip"|"Treat as Missing"|"Treat as Zero" )

**Description:** How to show connections that span missing factor levels

**JMP Version Added:** 15

#### [Missing Values](#missing-values_1)

**Syntax:** obj \<< Missing Values( "Connect Through"|"Connect Faded"|"Connect Dashed"|"No Connection" )

**Description:** How to show connections that span missing values.

#### [Ordering](#ordering_1)

**Syntax:** obj \<< Ordering( "Auto"|"Row Order"|"Summarized"|"Within Row" )

#### [Response Axis](#response-axis_6)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Row order](#row-order_1)

**Syntax:** obj \<< Row order( state=0|1 )

#### [Save Summary Formula](#save-summary-formula_2)

**Syntax:** obj \<< Save Summary Formula

#### [Smoothness](#smoothness_3)

**Syntax:** obj \<< Smoothness( number )

#### [Stack](#stack)

**Syntax:** obj \<< Stack( state=0|1 )

**JMP Version Added:** 15

#### [Stack Negative](#stack-negative_1)

**Syntax:** obj \<< Stack Negative( "Overlap"|"Separate Negative"|"Treat as Zero" )

**Description:** Controls how negative data values are handled when stacked.

**JMP Version Added:** 17

#### [Summary Statistic](#summary-statistic_4)

**Syntax:** obj \<< Summary Statistic( "N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

## [Line of Fit Element](#line-of-fit-element)

### [Associated Constructors](#associated-constructors_11)

#### [Line of Fit Element](#line-of-fit-element_1)

**Syntax:** Line of Fit Element

**Description:** Shows a linear regression with confidence intervals for continuous X and Y. Fits means for categorical X.

**ANOVA fit, oneway, means comparison**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// ANOVA fit, oneway, means comparison, confidence interval, F test p-value
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points( X, Y, Legend( 1 ) ),
        Line Of Fit( X, Y, Legend( 2 ), Unequal Variances( 1 ), F Test( 1 ) )
    )
);


```

**Overlaid linear regressions**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// linear regression, overlaid with confidence intervals
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 2 ) ), Line Of Fit( X, Y, Legend( 4 ) ) )
);


```

**Quadratic fits**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// linear regression, overlaid curves, quadratic
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Culmen Length ), Y( :Flipper Length ), Overlay( :Species ) ),
    Elements(
        Points( X, Y, Legend( 9 ) ),
        Line Of Fit( X, Y, Legend( 10 ), Degree( "Quadratic" ) )
    )
);


```

**Time series regression**

```

Open( "$SAMPLE_DATA/Time Series/Monthly Sales.jmp" );
// time series regression, periodic
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Date ), Y( :Sales ) ),
    Elements(
        Points( X, Y, Legend( 3 ) ),
        Line Of Fit( X, Y, Legend( 5 ), Fit( "Time Series" ), Seasonal Period( 12 ) )
    )
);


```

### [Item Messages](#item-messages_11)

#### [Adapt to Axis Scale](#adapt-to-axis-scale_2)

**Syntax:** obj \<< Adapt to Axis Scale( state=0|1 )

**Description:** For log and other axis transformations, apply computations on the transformed coordinates.

#### [Confidence of Fit](#confidence-of-fit)

**Syntax:** obj \<< Confidence of Fit( state=0|1 )

#### [Confidence of Prediction](#confidence-of-prediction)

**Syntax:** obj \<< Confidence of Prediction( state=0|1 )

#### [Constrain Parameters](#constrain-parameters)

**Syntax:** obj \<< Constrain Parameters( state=0|1 )

**Description:** Constrain ETS parameters.

**JMP Version Added:** 17

#### [Degree](#degree)

**Syntax:** obj \<< Degree( "Linear"|"Quadratic"|"Cubic" )

#### [Equation](#equation)

**Syntax:** obj \<< Equation( state=0|1 )

**Description:** Equation of the fit.

#### [F Test](#f-test)

**Syntax:** obj \<< F Test( state=0|1 )

**Description:** Significance level for the whole-model test.

**JMP Version Added:** 14

#### [Fit](#fit)

**Syntax:** obj \<< Fit( "Polynomial"|"Robust Cauchy"|"Time Series" )

**JMP Version Added:** 15

#### [Forecast Model](#forecast-model)

**Syntax:** obj \<< Forecast Model( state=0|1 )

**Description:** Show which model is used to forecast, with parameter estimates.

**JMP Version Added:** 15

#### [Forecast Periods](#forecast-periods)

**Syntax:** obj \<< Forecast Periods( number )

**Description:** Number of periods ahead to forecast.

**JMP Version Added:** 15

#### [Means and Std Devs](#means-and-std-devs_1)

**Syntax:** obj \<< Means and Std Devs( state=0|1 )

**Description:** Show the means and standard deviations of each group next to mean line.

**JMP Version Added:** 14

#### [Prediction](#prediction)

**Syntax:** obj \<< Prediction( state=0|1 )

**Description:** The confidence region for individual predicted values

#### [RMSE](#rmse)

**Syntax:** obj \<< RMSE( state=0|1 )

**Description:** Root Mean Square Error, a measure of error in units of the response.

#### [Response Axis](#response-axis_7)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Root Mean Square Error](#root-mean-square-error)

**Syntax:** obj \<< Root Mean Square Error( state=0|1 )

#### [R²](#r2)

**Syntax:** obj \<< R²( state=0|1 )

**Description:** Coefficient of determination, a measure of how well the fit predicts the data.

#### [Save Formula](#save-formula)

**Syntax:** obj \<< Save Formula

#### [Seasonal Period](#seasonal-period)

**Syntax:** obj \<< Seasonal Period( number )

**Description:** Number of periods in a season. For example, with monthly data, there are 12 periods for seasonal over a year.

**JMP Version Added:** 15

#### [Unequal Variances](#unequal-variances)

**Syntax:** obj \<< Unequal Variances( state=0|1 )

**Description:** Whether to calculate tests and confidence limits based on assuming different groups have different variances.

## [Mosaic Element](#mosaic-element)

### [Associated Constructors](#associated-constructors_12)

#### [Mosaic Element](#mosaic-element_1)

**Syntax:** Mosaic Element

**Description:** Shows counts using size for X and Y categories.

**Horizontal mosaic**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// horizontal mosaic, axis label line wrapping
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Clutch Completion ), Y( :Species ) ),
    Elements( Mosaic( X, Y, Legend( 5 ), Response Axis( "X" ) ) )
);


```

**Mosaic chart**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// mosaic, marimekko
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :sex ) ),
    Elements( Mosaic( X, Y, Legend( 4 ) ) )
);


```

### [Item Messages](#item-messages_12)

#### [Cell Labeling](#cell-labeling)

**Syntax:** obj \<< Cell Labeling( "No Labels"|"Label by Count"|"Label by Percent"|"Label by Value"|"Label by Row" )

**JMP Version Added:** 14

#### [Chi-square Test](#chi-square-test)

**Syntax:** obj \<< Chi-square Test( state=0|1 )

**Description:** Chi-square test that response rates are the same across groups, or that two responses are independent

**JMP Version Added:** 14

#### [Confid Percent](#confid-percent_1)

**Syntax:** obj \<< Confid Percent( number=. )

**Description:** Confidence interval coverage on the proportion in the upper level, in percent. "." by default.

**JMP Version Added:** 14

#### [Horizontal](#horizontal_1)

**Syntax:** obj \<< Horizontal( state=0|1 )

#### [Label Format](#label-format_2)

**Syntax:** obj \<< Label Format

**JMP Version Added:** 16

#### [Response Axis](#response-axis_8)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Test Proportion At](#test-proportion-at)

**Syntax:** obj \<< Test Proportion At( number=. )

**Description:** Test that the proportion in the upper level is a specified value. "." by default.

**JMP Version Added:** 14

#### [Vertical](#vertical_1)

**Syntax:** obj \<< Vertical( state=0|1 )

**Description:** On by default.

## [Parallel Element](#parallel-element)

### [Associated Constructors](#associated-constructors_13)

#### [Parallel Element](#parallel-element_1)

**Syntax:** Parallel Element

**Description:** Shows many variables along parallel axes with a connected line for each row.

**Parallel box plots**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// parallel coordinates - box plots
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Height ),
        X( :Skinfold, Position( 1 ) ),
        X( :Weight, Position( 1 ) ),
        X( :"% Ideal Body Wt."n, Position( 1 ) ),
        X( :"% Ideal Weight-3yr"n, Position( 1 ) ),
        X( :"Weight-3yr"n, Position( 1 ) ),
        X( :Cholesterol, Position( 1 ) ),
        X( :Triglycerides, Position( 1 ) ),
        X( :HDL, Position( 1 ) ),
        X( :LDL, Position( 1 ) ),
        X( :Cholesterol Loss, Position( 1 ) )
    ),
    Elements(
        Box Plot(
            X( 1 ),
            X( 2 ),
            X( 3 ),
            X( 4 ),
            X( 5 ),
            X( 6 ),
            X( 7 ),
            X( 8 ),
            X( 9 ),
            X( 11 )
        )
    )
);


```

**Parallel coordinates plot**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// parallel coordinates - lines
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Height ),
        X( :Skinfold, Position( 1 ) ),
        X( :Weight, Position( 1 ) ),
        X( :"% Ideal Body Wt."n, Position( 1 ) ),
        X( :"% Ideal Weight-3yr"n, Position( 1 ) ),
        X( :"Weight-3yr"n, Position( 1 ) ),
        X( :Cholesterol, Position( 1 ) ),
        X( :Triglycerides, Position( 1 ) ),
        X( :HDL, Position( 1 ) ),
        X( :LDL, Position( 1 ) ),
        X( :Cholesterol Loss, Position( 1 ) ),
        Color( :Sex )
    ),
    Elements(
        Parallel(
            X( 1 ),
            X( 2 ),
            X( 3 ),
            X( 4 ),
            X( 5 ),
            X( 6 ),
            X( 7 ),
            X( 8 ),
            X( 9 ),
            X( 10 ),
            X( 11 ),
            Smoothness( 0.5 )
        )
    )
);


```

**Parallel coordinates with aligned scale**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// parallel coordinates - aligned scale
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :"Trig-3yrs"n, Combine( "Parallel Merged" ) ),
        X( :"Chol-3yrs"n, Position( 1 ), Combine( "Parallel Merged" ) ),
        X( :"HDL-3yrs"n, Position( 1 ), Combine( "Parallel Merged" ) ),
        X( :"LDL-3yrs"n, Position( 1 ), Combine( "Parallel Merged" ) )
    ),
    Elements( Parallel( X( 1 ), X( 2 ), X( 3 ), X( 4 ), Legend( 8 ) ) )
);


```

**Parallel dot plots**

```

Open( "$SAMPLE_DATA/Lipid Data.jmp" );
// parallel coordinates - dots
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Height ),
        X( :Skinfold, Position( 1 ) ),
        X( :Weight, Position( 1 ) ),
        X( :"% Ideal Body Wt."n, Position( 1 ) ),
        X( :"% Ideal Weight-3yr"n, Position( 1 ) ),
        X( :"Weight-3yr"n, Position( 1 ) ),
        X( :Cholesterol, Position( 1 ) ),
        X( :Triglycerides, Position( 1 ) ),
        X( :HDL, Position( 1 ) ),
        X( :LDL, Position( 1 ) ),
        X( :Cholesterol Loss, Position( 1 ) ),
        Color( :Sex )
    ),
    Points(
        Parallel(
            X( 1 ),
            X( 2 ),
            X( 3 ),
            X( 4 ),
            X( 5 ),
            X( 6 ),
            X( 7 ),
            X( 8 ),
            X( 9 ),
            X( 10 ),
            X( 11 ),
            Smoothness( 0.5 )
        )
    )
);


```

**Parallel sets**

```

Open( "$SAMPLE_DATA/Titanic Passengers.jmp" );
// parallel sets
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Survived ),
        X( :Passenger Class, Position( 1 ) ),
        X( :Sex, Position( 1 ) ),
        X( :Age, Position( 1 ) ),
        Color( :Survived )
    ),
    Elements( Parallel( X( 1 ), X( 2 ), X( 3 ), X( 4 ), Legend( 5 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {DispatchSeg( ParallelAxisSeg( 1 ), Reversed( Passenger Class, Sex ) )}
        )
    )
);


```

**Sankey parallel sets**

```

Open( "$SAMPLE_DATA/Color Preference Survey.jmp" );
// parallel sets, sankey, categorical parallel coordinates
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables(
        X( :What is your gender?, Combine( "Parallel Independent" ) ),
        X(
            :"What is your favorite color? (select one)"n,
            Position( 1 ),
            Combine( "Parallel Independent" )
        ),
        X( :What is your favorite color?, Position( 1 ), Combine( "Parallel Independent" ) ),
        Color( :"What is your favorite color? (select one)"n )
    ),
    Elements( Parallel( X( 1 ), X( 2 ), X( 3 ), Legend( 15 ) ) ),
    SendToReport(
        Dispatch( {}, "What is your gender?", ScaleBox,
            {Label Row(
                {Tick Mark(
                    Label( "What is your favorite color?" ),
                    Label( "Specific favorite color" )
                ), Tick Mark(
                    Label( "What is your favorite color? (select one)" ),
                    Label( "General favorite color" )
                ), Tick Mark( Label( "What is your gender?" ), Label( "Gender" ) )}
            )}
        )
    )
);


```

### [Item Messages](#item-messages_13)

#### [Axes Labels](#axes-labels)

**Syntax:** obj \<< Axes Labels( state=0|1 )

#### [Combine Sets](#combine-sets)

**Syntax:** obj \<< Combine Sets( state=0|1 )

#### [Smoothness](#smoothness_4)

**Syntax:** obj \<< Smoothness( number )

**JMP Version Added:** 16

## [Pie Element](#pie-element)

### [Associated Constructors](#associated-constructors_14)

#### [Pie Element](#pie-element_1)

**Syntax:** Pie Element

**Description:** Shows portions of a whole.

**Donut chart by count**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// donut chart by count
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ) ),
    Elements( Pie( X, Legend( 6 ), Pie Style( "Ring" ) ) )
);


```

**Pie chart by count**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// pie chart by count
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ) ),
    Elements( Pie( X, Legend( 6 ) ) )
);


```

**Pie panel**

```

Open( "$SAMPLE_DATA/Smartphone OS.jmp" );
// pie panel
Graph Builder(
    Transform Column( "Market Share freq", Formula( Round( :Market Share * 1000 ) ) ),
    Show Control Panel( 0 ),
    Show Footer( 0 ),
    Variables( X( :Operating System ), Wrap( :Year ), Frequency( :Market Share freq ) ),
    Elements( Pie( X, Legend( 6 ) ) ),
    SendToReport(
        Dispatch( {}, "graph title", TextEditBox,
            {Set Text( "SmartPhone OS Market Share" )}
        )
    )
);


```

### [Item Messages](#item-messages_14)

#### [Label](#label_2)

**Syntax:** obj \<< Label( "No Labels"|"Label by Value"|"Label by Percent of Total Values"|"Label by Row" )

#### [Label Format](#label-format_3)

**Syntax:** obj \<< Label Format

**JMP Version Added:** 16

#### [Pie Style](#pie-style)

**Syntax:** obj \<< Pie Style( "Pie"|"Ring"|"Coxcomb" )

#### [Summary Statistic](#summary-statistic_5)

**Syntax:** obj \<< Summary Statistic( "N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

## [Points Element](#points-element)

### [Associated Constructors](#associated-constructors_15)

#### [Points Element](#points-element_1)

**Syntax:** Points Element

**Description:** Shows a scatter plot of data values.

**Centered side-by-side dot plots**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// center dot plots, colored by categorical variable
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ), Color( :Sex ) ),
    Elements( Points( X, Y, Legend( 10 ) ) ),
    SendToReport(
        Dispatch( {}, "Species", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                10,
                Properties( 0, {Marker Size( 5 )} ),
                Properties( 1, {Marker Size( 5 )} )
            )}
        )
    )
);


```

**Circle packing jitter**

```

Open( "$SAMPLE_DATA/Design Experiment/Peanut Data.jmp" );
// categorical 2D jitter, circle packing, color by response
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :"Pre-Soak"n ), Y( :Hydrolyze ), Color( :Solids ) ),
    Elements( Points( X, Y, Legend( 4 ) ) ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 4, Properties( 1, {Marker Size( 10 )} ) )}
        )
    )
);


```

**Density dot plot**

```

Open( "$SAMPLE_DATA/Online Consumer Data.jmp" );
// density dot plot, beeswarm
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables( X( :Privacy ), Y( :Female ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Jitter( "Hex Grid" ),
            Jitter Side( "Positive" ),
            Jitter Smooth( 1 )
        )
    ),
    SendToReport(
        Dispatch( {}, "Female", ScaleBox,
            {Min( 0 ), Max( 1.99 ), Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 3, Properties( 0, {Marker( "FilledCircle" )} ) )}
        )
    )
);


```

**Hexagonal grid dot plots**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// center hexagonal grid dot plots, smoothed jitter placement, colored by categorical variable
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ), Color( :Sex ) ),
    Elements( Points( X, Y, Legend( 10 ), Jitter( "Hex Grid" ), Jitter Smooth( 1 ) ) ),
    SendToReport(
        Dispatch( {}, "Species", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                10,
                Properties( 0, {Marker Size( 5 )} ),
                Properties( 1, {Marker Size( 5 )} )
            )}
        )
    )
);


```

**Hexagonal opposite-side dot plots**

```

Open( "$SAMPLE_DATA/S4 Temps.jmp" );
// dot plot, hexagonal jitter from opposite side (ordinal), custom axis label format
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables( X( :Y ), Y( :type of space ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 9 ),
            Jitter( "Hex Grid" ),
            Jitter Side( "Ordinal" ),
            Jitter Smooth( 1 )
        )
    ),
    Local Data Filter(
        Add Filter(
            columns( :type of space ),
            Where( :type of space == {"exterior", "interior"} )
        )
    ),
    SendToReport(
        Dispatch( {}, "Y", ScaleBox,
            {Format( "Custom", Formula( Char( value ) || "°" ), 12, 0 )}
        ),
        Dispatch( {}, "type of space", ScaleBox, {Min( 0 ), Max( 1 )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 9, Properties( 0, {Line Color( "Gray" ), Marker Size( 6 )} ) )}
        ),
        Dispatch( {}, "Y", TextEditBox, {Set Text( "Temperature (Celcius))" )} )
    )
);


```

**Latitude and Longitude**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
// geographic scatter plot, background map, sized dots
Graph Builder(
    Show Control Panel( 0 ),
    Show X Axis( 0 ),
    Show Y Axis( 0 ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ), Color( :PM10 ), Size( :POP ) ),
    Elements( Points( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                2,
                Properties( 0, {Marker Size( 8 )} ),
                Properties( 1, {gradient( {Color Theme( "Muted Yellow to Red" )} )} )
            )}
        ),
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) )}
        )
    )
);


```

**Scatter plot matrix**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// scatter plot matrix with main diagonal histograms
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Culmen Length ),
        X( :Culmen Depth ),
        X( :Flipper Length ),
        X( :Body Mass ),
        Y( :Culmen Length ),
        Y( :Culmen Depth ),
        Y( :Flipper Length ),
        Y( :Body Mass ),
        Overlay( :Species )
    ),
    Elements( Position( 1, 1 ), Histogram( X, Y, Legend( 87 ) ) ),
    Elements(
        Position( 1, 2 ),
        Points( X, Y, Legend( 57 ) ),
        Smoother( X, Y, Legend( 58 ) )
    ),
    Elements(
        Position( 1, 3 ),
        Points( X, Y, Legend( 59 ) ),
        Smoother( X, Y, Legend( 60 ) )
    ),
    Elements(
        Position( 1, 4 ),
        Points( X, Y, Legend( 61 ) ),
        Smoother( X, Y, Legend( 62 ) )
    ),
    Elements(
        Position( 2, 1 ),
        Points( X, Y, Legend( 63 ) ),
        Smoother( X, Y, Legend( 64 ) )
    ),
    Elements( Position( 2, 2 ), Histogram( X, Y, Legend( 88 ) ) ),
    Elements(
        Position( 2, 3 ),
        Points( X, Y, Legend( 67 ) ),
        Smoother( X, Y, Legend( 68 ) )
    ),
    Elements(
        Position( 2, 4 ),
        Points( X, Y, Legend( 69 ) ),
        Smoother( X, Y, Legend( 70 ) )
    ),
    Elements(
        Position( 3, 1 ),
        Points( X, Y, Legend( 71 ) ),
        Smoother( X, Y, Legend( 72 ) )
    ),
    Elements(
        Position( 3, 2 ),
        Points( X, Y, Legend( 73 ) ),
        Smoother( X, Y, Legend( 74 ) )
    ),
    Elements( Position( 3, 3 ), Histogram( X, Y, Legend( 89 ) ) ),
    Elements(
        Position( 3, 4 ),
        Points( X, Y, Legend( 77 ) ),
        Smoother( X, Y, Legend( 78 ) )
    ),
    Elements(
        Position( 4, 1 ),
        Points( X, Y, Legend( 79 ) ),
        Smoother( X, Y, Legend( 80 ) )
    ),
    Elements(
        Position( 4, 2 ),
        Points( X, Y, Legend( 81 ) ),
        Smoother( X, Y, Legend( 82 ) )
    ),
    Elements(
        Position( 4, 3 ),
        Points( X, Y, Legend( 83 ) ),
        Smoother( X, Y, Legend( 84 ) )
    ),
    Elements( Position( 4, 4 ), Histogram( X, Y, Legend( 90 ) ) )
);


```

**Scatter plot using size and color**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// bubble plot
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Culmen Depth ),
        Y( :Culmen Length ),
        Group X( :Species, Show Title( 0 ) ),
        Color( :Sex ),
        Size( :Body Mass )
    ),
    Elements( Points( X, Y, Legend( 20 ) ) ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                20,
                Properties( 1, {Marker( "Circle" ), Transparency( 0.5 )}, ),
                Properties( 2, {Marker( "FilledCircle" ), Transparency( 0.5 )} )
            )}
        )
    )
);


```

**Smoothed centered side-by-side dot plots**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// center dot plots, smoothed jitter placement, colored by categorical variable
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Species ), Y( :Body Mass ), Color( :Sex ) ),
    Elements( Points( X, Y, Legend( 10 ), Jitter Smooth( 0.5 ) ) ),
    SendToReport(
        Dispatch( {}, "Species", ScaleBox, {Label Row( Show Major Grid( 1 ) )} ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                10,
                Properties( 0, {Marker Size( 5 )} ),
                Properties( 1, {Marker Size( 5 )} )
            )}
        )
    )
);


```

**Smoothed dot plot**

```

Open( "$SAMPLE_DATA/Online Consumer Data.jmp" );
// smoothed dot plot, color by ordinal
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Privacy ), Y( :Female ), Color( :Internet Use ) ),
    Elements( Points( X, Y, Legend( 5 ), Jitter Smooth( 0.8 ) ) ),
    SendToReport(
        Dispatch( {}, "Privacy", ScaleBox,
            {Min( -2 ), Max( 2 ), Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "400", ScaleBox,
            {Legend Model(
                5,
                Type Properties( 0, "Marker", {Marker Size( 5 )} ),
                Properties(
                    0,
                    {Line Color( RGB Color( 0.86, 0.52, 0.35 ) ), Marker Size( 5 )}
                ),
                Properties(
                    1,
                    {Line Color( RGB Color( 0.95, 0.79, 0.45 ) ), Marker Size( 5 )}
                ),
                Properties(
                    2,
                    {Line Color( RGB Color( 0.56, 0.02, 0.23 ) ), Marker Size( 5 )}
                ),
                Properties(
                    3,
                    {Line Color( RGB Color( 0.88, 0.9, 0.74 ) ), Marker Size( 5 )}
                )
            )}
        ),
        Dispatch( {}, "400", LegendBox, {Legend Position( {5, [1, 2, 0, 3]} )} )
    )
);


```

**Variability chart**

```

Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
// variability chart, mean and range interval, nested axis
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Operator ), X( :Part, Position( 1 ) ), Y( :Y ) ),
    Elements(
        Points(
            X( 1 ),
            X( 2 ),
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Range" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Operator", ScaleBox, {Label Row( 2, Show Major Grid( 1 ) )} )
    )
);


```

### [Item Messages](#item-messages_15)

#### [Error Interval](#error-interval_3)

**Syntax:** obj \<< Error Interval( "Auto"|"None"|"Range"|"Interquartile Range"|"Standard Error"|"Standard Deviation"|"Confidence Interval"|"Median Absolute Deviation"|"Custom Interval"|"Two-way Interval" )

#### [Interval Style](#interval-style_3)

**Syntax:** obj \<< Interval Style( "Error Bar"|"Band"|"Hash Band"|"Arrow" )

#### [Jitter](#jitter_2)

**Syntax:** obj \<< Jitter( "None"|"Auto"|"Random Uniform"|"Random Normal"|"Density Random"|"Packed"|"Grid"|"Hex Grid"|"Beeswarm" )

#### [Jitter Limit](#jitter-limit)

**Syntax:** obj \<< Jitter Limit( number )

**JMP Version Added:** 14

#### [Jitter Overlap](#jitter-overlap)

**Syntax:** obj \<< Jitter Overlap( number )

**JMP Version Added:** 19

#### [Jitter Side](#jitter-side)

**Syntax:** obj \<< Jitter Side( "Centered"|"Positive"|"Negative"|"Ordinal" )

#### [Jitter Smooth](#jitter-smooth)

**Syntax:** obj \<< Jitter Smooth( number )

**JMP Version Added:** 19

#### [Label](#label_3)

**Syntax:** obj \<< Label( "No Labels"|"Label by Value"|"Label by Row"|"Label by Row and Value" )

#### [Label Format](#label-format_4)

**Syntax:** obj \<< Label Format

**JMP Version Added:** 18

#### [Response Axis](#response-axis_9)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Save Summary Formula](#save-summary-formula_3)

**Syntax:** obj \<< Save Summary Formula

#### [Set Shape Column](#set-shape-column)

**Syntax:** obj \<< Set Shape Column

**JMP Version Added:** 16

#### [Set Shape Expression](#set-shape-expression)

**Syntax:** obj \<< Set Shape Expression

**JMP Version Added:** 16

#### [Summary Statistic](#summary-statistic_6)

**Syntax:** obj \<< Summary Statistic( "None"|"N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

## [Shapes Element](#shapes-element)

### [Associated Constructors](#associated-constructors_16)

#### [Map Shapes Element](#map-shapes-element)

**Syntax:** Map Shapes Element

**Description:** Shows areas defined by a Map Shape variable, usually with a Color variable.

**Asia/Pacific-centered world map**

```

Open( "$SAMPLE_DATA/World Demographics.jmp" );
// world map, choropleth, grid lines, Pacific centering
Graph Builder(
    Size( 1094, 586 ),
    Show Control Panel( 0 ),
    Variables( Color( :Total Median Age ), Shape( :Territory ) ),
    Elements( Map Shapes( Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "", ScaleBox,
            {Format( "Longitude DDD", "PUNDIR", 16 ), Min( -23.27 ), Max( 327.33 ), Inc( 30 ),
            Minor Ticks( 0 ), Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "", ScaleBox( 2 ),
            {Format( "Latitude DDD", "PUNDIR", 16 ), Min( -87.55 ), Max( 87.55 ), Inc( 30 ),
            Minor Ticks( 0 ), Label Row( Show Major Grid( 1 ) )}
        )
    )
);


```

**Custom shape file with categorical color**

```

Open( "$SAMPLE_DATA/S4 Temps.jmp" );
// custom shape file choropleth, categorical color
Graph Builder(
    Show Control Panel( 0 ),
    Show X Axis( 0 ),
    Show Y Axis( 0 ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables( Color( :sector ), Shape( :"room/office"n ) ),
    Elements( Map Shapes( Legend( 2 ) ) )
);


```

**Custom shape file with gradient color**

```

Open( "$SAMPLE_DATA/S4 Temps.jmp" );
// custom shape file choropleth, color gradient
Graph Builder(
    Show Control Panel( 0 ),
    Show X Axis( 0 ),
    Show Y Axis( 0 ),
    Show X Axis Title( 0 ),
    Show Y Axis Title( 0 ),
    Variables( Group X( :time of day ), Color( :fahrenheit ), Shape( :"room/office"n ) ),
    Elements( Map Shapes( Legend( 2 ) ) )
);


```

**Mediterranean equal-area choropleth**

```

Open( "$SAMPLE_DATA/World Demographics.jmp" );
// Mediterranean map, choropleth, equal area projection, grid lines
Graph Builder(
    Size( 1094, 586 ),
    Show Control Panel( 0 ),
    Variables( Color( :Total Median Age ), Shape( :Territory ) ),
    Elements( Map Shapes( Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "", ScaleBox,
            {Format( "Longitude DDD", "PUNDIR", 16 ), Min( -14.2917884823647 ),
            Max( 64.9684846475565 ), Inc( 20 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "", ScaleBox( 2 ),
            {Format( "Latitude DDD", "PUNDIR", 16 ), Min( 21.8020806509188 ),
            Max( 61.3932495299748 ), Inc( 10 ), Minor Ticks( 1 ),
            Label Row( Show Major Grid( 1 ) )}
        )
    )
);


```

**World map choropleth**

```

Open( "$SAMPLE_DATA/World Demographics.jmp" );
// world map, choropleth, grid lines
Graph Builder(
    Show Control Panel( 0 ),
    Variables( Color( :Total Median Age ), Shape( :Territory ) ),
    Elements( Map Shapes( Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "", ScaleBox,
            {Format( "Longitude DDD", "PUNDIR", 16 ), Min( -175.3 ), Max( 175.3 ), Inc( 30 ),
            Minor Ticks( 0 ), Label Row( Show Major Grid( 1 ) )}
        ),
        Dispatch( {}, "", ScaleBox( 2 ),
            {Format( "Latitude DDD", "PUNDIR", 16 ), Min( -82.6 ), Max( 82.6 ), Inc( 30 ),
            Minor Ticks( 0 ), Label Row( Show Major Grid( 1 ) )}
        )
    )
);


```

### [Item Messages](#item-messages_16)

#### [Aspect Ratio](#aspect-ratio)

**Syntax:** obj \<< Aspect Ratio( number )

**Description:** Adjustment factor for X:Y scaling ratio.

#### [Show Missing Shapes](#show-missing-shapes)

**Syntax:** obj \<< Show Missing Shapes( state=0|1 )

**JMP Version Added:** 16

#### [Summary Statistic](#summary-statistic_7)

**Syntax:** obj \<< Summary Statistic( "N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

## [Smoother Element](#smoother-element)

### [Associated Constructors](#associated-constructors_17)

#### [Smoother Element](#smoother-element_1)

**Syntax:** Smoother Element

**Description:** Shows a smooth curve through the data. Best for continuous X and Y with an unknown relationship.

**Cyclical smoother**

```

Open( "$SAMPLE_DATA/Time Series/Air.jmp" );
// smoother, cycle, p-spline, bootstrap confidence interval
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :month ), Y( :Ozone Concentration ) ),
    Elements(
        Points( X, Y, Legend( 5 ) ),
        Smoother(
            X,
            Y,
            Legend( 6 ),
            Method( "P-Spline" ),
            Shape Constraint( "Cycle" ),
            Confidence of Fit( 1 )
        )
    )
);


```

**Monotonic on log x axis**

```

Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
// monotonic spline smoother, log x axis, overlaid, legend in graph corner
Graph Builder(
    Show Control Panel( 0 ),
    Legend Position( "Inside Left" ),
    Variables( X( :Concentration ), Y( :Toxicity ), Overlay( :Formulation ) ),
    Elements(
        Points( X, Y, Legend( 11 ) ),
        Smoother(
            X,
            Y,
            Legend( 12 ),
            Method( "P-Spline" ),
            Shape Constraint( "Non-descending" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Concentration", ScaleBox, {Scale( "Log" ), Minor Ticks( 1 )} )
    )
);


```

**Monotonic smoother trend line**

```

Open( "$SAMPLE_DATA/Penguins.jmp" );
// monotonic smooth trend line, p-spline, constraint
Graph Builder(
    Show Control Panel( 0 ),
    Include Missing Continuous Values( 0 ),
    Variables( X( :Culmen Length ), Y( :Culmen Depth ), Overlay( :Species ) ),
    Elements(
        Points( X, Y ),
        Smoother(
            X,
            Y,
            Method( "P-Spline" ),
            Lambda( 0.3 ),
            Shape Constraint( "Non-descending" )
        )
    )
);


```

**Smooth time series trend with split**

```

Open( "$SAMPLE_DATA/Time Series/Air.jmp" );
// Time series, split trend curve, grid lines
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :date ),
        Y( :Ozone Concentration ),
        Overlay( :Intervention for post 1960 period )
    ),
    Elements( Points( X, Y, Legend( 9 ) ), Smoother( X, Y, Legend( 10 ), Lambda( 1.4 ) ) ),
    SendToReport(
        Dispatch( {}, "date", ScaleBox, {Minor Ticks( 4 )} ),
        Dispatch( {}, "Ozone Concentration", ScaleBox, {Label Row( Show Major Grid( 1 ) )} )
    )
);


```

**Smooth trend and confidence interval**

```

Open( "$SAMPLE_DATA/Nonlinear Examples/Chemical Kinetics.jmp" );
// cubic spline smoother confidence interval
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Concentration ), Y( :"Velocity (y)"n ) ),
    Elements(
        Points( X, Y, Legend( 3 ) ),
        Smoother( X, Y, Legend( 4 ), Confidence of Fit( 1 ) )
    )
);


```

**Smooth trend curves, overlaid**

```

Open( "$SAMPLE_DATA/Nonlinear Examples/Algae Mitscherlich.jmp" );
// overlaid cubic spline trend lines
Graph Builder(
    Show Control Panel( 0 ),
    Legend Position( "Inside Left" ),
    Variables( X( :Days ), Y( :Algae density ), Overlay( :Treatment ) ),
    Elements( Points( X, Y, Legend( 9 ) ), Smoother( X, Y, Legend( 10 ) ) )
);


```

**Smooth trend curves, paneled**

```

Open( "$SAMPLE_DATA/Nonlinear Examples/Algae Mitscherlich.jmp" );
// paneled cubic spline trend lines
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables( X( :Days ), Y( :Algae density ), Wrap( :Treatment ) ),
    Elements( Points( X, Y, Legend( 9 ) ), Smoother( X, Y, Legend( 10 ) ) )
);


```

**Smooth trend curves, paneled and overlaid**

```

Open( "$SAMPLE_DATA/Corn Wheat Soybean Production.jmp" );
// smoothers paneled and filtered
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Year ),
        Y( :Commodity Acres Planted ),
        Group X( :State ),
        Overlay( :Commodity )
    ),
    Elements( Points( X, Y, Legend( 38 ) ), Smoother( X, Y, Legend( 39 ) ) ),
    Local Data Filter(
        Add Filter( columns( :State ), Where( :State == {"IOWA", "NEBRASKA", "OKLAHOMA"} ) )
    )
);


```

**Smooth trends lines over scatter plots**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
// smoothers and scatter plot, overlay, panels, trellis, trend curve, spline
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Wrap( :age ), Overlay( :sex ) ),
    Elements( Points( X, Y ), Smoother( X, Y, Lambda( 0.2 ) ) )
);


```

**Smoother comparison: loess, spline, p-spline**

```

Open( "$SAMPLE_DATA/Nonlinear Examples/Corn.jmp" );
// smoothers, loess, cubic spline, p-spline, monotonic, legend in bottom right
Graph Builder(
    Show Control Panel( 0 ),
    Legend Position( "Inside Bottom Right" ),
    Variables( X( :nitrate ), Y( :yield ) ),
    Elements(
        Points( X, Y, Legend( 3 ) ),
        Smoother(
            X,
            Y,
            Legend( 4 ),
            Method( "Local Kernel" ),
            Lambda( 0.5 ),
            Local Width( 0.687 ),
            Trim( 0 )
        ),
        Smoother( X, Y, Legend( 5 ), Lambda( 0.4 ) ),
        Smoother(
            X,
            Y,
            Legend( 6 ),
            Method( "P-Spline" ),
            Lambda( 2.0 ),
            Shape Constraint( "Non-descending" )
        )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {Legend Model( 4, Level Name( 0, "Loess" ) ),
            Legend Model( 5, Level Name( 0, "Spline" ) ),
            Legend Model( 6, Level Name( 0, "Monotonic p-spline" ) )}
        ),
        Dispatch( {}, "400", LegendBox,
            {Set Title( "" ), Legend Position( {3, [-1], 4, [0], 5, [1], 6, [2]} )}
        )
    )
);


```

### [Item Messages](#item-messages_17)

#### [Adapt to Axis Scale](#adapt-to-axis-scale_3)

**Syntax:** obj \<< Adapt to Axis Scale( state=0|1 )

**Description:** For log and other axis transformations, apply computations on the transformed coordinates.

#### [Confidence Bootstrap](#confidence-bootstrap)

**Syntax:** obj \<< Confidence Bootstrap( number )

**JMP Version Added:** 14

#### [Confidence of Fit](#confidence-of-fit_1)

**Syntax:** obj \<< Confidence of Fit( state=0|1 )

**Description:** Bootstrap confidence region for the fit.

**JMP Version Added:** 14

#### [Constrain Confidence Region](#constrain-confidence-region)

**Syntax:** obj \<< Constrain Confidence Region( state=0|1 )

**Description:** Whether the shape constraint also applies to the bootstrapped fits used to compute the confidence of fit region.

**JMP Version Added:** 19

#### [Degree](#degree_1)

**Syntax:** obj \<< Degree( "Median"|"Mean"|"Linear"|"Quadratic"|"Cubic" )

**JMP Version Added:** 16

#### [Lambda](#lambda)

**Syntax:** obj \<< Lambda( number )

#### [Local Constraint](#local-constraint)

**Syntax:** obj \<< Local Constraint( state=0|1 )

**Description:** Constrains the curve to the range of nearby values.

**JMP Version Added:** 19

#### [Local Region](#local-region)

**Syntax:** obj \<< Local Region( "Power"|"Fraction"|"Fixed"|"Trailing" )

**JMP Version Added:** 16

#### [Local Robustness](#local-robustness)

**Syntax:** obj \<< Local Robustness( number )

**JMP Version Added:** 16

#### [Local Weighting](#local-weighting)

**Syntax:** obj \<< Local Weighting( "Tri-cube"|"Cosine"|"Epanechnikov"|"Gaussian"|"Cauchy"|"Laplace"|"Triangular"|"Rectangular" )

**JMP Version Added:** 16

#### [Local Width](#local-width)

**Syntax:** obj \<< Local Width( number )

**JMP Version Added:** 16

#### [Maximum Constraint](#maximum-constraint)

**Syntax:** obj \<< Maximum Constraint( number )

#### [Method](#method)

**Syntax:** obj \<< Method( "Spline"|"P-Spline"|"Local Kernel"|"Savitzky-Golay"|"Moving Average"|"Moving Box" )

**JMP Version Added:** 15

#### [Minimum Constraint](#minimum-constraint)

**Syntax:** obj \<< Minimum Constraint( number )

#### [Response Axis](#response-axis_10)

**Syntax:** obj \<< Response Axis( "Auto"|"X"|"Y" )

#### [Save Formula](#save-formula_1)

**Syntax:** obj \<< Save Formula

#### [Scale lambda for count](#scale-lambda-for-count)

**Syntax:** obj \<< Scale lambda for count( state=0|1 )

**Description:** Adjust the spline smoother parameter lambda to account for data size. Useful for consistent smoothing across groups of different sizes.

#### [Shape Constraint](#shape-constraint)

**Syntax:** obj \<< Shape Constraint( "None"|"Non-descending"|"Non-ascending"|"Peak"|"Valley"|"Peak and Valley"|"Flat Start"|"Flat End"|"Flat Start and End"|"Cycle" )

**JMP Version Added:** 19

#### [Summary Statistic](#summary-statistic_8)

**Syntax:** obj \<< Summary Statistic( "None"|"N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

#### [Trim](#trim)

**Syntax:** obj \<< Trim( number )

**JMP Version Added:** 16

## [Treemap Element](#treemap-element)

### [Associated Constructors](#associated-constructors_18)

#### [Treemap Element](#treemap-element_1)

**Syntax:** Treemap Element

**Description:** Shows a response summarized by many categories.

**Continuous color gradient**

```

Open( "$SAMPLE_DATA/Airline Delays.jmp" );
// treemap, continuous color gradient
Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :Airline ), Color( :Arrival Delay ) ),
    Elements( Treemap( X, Legend( 5 ), Summary Statistic( "N" ) ) ),
    SendToReport(
        Dispatch( {}, "graph title", TextEditBox,
            {Set Text( "Airline Flight Count colored by Average Delay" )}
        )
    )
);


```

**Nested treemap, squarify**

```

Open( "$SAMPLE_DATA/Color Preference Survey.jmp" );
// nested treemap, squarify, color value column property
Graph Builder(
    Show Control Panel( 0 ),
    Show Legend( 0 ),
    Variables(
        X( :What is your gender? ),
        X( :"What is your favorite color? (select one)"n, Position( 1 ) ),
        X( :What is your favorite color?, Position( 1 ) ),
        Color( :"What is your favorite color? (select one)"n )
    ),
    Elements(
        Treemap(
            X( 1 ),
            X( 2 ),
            X( 3 ),
            Legend( 6 ),
            Layout( "Squarify" ),
            Group Labels( "Above" )
        )
    )
);


```

**Positional ordering hints**

```

Open( "$SAMPLE_DATA/SATByYear.jmp" );
// treemap, positional ordering hints
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :State ),
        Y( :Longitude ),
        Y( :Latitude, Position( 1 ) ),
        Color( :SAT Verbal ),
        Size( :Population )
    ),
    Elements( Treemap( X, Y( 1 ), Y( 2 ), Legend( 9 ) ) )
);


```

### [Item Messages](#item-messages_18)

#### [Category Name](#category-name)

**Syntax:** obj \<< Category Name( state=0|1 )

**Description:** Shows the column name of the category as part of the category label. This option is used only when the category value is also shown.

#### [Category Value](#category-value)

**Syntax:** obj \<< Category Value( state=0|1 )

**Description:** Shows the value of the category as part of the category label.

#### [Color Label Format](#color-label-format)

**Syntax:** obj \<< Color Label Format

**JMP Version Added:** 16

#### [Color Name](#color-name)

**Syntax:** obj \<< Color Name( state=0|1 )

**Description:** Shows the name of the color variable as part of the color label. This option is used only when the color value is also shown.

**JMP Version Added:** 16

#### [Color Value](#color-value)

**Syntax:** obj \<< Color Value( state=0|1 )

**Description:** Shows the value of the color variable as part of the category label. This option is used only when a color variable is specified.

#### [Group Labels](#group-labels)

**Syntax:** obj \<< Group Labels( "None"|"Above"|"Floating" )

**Description:** Turn off the group labels or show the group labels above the categories or as floating boxes.

#### [Implicit Color](#implicit-color)

**Syntax:** obj \<< Implicit Color( state=0|1 )

**Description:** Use unique colors for the Treemap. Deselecting this option will show the Treemap as one solid color. This option is disabled if a color variable has been specified. On by default.

#### [Label Justification](#label-justification)

**Syntax:** obj \<< Label Justification( "Left"|"Center"|"Right" )

#### [Label Threshold](#label-threshold)

**Syntax:** obj \<< Label Threshold( number )

**Description:** The minimum size (area) to display the label in the box.

#### [Label Transparency](#label-transparency)

**Syntax:** obj \<< Label Transparency( number )

**Description:** Set the transparency for the group label when the group label is floating. Valid values are between 0.0 and 1.0 inclusive.

**JMP Version Added:** 16

#### [Layout](#layout)

**Syntax:** obj \<< Layout( "Split"|"Squarify"|"Mixed" )

#### [Max Label Size](#max-label-size_1)

**Syntax:** obj \<< Max Label Size( number )

**Description:** Defines the maximum increase in font size.

#### [Orientation Bias](#orientation-bias)

**Syntax:** obj \<< Orientation Bias( number )

**Description:** Set the relative preference of horizontal vs. vertical area splitting.

**JMP Version Added:** 17

#### [Show Frames](#show-frames)

**Syntax:** obj \<< Show Frames( state=0|1 )

**Description:** On by default.

#### [Show Group Name](#show-group-name)

**Syntax:** obj \<< Show Group Name( state=0|1 )

**Description:** Shows the column name of the group as part of the group label. This option is used only when the group labels are above the group tiles.

#### [Size Label Format](#size-label-format)

**Syntax:** obj \<< Size Label Format

**JMP Version Added:** 16

#### [Size Name](#size-name)

**Syntax:** obj \<< Size Name( state=0|1 )

**Description:** Shows the name of the size variable as part of the size label. This option is used only when the size value is also shown.

**JMP Version Added:** 16

#### [Size Value](#size-value)

**Syntax:** obj \<< Size Value( state=0|1 )

**Description:** Shows the value of the size variable as part of the category label.

#### [Summary Statistic](#summary-statistic_9)

**Syntax:** obj \<< Summary Statistic( "N"|"Mean"|"Median"|"Mode"|"Geometric Mean"|"Min"|"Max"|"Range"|"Sum"|"Cumulative Sum"|"Cumulative Percent"|"% of Total"|"% of Factor"|"% of Grand Total"|"Std Dev"|"Variance"|"Std Err"|"CV"|"Interquartile Range"|"Median Absolute Deviation"|"First Quartile"|"Third Quartile" )

#### [Tile Labels](#tile-labels)

**Syntax:** obj \<< Tile Labels

# [GridBox](#gridbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Group Platform](#group-platform)

## [Associated Constructors](#associated-constructors)

### [Group Options](#group-options)

**Syntax:** obj = Platform( <Roles>, <Platform Options>, Group Options(\<Return Group(0|1)>, <options>))

**Description:** A Group Platform arranges reports for platforms that are created when launching with a By role or multiple Y roles. A Group Platform cannot be created directly, but is created when a launch can result in multiple platforms being created. Options for the group behavior are specified with the Group Options argument at launch.

#### [Group Platform return](#group-platform-return)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);


```

#### [Platform list return](#platform-list-return)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( X( :height ), Y( :weight ), By( :age ) );


```

## [Item Messages](#item-messages)

### [Auto Broadcast](#auto-broadcast)

**Syntax:** obj \<< Auto Broadcast( state=0|1 )

**Description:** Automatically apply broadcast for interactive actions in reports.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Auto Broadcast( 1 );


```

### [Get Auto Broadcast](#get-auto-broadcast)

**Syntax:** obj \<< Get Auto Broadcast

**Description:** Returns the setting for automatically applying broadcast for interactive actions in reports.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
Show( obj << Get Auto Broadcast() );


```

### [Get Hide Empty Platforms](#get-hide-empty-platforms)

**Syntax:** obj \<< Get Hide Empty Platforms

**Description:** Returns the setting for hiding empty platforms.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
Show( obj << Get Hide Empty Platforms() );


```

### [Get Layout](#get-layout)

**Syntax:** obj \<< Get Layout

**Description:** Returns the current layout of the platform group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Layout( "Arrange in Tabs" );
Show( obj << Get Layout );


```

### [Get N Across](#get-n-across)

**Syntax:** obj \<< Get N Across

**Description:** Returns the number of platforms across for Arrange in Rows layout.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Layout( "Arrange in Rows" );
Show( obj << Get N Across() );


```

### [Get Platforms](#get-platforms)

**Syntax:** list = Get Platforms(\<Visible Only(0|1)>)

**Description:** Returns a list of the platforms in the group. If the VisibleOnly option is specified, hidden platforms will not be included and the list will be in the order of display.

#### [All platforms](#all-platforms)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
Show( obj << Get Platforms );


```

#### [Visible only](#visible-only)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Hide Empty Platforms( 1 );
df = obj << Local Data Filter( Add Filter( columns( :height ), Where( :height <= 57 ) ) );
Show( obj << Get Platforms( Visible Only( 1 ) ) );


```

### [Hide Empty Platforms](#hide-empty-platforms)

**Syntax:** obj \<< Hide Empty Platforms( state=0|1 )

**Description:** Hide the empty platforms that are unable to compute.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway(
    Y( :height ),
    X( :sex ),
    By( :age ),
    Group Options(
        Return Group( 1 ),
        Local Data Filter( Add Filter( columns( :weight ), Where( :weight >= 140 ) ) ),
        Layout( "Arrange in Rows" )
    ),
    Automatic Recalc( 1 )
);
Wait( 1 );
obj << Hide Empty Platforms( 1 );


```

### [Layout](#layout)

**Syntax:** obj \<< Layout( "Vertical List"|"Horizontal List"|"Arrange in Rows"|"Arrange in Tabs" )

**Description:** Change the layout of the platforms in the group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Layout( "Arrange in Tabs" );


```

### [N Across](#n-across)

**Syntax:** obj \<< N Across( number )

**Description:** Set the number of platforms across for Arrange in Rows layout.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Layout( "Arrange in Rows" );
obj << N Across( 3 );


```

### [Order By](#order-by)

**Syntax:** Order By(<mode>, \<Descending(0|1)>, \<Order Statistic("Count" | "Mean" | "Median" | "Mode" | "Geometric Mean" | "Min" | "Max" | "Range" | "Sum" | "Std Dev" | "Variance" | "Std Err" | "CV" | "Interquartile Range" | "Median Absolute Deviation" | "Q10%" | "Q1" | "Q3" | "Q90%")>

**Description:** Sets the order for the platforms in the group. The order can be based on a platform-computed value, a column statistic when used with by-groups, or a response statistic when the group was launched with multiple Y's. By default, the order is descending with a stat of "Mean".

#### [Column statistic](#column-statistic)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Line( {Report( 0 )} );
Wait( 1 );
obj << Order By( :height, Descending( 1 ), Order Statistic( "Max" ) );


```

#### [Platform](#platform)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Fit Line( {Report( 0 )} );
Wait( 1 );
obj << Order By( "Goodness of Fit", Descending( 1 ) );


```

#### [Response statistic](#response-statistic)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Contour Plot(
    X( :Longitude, :Latitude ),
    Y( :OZONE, :CO ),
    Group Options( Return Group( 1 ) )
);
Wait( 1 );
obj << Order By( Order( "Response" ), Descending( 1 ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate(
    X( :height ),
    Y( :weight ),
    By( :age ),
    Group Options( Return Group( 1 ) )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Group Options(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [HTTP](#http)

## [HTTPRequest](#httprequest)

### [Item Messages](#item-messages)

#### [Authentication Method](#authentication-method)

**Syntax:** obj \<< Authentication Method(method)

**Description:** Enforces an authentication method. Valid values are:

```
NONE         - No HTTP authentication



BASIC        - HTTP Basic authentication



KERBEROS     - HTTP Kerberos



NEGOTIATE    - HTTP Negotiate (SPNEGO) authentication



NTLM         - HTTP NTLM authentication



ANY          - All types set (default)



ANYSAFE      - All types except Basic



DEFAULT      - The default authentication

```

By default JMP and the web service negotiate the most secure authentication method.

**JMP Version Added:** 17

```


request = New HTTP Request();
request << Authentication Method( "KERBEROS" );


```

#### [Blob](#blob)

**Syntax:** obj \<< Blob( binary data, <content-type> )

**Description:** This will set a Blob value in the request. The Blob value will be used as the body of the document. The request content type header will automatically be set to "Content-Type: application/octet-stream".

**JMP Version Added:** 14

```


blob = "Testing, Testing 1, 2, 3";
file = Save Text File( "$TEMP/test_blob", blob );
request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    Blob( Load Text File( file ) )
);
data = request << Send;


```

#### [Bypass Proxy](#bypass-proxy)

**Syntax:** obj \<< Bypass Proxy(localhost)

**Description:** Comma-separated list of hosts which do not use a proxy, if one is specified. The only wildcard is a single * character, which matches all hosts, and effectively disables the proxy. Each name in this list is matched as either a domain which contains the hostname, or the hostname itself. For example, local.com would match local.com, local.com:80, and www.local.com, but not www.notlocal.com.

**JMP Version Added:** 15

```


request = New HTTP Request();
request << Proxy Server( "http://my_proxy.com" );
request << Proxy User( "clark%20kent:superman" );
request << Bypass Proxy( "localhost" );


```

#### [Certificates](#certificates)

**Syntax:** obj \<< Certificates(certificate file)

**Description:** Use the specified certificate file for verification. The file might contain multiple CA certificates. The certificate(s) must be in PEM format.

**JMP Version Added:** 16

```


request = New HTTP Request();
request << Certificates( "c:\certs\my_certificate.crt" );


```

#### [Cookie](#cookie)

**Syntax:** obj \<< Cookie(\[[ key=> value ]\]

**Description:** Set a cookie in the request.

**JMP Version Added:** 14

```


request = New HTTP Request(
    url( "http://httpbin.org/get" ),
    Method( "GET" ),
    Cookie( [["username" => "bob", "address" => "12345"]] )
);
data = request << Send;


```

#### [Cookie File](#cookie-file)

**Syntax:** obj \<< Cookie File(<path>, \<"replace" | "rename" | "append">)

**Description:** Specify an alternate cookie file.

**JMP Version Added:** 14

```


request = New HTTP Request();
data = request << Cookie File( "$DESKTOP\..\cookie.txt" );


```

#### [Curlrc](#curlrc)

**Syntax:** obj \<< Curlrc(\<true | false>)

**Description:** Configures the request to use a standard .curl file.

The .curlrc (\_curlrc on Windows) file contains default options used for curl.

**JMP Version Added:** 15

```


request = New HTTP Request();
request << Curlrc( "true" );


```

#### [Curlrc File](#curlrc-file)

**Syntax:** obj \<< Curlrc File(<path>)

**Description:** Configures the request to use an alternate .curlrc file.

The .curlrc (\_curlrc on Windows) file contains default options used for curl.

**JMP Version Added:** 15

```


request = New HTTP Request();
request << Curlrc File( "$DESKTOP\..\my_curlrc.txt" );
request << Curlrc( "true" );


```

#### [DNS Timeout](#dns-timeout)

**Syntax:** obj \<< DNS Timeout(seconds)

**Description:** The default DNS cache timeout for the connection is 60 seconds. This value can be adjusted to accommodate DNS caching. Set to 0 to completely disable caching, or set to -1 to make the cached entries remain in memory.

**JMP Version Added:** 16

```


request = New HTTP Request(
    Url(
        "https://community.jmp.com/html/assets/community-icons/community-icon-mastering.png"
    ),
    Method( "GET" ),
    DNS Timeout( 120 )
);
bytes = request << Send;
img = Open( bytes, jpg );
obj = New Window( "Mastering JMP", img );


```

#### [Decode64 Char](#decode64-char)

**Syntax:** obj \<< Decode64 Char( value )

**Description:** Decode the string using Base 64 encoding

**JMP Version Added:** 16

```


request = New HTTP Request();
data = request << Decode64 Char(
    "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCAuLi4="
);


```

#### [Download](#download)

**Syntax:** obj \<< Download( path, \<"replace" | "rename" | "append"> )

**Description:** Downloads the HTTP Response to a file. Useful for downloading files from a web service.The replace option overwrites any existing file.The rename option uses sequential file names when a duplicate name is found(file, file(1), file(2)...).The append option appends to the existing file. Using show progress shows a cancelable progress bar with the percentage of the file downloaded.

**JMP Version Added:** 14

```


request = New HTTP Request(
    URL(
        "https://community.jmp.com/kvoqx44227/attachments/kvoqx44227/sample-data/49/1/BlueBirds.jmp"
    ),
    Method( "Get" )
);
file = request << Download( "$TEMP/BlueBirds.jmp", "replace", "show progress" );
If( !Is Empty( file ),
    Open( file )
);


```

#### [Encode64 Char](#encode64-char)

**Syntax:** obj \<< Encode64 Char( value )

**Description:** Encode the string using Base 64 encoding

**JMP Version Added:** 16

```


request = New HTTP Request();
data = request << Encode64 Char( "Man is distinguished, not only by his reason, but ..." );


```

#### [File](#file)

**Syntax:** obj \<< File ( path, <content-type> )

**Description:** This will set a File value in the request. The File contents will be used as the body of the document. The request content-type header will automatically be set to the appropriate content based on the file extension or application/octet-stream if not found.

**JMP Version Added:** 14

```


my_file = Save Text File( "$TEMP/test_file.txt", "Testing, Testing 1, 2, 3" );
request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    File( my_file )
);
data = request << Send;


```

#### [Form](#form)

**Syntax:** obj \<< Form(Fields(\[[ key=> value ]\], \<URI Encode(1 | 0 | Safe(...))>), Files({ key1, {path1, path2, ..}, key2, {path3, path4} }))

**Description:** Sets the form data value in the request. The form will be used as the body of the document. Form data can have fields and files elements.

**JMP Version Added:** 14

```


file1 = Save Text File( "$TEMP/file1", "hello world 1" );
file2 = Save Text File( "$TEMP/file2", "hello world 2" );
file3 = Save Text File( "$TEMP/file3", "hello world 3" );
file4 = Save Text File( "$TEMP/file4", "hello world 4" );
request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    Form(
        Fields(
            [["A" => "a", "B" => "b", "C" => "c", "1" => "one", "2" => "two", "3" => "three"]
            ]
        ),
        Files( {"group 1", {file1, file2}, "group 2", {file2, file4}} )
    )
);
data = request << Send;


```

#### [Get Certificate Info](#get-certificate-info)

**Syntax:** obj \<< Get Certificate Info

**Description:** Shows details about the certificate, such as who issued it, when it expires, and other information to ensure the certificate is trustworthy.

**JMP Version Added:** 19

```


request = New HTTP Request( URL( "https://google.com" ) );
request << Get Certificate Info;


```

#### [Get Last URL](#get-last-url)

**Syntax:** obj \<< Get Last URL

**Description:** Gets the last URL used in the request. Useful to find the redirected URL.

**JMP Version Added:** 14

```


baseURL = "http://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people/10" ), Method( "GET" ) );
request << Send;
Write( Char( request << Get Last URL ) );


```

#### [Get MIME Type](#get-mime-type)

**Syntax:** mimetype = obj \<< Get MIME Type

**Description:** After Send (or Download) is used with a request, this can be used to retrieve the MIME type of the returned data.

**JMP Version Added:** 14

```


url = "https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png";
request = New HTTP Request( URL( url ), Method( "GET" ) );
request << Send;
Write( request << Get Mime Type() || "\!n" );


```

#### [Get Method](#get-method)

**Syntax:** obj \<< Get Last Method

**Description:** Gets the last HTTP method used in the request.

**JMP Version Added:** 14

```


request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    JSON( "\[{"username":"bob","address":"12345"}]\" ),
    Password( "cm9zczpBYmMxMjM=" ),

);
request << Send;
Write( Char( request << Get Method ) || "\!n" );


```

#### [Get Response Headers](#get-response-headers)

**Syntax:** obj \<< Get Response Headers

**Description:** The response headers are an associative array of key/value pairs returned after a request has been sent. HTTP header definitions can be found here: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html. Date, Expires and Last-Modified keys will be converted to JMP dates. Age and Content-Length keys will be converted to numbers. All other values will be character.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people" ), Method( "GET" ) );
json = request << Send;

response_headers = request << Get Response Headers;
keys = response_headers << Get Keys;
For( i = 1, i <= N Items( keys ), i++,
    key = keys[i];
    value = response_headers[key];
    Write( "Key=> " || Char( key ) || ", Value=> " || Char( value ) || "\!n" );
);


```

#### [Get Status](#get-status)

**Syntax:** obj \<< Get Status

**Description:** Returns the status of the request after a Send. The status is the HTTP status if there are no connection errors. Otherwise, the connection status. 200-299 is successful.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people/1" ), Method( "GET" ) );
data = request << Send;
If( request << Get Status == 200,
    Write( "Success!!!!\!n" || Char( data ) || "\!n" )
);


```

#### [Get Status Message](#get-status-message)

**Syntax:** obj \<< Get Status Message

**Description:** Returns the status message of the request after a Send message. The status message is the HTTP status message if there are no connection errors. Otherwise, the connection status message. A status of 200-299 is successful.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people/100" ), Method( "GET" ) );
request << Send;
Write( "\!n" || Char( request << Get Status Message ) || "\!n" );


```

#### [Get Status Msg](#get-status-msg)

**Syntax:** obj \<< Get Status Msg

**Description:** Returns the status message of the request after a Send. This is an alias of GetStatusMessage. The status message is the HTTP status message if there are no connection errors. Otherwise, the connection status message. A status of 200-299 is successful.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people/100" ), Method( "GET" ) );
request << Send;
Write( "\!n" || Char( request << Get Status Msg ) || "\!n" );


```

#### [Get Warning Headers](#get-warning-headers)

**Syntax:** obj \<< Get Warning Headers

**Description:** Gets the warning header values (if any) from the request.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people" ), Method( "GET" ) );
json = request << Send;

warning_headers = request << Get Warning Headers;
If( !Is Empty( warning_headers ),
    keys = warning_headers << Get Keys;
    For( i = 1, i <= N Items( keys ), i++,
        key = keys[i];
        value = response_headers[key];
        Write( "Key=> " || Char( key ) || ", Value=> " || Char( value ) || "\!n" );
    );
);


```

#### [GetVersion](#getversion)

**Syntax:** request \<< GetVersion

**Description:** Returns the Current version of cURL being used in JMP

**JMP Version Added:** 14

```

Write( New HTTP Request() << GetVersion );


```

#### [Has Client Error](#has-client-error)

**Syntax:** obj \<< Has Client Error

**Description:** True if the HTTP status is 400-499.

**JMP Version Added:** 14

```


request = New HTTP Request( URL( "http://pokeapi.co/api/v2/pokemon/25/" ), Method( "GET" ) );
json = request << Send;
If( request << Has Client Error,
    msg = "Has Client Error: " || Char( request << Get Status Message ),
    msg = "Success!"
);
Write( msg );


```

#### [Has Error](#has-error)

**Syntax:** obj \<< Has Error

**Description:** True if the HTTP status is 400-599.

**JMP Version Added:** 14

```


request = New HTTP Request( URL( "http://pokeapi.co/api/v2/pokemon/1/" ), Method( "GET" ) );
json = request << Send;
If( request << Has Error,
    msg = "Has Error: " || Char( request << Get Status Message ),
    msg = "Success!"
);
Write( msg );


```

#### [Has Information](#has-information)

**Syntax:** obj \<< Has Information

**Description:** True if the HTTP status is 100-199.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people/20" ), Method( "GET" ) );
request << Send;
If( request << Has Information,
    msg = "Has Information: " || Char( request << GetStatusMessage ),
    msg = "No Status Information available."
);
Write( msg );


```

#### [Has Redirection](#has-redirection)

**Syntax:** obj \<< Has Redirection

**Description:** True if the HTTP status is 300-399.

**JMP Version Added:** 14

```


baseURL = "http://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people/10" ), Method( "GET" ) );
request << Send;
If( request << Has Redirection,
    msg = "Has Redirection: " || Char( request << Get Status Message ),
    msg = "No Redirection ocurred."
);
Write( msg );


```

#### [Has Server Error](#has-server-error)

**Syntax:** obj \<< Has Server Error

**Description:** True if the HTTP status is 500-599.

**JMP Version Added:** 14

```


request = New HTTP Request( URL( "http://pokeapi.co/api/v2/pokemon/25/" ), Method( "GET" ) );
json = request << Send;
If( request << Has Server Error,
    msg = "Has Server Error: " || Char( request << Get Status Message ),
    msg = "Success!"
);
Write( msg );


```

#### [Has Warning](#has-warning)

**Syntax:** obj \<< Has Warning

**Description:** True if the HTTP status has warning headers

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people" ), Method( "GET" ) );
json = request << Send;

If( !request << Has Warning,
    warning_headers = request << Get Warning Headers;
    keys = warning_headers << Get Keys;
    For( i = 1, i <= N Items( keys ), i++,
        key = keys[i];
        value = response_headers[key];
        Write( "Key=> " || Char( key ) || ", Value=> " || Char( value ) || "\!n" );
    );
);


```

#### [Headers](#headers)

**Syntax:** obj \<< Headers({header 1}, {header 2} | \[[ key=> value, key2=>value2 ]\])

**Description:** HTTP header definitions can be found here:

https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html. It is used to specify various meta information about the request to help the webservice response appropriately. These values should be thought of as "hints" to the webservice since it may choose not to honor the parameters. Consult the webservice API to verify support. For the request, "Content-Type: application/json" is used when specifying JSON values, "Content-Type: application/octet-stream" is used when specifying Blob values, "Content-Type: [extension/mime type mapping]" is used with File values, and, "Content-Type: application/x-www-form-urlencoded" or "Content-Type: multipart/form-data" depending on the content of the Form. The headers also "hint" to the webservice the type of data that should be returned. Common headers are "Accept: application/json", "Accept: application/xml", "Accept: text/csv", and "Accept: text/html". Header values can be specified as either a JSL list of character data or an Associative Array of character key/value pairs.

**JMP Version Added:** 14

```


url = "https://api.nasa.gov/planetary/apod";
fields = [=> ];
fields["api_key"] = "NNKOjkoul8n1CH18TWA9gwngW1s1SmjESPjNoUFo";

request = New HTTP Request(
    URL( url ),
    Method( "GET" ),
    Query String( fields ),
    Headers( {"Accept: application/json"} )
);
json = request << Send;
Write( json || "\!n" );


```

#### [Insecure](#insecure)

**Syntax:** obj \<< Insecure(\<"true"> | \<"false">) | \<"prompt">

**Description:** By default, certificate validation is on. If set to true, this will allow requests to complete without certificate validation. If set to prompt, this will allow a user to accept the certificate and complete the request as needed.

**JMP Version Added:** 14

```


request = New HTTP Request(
    Url(
        "https://community.jmp.com/html/assets/community-icons/community-icon-mastering.png"
    ),
    Method( "GET" ),
    Insecure( "true" )
);
bytes = request << Send;
img = Open( bytes, jpg );
obj = New Window( "Mastering JMP", img );


```

#### [Is Success](#is-success)

**Syntax:** obj \<< Is Success

**Description:** True if the HTTP status is 200-299.

**JMP Version Added:** 14

```


url = "https://api.nasa.gov/planetary/apod";
fields = [=> ];
fields["api_key"] = "NNKOjkoul8n1CH18TWA9gwngW1s1SmjESPjNoUFo";

request = New HTTP Request( URL( url ), Method( "GET" ), Query String( fields ) );
json = request << Send;
If( request << Is Success,
    JSON To Data Table( json )
);


```

#### [Is Successful](#is-successful)

**Syntax:** obj \<< Is Successful

**Description:** True if the HTTP status is 200-299.

**JMP Version Added:** 14

```


url = "https://api.nasa.gov/planetary/apod";
fields = [=> ];
fields["api_key"] = "NNKOjkoul8n1CH18TWA9gwngW1s1SmjESPjNoUFo";

request = New HTTP Request( URL( url ), Method( "GET" ), Query String( fields ) );
json = request << Send;
If( request << Is Successful,
    aa = Parse JSON( json );
    If( Contains( aa, "url" ),
        request << Reset( URL( aa["url"] ), Method( "GET" ) );
        bytes = request << Send;
        img = Open( bytes, jpg );
        obj = New Window( aa["title"], img );
    );
);


```

#### [Is Valid](#is-valid)

**Syntax:** obj \<< Is Valid

**Description:** Is the request valid

**JMP Version Added:** 14

```


request = New HTTP Request();
data = request << Is Valid();


```

#### [Is Verbose](#is-verbose)

**Syntax:** obj \<< Is Verbose

**Description:** Is the request automatically logging status messages

**JMP Version Added:** 14

```


request = New HTTP Request();
data = request << Is Verbose();


```

#### [JSON](#json)

**Syntax:** obj \<< JSON( json data )

**Description:** This will set a JSON string value in the request. The JSON string will be used as the body of the document. The request content type header will automatically be set to "Content-Type: application/json". You can use the As JSON Expr method to convert an Associative Array to a JSON string.

**JMP Version Added:** 14

```


request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    JSON( "\[{"username":"bob","address":"12345"}]\" )
);
data = request << Send;


```

#### [Max Redirect](#max-redirect)

**Syntax:** obj \<< Max Redirect(...)

**Description:** Specify number of redirects the request will follow.

**JMP Version Added:** 14

```


request = New HTTP Request(
    url( "http://httpbin.org/get" ),
    Method( "GET" ),
    Query String( [["username" => "bob", "address" => "12345"]] ),
    MaxRedirect( 2 )
);
data = request << Send;


```

#### [Method](#method)

**Syntax:** obj \<< Method("Post" | "Get" | "Put" | "Patch"| "Delete")

**Description:** Sets the method for the request. Currently, Get, Post, Put, Patch, Delete, and Head are supported.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/planets" ), Method( "GET" ) );
json = request << Send;
dt = JSON To Data Table( json );
dt << Set Name( "Swapi.co Planets" );
dt << Delete Columns( :next, :count, :previous );
dt << Select Where( :name == "" );
dt << Delete Rows();


```

#### [Netrc](#netrc)

**Syntax:** obj \<< Netrc(\<true | false>)

**Description:** Configures the request to use a standard .netrc file.

The .netrc (\_netrc on Windows) file contains data for logging in to a remote host over the network.

This file resides in the user's home directory on the machine initiating the file transfer.

Its permissions should be set to disallow Read access by group and others.

The following tokens are recognized. They may be separated by space, tab, or newline characters:

machine

```
identifies a remote machine name. The auto-login process searches the .netrc file for a machine token that matches the remote machine specified. Once a match is made, the subsequent .netrc tokens are processed, stopping when the EOF is reached or another machine token is encountered.

```

login

```
identifies a user on the remote machine. If this token is present, the auto-login process will initiate a login using the specified name.

```

password

```
supplies a password. If this token is present, the auto-login process will supply the specified string if the remote server requires a password as part of the login process.

```

**JMP Version Added:** 14

```


request = New HTTP Request();
request << Netrc( "true" );


```

#### [Netrc File](#netrc-file)

**Syntax:** obj \<< Netrc File(<path>)

**Description:** Configures the request to use an alternate .netrc file.

The .netrc (\_netrc on Windows) file contains data for logging in to a remote host over the network.

This file resides in the user's home directory on the machine initiating the file transfer.

Its permissions should be set to disallow Read access by the group and others.

The following tokens are recognized. They may be separated by space, tab, or newline characters:

machine

```
identifies a remote machine name. The auto-login process searches the .netrc file for a machine token that matches the remote machine specified. Once a match is made, the subsequent .netrc tokens are processed, stopping when the EOF is reached or another machine token is encountered.

```

login

```
identifies a user on the remote machine. If this token is present, the auto-login process will initiate a login using the specified name.

```

password

```
supplies a password. If this token is present, the auto-login process will supply the specified string if the remote server requires a password as part of the login process.

```

**JMP Version Added:** 14

```


request = New HTTP Request();
request << Netrc File( "$DESKTOP\..\my_netrc.txt" );
request << Netrc( "true" );


```

#### [Password](#password)

**Syntax:** obj \<< Password(passwd)

**Description:** Sets the password on the request used for basic authentication. This value is used with the request user name, where both user name and password are concatenated with a ':' (name:password) and passed to the web service. In addition, an encoded (such as a Kerberos V5 encoded) username/password value can be used here.

**JMP Version Added:** 14

```


request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    JSON( "\[{"username":"bob","address":"12345"}]\" ),
    Password( "cm9zczpBYmMxMjM=" ),

);
data = request << Send;


```

#### [Proxy Server](#proxy-server)

**Syntax:** obj \<< Proxy Server(proxy_url)

**Description:** The proxy URL can be specified the same way as the proxy environment variables, including the protocol prefix (http://) and the embedded user + password.

**JMP Version Added:** 15

```


request = New HTTP Request();
url = "http://my_proxy.com";
request << Proxy Server( url );


```

#### [Proxy User](#proxy-user)

**Syntax:** obj \<< Proxy User(username:password)

**Description:** User and password that might be provided in the proxy string are URL decoded. This allows you to pass in special characters such as @ by using %40 or pass in a colon with %3a.

**JMP Version Added:** 15

```


request = New HTTP Request();
url = "http://my_proxy.com";
request << Proxy Server( url );
request << Proxy User( "clark%20kent:superman" );


```

#### [Query String](#query-string)

**Syntax:** obj \<< Query String(\[[ key=> value ]\], \<URI Encode(1|0|Safe(...))>)

**Description:** Sets the Query String value in the request. This is an Associative Array key/value collection of character data. The key/value pairs are URL encoded (escaped) when they are sent to the web service.

**JMP Version Added:** 14

```


request = New HTTP Request(
    url( "http://httpbin.org/get" ),
    Method( "GET" ),
    Query String( [["username" => "bob", "address" => "12345"]] )
);
data = request << Send;


```

#### [Reset](#reset)

**Syntax:** obj \<< Reset(URL(...), Method(...), \<Form(\<Fields(...)>, \<Files(...)>)> | \<File(...)> | \<Blob(...)> | \<JSON(...)>, \<QueryString(...)>, \<Headers(...)>, \<Username(...)>, \<Password(...)>)

**Description:** Resets request to new values.

**JMP Version Added:** 14

```


request = New HTTP Request( URL( "http://pokeapi.co/api/v2/pokemon/1/" ), Method( "GET" ) );
json1 = request << Send;
request << Reset( URL( "http://pokeapi.co/api/v2/pokemon/25/" ), Method( "GET" ) );
json2 = request << Send;


```

#### [Run](#run)

**Syntax:** obj \<< Run

**Description:** Runs the request. This is an alias of Send. The return value from Run will be either character data or binary BLOB. You can check the return with the Is String JSL function.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/planets" ), Method( "GET" ) );
json = request << Send;
Write( json || "\!n" );


```

#### [SSL Version](#ssl-version)

**Syntax:** obj \<< SSL Version (version)

**Description:** "DEFAULT" Use the default negotiated version (recommended).

\\

```
     "1+"     Force TLS version 1.0 or higher, depending on what the server and client both support.

```

\\

```
     1.0        Force TLS 1.0

```

\\

```
     1.1        Force TLS 1.1

```

\\

```
     1.2        Force TLS 1.2

```

\\

```
     1.3        Force TLS 1.3

```

\\

```
     2.0        Force TLS 2.0 (not recommended)

```

\\

```
     3.0        Force TLS 3.0 (not recommended)

```

\\

```
     "MAX"    Automatically choose the highest supported version

```

**JMP Version Added:** 19

```


request = New HTTP Request();
request << SSL Version( "1+" );


```

#### [Secure](#secure)

**Syntax:** obj \<< Secure(\<"true"> | \<"false">) | \<"prompt">

**Description:** By default, certificate validation is on. If set to false, this will allow requests to complete without certificate validation. If set to prompt, this will allow a user to accept the certificate and complete the request as needed.

**JMP Version Added:** 14

```


request = New HTTP Request(
    Url(
        "https://community.jmp.com/html/assets/community-icons/community-icon-mastering.png"
    ),
    Method( "GET" ),
    Secure( 1 )
);
bytes = request << Send;
img = Open( bytes, jpg );
obj = New Window( "Mastering JMP", img );


```

#### [Send](#send)

**Syntax:** obj \<< Send(\<"text" | "blob">, \<"show progress download" | "show progress upload" | "show progress both" | "show progress">)

**Description:** Sends the request. The return value from Send will be either character data or binary BLOB. You can check the return with the Is String JSL function. Using show progress download will show a cancelable progress bar with the progress of data downloaded. Using show progress upload will show a cancelable progress bar with the progress of data uploaded. Using show progress both will show a cancelable progress bar with the progress of data uploaded and downloaded. Using show progress will show a cancelable progress bar with the progress of data uploaded or downloaded (or both). For posting forms, show progress will show upload and download progress. For posting files, show progress will show upload progress. For retrieving data, show progress will show download progress.

**JMP Version Added:** 14

```


baseURL = "https://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/planets" ), Method( "GET" ) );
json = request << Send;
Write( json || "\!n" );


```

#### [Text](#text)

**Syntax:** obj \<< Text( text data, <content-type>)

**Description:** This will set text string value in the request. The text string will be used as the body of the document. The request content type header will automatically be set to "Content-Type: text/plain"

**JMP Version Added:** 15

```


request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    Text( "Hello World" )
);
data = request << Send;


```

#### [Timeout](#timeout)

**Syntax:** obj \<< Timeout(seconds)

**Description:** The default timeout for the request action to complete is 60 seconds. This value can be adjusted to accommodate more time consuming web service actions.

**JMP Version Added:** 14

```


request = New HTTP Request(
    Url(
        "https://community.jmp.com/html/assets/community-icons/community-icon-mastering.png"
    ),
    Method( "GET" ),
    Timeout( 120 )
);
bytes = request << Send;
img = Open( bytes, jpg );
obj = New Window( "Mastering JMP", img );


```

#### [URL](#url)

**Syntax:** obj \<< URL(path)

**Description:** When the request is created (or used with Reset), this can be used as a parameter. obj = HTTP Request(URL("http://google.com"));

**JMP Version Added:** 14

```


fields = Associative Array();
fields["text"] = "statistics";
s = New HTTP Request(
    URL( "http://text-processing.com/api/sentiment/" ),
    Method( "POST" ),
    Form( Fields( fields ) )
) << Send;


```

#### [Use Cookies](#use-cookies)

**Syntax:** obj \<< Use Cookies(\<true | false>))

**Description:** Configures the request to use cookies for the session. The default is true.

**JMP Version Added:** 17

```


request = New HTTP Request();
data = request << Use Cookies( "false" );


```

#### [UserPwd](#userpwd)

**Syntax:** obj \<< UserPwd(clark kent:superman)

**Description:** Sets the user and password field on the request used for authentication. The format of which is: \[user name\]:[password]. The user and password strings are not URL decoded, so there is no way to send in a user name containing a colon using this option.

**JMP Version Added:** 18

```


request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    JSON( "\[{"username":"bob","address":"12345"}]\" ),
    UserPwd( "clark kent:superman" ),

);
data = request << Send;


```

#### [Username](#username)

**Syntax:** obj \<< Username(name)

**Description:** Sets the user name on the request used for basic authentication. This value is used in conjunction with request password, where both user name and password are concatenated with a ':' (name:password) and passed to the web service.

**JMP Version Added:** 14

```


request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    JSON( "\[{"username":"bob","address":"12345"}]\" ),
    Username( "ross" ),
    Password( "Abc123" ),

);
data = request << Send;


```

#### [Verbose](#verbose)

**Syntax:** obj \<< Verbose(\<"true"> | \<"false">)

**Description:** Writes extensive error messages to the log. The default is true.

**JMP Version Added:** 14

```


Write(
    "\!Verbose is true by default.\!nIt automatically outputs status so you'll see the status message twice....\!n"
);
baseURL = "http://swapi.co/api";
request = New HTTP Request( URL( baseURL || "/people/1000" ), Method( "GET" ) );
request << Send;
Write( "\!n" || Char( request << Get Status Message ) || "\!n" );

Write( "\!nSetting Verbose to false controls writing the status....\!n" );
baseURL = "http://swapi.co/api";
request << Reset( URL( baseURL || "/people/1000" ), Method( "GET" ), Verbose( "false" ) );
request << Send;
Write( "\!n" || Char( request << Get Status Message ) || "\!n" );


```

#### [Verify SSL](#verify-ssl)

**Syntax:** obj \<< Verify SSL(\<"true"> | \<"false">)

**Description:** Certificate verification is on. If set to false, requests to complete without certificate verification will be allowed.

**JMP Version Added:** 16

```


request = New HTTP Request(
    Url(
        "https://community.jmp.com/html/assets/community-icons/community-icon-mastering.png"
    ),
    Method( "GET" ),
    Verify SSL( "false" )
);
bytes = request << Send;
img = Open( bytes, jpg );
obj = New Window( "Mastering JMP", img );


```

#### [XML](#xml)

**Syntax:** obj \<< XML( xml data )

**Description:** This will set an xml string value in the request. The xml string will be used as the body of the document. The request content type header will automatically be set to "Content-Type: application/xml"

**JMP Version Added:** 15

```


request = New HTTP Request(
    url( "http://httpbin.org/post" ),
    Method( "POST" ),
    XML(
        "\[<?xml version="1.0" encoding="UTF-8"?>
        <serv:message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <body>
            <bodyContent
                xsi:type="java:com.webex.service.binding.attendee.LstMeetingAttendee">
                <meetingKey>123456</meetingKey>
            </bodyContent>
        </body>
    </serv:message>]\"
    )
);
data = request << Send;


```

## [MultiHTTPRequests](#multihttprequests)

### [Item Messages](#item-messages_1)

#### [Add](#add)

**Syntax:** obj \<< Add(request, <label>)

**Description:** Add an HTTP Request to MultiHTTPRequest. An optional label can be used. This is useful when performing parallel downloads. All HTTP Requests are validated before they are used.

**JMP Version Added:** 17

```


requests = New Multi HTTP Request();
requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso"
        )
    ),
    "My First Download"
);

requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso"
        )
    )
);

data = requests << Download( "show progress", "detailed" );
http_requests = requests << Get Requests();
For( i = 1, i <= N Items( http_requests ), i++,
    Show( http_requests[i] << Get Mime Type() )
);


```

#### [Download](#download_1)

**Syntax:** obj \<< Download(\<"show progress">, \<"detailed">)

**Description:** Downloads the HTTP Responses to files in parallel. Useful for downloading multiple files at once from one or more web services. Using show progress will show a cancelable progress bar with the progress of the files downloaded. Using details will show the individual download progress.

**JMP Version Added:** 17

**Example 1**

```


urls =
{"http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso",
"http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso",
"https://download.manjaro.org/xfce/21.1.0/manjaro-xfce-21.1.0-210817-linux513.iso"};

requests = New Multi HTTP Request();
For( i = 1, i <= N Items( urls ), i++,
    request = New HTTP Request( Method( "GET" ), URL( urls[i] ) );
    requests << Add( request );
);
http_requests = requests << Get Requests();
data = requests << Download( "show progress", "detailed" );
Show( requests << Has Error );
For( i = 1, i <= N Items( http_requests ), i++,
    Show( http_requests[i] << Get Mime Type() )
);


```

**Example 2**

```


urls =
{"http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso",
"http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso",
"https://download.manjaro.org/xfce/21.1.0/manjaro-xfce-21.1.0-210817-linux513.iso"};

process_result = Function( {p, r},
    {Default Local},
    Show( r )
);

process_error = Function( {p, e, t},
    {Default Local},
    Show( e );
    Show( t );
);


requests = New Multi HTTP Request();
For( i = 1, i <= N Items( urls ), i++,
    request = New HTTP Request( Method( "GET" ), URL( urls[i] ) );
    requests << Add( request );
);

http_requests = requests << Get Requests();
promise = requests << Download( "async" );
promise << On Result( process_result );
promise << On Error( process_error );


```

#### [Get Requests](#get-requests)

**Syntax:** obj \<< Get Requests()

**JMP Version Added:** 17

```


requests = New Multi HTTP Request();
http_request_1 = New HTTP Request(
    Method( "GET" ),
    URL(
        "http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso"
    )
);
http_request_2 = New HTTP Request(
    Method( "GET" ),
    URL( "http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso" )
);

requests << Add( http_request_1 );

requests << Add( http_request_2 );
http_requests = requests << Get Requests();
//http_request_1 is the same as http_requests[1]
//http_request_2 is the same as http_requests[2]


```

#### [Has Error](#has-error_1)

**Syntax:** obj \<< Has Error

**Description:** Returns true if the multi request has an error. The multi request has an error if any its HTTP requests have an error.

**JMP Version Added:** 14

```


requests = New Multi HTTP Request();
http_request_1 = New HTTP Request(
    Method( "GET" ),
    URL(
        "http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso"
    )
);
http_request_2 = New HTTP Request(
    Method( "GET" ),
    URL( "http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso" )
);

requests << Add( http_request_1 );

requests << Add( http_request_2 );
data = requests << Download( "show progress", "detailed" );
Show( requests << Has Error );


```

#### [Is Success](#is-success_1)

**Syntax:** obj \<< Is Success

**Description:** Returns true if the multi request is successful. The multi request is successful if all of its HTTP requests are successful.

**JMP Version Added:** 14

```


requests = New Multi HTTP Request();
http_request_1 = New HTTP Request( Method( "GET" ), URL( "https://google.com" ) );
http_request_2 = New HTTP Request( Method( "GET" ), URL( "https://jmp.com" ) );

requests << Add( http_request_1 );

requests << Add( http_request_2 );
data = requests << Download( "show progress", "detailed" );
Show( requests << Is Successful );


```

#### [Is Successful](#is-successful_1)

**Syntax:** obj \<< Is Successful

**Description:** Returns true if the multi request is successful. The multi request is successful if all of its HTTP requests are successful.

**JMP Version Added:** 14

```


requests = New Multi HTTP Request();
http_request_1 = New HTTP Request( Method( "GET" ), URL( "https://google.com" ) );
http_request_2 = New HTTP Request( Method( "GET" ), URL( "https://jmp.com" ) );

requests << Add( http_request_1 );

requests << Add( http_request_2 );
data = requests << Download( "show progress", "detailed" );
Show( requests << Is Successful );


```

#### [Is Valid](#is-valid_1)

**Syntax:** obj \<< Is Valid

**Description:** Is the multi request valid. The multi request is valid if all its HTTP requests are valid.

**JMP Version Added:** 17

```


requests = New Multi HTTP Request();
http_request_1 = New HTTP Request(
    Method( "GET" ),
    URL(
        "http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso"
    )
);
http_request_2 = New HTTP Request(
    Method( "GET" ),
    URL( "http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso" )
);

requests << Add( http_request_1 );

requests << Add( http_request_2 );
Show( requests << Is Valid() );


```

#### [Reset](#reset_1)

**Syntax:** obj \<< Reset()

**Description:** Resets multi requests. This resets any HTTP request that has already been added.

**JMP Version Added:** 17

```


requests = New Multi HTTP Request();
requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso"
        )
    ),
    "My First Download"
);

requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso"
        )
    )
);
requests << Reset();


```

#### [Send](#send_1)

**Syntax:** obj \<< Send(\<"text" | "blob">, \<"show progress download" | "show progress upload" | "show progress both" | "show progress">)

**Description:** The return value from Send will be either character data or binary BLOB. You can check the return with the Is String JSL function. Using show progress download will show a cancelable progress bar with the progress of data downloaded. Using show progress upload will show a cancelable progress bar with the progress of data uploaded. Using show progress both will show a cancelable progress bar with the progress of data uploaded and downloaded. Using show progress will show a cancelable progress bar with the progress of data uploaded or downloaded (or both). For posting forms, show progress will show upload and download progress. For posting files, show progress will show upload progress. For retrieving data, show progress will show download progress.

**JMP Version Added:** 17

**Example 1**

```


//Taken from the Scripting Index Example for New HTTP Request
requests = New Multi HTTP Request();
bLabel = 0;
bValues = 0;
dt = Empty();

process_result = Function( {p, r},
    {Default Local},
    sentiments = {};
    For( i = 1, i <= N Items( r ), i++,
        Insert Into( sentiments, r[i]["content"] )
    );
    //loop through the returned sentiments
    For( i = 1, i <= N Items( sentiments ), i++,
        s = sentiments[i];
        sAsList = Parse JSON( s );
        retval = Associative Array();
        retval["pos"] = sAsList["probability"]["pos"];
        retval["neg"] = sAsList["probability"]["neg"];
        retval["neutral"] = sAsList["probability"]["neutral"];
        retval["label"] = sAsList["label"];
        sentiment = retval;
        If( bLabel,
            Column( dt, colLabel )[i] = sentiment["label"]
        );
        If( bValues,
            Column( dt, colValPos )[i] = sentiment["pos"];
            Column( dt, colValNeg )[i] = sentiment["neg"];
            Column( dt, colValNeutral )[i] = sentiment["neutral"];
        );
    );
);

process_error = Function( {p, e, t},
    {Default Local},
    Show( e );
    Show( t );
);

//this is now just going to configure a New HTTP Request and add it to New Multi HTTP Request
getSentiment = Function( {text},
    fields = Associative Array();
    fields["text"] = text;
    requests << Add(
        New HTTP Request(
            URL( "http://text-processing.com/api/sentiment/" ),
            Method( "POST" ),
            Form( Fields( fields ) ),
            Headers( {"Accept: application/json"} )
        )
    );
);

addSentimentColumns = Function( {dt3, colname, cLabel, cValues},
    dt = dt3;
    bLabel = cLabel;
    bValues = cValues;
    col = Column( dt, colname );
    colLabel = "Sentiment_Label(" || colname || ")";
    colValPos = "Sentiment_Pos(" || colname || ")";
    colValNeg = "Sentiment_Neg(" || colname || ")";
    colValNeutral = "Sentiment_Neutral(" || colname || ")";
    If( bLabel,
        dt << New Column( colLabel, Character )
    );
    If( bValues,
        dt << New Column( colValPos, Numeric );
        dt << New Column( colValNeg, Numeric );
        dt << New Column( colValNeutral, Numeric );
    );
    For( i = 1, i <= N Rows( dt ), i++,
        getSentiment( col[i] )
    );
    //this executes in parallel, with a promise
    promise = requests << Send( "async" );
    promise << On Result( process_result );
    promise << On Error( process_error );
);

dt2 = Open( "$SAMPLE_DATA\Cereal.jmp" );
addSentimentColumns( dt2, "Name", 1, 1 );


```

**Example 2**

```


//Taken from the Scripting Index Example for New HTTP Request
requests = New Multi HTTP Request();

//this is now just going to configure a New HTTP Request and add it to New Multi HTTP Request
getSentiment = Function( {text},
    fields = Associative Array();
    fields["text"] = text;
    requests << Add(
        New HTTP Request(
            URL( "http://text-processing.com/api/sentiment/" ),
            Method( "POST" ),
            Form( Fields( fields ) ),
            Headers( {"Accept: application/json"} )
        )
    );
);

addSentimentColumns = Function( {dt, colname, bLabel, bValues},
    col = Column( dt, colname );
    colLabel = "Sentiment_Label(" || colname || ")";
    colValPos = "Sentiment_Pos(" || colname || ")";
    colValNeg = "Sentiment_Neg(" || colname || ")";
    colValNeutral = "Sentiment_Neutral(" || colname || ")";
    If( bLabel,
        dt << New Column( colLabel, Character )
    );
    If( bValues,
        dt << New Column( colValPos, Numeric );
        dt << New Column( colValNeg, Numeric );
        dt << New Column( colValNeutral, Numeric );
    );
    For( i = 1, i <= N Rows( dt ), i++,
        getSentiment( col[i] )
    );
    //this executes in parallel
    sentiments = requests << Send( "show progress", "detailed" );
    //loop through the returned sentiments
    Show( N Items( requests << Get Requests() ) ); //number of requests in parallel
    For( i = 1, i <= N Items( sentiments ), i++,
        s = sentiments[i];
        sAsList = Parse JSON( s );
        retval = Associative Array();
        retval["pos"] = sAsList["probability"]["pos"];
        retval["neg"] = sAsList["probability"]["neg"];
        retval["neutral"] = sAsList["probability"]["neutral"];
        retval["label"] = sAsList["label"];
        sentiment = retval;
        If( bLabel,
            Column( dt, colLabel )[i] = sentiment["label"]
        );
        If( bValues,
            Column( dt, colValPos )[i] = sentiment["pos"];
            Column( dt, colValNeg )[i] = sentiment["neg"];
            Column( dt, colValNeutral )[i] = sentiment["neutral"];
        );
    );
);

dt2 = Open( "$SAMPLE_DATA\Cereal.jmp" );
addSentimentColumns( dt2, "Name", 1, 1 );


```

## [OAuth2](#oauth2)

### [Item Messages](#item-messages_2)

#### [Authorization Fields](#authorization-fields)

**Syntax:** oauth2 \<< Authorization Fields(...)

**Description:** Authorization fields is an associative array of key and value pairs to be used in the query string for the OAuth2 authorization URL.

**JMP Version Added:** 15

```


/*
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
*/
auth_url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
scope = "https://graph.microsoft.com/user.read";
client_id = "6731de76-14a6-49ae-97bc-6eba6914391e";
auth_fields = [=> ];

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
oauth2 = New OAuth2();
oauth2 << Authorization Fields( auth_fields );


```

#### [Authorization URL](#authorization-url)

**Syntax:** oauth2 \<< Authorization URL(...)

**Description:** Sets the OAuth2 authorization URL.

**JMP Version Added:** 15

```


oauth2 = New OAuth2();
auth_url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
oauth2 << Authorization URL( auth_url );


```

#### [Browser Type](#browser-type)

**Syntax:** oauth2 \<< Browser Type("Default" | "Embedded" | "External")

**Description:** The Default option is to use the embedded browser for OAuth2 authentication unless authenticating with Google. The Embedded option is to use the embedded browser for OAuth2 authentication unless authenticating with Google (currently the same as Default). The External option is to use the external browser for OAuth2 authentication and copy the resulting code/URL into the text area in order to complete authentication.

**JMP Version Added:** 17

```


/*
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
*/

/*
Note: the copy the url into the text area after authentication is complete
*/
auth_url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
token_url = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
redirect_url = "http://localhost/myapp/";
client_id = "6731de76-14a6-49ae-97bc-6eba6914391e";
client_secret = "JqQX2PNo9bpM0uEihUPzyrh";
scope = "openid offline_access https://graph.microsoft.com/user.read";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2( Browser Type( "External" ) );
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

auth_header = oauth2 << Get Auth Header();
request = New HTTP Request(
    URL( "https://graph.microsoft.com/v1.0/me" ),
    Headers( {auth_header} ),
    Method( "GET" )
);
data = request << Send;


```

#### [Client Id](#client-id)

**Syntax:** oauth2 \<< Client Id(...)

**Description:** Sets the OAuth2 client ID is a public identifier that was used during web service creation.

**JMP Version Added:** 15

```


/*
https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/
*/
client_id = "6731de76-14a6-49ae-97bc-6eba6914391e";
oauth2 = New OAuth2();
oauth2 << Client Id( client_id );


```

#### [Client Secret](#client-secret)

**Syntax:** oauth2 \<< Client Secret(...)

**Description:** Sets the OAuth2 client secret that was created during web service creation.

**JMP Version Added:** 15

```


/*
https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/
*/
client_secret = "JqQX2PNo9bpM0uEihUPzyrh";
oauth2 = New OAuth2();
oauth2 << Client Secret( client_secret );


```

#### [Code Verifier](#code-verifier)

**Syntax:** oauth2 \<< Code Verifier(\<"cdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-.\_~">

**Description:** The code verifier is a cryptographically random string that the client uses to identify itself when exchanging an authorization code for an access token. It has a minimum length of 43 characters and a maximum length of 128 characters.

**JMP Version Added:** 19

```


oauth2 = New OAuth2();
oauth2 << Code Verifier( "cdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~" );


```

#### [Get Access Token](#get-access-token)

**Syntax:** oauth2 \<< Get Access Token()

**Description:** Gets the current OAuth2 access token. This initiates communication to the authorization server if needed.

**JMP Version Added:** 15

```


/*
https://github.com/googlesamples/oauth-apps-for-windows/blob/master/OAuthConsoleApp/OAuthConsoleApp/Program.cs
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/

auth_url = "https://accounts.google.com/o/oauth2/v2/auth";
token_url = "https://www.googleapis.com/oauth2/v4/token";
redirect_url = "http://localhost/myapp/";
client_id = "581786658708-elflankerquo1a6vsckabbhn25hclla0.apps.googleusercontent.com";
client_secret = "3f6NggMbPtrmIBpgx-MK2xXK";
scope = "openid profile";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

access_token = oauth2 << Get Access Token();


```

#### [Get Auth Response Error](#get-auth-response-error)

**Syntax:** oauth2 \<< Get Authentication Response Error()

**Description:** Gets the OAuth2 response error.

**JMP Version Added:** 18

```


oauth2 = New OAuth2();
error = oauth2 << Get Authentication Response Error();


```

#### [Get Auth Response Fields](#get-auth-response-fields)

**Syntax:** obj \<< Get Auth Response Fields

**JMP Version Added:** 15

#### [Get Authentication Response Error](#get-authentication-response-error)

**Syntax:** obj \<< Get Authentication Response Error

**JMP Version Added:** 18

#### [Get Authorization Header](#get-authorization-header)

**Syntax:** oauth2 \<< Get Authorization Header

**Description:** Gets the header in the form:

Authorization: Bearer [OAuth2 token]

where [OAuth2 token] is the bearer token obtained from an authorization server.

**JMP Version Added:** 15

**Example 1**

```


/*
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/
auth_url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
token_url = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
redirect_url = "http://localhost/myapp/";
client_id = "6731de76-14a6-49ae-97bc-6eba6914391e";
client_secret = "JqQX2PNo9bpM0uEihUPzyrh";
scope = "openid offline_access https://graph.microsoft.com/user.read";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

auth_header = oauth2 << Get Auth Header();
request = New HTTP Request(
    URL( "https://graph.microsoft.com/v1.0/me" ),
    Headers( {auth_header} ),
    Method( "GET" )
);
data = request << Send;


```

**Example 2**

```


/*
https://github.com/googlesamples/oauth-apps-for-windows/blob/master/OAuthConsoleApp/OAuthConsoleApp/Program.cs
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/
auth_url = "https://accounts.google.com/o/oauth2/v2/auth";
token_url = "https://www.googleapis.com/oauth2/v4/token";
redirect_url = "http://localhost/myapp/";
client_id = "581786658708-elflankerquo1a6vsckabbhn25hclla0.apps.googleusercontent.com";
client_secret = "3f6NggMbPtrmIBpgx-MK2xXK";
scope = "openid profile";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

auth_header = oauth2 << Get Auth Header();
request = New HTTP Request(
    URL( "https://www.googleapis.com/oauth2/v3/userinfo" ),
    Headers( {auth_header} ),
    Method( "GET" )
);
data = request << Send;
If( !Is Empty( data ),
    json_jsl = Parse JSON( data );
    If( json_jsl << Contains( "picture" ),
        picture_url = json_jsl["picture"];
        New Window( "Example", Picture Box( Open( picture_url ) ) );
    ,
        Show( data )
    );
);


```

#### [Get Authorization Response Fields](#get-authorization-response-fields)

**Syntax:** oauth2 \<< Get Authorization Response Fields()

**Description:** Gets the current OAuth2 response values from the authorization server.

**JMP Version Added:** 15

```


/*
https://github.com/googlesamples/oauth-apps-for-windows/blob/master/OAuthConsoleApp/OAuthConsoleApp/Program.cs
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/
auth_url = "https://accounts.google.com/o/oauth2/v2/auth";
token_url = "https://www.googleapis.com/oauth2/v4/token";
redirect_url = "http://localhost/myapp/";
client_id = "581786658708-elflankerquo1a6vsckabbhn25hclla0.apps.googleusercontent.com";
client_secret = "3f6NggMbPtrmIBpgx-MK2xXK";
scope = "openid profile";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

token = oauth2 << Get Access Token();
auth_response = oauth2 << Get Authorization Response Fields();


```

#### [Get Code](#get-code)

**Syntax:** oauth2 \<< Get Code()

**Description:** Gets the current OAuth2 code. This initiates communication to the authorization server if needed.

**JMP Version Added:** 15

```


/*
https://github.com/googlesamples/oauth-apps-for-windows/blob/master/OAuthConsoleApp/OAuthConsoleApp/Program.cs
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/

auth_url = "https://accounts.google.com/o/oauth2/v2/auth";
token_url = "https://www.googleapis.com/oauth2/v4/token";
redirect_url = "http://localhost/myapp/";
client_id = "581786658708-elflankerquo1a6vsckabbhn25hclla0.apps.googleusercontent.com";
client_secret = "3f6NggMbPtrmIBpgx-MK2xXK";
scope = "openid profile";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

code = oauth2 << Get Code();


```

#### [Get Grant Type](#get-grant-type)

**Syntax:** oauth2 \<< Get Grant Type()

**Description:** Gets the current OAuth2 grant type.

**JMP Version Added:** 15

```


oauth2 = New OAuth2();
grant_types = oauth2 << Get Grant Types();
oauth2 << Grant Type( grant_types[1] );
grant = oauth2 << Get Grant Type();
Show( grant );


```

#### [Get Grant Types](#get-grant-types)

**Syntax:** oauth2 \<< Get Grant Types

**Description:** Gets the supported JMP OAuth2 grant types.

**JMP Version Added:** 15

```


/*
https://oauth.net/2/grant-types/
*/
oauth2 = New OAuth2();
grant_types = oauth2 << Get Grant Types();
Show( grant_types );


```

#### [Get ID Token](#get-id-token)

**Syntax:** oauth2 \<< Get ID Token()

**Description:** Gets the current OAuth2 ID token. This initiates communication to the authorization server if needed.

**JMP Version Added:** 15

```


/*
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/

auth_url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
token_url = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
redirect_url = "http://localhost/myapp/";
client_id = "6731de76-14a6-49ae-97bc-6eba6914391e";
client_secret = "JqQX2PNo9bpM0uEihUPzyrh";
scope = "openid offline_access https://graph.microsoft.com/user.read";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

id_token = oauth2 << Get ID Token();


```

#### [Get Refresh Token](#get-refresh-token)

**Syntax:** oauth2 \<< Get Refresh Token()

**Description:** Gets the current OAuth2 refresh token. This initiates communication to the authorization server if needed.

**JMP Version Added:** 15

```


/*
https://github.com/googlesamples/oauth-apps-for-windows/blob/master/OAuthConsoleApp/OAuthConsoleApp/Program.cs
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/

auth_url = "https://accounts.google.com/o/oauth2/v2/auth";
token_url = "https://www.googleapis.com/oauth2/v4/token";
redirect_url = "http://localhost/myapp/";
client_id = "581786658708-elflankerquo1a6vsckabbhn25hclla0.apps.googleusercontent.com";
client_secret = "3f6NggMbPtrmIBpgx-MK2xXK";
scope = "openid profile";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

refresh_token = oauth2 << Get Refresh Token();


```

#### [Get Scope](#get-scope)

**Syntax:** oauth2 \<< Get Scope()

**Description:** Gets the current OAuth2 scope.

**JMP Version Added:** 15

```


/*
https://github.com/googlesamples/oauth-apps-for-windows/blob/master/OAuthConsoleApp/OAuthConsoleApp/Program.cs
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/

auth_url = "https://accounts.google.com/o/oauth2/v2/auth";
token_url = "https://www.googleapis.com/oauth2/v4/token";
redirect_url = "http://localhost/myapp/";
client_id = "581786658708-elflankerquo1a6vsckabbhn25hclla0.apps.googleusercontent.com";
client_secret = "3f6NggMbPtrmIBpgx-MK2xXK";
scope = "openid profile";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

code = oauth2 << Get Scope();


```

#### [Get Window Title](#get-window-title)

**Syntax:** oauth2 \<< Get Window Title

**Description:** Gets the OAuth2 window title.

**JMP Version Added:** 16

```


oauth2 = New OAuth2();
oauth2 << Set Window Title( "Authorization Window" );
title = oauth2 << Get Window Title;


```

#### [Grant Type](#grant-type)

**Syntax:** oauth2 \<< Grant Type("Authorization Code" | "Client Credentials" | "Refresh Token")

**Description:** The requested grant type has to be one of the grant types supported by JMP and the OAuth2 authorization provider.

**JMP Version Added:** 15

```


oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
grant = oauth2 << Get Grant Type();
Show( grant );


```

#### [Has Auth Response Error](#has-auth-response-error)

**Syntax:** obj \<< Has Auth Response Error

**JMP Version Added:** 18

#### [Has Authentication Response Error](#has-authentication-response-error)

**Syntax:** oauth2 \<< Has Authentication Response Error()

**Description:** Checks for an OAuth2 authentication response error.

**JMP Version Added:** 18

```


oauth2 = New OAuth2();
If( oauth2 << Has Authentication Response Error(),
    Show( oauth2 << Get Authentication Response Error )
);


```

#### [Is Expired](#is-expired)

**Syntax:** oauth2 \<< Is Expired()

**Description:** Returns whether the current OAuth2 access token has expired.

**JMP Version Added:** 15

```


/*
https://github.com/googlesamples/oauth-apps-for-windows/blob/master/OAuthConsoleApp/OAuthConsoleApp/Program.cs
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/
auth_url = "https://accounts.google.com/o/oauth2/v2/auth";
token_url = "https://www.googleapis.com/oauth2/v4/token";
redirect_url = "http://localhost/myapp/";
client_id = "581786658708-elflankerquo1a6vsckabbhn25hclla0.apps.googleusercontent.com";
client_secret = "3f6NggMbPtrmIBpgx-MK2xXK";
scope = "openid profile";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

token = oauth2 << Get Access Token();
expired = oauth2 << Is Expired();


```

#### [Login Hint](#login-hint)

**Syntax:** oauth2 \<< Login Hint(hint)

**Description:** Sets the login_hint value. login_hint is an OPTIONAL parameter in the Authentication Request as a "Hint" to the Authorization Server about the login identifier the End-User might use to log in (if necessary).

**JMP Version Added:** 17

```


oauth2 = New OAuth2();
oauth2 << Login Hint( "jmp_user@jmp.com" );


```

#### [Password](#password_1)

**Syntax:** oauth2 \<< Password(...)

**Description:** Sets the OAuth2 password for the password grant type.

**JMP Version Added:** 15

```




```

#### [Redirect URL](#redirect-url)

**Syntax:** oauth2 \<< Redirect URL(...)

**Description:** Sets the OAuth2 redirect URL that was used during web service creation.

**JMP Version Added:** 15

```


redirect_url = "http://localhost/myapp/";
oauth2 = New OAuth2();
oauth2 << Redirect URL( redirect_url );


```

#### [Scope](#scope)

**Syntax:** oauth2 \<< Scope(...)

**Description:** Sets the OAuth2 scope, a way to limit an application's access to an account.

**JMP Version Added:** 15

```


/*
https://oauth.net/2/scope/
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent
*/
scope = {"openid", "offline_access", "https://graph.microsoft.com/user.read"};
auth_fields = [=> ];
auth_fields["scope"] = Concat Items( scope, " " );
Show( auth_fields );
oauth2 = New OAuth2();
oauth2 << Authorization Fields( auth_fields );


```

#### [Set Window Title](#set-window-title)

**Syntax:** oauth2 \<< Set Window Title(title)

**Description:** Sets the OAuth2 window title.

**JMP Version Added:** 16

```


oauth2 = New OAuth2();
oauth2 << Set Window Title( "Authorization Window" );


```

#### [Token Fields](#token-fields)

**Syntax:** obj \<< Token Fields

**Description:** An associative array of key and value pairs to be used in the query string for the OAuth2 token URL.

**JMP Version Added:** 15

```


/*
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
*/
tokem_url = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
client_secret = "6731de76-14a6-49ae-97bc-6eba6914391e";
token_fields = [=> ];
scope = "openid profile";
token_fields["scope"] = scope;
oauth2 = New OAuth2();
oauth2 << Token Fields( token_fields );


```

#### [Token URL](#token-url)

**Syntax:** oauth2 \<< Token URL(...)

**Description:** Sets the OAuth2 token URL.

**JMP Version Added:** 15

```


oauth2 = New OAuth2();
token_url = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
oauth2 << Token URL( token_url );


```

#### [Use Default Window Title](#use-default-window-title)

**Syntax:** oauth2 \<< Use Default Window Title(1 | 0)

**Description:** Gets the OAuth2 window title.

**JMP Version Added:** 16

```


oauth2 = New OAuth2();
oauth2 << Use Default Window Title( 1 );
title = oauth2 << Get Window Title;


```

#### [Username](#username_1)

**Syntax:** oauth2 \<< Username(...)

**Description:** Sets the OAuth2 user name for the password grant type.

**JMP Version Added:** 15

```




```

# [IP.21 Server](#ip21-server)

### [New IP21 Client](#new-ip21-client)

**Syntax:** New IP21 Client(URL(base URL), \<Authentication Method("None"|"Basic"|"NTLM"|"Kerberos")>, \<Username(userid)>,\<Password(password)>)

**Description:** Creates a new IP21 Client instance that can be used to import data from an AspenTech IP.21 server.

**JMP Version Added:** 19

**Example 1**

```

/* Import actual (raw) data */
/* Note: URL() and Authentication Method() use example values. Please supply a working URL and authentication credentials. */  
tag set = {"TI8045", "TI8058", "TI8064"};
end time = Today();
start time = end time - In Days( 1 );
client = New IP21 Client(
    URL( "https://myserver.com/" ),
    Authentication Method( "NTLM" ),
    Username( "%_UID_%" ),
    Password( "%_PWD_%" )
);
importer = client << Importer(
    Data Source( "My-Data-Source" ),
    Tag Set( tag set ),
    Start Time( start time ),
    End Time( end time ),
    Retrieval Type( "Actual" )
);
importer << Run;


```

**Example 2**

```

/* Import interpolated data */
/* Note: URL() and Authentication Method() use example values. Please supply a working URL and authentication credentials. */  
tag set = {"TI8045", "TI8058", "TI8064"};
end time = Today();
start time = end time - In Days( 1 );
client = New IP21 Client(
    URL( "https://myserver.com/" ),
    Authentication Method( "NTLM" ),
    Username( "%_UID_%" ),
    Password( "%_PWD_%" )
);
importer = client << Importer(
    Data Source( "My-Data-Source" ),
    Tag Set( tag set ),
    Start Time( start time ),
    End Time( end time ),
    Retrieval Type( "Interpolated" ),
    Period( Minute( 30 ) ),     /* Every half hour */
);
importer << Run;


```

## [Item Messages](#item-messages)

### [Importer](#importer)

**Syntax:** Importer(Data Source(string), Tag Set(string list), Start Time(date-time value), End Time(date-time value), \<Retrieval Type(string)>, \<Max Count(number)>, \<Include Outsiders(0|1)>, \<Stepped(0|1)>, \<Period(Day(number) | Hour(number) | Minute(number))>, \<Aggregate( Method("Integral" | "Value" | "Integral Incomplete" | "Value Incomplete"), Start("Start Of Day" | "Start Of Time"), Anchor("Begin" | "Middle" | "End"))>

**Description:** Creates a new raw importer instance.

**JMP Version Added:** 19

**Example 1**

```

/* Import actual (raw) data */
/* Note: URL() and Authentication Method() use example values. Please supply a working URL and authentication credentials. */  
tag set = {"TI8045", "TI8058", "TI8064"};
end time = Today();
start time = end time - In Days( 1 );
client = New IP21 Client(
    URL( "https://myserver.com/" ),
    Authentication Method( "NTLM" ),
    Username( "%_UID_%" ),
    Password( "%_PWD_%" )
);
importer = client << Importer(
    Data Source( "My-Data-Source" ),
    Tag Set( tag set ),
    Start Time( start time ),
    End Time( end time ),
    Retrieval Type( "Actual" )
);
importer << Run;


```

**Example 2**

```

/* Import interpolated data */
/* Note: URL() and Authentication Method() use example values. Please supply a working URL and authentication credentials. */  
tag set = {"TI8045", "TI8058", "TI8064"};
end time = Today();
start time = end time - In Days( 1 );
client = New IP21 Client(
    URL( "https://myserver.com/" ),
    Authentication Method( "NTLM" ),
    Username( "%_UID_%" ),
    Password( "%_PWD_%" )
);
importer = client << Importer(
    Data Source( "My-Data-Source" ),
    Tag Set( tag set ),
    Start Time( start time ),
    End Time( end time ),
    Retrieval Type( "Interpolated" ),
    Period( Minute( 30 ) ),     /* Every half hour */
);
importer << Run;


```

# [Image](#image)

## [Associated Constructors](#associated-constructors)

### [New Image](#new-image)

**Syntax:** img = Open( filepath, jpg|png|gif|bmp|tif ) New Image(\<width, height>, <existing image> )

**Description:** A picture object, which can be used for adding a picture to a frame or a display box.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );


```

### [Open](#open)

**Syntax:** Open( filePath, \<data table options | Excel import options | text import options | SAS import options | HTML import options | esriShapeFile import options | PDF import options | other file options > )

**Description:** Returns a reference to a data table or other JMP file or object created from a file. If no path is specified, the Open dialog appears. If a folder path is specified, the system file browser is opened and no object is returned. Refer to the Syntax Reference for a complete description of available options.

```

/* Data tables, other JMP files, external files:
   Open( filePath,
     <Invisible | Private>,
     <Select Columns( "col", ... )>,
     <Ignore Columns( "col", ... )>,
     <Add to Recent Files(bool)>,
     <Quarantine Action("Allow Scripts"|"Block Scripts"|"Do Not Open"|"Show Dialog")>
     <Force Refresh>,
     <Enable Filter Views(bool)>,
     <"file type">
   )
*/
//Basic data table open
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
//Data table open with some options
dt2 = Open( "$SAMPLE_DATA/Fitness.jmp", Select Columns( "Name", "Sex", "Age", "Weight" ) );


```

## [Item Messages](#item-messages)

### [Add Frame](#add-frame)

**Syntax:** obj \<< Add Frame

**Description:** Adds a new frame to an animated image. The frame will not contain any content until Set Pixels is used. An optional duration argument can be specified, which indicates the frame duration in milliseconds. If the duration argument is omitted, the duration of the current frame will be used as the duration of the added frame. If there are no other frames, a default duration of 100 milliseconds is used.

**JMP Version Added:** 16

```

dim = 100;
mat0 = J( dim, dim, 0 );
mat1 = J( dim, dim, 1 );
multiImage = New Image( "rgb", {mat1, mat0, mat0} );
multiImage << Add Frame( 2000 );
multiImage << Set Pixels( "rgb", {mat0, mat1, mat0} );
multiImage << Add Frame( 1000 );
multiImage << Set Pixels( "rgb", {mat0, mat0, mat1} );
win = New Window( "Multi-Frame Image", multiImage );
durs = multiImage << Get Frame Durations();
For( i = 0, i < 3, i++,
    multiImage << Set Current Frame( i );
    win << reshow();
    dur = durs[i + 1] / 1000.0;
    Wait( dur );
);
win << Close Window();


```

### [Crop](#crop)

**Syntax:** obj \<< Crop( Left( number ), Right( number ), Top( number ), Bottom( number ) )

**Description:** Modifies the image to be the sub-image at the specified pixel coordinates within the existing image.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
Wait( 1 );
img << Crop( Left( 50 ), Right( 300 ), Top( 20 ), Bottom( 200 ) );
obj2 = New Window( "Cropped", img );


```

### [Filter](#filter)

**Syntax:** obj \<< Filter( despeckle|edge|enhance|median|negate|normalize|sharpen|contrast|gamma|reduce noise|gaussian blur|canny, <number> )

**Description:** Filters the image based on the specified algorithm. Filtering is useful for cleaning up noise in the image. Contrast, gamma and reduce noise require one additional (numeric) parameter. Gaussian blur requires two: radius and sigma.

**Example 1**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
New Window( "tile(40,40)", New Image( img ) );
Wait( 1 );
img << Filter( "negate" );
New Window( "Neg filter", img ); 
//contrast filter example 
img2 = Open( "$SAMPLE_IMAGES/black rhino footprint.jpg", jpg );
obj = New Window( "Black Rhino", New Image( img2 ) );
Wait( 1 );
img3 = New Image( img2 );/*save a copy for later*/ img2 << Filter( "Contrast", 4 );
New Window( "Contrast filter", New Image( img2 ) );


```

**Example 2**

```

/* http://en.wikipedia.org/wiki/Canny_edge_detector */ 
radius = 1;
sigma = 3;
smallThreshold = .01;
largeThreshold = .3;
file = Pick File(
    "pick picture",
    "$SAMPLE_IMAGES",
    {"pictures|png;jpg", "All Files|*"},
    1,
    0,
    "black rhino footprint.jpg"
);
original = New Image( file );
edges = New Image( original );
New Window( "canny",
    H List Box(
        Slider Box(
            0,
            10,
            radius,
            refilter();
            hb << reshow;
            t1 << settext( Char( Floor( radius ) ) );,
            <<setwidth( 100 )
        ),
        Text Box( "radius of smoothing filter=" ),
        t1 = Text Box( Char( Floor( radius ) ) )
    ),
    H List Box(
        Slider Box(
            1,
            5,
            sigma,
            refilter();
            hb << reshow;
            t2 << settext( Char( Floor( sigma ) ) );,
            <<setwidth( 100 )
        ),
        Text Box( "smoothing repeat=" ),
        t2 = Text Box( Char( Floor( sigma ) ) )
    ),
    H List Box(
        sb1 = Slider Box(
            .0001,
            1,
            largeThreshold,
            If( smallThreshold >= largeThreshold,
                sb0 << set( largeThreshold / 2 )
            );
            refilter();
            hb << reshow;
            t3 << settext( Char( largeThreshold ) );
            t4 << settext( Char( smallThreshold ) );,
            <<setwidth( 300 )
        ),
        Text Box( "large (start) threshold=" ),
        t3 = Text Box( Char( largeThreshold ) )
    ),
    H List Box(
        sb0 = Slider Box(
            .0001,
            1,
            smallThreshold,
            If( smallThreshold >= largeThreshold,
                sb1 << set( smallThreshold + .1 )
            );
            refilter();
            hb << reshow;
            t4 << settext( Char( smallThreshold ) );
            t3 << settext( Char( largeThreshold ) );,
            <<setwidth( 300 )
        ),
        Text Box( "small (stop) threshold=" ),
        t4 = Text Box( Char( smallThreshold ) )
    ),
    Spacer Box( size( 10, 20 ) ),
    hb = H List Box( original, edges )
);
refilter = Function( {},
    edges << setpixels( original << getpixels );
    //edges << filter( "gaussian blur", radius, sigma ); //you could use the gaussian blur filter by setting radius(0), below
    edges << filter(
        "canny"/* here it is! */,
        largeThreshold( largeThreshold )/*tracing begins when a large-value edge is found*/,
        smallThreshold( smallThreshold )/*tracing stops when the edge value gets too small*/,
        radius( radius )/*a blur-filter, use 0 for no blurring*/,
        Repeat( sigma )/* number of repeats of a box-blur; 3 approximates a gaussian-blur filter */
    );
    edges << filter( "negate" );/*black on white*/
);
refilter();


```

### [Flip Both](#flip-both)

**Syntax:** obj \<< Flip Both

**Description:** Flips the image both horizontally and vertically.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
Wait( 1 );
img << Flip Both;
obj2 = New Window( "Diagonal Flip", img );


```

### [Flip Horizontal](#flip-horizontal)

**Syntax:** obj \<< Flip Horizontal

**Description:** Flips the image horizontally.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
Wait( 1 );
img << Flip Horizontal;
obj2 = New Window( "Horizontal Flip", img );


```

### [Flip Vertical](#flip-vertical)

**Syntax:** obj \<< Flip Vertical

**Description:** Flips the image upside down.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
Wait( 1 );
img << Flip Vertical;
obj2 = New Window( "Vertical Flip", img );


```

### [Get Current Frame](#get-current-frame)

**Syntax:** obj \<< Get Current Frame

**Description:** Returns the current frame number. For most images, the value is 0. For animated GIF files, the value can be between 0 and one less than the number of frames. Actions, such as getPixels and setPixels, will act on the current frame.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
num = img << Get Current Frame();


```

### [Get EXIF](#get-exif)

**Syntax:** obj \<< Get EXIF

**Description:** Gets EXIF data that is stored internally with the image. An array of key/value pairs will be returned.

**JMP Version Added:** 14

```

img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
exifData = img << getEXIF();
key = exifData << first;
While( !Is Empty( key ),
    v = exifData << getValue( key );
    Show( key, v );
    key = exifData << next( key );
);


```

### [Get Frame Durations](#get-frame-durations)

**Syntax:** obj \<< Get Frame Durations

**Description:** Returns a matrix of the pause duration between each frame. The time is specified in milliseconds.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
durs = img << Get Frame Durations();


```

### [Get N Frames](#get-n-frames)

**Syntax:** obj \<< Get N Frames

**Description:** Returns the number of frames in the image. For most images this will be one. For animated GIF files this could be more than one.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
num = img << Get N Frames();


```

### [Get N Loops](#get-n-loops)

**Syntax:** obj \<< Get N Loops

**Description:** Returns the number of times an animated image should loop through its sequence. A value of zero indicates it should loop indefinitely.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
loops = img << Get N Loops();


```

### [Get Path](#get-path)

**Syntax:** obj \<< Get Path

### [Get Pixels](#get-pixels)

**Syntax:** mat = img \<< Get Pixels(); {r, g, b} = img \<< Get Pixels("rgb"); {r, g, b, a} = img \<< Get Pixels("rgba")

**Description:** If no color designator is specified, a matrix of JSL colors representing the pixel values is returned. A color designator of rgb will return a list of three matrices, red, green, and blue, respectively. Specifying rgba will return the alpha (transparency) channel as well as the red, green, and blue.

**Example 1**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
win = New Window( "tile(40,40)", img );
m = img << Get Pixels;
Show( m );


```

**Example 2**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
win = New Window( "tile(40,40)", img );
{r, g, b} = img << Get Pixels( "rgb" );


```

**Example 3**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
win = New Window( "tile(40,40)", img );
{r, g, b, a} = img << Get Pixels( "rgba" );


```

### [GetSize](#getsize)

**Syntax:** {w,h} = pic \<< Get Size {w,h} = pic \<< Size

**Description:** Returns a list containing the width and height of the image.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
s = {w, h} = img << Get Size;
Show( s );


```

### [Remove Frame](#remove-frame)

**Syntax:** obj \<< Remove Frame

**Description:** Removes a frame from an animated image. The index of the frame to remove is passed.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
img << Remove Frame( 0 );


```

### [Rotate](#rotate)

**Syntax:** obj \<< Rotate( angle )

**Description:** Rotates the image by the specified angle of rotation.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
Wait( 1 );
img << Rotate( 45 );
obj2 = New Window( "Rotated", img );


```

### [Save Image](#save-image)

**Syntax:** obj \<< Save Image( filePath, image type )

**Description:** Saves the image in the specified location and file name. The second parameter indicates what type of image to save, regardless of the extension used in the file name. Valid image types include PNG, JPG, GIF, TIFF, BMP, and PDF. If no image type is specified, or the specified image type is not understood, the image is saved as a PNG file.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
img << Save Image( "$TEMP/Mediterranean.jpg", "jpg" );


```

### [Scale](#scale)

**Syntax:** obj \<< Scale( scale | xscale, yscale )

**Description:** Applies a scale factor to the width and height of the image or scales the width (xscale) and height (yscale) independently.

**Example 1**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
img << scale( 0.5 );
obj2 = New Window( "Tile scaled by 0.5", img );


```

**Example 2**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
img << scale( 2, 0.5 );
obj2 = New Window( "Tile scaled by 2 vertically and by 0.5 horizontally", img );


```

### [Set Blob](#set-blob)

**Syntax:** obj \<< Set Blob

**Description:** Sets the image from a blob.

### [Set Current Frame](#set-current-frame)

**Syntax:** obj \<< Set Current Frame( frame )

**Description:** Sets the current frame number. For most images this will be 0. For animated GIF files, this can be between 0 and one less than the number of frames. Actions, such as getPixels and setPixels, will act on the current frame.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
num = img << Get N Frames();
win = New Window( "Progress", img );
For( i = 0, i < num, i++,
    img << Set Current Frame( i );
    win << reshow();
    Wait( 1 );
);
win << Close Window();


```

### [Set Frame Duration](#set-frame-duration)

**Syntax:** obj \<< Set Frame Duration( duration )

**Description:** Set the duration of the current frame in an animated image. The time is specified in milliseconds.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
img << Set Frame Duration( 1000 );
durs = img << Get Frame Durations();


```

### [Set N Loops](#set-n-loops)

**Syntax:** obj \<< Set N Loops( loops )

**Description:** Sets the number of times an animated image should loop through its sequence. A value of 0 indicates that the image should loop indefinitely.

```

img = New Image( "$SAMPLE_IMAGES/progress.gif" );
img << Set N Loops( 3 );
loops = img << Get N Loops();


```

### [Set Pixels](#set-pixels)

**Syntax:** img \<< Set Pixels(jslmat); img \<< Set Pixels ("rgb", {r, g, b})

**Description:** Sets the pixel matrix, or matrices, for the image. If one matrix is specified with no color designator, the matrix is treated as a matrix of JSL colors. A color designator can be specified, such as rgb, to indicate the following matrices are red, green, and blue, respectively. In this case, the size of all the specified matrices should be the same.

**Example 1**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
win = New Window( "tile(40,40)", img );
m = img << Get Pixels;
Wait( 1 );
n = m`;
img << Set Pixels( n );
win2 = New Window( "Transformed", img );


```

**Example 2**

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
win = New Window( "tile(40,40)", img );
{r, g, b} = img << Get Pixels( "rgb" );
Wait( 1 );
i = .30 * r + .59 * g + .11 * b;
img << Set Pixels( "rgb", {i, i, i} );
win2 = New Window( "Gray Scale", img );


```

### [SetSize](#setsize)

**Syntax:** obj \<< SetSize( {width, height} )

**Description:** Sets the image size based on the specified width and height.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
img << Set Size( {600, 600} );
obj2 = New Window( "Larger tile(40,40)", img );


```

### [Size](#size)

**Syntax:** {w,h} = pic \<< Get Size {w,h} = pic \<< Size

**Description:** Returns a list containing the width and height of the image.

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
obj = New Window( "tile(40,40)", img );
s = {w, h} = img << Get Size;
Show( s );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( fraction )

**Description:** Applies transparency to an image. Valid values are between 0.0 (transparent) and 1.0 (opaque)

```

img = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
win = New Window( "tile(40,40)", img );
Wait( 1 );
img << Transparency( 0.5 );
win << reshow;


```

# [Item Analysis](#item-analysis)

## [Associated Constructors](#associated-constructors)

### [Item Analysis](#item-analysis_1)

**Syntax:** Item Analysis( Y( columns ) )

**Description:** Relates a trait or ability to an individual's probability of endorsing or correctly responding to an item.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ), Freq( :_freqcol ) );


```

### [Test Items](#test-items)

**Syntax:** obj \<< Test Items( column(s) )

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );


```

## [Item Messages](#item-messages)

### [Model](#model)

**Syntax:** obj = Item Analysis(...Model( "Logistic 2PL"|"Logistic 3PL"|"Logistic 1PL" )...)

**Description:** Identifies the model used for the Item Analysis.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    Model( "Logistic 2PL" )
);


```

### [Number of Plots Across](#number-of-plots-across)

**Syntax:** obj \<< Number of Plots Across( number )

**Description:** Changes the layout of the Item Characteristic Curves which are closed by default.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
(obj << report)["Characteristic Curves"] << Close( 0 );
obj << Number of Plots Across( 3 );


```

### [Save Ability Formula](#save-ability-formula)

**Syntax:** obj \<< Save Ability Formula

**Description:** Saves the ability formula to a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Save Ability Formula;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Item Analysis(
    Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5, :Q6, :Q7, :Q8, :Q9 ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Item Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [JMP App Module Instance](#jmp-app-module-instance)

## [Item Messages](#item-messages)

### [Create Objects](#create-objects)

**Syntax:** obj \<< Create Objects

**Description:** Create the objects of the module instance. This can be called only within the script for a JMP App Module.

```

// This command is only valid within a JMP App Module Script


```

### [Get Box](#get-box)

**Syntax:** obj \<< Get Box

**Description:** Get the display box for the module instance.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Run Application;
modules = app << Get Modules;
inst = modules[1] << Create Instance;
inst << Get Box;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Get the namespace for the module instance.

```

app = JMP App();
(app << Get Namespace) << Show Contents;


```

### [Get User Data](#get-user-data)

**Syntax:** obj \<< Get User Data

**Description:** Returns the user data associated with the module instance.

```

// This command is only valid within a JMP App Module Script


```

### [Set User Data](#set-user-data)

**Syntax:** inst \<< Set User Data(expr)

**Description:** Stores a JSL value in the JMP app module instance; the value could be a number, string, list, associative array, or other JSL type.

```

// This command is only valid within a JMP App Module Script


```

# [JMP App Module](#jmp-app-module)

## [Item Messages](#item-messages)

### [Create Instance](#create-instance)

**Syntax:** instance = obj \<< Create Instance( <parameters> )

**Description:** Create an instance of the module. The parameters are passed to the OnModuleLoad() function defined in the module script.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Run Application;
modules = app << Get Modules;
modules[1] << Create Instance;


```

### [Get Application](#get-application)

**Syntax:** app = obj \<< Get Application

**Description:** Returns the application that owns the module.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Run Application;
modules = app << Get Modules;
modules[1] << Get Application;


```

# [JMP App](#jmp-app)

## [Item Messages](#item-messages)

### [Combine Windows](#combine-windows)

**Syntax:** obj \<< Combine Windows( {list of reports or data tables}, {...} )

**Description:** Combine the given list of platform reports or data tables into a new module. The application must not be currently running or in an edit state.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
biv = Bivariate( Y( :weight ), X( :height ) );
app = JMP App();
app << Set Name( "Instant App" );
app << Combine Windows( {dist << Report, biv << Report} );
(app << Get Modules)[1] << Set Window Title( "My Report" );
app << Run;


```

### [Debug](#debug)

**Syntax:** obj \<< Debug

**Description:** Run the application in the debugger.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Launcher with Report.jmpappsource" );
app << Debug;


```

### [Edit](#edit)

**Syntax:** obj \<< Edit

**Description:** Edit the application or dashboard in the builder.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Edit;


```

### [Get Modules](#get-modules)

**Syntax:** list = obj \<< Get Modules

**Description:** Get a list of the modules defined in the application.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Edit Application;
app << Get Modules();


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Get the namespace for the module instance.

```

app = JMP App();
(app << Get Namespace) << Show Contents;


```

### [Get Windows](#get-windows)

**Syntax:** obj \<< Get Windows

**Description:** Returns a list of open windows created as instances of application modules. Note that other windows created by application scripts, using New Window() or other functions, will not be included.

**JMP Version Added:** 14

**Example 1**

```

app = JMP App();
Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Historical.jmp" );
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Run;
app << Get Windows();


```

**Example 2**

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Graph Launcher.jmpappsource" );
app << Run;
launcher = (app << Get Windows())[1];
launcher[Button Box( 1 )] << Click;
launcher[Button Box( 1 )] << Click;
app << Get Windows();


```

### [Open File](#open-file)

**Syntax:** obj \<< Open File( <path> )

**Description:** Load the application from the given file.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
box = app << Edit Application;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Relaunches the Dashboard or Application, creating a new running copy of the Application.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Edit;
app << Relaunch Analysis;


```

### [Run](#run)

**Syntax:** obj \<< Run

**Description:** Run the application or dashboard.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Run;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Save a New Window() script

```

app = Include( "$SAMPLE_DASHBOARDS/Six Quality Graphs Dashboard.jmpappsource" );
app << Run;
app << Save Script for All Objects;


```

### [Save Script to Add-In](#save-script-to-add-in)

**Syntax:** obj \<< Save Script to Add-In

**Description:** Create a script (JSL) to produce this analysis, and load it into the Add-in Builder

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Edit;
app << "Save Script to Add-In";


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** app \<< Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Edit;
app << Save Script to Data Table;


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Edit;
app << Save Script to Journal;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

app = JMP App();
app << Open File( "$SAMPLE_APPS/Instant App.jmpappsource" );
app << Edit;
app << Save Script to Script Window;


```

# [JMP Live Connection](#jmp-live-connection)

## [Item Messages](#item-messages)

### [Create Folder](#create-folder)

**Syntax:** liveresult = liveconnection \<< Create Folder(Title(folder_title), Parent Folder(id | path | JMP Live Folder), \<Description(folder_description)>, \<If Exists("use" | "fail" | "default")>)

**Description:** Creates a new folder on JMP Live. Returns a JMP Live Result, which can be used to obtain the JMP Live Folder object for the new folder. Title and Parent Folder are required parameters. Parent Folder can be shortened to Parent or Folder. Description is optional. If Exists tells JMP Live what to do if the specified folder already exists: "use" means to just return the existing folder, "fail" means to throw an error, and "default" means to create a new folder and make its name unique by adding "(2)", "(3)", etc.

**JMP Version Added:** 16

**Example 1**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Create Folder Example" ),
    Description( "Folder created in the scripting index example script." )
);
folder = jmpliveresult << As Scriptable;
id = folder << Get ID;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( id ),
    Title( "Folder created using ID for parent" )
);
subfolder = jmpliveresult << As Scriptable;
Show( subfolder );


```

**Example 2**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Create Folder Example" ),
    If Exists( "use" ),
    Description( "Folder created in the scripting index example script." )
);
folder = jmpliveresult << As Scriptable;
Write( "\!n\!nNew folder ID: ", folder << Get ID, "  Path: ", folder << Get Path );


```

**Example 3**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Create Nested Subfolder Example" ),
    If Exists( "use" ),
    Description(
        "Folder created in the scripting index example script to serve as a top level folder."
    ),

);
folder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "Nested Subfolder Number 1" ),
    Description( "The First Subfolder." )
);
subFolder1 = jmpliveresult << As Scriptable;
Show( subFolder1 );
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "Nested Subfolder Number 2" ),
    Description( "The Second Subfolder." )
);
subFolder2 = jmpliveresult << As Scriptable;
Show( subFolder2 );


```

### [Delete Data](#delete-data)

**Syntax:** jmpliveresult = liveconnection \<< Delete Data(id | path | JMP Live Data)

**Description:** Deletes the specified data post. Returns whether action was successful (1) or not (0).

**JMP Version Added:** 17

```

liveconnection = New JMP Live();
// Create a folder to publish a report and data to
folder = (liveconnection << Create Folder(
    Title( "Delete Data Example" ),
    Parent( "~" ),
    If Exists( "use" )
)) << As Scriptable;

// Publish a report and data to the folder
bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
content = New JMP Live Content( gbsmoother, Title( "Smoother" ) );
publishedContent = (folder << Publish( content )) << As Scriptable;
report = publishedContent[1];
data = publishedContent[2];

// Delete the report by object
result = liveconnection << Delete Report( report );
If( result == 1,
    Write( "\!nReport was successfully deleted" ),
    Write( "\!nProblem deleting report" )
);

// Delete the data by path
result = liveconnection << Delete Data( "~/Delete Data Example/Big Class" );
If( result == 1,
    Write( "\!nData was successfully deleted" ),
    Write( "\!nProblem deleting data" )
);

// Delete the folder by ID
result = liveconnection << Delete Folder( folder << Get ID );
If( result == 1,
    Write( "\!nFolder was successfully deleted" ),
    Write( "\!nProblem deleting folder" )
);


```

### [Delete Folder](#delete-folder)

**Syntax:** jmpliveresult = liveconnection \<< Delete Folder(id | path | JMP Live Folder)

**Description:** Deletes the specified folder. Returns whether action was successful (1) or not (0).

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
// Create a folder to publish a report and data to
folder = (liveconnection << Create Folder(
    Title( "Delete Folder Example" ),
    Parent( "~" ),
    If Exists( "use" )
)) << As Scriptable;

// Publish a report and data to the folder
bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
content = New JMP Live Content( gbsmoother, Title( "Smoother" ) );
publishedContent = (folder << Publish( content )) << As Scriptable;
report = publishedContent[1];
data = publishedContent[2];

// Delete the report by ID
result = liveconnection << Delete Report( report << Get ID );
If( result == 1,
    Write( "\!nReport was successfully deleted" ),
    Write( "\!nProblem deleting report" )
);

// Delete the data using the JMP Live Data object
result = liveconnection << Delete Data( data );
If( result == 1,
    Write( "\!nData was successfully deleted" ),
    Write( "\!nProblem deleting data" )
);

// Delete the folder by path
result = liveconnection << Delete Folder( "~/Delete Folder Example" );
If( result == 1,
    Write( "\!nFolder was successfully deleted" ),
    Write( "\!nProblem deleting folder" )
);


```

### [Delete Report](#delete-report)

**Syntax:** jmpliveresult = liveconnection \<< Delete Report(id | path | JMP Live Report)

**Description:** Deletes the specified report. Returns whether action was successful (1) or not (0).

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
// Create a folder to publish a report and data to
folder = (liveconnection << Create Folder(
    Title( "Delete Report Example" ),
    Parent( "~" ),
    If Exists( "use" )
)) << As Scriptable;

// Publish a report and data to the folder
bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
content = New JMP Live Content( gbsmoother, Title( "Smoother" ) );
publishedContent = (folder << Publish( content )) << As Scriptable;
report = publishedContent[1];
data = publishedContent[2];

// Delete the report by path
result = liveconnection << Delete Report( "~/Delete Report Example/Smoother" );
If( result == 1,
    Write( "\!nReport was successfully deleted" ),
    Write( "\!nProblem deleting report" )
);

// Delete the data by ID
result = liveconnection << Delete Data( data << Get ID );
If( result == 1,
    Write( "\!nData was successfully deleted" ),
    Write( "\!nProblem deleting data" )
);

// Delete the folder using the object
result = liveconnection << Delete Folder( folder );
If( result == 1,
    Write( "\!nFolder was successfully deleted" ),
    Write( "\!nProblem deleting folder" )
);


```

### [Find Folders](#find-folders)

**Syntax:** jmpliveresult = liveconnection \<< Find Folders(\<Search(search_string)>, \<Publisher(user_name)>, \<PageSize(val)>)

**Description:** Finds folders by search string, publisher, or both. Returns a JMP Live Result List that can be used to reference individual folders. Subsequent Next() calls on this list return more folders. PageSize specifies how many folders to return, and defaults to 10. All search parameters are optional, and if none are provided, all folders are returned.

**JMP Version Added:** 16

**Example 1**

```

liveconnection = New JMP Live();
user = liveconnection << Get Username;

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Folders Example 1" )
);
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Folders Example 2" )
);

jmpliveresult = liveconnection << Find Folders( Publisher( user ), PageSize( 5 ) );
folderlist = jmpliveresult << As Scriptable();
Write( "\!nFind Folders(Count): ", folderlist << Get Number Of Items );
For( i = 1, i <= folderlist << Get Number Of Items, i += 1,
    Write( "\!nFolder[", i, "]", "(ID): ", folderlist[i] << Get ID );
    Write( "\!nFolder[", i, "]", "(Title): ", folderlist[i] << Get Title );
);


```

**Example 2**

```

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Folders Example - Search String 1" )
);
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Folders Example X" )
);
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Folders Example - Search String 2" )
);
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Folders Example Y" )
);

jmpliveresult = liveconnection << Find Folders( Search( "Search String" ), PageSize( 5 ) );
folderlist = jmpliveresult << As Scriptable();
Write( "\!nFind Folders(Count): ", folderlist << Get Number Of Items );
For( i = 1, i <= folderlist << Get Number Of Items, i += 1,
    Write( "\!nFolder[", i, "]", "(ID): ", folderlist[i] << Get ID );
    Write( "\!nFolder[", i, "]", "(Title): ", folderlist[i] << Get Title );
);


```

### [Find Posts](#find-posts)

**Syntax:** jmpliveresult = liveconnection \<< Find Posts(\<Search(search_string)>, \<Publisher(user_name)>, \<PageSize(val)>)

**Description:** Finds posts (all items including folders, reports and data) by search string, publisher, or both. Returns a JMP Live Result List that can be used to reference individual posts. Subsequent Next() calls on this list return more posts. PageSize specifies how many posts to return, and defaults to 10. All search parameters are optional, and if none are provided, all posts are returned.

**JMP Version Added:** 16

**Example 1**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();
user = liveconnection << Get Username;

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Posts Example" )
);
folder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into( contentlist, New JMP Live Content( dist ) );
Insert Into( contentlist, New JMP Live Content( gbsmoother ) );
Insert Into( contentlist, New JMP Live Content( gbline ) );
Insert Into( contentlist, New JMP Live Content( gbheat ) );

jmpliveresult = liveconnection << Publish( contentlist, Folder( folder ) );
jmpliveresult = liveconnection << Find Posts( Publisher( user ), PageSize( 5 ) );
postlist = jmpliveresult << As Scriptable();
Write( "\!nFind Posts(Count): ", postlist << Get Number Of Items );
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

**Example 2**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line and Bar Charts" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Posts Example" ),
    Description( "Has Graph Builder Reports" )
);
folder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into( contentlist, New JMP Live Content( dist ) );
Insert Into( contentlist, New JMP Live Content( gbsmoother ) );
Insert Into( contentlist, New JMP Live Content( gbline ) );

jmpliveresult = liveconnection << Publish( contentlist, Folder( folder ) );
jmpliveresult = liveconnection << Find Posts( Search( "Graph Builder" ), PageSize( 5 ) );
postlist = jmpliveresult << As Scriptable();
Write( "\!nFind Posts(Count): ", postlist << Get Number Of Items );
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

### [Find Reports](#find-reports)

**Syntax:** jmpliveresult = liveconnection \<< Find Reports(\<Search(search_string)>, \<Publisher(user_name)>, \<PageSize(val)>)

**Description:** Finds reports by search string, publisher, or both. Returns a JMP Live Result List that can be used to reference individual reports. Subsequent Next() calls on this list return more reports. PageSize specifies how many reports to return, and defaults to 10. All search parameters are optional, and if none are provided, all reports are returned.

**JMP Version Added:** 16

**Example 1**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();
user = liveconnection << Get Username;

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Reports Example" )
);
folder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into( contentlist, New JMP Live Content( dist ) );
Insert Into( contentlist, New JMP Live Content( gbsmoother ) );
Insert Into( contentlist, New JMP Live Content( gbline ) );
Insert Into( contentlist, New JMP Live Content( gbheat ) );

jmpliveresult = liveconnection << Publish( contentlist, Folder( folder ) );
jmpliveresult = liveconnection << Find Reports( Publisher( user ), PageSize( 5 ) );
reportlist = jmpliveresult << As Scriptable();
Write( "\!nFind Reports(Count): ", reportlist << Get Number Of Items );
For( i = 1, i <= reportlist << Get Number Of Items, i += 1,
    Write( "\!nReport[", i, "]", "(ID): ", reportlist[i] << Get ID );
    Write( "\!nReport[", i, "]", "(Title): ", reportlist[i] << Get Title );
);


```

**Example 2**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();
user = liveconnection << Get Username;

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Find Reports Example" )
);
folder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into( contentlist, New JMP Live Content( dist ) );
Insert Into( contentlist, New JMP Live Content( gbsmoother ) );
Insert Into( contentlist, New JMP Live Content( gbline ) );
Insert Into( contentlist, New JMP Live Content( gbheat ) );

jmpliveresult = liveconnection << Publish( contentlist, Folder( folder ) );
jmpliveresult = liveconnection << Find Reports( Search( "Graph Builder" ), PageSize( 5 ) );
reportlist = jmpliveresult << As Scriptable();
Write( "\!nFind Reports(Count): ", reportlist << Get Number Of Items );
For( i = 1, i <= reportlist << Get Number Of Items, i += 1,
    Write( "\!nReport[", i, "]", "(ID): ", reportlist[i] << Get ID );
    Write( "\!nReport[", i, "]", "(Title): ", reportlist[i] << Get Title );
);


```

### [Find Spaces](#find-spaces)

**Syntax:** jmpliveresult = liveconnection \<< Find Spaces(\<Permissions( "Contribute" )>, \<Search(search_string)>, \<PageSize(val)>)

**Description:** Finds spaces by an optional search string and an optional Permissions parameter to further filter the spaces to only those that allow contributions. Currently the Contribute permission is the only permission value supported. Returns a JMP Live Result List that can be used to reference individual spaces within the list. A paging value can be specified to say how many space items you want returned in the result list. Additional Next() calls can be made on this result list to get more spaces back.

**JMP Version Added:** 18

**Example 1**

```

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Find Spaces();
spaceList = jmpliveresult << As Scriptable;

Write( "\!n\!nSpace(Count): ", spaceList << Get Number Of Items );
For( i = 1, i <= spaceList << Get Number Of Items, i += 1,
    Write( "\!n\!nSpace[", i, "]", "(Name): ", spaceList[i] << Get Name );
    Write( "\!nSpace[", i, "]", "(Type): ", spaceList[i] << Get Type );
    Write( "\!nSpace[", i, "]", "(Key): ", spaceList[i] << Get Key );
    Write( "\!nSpace[", i, "]", "(Description): ", spaceList[i] << Get Description );
);


```

**Example 2**

```

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Find Spaces( Permissions( "Contribute" ) );
spaceList = jmpliveresult << As Scriptable;

Write( "\!n\!nSpace(Count): ", spaceList << Get Number Of Items );
For( i = 1, i <= spaceList << Get Number Of Items, i += 1,
    Write( "\!n\!nSpace[", i, "]", "(Name): ", spaceList[i] << Get Name );
    Write( "\!nSpace[", i, "]", "(Type): ", spaceList[i] << Get Type );
    Write( "\!nSpace[", i, "]", "(Key): ", spaceList[i] << Get Key );
    Write( "\!nSpace[", i, "]", "(Description): ", spaceList[i] << Get Description );
);


```

### [Get Connection Name](#get-connection-name)

**Syntax:** string = liveconnection \<< Get Connection Name()

**Description:** Retrieves the name of the JMP Live connection as a string.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
connectionname = liveconnection << Get Connection Name();
Write( "Connection Name: ", connectionname );


```

### [Get Data](#get-data)

**Syntax:** liveresult = liveconnection \<< Get Data(id | path)

**Description:** Retrieves a data post as a JMP Live Result object, which can be used to obtain the JMP Live Data object for that post.

**JMP Version Added:** 19

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Get Data Example" ),
    If Exists( "use" ),
    Description( "Folder created in the scripting index example script." )
);
folder = jmpliveresult << As Scriptable;

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

content = New JMP Live Content( gbsmoother );
jmpliveresult = folder << Publish( content );

dataPostID = "";
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Data",
        dataPostID = postlist[i] << Get ID
    );
);

// Get the data post by ID
dataPost = (liveconnection << Get Data( dataPostID )) << As Scriptable;
Write( "\!n\!nData post retrieved by ID: ", dataPost );

// Get the data post by path
dataPost = (liveconnection << Get Data( "~/Get Data Example/Big Class" )) << As Scriptable;
Write( "\!n\!nData post retrieved by path: ", dataPost );


```

### [Get Folder](#get-folder)

**Syntax:** liveresult = liveconnection \<< Get Folder(id | path)

**Description:** Retrieves a folder object as a JMP Live Result object, which can be used to obtain the JMP Live Folder object for the folder.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Get Folder Example" ),
    If Exists( "use" ),
    Description( "Folder created in the scripting index example script." )
);
folder = jmpliveresult << As Scriptable;
id = folder << Get ID;

// Get the folder using its ID
jmpliveresult = liveconnection << Get Folder( id );
retrieved = jmpliveresult << As Scriptable;
Write( "\!n\!nID of retrieved folder: ", retrieved << Get ID );

// Get the folder using its path
jmpliveresult = liveconnection << Get Folder( "~/Get Folder Example" );
retrieved = jmpliveresult << As Scriptable;
Write( "\!n\!nPath of retrieved folder: ", retrieved << Get Path );


```

### [Get HTTP Request](#get-http-request)

**Syntax:** httprequest = liveconnection \<< Get HTTP Request()

**Description:** Returns an HTTP Request instance that can be used to call JMP Live REST functions.

```

liveconnection = New JMP Live();
httprequest = liveconnection << Get HTTP Request();

httprequest << Method( "GET" );
httprequest << URL( "/api/webjmp" );
httprequest << Send();
httprequest << Get Status Message();


```

### [Get Post](#get-post)

**Syntax:** liveresult = liveconnection \<< Get Post(id | path)

**Description:** Retrieves a post as a JMP Live Result object, which can be used to obtain the JMP Live Post object for that post.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Get Post Example" ),
    If Exists( "use" ),
    Description( "Folder created in the scripting index example script." )
);
folder = jmpliveresult << As Scriptable;

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

content = New JMP Live Content( gbsmoother, Title( "Smoother" ) );
jmpliveresult = folder << Publish( content );

postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    result = liveconnection << Get Post( postlist[i] << Get ID );
    post = result << As Scriptable;
    Write( "\!n\!nPost ", i, ": ", post );
);

// Get a post by path
postByPath = (jmpliveresult = liveconnection << Get Post( "~/Get Post Example/Smoother" ))
 << As Scriptable;
Write( "\!n\!nPost retrieved by path: ", postByPath );


```

### [Get Report](#get-report)

**Syntax:** liveresult = liveconnection \<< Get Report(id | path)

**Description:** Retrieves a report post as a JMP Live Result object, which can be used to obtain the JMP Live Report object for that post.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Get Report Example" ),
    If Exists( "use" ),
    Description( "Folder created in the scripting index example script." )
);
folder = jmpliveresult << As Scriptable;

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

content = New JMP Live Content( gbsmoother, Title( "Smoother" ) );
jmpliveresult = folder << Publish( content );

reportPostId = "";
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        reportPostId = postlist[i] << Get ID
    );
);

// Get the report post by ID
reportPost = (liveconnection << Get Report( reportPostId )) << As Scriptable;
Write( "\!n\!nReport post retrieved by ID: ", reportPost );

// Get the data post by path
reportPost = (liveconnection << Get Report( "~/Get Report Example/Smoother" )) <<
As Scriptable;
Write( "\!n\!nReport post retrieved by path: ", reportPost );


```

### [Get URL](#get-url)

**Syntax:** string = liveconnection \<< Get URL()

**Description:** Retrieves the URL to the JMP Live site if it is available.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
url = liveconnection << Get URL();
Write( "URL: ", url );


```

### [Get Username](#get-username)

**Syntax:** string = liveconnection \<< Get Username()

**Description:** Retrieves the Username from the JMP Live object if it is available.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
username = liveconnection << Get UserName();
Write( "Username: ", username );


```

### [Is Logged In](#is-logged-in)

**Syntax:** value = liveconnection \<< Is Logged In()

**Description:** Indicates whether an authenticated session is established to the server. Returns whether action was successful (1) or not (0).

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
isloggedin = liveconnection << Is Logged In();
Write( "Logged In: ", isloggedin );


```

### [Publish](#publish)

**Syntax:** liveresult = liveconnection \<< Publish(JMPLiveContent, Folder(id | path | JMP Live Folder), \<Use Existing Data({{dt_or_name, data_id | data_path | JMP Live Data}})>)

**Description:** Publish reports or standalone data to JMP Live. Returns a JMP Live Result List object. You must specify the folder on JMP Live to which the content should be published. Mixing reports and standalone data in the same Publish command is not allowed. When publishing reports, if the report should use data that is already on JMP Live, the optional Use Existing Data parameter can be used to specify that. The Use Existing Data parameter is not valid when publishing standalone data.

**JMP Version Added:** 16

**Example 1**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Publish Example" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( gbsmoother );
jmpliveresult = liveconnection << Publish( content, Folder( folder ) );
postlist = jmpliveresult << As Scriptable();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!n\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

**Example 2**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line and Bar Charts" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Publish with Two Reports Example" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content1 = New JMP Live Content( gbsmoother );
content2 = New JMP Live Content( gbline );
jmpliveresult = liveconnection << Publish( {content1, content2}, Folder( folder ) );
postlist = jmpliveresult << As Scriptable();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!n\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

**Example 3**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Publish with Data Options Example" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content1 = New JMP Live Content(
    gbsmoother,
    Title( "Smoother Graph" ),
    Description( "A Report from the Scripting Index Example" )
);
content2 = New JMP Live Content(
    gbline,
    Title( "Line Graph" ),
    Description( "A Report from the Scripting Index Example" )
);
jmpliveresult = liveconnection << Publish( {content1, content2}, Folder( folder ) );

bcDataPostID = "";
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Data",
        bcDataPostId = postlist[i] << Get ID
    );
);

content1 = New JMP Live Content(
    gbheat,
    Title( "Heatmap" ),
    Description( "A Report from the Scripting Index Example" )
);
jmpliveresult = liveconnection << Publish(
    content1,
    Folder( Folder ),
    Use Existing Data( {{bc, bcDataPostId}} )
);
postlist = jmpliveresult << As Scriptable();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!n\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

**Example 4**

```


liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Publish Standalone Data Example" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( Data( "$SAMPLE_DATA/Big Class.jmp" ) );
jmpliveresult = liveconnection << Publish( content, Folder( folder ) );
postlist = jmpliveresult << As Scriptable();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!n\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

**Example 5**

```


liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Publish Standalone Data and Maps Example" ),
    If Exists( "use" )
);

folder = jmpliveresult << As Scriptable;

content1 = New JMP Live Content(
    Data( "$SAMPLE_DATA/S4 Temps.jmp" ),
    Title( "S4 Temps Data" ),
    Description( "The data table containing the actual temperature information." )
);
content2 = New JMP Live Content(
    Map( "$SAMPLE_DATA/S4-XY.jmp" ),
    Title( "S4 Coordinate Map File" )
);
content3 = New JMP Live Content(
    Map( "$SAMPLE_DATA/S4-Name.jmp" ),
    Title( "S4 Name Map File" )
);

jmpliveresult = liveconnection << Publish( {content1, content2, content3}, Folder( folder ) );
postlist = jmpliveresult << As Scriptable();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!n\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

### [Replace](#replace)

**Syntax:** liveresult = liveconnection \<< Replace(JMPLiveContent, Report(id | path | JMP Live Report), \<Use Existing Data({{dt_or_name, data_id | data_path | JMP Live Data}})>, \<Update Existing Data({{dt_or_name, data_id | data_path | JMP Live Data}})>, \<Publish New Data({dt_or_name})> )

**Description:** Replaces an existing JMP Live report with another report. The data options are required to specify how to manage the data being provided with the report. "Use Existing Data" instructs the server to use the existing data on JMP Live for the data specified. "Update Existing Data" instructs the server to replace the data on the server with the data provided in the command. "Publish New Data" instructs the server to publish a new data table and use it for the report being replaced. "Publish New Data" is the default data option for all data tables. Any combination of the data options can be specified. Returns a JMP Live Result List object.

**JMP Version Added:** 16

**Example 1**

```

dt = Open( "$SAMPLE_DATA/S4 Temps.jmp" );
tod = dt << Run Script( "by Time of Day" );
therm = dt << Run Script( "by Thermometer" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Replace Example 1" )
);
folder = jmpliveresult << As Scriptable;
folderURL = folder << Get URL;

content = New JMP Live Content( tod );
jmpliveresult = liveconnection << Publish( content, Folder( folder ) );
postlist = jmpliveresult << As Scriptable;

xyPostId = "";
namePostId = "";
tempsPostId = "";
reportId = "";
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    title = postlist[i] << Get Title();
    type = postlist[i] << Get Type();
    If( title == "S4-Name",
        namePostId = postlist[i] << Get ID
    );
    If( title == "S4-XY",
        xyPostId = postlist[i] << Get ID
    );
    If( title == "S4 Temps",
        tempsPostId = postlist[i] << Get ID
    );
    If( type == "Report",
        reportId = postlist[i] << Get ID
    );
);

content = New JMP Live Content( therm );
jmpliveresult = liveconnection << Replace(
    content,
    Report( reportId ),
    Use Existing Data( {{"S4-Name", namePostId}, {"S4-XY", xyPostId}} ),
    Update Existing Data( {{"S4 Temps", tempsPostId}} )
);

Write( "\!n\!nOpen this URL to see results: ", folderURL );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/S4 Temps.jmp" );
tod = dt << Run Script( "by Time of Day" );
therm = dt << Run Script( "by Thermometer" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Replace Example 2" )
);
folder = jmpliveresult << As Scriptable;
folderURL = folder << Get URL;

content = New JMP Live Content( tod );
jmpliveresult = liveconnection << Publish( content, Folder( folder ) );
postlist = jmpliveresult << As Scriptable;

xyPostId = "";
namePostId = "";
reportId = "";
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    title = postlist[i] << Get Title();
    type = postlist[i] << Get Type();
    If( title == "S4-Name",
        namePostId = postlist[i] << Get ID
    );
    If( title == "S4-XY",
        xyPostId = postlist[i] << Get ID
    );
    If( type == "Report",
        reportId = postlist[i] << Get ID
    );
);

content = New JMP Live Content( therm );
jmpliveresult = liveconnection << Replace(
    content,
    Report( reportId ),
    Use Existing Data( {{"S4-Name", namePostId}, {"S4-XY", xyPostId}} ),
    Publish New Data( {"S4 Temps"} )
);

Write( "\!n\!nOpen this URL to see results: ", folderURL );


```

### [Update Data](#update-data)

**Syntax:** jmpliveresult = liveconnection \<< Update Data( Data(id | path | JMP Live Data), dataTable | path | JMPLiveContent )

**Description:** Updates the data table or map for a data post with the content provided. The Data parameter identifies the data on JMP Live to be updated. The second parameter is the content to use for the update. It can be a data table object, a path to a data table, or a JMP Live Content object created from a data table or map.

**JMP Version Added:** 16

**Example 1**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Update Data Example - Using JMP Live Content" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( dist );
jmpliveresult = liveconnection << Publish( content, Folder( folder ) );
postlist = jmpliveresult << As Scriptable;

dataPost = Empty();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    type = postlist[i] << Get Type();
    If( type == "Data",
        dataPost = postlist[i]
    );
);

content = New JMP Live Content( Data( bc ) );
liveresult = liveconnection << Update Data( Data( dataPost ), content );
updatedData = liveresult << As Scriptable;
Write( "\!n\!nUpdated data: ", updatedData );


```

**Example 2**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Update Data Example - Using Data Table" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( dist );
jmpliveresult = liveconnection << Publish( content, Folder( folder ) );
postlist = jmpliveresult << As Scriptable;

dataPost = Empty();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    type = postlist[i] << Get Type();
    If( type == "Data",
        dataPost = postlist[i]
    );
);

liveresult = liveconnection << Update Data( Data( dataPost ), bc );
updatedData = liveresult << As Scriptable;
Write( "\!n\!nUpdated data: ", updatedData );


```

**Example 3**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Update Data Example - Using Path" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( dist );
jmpliveresult = liveconnection << Publish( content, Folder( folder ) );
postlist = jmpliveresult << As Scriptable;

dataPost = Empty();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    type = postlist[i] << Get Type();
    If( type == "Data",
        dataPost = postlist[i]
    );
);

liveresult = liveconnection << Update Data( Data( dataPost ), "$SAMPLE_DATA/Big Class.jmp" );
updatedData = liveresult << As Scriptable;
Write( "\!n\!nUpdated data: ", updatedData );


```

# [JMP Live Content](#jmp-live-content)

## [Associated Constructors](#associated-constructors)

### [JMP Live Content](#jmp-live-content_1)

**Syntax:** obj = New JMP Live Content(jmpreport|Image(path_to_image)|Data(jmpdatatable)|Map(jmpmap), \<Title(...)>, \<Description(...)>, \<Publish Data(0|1)>, \<Enable Warnings(0|1)>, \<Optimization("Interactivity" | "Performance")>

**Description:** Creates interactive content for publishing on JMP Live.

```
The first parameter is required and specifies the data to use for the content. That data can be a report, a data table, a map or an image.

Title and Description are used to customize any type of content that is being published. The remaining parameters are optional and used to customize report content only.

Publish Data indicates whether the data used in the report is published to JMP Live. The data for the report is published by default.

Enable Warnings indicates whether Control Chart Warnings should be enabled for the report. Control Chart Warnings are disabled by default.

Optimization is used to customize the way the report is published to JMP Live. The report is published to enable greater interactivity by default.

```

**Example 1**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Sample Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    dist,
    Title( "Distribution Web Report" ),
    Description( "This report was created with the sample found in the Scripting Index" ),
    Publish Data( 1 ),
    Optimization( "Interactivity" )
);

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 2**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Data Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    Data( "$SAMPLE_DATA/Big Class.jmp" ),
    Title( "Big Class Sample Table" ),
    Description(
        "This data table was published with the sample found in the Scripting Index"
    )
);

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 3**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Map Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( Map( "$SAMPLE_DATA/S4-XY.jmp" ) );

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 4**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Image Content" )
);
folder = jmpliveresult << As Scriptable;

imageContent = New JMP Live Content(
    Image( "$SAMPLE_IMAGES/black rhino footprint.jpg" ),
    Title( "Rhino Footprint" ),
    Description( "An image of a rhino footprint from the Sample Data" )
);

jmpliveresult = liveconnection << Publish( imageContent, Folder( folder ) );


```

# [JMP Live Data](#jmp-live-data)

## [Item Messages](#item-messages)

### [Get Description](#get-description)

**Syntax:** string = jmplivepost \<< Get Description()

**Description:** Gets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" )
);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );


```

### [Get ID](#get-id)

**Syntax:** string = jmplivepost \<< Get ID()

**Description:** Gets the ID for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );


```

### [Get Path](#get-path)

**Syntax:** string = jmplivepost \<< Get Path()

**Description:** Gets the path of this JMP Live Report, Folder or Post as a string.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nPath: ", report << Get Path );


```

### [Get Title](#get-title)

**Syntax:** string = jmplivepost \<< Get Title()

**Description:** Gets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

### [Get Type](#get-type)

**Syntax:** string = jmplivepost \<< Get Type()

**Description:** Get the specific type of Post (Folder, Data or Report)

**JMP Version Added:** 17

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nType: ", report << Get Type );


```

### [Get URL](#get-url)

**Syntax:** string = jmplivepost \<< Get URL()

**Description:** Gets the URL for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nURL: ", report << Get URL );


```

### [Set Description](#set-description)

**Syntax:** success = jmplivepost \<< Set Description("string value")

**Description:** Given a string, sets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );

report << Set Description( "A Much Nicer Description" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDecription: ", report << Get Description );


```

### [Set Title](#set-title)

**Syntax:** success = jmplivepost \<< Set Title("New Title")

**Description:** Sets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns a true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;
// Make sure the report we will create does not already exist.
liveconnection << Delete Report( "~/Reports and Posts - Messages/A New Title" );

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );

report << Set Title( "A New Title" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

# [JMP Live Folder](#jmp-live-folder)

## [Item Messages](#item-messages)

### [Add Reports To Folder](#add-reports-to-folder)

**Syntax:** jmpliveresultlist = folder \<< Add Reports To Folder(JMPLiveContent, \<Use Existing Data({{dt_or_name, id | relative_path | JMP Live Data}})>)

**Description:** The Add Reports To Folder message is deprecated. Use Publish instead.

**JMP Version Added:** 16

### [Create Folder](#create-folder)

**Syntax:** liveresult = folder \<< Create Folder(Title("Title"), \<Description("Description")>, \<If Exists("use" | "fail" | "default")>)

**Description:** Creates a subfolder of this folder on JMP Live. Returns a JMP Live Result, which can be used to obtain the JMP Live Folder object for the new folder. Title is required. Description is optional. If Exists tells JMP Live what to do if the specified folder already exists: "use" means to just return the existing folder, "fail" means to throw an error, and "default" means to create a new folder and make its name unique by adding "(2)", "(3)", etc.

**JMP Version Added:** 19

```

liveconnection = New JMP Live();

existingFolder = (liveconnection << Get Folder( "~" )) << As Scriptable;

newFolder = (existingFolder << Create Folder(
    Title( "Important Reports" ),
    If Exists( "default" )
)) << As Scriptable;

Write( "New folder path: ", newFolder << Get Path );


```

### [Get Children](#get-children)

**Syntax:** jmpliveresultlist = folder \<< Get Children(\<PAGESIZE(10)>)

**Description:** Retrieves the child posts contained in the folder as a JMP Live Result List. An optional pagesize argument can be used to control the number of posts returned.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder - Get Children Example" )
);
folder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
jmpliveresult = folder << Publish( contentlist );

jmpliveresult = folder << Get Children;
children = jmpliveresult << As Scriptable;
For( i = 1, i <= children << Get Number Of Items, i += 1,
    Write( "\!n\!nChild ID: ", children[i] << Get ID );
    Write( "\!nChild Type: ", children[i] << Get Type );
);


```

### [Get Data](#get-data)

**Syntax:** result = jmplivefolder \<< Get Data(id | relative_path)

**Description:** Retrieves a data post from the folder as a JMP Live Result object, which can be used to obtain the JMP Live Data object for that post.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

post = (folder << Get Data( "Big Class" )) << As Scriptable;

Write( "\!n\!nTitle: ", post << Get Title );


```

### [Get Description](#get-description)

**Syntax:** string = jmplivepost \<< Get Description()

**Description:** Gets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" )
);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );


```

### [Get Folder](#get-folder)

**Syntax:** result = jmplivefolder \<< Get Folder(id | relative_path)

**Description:** Retrieves a child folder from the folder as a JMP Live Result object, which can be used to obtain the JMP Live Folder object for that child folder.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
personalFolder = (liveConnection << Get Folder( "~" )) << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( personalFolder ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
subfolder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = subfolder << Publish( content );

folder = (personalFolder << Get Folder( "Reports and Posts - Messages" )) << As Scriptable;

Write( "\!n\!nTitle: ", folder << Get Title );


```

### [Get ID](#get-id)

**Syntax:** string = jmplivepost \<< Get ID()

**Description:** Gets the ID for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );


```

### [Get Number Of Items](#get-number-of-items)

**Syntax:** value = jmplivefolder \<< Get Number Of Items()

**Description:** Gets the number of items in the folder.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder - Get Children Count Example" )
);
folder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
jmpliveresult = folder << Publish( contentlist );

count = folder << Get Number of Items;
Write( "\!n\!nChild Count: ", count );


```

### [Get Path](#get-path)

**Syntax:** string = jmplivepost \<< Get Path()

**Description:** Gets the path of this JMP Live Report, Folder or Post as a string.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nPath: ", report << Get Path );


```

### [Get Post](#get-post)

**Syntax:** result = jmplivefolder \<< Get Post(id | relative_path)

**Description:** Retrieves a post from the folder as a JMP Live Result object, which can be used to obtain the JMP Live Post object for that post.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );
post = (folder << Get Post( "A Very Important Report" )) << As Scriptable;

Write( "\!n\!nTitle: ", post << Get Title );


```

### [Get Report](#get-report)

**Syntax:** result = jmplivepost \<< Get Report(id | relative_path)

**Description:** Retrieves a report post from the folder as a JMP Live Result object, which can be used to obtain the JMP Live Report object for that report.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

post = (folder << Get Report( "A Very Important Report" )) << As Scriptable;

Write( "\!n\!nTitle: ", post << Get Title );


```

### [Get Title](#get-title)

**Syntax:** string = jmplivepost \<< Get Title()

**Description:** Gets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

### [Get Type](#get-type)

**Syntax:** string = jmplivepost \<< Get Type()

**Description:** Get the specific type of Post (Folder, Data or Report)

**JMP Version Added:** 17

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nType: ", report << Get Type );


```

### [Get URL](#get-url)

**Syntax:** string = jmplivepost \<< Get URL()

**Description:** Gets the URL for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nURL: ", report << Get URL );


```

### [Publish](#publish)

**Syntax:** jmpliveresultlist = folder \<< Publish(JMPLiveContent, \<Use Existing Data({{dt_or_name, id | relative_path | JMP Live Data}})>)

**Description:** Publish reports or standalone data to the JMP Live folder. Returns a JMP Live Result List object. Replaces the Add Reports To Folder message. Mixing reports and standalone data in the same Publish command is not allowed. When publishing reports, if the report should use data that is already on JMP Live, the optional Use Existing Data parameter can be used to specify that. The Use Existing Data parameter is not valid when publishing standalone data.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder - Publish Example" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
jmpliveresult = folder << Publish( contentlist );
postlist = jmpliveresult << As Scriptable();
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    Write( "\!n\!nPost[", i, "]", "(ID): ", postlist[i] << Get ID );
    Write( "\!nPost[", i, "]", "(Type): ", postlist[i] << Get Type );
    Write( "\!nPost[", i, "]", "(Title): ", postlist[i] << Get Title );
);


```

### [Replace](#replace)

**Syntax:** liveresult = jmplivefolder \<< Replace(Report(id | relative_path | JMP Live Report), JMPLiveContent, \<Use Existing Data({{dt_or_name, data_id | data_path | JMP Live Data}})>, \<Update Existing Data({{dt_or_name, data_id | data_path | JMP Live Data}})>, \<Publish New Data({dt_or_name})> )

**Description:** Replaces an existing JMP Live report in the folder with another report. The data options are required to specify how to manage the data being provided with the report. "Use Existing Data" instructs the server to use the existing data on JMP Live for the data specified. "Update Existing Data" instructs the server to replace the data on the server with the data provided in the command. "Publish New Data" instructs the server to publish a new data table and use it for the report being replaced. "Publish New Data" is the default data option for all data tables. Any combination of the data options can be specified. Returns a JMP Live Result List object.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
content1 = New JMP Live Content( gblinebar, Title( "Line Bar" ) );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
content2 = New JMP Live Content( gbsmoother, Title( "Smoother" ) );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder - Replace Example" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;
publishList = (folder << Publish( content1 )) << As Scriptable;
publishedReport = publishList[1];

replaceResult = folder << Replace( Report( publishedReport ), content2 );

resultList = replaceResult << As Scriptable();
Write( "\!n\!nUpdated report and data: ", resultList );


```

### [Set Description](#set-description)

**Syntax:** success = jmplivepost \<< Set Description("string value")

**Description:** Given a string, sets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );

report << Set Description( "A Much Nicer Description" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDecription: ", report << Get Description );


```

### [Set Title](#set-title)

**Syntax:** success = jmplivepost \<< Set Title("New Title")

**Description:** Sets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns a true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;
// Make sure the report we will create does not already exist.
liveconnection << Delete Report( "~/Reports and Posts - Messages/A New Title" );

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );

report << Set Title( "A New Title" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

### [Update Data](#update-data)

**Syntax:** result = jmplivefolder \<< Update Data(Data(id | relative_path | JMP Live Data), dataTable | path | JMPLiveContent)

**Description:** Updates the data table or map for a data post in the folder. The Data parameter identifies the data on JMP Live to be updated. The second parameter is the content to use for the update. It can be a data table object, a path to a data table, or a JMP Live Content object created from a data table or map.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
content = New JMP Live Content( gblinebar, Title( "Line Bar" ) );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder - Replace Example" ),
    If Exists( "use" )
);
folder = jmpliveresult << As Scriptable;
publishList = (folder << Publish( content )) << As Scriptable;
publishedData = publishList[2];

bc << Add Rows( 1 );
bc[N Rows(), 0] = {"KEIRA", 16, "F", 62, 112};
bc << Add Rows( 1 );
bc[N Rows(), 0] = {"ORLANDO", 17, "M", 66, 164};

updateResult = folder << Update Data( Data( publishedData ), bc );

updatedData = updateResult << As Scriptable;
Write( "\!n\!nUpdated data: ", updatedData );


```

# [JMP Live Post](#jmp-live-post)

## [Item Messages](#item-messages)

### [Get Description](#get-description)

**Syntax:** string = jmplivepost \<< Get Description()

**Description:** Gets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" )
);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );


```

### [Get ID](#get-id)

**Syntax:** string = jmplivepost \<< Get ID()

**Description:** Gets the ID for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );


```

### [Get Path](#get-path)

**Syntax:** string = jmplivepost \<< Get Path()

**Description:** Gets the path of this JMP Live Report, Folder or Post as a string.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nPath: ", report << Get Path );


```

### [Get Title](#get-title)

**Syntax:** string = jmplivepost \<< Get Title()

**Description:** Gets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

### [Get Type](#get-type)

**Syntax:** string = jmplivepost \<< Get Type()

**Description:** Get the specific type of Post (Folder, Data or Report)

**JMP Version Added:** 17

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nType: ", report << Get Type );


```

### [Get URL](#get-url)

**Syntax:** string = jmplivepost \<< Get URL()

**Description:** Gets the URL for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nURL: ", report << Get URL );


```

### [Set Description](#set-description)

**Syntax:** success = jmplivepost \<< Set Description("string value")

**Description:** Given a string, sets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );

report << Set Description( "A Much Nicer Description" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDecription: ", report << Get Description );


```

### [Set Title](#set-title)

**Syntax:** success = jmplivepost \<< Set Title("New Title")

**Description:** Sets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns a true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;
// Make sure the report we will create does not already exist.
liveconnection << Delete Report( "~/Reports and Posts - Messages/A New Title" );

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );

report << Set Title( "A New Title" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

# [JMP Live Report](#jmp-live-report)

## [Item Messages](#item-messages)

### [Get Description](#get-description)

**Syntax:** string = jmplivepost \<< Get Description()

**Description:** Gets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" )
);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );


```

### [Get ID](#get-id)

**Syntax:** string = jmplivepost \<< Get ID()

**Description:** Gets the ID for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );


```

### [Get Path](#get-path)

**Syntax:** string = jmplivepost \<< Get Path()

**Description:** Gets the path of this JMP Live Report, Folder or Post as a string.

**JMP Version Added:** 19

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nPath: ", report << Get Path );


```

### [Get Title](#get-title)

**Syntax:** string = jmplivepost \<< Get Title()

**Description:** Gets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

### [Get Type](#get-type)

**Syntax:** string = jmplivepost \<< Get Type()

**Description:** Get the specific type of Post (Folder, Data or Report)

**JMP Version Added:** 17

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nType: ", report << Get Type );


```

### [Get URL](#get-url)

**Syntax:** string = jmplivepost \<< Get URL()

**Description:** Gets the URL for this JMP Live Report, JMP Live Folder, or JMP Live Post as a string.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nURL: ", report << Get URL );


```

### [Set Description](#set-description)

**Syntax:** success = jmplivepost \<< Set Description("string value")

**Description:** Given a string, sets the description of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDescription: ", report << Get Description );

report << Set Description( "A Much Nicer Description" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nDecription: ", report << Get Description );


```

### [Set Title](#set-title)

**Syntax:** success = jmplivepost \<< Set Title("New Title")

**Description:** Sets the title of the JMP Live Report, JMP Live Folder, or JMP Live Post. Returns a true or false for success or failure.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );

liveconnection = New JMP Live();
result = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Reports and Posts - Messages" ),
    If Exists( "use" )
);
folder = result << As Scriptable;
// Make sure the report we will create does not already exist.
liveconnection << Delete Report( "~/Reports and Posts - Messages/A New Title" );

content = New JMP Live Content(
    gbsmoother,
    Title( "A Very Important Report" ),
    Description( "The Report That Is Published" ),

);
jmpliveresult = folder << Publish( content );

report = Empty();
postList = jmpliveresult << As Scriptable;
For( i = 1, i <= postlist << Get Number Of Items, i += 1,
    posttype = postlist[i] << Get Type;
    If( posttype == "Report",
        report = postlist[i]
    );
);
Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );

report << Set Title( "A New Title" );
jmpliveresult = liveconnection << Get Report( report << Get ID );
updated = jmpliveresult << As Scriptable;

Write( "\!n\!nID: ", report << Get ID );
Write( "\!nTitle: ", report << Get Title );


```

# [JMP Live Result List](#jmp-live-result-list)

## [Item Messages](#item-messages)

### [As Scriptable](#as-scriptable)

**Syntax:** jmplivereportlist = jmplivelist \<< As Scriptable()

**Description:** Returns a scriptable list of JMP Live Folder, JMP Live Report, or JMP Live Post objects depending on the Find operation that was performed to produce the JMP Live Result List.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "JMP Live Result List Example" )
);
folder = jmpliveresult << As Scriptable;
jmpliveresult = folder << Create Folder( Title( "JMP Live Result List - Graph Builder" ) );
gbfolder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gblinebar, Title( "Graph Builder Line and Bar Charts" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "Graph Builder Line Chart" ) )
);
Insert Into( contentlist, New JMP Live Content( gbheat, Title( "Graph Builder Heatmap" ) ) );
jmpliveresult = gbfolder << Publish( contentlist );
If( jmpliveresult << Succeeded,
    postlist = jmpliveresult << As Scriptable();
    Write( "\!n\!nNew Posts(Count): ", postlist << Get Number Of Items );
);


```

### [Get Current Page Number](#get-current-page-number)

**Syntax:** value = jmplivelist \<< Get Current Page Number()

**Description:** Gets the current page number of items within the list.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
bivariate = bc << Run Script( "Bivariate" );
oneway = bc << Run Script( "Oneway" );
logistic = bc << Run Script( "Logistic" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "JMP Live Result List Example" )
);
folder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Graph Builder" )
);
gbfolder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Normal" )
);
normalfolder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( dist, Title( "SearchString - Distribution" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( bivariate, Title( "SearchString - Bivariate" ) )
);
Insert Into( contentlist, New JMP Live Content( oneway, Title( "SearchString - Oneway" ) ) );
Insert Into(
    contentlist,
    New JMP Live Content( logistic, Title( "SearchString - Logistic" ) )
);
gbfolder << Publish( contentlist );

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
normalfolder << Publish( contentlist );

jmpliveresult = liveconnection << Find Posts( Search( "SearchString" ), PageSize( 4 ) );

liveposts = jmpliveresult << As Scriptable;
count = liveposts << Get Number Of Items;
nextpage = liveposts << Get Page( 1 );
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", nextpage << Get Number Of Items );

    Try(
        nextpage = liveposts << Next;
        count = nextpage << Get Number Of Items;
    ,
        count = 0
    );
);

prevpage = liveposts << Previous;
count = prevpage << Get Number Of Items;
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", prevpage << Get Number Of Items );

    Try(
        prevpage = liveposts << Previous;
        count = prevpage << Get Number Of Items;
    ,
        count = 0
    );
);


```

### [Get Number Of Items](#get-number-of-items)

**Syntax:** value = jmplivelist \<< Get Number Of Items()

**Description:** Get the number of items in this result set.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
bivariate = bc << Run Script( "Bivariate" );
oneway = bc << Run Script( "Oneway" );
logistic = bc << Run Script( "Logistic" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "JMP Live Result List Example" )
);
folder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Graph Builder" )
);
gbfolder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Normal" )
);
normalfolder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( dist, Title( "SearchString - Distribution" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( bivariate, Title( "SearchString - Bivariate" ) )
);
Insert Into( contentlist, New JMP Live Content( oneway, Title( "SearchString - Oneway" ) ) );
Insert Into(
    contentlist,
    New JMP Live Content( logistic, Title( "SearchString - Logistic" ) )
);
gbfolder << Publish( contentlist );

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
normalfolder << Publish( contentlist );

jmpliveresult = liveconnection << Find Posts( Search( "SearchString" ) );
If( jmpliveresult << Succeeded,
    postlist = jmpliveresult << As Scriptable();
    Write( "\!n\!nPosts(Count): ", postlist << Get Number Of Items );
);


```

### [Get Page](#get-page)

**Syntax:** reportlist = jmplivelist \<< Get Page(value)

**Description:** Gets the specific page of JMP Live Folder, JMP Live Report, or JMP Live Post objects within the entire result list of a find operation.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
bivariate = bc << Run Script( "Bivariate" );
oneway = bc << Run Script( "Oneway" );
logistic = bc << Run Script( "Logistic" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "JMP Live Result List Example" )
);
folder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Graph Builder" )
);
gbfolder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Normal" )
);
normalfolder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( dist, Title( "SearchString - Distribution" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( bivariate, Title( "SearchString - Bivariate" ) )
);
Insert Into( contentlist, New JMP Live Content( oneway, Title( "SearchString - Oneway" ) ) );
Insert Into(
    contentlist,
    New JMP Live Content( logistic, Title( "SearchString - Logistic" ) )
);
gbfolder << Publish( contentlist );

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
normalfolder << Publish( contentlist );

jmpliveresult = liveconnection << Find Posts( Search( "SearchString" ), PageSize( 4 ) );

liveposts = jmpliveresult << As Scriptable;
count = liveposts << Get Number Of Items;
nextpage = liveposts << Get Page( 1 );
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", nextpage << Get Number Of Items );

    Try(
        nextpage = liveposts << Next;
        count = nextpage << Get Number Of Items;
    ,
        count = 0
    );
);

prevpage = liveposts << Previous;
count = prevpage << Get Number Of Items;
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", prevpage << Get Number Of Items );

    Try(
        prevpage = liveposts << Previous;
        count = prevpage << Get Number Of Items;
    ,
        count = 0
    );
);


```

### [Next](#next)

**Syntax:** reportlist = jmplivelist \<< Next()

**Description:** Returns the next page of results in a find operation. This list can contain JMP Live Folders, JMP Live Reports, or JMP Live Posts depending on the find operation.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
bivariate = bc << Run Script( "Bivariate" );
oneway = bc << Run Script( "Oneway" );
logistic = bc << Run Script( "Logistic" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "JMP Live Result List Example" )
);
folder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Graph Builder" )
);
gbfolder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Normal" )
);
normalfolder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( dist, Title( "SearchString - Distribution" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( bivariate, Title( "SearchString - Bivariate" ) )
);
Insert Into( contentlist, New JMP Live Content( oneway, Title( "SearchString - Oneway" ) ) );
Insert Into(
    contentlist,
    New JMP Live Content( logistic, Title( "SearchString - Logistic" ) )
);
gbfolder << Publish( contentlist );

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
normalfolder << Publish( contentlist );

jmpliveresult = liveconnection << Find Posts( Search( "SearchString" ), PageSize( 4 ) );

liveposts = jmpliveresult << As Scriptable;
count = liveposts << Get Number Of Items;
nextpage = liveposts << Get Page( 1 );
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", nextpage << Get Number Of Items );

    Try(
        nextpage = liveposts << Next;
        count = nextpage << Get Number Of Items;
    ,
        count = 0
    );
);

prevpage = liveposts << Previous;
count = prevpage << Get Number Of Items;
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", prevpage << Get Number Of Items );

    Try(
        prevpage = liveposts << Previous;
        count = prevpage << Get Number Of Items;
    ,
        count = 0
    );
);


```

### [Previous](#previous)

**Syntax:** reportlist = jmplivelist \<< Previous()

**Description:** Returns the previous page of results in a find operation. This list can contain JMP Live Folders, JMP Live Reports, or JMP Live Posts depending on the find operation.

**JMP Version Added:** 16

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );
bivariate = bc << Run Script( "Bivariate" );
oneway = bc << Run Script( "Oneway" );
logistic = bc << Run Script( "Logistic" );
gblinebar = bc << Run Script( "Graph Builder Line and Bar Charts" );
gbsmoother = bc << Run Script( "Graph Builder Smoother Line" );
gbline = bc << Run Script( "Graph Builder Line Chart" );
gbheat = bc << Run Script( "Graph Builder Heatmap" );

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "JMP Live Result List Example" )
);
folder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Graph Builder" )
);
gbfolder = jmpliveresult << As Scriptable;
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( folder ),
    Title( "JMP Live Result List - Normal" )
);
normalfolder = jmpliveresult << As Scriptable;

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( dist, Title( "SearchString - Distribution" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( bivariate, Title( "SearchString - Bivariate" ) )
);
Insert Into( contentlist, New JMP Live Content( oneway, Title( "SearchString - Oneway" ) ) );
Insert Into(
    contentlist,
    New JMP Live Content( logistic, Title( "SearchString - Logistic" ) )
);
gbfolder << Publish( contentlist );

contentlist = {};
Insert Into(
    contentlist,
    New JMP Live Content( gbsmoother, Title( "SearchString - Graph Builder Smoother Line" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content(
        gblinebar,
        Title( "SearchString - Graph Builder Line and Bar Charts" )
    )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbline, Title( "SearchString - Graph Builder Line Chart" ) )
);
Insert Into(
    contentlist,
    New JMP Live Content( gbheat, Title( "SearchString - Graph Builder Heatmap" ) )
);
normalfolder << Publish( contentlist );

jmpliveresult = liveconnection << Find Posts( Search( "SearchString" ), PageSize( 4 ) );

liveposts = jmpliveresult << As Scriptable;
count = liveposts << Get Number Of Items;
nextpage = liveposts << Get Page( 1 );
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", nextpage << Get Number Of Items );

    Try(
        nextpage = liveposts << Next;
        count = nextpage << Get Number Of Items;
    ,
        count = 0
    );
);

prevpage = liveposts << Previous;
count = prevpage << Get Number Of Items;
While( count > 0,
    Write( "\!n\!nPage: ", liveposts << Get Current Page Number );
    Write( "\!nNumber of Search Results: ", prevpage << Get Number Of Items );

    Try(
        prevpage = liveposts << Previous;
        count = prevpage << Get Number Of Items;
    ,
        count = 0
    );
);


```

# [JMP Live Result](#jmp-live-result)

## [Item Messages](#item-messages)

### [As Scriptable](#as-scriptable)

**Syntax:** jmplivereport = jmpliveresult \<< As Scriptable()

**Description:** Depending on the operation that produced the JMP Live Result, returns a JMP Live Report, JMP Live Folder or JMP Live Post for further scripting operations.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Result Example Folder" ),
    If Exists( "use" )
);
worked = jmpliveresult << Succeeded();
If( worked == 1,
    folder = jmpliveresult << As Scriptable;
    Write( "\!nResponse Type: ", jmpliveresult << Get Response Type );
    Write( "\!nTitle: ", folder << Get Title );
);


```

### [Get Error Message](#get-error-message)

**Syntax:** messagetext = jmpliveresult \<< Get Error Message()

**Description:** Gets any message produced by the last operation as a string.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Get Folder( "THISISNOTAFOLDERID" );

httpstatus = jmpliveresult << Get HTTP Status();
httpmessage = jmpliveresult << Get Error Message();
Write( "\!nHTTP Status Code: ", httpstatus, " Message: ", httpmessage );


```

### [Get HTTP Status](#get-http-status)

**Syntax:** statuscode = jmpliveresult \<< Get HTTP Status()

**Description:** Gets the HTTP status code from the last operation. This is an industry standard integer code.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Get Folder( "THISISNOTAFOLDERID" );

httpstatus = jmpliveresult << Get HTTP Status();
httpmessage = jmpliveresult << Get Error Message();
Write( "\!nHTTP Status Code: ", httpstatus, " Message: ", httpmessage );


```

### [Get JMP Live](#get-jmp-live)

**Syntax:** liveconnection = jmpliveresult \<< Get JMP Live()

**Description:** Retrieves the underlying JMP Live Connection object.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Result Example Folder" ),
    If Exists( "use" )
);
secondliveconnection = jmpliveresult << Get JMP Live();

name = secondliveconnection << Get Connection Name();
Write( "\!nConnection Name: ", name );


```

### [Get Response Type](#get-response-type)

**Syntax:** responsevalue = jmpliveresult \<< Get Response Type()

**Description:** Gets the type of response produced by the last operation as a string.

**JMP Version Added:** 16

```

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Result Example Folder" ),
    If Exists( "use" )
);
worked = jmpliveresult << Succeeded();
If( worked == 1,
    folder = jmpliveresult << As Scriptable;
    Write( "\!nResponse Type: ", jmpliveresult << Get Response Type );
    Write( "\!nTitle: ", folder << Get Title );
);


```

### [Succeeded](#succeeded)

**Syntax:** success = jmpliveresult \<< Succeeded()

**Description:** Returns whether the last action was successful (1) or not (0).

**JMP Version Added:** 16

```

liveconnection = New JMP Live();

jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Result Example Folder" ),
    If Exists( "use" )
);
worked = jmpliveresult << Succeeded();
If( worked == 1,
    folder = jmpliveresult << As Scriptable;
    Write( "\!nResponse Type: ", jmpliveresult << Get Response Type );
    Write( "\!nTitle: ", folder << Get Title );
);


```

# [JMP Live Space](#jmp-live-space)

## [Item Messages](#item-messages)

### [Get Description](#get-description)

**Syntax:** string = jmplivespace \<< Get Description()

**Description:** Gets the description of the JMP Live Space

**JMP Version Added:** 18

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Find Spaces( Search( "~" ) );

spaceList = jmpliveresult << As Scriptable;
space = spaceList[1];

Write( "Description: ", space << Get Description );


```

### [Get Key](#get-key)

**Syntax:** string = jmplivespace \<< Get Key()

**Description:** Gets the space key for the JMP Live Space

**JMP Version Added:** 18

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Find Spaces( Search( "~" ) );

spaceList = jmpliveresult << As Scriptable;
space = spaceList[1];

Write( "Key: ", space << Get Key );


```

### [Get Name](#get-name)

**Syntax:** string = jmplivespace \<< Get Name()

**Description:** Gets the name of the JMP Live Space

**JMP Version Added:** 18

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Find Spaces( Search( "~" ) );

spaceList = jmpliveresult << As Scriptable;
space = spaceList[1];

Write( "Name: ", space << Get Name );


```

### [Get Type](#get-type)

**Syntax:** string = jmplivespace \<< Get Type()

**Description:** Gets the type of the JMP Live Space (Personal or Normal)

**JMP Version Added:** 18

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Find Spaces( Search( "~" ) );

spaceList = jmpliveresult << As Scriptable;
space = spaceList[1];

Write( "Type: ", space << Get Type );


```

# [K Means Cluster](#k-means-cluster)

## [Associated Constructors](#associated-constructors)

### [K Means Cluster](#k-means-cluster_1)

**Syntax:** K Means Cluster( Y( column(s) ), Number of Clusters( number ) )

**Description:** Clusters rows based on numeric variables in data tables with up to millions of rows. You must specify the number of clusters in advance.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = K Means Cluster(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;


```

### [Freq](#freq)

**Syntax:** obj = K Means Cluster(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = K Means Cluster(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Freq( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = Normal Mixtures(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Freq( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

### [Weight](#weight)

**Syntax:** obj = K Means Cluster(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = K Means Cluster(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Weight( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = Normal Mixtures(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Weight( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

### [Y](#y)

**Syntax:** obj = K Means Cluster(...Y( column(s) )...)

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);


```

## [Item Messages](#item-messages)

### [Columns Scaled Individually](#columns-scaled-individually)

**Syntax:** Columns Scaled Individually( state=0|1 )

**Description:** Scales each column independently of the other columns. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Columns Scaled Individually( 1 ),
    Go
);


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Launches the platform by completing the iterations.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

### [Initial Clusters](#initial-clusters)

**Syntax:** obj \<< Initial Clusters( "Default" | "Randomize" | column )

**Description:** Determines how the initial clusters are created. The initial clusters can be randomized or you can specify a categorical column to define the initial clusters, seeding by the means for each category.

**JMP Version Added:** 19

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Initial Clusters( :Species ),
    Go
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Initial Clusters( "Randomize" ),
    Go
);


```

### [Max Iterations](#max-iterations)

**Syntax:** obj \<< Max Iterations( number )

**Description:** Sets the maximum number of iterations.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Max Iterations( 100 );
obj << Go;


```

### [Number of Clusters](#number-of-clusters)

**Syntax:** obj \<< Number of Clusters( number )

**Description:** Changes the number of clusters.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
Wait( 1 );
obj << Number of Clusters( 5 );
obj << Go;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
Wait( 1 );
obj << Number of Clusters( 5 );
obj << Go;


```

### [SOM](#som)

**Syntax:** obj \<< SOM

**Description:** Creates clusters using self-organizing maps. The grid structure used by this method can be used to interpret the clusters in two dimensions.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << SOM;
obj << Go;


```

### [SOM Bandwidth](#som-bandwidth)

**Syntax:** obj \<< SOM Bandwidth( number )

**Description:** Specifies the bandwidth for the self-organizing maps.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << SOM;
obj << SOM Bandwidth( 0.5 );
obj << Go;


```

### [SOM N Rows](#som-n-rows)

**Syntax:** obj \<< SOM N Rows( number )

**Description:** Sets the number of rows for the self-organizing maps.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << SOM( 1 );
obj << SOM N Rows( 3 );
obj << Go;


```

### [Shift distances by rates](#shift-distances-by-rates)

**Syntax:** obj \<< Shift distances by rates( state=0|1 )

**Description:** Gives higher preference to point assignments to larger clusters.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Shift distances by rates( 1 ),
    Go
);


```

### [Single Step](#single-step)

**Syntax:** obj \<< Single Step( state=0|1 )

**Description:** Enables stepping through individual iterations. In the K Means outline, click the Step button for each iteration.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Single Step( 1 );
obj << Go;
obj << Step;
Wait( 1 );
obj << Step;


```

### [Use within cluster std dev](#use-within-cluster-std-dev)

**Syntax:** obj \<< Use within cluster std dev( state=0|1 )

**Description:** Calculates distances scaled by the standard deviation estimated for each cluster.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Use within cluster std dev( 1 ),
    Go
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = K Means Cluster(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [K Means Fit](#k-means-fit)

### [Item Messages](#item-messages_1)

#### [Biplot](#biplot)

**Syntax:** obj \<< Biplot( state=0|1 )

**Description:** Shows or hides a plot of the points and clusters in the first two principal components of the data.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );


```

#### [Biplot 3D](#biplot-3d)

**Syntax:** obj \<< Biplot 3D( state=0|1 )

**Description:** Shows or hides a plot of the points and clusters in the first three principal components of the data.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot 3D( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot 3D( 1 );


```

#### [Biplot Contour Density](#biplot-contour-density)

**Syntax:** obj \<< Biplot Contour Density( density percent )

**Description:** Sets the level for the density contour.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Contour Density( .95 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Contour Density( .95 );


```

#### [Biplot Ray Position](#biplot-ray-position)

**Syntax:** obj \<< Biplot Ray Position( [X, Y, scaling] )

**Description:** Moves the biplot ray display.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Ray Position( [-1, -1, 2] );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Ray Position( [-1, -1, 2] );


```

#### [Get Statistics](#get-statistics)

**Syntax:** obj \<< Get Statistics

**Description:** Returns the mean and standard deviation for each variable within each cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
stats = obj << Get Statistics;
Show( stats );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
stats = obj << Get Statistics;
Show( stats );


```

#### [Mark Clusters](#mark-clusters)

**Syntax:** obj \<< Mark Clusters

**Description:** Sets the markers in the row state for each row in the data table. Each cluster is assigned a different marker. This affects plots across platforms using rowstate markers, including the Biplot in Cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );
obj << Mark Clusters;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );
obj << Mark Clusters;


```

#### [Parallel Coord Plots](#parallel-coord-plots)

**Syntax:** obj \<< Parallel Coord Plots( state=0|1 )

**Description:** Shows or hides a plot for each cluster separately showing connected line segments that represent each row of the data table.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Parallel Coord Plots( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Parallel Coord Plots( 1 );


```

#### [Publish Cluster Formulas](#publish-cluster-formulas)

**Syntax:** obj \<< Publish Cluster Formulas

**Description:** Builds probability formulas and publishes them as a formula column script in Formula Depot.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Publish Cluster Formulas;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Publish Cluster Formulas;


```

#### [SOM Heat Map](#som-heat-map)

**Syntax:** obj \<< SOM Heat Map( state=0|1 )

**Description:** Shows or hides a heat map of the SOM cluster means, colored by one of the Y variables that was used in the clustering.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    {SOM N Rows( 2 ), SOM Bandwidth( 0.5 ), Single Step( 0 ), Number of Clusters( 4 ), SOM,
    Go}
);
obj << SOM Heat Map;


```

#### [Save Cluster Distance](#save-cluster-distance)

**Syntax:** obj \<< Save Cluster Distance

**Description:** Saves a column to the data table that contains the distance to the assigned cluster number.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Cluster Distance;


```

#### [Save Cluster Formula](#save-cluster-formula)

**Syntax:** obj \<< Save Cluster Formula

**Description:** Saves a column to the data table with a formula that determines the most likely cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Cluster Formula;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Cluster Formula;


```

#### [Save Clusters](#save-clusters)

**Syntax:** obj \<< Save Clusters

**Description:** Saves a new column to the data table that contains the most likely cluster for each row.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Clusters;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Clusters;


```

#### [Save Colors to Table](#save-colors-to-table)

**Syntax:** obj \<< Save Colors to Table

**Description:** Saves the color assigned to the row state in each row according to the cluster membership.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Colors to Table;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Colors to Table;


```

#### [Save Distance Formula](#save-distance-formula)

**Syntax:** obj \<< Save Distance Formula

**Description:** Saves a column to the data table that contains the distance formula to the assigned cluster number.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Distance Formula;


```

#### [Save K Cluster Distances](#save-k-cluster-distances)

**Syntax:** obj \<< Save K Cluster Distances

**Description:** Saves the distance to each cluster center as a separate column in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save K Cluster Distances;


```

#### [Save K Distance Formulas](#save-k-distance-formulas)

**Syntax:** obj \<< Save K Distance Formulas

**Description:** Saves the distance formula to each cluster center as a separate column in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save K Distance Formulas;


```

#### [Save SOM Grid](#save-som-grid)

**Syntax:** obj \<< Save SOM Grid

**Description:** Saves new columns to the data table that contain the SOM grid row and column for the most likely cluster.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    {SOM N Rows( 2 ), SOM Bandwidth( 0.5 ), Single Step( 0 ), Number of Clusters( 4 ), SOM,
    Go}
);
obj << Save SOM Grid;


```

#### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** obj \<< Scatterplot Matrix( state=0|1 )

**Description:** Creates a scatterplot matrix in a new window with confidence ellipses based on the current number of clusters.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Scatterplot Matrix;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Scatterplot Matrix;


```

#### [Show Biplot Rays](#show-biplot-rays)

**Syntax:** obj \<< Show Biplot Rays( state=0|1 )

**Description:** Shows or hides the rays on the biplot. On by default.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Show Biplot Rays( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Show Biplot Rays( 1 );


```

#### [Simulate Clusters](#simulate-clusters)

**Syntax:** obj \<< Simulate Clusters

**Description:** Creates a new data table with simulated data using the estimated cluster mixing probabilities, means, and standard deviations for each cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Simulate Clusters( 1000 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Simulate Clusters( 1000 );


```

#### [Step](#step)

**Syntax:** obj \<< Step

**Description:** Takes one K-means step or iteration.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Single Step( 1 );
obj << Go;
obj << Step;
Wait( 1 );
obj << Step;


```

# [K Nearest Neighbors](#k-nearest-neighbors)

## [Associated Constructors](#associated-constructors)

### [K Nearest Neighbors](#k-nearest-neighbors_1)

**Syntax:** K Nearest Neighbors(Y( column ), X( columns ))

**Description:** Predicts a continuous or categorical response based on the responses of the k nearest neighbors in the space of the X variables.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = K Nearest Neighbors(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Factor](#factor)

**Syntax:** obj = K Nearest Neighbors(...Factor( column(s) )...)

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);


```

### [Validation](#validation)

**Syntax:** obj = K Nearest Neighbors(...\<Validation( column )>...)

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);


```

### [X](#x)

**Syntax:** obj = K Nearest Neighbors(...X( column(s) )...)

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);


```

### [Y](#y)

**Syntax:** obj = K Nearest Neighbors(...\<Y( column(s) )>...)

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);


```

## [Item Messages](#item-messages)

### [Category Bias](#category-bias)

**Syntax:** obj = K Nearest Neighbors(...Category Bias( number=0.5 )...)

**Description:** Specifies a tuning parameter that ensures that the fitted probabilities for categorical responses are always positive. "0.5" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = K Nearest Neighbors(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    K( 10 ),
    Category Bias( 0.2 )
);


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Get Measures;


```

### [K](#k)

**Syntax:** obj = K Nearest Neighbors(...K( number=10 )...)

**Description:** Sets the maximum number of nearest neighbors to analyze. "10" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = K Nearest Neighbors(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    K( 8 )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( "<Response Variable Name>", \<Set K( number )>, \<Mosaic Plot ( state=0|1 ) >, \<Plot Actual by Predicted( state=0|1 )>, \<Plot Residual by Predicted( state=0|1 )> )

**Description:** Specifies report options available for the model response. Available options depend on the response type.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 ),
    Response(
        "Y",
        Set K( 6 ),
        Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 )
    )
);


```

### [Save Near Neighbor Distances](#save-near-neighbor-distances)

**Syntax:** obj \<< Save Near Neighbor Distances

**Description:** Saves the distance to the k'th nearest data point.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << Save Near Neighbor Distances;


```

### [Save Near Neighbor Rows](#save-near-neighbor-rows)

**Syntax:** obj \<< Save Near Neighbor Rows

**Description:** Saves the row numbers of the k nearest neighbors.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << Save Near Neighbor Rows;


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = K Nearest Neighbors(...Set Random Seed( number )...)

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = K Nearest Neighbors(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Set Random Seed( 123456 ),
    K( 8 )
);


```

### [Use Excluded Rows for Validation](#use-excluded-rows-for-validation)

**Syntax:** obj \<< Use Excluded Rows for Validation( state=0|1 )

**Description:** Uses the excluded rows in the data table to create a validation set. This option appears in the launch window only if you are using standard JMP and there are excluded rows.

**JMP Version Added:** 15

### [Validation Portion](#validation-portion)

**Syntax:** obj = K Nearest Neighbors(...Validation Portion( fraction=0 )...)

**Description:** Forms a validation set by randomly selecting rows with each row having probability p (fraction) of being selected. "0" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = K Nearest Neighbors(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 ),
    K( 10 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Nearest Neighbors(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    K( 10 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = K Nearest Neighbors(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [KNN Fit](#knn-fit)

### [Item Messages](#item-messages_1)

#### [Apply Preset](#apply-preset_1)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Plot Actual by Predicted( 1 ));
obj << (Response[1] << Plot Residual by Predicted( 1 ));
preset = obj << (Response[1] << New Preset);
obj2 = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 5 )
);
Wait( 1 );
obj2 << (Response[1] << Apply Preset( preset ));


```

#### [Get Best K](#get-best-k)

**Syntax:** obj \<< (Response[number] \<< Get Best K)

**Description:** Returns the value of the best K neighbors.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Get Best K);


```

#### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< (Response[number] \<< Get Prediction Formula( k ))

**Description:** Constructs a script to create a prediction formula column and returns it.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Get Prediction Formula( 9 ));


```

#### [Mosaic Plot](#mosaic-plot)

**Syntax:** obj \<< Mosaic Plot( state=0|1 )

**Description:** Displays or hides a mosaic plot of the data. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Mosaic Plot( 0 ));


```

#### [New Preset](#new-preset_1)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Plot Actual by Predicted( 1 ));
obj << (Response[1] << Plot Residual by Predicted( 1 ));
preset = obj << (Response[1] << New Preset);


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< (Response[number] \<< Plot Actual By Predicted( state=0|1 ))

**Description:** Shows or hides a plot with the actual response values on the vertical axis and the predicted values on the horizontal axis. In good fits, points are near the diagonal. You can see which points are far from the diagonal, look for patterns, and visualize the test.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Plot Actual by Predicted( 1 ));


```

#### [Plot Residual by Predicted](#plot-residual-by-predicted)

**Syntax:** obj \<< ( Response[number] \<< Plot Residual By Predicted( state=0|1 ) )

**Description:** Plots the residuals on the Y axis and the predicted values on the X axis. Use the scatterplot to detect patterns in the fit or in the variation.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Plot Residual by Predicted( 1 ));


```

#### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< (Response[number] \<< Publish Prediction Formula( k ))

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Publish Prediction Formula( 9 ));


```

#### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< (Response[number] \<< Save Predicteds)

**Description:** Saves the predicted values in a new column in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Save Predicteds);


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< (Response[number] \<< Save Prediction Formula( k ))

**Description:** Saves the prediction formula in a new column in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 )
);
obj << (Response[1] << Save Prediction Formula( 9 ));


```

#### [Set K](#set-k)

**Syntax:** obj \<< ( Response[number] \<< Set K( number ) )

**Description:** Changes the specified model to a different model in the solution path.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = K Nearest Neighbors(
    Y( :Y ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation ),
    K( 10 ),
    Plot Actual by Predicted( 1 )
);
Wait( 3 );
obj << (Response[1] << Set K( 6 ));


```

# [Latent Class Analysis](#latent-class-analysis)

## [Associated Constructors](#associated-constructors)

### [Latent Class Analysis](#latent-class-analysis_1)

**Syntax:** Latent Class Analysis( Y( column(s) ), Number of Clusters( number ) )

**Description:** Clusters rows based on categorical variables using multinomial mixtures. You must specify the number of latent classes (clusters) in advance.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Latent Class Analysis(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Latent Class Analysis(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Freq( :age ),
    Number of Clusters( 3 )
);


```

### [ID](#id)

**Syntax:** obj = Latent Class Analysis(...\<ID( column )>...)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :marital status, :country, :size, :type ),
    ID( :sex ),
    Number of Clusters( 3 )
);


```

### [Weight](#weight)

**Syntax:** obj = Latent Class Analysis(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Weight( :age ),
    Number of Clusters( 3 )
);


```

### [Y](#y)

**Syntax:** obj = Latent Class Analysis(...Y( column(s) )...)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);


```

## [Item Messages](#item-messages)

### [New Number of Clusters](#new-number-of-clusters)

**Syntax:** obj \<< New Number of Clusters( number )

**Description:** Enables you to run another analysis using a different number of clusters.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 2 );
obj << New Number of Clusters( 4 );


```

### [Number of Clusters](#number-of-clusters)

**Syntax:** obj = Latent Class Analysis(...Number of Clusters( number=3 )...)

**Description:** Specifies the number of latent classes. "3" by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 4 )
);
Wait( 1 );


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number )

**Description:** Specifies a random seed to reproduce the results for future launches of the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Set Random Seed( 123456 ),
    Number of Clusters( 3 )
);


```

### [Up to](#up-to)

**Syntax:** obj = Latent Class Analysis(...Up to( number )...)

**Description:** Specifies a maximum number of clusters. If this number exceeds the specified number of clusters, a latent class analysis is produced for each integer value in the range.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    Up To( 6 )
);
Wait( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Latent Class Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [LCA Fit](#lca-fit)

### [Item Messages](#item-messages_1)

#### [Color by Cluster](#color-by-cluster)

**Syntax:** obj\<<(Fit[number] \<< Color By Cluster)

**Description:** Colors the rows in the data table according to their most probable clusters.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 1 );
obj << (Fit[1] << Color By Cluster);


```

#### [Effect Sizes](#effect-sizes)

**Syntax:** obj \<< ( fit[number] \<< Effect Sizes( state=0|1 ) )

**Description:** Shows or hides the table of effect sizes. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 1 );
obj << (fit[1] << Effect Sizes( 0 ));


```

#### [Get Probability Formulas](#get-probability-formulas)

**Syntax:** obj \<< (Fit[number] \<< Get Probability Formulas)

**Description:** Returns a script to create probability formulas.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << (Fit[1] << Get Probability Formulas);


```

#### [MDS Plot](#mds-plot)

**Syntax:** obj \<< ( fit[number] \<< MDS Plot( state=0|1 ) )

**Description:** Shows or hides the MDS plot, which is a two-dimensional representation of cluster proximity. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 1 );
obj << (fit[1] << MDS Plot( 0 ));


```

#### [Mixture Probabilities](#mixture-probabilities)

**Syntax:** obj \<< ( fit[number] \<< Mixture Probabilities( state=0|1 ) )

**Description:** Shows or hides the table of mixture probabilities.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 1 );
obj << (fit[1] << Mixture Probabilities( 1 ));


```

#### [Model Summary](#model-summary)

**Syntax:** obj \<< ( fit[number] \<< Model Summary( state=0|1 ) )

**Description:** Shows or hides a model summary table that contains the negative log-likelihood, number of parameters, BIC, and AIC values. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 1 );
obj << (fit[1] << Model Summary( 0 ));


```

#### [Parameter Estimates](#parameter-estimates)

**Syntax:** obj \<< ( fit[number] \<< Parameter Estimates( state=0|1 ) )

**Description:** Shows or hides the parameter estimates report that contains tabular and graphical summaries of the parameter estimates. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 1 );
obj << (fit[1] << Parameter Estimates( 0 ));


```

#### [Publish Probability Formulas](#publish-probability-formulas)

**Syntax:** obj \<< (Fit[number] \<< Publish Probability Formulas)

**Description:** Builds probability formulas and publishes them as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << (Fit[1] << Publish Probability Formulas);


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (Fit[number] \<< Remove Fit)

**Description:** Removes the specified fit from the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 2 );
obj << (Fit[1] << Remove Fit);


```

#### [Rename Clusters](#rename-clusters)

**Syntax:** obj \<< (Fit[number]\<<Rename Clusters( {argument list} )

**Description:** Enables you to give meaningful names to the clusters in the report. If no argument list is specified, you are prompted to provide cluster names.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << (Fit[1] << Rename Clusters( {"New Cluster 1", "New Cluster 2", "New Cluster 3"} ));


```

#### [Save Cluster Formula Only](#save-cluster-formula-only)

**Syntax:** obj \<< (Fit[number] \<< Save Cluster Formula Only)

**Description:** Saves a column to the data table with a formula that determines the most likely cluster.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << (Fit[1] << Save Cluster Formula Only);


```

#### [Save Cluster Only](#save-cluster-only)

**Syntax:** obj \<< (Fit[number] \<< Save Cluster Only)

**Description:** Saves a column to the data table that contains the most likely cluster for each row.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << (Fit[1] << Save Cluster Only);


```

#### [Save Mixture Probabilities](#save-mixture-probabilities)

**Syntax:** obj \<< (Fit[number] \<< Save Mixture Probabilities)

**Description:** Saves the probability of membership to each cluster as a separate column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << (Fit[1] << Save Mixture Probabilities);


```

#### [Save Mixture and Cluster Formulas](#save-mixture-and-cluster-formulas)

**Syntax:** obj \<< (Fit[number] \<< Save Mixture and Cluster Formulas)

**Description:** Saves the mixture probability formula to each cluster as a separate column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
obj << (Fit[1] << Save Mixture and Cluster Formulas);


```

#### [Transposed Parameter Estimates](#transposed-parameter-estimates)

**Syntax:** obj \<< ( fit[number] \<< Transposed Parameter Estimates( state=0|1 ) )

**Description:** Shows or hides the transposed table of parameter estimates.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Latent Class Analysis(
    Y( :sex, :marital status, :country, :size, :type ),
    Number of Clusters( 3 )
);
Wait( 1 );
obj << (fit[1] << Transposed Parameter Estimates( 1 ));


```

# [Legend Item](#legend-item)

## [Item Messages](#item-messages)

### [Get Label](#get-label)

**Syntax:** obj \<< Get Label

**Description:** Returns the label of the legend item.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 2, 1 );
Print( item << Get Label );


```

### [Get Position](#get-position)

**Syntax:** obj \<< Get Position

**Description:** Returns the sequential position of an item in the legend, or a negative code if it is not displayed. Codes: -1 = Hidden by User, -2 = Hidden by If Display, -3 = Hidden By Dependency, -4 = Hidden By Initial Setting

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 2, 1 );
Print( item << Get Position );


```

### [Get Type](#get-type)

**Syntax:** obj \<< Get Type

**Description:** Returns the type of the legend item. Types are: "None", "Marker", "H Line", "V Line", "Step", "Bar", "V Box Plot", "H Interval", "V Interval", "H Bar Box Plot", "V Bar Box Plot", "OHLC Plot", "H Box Plot",Gradient", "Density Gradient", "Fill and Line", "Marker Size", "Line Size", Gradient Line", "Gradient Contour", "Mark Color", "Marker Size Categorical", "Cell Size".

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 2, 1 );
Print( item << Get Type );


```

### [Set Label](#set-label)

**Syntax:** obj \<< Set Label( text )

**Description:** Sets the label of an item in the legend.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 2, 1 );
item << Set Label( "Label Set Through Script" );


```

### [Set Visible](#set-visible)

**Syntax:** obj \<< Set Visible( state=0|1 )

**Description:** Sets the visibility of an item in the legend.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 2, 1 );
item << Set Visible( 0 );


```

# [Legend Model](#legend-model)

## [Item Messages](#item-messages)

### [Get Fill Color](#get-fill-color)

**Syntax:** obj \<< Get Fill Color

**Description:** Returns the fill color of the Legend Model Item which is linked to a Display Seg in the graph.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Ellipse( X, Y, Legend( 3 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 3, 1 );
Show( item << Get Fill Color );


```

### [Get Gradient Settings](#get-gradient-settings)

**Syntax:** obj \<< Get Gradient Settings

**Description:** Returns a list of Gradient Settings for the Legend Model Item which is linked to a Display Seg in the graph.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Color( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 1, 1 );
Print( item << Get Gradient Settings );


```

### [Get Label](#get-label)

**Syntax:** obj \<< Get Label

**Description:** Returns the label of the Legend Model Item.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 2, 1 );
Print( item << Get Label );


```

### [Get Marker Size Settings](#get-marker-size-settings)

**Syntax:** obj \<< Get Marker Size Settings

**Description:** Returns a list of Marker Size Settings for the Legend Model Item which is linked to a Display Seg in the graph.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Size( :height ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 1, 1 );
Print( item << Get Marker Size Settings );


```

### [Get Pen Settings](#get-pen-settings)

**Syntax:** obj \<< Get Pen Settings

**Description:** Returns a list of Pen Settings for the Legend Model Item which is linked to a Display Seg in the graph.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 1, 7 );
Print( item << Get Pen Settings );


```

### [Get Type](#get-type)

**Syntax:** obj \<< Get Type

**Description:** Returns the type of the Legend Model Item. Types are: "None", "Marker", "H Line", "V Line", "Step", "Bar", "V Box Plot", "H Interval", "V Interval", "H Bar Box Plot", "V Bar Box Plot", "OHLC Plot", "H Box Plot",Gradient", "Density Gradient", "Fill and Line", "Marker Size", "Line Size", Gradient Line", "Gradient Contour", "Mark Color", "Marker Size Categorical", "Cell Size".

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 2, 1 );
Print( item << Get Type );


```

### [Set Label](#set-label)

**Syntax:** obj \<< Set Label( text )

**Description:** Sets the label for the Legend Model Item which is linked to a Display Seg in the graph.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
server = gb << Get Legend Server;
items = server << Get Legend Items;
For Each( {item, index}, items[1], item << Set Label( "Item " || Char( index ) ) );


```

### [Set Properties](#set-properties)

**Syntax:** obj \<< Set Properties

**Description:** Set arbitrary display properties for the Legend Model Item which is linked to a Display Seg in the graph.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Size( :height ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 1, 1 );
item << Set Properties(
    {Marker Size( 5 ), Marker Scale( {Marker Size Minimum( "Dot" ), Style( "Nested Full" )} )
    }
);


```

# [Life Distribution and Extensions](#life-distribution-and-extensions)

## [Compare Groups](#compare-groups)

### [Columns](#columns)

#### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

#### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

#### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column(s) )

#### [Label](#label)

**Syntax:** obj \<< Label( column )

#### [Time to Event](#time-to-event)

**Syntax:** obj \<< Time to Event( column(s) )

#### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

### [Item Messages](#item-messages)

#### [Change Confidence Level](#change-confidence-level)

**Syntax:** obj \<< Change Confidence Level( fraction )

**Description:** Specifies the confidence level for the entire platform. All plots and reports update accordingly.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Select Distribution( Distribution, Exponential )
);
obj << Change Confidence Level( 0.99 );


```

#### [Default Parametric Distribution](#default-parametric-distribution)

**Syntax:** obj \<< Default Parametric Distribution( "Lognormal"|"Weibull"|"Loglogistic"|"Frechet"|"Normal"|"SEV"|"Logistic"|"LEV"|"Exponential"|"LogGenGamma"|"GenGamma"|"TH Weibull"|"TH Lognormal"|"TH Frechet"|"TH Loglogistic"|"ZI Weibull"|"ZI Lognormal"|"ZI Frechet"|"ZI Loglogistic"|"DS Weibull"|"DS Lognormal"|"DS Frechet"|"DS Loglogistic" )

#### [Estimate Probability](#estimate-probability)

**Syntax:** obj \<< Estimate Probability( state=\<0|1> | \<Compute( array )> )

**Description:** Shows or hides an Estimate Probability report that corresponds to the most recently selected distribution in the Compare Distribution report. Use the Compute argument to specify an array of time values for the probability estimation.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Select Distribution( Distribution, Exponential )
);
obj << Estimate Probability( 1 );
obj << Estimate Probability( Compute( [1000] ) );


```

#### [Estimate Quantile](#estimate-quantile)

**Syntax:** obj \<< Estimate Quantile( state=\<0|1> | \<Compute( array )> )

**Description:** Shows or hides an Estimate Quantile report that corresponds to the most recently selected distribution in the Compare Quantile report. Use the Compute argument to specify an array of probability values for the quantile estimation.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Show Quantile Functions( 1 )
);
obj << Select Distribution( Quantile, Exponential );
obj << Estimate Quantile( 1 );
obj << Estimate Quantile( Compute( [.1] ) );


```

#### [Fit Distribution](#fit-distribution)

**Syntax:** obj \<< Fit Distribution( distribution )

**Description:** Fits the specified distribution.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor )
);
obj << Fit Distribution( "Loglogistic" );


```

#### [Interval Type](#interval-type)

**Syntax:** obj \<< Interval Type( "Simultaneous"|"Pointwise" )

**Description:** Specifies the type of confidence interval shown for the Nonparametric fit in the Compare Distributions plot. The available options are pointwise or simultaneous confidence intervals.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor )
);
Wait( 1 );
obj << Interval Type( "Pointwise" );


```

#### [Select Distribution](#select-distribution)

**Syntax:** obj \<< Select Distribution( Distribution|Quantile|Hazard|Density, distribution )

**Description:** Specifies a distribution to show for each group on the specified graph. This is equivalent to selecting a distribution option in the Compare Distribution, Compare Quantile, Compare Hazard, or Compare Density reports.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor )
);
obj << Select Distribution( Distribution, Weibull );


```

#### [Select Scale](#select-scale)

**Syntax:** obj \<< Select Scale( distribution )

**Description:** Specifies a scale for the probability axis in the Compare Distribution plot. This is equivalent to selecting an option under Scale in the Compare Distribution report.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor )
);
obj << Select Scale( Normal );


```

#### [Show Confidence Area](#show-confidence-area)

**Syntax:** obj \<< Show Confidence Area( state=0|1 )

**Description:** Shows or hides the shaded confidence regions in the plots. On by default.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Select Distribution( Distribution, Exponential )
);
Wait( 1 );
obj << Show Confidence Area( 0 );


```

#### [Show Density Functions](#show-density-functions)

**Syntax:** obj \<< Show Density Functions( state=0|1 )

**Description:** Shows or hides the Compare Density report, which overlays plots of the density functions for each group for the selected distribution.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Show Density Functions( 1 )
);
obj << Select Distribution( Density, Weibull );


```

#### [Show Hazard Functions](#show-hazard-functions)

**Syntax:** obj \<< Show Hazard Functions( state=0|1 )

**Description:** Shows or hides the Compare Hazard report, which overlays plots of the hazard functions for each group for the selected distribution.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Show Hazard Functions( 1 )
);
obj << Select Distribution( Hazard, Weibull );


```

#### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides data points in the probability plot. The Life Distribution platform uses the midpoint estimates of the step function to construct probability plots. When you deselect the Show Points option, the midpoint estimates are replaced by Kaplan-Meier estimates. On by default.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor )
);
Wait( 1 );
obj << Show Points( 0 );


```

#### [Show Quantile Functions](#show-quantile-functions)

**Syntax:** obj \<< Show Quantile Functions( state=0|1 )

**Description:** Shows or hides the Compare Quantile report, which overlays plots of the quantile functions for each group for the selected distribution.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Show Quantile Functions( 1 )
);
obj << Select Distribution( Quantile, Weibull );


```

#### [Show Survival Curve](#show-survival-curve)

**Syntax:** obj \<< Show Survival Curve( state=0|1 )

**Description:** Switches between the failure probability and the survival curve on the Compare Distribution probability plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Show Survival Curve( 1 )
);


```

#### [Tabbed Report](#tabbed-report)

**Syntax:** obj \<< Tabbed Report( state=0|1 )

**Description:** Shows graphs and data in individual tabs rather than in the default outline style.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Life Distribution(
    Perspective( Compare Groups ),
    Y( :days ),
    Grouping( :Group ),
    Censor( :Censor ),
    Tabbed Report( 1 )
);


```

### [Shared Item Messages](#shared-item-messages)

#### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

obj << Copy Script;


```

#### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

obj << Title( "My Platform" );


```

#### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view)

**Syntax:** obj = Y(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Competing Cause > Mean Remaining Life](#competing-cause-mean-remaining-life)

### [Item Messages](#item-messages_1)

#### [Compute](#compute)

**Syntax:** obj \<< Mean Remaining Life( Compute( array ) )

**Description:** Specifies an array of time values to be added to the Mean Remaining Life Calculator.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Mean Remaining Life( Configuration( 1, 100, 1000, 333 ), Compute( [1000 2000] ) );


```

#### [Configuration](#configuration)

**Syntax:** obj \<< Mean Remaining Life( Configuration( useBootstrap, BootstrapSize, SampleSize, RandomSeed ) )

**Description:** Specifies the settings for the Mean Remaining Life Calculator, which estimates the mean remaining life of a unit at a set of given survival times. The arguments specify if a bootstrap should be used, the number of bootstrap aggregated distributions, the number of simulated failure times, and a random seed. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Mean Remaining Life( Configuration( 1, 100, 1000, 333 ), Compute( [1000 2000] ) );


```

#### [Get Results](#get-results)

**Syntax:** obj \<< Mean Remaining Life( Get Results )

**Description:** Returns a matrix of the table in the Mean Remaining Life Calculator.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Mean Remaining Life( Configuration( 1, 100, 1000, 333 ), Compute( [1000 2000] ) );
obj << Mean Remaining Life( Get Results );


```

## [Competing Cause](#competing-cause)

### [Columns](#columns_1)

#### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

#### [Censor](#censor_1)

**Syntax:** obj \<< Censor( column )

#### [Failure Cause](#failure-cause)

**Syntax:** obj \<< Failure Cause( column )

#### [Freq](#freq_1)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

#### [Label](#label_1)

**Syntax:** obj \<< Label( column )

#### [Time to Event](#time-to-event_1)

**Syntax:** obj \<< Time to Event( column(s) )

#### [Y](#y_1)

**Syntax:** obj \<< Y( column(s) )

### [Item Messages](#item-messages_2)

#### [Bootstrap Sample Size](#bootstrap-sample-size)

**Syntax:** obj \<< Bootstrap Sample Size( n )

**Description:** Specifies the number of samples to be used in the bootstrap method that is used to obtain Bayesian estimates or Weibayes results. For Bayesian and Weibayes methods, the confidence limits for the aggregated functions that appear in the Distribution Profiler must be simulated using a parametric bootstrap.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull ),
    Allow failure mode to use Bayesian models( 1 ),
    Fit Model(
        {{"0", Bayesian Lognormal, 0}, {"1", Weibull, 1}, {"10", Weibull, 0}, {"15", Weibull,
        0}, {"2", Weibull, 0}, {"5", Weibull, 0}, {"6", Weibull, 0}, {"9", Weibull, 0}}
    )
);
obj << Bootstrap Sample Size( 1000 );


```

#### [Compute Remaining Life Distribution](#compute-remaining-life-distribution)

**Syntax:** obj \<< Compute Remaining Life Distribution( time0, time1 )

**Description:** Returns a list that contains the remaining life distribution value at time1, given that the unit survived through time0. The list also contains lower and upper limits for the remaining life estimate.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Show Remaining Life Distribution( 1 );
p = obj << Compute Remaining Life Distribution( 2000, 4000 );


```

#### [Density](#density)

**Syntax:** obj \<< Density( t )

**Description:** Returns the density value at the specified time.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
d = obj << Density( .5 );


```

#### [Export Bootstrap Results](#export-bootstrap-results)

**Syntax:** obj \<< Export Bootstrap Results( time )

**Description:** Saves the bootstrap results to a new data table. A bootstrap method is used to obtain Bayesian estimates or Weibayes results. For Bayesian and Weibayes methods, the confidence limits for the aggregated functions that appear in the Distribution Profiler must be simulated using a parametric bootstrap.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull ),
    Allow failure mode to use Bayesian models( 1 ),
    Fit Model(
        {{"0", Bayesian Lognormal, 0}, {"1", Weibull, 1}, {"10", Weibull, 0}, {"15", Weibull,
        0}, {"2", Weibull, 0}, {"5", Weibull, 0}, {"6", Weibull, 0}, {"9", Weibull, 0}}
    )
);
obj << Export Bootstrap Results( 15000 );


```

#### [Export Lifetime Data for Individual Causes](#export-lifetime-data-for-individual-causes)

**Syntax:** obj \<< Export Lifetime Data for Individual Causes

**Description:** Export a stacked data set that consists of lifetime data for individual causes. A lifetime data for a cause is a copy of the original data while right censoring all observations other than the cause.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull ),
    Allow failure mode to use Bayesian models( 1 )
);
dt = obj << Export Lifetime Data for Individual Causes();


```

#### [Fit Model](#fit-model)

**Syntax:** obj \<< Fit Model( specification )

**Description:** Fits a competing cause model using the given specification. The model is specified by a list of 3-item lists for each cause. Each sublist consists of a cause code, a distribution, and an indicator to omit the cause or not.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Fit Model(
    {{"0", Weibull, 1}, {"10", Weibull, 0}, {"15", Weibull, 0}, {"2", Weibull, 0}, {"5",
    Weibull, 0}, {"6", Weibull, 0}, {"9", Weibull, 0}}
);


```

#### [Get Causes](#get-causes)

**Syntax:** obj \<< Get Causes

**Description:** Returns a list of the cause codes.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
lst = obj << Get Causes;


```

#### [Get Estimates](#get-estimates)

**Syntax:** obj \<< Get Estimates

**Description:** Returns a list that contains the causes, counts, distributions, and parameter estimates for the competing cause model.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
res = obj << Get Estimates;


```

#### [Get Life Distribution](#get-life-distribution)

**Syntax:** obj \<< Get Life Distribution( i )

**Description:** Returns a reference to the specified Life Distribution report object in the Individual Causes section of the Competing Cause report. For the argument to this option, the Life Distribution reports are indexed from 0 to n-1, where n is the number of causes.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
ld = (obj << Get Life Distribution( 1 ));


```

#### [Get Model Specification](#get-model-specification)

**Syntax:** obj \<< Get Model Specification

**Description:** Returns a list that contains the specifications for the competing cause model. This list can be used as the argument for the Fit Model message for the Competing Cause platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
spec = obj << Get Model Specification;


```

#### [Hazard](#hazard)

**Syntax:** obj \<< Hazard( t )

**Description:** Returns the value of the hazard function at the specified time.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
h = obj << Hazard( 2500 );


```

#### [Mean Remaining Life](#mean-remaining-life)

**Syntax:** obj \<< Mean Remaining Life( state=0|1 ) obj \<< Mean Remaining Life( Configuration(), Compute(), Get Results )

**Description:** Shows or hides the Mean Remaining Life Calculator, which enables you to estimate the mean remaining life of a unit at a given survival time. You can also use this option to send messages to the Mean Remaining Life calculator object.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Mean Remaining Life( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Mean Remaining Life( Configuration( 1, 100, 1000, 333 ), Compute( [1000 2000] ) );


```

#### [Omit](#omit)

**Syntax:** obj \<< Omit( k, 0|1 )

**Description:** Shows or hides the specified cause from the Cause Combination plot. The first argument specifies the number of the cause. If the second argument is 1, the specified cause is removed; if the second argument is 0, the specified cause is included.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
Wait( 1 );
obj << Omit( 1, 1 );


```

#### [Probability](#probability)

**Syntax:** obj \<< Probability( t )

**Description:** Returns the failure probability at the specified time.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
p = obj << Probability( 2500 );


```

#### [Quantile](#quantile)

**Syntax:** obj \<< Quantile( p )

**Description:** Returns the quantile value at the specified probability.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
q = obj << Quantile( .5 );


```

#### [Set Scale](#set-scale)

**Syntax:** obj \<< Set Scale( name )

**Description:** Specifies the probability scale for the vertical axis of the Cause Combination plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
Wait( 1 );
obj << Set Scale( Weibull );


```

#### [Show Points](#show-points_1)

**Syntax:** obj \<< Show Points( \<0|1> )

**Description:** Shows or hides data points in the Cause Combination plot. The Life Distribution platform uses the midpoint estimates of the step function to construct probability plots. When you deselect the Show Points option, the midpoint estimates are replaced by Kaplan-Meier estimates. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
Wait( 1 );
obj << Show Points( 0 );


```

#### [Show Remaining Life Distribution](#show-remaining-life-distribution)

**Syntax:** obj \<< Show Remaining Life Distribution( state=0|1 )

**Description:** Shows or hides the profiler of the remaining life distribution, which is conditional upon the unit surviving through a given time.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Show Remaining Life Distribution( 1 );


```

#### [Show Subdistributions](#show-subdistributions)

**Syntax:** obj \<< Show Subdistributions( state=0|1 )

**Description:** Shows or hides the profiler for each individual cause subdistribution. When you select the Show Subdistributions option, the Cause Combination plot updates to show the subdistribution functions for all causes.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Show Subdistributions( 1 );


```

#### [Subdistribution](#subdistribution)

**Syntax:** obj \<< Subdistribution( Cause(i), Compute(m) )

**Description:** Specifies the cause and time values for the subdistribution calculations. The Cause argument specifies the number of the cause. The Compute argument is a column vector of time values. The Show Subdistributions option must be selected before using this message.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull )
);
obj << Show Subdistributions( 1 );
obj << Subdistribution( Cause( 2 ), Compute( [5000, 10000] ) );


```

#### [Tabbed Report](#tabbed-report_1)

**Syntax:** obj \<< Tabbed Report( state=0|1 )

**Description:** Organizes the sections of the Competing Cause report into tabs.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull ),
    Tabbed Report( 1 )
);


```

#### [Tabbed Report for Individual Causes](#tabbed-report-for-individual-causes)

**Syntax:** obj \<< Tabbed Report for Individual Causes( state=0|1 )

**Description:** Organizes the Life Distribution reports in the Individual Causes section of the Competing Cause report into tabs.

```

dt = Open( "$SAMPLE_DATA/Reliability/Appliance.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause( Weibull ),
    Tabbed Report for Individual Causes( 1 )
);


```

### [Shared Item Messages](#shared-item-messages_1)

#### [Action](#action_1)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_1)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_1)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_1)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_1)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_1)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_1)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

obj << Copy Script;


```

#### [Data Table Window](#data-table-window_1)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_1)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_1)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_1)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_1)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_1)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_1)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_1)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_1)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_1)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_1)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_1)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_1)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_1)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_1)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_1)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_1)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_1)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_1)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_1)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_1)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_1)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_1)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_1)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_1)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_1)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_1)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_1)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_1)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_1)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_1)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_1)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_1)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_1)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_1)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

obj << Title( "My Platform" );


```

#### [Top Report](#top-report_1)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_1)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_1)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_1)

**Syntax:** obj = Y(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Life Distribution](#life-distribution)

### [Associated Constructors](#associated-constructors)

#### [Life Distribution](#life-distribution_1)

**Syntax:** Life Distribution( Y( column(s) ) )

**Description:** Analyzes the distribution of time-to-event data. Can be used for modeling censored data, product lifetime, reliability, and competing causes.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );


```

### [Columns](#columns_2)

#### [By](#by_1)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

#### [Censor](#censor_2)

**Syntax:** obj \<< Censor( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );


```

#### [Failure Cause](#failure-cause_1)

**Syntax:** obj \<< Failure Cause( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );


```

#### [Freq](#freq_2)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Freq( :_freqcol ) );


```

#### [Label](#label_2)

**Syntax:** obj \<< Label( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );


```

#### [Time to Event](#time-to-event_2)

**Syntax:** obj \<< Time to Event( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );


```

#### [Y](#y_2)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );


```

### [Item Messages](#item-messages_3)

#### [Censor Code](#censor-code)

**Syntax:** obj = Life Distribution(... Censor Code( value ) )

**Description:** Identifies the value in the Censor column that designates right-censored observations. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Life Distribution(
    Y( :Hours ),
    Censor( :Status ),
    Freq( :Weight ),
    Censor Code( "Censored" )
);
obj << Fit Lognormal;


```

#### [Change Confidence Level](#change-confidence-level_1)

**Syntax:** obj \<< Change Confidence Level( fraction )

**Description:** Specifies the confidence level for the entire platform. All plots and reports update accordingly.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
obj << Change Confidence Level( 0.99 );


```

#### [Comparison Criterion](#comparison-criterion)

**Syntax:** obj \<< Comparison Criterion( \<Negative Loglikelihood|AICc|BIC> )

**Description:** Specifies the criterion used to rank models in the Model Comparison report. For all three criteria, smaller values indicate better fit.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit All Distributions;
obj << Comparison Criterion( BIC );


```

#### [Confidence Interval Method](#confidence-interval-method)

**Syntax:** obj = Life Distribution(... Confidence Interval Method( "Wald"|"Likelihood" ) )

**Description:** Specifies the method used for computing confidence intervals for the parameters. The default is Wald, but you can select Likelihood instead. However, all confidence intervals provided in the profilers are based on the Wald method. "Wald" by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Life Distribution(
    Y( :Hours ),
    Censor( :Status ),
    Freq( :Weight ),
    Censor Code( "Censored" ),
    Confidence Interval Method( "Likelihood" )
);
obj << Fit Lognormal;


```

#### [Do Same Analyses For All Groups](#do-same-analyses-for-all-groups)

**Syntax:** obj \<< Do Same Analyses For All Groups

**Description:** Applies all selected options from the current group to all by-group sections of the output.

```

dt = Open( "$SAMPLE_DATA/Reliability/Blenders.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    By( :Group ),
    Censor( :Censor ),
    Fit Exponential
);
obj[2] << Fit Weibull;
Wait( 1 );
obj[2] << Do Same Analyses For All Groups;


```

#### [Fit All DS Distributions](#fit-all-ds-distributions)

**Syntax:** obj \<< Fit All DS Distributions

**Description:** Fits all defective subpopulation (DS) distributions.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit All DS Distributions;


```

#### [Fit All Distributions](#fit-all-distributions)

**Syntax:** obj \<< Fit All Distributions

**Description:** Fits all distributions except the threshold (TH) distributions.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit All Distributions;


```

#### [Fit All Nonnegative](#fit-all-nonnegative)

**Syntax:** obj \<< Fit All Nonnegative

**Description:** Fits all distributions that support nonnegative observations.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit All Nonnegative;


```

#### [Fit Competing Risk Mixture](#fit-competing-risk-mixture)

**Syntax:** obj \<< Fit Competing Risk Mixture( Mix( distribution( n ), \<distribution( n ), ...>, method, \<Show Profilers( 0|1 )>

**Description:** Specifies the distributions and options for a competing risk mixture model. The method argument is required and must be one of the following starting value methods: Single Cluster, Separable Clusters, or Overlapping Clusters.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Life Distribution(
    Y( :Hours ),
    Censor( :Status ),
    Censor Code( "Censored" ),
    Freq( :Weight ),
    <<Fit Lognormal
);
obj << Fit Competing Risk Mixture(
    Mix( Lognormal( 2 ), Single Cluster, Show Profilers( 0 ) )
);


```

#### [Fit DS Frechet](#fit-ds-frechet)

**Syntax:** obj \<< Fit DS Frechet

**Description:** Fits a defective subpopulation Fréchet distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit DS Frechet;


```

#### [Fit DS Loglogistic](#fit-ds-loglogistic)

**Syntax:** obj \<< Fit DS Loglogistic

**Description:** Fits a defective subpopulation loglogistic distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit DS Loglogistic;


```

#### [Fit DS Lognormal](#fit-ds-lognormal)

**Syntax:** obj \<< Fit DS Lognormal

**Description:** Fits a defective subpopulation lognormal distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit DS Lognormal;


```

#### [Fit DS Weibull](#fit-ds-weibull)

**Syntax:** obj \<< Fit DS Weibull

**Description:** Fits a defective subpopulation Weibull distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit DS Weibull;


```

#### [Fit Exponential](#fit-exponential)

**Syntax:** obj \<< Fit Exponential

**Description:** Fits an exponential distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit Exponential;


```

#### [Fit Frechet](#fit-frechet)

**Syntax:** obj \<< Fit Frechet

**Description:** Fits a Fréchet distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit Frechet;


```

#### [Fit GenGamma](#fit-gengamma)

**Syntax:** obj \<< Fit GenGamma

**Description:** Fits a generalized gamma distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit GenGamma;


```

#### [Fit LEV](#fit-lev)

**Syntax:** obj \<< Fit LEV

**Description:** Fits a largest extreme value (LEV) distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit LEV;


```

#### [Fit LogGenGamma](#fit-loggengamma)

**Syntax:** obj \<< Fit LogGenGamma

**Description:** Fits a log generalized gamma distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit LogGenGamma;


```

#### [Fit Logistic](#fit-logistic)

**Syntax:** obj \<< Fit Logistic

**Description:** Fits a logistic distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit Logistic;


```

#### [Fit Loglogistic](#fit-loglogistic)

**Syntax:** obj \<< Fit Loglogistic

**Description:** Fits a loglogistic distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit Loglogistic;


```

#### [Fit Lognormal](#fit-lognormal)

**Syntax:** obj \<< Fit Lognormal

**Description:** Fits a lognormal distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit Lognormal;


```

#### [Fit Mixture](#fit-mixture)

**Syntax:** obj \<< Fit Mixture( Mix( distribution( n ), \<distribution( n ), ...>, method, \<Show Profilers( 0|1 )>

**Description:** Specifies the distributions and options for a mixture model. The method argument is required and must be one of the following starting value methods: Single Cluster, Separable Clusters, or Overlapping Clusters.

```

dt = Open( "$SAMPLE_DATA/Reliability/Devalt.jmp" );
obj = dt << Life Distribution(
    Y( :Hours ),
    Censor( :Status ),
    Censor Code( "Censored" ),
    Freq( :Weight ),
    <<Fit Lognormal
);
obj << Fit Mixture( Mix( Lognormal( 2 ), Single Cluster, Show Profilers( 0 ) ) );


```

#### [Fit Normal](#fit-normal)

**Syntax:** obj \<< Fit Normal

**Description:** Fits a normal distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit Normal;


```

#### [Fit SEV](#fit-sev)

**Syntax:** obj \<< Fit SEV

**Description:** Fits a smallest extreme value (SEV) distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit SEV;


```

#### [Fit TH Frechet](#fit-th-frechet)

**Syntax:** obj \<< Fit TH Frechet

**Description:** Fits a Fréchet with threshold distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit TH Frechet;


```

#### [Fit TH Loglogistic](#fit-th-loglogistic)

**Syntax:** obj \<< Fit TH Loglogistic

**Description:** Fits a loglogistic with threshold distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit TH Loglogistic;


```

#### [Fit TH Lognormal](#fit-th-lognormal)

**Syntax:** obj \<< Fit TH Lognormal

**Description:** Fits a lognormal with threshold distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit TH Lognormal;


```

#### [Fit TH Weibull](#fit-th-weibull)

**Syntax:** obj \<< Fit TH Weibull

**Description:** Fits a Weibull with threshold distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit TH Weibull;


```

#### [Fit Weibull](#fit-weibull)

**Syntax:** obj \<< Fit Weibull

**Description:** Fits a Weibull distribution to the data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Fit Weibull;


```

#### [Fit ZI Frechet](#fit-zi-frechet)

**Syntax:** obj \<< Fit ZI Frechet

**Description:** Fits a zero-inflated Fréchet distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Spring.jmp" );
obj = dt << Life Distribution( Y( :Precip ) );
obj << Fit ZI Frechet;


```

#### [Fit ZI Loglogistic](#fit-zi-loglogistic)

**Syntax:** obj \<< Fit ZI Loglogistic

**Description:** Fits a zero-inflated loglogistic distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Spring.jmp" );
obj = dt << Life Distribution( Y( :Precip ) );
obj << Fit ZI Loglogistic;


```

#### [Fit ZI Lognormal](#fit-zi-lognormal)

**Syntax:** obj \<< Fit ZI Lognormal

**Description:** Fits a zero-inflated lognormal distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Spring.jmp" );
obj = dt << Life Distribution( Y( :Precip ) );
obj << Fit ZI Lognormal;


```

#### [Fit ZI Weibull](#fit-zi-weibull)

**Syntax:** obj \<< Fit ZI Weibull

**Description:** Fits a zero-inflated Weibull distribution to the data. On by default.

```

dt = Open( "$SAMPLE_DATA/Spring.jmp" );
obj = dt << Life Distribution( Y( :Precip ) );
obj << Fit ZI Weibull;


```

#### [Get Estimates](#get-estimates_1)

**Syntax:** obj \<< Get Estimates

**Description:** Returns a list that contains the estimates for all fitted distributions. The list also contains the original data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Fit Exponential,
    Set Scale( Exponential )
);
estimate = obj << Get Estimates;
Show( estimate );


```

#### [Get Formula](#get-formula)

**Syntax:** obj \<< Get Formula

**Description:** Returns a list that contains the formulas for all fitted distributions. The list also contains the original data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Fit Exponential,
    Set Scale( Exponential )
);
formula = obj << Get Formula;
Show( formula );


```

#### [Get Results](#get-results_1)

**Syntax:** obj \<< Get Results

**Description:** Returns a list that contains the results for all fitted distributions. The list also contains the original data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Fit Exponential,
    Set Scale( Exponential )
);
r = obj << Get Results;
Show( r );


```

#### [Interval Type](#interval-type_1)

**Syntax:** obj \<< Interval Type( "Simultaneous"|"Pointwise" )

**Description:** Specifies the type of confidence interval shown for the Nonparametric fit in the Compare Distributions plot. The available options are pointwise or simultaneous confidence intervals.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
obj << Interval Type( "Pointwise" );


```

#### [Nonparametric Estimate Plot Options](#nonparametric-estimate-plot-options)

**Syntax:** obj \<< Nonparametric Estimate Plot Options( "Points"|"Step Function"|"Both"|"None" )

**Description:** Specifies how the data points in the probability plot are represented. You can choose between points, step functions, both points and step functions, or neither.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
Wait( 1 );
obj << Nonparametric Estimate Plot Options( "Step Function" );


```

#### [Rejection Sampler Maximum Trials](#rejection-sampler-maximum-trials)

**Syntax:** obj \<< Rejection Sampler Maximum Trials( number=10000 )

**Description:** "10000" by default.

**JMP Version Added:** 14

#### [Save By Group Results](#save-by-group-results)

**Syntax:** obj \<< Save By Group Results

**Description:** Saves the resulting estimates for all by groups as a separate row in a new table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Blenders.jmp" );
obj = dt << Life Distribution(
    Y( :Time Cycles ),
    By( :Group ),
    Censor( :Censor ),
    Fit Exponential
);
obj[1] << Save By Group Results;


```

#### [Set Scale](#set-scale_1)

**Syntax:** obj \<< Set Scale( Linear|Lognormal|Weibull|Loglogistic|Frechet|Normal|SEV|Logistic|LEV|Exponential )

**Description:** Specifies a scale for the probability axis in the Compare Distributions plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
obj << Set Scale( Exponential );


```

#### [Show Confidence Area](#show-confidence-area_1)

**Syntax:** obj \<< Show Confidence Area( state=0|1 )

**Description:** Shows or hides the shaded confidence regions in the plots. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
Wait( 1 );
obj << Show Confidence Area( 0 );


```

#### [Show Event Plot Frequency Label](#show-event-plot-frequency-label)

**Syntax:** obj \<< Show Event Plot Frequency Label( state=0|1 )

**Description:** Shows or hides the frequency labels in the Event Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Microprocessor Data.jmp" );
obj = dt << Life Distribution( Y( :start time, end time ), Freq( :count ) );
Report( obj )["Event Plot"] << Close( 0 );
Wait( 1 );
obj << Show Event Plot Frequency Label( 0 );


```

#### [Show Hazard Functions](#show-hazard-functions_1)

**Syntax:** obj \<< Show Hazard Functions( state=0|1 )

**Description:** Shows or hides the Hazard Profiler report, which overlays the plots of hazard functions for the selected distributions.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
obj << Show Hazard Functions( 1 );


```

#### [Show Points](#show-points_2)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides data points in the probability plot. The Life Distribution platform uses the midpoint estimates of the step function to construct probability plots. When you deselect the Show Points option, the midpoint estimates are replaced by Kaplan-Meier estimates. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
Wait( 1 );
obj << Show Points( 0 );


```

#### [Show Quantile Functions](#show-quantile-functions_1)

**Syntax:** obj \<< Show Quantile Functions( state=0|1 )

**Description:** Shows or hides the Quantile Profiler report, which overlays the plots of quantile functions for the selected distributions.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
obj << Show Quantile Functions( 1 );


```

#### [Show Statistics](#show-statistics)

**Syntax:** obj \<< Show Statistics( state=0|1 )

**Description:** Shows or hides the Statistics report, which contains model comparisons, a data summary, and nonparametric and parametric estimates. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
Wait( 1 );
obj << Show Statistics( 0 );


```

#### [Show Survival Curve](#show-survival-curve_1)

**Syntax:** obj \<< Show Survival Curve( state=0|1 )

**Description:** Switches between the failure probability and the survival curve on the Compare Distributions probability plot and the Distribution Profiler plots.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Show Survival Curve( 1 ),
    Fit Exponential
);


```

#### [Suppress Plot](#suppress-plot)

**Syntax:** obj \<< Suppress Plot( distribution name )

**Description:** Removes the specified distribution from the plots in the report. This option is equivalent to unchecking the corresponding box under Distribution in the Compare Distributions, Hazard Profiler, or Quantile Profiler reports.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Fit Weibull, Fit Lognormal, Set Scale( Weibull ) );
Wait( 2 );
obj << Suppress Plot( Lognormal );


```

#### [Tabbed Report](#tabbed-report_2)

**Syntax:** obj \<< Tabbed Report( state=0|1 )

**Description:** Shows graphs and data in individual tabs rather than in the default outline style.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ), Fit Exponential );
obj << Tabbed Report( 1 );


```

### [Shared Item Messages](#shared-item-messages_2)

#### [Action](#action_2)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset_2)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Automatic Recalc](#automatic-recalc_2)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

#### [Broadcast](#broadcast_2)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher_2)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script_2)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script_2)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Copy Script;


```

#### [Data Table Window](#data-table-window_2)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels_2)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script_2)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container_2)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table_2)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform_2)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script_2)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table_2)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing_2)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support_2)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr_2)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences_2)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter_2)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset_2)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter_2)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis_2)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis_2)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher_2)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter_2)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report_2)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view_2)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table_2)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal_2)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window_2)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects_2)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table_2)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table_2)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal_2)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report_2)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window_2)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup_2)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable_2)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport_2)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes_2)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title_2)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
obj << Title( "My Platform" );


```

#### [Top Report](#top-report_2)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Life Distribution( Y( :Time ), Censor( :Censor ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column_2)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml_2)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view_2)

**Syntax:** obj = Life Distribution(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Loading Bar Plot](#loading-bar-plot)

## [Item Messages](#item-messages)

### [Packed](#packed)

**Syntax:** obj \<< Packed

**Description:** Packed

### [Plot Choice](#plot-choice)

**Syntax:** obj \<< Plot Choice( "Overview"|"Individual" )

**Description:** On by default.

### [Side by side](#side-by-side)

**Syntax:** obj \<< Side by side

**Description:** Side by side

### [Stacked](#stacked)

**Syntax:** obj \<< Stacked

**Description:** Stacked

# [MATLAB Connection](#matlab-connection)

## [Item Messages](#item-messages)

### [Control](#control)

**Syntax:** obj \<< Control(\<Echo(Boolean)>)

**Description:** Controls the execution of MATLAB.

```


conn = MATLAB Connect();
conn << Control( Echo( 0 ) );
conn << Submit( "\[ a = 'hello'; ]\" ); // no echo
conn << Control( Echo( 1 ) );
conn << Submit( "\[ a = 'hello'; ]\" ); // echo


```

### [Disconnect](#disconnect)

**Syntax:** obj \<< Disconnect

**Description:** Terminates the MATLAB interfaces.

```

MATLABConnection = MATLAB Connect();
MATLABConnection << Disconnect;


```

### [Execute](#execute)

**Syntax:** obj \<< Execute( { list of Inputs }, { list of Outputs }, statements, \<Echo(0|1)>, \<Expand(0|1)> )

**Description:** Sends a list of inputs, executes statements, and returns a list of outputs. Optional echo() parameter defaults to True. The echo parameter controls echoing the MATLAB source to the log. Logical True (1) enables echo of source while 0 suppresses the echo to the log.

```

MATLABConnection = MATLAB Connect();
a = "abcdef";
d = 3.141;
v = [9 8 7, 6 5 4, 3 2 1];
m = [1 2 3, 4 5 6, 7 8 9];
MATLABConnection << Execute(
    {v, m, a, d},
    {x, z, a, d},
    "\[
a = v * m; % matrix product
d = v / m; % = v * inv(m) called Right division
z = m \ v; % = m * inv(v)   called Left division
x = m .* v; % element-wise product
]\"
);
Show( v, m, x, z, a, d );
MATLABConnection << Disconnect;


```

### [Get](#get)

**Syntax:** y = obj \<< Get( name )

**Description:** Returns data from MATLAB, where the name argument can represent any of the following MATLAB data types ( numeric | string | matrix | list | data frame).

```

MATLABConnection = MATLAB Connect();
x1 = [1, 2, 3];
MATLABConnection << Set( x1 );
x2 = MATLABConnection << Get( x1 );
Show( x1, x2 );
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
MATLABConnection << Set( dt1 );
dt2 = MATLABConnection << Get( dt1 );
dt2 << New Data View;
Close( dt1 );
MATLABConnection << Disconnect;


```

### [Get Graphics](#get-graphics)

**Syntax:** MATLAB graphics = obj \<< Get Graphics( format )

**Description:** Returns the last graphics object written to the MATLAB graph display window in a graphics format specified by the format argument.

```

MATLABConnection = MATLAB Connect();
ml = MATLABConnection << Submit( "\[
x = 0:pi/100:2*pi;
y = sin(x);
plot(x,y)
]\" );
plot = MATLABConnection << Get Graphics( png );
New Window( "Plot", Picture Box( plot ) );
MATLABConnection << Disconnect;


```

### [Get Version](#get-version)

**Syntax:** version = obj \<< Get Version

**Description:** Returns the version number of MATLAB used in the current connection.

```

MATLABConnection = MATLAB Connect();
version = MATLABConnection << Get Version;
Show( version );
MATLABConnection << Disconnect;


```

### [Is Connected](#is-connected)

**Syntax:** x = obj \<< Is Connected

**Description:** Returns 1 if there is an active MATLAB connection; otherwise, returns 0.

```

MATLABConnection = MATLAB Connect();
x = MATLABConnection << Is Connected;
Show( x );
MATLABConnection << Disconnect;


```

### [JMP Name To MATLAB Name](#jmp-name-to-matlab-name)

**Syntax:** obj \<< JMP Name To MATLAB Name( JMP name )

**Description:** Maps a JMP variable name to a MATLAB variable name using MATLAB variable naming rules.

```

MATLABConnection = MATLAB Connect();
MATLAB Name = MATLABConnection << JMP Name To MATLAB Name( a b c );
Show( MATLAB Name );
MATLABConnection << Disconnect;


```

### [Load](#load)

**Syntax:** obj \<< Load( path )

**Description:** Loads a ".mat" file into MATLAB and returns the variables to a JSL associative array.

```

MATLABConnection = MATLAB Connect();
// .mat file has x, y variables with values
vars = MATLABConnection << Load( "path/to/matfile.mat" );
Show( vars << Get Value( "x" ), vars << Get Value( "y" ) );
MATLABConnection << Disconnect;


```

### [Send](#send)

**Syntax:** y = obj \<< Send( name, <Named Arguments> )

**Description:** Sends data to MATLAB, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table).

```

MATLABConnection = MATLAB Connect();
x = [1, 2, 3];
MATLABConnection << Send( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
MATLABConnection << Send( dt );
Close( dt );
MATLABConnection << Submit( "x" );
MATLABConnection << Submit( "dt" );
MATLABConnection << Disconnect;


```

### [Send File](#send-file)

**Syntax:** y = obj \<< Send File( filename, \<MATLAB Name ( name )> )

**Description:** Sends a data file to MATLAB, where the filename argument is a string that specifies a path name to the file to be sent to MATLAB.

```

MATLABConnection = MATLAB Connect();
MATLABConnection << Send File( "$SAMPLE_DATA/Big Class.jmp" );
dtname = "$SAMPLE_DATA/Baseball.jmp";
MATLABConnection << Send File( dtname );
MATLABConnection << Submit( "BigClass" );
MATLABConnection << Submit( "Baseball" );
MATLABConnection << Disconnect;


```

### [Set](#set)

**Syntax:** y = obj \<< Set( name, \<MATLAB Name ( name )> )

**Description:** Sends data to MATLAB, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table).

```

MATLABConnection = MATLAB Connect();
x = [1, 2, 3];
MATLABConnection << Set( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
MATLABConnection << Set( dt );
Close( dt );
MATLABConnection << Submit( "x" );
MATLABConnection << Submit( "dt" );
MATLABConnection << Disconnect;


```

### [Submit](#submit)

**Syntax:** obj \<< Submit( statements )

**Description:** Submit statements to MATLAB. Statements can be in the form of a string value or a list of string values.

```

MATLABConnection = MATLAB Connect();
MATLABConnection << Submit(
    "\[
str = 'The quick brown fox jumps over the lazy dog';
a = 200;
]\"
);
getStr = MATLABConnection << Get( str );
getNum = MATLABConnection << Get( a );
Show( getStr, getNum );
MATLABConnection << Disconnect;


```

### [Submit File](#submit-file)

**Syntax:** obj \<< Submit File( path )

**Description:** Submits statements to MATLAB using a file specified by the path argument.

```

MATLABConnection = MATLAB Connect();
MATLABConnection << Submit File( "file containing MATLAB source." );
MATLABConnection << Disconnect;


```

# [Make Validation Column](#make-validation-column)

## [Associated Constructors](#associated-constructors)

### [Make Validation Column](#make-validation-column_1)

**Syntax:** Make Validation Column( \<Stratification Columns(columns)>, \<Grouping Columns(columns)>, \<Cutpoint Column(column)>, \<Cutpoint Batch ID(column)> )

**Description:** Makes a column used to divide the data into training, validation, and test sets.

**Cutpoint Example**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << Make Validation Column(
    Cutpoint Column( :Week of Year ),
    Cutpoint Batch ID( :ID ),
    Training Set( 0.60 ),
    Validation Set( 0.25 ),
    Test Set( 0.15 ),
    New Column Name( "Cutpoint Batch Validation" ),
    Go
);


```

**Stratification Example**

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);


```

## [Columns](#columns)

### [Cutpoint Batch ID](#cutpoint-batch-id)

**Syntax:** obj \<< Cutpoint Batch ID( column )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << Make Validation Column(
    Cutpoint Column( :Week of Year ),
    Cutpoint Batch ID( :ID ),
    Training Set( 0.60 ),
    Validation Set( 0.25 ),
    Test Set( 0.15 ),
    New Column Name( "Cutpoint Batch Validation" ),
    Go
);


```

### [Cutpoint Column](#cutpoint-column)

**Syntax:** obj \<< Cutpoint Column( column )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << Make Validation Column(
    Cutpoint Column( :Week of Year ),
    Cutpoint Batch ID( :ID ),
    Training Set( 0.60 ),
    Validation Set( 0.25 ),
    Test Set( 0.15 ),
    New Column Name( "Cutpoint Batch Validation" ),
    Go
);


```

### [Grouping Columns](#grouping-columns)

**Syntax:** obj \<< Grouping Columns( column(s) )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Make Validation Column(
    Grouping Column( :ID ),
    Training Set( 0.5 ),
    Validation Set( 0.3 ),
    Test Set( 0.2 ),
    Go
);


```

### [Stratification Columns](#stratification-columns)

**Syntax:** obj \<< Stratification Columns( column(s) )

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
obj = dt << Make Validation Column(
    Y( :Cholesterol Loss ),
    Stratification Columns( :Sex ),
    Number of Folds( 5 ),
    Random Seed( 1234 ),
    Go
);


```

## [Item Messages](#item-messages)

### [Assign Extra Rows](#assign-extra-rows)

**Syntax:** obj \<< Assign Extra Rows( "To Training"|"To Validation"|"To Test" )

**Description:** Specifies if extra rows should be assigned to the training, validation, or test set. This option is available only when Numbers of Rows is specified as the Determine cutpoints using option and a Cutpoint Batch ID variable is specified.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Make Validation Column(
    Cutpoint Column( :Week of Year ),
    Cutpoint Batch ID( :ID ),
    Training Set( 20 ),
    Validation Set( 10 ),
    Test Set( 4 ),
    New Column Name( "Cutpoint Batch Validation" ),
    Determine cutpoints using( "Numbers of Rows" ),
    Assign Extra Rows( "To Training" )
);
Wait( 2 );
obj << Go;


```

### [Determine cutpoints using](#determine-cutpoints-using)

**Syntax:** obj \<< Determine cutpoints using( "Proportions"|"Numbers of Rows"|"Fixed Time or Date"|"Elapsed Time" )

**Description:** Specifies the method that is used to determine the cutpoints.

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
obj = dt << Make Validation Column(
    Cutpoint Column( :Week of Year ),
    Cutpoint Batch ID( :ID ),
    Training Set( 20 ),
    Validation Set( 10 ),
    Test Set( 4 ),
    New Column Name( "Cutpoint Batch Validation" ),
    Determine cutpoints using( "Numbers of Rows" ),
    Assign Extra Rows( "To Training" )
);
Wait( 2 );
obj << Go;


```

### [Go](#go)

**Syntax:** obj \<< Go( text )

**Description:** Make a validation column with the current settings.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);


```

### [New Column Name](#new-column-name)

**Syntax:** obj \<< New Column Name( text )

**Description:** Specifies a name for the newly created validation column.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Make Validation Column(
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Go
);


```

### [Number of Folds](#number-of-folds)

**Syntax:** obj \<< Number of Folds( number=4 )

**Description:** Specifies the number of folds that are used for K-Fold crossvalidation. "4" by default.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
obj = dt << Make Validation Column(
    Y( :Cholesterol Loss ),
    Stratification Columns( :Sex ),
    Number of Folds( 5 ),
    Random Seed( 1234 ),
    Go
);


```

### [Random Seed](#random-seed)

**Syntax:** obj \<< Random Seed( number )

**Description:** Specifies a random seed for the production of validation columns. Use the same random seed to reproduce the same validation column when using the same method.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Make Validation Column(
    Training Set( 0.75 ),
    Validation Set( 0.25 ),
    Random Seed( 12321 ),
    Go
);


```

### [Test Set](#test-set)

**Syntax:** obj \<< Test Set( number=0.00 )

**Description:** Specifies the proportion of observations to be assigned to the test set. The test set is optional and is used to check the predictive ability of the model after the model is chosen. "0.00" by default.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);


```

### [Training Set](#training-set)

**Syntax:** obj \<< Training Set( number=0.75 )

**Description:** Specifies the proportion of observations to be assigned to the training set. The training set is used to estimate the model. "0.75" by default.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);


```

### [Validation Column Type](#validation-column-type)

**Syntax:** obj \<< Validation Column Type( Fixed|Formula )

**Description:** Selects the column type (fixed or formula) for the new validation column. The default is a fixed column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Make Validation Column(
    Training Set( 0.75 ),
    Validation Set( 0.25 ),
    Validation Column Type( Formula ),
    Go
);


```

### [Validation Set](#validation-set)

**Syntax:** obj \<< Validation Set( number=0.25 )

**Description:** Specifies the proportion of observations to be assigned to the validation set. The validation set is used to help choose a model that predicts well. "0.25" by default.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Lipid Data.jmp" );
dt << Make Validation Column(
    Stratification Columns( :Sex ),
    Training Set( 0.50 ),
    Validation Set( 0.25 ),
    Test Set( 0.25 ),
    New Column Name( "Valid1" ),
    Random Seed( 1234 ),
    Go
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Make Validation Column(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Manage Limits](#manage-limits)

## [Associated Constructors](#associated-constructors)

### [Manage Limits](#manage-limits_1)

**Syntax:** Manage Limits( Process Variables( columns ) )

**Description:** Launches utility for managing quality limits for multiple columns at once. You can add, edit, and save limits to column properties.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );


```

## [Columns](#columns)

### [Grouping](#grouping)

**Syntax:** obj = Manage Limits( Process Variables( columns), Grouping( columns) )

**Description:** Specifies columns as grouping variables.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits(
    Process Variables( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Grouping( :site )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cheese Manufacturing Data.jmp" );
obj = dt << Manage Limits(
    Process Variables( :pH, :Salt Concentration, :Moisture Content ),
    Grouping( :Cheese Type )
);


```

### [Process Variables](#process-variables)

**Syntax:** obj = Manage Limits( Process Variables( columns) )

**Description:** Specifies the continuous columns of processes.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( :NPN1, :PNP1, :PNP2, :NPN2 ) );


```

## [Item Messages](#item-messages)

### [Color Out of Spec Values](#color-out-of-spec-values)

**Syntax:** obj \<< Color Out of Spec Values

**Description:** Colors the cells in the data table that correspond to observations that are outside the specification limits. Cells for observations that are below the lower specification limit are colored light red. Cells for observations that are above the upper specification limit are colored light blue.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
Wait( 1 );
obj << Color Out of Spec Values;


```

### [Load from Limits Table](#load-from-limits-table)

**Syntax:** obj \<< Load from Limits Table

**Description:** Load limits data from a data table.

**JMP Version Added:** 14

**Example 1**

```


dtLimits = New Table( "Cities Limits",
    Add Rows( 4 ),
    New Column( "Process", Character, Set Values( {"OZONE", "CO", "SO2", "NO"} ) ),
    New Column( "LSL", Numeric, Set Values( [0, 0, 0, 0] ) ),
    New Column( "Target", Numeric, Set Values( [0.2, 15, 0.05, 0.035] ) ),
    New Column( "USL", Numeric, Set Values( [0.4, 30, 0.1, 0.07] ) ),
    Set Label Columns( :Process )
);
dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Manage Limits( Process Variables( :OZONE, :CO, :SO2, :NO ) );
obj << Load From Limits Table( dtLimits );


```

**Example 2**

```


dtLimits = Open( "$SAMPLE_DATA/Cheese Manufacturing Limits.jmp" );
dt = Open( "$SAMPLE_DATA/Cheese Manufacturing Data.jmp" );
obj = dt << Manage Limits(
    Process Variables( :pH, :Salt Concentration, :Moisture Content ),
    Grouping( :Cheese Type )
);
obj << Load From Limits Table( dtLimits );


```

### [Round Decimals](#round-decimals)

**Syntax:** obj \<< Round Decimals

**Description:** Rounds all numeric values to a specified number of decimal places.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
Wait( 1 );
obj << Round Decimals( 1 );


```

### [Save to Column Properties](#save-to-column-properties)

**Syntax:** obj \<< Save to Column Properties

**Description:** Saves the limits data as column properties.

**JMP Version Added:** 14

```


dtLimits = New Table( "Cities Limits",
    Add Rows( 4 ),
    New Column( "Process", Character, Set Values( {"OZONE", "CO", "SO2", "NO"} ) ),
    New Column( "LSL", Numeric, Set Values( [0, 0, 0, 0] ) ),
    New Column( "Target", Numeric, Set Values( [0.2, 15, 0.05, 0.035] ) ),
    New Column( "USL", Numeric, Set Values( [0.4, 30, 0.1, 0.07] ) ),
    Set Label Columns( :Process )
);
dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Manage Limits(
    Process Variables( :OZONE, :CO, :SO2, :NO ),
    Load From Limits Table( dtLimits )
);
obj << Save to Column Properties;


```

### [Save to Column Properties in Split Table](#save-to-column-properties-in-split-table)

**Syntax:** obj \<< Save to Column Properties in Split Table( < Remaining Columns ( Drop All | Keep All | Split All )> )

**Description:** Saves the limits data as column properties in a new data table split by the grouping variables.

**JMP Version Added:** 19

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( :NPN1, :PNP1 ), Grouping( :site ) );
obj << Save to Column Properties in Split Table( Remaining Columns( Drop All ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( :NPN1, :PNP1 ), Grouping( :site ) );
obj << Save to Column Properties in Split Table( Remaining Columns( Keep All ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( :NPN1, :PNP1 ), Grouping( :site ) );
obj << Save to Column Properties in Split Table( Remaining Columns( Split All ) );


```

### [Save to Tall Limits Table](#save-to-tall-limits-table)

**Syntax:** obj \<< Save to Tall Limits Table

**Description:** Creates a new tall data table that contains all the limits data for each column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Save to Tall Limits Table;


```

### [Save to Wide Limits Table](#save-to-wide-limits-table)

**Syntax:** obj \<< Save to Wide Limits Table

**Description:** Creates a new wide data table that contains all the limits data for each column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Save to Wide Limits Table;


```

### [Show Limits All](#show-limits-all)

**Syntax:** obj \<< Show Limits All

**Description:** Checks the 'Show Limits' check boxes for all the items.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
Wait( 1 );
obj << Show Limits All;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Manage Limits(
    Process Variables( dt << Get Column Group( "Processes" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Manage Limits(
    Process Variables( dt << Get Column Group( "Processes" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Manage Limits(
    Process Variables( dt << Get Column Group( "Processes" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Manage Limits(
    Process Variables( dt << Get Column Group( "Processes" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Manage Limits(
    Process Variables( dt << Get Column Group( "Processes" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Manage Limits(
    Process Variables( dt << Get Column Group( "Processes" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Manage Limits(
    Process Variables( dt << Get Column Group( "Processes" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Manage Limits( Process Variables( dt << Get Column Group( "Processes" ) ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Manage Limits(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Marker Admixture](#marker-admixture)

## [Associated Constructors](#associated-constructors)

### [Marker Admixture](#marker-admixture_1)

**Syntax:** Marker Admixture( Marker( columns ) )

**Description:** Estimates population admixture for individuals based on marker genotypes.

**JMP Version Added:** 19

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(
        Missing Marker Imputation Method( "Specified" ),
        Estimation Method( "Fixed Parameter" ),
        Unthreaded( 1 ),
        Imputation Value( 1 ),
        Number of Ancestral Populations( 3 )
    ),
    Fit(
        Missing Marker Imputation Method( "Specified" ),
        Estimation Method( "Fixed Parameter" ),
        Unthreaded( 1 ),
        Imputation Value( 1 ),
        Number of Ancestral Populations( 3 )
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** For each level of the specified column, analyzes and presents the results in separate tables and reports.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

    //Run platform
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), By( :Sex ), Fit );


```

### [Label](#label)

**Syntax:** obj \<< Label( column )

**Description:** Specifies a column that contains label for each sample.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Label( :Sex ), Fit );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( column(s) )

**Description:** Specifies columns that contain genetic markers.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Sample ID( :SampleID ),
    Label( :Sex ),
    Fit
);


```

### [Sample ID](#sample-id)

**Syntax:** obj \<< Sample ID( column )

**Description:** Specifies a column that contains a unique identifier for each sample.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set up ID Column
dt << New Column( "SampleID",
    Character,
    "Nominal",
    Formula( Char( :Pedigree ) || Char( :Sample ) )
);

//Run platform
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Sample ID( :SampleID ),
    Label( :Sex ),
    Fit
);


```

## [Item Messages](#item-messages)

### [Compare](#compare)

**Syntax:** obj \<< Compare

**Description:** Updates the Marker Admixture comparison metrics.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit,
    Fit( Estimation Method( "Fixed Parameter" ), Number of Ancestral Populations( 3 ) ),
    Set( Estimation Method( "Fixed Parameter" ), Number of Ancestral Populations( 3 ) )
);
obj << Compare( LogLikehood( 0 ) );


```

### [Fit](#fit)

**Syntax:** obj \<< Fit

**Description:** Fits a Marker Admixture model. You can specify parameters and fitting specifications within this command.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Estimation Method( "Fixed Parameter" ),
        Number of Ancestral Populations( 3 ),
        Unthreaded( 1 ),
        Missing Marker Imputation Method( "Specified" ),
        Imputation Value( 1 )
    )
);


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**JMP Version Added:** 19

### [Set](#set)

**Syntax:** obj \<< Set

**Description:** Specifies parameters for a Marker Admixture model.

**JMP Version Added:** 18

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(
        Estimation Method( "Fixed Parameter" ),
        Number of Ancestral Populations( 3 ),
        Unthreaded( 1 ),
        Missing Marker Imputation Method( "Specified" ),
        Imputation Value( 1 )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(),
    Fit(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(),
    Fit(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(),
    Fit(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(),
    Fit(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(),
    Fit(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(),
    Fit(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Set(),
    Fit(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Set(), Fit() );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Marker Admixture(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Marker Admixture Compare](#marker-admixture-compare)

### [Associated Constructors](#associated-constructors_1)

#### [Marker Admixture Compare](#marker-admixture-compare_1)

**Syntax:** Marker Admixture Compare

### [Item Messages](#item-messages_1)

#### [Hide All Models](#hide-all-models)

**Syntax:** obj \<< Hide All Models

**Description:** Hides all models.

**JMP Version Added:** 19

#### [Iterations](#iterations)

**Syntax:** obj \<< Iterations( state=0|1 )

**Description:** Shows or hides the number of iterations when the factorization algorithm stopped. On by default.

**JMP Version Added:** 19

#### [Log Likelihood](#log-likelihood)

**Syntax:** obj \<< Log Likelihood( state=0|1 )

**Description:** Shows or hides negative logarithm of the likelihood-based function. On by default.

**JMP Version Added:** 19

#### [Number of Ancestral Populations](#number-of-ancestral-populations)

**Syntax:** obj \<< Number of Ancestral Populations( state=0|1 )

**Description:** Shows or hides the number of ancestral populations. On by default.

**JMP Version Added:** 19

#### [Predictors](#predictors)

**Syntax:** obj \<< Predictors( state=0|1 )

**Description:** Shows or hides the Predictors column. On by default.

**JMP Version Added:** 19

#### [Remove Hidden Models](#remove-hidden-models)

**Syntax:** obj \<< Remove Hidden Models

**Description:** Removes all models for which the Show box is not checked.

**JMP Version Added:** 19

#### [Remove Shown Models](#remove-shown-models)

**Syntax:** obj \<< Remove Shown Models

**Description:** Removes all models for which the Show check box is checked and shows the remaining models.

**JMP Version Added:** 19

#### [Show All Models](#show-all-models)

**Syntax:** obj \<< Show All Models

**Description:** Shows all models.

**JMP Version Added:** 19

#### [Tolerance](#tolerance)

**Syntax:** obj \<< Tolerance( state=0|1 )

**Description:** Shows or hides the tolerance value (RMSE of estimated individual admixture) when the factorization algorithm stopped. On by default.

**JMP Version Added:** 19

## [Marker Admixture Fit](#marker-admixture-fit)

### [Associated Constructors](#associated-constructors_2)

#### [Marker Admixture Fit](#marker-admixture-fit_1)

**Syntax:** Marker Admixture Fit

### [Item Messages](#item-messages_2)

#### [Cluster Individuals](#cluster-individuals)

**Syntax:** obj \<< Cluster Individuals( state=0|1 )

**Description:** Clusters individuals based on their estimated ancestral population admixture probabilities.

**JMP Version Added:** 19

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Cluster Individuals( 1 ));


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit( Cluster Individuals( 1 ) )
);


```

#### [Cluster Markers](#cluster-markers)

**Syntax:** obj \<< Cluster Markers( state=0|1 )

**Description:** Clusters markers based on their reference allele frequencies estimated on each ancestral population.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Cluster Markers( 1 ));


```

#### [Copy Parameters to Launch](#copy-parameters-to-launch)

**Syntax:** obj \<< Copy Parameters to Launch

**Description:** Copies the parameters from this model to the model launch section.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Copy Parameters to Launch());


```

#### [Estimation Method](#estimation-method)

**Syntax:** obj = Marker Admixture Fit(...Estimation Method( "Stability Point"|"Fixed Parameter"="Stability Point" )...)

**Description:** Specifies the method of estimation for the number of ancestral populations. "Stability Point" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Estimation Method( "Fixed Parameter" ),
        Number of Ancestral Populations( 3 ),
        Unthreaded( 1 ),
        Missing Marker Imputation Method( "Specified" ),
        Imputation Value( 1 )
    )
);


```

#### [Imputation Value](#imputation-value)

**Syntax:** obj = Marker Admixture Fit(...Imputation Value( number=0 )...)

**Description:** Specifies an integer number from zero to the ploidy for the replacement of missing marker scores. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Set Random Seed( 12345 ),
        Missing Marker Imputation Method( "HWE On" ),
        Imputation Value( 1 )
    )
);


```

#### [Missing Marker Imputation Method](#missing-marker-imputation-method)

**Syntax:** obj = Marker Admixture Fit(...Missing Marker Imputation Method( "HWE Off"|"HWE On"|"Random"|"Specified"="HWE Off" )...)

**Description:** Specifies one of four types of missing marker imputation methods. "HWE Off" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Set Random Seed( 12345 ),
        Missing Marker Imputation Method( "HWE On" ),
        Imputation Value( 1 )
    )
);


```

#### [Number of Ancestral Populations](#number-of-ancestral-populations_1)

**Syntax:** obj = Marker Admixture Fit(...Number of Ancestral Populations( number=2 )...)

**Description:** Specifies the number of ancestral populations. "2" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Estimation Method( "Fixed Parameter" ),
        Number of Ancestral Populations( 3 ),
        Unthreaded( 1 )
    )
);


```

#### [Order Populations Method](#order-populations-method)

**Syntax:** obj = Marker Admixture Fit(...Order Populations Method( "Average Admixture"|"Variance Explained"="Average Admixture" )...)

**Description:** Specifies the method for ordering the columns of the P matrix (m x d, where m = number of genetic markers and d is the number of ancestral populations) and the rows of Q matrix (d x n, where n= number of samples). "Average Admixture" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Estimation Method( "Fixed Parameter" ),
        Order Populations Method( "Variance Explained" ),
        Number of Ancestral Populations( 3 )
    ),
    Set(
        Estimation Method( "Fixed Parameter" ),
        Order Populations Method( "Variance Explained" ),
        Number of Ancestral Populations( 3 )
    )
);


```

#### [Parallel Plot for Individuals](#parallel-plot-for-individuals)

**Syntax:** obj \<< Parallel Plot for Individuals( state=0|1 )

**Description:** Creates an overlay plot of all individuals based on their ancestral population admixture probabilities.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Parallel Plot for Individuals( 1 ));


```

#### [Parallel Plot for Markers](#parallel-plot-for-markers)

**Syntax:** obj \<< Parallel Plot for Markers( state=0|1 )

**Description:** Creates an overlay plot of all markers based on their reference allele frequencies estimated on each ancestral population.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Parallel Plot for Markers( 1 ));


```

#### [Remove All But This Fit](#remove-all-but-this-fit)

**Syntax:** obj \<< ( Fit[number] \<< Remove All But This Fit( state=0|1 ) )

**Description:** Removes the reports and plots for all models except this one.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit,
    Fit( Estimation Method( "Fixed Parameter" ), Number of Ancestral Populations( 3 ) ),
    Set( Estimation Method( "Fixed Parameter" ), Number of Ancestral Populations( 3 ) )
);
Wait( 2 );
obj << (Fit[2] << Remove All But This Fit( 1 ));


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< ( Fit[number] \<< Remove Fit( state=0|1 ) )

**Description:** Removes the entire model report.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Set Random Seed( 12345 ),
        Missing Marker Imputation Method( "HWE On" ),
        Imputation Value( 1 )
    )
);
Wait( 2 );
obj << (Fit[1] << Remove Fit( 1 ));


```

#### [Save F Table](#save-f-table)

**Syntax:** obj \<< Save F Table

**Description:** Saves the product of matrices P times Q into a table.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Save F Table());


```

#### [Save P Table](#save-p-table)

**Syntax:** obj \<< Save P Table

**Description:** Saves the estimated frequency of the reference allele (P) for each genetic marker into a table.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Save P Table());


```

#### [Save Q Table](#save-q-table)

**Syntax:** obj \<< Save Q Table

**Description:** Saves the estimated admixture probabilities (Q) of ancestral populations for each sample into a table.

**JMP Version Added:** 19

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Admixture( Marker( Column Group( "Markers" ) ), Fit() );
Wait( 2 );
obj << (Fit[1] << Save Q Table());


```

#### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Marker Admixture Fit(...Set Random Seed( number=0 )...)

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Set Random Seed( 12345 ),
        Missing Marker Imputation Method( "HWE On" ),
        Imputation Value( 1 )
    )
);


```

#### [Unthreaded](#unthreaded)

**Syntax:** obj = Marker Admixture Fit(...Unthreaded( state=0 )...)

**Description:** Use only the main thread for calculations "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Admixture(
    Marker( Column Group( "Markers" ) ),
    Fit(
        Estimation Method( "Fixed Parameter" ),
        Number of Ancestral Populations( 3 ),
        Unthreaded( 1 )
    )
);


```

# [Marker Imputation](#marker-imputation)

## [Associated Constructors](#associated-constructors)

### [Marker Imputation](#marker-imputation_1)

**Syntax:** Marker Imputation( Marker( columns ) )

**Description:** Imputes numeric missing marker genotypes.

**JMP Version Added:** 19

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
obj = dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 0 ),
    Method( "Specified" ),
    Imputation Value( 1 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** For each level of the specified column, analyzes and presents the results in separate tables and reports.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    By( :Sex ),
    Ploidy( 2 ),
    Unthreaded( 0 ),
    Missing Marker Imputation Method( "LD-kNN" )
);


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( column(s) )

**Description:** Specifies columns that contain genetic markers.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);


```

## [Item Messages](#item-messages)

### [Imputation Value](#imputation-value)

**Syntax:** obj = Marker Imputation(...Imputation Value( number=0 )...)

**Description:** Specifies an integer number from zero to the ploidy for the replacement of missing marker scores. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

         //Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "Specified" ),
    Imputation Value( 0 )
);


```

### [Method](#method)

**Syntax:** obj = Marker Imputation(...Method( "LD-kNN"|"HWE Off"|"HWE On"|"Random"|"Specified"="LD-kNN" )...)

**Description:** Specifies one of four types of missing marker imputation methods. "LD-kNN" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

         //Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    Imputation Value( 0 )
);


```

### [Nearest Markers](#nearest-markers)

**Syntax:** obj = Marker Imputation(...Nearest Markers( number=15 )...)

**Description:** Specifies the number of neighbor markers. "15" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

         //Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    Nearest Markers( 20 )
);


```

### [Nearest Samples](#nearest-samples)

**Syntax:** obj = Marker Imputation(...Nearest Samples( number=15 )...)

**Description:** Specifies the number of neighbor samples. "15" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

         //Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    Nearest Samples( 20 )
);


```

### [Ploidy](#ploidy)

**Syntax:** obj = Marker Imputation(...Ploidy( number=2 )...)

**Description:** Specifies a positive even number that indicates the ploidy level. "2" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);


```

### [Select Where](#select-where)

**Syntax:** obj \<< Select Where

**Description:** Selects items in the report table that correspond to a particular condition.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
obj = dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Unthreaded( 1 ),
    Missing Marker Imputation Method( "LD-kNN" )
);

obj << Select Where( Percent of Missing >= 85 );


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Marker Imputation(...Set Random Seed( number=0 )...)

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" )
);


```

### [Unthreaded](#unthreaded)

**Syntax:** obj = Marker Imputation(...Unthreaded( state=0|1 )...)

**Description:** Use only the main thread for calculations

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Unthreaded( 1 ),
    Missing Marker Imputation Method( "LD-kNN" )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set missing values for some markers
dt = Current Data Table();
Random Reset( 1234 );
markers = dt << Get Column Group( "Markers" );
markers = markers[Random Index( N Items( markers ), 15 )];
For Each( {col}, markers, col[Random Index( N Rows( dt ), Random Integer( 1, 20 ) )] = . );

//Run platform
dt << Marker Imputation(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Missing Marker Imputation Method( "LD-kNN" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Marker Imputation(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Marker Relatedness](#marker-relatedness)

## [Associated Constructors](#associated-constructors)

### [Marker Relatedness](#marker-relatedness_1)

**Syntax:** Marker Relatedness( Marker( columns ) )

**Description:** Estimates several types of genomic relationship measures between pairs of individuals based genetic markers in both diploid and polyploid organisms.

**JMP Version Added:** 18

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
obj = dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE On" ),
    Kinship Type( "Identical by State" )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** For each level of the specified column, analyzes and presents the results in separate tables and reports.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    By( :Sex ),
    Ploidy( 2 ),
    Unthreaded( 0 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( column(s) )

**Description:** Specifies columns that contain genetic markers.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

### [Sample ID](#sample-id)

**Syntax:** obj \<< Sample ID( column )

**Description:** Specifies a column that contains a unique identifier for each sample.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set up ID Column
dt << New Column( "SampleID",
    Character,
    "Nominal",
    Formula( Char( :Pedigree ) || Char( :Sample ) )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Sample ID( :SampleID ),
    Ploidy( 2 ),
    Unthreaded( 0 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

## [Item Messages](#item-messages)

### [Additive Type](#additive-type)

**Syntax:** obj = Marker Relatedness(...Additive Type( "Diploid Method 1"|"Diploid Method 2"|"Polyploid"="Diploid Method 1" )...)

**Description:** Specifies an estimation method for the additive genomic relationship matrix. "Diploid Method 1" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 0 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Additive" ),
    Additive Type( "Diploid Method 2" )
);


```

### [Clustering](#clustering)

**Syntax:** obj = Marker Relatedness(...Clustering( state=0|1 )...)

**Description:** Creates a clustering report using the relationship matrix.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Principal Components( 1 ),
    Clustering( 1 ),
    Ploidy( 2 ),
    Unthreaded( 1 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

### [Dominance Type](#dominance-type)

**Syntax:** obj = Marker Relatedness(...Dominance Type( "Diploid Method 1"|"Diploid Method 2"|"Polyploid"="Diploid Method 1" )...)

**Description:** Specifies an estimation method for the dominance genomic relationship matrix. "Diploid Method 1" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Dominance" ),
    Dominance Type( "Diploid Method 2" )
);


```

### [Epistasis Type](#epistasis-type)

**Syntax:** obj = Marker Relatedness(...Epistasis Type( "Additive by Additive"|"Additive by Dominance"|"Dominance by Dominance"="Additive by Additive" )...)

**Description:** Specifies a type of epistasis genomic relationship matrix to be computed from markers. "Additive by Additive" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Epistasis" ),
    Additive Type( "Diploid Method 1" ),
    Dominance Type( "Diploid Method 2" ),
    Epistasis Type( "Additive by Dominance" )
);


```

### [Imputation Value](#imputation-value)

**Syntax:** obj = Marker Relatedness(...Imputation Value( number=0 )...)

**Description:** Specifies an integer number from zero to the ploidy for the replacement of missing marker scores. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 0 ),
    Missing Marker Imputation Method( "Specified" ),
    Imputation Value( 0 ),
    Kinship Type( "Additive" ),
    Additive Type( "Diploid Method 1" )
);


```

### [Kinship Type](#kinship-type)

**Syntax:** obj = Marker Relatedness(...Kinship Type( "Identical by State"|"Additive"|"Dominance"|"Epistasis"="Identical by State" )...)

**Description:** Specifies a type of genomic relationship matrix to be computed from markers. "Identical by State" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Dominance" ),
    Dominance Type( "Diploid Method 2" )
);


```

### [Merge Kinship Table](#merge-kinship-table)

**Syntax:** obj \<< Merge Kinship Table

**Description:** Merges the genomic relationship matrix table into the original data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
obj = dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Unthreaded( 0 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Merge Kinship Table;


```

### [Missing Marker Imputation Method](#missing-marker-imputation-method)

**Syntax:** obj = Marker Relatedness(...Missing Marker Imputation Method( "HWE Off"|"HWE On"|"Random"|"Specified"="HWE Off" )...)

**Description:** Specifies one of four types of missing marker imputation methods. "HWE Off" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "Specified" ),
    Imputation Value( 0 ),
    Kinship Type( "Additive" ),
    Additive Type( "Diploid Method 1" )
);


```

### [Ploidy](#ploidy)

**Syntax:** obj = Marker Relatedness(...Ploidy( number=2 )...)

**Description:** Specifies a positive even number that indicates the ploidy level. "2" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

### [Principal Components](#principal-components)

**Syntax:** obj = Marker Relatedness(...Principal Components( state=0|1 )...)

**Description:** Creates a principal components report using the relationship matrix.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Principal Components( 1 ),
    Clustering( 1 ),
    Ploidy( 2 ),
    Unthreaded( 1 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

### [Save Square Kinship Table](#save-square-kinship-table)

**Syntax:** obj \<< Save Square Kinship Table

**Description:** Saves the square matrix genomic relationship into a table in the unstacked format

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
obj = dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Unthreaded( 0 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Save Square Kinship Table;


```

### [Save Stacked Kinship Table](#save-stacked-kinship-table)

**Syntax:** obj \<< Save Stacked Kinship Table

**Description:** Saves the upper triangular part of the genomic relationship matrix into a table in the stacked format

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
obj = dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Unthreaded( 0 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Save Stacked Kinship Table;


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Marker Relatedness(...Set Random Seed( number=0 )...)

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

### [Unthreaded](#unthreaded)

**Syntax:** obj = Marker Relatedness(...Unthreaded( state=0|1 )...)

**Description:** Use only the main thread for calculations

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Unthreaded( 1 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Run platform
dt << Marker Relatedness(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Set Random Seed( 12345 ),
    Missing Marker Imputation Method( "HWE Off" ),
    Kinship Type( "Identical by State" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Marker Relatedness(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Marker Simulation](#marker-simulation)

## [Associated Constructors](#associated-constructors)

### [Marker Simulation](#marker-simulation_1)

**Syntax:** Marker Simulation( Marker( columns ), Predictor Formula( columns ) )

**Description:** Simulates marker genotypes from parental crosses and computes related measures of breeding performance.

**JMP Version Added:** 17

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
obj = dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** For each level of the specified column, analyzes and presents the results in separate tables and reports.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

    //Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

    //Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4
    ),
    Cross( :Sex ),
    By( :Disease Status ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 )
);


```

### [Cross](#cross)

**Syntax:** obj \<< Cross( column(s) )

**Description:** Specifies a column that groups the samples into blocks. Crosses are then made between samples of different groups.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

    //Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

    //Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( column(s) )

**Description:** Specifies columns that contain genetic markers.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Predictor Formula](#predictor-formula)

**Syntax:** obj \<< Predictor Formula( column(s) )

**Description:** Specifies columns that contain prediction formulas for responses or traits.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Sample ID](#sample-id)

**Syntax:** obj \<< Sample ID( column )

**Description:** Specifies a column that contains a unique identifier for each sample.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

    //Set up ID Column
dt << New Column( "SampleID",
    Character,
    "Nominal",
    Formula( Char( :Pedigree ) || Char( :Sample ) )
);

    //Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

    //Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Sample ID( :SampleID ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

## [Item Messages](#item-messages)

### [Estimate Diversity](#estimate-diversity)

**Syntax:** obj = Marker Simulation(...Estimate Diversity( state=0|1 )...)

**Description:** Estimates genetic diversity for the simulated individuals.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set up thresholds for progeny selection via Spec Limits
dt:Name( "Pred Formula Trait1" ) << Set Property( "Spec Limits", {LSL( 22.5 )} );
dt:Name( "Pred Formula Trait2" ) << Set Property( "Spec Limits", {USL( 25.5 )} );
dt:Name( "Probability( Disease Status=1 )" ) << Set Property( "Spec Limits", {USL( 0.3 )} );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Estimate Diversity( 1 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),

);


```

### [Imputation Value](#imputation-value)

**Syntax:** obj = Marker Simulation(...Imputation Value( number=0 )...)

**Description:** Specifies an integer number from zero to the ploidy for the replacement of missing marker scores. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set up thresholds for progeny selection via Spec Limits
dt:Name( "Pred Formula Trait1" ) << Set Property( "Spec Limits", {LSL( 22.5 )} );
dt:Name( "Pred Formula Trait2" ) << Set Property( "Spec Limits", {USL( 25.5 )} );
dt:Name( "Probability( Disease Status=1 )" ) << Set Property( "Spec Limits", {USL( 0.3 )} );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 1 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    Missing Marker Imputation Method( "Specified" ),
    Imputation Value( 0 )
);


```

### [Missing Marker Imputation Method](#missing-marker-imputation-method)

**Syntax:** obj = Marker Simulation(...Missing Marker Imputation Method( "HWE Off"|"HWE On"|"Random"|"Specified"="HWE Off" )...)

**Description:** Specifies one of four types of missing marker imputation methods. "HWE Off" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set up thresholds for progeny selection via Spec Limits
dt:Name( "Pred Formula Trait1" ) << Set Property( "Spec Limits", {LSL( 22.5 )} );
dt:Name( "Pred Formula Trait2" ) << Set Property( "Spec Limits", {USL( 25.5 )} );
dt:Name( "Probability( Disease Status=1 )" ) << Set Property( "Spec Limits", {USL( 0.3 )} );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    Missing Marker Imputation Method( "Random" )
);


```

### [Number of Generations](#number-of-generations)

**Syntax:** obj = Marker Simulation(...Number of Generations( number=1 )...)

**Description:** Specifies the number of generations to go through in the crosses and selection process. "1" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Number of Individuals per Cross](#number-of-individuals-per-cross)

**Syntax:** obj = Marker Simulation(...Number of Individuals per Cross( number=5 )...)

**Description:** Specifies the number of individuals to be simulated per cross. "5" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Number of Selected Crosses](#number-of-selected-crosses)

**Syntax:** obj = Marker Simulation(...Number of Selected Crosses( number=0 )...)

**Description:** Specifies the maximum number of families to be selected per generation. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Select Best Individuals( 1 ),
    Number of Selected Individuals( 2 ),
    Number of Selected Crosses( 5 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Number of Selected Individuals](#number-of-selected-individuals)

**Syntax:** obj = Marker Simulation(...Number of Selected Individuals( number=0 )...)

**Description:** Specifies the maximum number of individuals to be selected per family. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Select Best Individuals( 1 ),
    Number of Selected Individuals( 2 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Ploidy](#ploidy)

**Syntax:** obj = Marker Simulation(...Ploidy( number=2 )...)

**Description:** Specifies an even number that indicates the ploidy level. "2" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Save Simulated Table](#save-simulated-table)

**Syntax:** obj \<< Save Simulated Table

**Description:** Saves the simulated genotypes to a new data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
obj = dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 2000 ),
    Show Evaluation Plot( 0 ),
    Show Diversity Plot( 0 )
);

// Create Full Simulated Table
Show( obj << Save Simulated Table );


```

### [Select Best Individuals](#select-best-individuals)

**Syntax:** obj = Marker Simulation(...Select Best Individuals( state=0|1 )...)

**Description:** Selects best individuals that meet all criteria specified on Spec Limits's Column Properties of Predictor Formulas.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Set up thresholds for progeny selection via Spec Limits
dt:Name( "Pred Formula Trait1" ) << Set Property( "Spec Limits", {LSL( 22.5 )} );
dt:Name( "Pred Formula Trait2" ) << Set Property( "Spec Limits", {USL( 25.5 )} );
dt:Name( "Probability( Disease Status=1 )" ) << Set Property( "Spec Limits", {USL( 0.3 )} );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Select Best Individuals( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Marker Simulation(...Set Random Seed( number=0 )...)

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible. "0" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Show Diversity Plot](#show-diversity-plot)

**Syntax:** obj \<< Show Diversity Plot( state=1 )

**Description:** Shows or hides the plot of genetic diversity. On by default.

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 2000 ),
    Estimate Diversity( 1 ),
    Show Diversity Plot( 1 )
);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
obj = dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 2000 ),
    Estimate Diversity( 1 ),
    Show Diversity Plot( 0 )
);
obj << Show Diversity Plot( 1 );


```

### [Show Evaluation Plot](#show-evaluation-plot)

**Syntax:** obj \<< Show Evaluation Plot( state=1 )

**Description:** Shows or hides the plot of genetic statistics. On by default.

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 2000 ),
    Show Evaluation Plot( 1 ),

);


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
obj = dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 2000 ),
    Show Evaluation Plot( 0 ),

);
obj << Show Evaluation Plot( 1 );


```

### [Threshold to Make Line Plots](#threshold-to-make-line-plots)

**Syntax:** obj = Marker Simulation(...Threshold to Make Line Plots( number=500 )...)

**Description:** Specifies a maximum number of crosses for which to draw line plots in the reports. Line plots are drawn when the total number of crosses is less than this threshold. "500" by default.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Unthreaded](#unthreaded)

**Syntax:** obj = Marker Simulation(...Unthreaded( state=0|1 )...)

**Description:** Use only the main thread for calculations

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

### [Use Annotation Table](#use-annotation-table)

**Syntax:** obj = Marker Simulation(...Use Annotation Table( state=0|1 )...)

**Description:** Uses the annotation table that contains marker annotation group and position.

```


dtAnno = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree Anno.jmp" );
dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    Use Annotation Table(
        1,
        dtAnno,
        Marker Variables( :Marker ),
        Annotation Group( :Gene ),
        Annotation Position( :Linkage Position ),
        Go
    )
);


```

### [Use Only Markers Found in Predictor Formula](#use-only-markers-found-in-predictor-formula)

**Syntax:** obj = Marker Simulation(...Use Only Markers Found in Predictor Formula( state=0|1 )...)

**Description:** Simulates only those markers found in the predictor formula.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Use Only Markers Found in Predictor Formula( 1 ),
    Unthreaded( 1 ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );

//Hide and Exclude Rows
dt << Clear Select << Clear Row States;
dt << Select Where( :Father == 0 & :Mother == 0 & Row() <= 100 );
dt << Invert Row Selection << Exclude;
dt << Clear Select;

//Run platform
dt << Marker Simulation(
    Marker( Column Group( "Markers" ) ),
    Predictor Formula(
        :Pred Formula Trait1, :Pred Formula Trait2, :Pred Formula Trait3,
        :Pred Formula Trait4, :"Probability( Disease Status=1 )"n
    ),
    Cross( :Sex ),
    Ploidy( 2 ),
    Number of Generations( 2 ),
    Number of Individuals per Cross( 10 ),
    Set Random Seed( 12345 ),
    Threshold to Make Line Plots( 1000 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Marker Simulation(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Marker Statistics](#marker-statistics)

## [Associated Constructors](#associated-constructors)

### [Marker Statistics](#marker-statistics_1)

**Syntax:** Marker Statistics( Marker( columns ), With Marker( columns ) )

**Description:** Performs analysis on genetic marker data to compute measures such as minor allele frequency, Hardy-Weinberg equilibrium, and linkage disequilibrium.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** For each level of the specified column, analyzes and presents the results in separate tables and reports.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ), By( :Sex ) );


```

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column(s) )

**Description:** Analyzes the rows assigned to each level of the specified column separately. All results are presented in a single table and report.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Grouping( :Sex )
);


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( column(s) )

**Description:** Specifies columns that contain genetic markers.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );


```

### [With Marker](#with-marker)

**Syntax:** obj \<< With Marker( column(s) )

**Description:** Specifies columns that contain genetic markers for pairwise linkage disequilibrium estimation with columns of genetic markers specified in Markers.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );


```

## [Item Messages](#item-messages)

### [Counts Table](#counts-table)

**Syntax:** obj \<< Counts Table( state=1 )

**Description:** Shows or hides the table of counts by genotype levels. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Counts Table( 1 )
);
obj << Counts Table( 0 );


```

### [LD Decay Plot](#ld-decay-plot)

**Syntax:** obj \<< LD Decay Plot( state=1 )

**Description:** Shows or hides the LD Decay Plot. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 )
);
obj << LD Decay Plot( 1 );


```

### [Levels Table](#levels-table)

**Syntax:** obj \<< Levels Table( state=1 )

**Description:** Shows or hides the table of genotype levels. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Levels Table( 1 )
);
obj << Levels Table( 0 );


```

### [Marker Format](#marker-format)

**Syntax:** obj = Marker Statistics(...Marker Format( "Numeric"|"Single-Character"|"Character"|"Single-Code Nucleotide"|"Nucleotide"="Numeric" )...)

**Description:** Provides options for choosing the format of genotypes: Single-Character (A, B, H), Single-Code Nucleotide (IUPAC: A,C,G,T,R,Y,S,W,K,M,+,0,-,N), Nucleotide (AA, CC, GG, TT, AC, AT, and son on), Numeric (0, 1, 2, ..., p) and Character (ApBp or Ap/Bp). Both Numeric and Character formats handle genotype with p-ploidy. "Numeric" by default.

### [PValue Plot](#pvalue-plot)

**Syntax:** obj \<< PValue Plot( state=1 )

**Description:** Shows or hides the PValues Plot. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << PValue Plot( 0 );


```

### [PValues Table on Launch](#pvalues-table-on-launch)

**Syntax:** obj = Marker Statistics(...PValues Table on Launch( state=0 )...)

**Description:** Specifies whether to create a PValues data table when the platform launches. "0" by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    PValues Table on Launch( 1 ),
    Ploidy( 2 )
);


```

### [Ploidy](#ploidy)

**Syntax:** obj = Marker Statistics(...Ploidy( number=2 )...)

**Description:** Specifies a positive even number that indicates the ploidy level. "2" by default.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 )
);


```

### [Recode Marker](#recode-marker)

**Syntax:** obj \<< Recode Marker

**Description:** Recodes all selected marker columns in the original data table by switching minor and major alleles.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    PValues Table on Launch( 1 )
);
obj << Select Where( Marker Annotation Position == 11 );
obj << Recode Marker;


```

### [Result Table](#result-table)

**Syntax:** obj \<< Result Table( state=1 )

**Description:** Show the table of results On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 )
);
obj << Result Table( 0 );


```

### [Save Counts Table](#save-counts-table)

**Syntax:** obj \<< Save Counts Table

**Description:** Saves the counts to a data table

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    PValues Table on Launch( 1 )
);
Show( obj << Save Counts Table );


```

### [Save Levels Table](#save-levels-table)

**Syntax:** obj \<< Save Levels Table

**Description:** Saves the levels to a data table

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    PValues Table on Launch( 1 )
);
Show( obj << Save Levels Table );


```

### [Save Proportion of Missing Markers](#save-proportion-of-missing-markers)

**Syntax:** obj \<< Save Proportion of Missing Markers

**Description:** Adds a column to the original data table that contains the proportion of missing genotypes

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Save Proportion of Missing Markers
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 )
);
obj << Save Proportion of Missing Markers;


```

### [Save Result Table](#save-result-table)

**Syntax:** obj \<< Save Result Table

**Description:** Saves the results to a data table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Save Result Table
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    With Marker( Column Group( "Markers" ) ),
    Ploidy( 2 )
);
Show( obj << Save Result Table );


```

### [Select Columns](#select-columns)

**Syntax:** obj \<< Select Columns

**Description:** Selects columns in the original data table that correspond to selected rows in the Result Table.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    PValues Table on Launch( 1 )
);
obj << Select Where( Minor Allele Frequency >= 0.05 );
obj << Select Columns;


```

### [Select Where](#select-where)

**Syntax:** obj \<< Select Where

**Description:** Selects items in the report table that correspond to a particular condition.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    PValues Table on Launch( 1 )
);
obj << Select Where( Minor Allele Frequency >= 0.05 );


```

### [Select and Recode Marker](#select-and-recode-marker)

**Syntax:** obj \<< Select and Recode Marker

**Description:** Selects and Recodes marker columns in the original data table by switching minor and major alleles.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    PValues Table on Launch( 1 )
);
obj << Select and Recode Marker( Marker Annotation Position == 11 );


```

### [Unthreaded](#unthreaded)

**Syntax:** obj = Marker Statistics(...Unthreaded( state=0|1 )...)

**Description:** Use only the main thread for calculations

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    Ploidy( 2 ),
    Unthreaded( 1 )
);


```

### [Use Annotation Table](#use-annotation-table)

**Syntax:** obj = Marker Statistics(...Use Annotation Table( state=0|1 )...)

**Description:** Uses the annotation table that contains marker annotation group and position.

```

dt1 = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt2 = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree Anno.jmp" );
dt1 << Marker Statistics(
    Marker( Column Group( "Markers" ) ),
    Use Annotation Table(
        1,
        dt2,
        Marker Variables( :Marker ),
        Annotation Group( :Gene ),
        Annotation Position( :Physical Position ),
        Go
    ),
    Ploidy( 2 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Life Sciences/Genotypes Pedigree.jmp" );
dt << Marker Statistics( Marker( Column Group( "Markers" ) ), Ploidy( 2 ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Marker Statistics(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Matched Pairs](#matched-pairs)

## [Associated Constructors](#associated-constructors)

### [Matched Pairs](#matched-pairs_1)

**Syntax:** Matched Pairs( Y( columns ), X( column ) )

**Description:** Compares the means of matched sets of variables using paired t tests or simple repeated measures analysis to account for correlation between responses.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ), Freq( :_freqcol ) );


```

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column )

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );


```

### [Paired Response](#paired-response)

**Syntax:** obj \<< Paired Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ), Weight( :_weightcol ) );


```

### [X](#x)

**Syntax:** obj \<< X( column )

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );


```

## [Item Messages](#item-messages)

### [Bland Altman Analysis](#bland-altman-analysis)

**Syntax:** obj \<< Bland Altman Analysis( state=0|1 )

**Description:** Shows or hides the Bland-Altman analysis. This analysis is a method comparison technique that is used to compare two measurements of the same variable.

```

dt = Open( "$SAMPLE_DATA/Method Comparison.jmp" );
obj = dt << Matched Pairs( Y( :Standard, :Method 1, :Method 2 ) );
obj << Bland Altman Analysis( 1 );


```

### [Bland Altman Percent Analysis](#bland-altman-percent-analysis)

**Syntax:** obj \<< Bland Altman Percent Analysis( state=0|1 )

**Description:** Shows or hides the Bland-Altman percent analysis.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Method Comparison.jmp" );
obj = dt << Matched Pairs( Y( :Standard, :Method 1, :Method 2 ) );
obj << Bland Altman Percent Analysis( 1 );


```

### [Dif Statistics](#dif-statistics)

**Syntax:** obj \<< Dif Statistics( state=0|1 )

**Description:** Shows or hides the difference statistics. On by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Dif Statistics( 1 );


```

### [Equivalence Tests](#equivalence-tests)

**Syntax:** obj \<< Equivalence Tests

**JMP Version Added:** 18

### [Percent Dif Statistics](#percent-dif-statistics)

**Syntax:** obj \<< Percent Dif Statistics( state=0|1 )

**Description:** Shows or hides the percent difference statistics.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Percent Dif Statistics( 1 );


```

### [Plot Dif By Mean](#plot-dif-by-mean)

**Syntax:** obj \<< Plot Dif By Mean( state=0|1 )

**Description:** Shows or hides the plot of the paired differences by paired means. On by default.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Plot Dif by Mean( 1 );


```

### [Plot Dif By Row](#plot-dif-by-row)

**Syntax:** obj \<< Plot Dif By Row( state=0|1 )

**Description:** Shows or hides the plot of paired differences by row number.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Plot Dif by Row( 1 );


```

### [Plot Percent Dif by Mean](#plot-percent-dif-by-mean)

**Syntax:** obj \<< Plot Percent Dif by Mean( state=0|1 )

**Description:** Shows or hides a plot of percent difference by mean.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Plot Percent Dif by Mean( 1 );


```

### [Plot Percent Dif by Row](#plot-percent-dif-by-row)

**Syntax:** obj \<< Plot Percent Dif by Row( state=0|1 )

**Description:** Shows or hides a plot of percent difference by row.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Plot Percent Dif by Row( 1 );


```

### [Reference Frame](#reference-frame)

**Syntax:** obj \<< Reference Frame( state=0|1 )

**Description:** Shows or hides the reference frame on the Plot Dif by Mean plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Reference Frame( 1 );


```

### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj \<< Set Alpha Level( "0.01"|"0.05"|"0.10"|"0.50"|"Other…" )

**Description:** Changes the alpha level used in the analyses. Affects the confidence intervals both in the report and on the plot.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Set Alpha Level( 0.1 );


```

### [Set α Level](#set-level)

**Syntax:** obj \<< Set α Level( "0.01"|"0.05"|"0.10"|"0.50"|"Other…" )

**Description:** Changes the alpha level used in the analyses. Affects the confidence intervals both in the report and on the plot.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Set Alpha Level( 0.1 );


```

### [Sign Test](#sign-test)

**Syntax:** obj \<< Sign Test( state=0|1 )

**Description:** Shows or hides the Sign test. This is a nonparametric version of the paired t-test.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Sign Test( 1 );


```

### [Wilcoxon Signed Rank](#wilcoxon-signed-rank)

**Syntax:** obj \<< Wilcoxon Signed Rank( state=0|1 )

**Description:** Shows or hides the Wilcoxon Signed Rank test. This is a nonparametric version of the paired t-test.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Wilcoxon Signed Rank( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Matched Pairs(
    X( :Dose ),
    Y( :BP 8M, :BP 8W ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
obj = dt << Matched Pairs( X( :Dose ), Y( :BP 8M, :BP 8W ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Matched Pairs(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [MaxDiff](#maxdiff)

## [Associated Constructors](#associated-constructors)

### [MaxDiff](#maxdiff_1)

**Syntax:** MaxDiff( Profile DataTable( data table ), Profile ID( column ), Profile Effects( column(s) ), \<Response Data Table( data table )>, \<Subject Data Table( data table )>, \<Response Profile ID Chosen( column )>, \<Response Subject ID( column)>, \<Response Grouping( column(s) )>, \<Response Profile ID Choices( column(s) )>, \<Profile Grouping( column(s) )>, \<Subject Subject ID( column )>, \<Subject Effects( column(s) )> )

**Description:** Creates a design to find the combination of product attributes that customers most prefer and least prefer.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

## [Columns](#columns)

### [Choice Set ID](#choice-set-id)

**Syntax:** Choice( Choice Set ID( column ), ... )

**Description:** A column that identifies the choice set that was presented to the subject for a given preference determination in the one data table situation.

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Profile Effects](#profile-effects)

**Syntax:** obj = MaxDiff(...\<Profile Effects( column )>...)

**Description:** One or more columns that contain the effect or factor values in the profile data table.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Profile Grouping](#profile-grouping)

**Syntax:** Choice( Profile Grouping( column(s) ), ... )

**Description:** A column which, when used with the Profile ID column, uniquely designates each choice set.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Profile ID](#profile-id)

**Syntax:** Choice( Profile ID( column ), ... )

**Description:** A column that contains the ID in the profile data table.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Response Best Option](#response-best-option)

**Syntax:** MaxDiff( Response Best Option( column ), ... )

**Description:** A column in the response data table that contains the Profile ID of the profile that the study participant designated as Best.

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Response Freq](#response-freq)

**Syntax:** Choice( Response Freq( column ), ... )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Response Grouping](#response-grouping)

**Syntax:** Choice( Response Grouping( column(s) ), ... )

**Description:** A column which, when used with the Profile ID Chosen column, uniquely designates each choice set.

```

Open( "$Sample_Data/Laptop Profile.jmp" );
Open( "$Sample_Data/Laptop Runs.jmp" );
Choice(
    Response Data Table( Data Table( "Laptop Runs" ) ),
    Profile DataTable( Data Table( "Laptop Profile" ) ),
    Response Grouping( :Survey, :Choice Set ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :Choice ID ),
    Profile Grouping( :Survey, :Choice Set ),
    Profile Effects( :Hard Disk, :Speed, :Battery Life, :Price ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    Response Profile ID Chosen( :Response ),
    Likelihood Ratio Tests( 1 ),
    Willingness to Pay(
        Hard Disk( Feature Factor, "40 GB" ),
        Speed( Feature Factor, "1.5 GHz" ),
        Battery Life( Feature Factor, "4 hours" ),
        Price( Price Factor, 1000 )
    )
);


```

### [Response Profile ID Choices](#response-profile-id-choices)

**Syntax:** Choice( Response Profile ID Choice( columns ), ... )

**Description:** At least two columns that contain the possible choices available as responses.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Response Subject ID](#response-subject-id)

**Syntax:** Choice( Response Subject ID( column ), ... )

**Description:** A column that identifies the study participant in the response data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Response Weight](#response-weight)

**Syntax:** Choice( Response Weight( column ), ... )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Response Worst Option](#response-worst-option)

**Syntax:** MaxDiff( Response Worst Option( column ), ... )

**Description:** A column in the response data table that contains the Profile ID of the profile that the study participant designated as Worst.

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Subject Effects](#subject-effects)

**Syntax:** obj = MaxDiff(...\<Subject Effects( column )>...)

**Description:** One or more columns that contain the effect or factor values in the subject data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Subject ID](#subject-id)

**Syntax:** Choice( Subject ID( column ), ... )

**Description:** A column that identifies the study participant in the subject data table or in the one data table situation.

```

dt = Open( "$SAMPLE_DATA/Pizza Combined.jmp" );
obj = Choice(
    One Table( 1 ),
    Subject ID( :Subject ),
    Choice Set ID( :Trial ),
    Profile ID( :Indicator ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

### [Subject Subject ID](#subject-subject-id)

**Syntax:** Choice( Subject Subject ID( column ), ... )

**Description:** A column that identifies the study participant in the subject data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

## [Item Messages](#item-messages)

### [All Levels Comparison Report](#all-levels-comparison-report)

**Syntax:** obj \<< All Levels Comparison Report( state=0|1 )

**Description:** Compares all levels of a single MaxDiff choice model.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << All Levels Comparison Report( 1 );


```

### [Comparisons](#comparisons)

**Syntax:** obj \<< Comparisons( {term1(value1a),term2(value2a),...},{term1(value1b),term2(value2b),...} )

**Description:** Performs comparisons between specific alternative choice profiles. Enables you to specify the factors and the values that you want to compare.

### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< Confidence Intervals( state=0|1, <alpha> )

**Description:** Shows or hides (1-alpha)% confidence intervals for each parameter in the Parameter Estimates report.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
Report( obj )["Parameter Estimates"] << Close( 0 );
obj << Confidence Intervals( 1, 0.01 );


```

### [Confidence Limits](#confidence-limits)

**Syntax:** obj \<< Confidence Limits( state=0|1, <alpha> )

**Description:** Shows or hides confidence limits for each parameter in the Bayesian Parameter Estimates report. The limits are constructed based on the 2.5 and 97.5 quantiles of the posterior distribution.

**JMP Version Added:** 14

### [Convergence Criterion](#convergence-criterion)

**Syntax:** obj = MaxDiff(...Convergence Criterion( number )...)

**Description:** Sets the acceptable criterion for convergence when estimating the parameters.

### [Correlation of Estimates](#correlation-of-estimates)

**Syntax:** obj \<< Correlation of Estimates( state=0|1 )

**Description:** Shows or hides the correlation matrix for the parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Correlation of Estimates( 1 );


```

### [Effect Marginals](#effect-marginals)

**Syntax:** obj \<< Effect Marginals( state=0|1 )

**Description:** Shows or hides marginal probabilities and marginal utilities for each main effect in the model. The marginal probability is the probability that an individual selects attribute A over B with all other attributes set to their mean or default levels.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Effect Marginals( 1 );


```

### [Firth Bias-Adjusted Estimates](#firth-bias-adjusted-estimates)

**Syntax:** obj = MaxDiff(...Firth Bias-Adjusted Estimates( state=0|1 )...)

**Description:** Computes bias-corrected maximum likelihood estimates (MLEs) that produce better estimates and tests than MLEs without bias correction. These estimates also improve separation problems that tend to occur in logistic models. On by default.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);
Report( obj )["Parameter Estimates"] << Close( 0 );


```

### [Hierarchical Bayes](#hierarchical-bayes)

**Syntax:** obj = MaxDiff(...Hierarchical Bayes( state=0|1 )...)

**Description:** Uses a Bayesian approach to estimate subject-specific parameters.

### [Joint Factor Tests](#joint-factor-tests)

**Syntax:** obj \<< Joint Factor Tests( state=0|1 )

**Description:** Tests each factor in the model by constructing a likelihood ratio test for all the effects involving that factor. Subject Data Table is required for this option when an interaction is not present in the model.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Joint Factor Tests( 1 );


```

### [Likelihood Ratio Tests](#likelihood-ratio-tests)

**Syntax:** obj \<< Likelihood Ratio Tests( state=0|1 )

**Description:** Performs likelihood ratio tests for each effect in the model. On by default for models that converge in less than five seconds.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Likelihood Ratio Tests( 1 );


```

### [Model Dialog](#model-dialog)

**Syntax:** obj \<< Model Dialog

**Description:** Opens the Model Dialog window.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Model Dialog;


```

### [Number of Bayesian Iterations](#number-of-bayesian-iterations)

**Syntax:** obj = MaxDiff(...Number of Bayesian Iterations( number )...)

### [Number of Burn In Iterations](#number-of-burn-in-iterations)

**Syntax:** obj \<< Number of Burn In Iterations( number )

### [One Table](#one-table)

**Syntax:** obj = MaxDiff(...One Table...)

**Description:** Specifies that the data are in stacked format in one data table.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Profile DataTable](#profile-datatable)

**Syntax:** Choice( Profile Data Table( table ), ... )

**Description:** Identifies the profile data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Remove Subject Effects](#remove-subject-effects)

**Syntax:** obj = MaxDiff(...Remove Subject Effects...)

### [Response Data Table](#response-data-table)

**Syntax:** Choice( Response Data Table( table ), ... )

**Description:** Identifies the response data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Response Value Indicates Best](#response-value-indicates-best)

**Syntax:** MaxDiff( Response Value Indicates Best( value ), ... )

**Description:** Specifies the value that represents the Profile ID of the profile that that study participant designated as Best.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Response Value Indicates Worst](#response-value-indicates-worst)

**Syntax:** MaxDiff( Response Value Indicates Worst( value ), ... )

**Description:** Specifies the value that represents the Profile ID of the profile that that study participant designated as Worst.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);


```

### [Save Bayes Chain](#save-bayes-chain)

**Syntax:** obj \<< Save Bayes Chain

### [Save Gradients by Subject](#save-gradients-by-subject)

**Syntax:** obj \<< Save Gradients by Subject

**Description:** Creates a new table with a row for each subject containing the average steps on each parameter.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Save Gradients by Subject;


```

### [Save Subject Estimates](#save-subject-estimates)

**Syntax:** obj \<< Save Subject Estimates

### [Save Utility Formula](#save-utility-formula)

**Syntax:** obj \<< Save Utility Formula

**Description:** Creates a new column in the profile data table with a formula for the linear model that is estimated.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Save Utility Formula;


```

### [Show MLE Parameter Estimates](#show-mle-parameter-estimates)

**Syntax:** obj \<< Show MLE Parameter Estimates( state=0|1 )

**Description:** Shows maximum likelihood estimates with Bayes parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    Hierarchical Bayes( 1 )
);
obj << Show MLE Parameter Estimates( 1 );


```

### [Subject DataTable](#subject-datatable)

**Syntax:** Choice( Subject Data Table( table ), ... )

**Description:** Identifies the subject data table.

**Choice Example**

```


dt1 = Open( "$SAMPLE_DATA/Pizza Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Pizza Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Pizza Subjects.jmp" );
obj = Choice(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Profile ID Chosen( :Choice ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices( :Choice1, :Choice2 ),
    Profile ID( :ID ),
    Profile Effects( :Crust, :Cheese, :Topping ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender )
);


```

**MaxDiff Example**

```


dt1 = Open( "$SAMPLE_DATA/Potato Chip Profiles.jmp" );
dt2 = Open( "$SAMPLE_DATA/Potato Chip Responses.jmp" );
dt3 = Open( "$SAMPLE_DATA/Potato Chip Subjects.jmp" );
obj = MaxDiff(
    Response Data Table( dt2 ),
    Profile DataTable( dt1 ),
    Subject DataTable( dt3 ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices( :Choice 1, :Choice 2, :Choice 3 ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects( :Citizenship, :Gender ),
    Response Best Option( :Best Profile ),
    Response Worst Option( :Worst Profile )
);


```

### [Use Adaptive Bayes](#use-adaptive-bayes)

**Syntax:** obj \<< Use Adaptive Bayes( state=0|1 )

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Potato Chip Combined.jmp" );
obj = dt << MaxDiff(
    One Table( 1 ),
    Subject ID( :Respondent ),
    Choice Set ID( :Choice Set ID ),
    Profile ID( :Response ),
    Profile Grouping( :Survey ID ),
    Profile Effects( :Profile ID ),
    Response Value Indicates Best( 1 ),
    Response Value Indicates Worst( -1 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = MaxDiff(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Mixture Profiler](#mixture-profiler)

## [Associated Constructors](#associated-constructors)

### [Mixture Profiler](#mixture-profiler_1)

**Syntax:** Mixture Profiler( Y( column1, column2, ... ) )

**Description:** Produces an interactive ternary plot that enables you to explore the contours of the saved prediction formulas for mixture models with three or more factors.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );


```

## [Columns](#columns)

### [Noise Factors](#noise-factors)

**Syntax:** obj = Mixture Profiler(...\<Noise Factors( column(s) )>...)

**Description:** Specifies noise factors, which must be columns that are ingredients to the formula columns. Noise factors are used to study robustness (or flatness) with respect to transmitted variation from these factors. The resulting profiler includes derivatives of the formulas with respect to the noise factors.

**Contour Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Custom Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Mixture Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Noise Factors( :p1 ) );


```

**Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

### [Prediction Formula](#prediction-formula)

**Syntax:** obj = Mixture Profiler(...Prediction Formula( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );


```

### [Y](#y)

**Syntax:** obj = Mixture Profiler(...Y( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );


```

## [Item Messages](#item-messages)

### [Animation](#animation)

**Syntax:** obj \<< Animation( \<Tour Type( "Sequential"|("Single Factor",factorname)|"Random"|"Data Sequential"|"Data Random" )>, \<Speed(ticks)>, <Go>, <Stop> )

**Description:** Starts or stops the animation of the profiler. You can also specify how the animation cycles through factor combinations.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Animation( Tour Type( "Sequential" ), Go );
Wait( 3 );
obj << Animation( "Stop" );


```

### [Append Settings to Table](#append-settings-to-table)

**Syntax:** obj \<< Append Settings to Table

**Description:** Saves the settings of the current profiler as a new row at the end of the data table.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Append Settings to Table;


```

### [Broadcast Factor Settings](#broadcast-factor-settings)

**Syntax:** obj \<< Broadcast Factor Settings

**Description:** Sends the factor settings for the current profiler to all other profilers. This option does not link the profilers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 ),
    Term Value(
        SILICA( 1.75, Lock( 0 ), Show( 1 ) ),
        SILANE( 45.2, Lock( 0 ), Show( 1 ) ),
        SULFUR( 2.45, Lock( 0 ), Show( 1 ) )
    )
);
obj << Contour Profiler( 1 );
Wait( 1 );
obj << Broadcast Factor Settings;


```

### [Contour Grid](#contour-grid)

**Syntax:** obj \<< Contour Grid( minimum, maximum, increment, y column )

**Description:** Draws a contour grid on the mixture profiler. The grid is based on the specified intervals.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 1 );
obj << Contour Grid( 5, 20, 3, :PredFormula Y );


```

### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the Contour Profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Contour Profiler( 1 );


```

### [Contour Value](#contour-value)

**Syntax:** obj \<< Contour Value( y1( number, \<Min( number )>, \<Max( number )>), y2(...) )

**Description:** Sets specific contour values for responses in the mixture profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Contour Value( Pred Formula Y( 18.167, Min( 5 ), Max( 20 ) ) );


```

### [Copy Settings Script](#copy-settings-script)

**Syntax:** obj \<< Copy Settings Script

**Description:** Copies the current factor settings to the clipboard. The settings can then be pasted into another profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Custom Profiler](#custom-profiler)

**Syntax:** obj \<< Custom Profiler( state=0|1 )

**Description:** Shows or hides the Custom Profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Custom Profiler( 1 );


```

### [Formulas for OPTMODEL](#formulas-for-optmodel)

**Syntax:** obj \<< Formulas for OPTMODEL

**Description:** Saves the prediction formulas from the model in a new file as SAS statements for PROC OPTMODEL.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Formulas for OPTMODEL;


```

### [Get Constraints](#get-constraints)

**Syntax:** obj \<< Get Constraints

**Description:** Returns a list of factor constraints.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Profiler(
    Y( :Pred Formula Y ),
    Profiler( 1, Profile at Boundary( "Stop at Boundaries" ), )
);
obj << Get Constraints;


```

### [Get Factor Settings](#get-factor-settings)

**Syntax:** obj \<< Get Factor Settings

**Description:** Returns the current factor settings as a list.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Get Factor Settings;


```

### [Get Factor Settings Script](#get-factor-settings-script)

**Syntax:** obj \<< Get Factor Settings Script

**Description:** Returns the current factor settings as an expression that can be used in a script.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Get Factor Settings Script;


```

### [Get Simulator](#get-simulator)

**Syntax:** obj \<< Get Simulator

**Description:** Returns a reference to the Simulator.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ), SILANE << Fixed( 50 ),
        SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << Add Random Noise( 1 ),
        Pred Formula HARDNESS << Add Random Weighted Noise( 1 )
    )
);
obj2 = obj << Get Simulator;
obj2 << Simulation Experiment;


```

### [Left Factor](#left-factor)

**Syntax:** obj \<< Left Factor( column )

**Description:** Specifies the factor that is shown on the left side of the ternary graph.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 1 );
obj << Left Factor( :p1 );


```

### [Link Profilers](#link-profilers)

**Syntax:** obj \<< Link Profilers( state=0|1 )

**Description:** Links all the profilers in a single report together, so that a change in a factor in one profiler causes that factor to change to that value in all other profilers.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Prediction Profiler( 1 );
obj << Contour Profiler( 1 );
obj << Link Profilers( 1 );
Wait( 1 );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );


```

### [Number of Grid Points](#number-of-grid-points)

**Syntax:** obj = Mixture Profiler(...Number of Grid Points( number )...)

**Description:** Specifies the number of grid points on each of the three axes to use for the evaluation of the contours.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Number of Grid Points( 100 ) );
Wait( 1 );
obj << Number of Grid Points( 140 );


```

### [Paste Settings Script](#paste-settings-script)

**Syntax:** obj \<< Paste Settings Script

**Description:** Pastes the profiler settings from the clipboard to a profiler in another report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Predict for Another Table](#predict-for-another-table)

**Syntax:** obj \<< Predict for Another Table( <data table> )

**Description:** Adds prediction columns to a specified data table, using the factors in that table. This option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
dt2 = dt << Subset(
    All rows,
    columns( :SILICA, :SILANE, :SULFUR ),
    Output Table( "Subset" )
);
obj << Predict For Another Table( dt2 );


```

### [Prediction Profiler](#prediction-profiler)

**Syntax:** obj \<< Prediction Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Prediction Profiler( 1 );


```

### [Remember Settings](#remember-settings)

**Syntax:** obj \<< Remember Settings

**Description:** Adds an outline node to the report with the values of the factor settings.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Remember Settings;


```

### [Remove Contour Grid](#remove-contour-grid)

**Syntax:** obj \<< Remove Contour Grid

**Description:** Removes the contour grid that is overlaid on the mixture profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Contour Grid( 5, 20, 3, :PredFormula Y );
Wait( 1 );
obj << Remove Contour Grid;


```

### [Reset](#reset)

**Syntax:** obj \<< Reset

**Description:** Updates the predictions at the current values.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = Mixture Profiler( Y( :Pred Formula Y ) );
obj << Term Value( :p1( 0.804905315083495 ), :p2( 0.0286246849165042 ), :p3( 0.15647 ) );
obj << Reset;


```

### [Right Factor](#right-factor)

**Syntax:** obj \<< Right Factor( column )

**Description:** Specifies the factor that is shown on the right side of the ternary graph.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 1 );
obj << Right Factor( :p2 );


```

### [Save Expanded Formulas](#save-expanded-formulas)

**Syntax:** obj \<< Save Expanded Formulas

**Description:** Saves a new formula column to the data table. The new column contains resolved formula references within the formulas used as Y variables to see the underlying variables. This is available only after the Expand Intermediate Formulas option is selected in the launch window or the Expand message is specified in the Profiler script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Profiler( Y( :GP Fit, :NL Fit, :Difference ), Expand, Contour Profiler( 1 ) );
obj << Save Expanded Formulas;


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( Function( {arguments}, \<{locals}>, expr ) )

**Description:** Sets a script that is run each time a factor changes.

```

ProfileCallbackLog = Function( {arg}, Show( arg ) );
dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Set Script( ProfileCallbackLog );
obj << Term Value( :Silica( 1 ) );


```

### [Set to Data in Row](#set-to-data-in-row)

**Syntax:** obj \<< Set to Data in Row( row number )

**Description:** Assigns the values of a data table row to the X variables in the profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 2 );
obj << Set to Data in Row( 4 );


```

### [Show Constraints](#show-constraints)

**Syntax:** obj \<< Show Constraints( state=0|1 )

**Description:** Shows or hides the shading that results from any constraints on the factors. On by default.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Property( "Constraint", {:p2 + :p3 <= :p1} );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 1 );
obj << Show Constraints( 0 );


```

### [Show Current Value](#show-current-value)

**Syntax:** obj \<< Show Current Value( state=0|1 )

**Description:** Shows or hides a three-way crosshair at the current mixture values on the ternary graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Show Current Value( 0 ) );
Wait( 1 );
obj << Show Current Value( 1 );


```

### [Show Formulas](#show-formulas)

**Syntax:** obj \<< Show Formulas

**Description:** Opens a script window that contains JSL for all formulas that are being profiled.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Show Formulas;


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the individual points on the ternary graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Show Points( 0 ) );
Wait( 1 );
obj << Show Points( 1 );


```

### [Specify Factor Values](#specify-factor-values)

**Syntax:** obj \<< Specify Factor Values

**Description:** Opens a window that enables you to specify factor values.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Specify Factor Values;


```

### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides the Surface Profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Surface Profiler( 1 );


```

### [Term Value](#term-value)

**Syntax:** obj \<< Term Value( x1( number, \<Min( number )>, \<Max( number )> ),x2( number \<Min( number )>, \<Max( number )> ), ... )

**Description:** Sets specific term values for the factors in the mixture profiler.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 1 );
obj << Term Value( :p1( 0.804905315083495 ), :p2( 0.0386246849165042 ), :p3( 0.15647 ) );


```

### [Top Factor](#top-factor)

**Syntax:** obj \<< Top Factor( column )

**Description:** Specifies the factor that is shown on the top side of the ternary graph.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 1 );
obj << Top Factor( :p3 );


```

### [Unthreaded](#unthreaded)

**Syntax:** obj \<< Unthreaded( state=0|1 )

**Description:** To suppress any multithreading in evaluating the profile traces, the contour grid, and the optimizer trips.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Unthreaded( 1 );
obj << Maximize Desirability;


```

### [Up Dots](#up-dots)

**Syntax:** obj \<< Up Dots( state=0|1 )

**Description:** Shows or hides dots next to the contour lines. These dots indicate the upward direction of the response. On by default.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
Wait( 1 );
obj << Up Dots( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Mixture Profiler(
    Y( :Pred Formula Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Mixture Profiler(
    Y( :Pred Formula Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Model Comparison](#model-comparison)

## [Associated Constructors](#associated-constructors)

### [Model Comparison](#model-comparison_1)

**Syntax:** Model Comparison( Predictors( columns ), Group( column ) )

**Description:** Compares performance across models using prediction formula columns.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();


```

## [Columns](#columns)

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    Freq( :_freqcol )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    Freq( :_freqcol )
);
obj = Model Comparison();


```

### [Group](#group)

**Syntax:** obj \<< Group( column(s) )

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();


```

### [Predictors](#predictors)

**Syntax:** obj \<< Predictors( column(s) )

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    Weight( :_weightcol )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    Weight( :_weightcol )
);
obj = Model Comparison();


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();


```

## [Item Messages](#item-messages)

### [AUC Comparison](#auc-comparison)

**Syntax:** obj \<< AUC Comparison( state=0|1 )

**Description:** Shows or hides a comparison of the area under the ROC curve (AUC) from each model.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :sex ),
    Effects( :height ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
dt << Fit Model(
    Y( :sex ),
    Effects( :age ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
Model Comparison( AUC Comparison( 1 ) );


```

### [Confusion Matrix](#confusion-matrix)

**Syntax:** obj \<< Confusion Matrix( state=0|1 )

**Description:** Shows or hides a crosstabulation matrix of actual and predicted responses.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :sex ),
    Effects( :height ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
dt << Fit Model(
    Y( :sex ),
    Effects( :age ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
Model Comparison( Confusion Matrix( 1 ) );


```

### [Cum Gains Curve](#cum-gains-curve)

**Syntax:** obj \<< Cum Gains Curve( state=0|1 )

**Description:** Shows or hides a plot of cumulative gains curves for each level of the response variable. A cumulative gains curve plots the proportion of a response level that is identified by the model against the proportion of all responses.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :sex ),
    Effects( :height ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
dt << Fit Model(
    Y( :sex ),
    Effects( :age ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
Model Comparison( Cum Gains Curve( 1 ) );


```

### [Decision Threshold](#decision-threshold)

**Syntax:** obj \<< Decision Threshold( state = 0|1, Set Probability Threshold( number ) )

**Description:** Shows or hides the distribution of fitted probabilities and actual versus predicted tables for each model. You can change the probability threshold to explore how different thresholds affect the classification results.

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :sex ),
    Effects( :height ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
dt << Fit Model(
    Y( :sex ),
    Effects( :age ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
Model Comparison( Decision Threshold( 1 ) );


```

### [Lift Curve](#lift-curve)

**Syntax:** obj \<< Lift Curve( state=0|1 )

**Description:** Shows or hides lift curves for each level of the response variable. The curves for the different models are overlaid in the plots.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :sex ),
    Effects( :height ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
dt << Fit Model(
    Y( :sex ),
    Effects( :age ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
Model Comparison( Lift Curve( 1 ) );


```

### [Model Averaging](#model-averaging)

**Syntax:** obj \<< Model Averaging

**Description:** Saves a new prediction column of the average of the predicted probabilities across models. This prediction column often results in a model with better prediction capability than the individual models.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
Model Comparison( Model Averaging );


```

### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides a plot with the actual response values on the vertical axis and the predicted values on the horizontal axis. In good fits, points are near the diagonal. You can see which points are far from the diagonal, look for patterns, and visualize the test.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
Model Comparison( Plot Actual by Predicted( 1 ) );


```

### [Plot Residual by Row](#plot-residual-by-row)

**Syntax:** obj \<< Plot Residual by Row( state=0|1 )

**Description:** Shows or hides a plot with the residuals on the vertical axis and the row number on the horizontal axis.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
Model Comparison( Plot Residual by Row( 1 ) );


```

### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides Precision-Recall Curve plots for each level of the response variable. The curves for the different models are overlaid in the plots.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :sex ),
    Effects( :height ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
dt << Fit Model(
    Y( :sex ),
    Effects( :age ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
Model Comparison( Precision Recall Curve( 1 ) );


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
Model Comparison( Profiler( 1 ) );


```

### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides Receiver Operating Characteristic (ROC) curves for each level of the response variable. The curves for the different models are overlaid in the plots.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :sex ),
    Effects( :height ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
dt << Fit Model(
    Y( :sex ),
    Effects( :age ),
    Target Level( "M" ),
    Personality( "Nominal Logistic" ),
    Run( Save Probability Formula, Close Window )
);
Model Comparison( ROC Curve( 1 ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj = Model Comparison();
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj = Model Comparison();
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Fit Model(
    Y( :weight ),
    Effects( :height ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
dt << Fit Model(
    Y( :weight ),
    Effects( :age ),
    Personality( "Standard Least Squares" ),
    Run( Prediction Formula, Close Window )
);
obj = Model Comparison();
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Model Driven Multivariate Control Chart](#model-driven-multivariate-control-chart)

## [Associated Constructors](#associated-constructors)

### [Model Driven Multivariate Control Chart](#model-driven-multivariate-control-chart_1)

**Syntax:** Model Driven Multivariate Control Chart( Process( columns ) )

**Description:** Creates multivariate control charts based on principal components or partial least squares methods.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Process](#process)

**Syntax:** obj \<< Process( column(s) )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);


```

### [Time ID](#time-id)

**Syntax:** obj \<< Time ID( column )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    Time ID( :Flight Date ),

);


```

## [Item Messages](#item-messages)

### [Alarm Script](#alarm-script)

**Syntax:** Alarm Script(Write("...")|Speak("...")|Mail(address, subject,"...") )

**Description:** Sends a message whenever a point on a control chart fails a given test. The message can be sent to the log, can be spoken, or can be emailed.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    Set Component( 3 ),
    "Historical Data End at Row"(16),
    Normalized DModX Plot,
    Alarm Script(
        Write(
            Substitute(
                    "Out of Control from ^QCNOTES in column ^QCCOL in sample ^QCSAMPLE from the table of ^QCTABLE.",
                "^QCNOTES", qc_notes,
                "^QCCOL", qc_col,
                "^QCSAMPLE", Char( qc_sample ),
                "^QCTABLE", qc_tableName
            ) || " \!N"
        )
    )
);
obj << Show Alarm Report( 1 );


```

### [Change Point Detection](#change-point-detection)

**Syntax:** obj \<< Change Point Detection( state=0|1 )

**Description:** Displays or hides a phase-detection plot of test statistics by row number and a scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Historical.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure )
);
obj << Change Point Detection( 1 );


```

### [Diagnose the Process](#diagnose-the-process)

**Syntax:** obj \<< Diagnose the Process( state=0|1 )

**Description:** Shows or hides diagnostic plots.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    T Square Plot( Contribution Proportion Plot for Selected Samples( {24} ) )
);
obj << Diagnose the Process( 0 );


```

### [Historical Data End at Row](#historical-data-end-at-row)

**Syntax:** obj = Model Driven Multivariate Control Chart(...Historical Data End at Row( number )...)

**Description:** The specified row number splits the observations into historical and current data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    Historical Data End at Row( 16 )
);


```

### [Normalized DModX Plot](#normalized-dmodx-plot)

**Syntax:** obj \<< Normalized DModX Plot( state=0|1 )

**Description:** Shows or hides a plot of the normalized DModX values. DModX measures the distance of each observation to the PCA or PLS model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Normalized DModX Plot( 1 );


```

### [Parallel Coord Plot](#parallel-coord-plot)

**Syntax:** obj \<< Parallel Coord Plot( state=0|1 )

**Description:** Shows or hides a parallel coordinate plot of the variables.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Set Component( 3 ),
    "Historical Data End at Row"(16),
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Parallel Coord Plot( Show Mean( 1 ) );


```

### [Score Plot](#score-plot)

**Syntax:** obj \<< Score Plot( state=0|1 )

**Description:** Shows or hides a score plot of principal components or partial least squares factors.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Score Plot( 1 );


```

### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj \<< Set Alpha Level( "0.01"|"0.05"|"0.10"|"0.50"|"Other…" )

**Description:** Specifies the alpha level that is used to compute the decision limits.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Set Alpha Level( 0.1 );


```

### [Set Component](#set-component)

**Syntax:** obj \<< Set Component( number )

**Description:** Enables you to set the number of components for the T², DModX, and SPE plots.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Set Component( 2 );


```

### [Set α Level](#set-level)

**Syntax:** obj \<< Set α Level( "0.01"|"0.05"|"0.10"|"0.50"|"Other…" )

**Description:** Specifies the alpha level that is used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Set Alpha Level( 0.1 );


```

### [Show Alarm Report](#show-alarm-report)

**Syntax:** obj \<< Show Alarm Report( state=0|1 )

**Description:** Shows or hides the alarm rate report.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    Set Component( 3 ),
    "Historical Data End at Row"(16),
    Normalized DModX Plot
);
obj << Show Alarm Report( 1 );


```

### [Show Excluded Rows](#show-excluded-rows)

**Syntax:** obj \<< Show Excluded Rows( state=0|1 )

**Description:** Shows or hides excluded rows on plots. When this option is selected, excluded rows are included in the count of out of control points, but excluded from numerical calculations. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << Select Rows( 1 :: 5 );
dt << Exclude();
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Show Excluded Rows( 0 );


```

### [Show History Summary Statistics](#show-history-summary-statistics)

**Syntax:** obj \<< Show History Summary Statistics( state=0|1 )

**Description:** Shows or hides summary statistics that contain eigenvalues, principal component loadings, and process variable means and standard deviations. The means and standard deviations are calculated from historical data and are used to compute principal component scores, T square, squared prediction error (SPE), and DModX statistics for the current data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Show History Summary Statistics( 1 );


```

### [Show Monitoring Plots](#show-monitoring-plots)

**Syntax:** obj \<< Show Monitoring Plots( state=0|1 )

**Description:** Shows or hides selected process monitoring plots.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Show Monitoring Plots( 0 );


```

### [Squared Prediction Error Plot](#squared-prediction-error-plot)

**Syntax:** obj \<< Squared Prediction Error Plot( state=0|1 )

**Description:** Shows or hides a plot of the squared prediction error (SPE). SPE measures the sum of squared residuals from the PCA or PLS model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Squared Prediction Error Plot( 1 );


```

### [T² Plot](#t2-plot)

**Syntax:** obj \<< T² Plot( state=0|1 )

**Description:** Shows or hides a plot of the T² statistic. T² measures how far away an observation is from the center of a PCA or PLS model. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << T Square Plot( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Model Driven Multivariate Control Chart(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Model Screening](#model-screening)

## [Associated Constructors](#associated-constructors)

### [Model Screening](#model-screening_1)

**Syntax:** Model Screening( Y( column ), X( columns ) )

**Description:** Fits many different predictive models, so that you can select the best.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Factor](#factor)

**Syntax:** obj \<< Factor( column(s) )

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Freq( :_freqcol )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Weight( :_weightcol )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);


```

## [Item Messages](#item-messages)

### [Add Quadratics](#add-quadratics)

**Syntax:** obj = Model Screening(...Add Quadratics( state=0|1 )...)

**Description:** Adds effects for the squares of continuous variables to linear modeling fits.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :LTG, :BMI, :BP, :Glucose, :HDL ),
    Add Quadratics( 1 )
);


```

### [Add Two Way Interactions](#add-two-way-interactions)

**Syntax:** obj = Model Screening(...Add Two Way Interactions( state=0|1 )...)

**Description:** Adds all two-way interaction effects to linear modeling fits.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :LTG, :BMI, :BP, :Glucose, :HDL ),
    Add Two Way Interactions( 1 )
);


```

### [Additional Methods](#additional-methods)

**Syntax:** obj = Model Screening(...Additional Methods( state=0|1 )...)

**Description:** Calls several additional methods in the Generalized Regression platform in addition to Lasso: Forward Selection, Pruned Forward Selection, Elastic Net, and Ridge.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Additional Methods( 1 )
);


```

### [Boosted Tree](#boosted-tree)

**Syntax:** obj = Model Screening(...Boosted Tree( state=0|1 )...)

**Description:** Builds a decision tree that is a sequence of smaller trees to predict a response. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 1 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 )
);


```

### [Bootstrap Forest](#bootstrap-forest)

**Syntax:** obj = Model Screening(...Bootstrap Forest( state=0|1 )...)

**Description:** Builds a collection of decision trees using random sampling and averages the results to predict a response. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 1 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 )
);


```

### [Cardinality of Predictors](#cardinality-of-predictors)

**Syntax:** obj \<< Cardinality of Predictors( state=0|1 )

**Description:** Shows or hides a report of the number of levels and how many parameters are used in the linear model fit for each categorical predictor.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Equity.jmp" );
Model Screening(
    Y( :BAD ),
    Validation( :Validation ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Neural( 0 ),
    Bootstrap Forest( 0 ),
    Generalized Regression( 0 ),
    Support Vector Machines( 0 ),
    Cardinality of Predictors( 1 )
);


```

### [Decision Threshold](#decision-threshold)

**Syntax:** obj \<< Decision Threshold( state = 0|1, Set Probability Threshold( number ) )

**Description:** Shows or hides the distribution of fitted probabilities and actual versus predicted tables for each model. You can change the probability threshold to explore how different thresholds affect the classification results.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 1 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 1 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 1 ),
    Generalized Regression( 1 ),
    Decision Threshold( 1 )
);


```

### [Decision Tree](#decision-tree)

**Syntax:** obj = Model Screening(...Decision Tree( state=0|1 )...)

**Description:** Builds a decision tree to predict a response. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 1 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 )
);


```

### [Discriminant](#discriminant)

**Syntax:** obj = Model Screening(...Discriminant( state=0|1 )...)

**Description:** Classifies categorical group membership based on continuous variables. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Iris.jmp" );
Make Validation Column( Validation Set( .3 ), Training Set( .7 ), Go );
obj = Model Screening(
    Y( :Species ),
    Validation( :Validation ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Discriminant( 1 ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 0 ),
    Generalized Regression( 0 )
);


```

### [Elapsed Time](#elapsed-time)

**Syntax:** obj \<< Elapsed Time( state=0|1 )

**Description:** Shows or hides a report that contains the total elapsed time that was spent fitting each method.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Elapsed Time( 1 )
);


```

### [Fit Least Squares](#fit-least-squares)

**Syntax:** obj = Model Screening(...Fit Least Squares( state=0|1 )...)

**Description:** Fits a linear regression model for a continuous response. Techniques include regression, analysis of variance, analysis of covariance, mixed models, and analysis of designed experiments. The Emphasis option enables you to specify the report layout. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 1 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 )
);


```

### [Fit Stepwise](#fit-stepwise)

**Syntax:** obj = Model Screening(...Fit Stepwise( state=0|1 )...)

**Description:** Fits stepwise regression models, which facilitate variable selection for standard least squares and ordinal logistic models, as well as nominal logistic models with a binary response. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 1 ),
    Generalized Regression( 0 )
);


```

### [Generalized Regression](#generalized-regression)

**Syntax:** obj = Model Screening(...Generalized Regression( state=0|1 )...)

**Description:** Fits generalized linear models using penalized regression techniques, which help automate variable selection in a way that avoids overfitting. The penalized regression techniques include the lasso, the adaptive lasso, the elastic net, the adaptive elastic net, and ridge regression. The response distributions can accommodate continuous, categorical, count, and time-to-event response data. This is the recommended personality for most regression settings. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 1 )
);


```

### [Informative Missing](#informative-missing)

**Syntax:** obj = Model Screening(...Informative Missing( state=0|1 )...)

**Description:** Enables the informative missing option for all platforms.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Equity.jmp" );
Model Screening(
    Y( :BAD ),
    Validation( :Validation ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Neural( 0 ),
    Informative Missing( 1 )
);


```

### [K Fold Crossvalidation](#k-fold-crossvalidation)

**Syntax:** obj = Model Screening(...K Fold Crossvalidation( state=0|1 )...)

**Description:** Partitions the data randomly into K parts or folds. A model is fit to the data K times, each time with a different fold held out as a crossvalidation set.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    K Fold Crossvalidation( 1 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [K Nearest Neighbors](#k-nearest-neighbors)

**Syntax:** obj = Model Screening(...K Nearest Neighbors( state=0|1 )...)

**Description:** Predicts a response based on the responses of the k nearest neighbors. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 1 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 )
);


```

### [K for K Fold](#k-for-k-fold)

**Syntax:** obj = Model Screening(...K for K Fold( number=5 )...)

**Description:** Specifies the number of folds for K Fold Crossvalidation. The default is 5 and K must be greater than 1. "5" by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    K Fold Crossvalidation( 1 ),
    K for K Fold( 6 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [K for Nested](#k-for-nested)

**Syntax:** obj = Model Screening(...K for Nested( number=5 )...)

**Description:** Specifies the number of folds for Nested Crossvalidation. The default is 5 and K must be greater than 1. "5" by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Nested Crossvalidation( 1 ),
    K for Nested( 3 ),
    L for Nested( 4 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [L for Nested](#l-for-nested)

**Syntax:** obj = Model Screening(...L for Nested( number=4 )...)

**Description:** Specifies the number of inner folds for Nested Crossvalidation. The default is 4 and L must be greater than 1. "4" by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Nested Crossvalidation( 1 ),
    K for Nested( 5 ),
    L for Nested( 4 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [Log Methods](#log-methods)

**Syntax:** obj = Model Screening(...Log Methods( state=0|1 )...)

### [Logistic Regression](#logistic-regression)

**Syntax:** obj = Model Screening(...Logistic Regression( state=0|1 )...)

**Description:** Fits a logistic regression model of nominal response categories for both continuous and categorical predictors. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 1 ),
    Generalized Regression( 0 )
);


```

### [Model NParm Limit](#model-nparm-limit)

**Syntax:** obj \<< Model NParm Limit( number=450 )

**Description:** Specifies the number of parameters above which the modeling platforms are not run. "450" by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Add Two Way Interactions( 1 ),
    Add Quadratics( 1 ),
    Model NParm Limit( 40 ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Fit Least Squares( 1 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 0 ),
    Generalized Regression( 0 )
);


```

### [Naive Bayes](#naive-bayes)

**Syntax:** obj = Model Screening(...Naive Bayes( state=0|1 )...)

**Description:** Predicts group membership for a categorical variable.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 1 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 0 ),
    Generalized Regression( 0 ), 

);


```

### [Nested Crossvalidation](#nested-crossvalidation)

**Syntax:** obj = Model Screening(...Nested Crossvalidation( state=0|1 )...)

**Description:** Partitions the data randomly into K equal parts and then further partitions all but one of those parts into L equal parts.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Nested Crossvalidation( 1 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [Neural](#neural)

**Syntax:** obj = Model Screening(...Neural( state=0|1 )...)

**Description:** Predicts one or more response variables using a flexible function of the input variables. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 1 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 )
);


```

### [Partial Least Squares](#partial-least-squares)

**Syntax:** obj = Model Screening(...Partial Least Squares( state=0|1 )...)

**Description:** Fits a model to one or more response variables using latent factors. This permits models to be fit when explanatory variables are highly correlated, or when there are more explanatory variables than there are observations.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 ),
    Partial Least Squares( 1 )
);


```

### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Overlays Actual by Predicted points from several model fits.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 1 ),
    Boosted Tree( 1 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 1 ),
    Generalized Regression( 1 ),
    Plot Actual by Predicted( 1 )
);


```

### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides overlaid precision-recall curves for all of the model fits. There are separate plots for the Training, Validation, and Test sets.

**JMP Version Added:** 16

```


dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = dt << Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 1 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 1 ),
    Generalized Regression( 1 ),

);
obj << Precision Recall Curve( 1 );


```

### [Predictor Properties](#predictor-properties)

**Syntax:** obj \<< Predictor Properties( state=0|1 )

**Description:** Available if you hold down the shift button, for each platform called, shows information about supported interfaces.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Predictor Properties( 1 )
);


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides prediction profilers for each type of model fit. This option is available only for continuous responses.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 1 ),
    K Nearest Neighbors( 0 ),
    Neural( 1 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 1 ),
    Profiler( 1 )
);


```

### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides overlaid Receiver Operating Characteristic (ROC) curves for all of the model fits. There are separate plots for the Training, Validation, and Test sets.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 1 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 1 ),
    Generalized Regression( 1 ),
    ROC Curve( 1 )
);


```

### [Remove Live Reports](#remove-live-reports)

**Syntax:** obj = Model Screening(...Remove Live Reports( state=0|1 )...)

**Description:** Removes the individual model platform reports from the Model Screening report window. You can use this option to free up memory for further work.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    K Fold Crossvalidation( 1 ),
    Remove Live Reports( 1 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [Repeated K Fold](#repeated-k-fold)

**Syntax:** obj = Model Screening(...Repeated K Fold( number=0 )...)

**Description:** Specifies the number of times the K Fold Crossvalidation or Nested Crossvalidation process is repeated. "0" by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Repeated K Fold( 2 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [SVM NRow Limit](#svm-nrow-limit)

**Syntax:** obj \<< SVM NRow Limit( number=10000 )

**Description:** Specifies the number of rows above which Support Vector Machines are not run. "10000" by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Equity.jmp" );
Model Screening(
    Y( :BAD ),
    Validation( :Validation ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Decision Tree( 1 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 1 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 ),
    SVM NRow Limit( 6000 )
);


```

### [Save Folded Prediction Formula](#save-folded-prediction-formula)

**Syntax:** obj \<< Save Folded Prediction Formula

**Description:** Saves new columns to the original data table. The new columns contain a leak-free prediction formula for K Fold Crossvalidation. For each row, the formula avoids using model fits that were trained using that row.

### [Save KFold Results Table](#save-kfold-results-table)

**Syntax:** obj \<< Save KFold Results Table

**Description:** Saves the information in the Summary Across the Folds report to a new data table.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    K Fold Crossvalidation( 1 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 1 ),
    Boosted Tree( 1 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 1 ),
    Save KFold Results Table
);


```

### [Save Prediction Formulas](#save-prediction-formulas)

**Syntax:** obj \<< Save Prediction Formulas

**Description:** Saves the prediction formulas to the data table.

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 1 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Fit Least Squares( 1 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 0 ),
    Generalized Regression( 0 )
);
obj << Select Fit( "Training", "Best" );
obj << Save Prediction Formulas;


```

### [Save Results Table](#save-results-table)

**Syntax:** obj \<< Save Results Table

**Description:** Saves the information in the Validation report to a new data table. If there is a test set, the information in the Test report is also saved to a new data table.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Save Results Table
);


```

### [Select Fit](#select-fit)

**Syntax:** \<<Select Fit( Training | Validation | Test | Summary | Clear All, Clear | Dominant | Best(<number>), | Largest(name,<number>) | Smallest(name,<number>) | Where(expression) )

**Description:** Select fits in various reports based on specified criteria. This option is available only in JSL.

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Select Fit( Validation, Largest( "RSquare", 2 ) );


```

### [Set Probability Threshold](#set-probability-threshold)

**Syntax:** obj \<< Set Probability Threshold( number=0.5 )

**Description:** Specifies the number of parameters above which the modeling platforms are not run. "0.5" by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 1 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 1 ),
    Generalized Regression( 1 ),
    Decision Threshold( 1 ),
    Set Probability Threshold( .2 )
);


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Model Screening(...Set Random Seed( number )...)

**Description:** Specifies a random seed to reproduce the results for future launches of the platform.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 123454321 )
);


```

### [Show Methods in Log](#show-methods-in-log)

**Syntax:** obj = Model Screening(...Show Methods in Log( state=0|1 )...)

**Description:** Writes out a progress message to the log each time a fitting platform is called.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Log Methods( 1 )
);


```

### [Show Profit](#show-profit)

**Syntax:** obj \<< Show Profit( state=0|1 )

**Description:** Shows or hides the expected profit for each model using the specified Profit Matrix for the response levels.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
Column( "Y Binary" ) << Set Property(
    "Profit Matrix", {[1 - 1, -0.3333333 1, . .], {"Low", "High", "Undecided"}}
);
obj = Model Screening(
    Y( :Y Binary ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 1 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 1 ),
    Generalized Regression( 1 ),
    Show Profit( 1 )
);


```

### [Show Scripts](#show-scripts)

**Syntax:** obj \<< Show Scripts( state=0|1 )

**Description:** For each platform called, shows options added to launch script.

**JMP Version Added:** 19

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Bootstrap Forest( 1, {Number Trees( 80 ), Number Terms( 5 )} ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Show Scripts( 1 )
);


```

### [Specify Profit Matrix](#specify-profit-matrix)

**Syntax:** obj \<< Specify Profit Matrix

**Description:** Enables you to specify profits or costs associated with correct or incorrect classification decisions.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Model Screening(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Naive Bayes( 0 ),
    Neural( 1 ),
    Support Vector Machines( 0 ),
    Fit Stepwise( 0 ),
    Logistic Regression( 1 ),
    Generalized Regression( 1 ),
    Specify Profit Matrix( [0 -1, -0.6 0, . .], "Married", "Single", "Undecided" ),
    Show Profit( 1 )
);


```

### [Support Vector Machines](#support-vector-machines)

**Syntax:** obj = Model Screening(...Support Vector Machines( state=0|1 )...)

**Description:** Predicts a response based on the support vectors in the space of the X variables. On by default.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 1 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 )
);


```

### [Time Limit Each](#time-limit-each)

**Syntax:** obj = Model Screening(...Time Limit Each( number )...)

**Description:** Specifies a time limit in seconds for each fit. For platforms that support early stopping, the best estimates up to that point are provided.

**JMP Version Added:** 16

```


Open( "$Sample_Data/Equity.jmp" );
Model Screening(
    Y( :BAD ),
    Validation( :Validation ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Time Limit Each( 1 )
);


```

### [Use Two Way Splits for K Fold](#use-two-way-splits-for-k-fold)

**Syntax:** obj = Model Screening(...Use Two Way Splits for K Fold( state=0|1 )...)

**Description:** Uses only training and validation splits instead of training, validation, and test splits.

**JMP Version Added:** 19

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    K Fold Crossvalidation( 1 ),
    Use Two Way Splits for K Fold( 1 ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Neural( 0 ),
    Support Vector Machines( 0 )
);


```

### [XGBoost](#xgboost)

**Syntax:** obj = Model Screening(...XGBoost( state=0|1 )...)

**Description:** Invokes XGBoost for gradient boosting if you have the XGBoost add-in. This option appears only if the add-in is installed.

```


Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Decision Tree( 0 ),
    Bootstrap Forest( 0 ),
    Boosted Tree( 0 ),
    K Nearest Neighbors( 0 ),
    Neural( 0 ),
    Support Vector Machines( 0 ),
    Fit Least Squares( 0 ),
    Fit Stepwise( 0 ),
    Generalized Regression( 0 ),
    XGBoost( 1 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Model Screening(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Multidimensional Scaling](#multidimensional-scaling)

## [Associated Constructors](#associated-constructors)

### [Multidimensional Scaling](#multidimensional-scaling_1)

**Syntax:** Multidimensional Scaling( Y( columns ) )

**Description:** Creates a visual representation of the pattern of proximities among a set of objects.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);


```

## [Item Messages](#item-messages)

### [3D Plot](#3d-plot)

**Syntax:** obj \<< "3D Plot"n( 1 )

**Description:** Shows or hides a 3-D plot, which requires a minimum of three dimensions.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    Set Dimensions( 3 )
);
obj << "3D Plot"n( 1 );


```

### [Data Format](#data-format)

**Syntax:** Data Format( Distance Matrix | Attribute List )

**Description:** Specifies the format of the data table, which can be a distance matrix or an attribute list.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    Data Format( "Distance Matrix" )
);


```

### [Flip Horizontal](#flip-horizontal)

**Syntax:** obj \<< Flip Horizontal

**Description:** Reflects the multidimensional scaling plot on the horizontal axis.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Flip Horizontal( 1 );


```

### [Flip Vertical](#flip-vertical)

**Syntax:** obj \<< Flip Vertical

**Description:** Reflects the multidimensional scaling plot on the vertical axis.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Flip Vertical( 1 );


```

### [MDS Plot](#mds-plot)

**Syntax:** obj \<< MDS Plot( state=0|1 )

**Description:** Shows or hides the multidimensional scaling plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << MDS Plot( 1 );


```

### [Save Coordinates](#save-coordinates)

**Syntax:** obj \<< Save Coordinates

**Description:** Saves the dimension coordinates for the response variables to the data table.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Save Coordinates;


```

### [Save Proximity](#save-proximity)

**Syntax:** obj \<< Save Proximity

**Description:** Saves the proximity matrix to the data table. Available only when the data format is Attribute List.

```

dt = Open( "$SAMPLE_DATA/Teeth.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Top incisors, :Bottom incisors, :Top canines, :Bottom canines, :Top premolars,
        :Bottom premolars, :Top molars, :Bottom molars
    ),
    Data Format( "Attribute List" )
);
obj << Save Proximity;


```

### [Select dimension](#select-dimension)

**Syntax:** obj \<< Select dimension( <specify dimension to plot> )

**Description:** Selects the dimensions that are used as axes in the correspondence plot.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    Set Dimensions( 3 )
);
obj << Select Dimension( 1, 3 );


```

### [Set Dimensions](#set-dimensions)

**Syntax:** obj = Multidimensional Scaling(...Set Dimensions( number=2 )...)

**Description:** Specifies the dimensions for MDS. "2" by default.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    Set Dimensions( 3 )
);


```

### [Shepard Diagram](#shepard-diagram)

**Syntax:** obj \<< Shepard Diagram( state=0|1 )

**Description:** Shows or hides the Shepard diagram, which plots actual proximity versus predicted proximity. On by default.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Shepard Diagram( 1 );


```

### [Show Coordinates](#show-coordinates)

**Syntax:** obj \<< Show Coordinates( state=0|1 )

**Description:** Shows or hides dimension coordinates for the response variables.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Show Coordinates( 1 );


```

### [Show Proximity](#show-proximity)

**Syntax:** obj \<< Show Proximity( state=0|1 )

**Description:** Shows or hides a table of actual and predicted proximity values between response variables.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Show Proximity( 1 );


```

### [Transformation](#transformation)

**Syntax:** Transformation( None | Ratio | Interval | Ordinal )

**Description:** Specifies the choice of transformation for the multidimensional scaling analysis.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    Transformation( "Ratio" )
);


```

### [Waern Links](#waern-links)

**Syntax:** obj \<< Waern Links( Smallest Portion | Largest Portion, portion, visible )

**Description:** Specifies Waern links for the MDS plot. The first argument specifies whether links should be drawn for the smallest or largest portion. The second argument specifies the portion value. The third argument is a Boolean that specifies if the Waern link controls are visible.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Waern links( "Smallest Portion", 0.33, 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Flight Distances.jmp" );
obj = dt << Multidimensional Scaling(
    Y(
        :Birmingham, :Boston, :Buffalo, :Chicago, :Cleveland, :Dallas, :Denver, :Detroit,
        :El Paso, :Houston, :Indianapolis, :Kansas City, :Los Angeles, :Louisville, :Memphis,
        :Miami, :Minneapolis, :New Orleans, :New York, :Omaha, :Philadelphia, :Phoenix,
        :Pittsburgh, :St. Louis, :Salt Lake City, :San Francisco, :Seattle, :Washington DC
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Multidimensional Scaling(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Multiple Correspondence Analysis](#multiple-correspondence-analysis)

## [Associated Constructors](#associated-constructors)

### [Multiple Correspondence Analysis](#multiple-correspondence-analysis_1)

**Syntax:** Multiple Correspondence Analysis( Y( columns ), X( columns ) )

**Description:** Identifies associations between the levels of categorical variables. Multiple Correspondence Analysis is analogous to principal components analysis for categorical data.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Multiple Correspondence Analysis(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Factor](#factor)

**Syntax:** obj = Multiple Correspondence Analysis(...\<Factor( column(s) )>...)

**Description:** Specifies one or more categorical columns to be used as factor, or explanatory, variables.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);


```

### [Freq](#freq)

**Syntax:** obj = Multiple Correspondence Analysis(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    Freq( :_freqcol )
);


```

### [Response](#response)

**Syntax:** obj = Multiple Correspondence Analysis(...Response( column(s) )...)

**Description:** Specifies the categorical columns to be analyzed.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);


```

### [Supplementary ID](#supplementary-id)

**Syntax:** obj = Multiple Correspondence Analysis(...\<Supplementary ID( column )>...)

**Description:** Specifies a column that identifies rows to be used as supplementary.

```

dt = Open( "$SAMPLE_DATA/US Regional Population.jmp" );
obj = dt << Multiple Correspondence Analysis(
    Y( :Year ),
    X( :Region ),
    Freq( :Population ),
    Supplementary ID( :ID )
);
obj << Cross Table of Supplementary Rows( 0 );


```

### [Supplementary Variable](#supplementary-variable)

**Syntax:** obj = Multiple Correspondence Analysis(...\<Supplementary Variable( column(s) )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country ), X( :size ), Z( :sex ) );


```

### [X](#x)

**Syntax:** obj = Multiple Correspondence Analysis(...\<X( column(s) )>...)

**Description:** Specifies one or more categorical columns to be used as factor, or explanatory, variables.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);


```

### [Y](#y)

**Syntax:** obj = Multiple Correspondence Analysis(...Y( column(s) )...)

**Description:** Specifies the categorical columns to be analyzed.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);


```

### [Z](#z)

**Syntax:** obj = Multiple Correspondence Analysis(...\<Z( column(s) )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country ), X( :size ), Z( :sex ) );


```

## [Item Messages](#item-messages)

### [3D Correspondence Analysis](#3d-correspondence-analysis)

**Syntax:** obj\<<"3D Correspondence Analysis"n(1)

**Description:** Displays or hides a 3D correspondence plot. 3D Correspondence Analysis requires a minimum of four levels for each of the X and Y variables.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << "3D Correspondence Analysis"n( 1 );


```

### [Cochran's Q Test](#cochrans-q-test)

**Syntax:** obj\<<Cochran's Q Test(1)

**Description:** Shows or hides Cochran's Q test.

```

dt = New Table( "Drug_Qtest",
    Add Rows( 8 ),
    New Column( "Subject", Numeric, "Continuous", Set Values( [1, 2, 3, 4, 5, 6, 7, 8] ) ),
    New Column( "drug_A",
        Character,
        "Nominal",
        Set Values( {"F", "F", "F", "F", "U", "U", "U", "U"} )
    ),
    New Column( "drug_B",
        Character,
        "Nominal",
        Set Values( {"F", "F", "U", "U", "F", "F", "U", "U"} )
    ),
    New Column( "drug_C",
        Character,
        "Nominal",
        Set Values( {"F", "U", "F", "U", "F", "U", "F", "U"} )
    ),
    New Column( "Count", Numeric, "Continuous", Set Values( [6, 16, 2, 4, 2, 4, 6, 6] ) )
);
obj = dt << Multiple Correspondence Analysis(
    Y( :drug_A, :drug_B, :drug_C ),
    X( :Subject ),
    Freq( :Count )
);
obj << Cochran's Q Test( 1 );


```

### [Cross Table](#cross-table)

**Syntax:** obj \<< Cross Table( state=0|1 )

**Description:** Displays or hides a Contingency or Burt table. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Cross Table( 0 );


```

### [Cross Table of Supplementary Columns](#cross-table-of-supplementary-columns)

**Syntax:** obj \<< Cross Table of Supplementary Columns( state=0|1 )

**Description:** Displays or hides a Cross Table of Supplementary Columns.

```

dt = Open( "$SAMPLE_DATA/US Regional Population.jmp" );
obj = dt << Multiple Correspondence Analysis(
    Y( :Region ),
    X( :Year ),
    Freq( :Population ),
    Supplementary ID( :ID )
);
obj << Cross Table of Supplementary Columns( 0 );


```

### [Cross Table of Supplementary Rows](#cross-table-of-supplementary-rows)

**Syntax:** obj \<< Cross Table of Supplementary Rows( state=0|1 )

**Description:** Displays or hides a Cross Table of Supplementary Rows.

```

dt = Open( "$SAMPLE_DATA/US Regional Population.jmp" );
obj = dt << Multiple Correspondence Analysis(
    Y( :Year ),
    X( :Region ),
    Freq( :Population ),
    Supplementary ID( :ID )
);
obj << Cross Table of Supplementary Rows( 0 );


```

### [Mosaic Plot](#mosaic-plot)

**Syntax:** obj \<< Mosaic Plot( state=0|1 )

**Description:** Displays or hides a mosaic plot of the data.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country ), X( :size ) );
obj << Mosaic Plot( 1 );


```

### [Proportional marker size](#proportional-marker-size)

**Syntax:** obj\<<Proportional Marker Size(1)

**Description:** Sets the size of each marker in the correspondence plot to be proportional to the frequency of the corresponding group.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Proportional Marker Size( 1 );


```

### [Save Coordinate Formula](#save-coordinate-formula)

**Syntax:** obj\<<Save Coordinates

**Description:** Saves the coordinate formula for each observation to a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Save Coordinate Formula( 2 );


```

### [Save Coordinates](#save-coordinates)

**Syntax:** obj\<<Save Coordinates

**Description:** Saves column or row coordinates.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Save Coordinates;


```

### [Select dimension](#select-dimension)

**Syntax:** obj \<< Select dimension( <specify dimension to plot> )

**Description:** Selects the dimensions that are used as axes in the correspondence plot.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Select Dimension( 1, 3 );


```

### [Show Adjusted Inertia](#show-adjusted-inertia)

**Syntax:** obj\<<Show Adjusted Inertia(1)

**Description:** Displays or hides adjusted inertia.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Show Adjusted Inertia( 1 );


```

### [Show Coordinates](#show-coordinates)

**Syntax:** obj\<<Show Coordinates(1)

**Description:** Displays or hides row and column coordinates.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Show Coordinates( 1 );


```

### [Show Detail](#show-detail)

**Syntax:** obj\<<Show Detail(0)

**Description:** Displays or hides details of inertia and chi-square decomposition. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Show Detail( 0 );


```

### [Show Partial Contributions to Inertia](#show-partial-contributions-to-inertia)

**Syntax:** obj\<<Show Partial Contributions to Inertia(1)

**Description:** Displays or hides partial contributions to inertia.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Show Partial Contributions to Inertia( 1 );


```

### [Show Plot](#show-plot)

**Syntax:** obj\<<Show Plot(0)

**Description:** Displays or hides a correspondence plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Show Plot( 0 );


```

### [Show Squared Cosines](#show-squared-cosines)

**Syntax:** obj\<<Show Squared Cosines(1)

**Description:** Shows or hides a table that contains the squared cosines of variables.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Show Squared Cosines( 1 );


```

### [Show Summary Statistics](#show-summary-statistics)

**Syntax:** obj\<<Show Summary Statistics(1)

**Description:** Displays or hides quality, mass and inertia summary statistics.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country, :size, :type ) );
obj << Show Summary Statistics( 1 );


```

### [Tests for Independence](#tests-for-independence)

**Syntax:** obj \<< Tests for Independence( state=0|1 )

**Description:** Displays or hides tests for independence.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Multiple Correspondence Analysis( Y( :country ), X( :size ) );
obj << Tests for Independence( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Cereal.jmp" );
dt << Multiple Correspondence Analysis(
    Y( :Mfr, :"Hot/Cold"n, :Fiber Gr ),
    X( :Manufacturer )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Multiple Correspondence Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Multiple Factor Analysis](#multiple-factor-analysis)

## [Associated Constructors](#associated-constructors)

### [Multiple Factor Analysis](#multiple-factor-analysis_1)

**Syntax:** Multiple Factor Analysis( MFABLocks({"Block 1", columns},{"Block 2", columns}) )

**Description:** Analyzes agreement among panelists in sensory data analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Multiple Factor Analysis(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Multiple Factor Analysis(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    Freq( :_freqcol )
);


```

### [MFA Blocks](#mfa-blocks)

**Syntax:** obj = Multiple Factor Analysis(...\<MFA Blocks( column )>...)

**Description:** Specifies groups of columns that should be treated as sub-tables within the multiple factor analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Wine ),
    MFA Blocks(
        {"Susan", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness}
    )
);


```

### [Product ID](#product-id)

**Syntax:** obj = Multiple Factor Analysis(...\<Product ID( column )>...)

**Description:** Specifies columns of items or products to be analyzed.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Wine ),
    MFA Blocks(
        {"Susan", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness}
    )
);


```

### [Supplementary](#supplementary)

**Syntax:** obj = Multiple Factor Analysis(...\<Supplementary( column )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Wine ),
    Z( :Region ),
    MFA Blocks(
        {"Susan", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness}
    )
);


```

### [Weight](#weight)

**Syntax:** obj = Multiple Factor Analysis(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    Weight( :_weightcol )
);


```

### [Z](#z)

**Syntax:** obj = Multiple Factor Analysis(...\<Z( column )>...)

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Wine ),
    Z( :Region ),
    MFA Blocks(
        {"Susan", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness}
    )
);


```

## [Item Messages](#item-messages)

### [Arrow Lines](#arrow-lines)

**Syntax:** obj \<< Arrow Lines( state=0|1 )

**Description:** Shows or hides the arrow lines in the graph. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Arrow Lines( 0 );


```

### [Biplot](#biplot)

**Syntax:** obj \<< Biplot( state=0|1 )

**Description:** Shows or hides a plot that overlays the score plot and the loading plot for the specified number of components.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Biplot( 1 );


```

### [Biplot Select Component](#biplot-select-component)

**Syntax:** obj\<<Biplot Select Component( 1, 3 )

**Description:** Selects the components that are used as axes in the biplot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Biplot Select Component( 1, 3 );


```

### [Block Partial Contributions](#block-partial-contributions)

**Syntax:** obj \<< Block Partial Contributions( state=0|1 )

**Description:** Displays or hides block contributions which is the sum of the contributions of its variables.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Block Partial Contributions( 1 );


```

### [Block Partial Inertias](#block-partial-inertias)

**Syntax:** obj \<< Block Partial Inertias( state=0|1 )

**Description:** Displays or hides rescaled block contributions, such that the sum of inertia across blocks equals the principal component's eigenvalue.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Block Partial Inertias( 1 );


```

### [Block Partial and Consensus Correlations](#block-partial-and-consensus-correlations)

**Syntax:** obj \<< Block Partial and Consensus Correlations( state=0|1 )

**Description:** Displays or hides a matrix of coefficients indicating the correlations between partial and consensus scores on each principal component dimension.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Block Partial and Consensus Correlations( 1 );


```

### [Block Squared Cosines](#block-squared-cosines)

**Syntax:** obj \<< Block Squared Cosines( state=0|1 )

**Description:** Displays or hides the proportion of overlap in variance between blocks and principal component dimensions.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Block Squared Cosines( 1 );


```

### [Block Weights](#block-weights)

**Syntax:** obj \<< Block Weights( state=0|1 )

**Description:** Displays or hides a matrix of block weight which is the inverse of each block's first singular value.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Block Weights( 1 );


```

### [Consensus Map](#consensus-map)

**Syntax:** obj \<< Consensus Map( state=0|1 )

**Description:** Displays or hides a Consensus Map which overlays the centroid scores and partial scores from each block. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Consensus Map( 0 );


```

### [Consensus Map Select Component](#consensus-map-select-component)

**Syntax:** obj\<<Consensus Map Select Component( 1, 3 )

**Description:** Selects the components that are used as axes in the consensus map.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Consensus Map Select Component( 1, 3 );


```

### [Eigenvalues](#eigenvalues)

**Syntax:** obj \<< Eigenvalues( state=0|1 )

**Description:** Shows or hides the sorted eigenvalues, their percent of variation, and the cumulative percent of variation.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Eigenvalues( 1 );


```

### [Eigenvectors](#eigenvectors)

**Syntax:** obj \<< Eigenvectors( state=0|1 )

**Description:** Shows or hides a report of the eigenvectors for each of the principal components.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Eigenvectors( 1 );


```

### [Highlight Product](#highlight-product)

**Syntax:** obj\<<Partial Axes Plot Select Component( 1, 3 )

**Description:** Highlights product clusters based on the specified inertial value.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    ),
    Consensus Map( 1 )
);
obj << Highlight Product( "Small Inertia", 4 );


```

### [Lg Coefficients](#lg-coefficients)

**Syntax:** obj \<< Lg Coefficients( state=0|1 )

**Description:** Displays or hides a matrix of coefficients indicating the similarity between blocks. Equivalent to unstandardized RV correlations.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Lg Coefficients( 1 );


```

### [Partial Axes Plot](#partial-axes-plot)

**Syntax:** obj \<< Partial Axes Plot( state=0|1 )

**Description:** Displays or hides a Partial Axes Plot which shows the link between centroid plane and blocks.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Partial Axes Plot( 1 );


```

### [Partial Axes Plot Select Component](#partial-axes-plot-select-component)

**Syntax:** obj\<<Partial Axes Plot Select Component( 1, 3 )

**Description:** Selects the components that are used as axes in the Partial Axes Plot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    ),
    Partial Axes Plot( 1 )
);
obj << Partial Axes Plot Select component( 1, 3 );


```

### [RV Correlations](#rv-correlations)

**Syntax:** obj \<< RV Correlations( state=0|1 )

**Description:** Displays or hides a matrix of squared correlation coefficients between blocks. RV coefficients range from 0 to 1.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << RV Correlations( 1 );


```

### [Save Block Partial Scores](#save-block-partial-scores)

**Syntax:** obj \<< Save Block Partial Scores

**Description:** Saves block partial scores to new columns in a data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Save Block Partial Scores();


```

### [Save Individual Partial Contributions](#save-individual-partial-contributions)

**Syntax:** obj \<< Save Individual Partial Contributions

**Description:** Saves individual partial contributions to new columns in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Save Individual Partial Contributions();


```

### [Save Individual Scores](#save-individual-scores)

**Syntax:** obj \<< Save Individual Scores

**Description:** Saves the given number of principal components to new columns in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Save Individual Scores();


```

### [Save Individual Squared Cosines](#save-individual-squared-cosines)

**Syntax:** obj \<< Save Individual Squared Cosines

**Description:** Saves individual squared cosines to new columns in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Save Individual Squared Cosines();


```

### [Save Partial Axes Coordinates](#save-partial-axes-coordinates)

**Syntax:** obj \<< Save Partial Axes Coordinates

**Description:** Saves partial axes coordinates to new columns in a data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Save Partial Axes Coordinates();


```

### [Show Labels](#show-labels)

**Syntax:** obj \<< Show Labels( state=0|1 )

**Description:** Displays or hides the labels of points in the graph.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Show Labels( 1 );


```

### [Summary Plot Select Component](#summary-plot-select-component)

**Syntax:** obj\<<Summary Plot Select Component( 1, 3 )

**Description:** Selects the components that are used as axes in the summary plots.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Summary Plot Select Component( 1, 3 );


```

### [Summary Plots](#summary-plots)

**Syntax:** obj \<< Summary Plots( state=0|1 )

**Description:** Shows or hides an outline node that contains a plot of the eigenvalues, a score plot, and a loading plot. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Summary Plots( 0 );


```

### [Variable Loadings](#variable-loadings)

**Syntax:** obj \<< Variable Loadings( state=0|1 )

**Description:** Displays or hides a report showing the columns corresponding to the component loadings.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Variable Loadings( 1 );


```

### [Variable Partial Contributions](#variable-partial-contributions)

**Syntax:** obj \<< Variable Partial Contributions( state=0|1 )

**Description:** Shows or hides a table that contains the partial contributions of variables and a plot of the partial contributions for the first three principal components.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Variable Partial Contributions( 1 );


```

### [Variable Squared Cosines](#variable-squared-cosines)

**Syntax:** obj \<< Variable Squared Cosines( state=0|1 )

**Description:** Shows or hides a table that contains the squared cosines of variables.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
obj = dt << Multiple Factor Analysis(
    MFA Blocks(
        {"Carolyn Peppery etc.", :Carolyn Peppery, :Carolyn Tannic, :Carolyn Aromatic,
        :Carolyn Berry Notes},
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness}
    )
);
obj << Variable Squared Cosines( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Wine Sensory Data.jmp" );
dt << Multiple Factor Analysis(
    Product ID( :Vineyard ),
    Z( :Region ),
    MFA Blocks(
        {"Susan Fruity etc.", :Susan Fruity, :Susan Flowery, :Susan Spicy, :Susan Crispness},
        {"Florence Flowery etc.", :Florence Flowery, :Florence Crispness, :Florence Tannin,
        :Florence Savory, :Florence Lightness},
        {"Xavier Fruity etc.", :Xavier Fruity, :Xavier Spicy, :Xavier Crispness,
        :Xavier Alcohol, :Xavier Savory, :Xavier Lightness},
        {"Robert Fruity etc.", :Robert Fruity, :Robert Flowery, :Robert Spicy,
        :Robert Crispness, :Robert Tannin, :Robert Alcohol, :Robert Savory, :Robert Lightness
        },
        {"Paula Fruity etc.", :Paula Fruity, :Paula Flowery, :Paula Spicy, :Paula Crispness,
        :Paula Tannin, :Paula Savory},
        {"Monica Fruity etc.", :Monica Fruity, :Monica Flowery, :Monica Spicy, :Monica Tannin,
        :Monica Alcohol, :Monica Savory, :Monica Lightness},
        {"Frank Fruity etc.", :Frank Fruity, :Frank Flowery, :Frank Spicy, :Frank Crispness,
        :Frank Tannin, :Frank Alcohol, :Frank Savory, :Frank Lightness}
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Multiple Factor Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Multiple File Import](#multiple-file-import)

## [Associated Constructors](#associated-constructors)

### [Multiple File Import](#multiple-file-import_1)

**Syntax:** mfiObj = Multiple File Import();

**Description:** Creates a Multiple File Import object; the object accepts messages to set a folder, filter files, and import. To bring up a dialog use the "Create Window" message. To immediately import use the "Import Data" message which will return a list of the tables that were created.

```

// use the save-script-to-script-window button 
// in the MFI dialog to see more messages
// for filtering files and controlling the import
Multiple File Import(
    <<Set Folder( "$DESKTOP" ),
    <<Set Name Filter( "*.csv;" ),
    <<Set Name Enable( 1 )
) << Create Window;


```

## [Item Messages](#item-messages)

### [Create Window](#create-window)

**Syntax:** obj \<< Create Window

**Description:** Bring up a window with the current settings.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << set folder( "$sample_import_data" );
mfi << create window();


```

### [Get Add File Date Column](#get-add-file-date-column)

**Syntax:** obj \<< Get Add File Date Column

**Description:** Returns 1 if the imported table has a column for the name of the file the row was imported from.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Add File Date Column( 1 );
mfi << Get Add File Date Column();


```

### [Get Add File Name Column](#get-add-file-name-column)

**Syntax:** obj \<< Get Add File Name Column

**Description:** Returns 1 if the imported table has a column for the name of the file the row was imported from.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Add File Name Column( 1 );
mfi << Get Add File Name Column();


```

### [Get Add File Size Column](#get-add-file-size-column)

**Syntax:** obj \<< Get Add File Size Column

**Description:** Returns 1 if the imported table will have a column for the size of the file the row was imported from.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Add File Size Column( 1 );
mfi << Get Add File Size Column();


```

### [Get CSV Allow Numeric](#get-csv-allow-numeric)

**Syntax:** obj \<< Get CSV Allow Numeric

**Description:** Returns 1 if numeric columns will be created from apparent numeric data.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV Allow Numeric;


```

### [Get CSV EOF Comma](#get-csv-eof-comma)

**Syntax:** obj \<< Get CSV EOF Comma

**Description:** Set to 1 to use a comma to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOF Comma();


```

### [Get CSV EOF Other](#get-csv-eof-other)

**Syntax:** obj \<< Get CSV EOF Other

**Description:** Set to the value that separates fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOF Other();


```

### [Get CSV EOF Space](#get-csv-eof-space)

**Syntax:** obj \<< Get CSV EOF Space

**Description:** Set to 1 to use a space to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOF Space();


```

### [Get CSV EOF Spaces](#get-csv-eof-spaces)

**Syntax:** obj \<< Get CSV EOF Spaces

**Description:** Set to 1 to use a spaces to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOF Spaces();


```

### [Get CSV EOF Tab](#get-csv-eof-tab)

**Syntax:** obj \<< Get CSV EOF Tab

**Description:** Set to 1 to use a tab to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOF TAb();


```

### [Get CSV EOL CR](#get-csv-eol-cr)

**Syntax:** obj \<< Get CSV EOL CR

**Description:** Returns 1 if using CR as the value that separates lines that will be used to create different rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOL CR();


```

### [Get CSV EOL CRLF](#get-csv-eol-crlf)

**Syntax:** obj \<< Get CSV EOL CRLF

**Description:** Returns 1 if using CRLF as the value that separates lines that will be used to create different rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOL CRLF();


```

### [Get CSV EOL LF](#get-csv-eol-lf)

**Syntax:** obj \<< Get CSV EOL LF

**Description:** Returns 1 if using LF as the value that separates lines that will be used to create different rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOL LF();


```

### [Get CSV EOL Other](#get-csv-eol-other)

**Syntax:** obj \<< Get CSV EOL Other

**Description:** Gets the custom value the separates lines in the input file. This value creates rows in the output.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOF Other();


```

### [Get CSV EOL Semicolon](#get-csv-eol-semicolon)

**Syntax:** obj \<< Get CSV EOL Semicolon

**Description:** Returns 1 if a semicolon represents the lines between rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV EOL Semicolon();


```

### [Get CSV Escape](#get-csv-escape)

**Syntax:** obj \<< Get CSV Escape

**Description:** Gets the character that escapes special characters such as end of field, end of line or the quote delimeter.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV Escape();


```

### [Get CSV First Data Line](#get-csv-first-data-line)

**Syntax:** obj \<< Get CSV First Data Line

**Description:** The line number in the import file that contains the first row of data.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV First Data Line();


```

### [Get CSV First Header Line](#get-csv-first-header-line)

**Syntax:** obj \<< Get CSV First Header Line

**Description:** Gets the first line in the import file that has headers that will be used to create column names.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Has Headers( 1 );
mfi << Set CSV First Header Line( 2 );
mfi << Get CSV First Header Line();


```

### [Get CSV Has Headers](#get-csv-has-headers)

**Syntax:** obj \<< Get CSV Has Headers

**Description:** Returns 1 if the header settings will be used while importing.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV Has Headers;


```

### [Get CSV Number Of Header Lines](#get-csv-number-of-header-lines)

**Syntax:** obj \<< Get CSV Number Of Header Lines

**Description:** Gets the number of lines of headers that will be used for column names.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Has Headers( 1 );
mfi << Set CSV Number Of Header Lines( 2 );
mfi << Get CSV Number Of Header Lines();


```

### [Get CSV Quote](#get-csv-quote)

**Syntax:** obj \<< Get CSV Quote

**Description:** Gets the value that separates quoted strings

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get CSV Quote();


```

### [Get Charset](#get-charset)

**Syntax:** obj \<< Get Charset

**Description:** Returns the charset that will be used for importing data.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get Charset();


```

### [Get Date Count](#get-date-count)

**Syntax:** obj \<< Get Date Count

**Description:** Returns the number of files that are in the range of the date filter if it is enabled, otherwise it returns the total number of files.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Folder( "$downloads" );
mfi << Set Date Filter( {05Sep2019:14:30:00, Today()} );
mfi << Set Date Enable( 1 );
mfi << Get Date Count();


```

### [Get Date Enable](#get-date-enable)

**Syntax:** obj \<< Get Date Enable

**Description:** Returns 1 if the date filter is enabled.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get Date Enable();


```

### [Get Date Filter](#get-date-filter)

**Syntax:** obj \<< Get Date Filter

**Description:** Returns the current date filter.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Date Filter( {05Sep2019:14:30:00, Today()} );
mfi << Set Date Enable( 1 );
mfi << Get Date Filter();


```

### [Get Excel Add Sheet Name Column](#get-excel-add-sheet-name-column)

**Syntax:** obj \<< Get Excel Add Sheet Name Column

**Description:** Returns 1 if a column will be added to the imported table that has the name of the spreadsheet the data came from.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Add Sheet Name Column;


```

### [Get Excel Best Guess](#get-excel-best-guess)

**Syntax:** obj \<< Get Excel Best Guess

**Description:** Returns 1 if data and column headers will be found dynamically. Returns 0 if the other excel settings will be used when importing Excel data.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Best Guess;


```

### [Get Excel Column Headers As Hierarchies](#get-excel-column-headers-as-hierarchies)

**Syntax:** obj \<< Get Excel Column Headers As Hierarchies

**Description:** Returns 1 if spreadsheet cells that are in the header rows that span more than one cell horizontally will be treated as hierarchies.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Column Headers as Hierarchies;


```

### [Get Excel Column Name Separator](#get-excel-column-name-separator)

**Syntax:** obj \<< Get Excel Column Name Separator

**Description:** Get the string to be used when concatenating multiple cells into column header names.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Column Name Separator;


```

### [Get Excel First Data Column](#get-excel-first-data-column)

**Syntax:** obj \<< Get Excel First Data Column

**Description:** Returns the first non-empty column in the spreadsheet to be imported as data.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel First Data Column;


```

### [Get Excel First Data Line](#get-excel-first-data-line)

**Syntax:** obj \<< Get Excel First Data Line

**Description:** Returns the first non-empty row in the spreadsheet to be imported as data.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel First Data Line;


```

### [Get Excel First Header Line](#get-excel-first-header-line)

**Syntax:** obj \<< Get Excel First Header Line

**Description:** Returns the first non-empty row in the spreadsheet to be imported as a column header.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel First Header Line;


```

### [Get Excel Has Headers](#get-excel-has-headers)

**Syntax:** obj \<< Get Excel Has Headers

**Description:** Returns 1 if headers will be imported from the spreadsheets and 0 otherwise.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Has Headers;


```

### [Get Excel Import Color Cells](#get-excel-import-color-cells)

**Syntax:** obj \<< Get Excel Import Color Cells

**Description:** Returns 1 if the background color of spreadsheet data cells will be imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Import Color Cells;


```

### [Get Excel Last Data Column](#get-excel-last-data-column)

**Syntax:** obj \<< Get Excel Last Data Column

**Description:** Returns the last column in the data area of the spreadsheet to be imported. If missing is returned then the last column will be found dynamically.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Last Data Column;


```

### [Get Excel Last Data Row](#get-excel-last-data-row)

**Syntax:** obj \<< Get Excel Last Data Row

**Description:** Returns the last row in the data area of the spreadsheet to be imported. If missing is returned then the last row will be found dynamically.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Last Data Row;


```

### [Get Excel Limit Column Type Detection](#get-excel-limit-column-type-detection)

**Syntax:** obj \<< Get Excel Limit Column Type Detection

**Description:** Returns 0 if all of the spreadsheet cells in each column will be checked when detecting the data type of the column and returns 1 if only a subset will be checked. Limiting detection can improve performance with large spreadsheets.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Limit Column Type Detection;


```

### [Get Excel Multiple Series Stack](#get-excel-multiple-series-stack)

**Syntax:** obj \<< Get Excel Multiple Series Stack

**Description:** Returns 1 if spanned columns will be stacked if "Set Excel Column Headers As Hierarchies" is set to 1.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Multiple Series Stack;


```

### [Get Excel Number of Header Lines](#get-excel-number-of-header-lines)

**Syntax:** obj \<< Get Excel Number of Header Lines

**Description:** Returns the number of lines in the spreadsheet that will be imported as column headers.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Number of Header Lines;


```

### [Get Excel Replicate Data In Spanned Rows](#get-excel-replicate-data-in-spanned-rows)

**Syntax:** obj \<< Get Excel Replicate Data In Spanned Rows

**Description:** For multiple header rows that are merged vertically, set to 1 to repeat the value.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Replicate Data In Spanned Rows;


```

### [Get Excel Replicate Headers In Spanned Rows](#get-excel-replicate-headers-in-spanned-rows)

**Syntax:** obj \<< Get Excel Replicate Headers In Spanned Rows

**Description:** Returns 1 if merged spreadsheet header cells will have cell values duplicated when creating the JMP table column name.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Replicate Headers In Spanned Rows;


```

### [Get Excel Suppress Empty Columns](#get-excel-suppress-empty-columns)

**Syntax:** obj \<< Get Excel Suppress Empty Columns

**Description:** Set to 1 to prevent empty columns from being imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Suppress Empty Columns;


```

### [Get Excel Suppress Hidden Columns](#get-excel-suppress-hidden-columns)

**Syntax:** obj \<< Get Excel Suppress Hidden Columns

**Description:** Returns 1 if hidden columns will not be imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Suppress Hidden Columns;


```

### [Get Excel Suppress Hidden Rows](#get-excel-suppress-hidden-rows)

**Syntax:** obj \<< Get Excel Suppress Hidden Rows

**Description:** Returns 1 if hidden rows will not be imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Suppress Hidden Rows;


```

### [Get Excel Worksheet Filter](#get-excel-worksheet-filter)

**Syntax:** obj \<< Get Excel Worksheet Filter

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Get Excel Worksheet Filter;


```

### [Get File List](#get-file-list)

**Syntax:** obj \<< Get File List

**JMP Version Added:** 18

```




```

### [Get Folder](#get-folder)

**Syntax:** obj \<< Get Folder

**Description:** Return the folder name.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Folder( "$Desktop" );
mfi << Get Folder;


```

### [Get Folder Count](#get-folder-count)

**Syntax:** obj \<< Get Folder Count

**Description:** Return the number of files in the folder.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Folder( "$Desktop" );
mfi << Get Folder Count;


```

### [Get Import Callback](#get-import-callback)

**Syntax:** obj \<< Get Import Callback

**JMP Version Added:** 15

```


Create Directory( "$temp/deleteme" );
Save Text File( "$temp/deleteme/test1.txt", "a1\!n1" );
Save Text File( "$temp/deleteme/test2.txt", "a2\!n1" );
mfi = Multiple File Import(
    <<Set Folder( "$temp/deleteme/" ),
    <<Set Name Filter( "test?.txt;" ),
    <<Set Name Enable( 1 ),
    <<Set Add File Name Column( 1 ),
    <<Set Import Callback(
        Function( {a, b},
            Write( "\!na=", a );
            Write( "\!nb=", b );
        )
    )
);
mfi << Get Import Callback();


```

### [Get Import Mode](#get-import-mode)

**Syntax:** obj \<< Get Import Mode

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Import Mode( "Row Per Line" );
mfi << Get Import Mode();


```

### [Get JSON Guess](#get-json-guess)

**Syntax:** obj \<< Get JSON Guess

**Description:** Returns the built-in method for importing JSON data to create data tables.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Get JSON Guess();


```

### [Get JSON Method](#get-json-method)

**Syntax:** obj \<< Get JSON Method

**Description:** Return the current method used for importing JSON data.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Get JSON Method();


```

### [Get JSON Settings](#get-json-settings)

**Syntax:** obj \<< Get JSON Settings

**Description:** Returns the custom JSL that imports JSON data.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Get JSON Settings();


```

### [Get Name Count](#get-name-count)

**Syntax:** obj \<< Get Name Count

**Description:** Returns the number of files that match the current name filter if Set Name Enable is set or the total number of files otherwise.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get Name Count();


```

### [Get Name Enable](#get-name-enable)

**Syntax:** obj \<< Get Name Enable

**Description:** Returns 1 if the current name filter will be applied to filter the files being included.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Name Enable( 1 );
mfi << Get Name Enable();


```

### [Get Name Filter](#get-name-filter)

**Syntax:** obj \<< Get Name Filter

**Description:** Returns the current name filter.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Name Filter( "*.csv;*.txt" );
mfi << Set Name Enable( 1 );
mfi << Get Name Filter();


```

### [Get PDF Method](#get-pdf-method)

**Syntax:** obj \<< Get PDF Method

**Description:** Return the current method used for importing PDF data.

**JMP Version Added:** 17

```


mfi = Multiple File Import();
mfi << Get PDF Method();


```

### [Get PDF Settings](#get-pdf-settings)

**Syntax:** obj \<< Get PDF Settings

**Description:** Returns the custom JSL that imports PDF data.

**JMP Version Added:** 17

```


mfi = Multiple File Import();
mfi << Get PDF Settings();


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Create a script from the current settings.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get Script();


```

### [Get Show Hidden](#get-show-hidden)

**Syntax:** obj \<< Get Show Hidden

**Description:** Returns whether hidden files are included

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set Show Hidden( 1 );
mfi << Get Show Hidden();


```

### [Get Size Count](#get-size-count)

**Syntax:** obj \<< Get Size Count

**Description:** Returns the number of files matching the current size filter if Set Size Enable is set or the total number of files otherwise.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Folder( "$Documents" );
mfi << Set Size Filter( {0, 1000} );
mfi << Set Size Enable( 1 );
Print( mfi << Get Size Count() );
mfi << Set Size Enable( 0 );
Print( mfi << Get Size Count() );


```

### [Get Size Enable](#get-size-enable)

**Syntax:** 0|1 = obj \<< Get Size Enable

**Description:** Returns 1 if the size filter is enabled.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Size Enable( 1 );
mfi << Set Size Filter( {0, 1000} );
mfi << Get Size Enable();


```

### [Get Size Filter](#get-size-filter)

**Syntax:** obj \<< Get Size Filter

**Description:** Returns a list whose first member is the smallest file size included and whose second number is the largest file size included.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Size Filter( {0, 1000} );
mfi << Get Size Filter();


```

### [Get Stack Mode](#get-stack-mode)

**Syntax:** obj \<< Get Stack Mode

**Description:** Returns "Stack Similar" if similar input files will be combined into one table when importing, or returns "Table Per File" when input files will be combined into two or more tables.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Get Stack Mode();


```

### [Get Subfolders](#get-subfolders)

**Syntax:** obj \<< Get Subfolders

**Description:** Returns 1 if files in subfolders are included.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set Subfolders( 1 );
mfi << Get Subfolders();


```

### [Get Use File List](#get-use-file-list)

**Syntax:** obj \<< Get Use File List

**JMP Version Added:** 18

```




```

### [Get XML Guess](#get-xml-guess)

**Syntax:** obj \<< Get XML Guess

**Description:** Returns the built-in method for importing XML data to create data tables.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Get XML Guess();


```

### [Get XML Method](#get-xml-method)

**Syntax:** obj \<< Get XML Method

**Description:** Return the current method used for importing XML data.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Get XML Method();


```

### [Get XML Settings](#get-xml-settings)

**Syntax:** obj \<< Get XML Settings

**Description:** Returns the custom jsl for importing xml data.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Get XML Settings();


```

### [Import Data](#import-data)

**Syntax:** list of data tables = obj \<< Import Data

**Description:** Imports data based on the current settings and returns a list of data tables.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Folder( "$SAMPLE_IMPORT_DATA" );
mfi << Set Name Filter( "*.txt" );
mfi << Set Name Enable( 1 );
tables = mfi << Import Data();


```

### [Set Add File Date Column](#set-add-file-date-column)

**Syntax:** obj \<< Set Add File Date Column

**Description:** Set to create a column with the file size of the file the row was imported from.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Add File Date Column( 1 );


```

### [Set Add File Name Column](#set-add-file-name-column)

**Syntax:** obj \<< Set Add File Name Column

**Description:** Set to create a column with the file name the row was imported from.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Add File Name Column( 1 );


```

### [Set Add File Size Column](#set-add-file-size-column)

**Syntax:** obj \<< Set Add File Size Column

**Description:** Set to create a column with the file size of the file the row was imported from.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Add File Size Column( 1 );


```

### [Set CSV Allow Numeric](#set-csv-allow-numeric)

**Syntax:** obj \<< Set CSV Allow Numeric

**Description:** Set to 1 to allow numeric columns to be created from apparent numeric data or set to 0 to create all character columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Allow Numeric( 1 );


```

### [Set CSV EOF Comma](#set-csv-eof-comma)

**Syntax:** obj \<< Set CSV EOF Comma

**Description:** Set to 1 to use a comma to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOF Comma( 1 );


```

### [Set CSV EOF Other](#set-csv-eof-other)

**Syntax:** obj \<< Set CSV EOF Other

**Description:** Set to the value that separates fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOF Other( "\" );


```

### [Set CSV EOF Space](#set-csv-eof-space)

**Syntax:** obj \<< Set CSV EOF Space

**Description:** Set to 1 to use a space to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOF Space( 1 );


```

### [Set CSV EOF Spaces](#set-csv-eof-spaces)

**Syntax:** obj \<< Set CSV EOF Spaces

**Description:** Set to 1 to use a space to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOF Spaces( 1 );


```

### [Set CSV EOF Tab](#set-csv-eof-tab)

**Syntax:** obj \<< Set CSV EOF Tab

**Description:** Set to 1 to use a tab to separate fields that will be used to create different columns.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOF Tab( 1 );


```

### [Set CSV EOL CR](#set-csv-eol-cr)

**Syntax:** obj \<< Set CSV EOL CR

**Description:** Set to 1 to use CR as the value that separates lines that will be used to create different rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOL CR( 1 );


```

### [Set CSV EOL CRLF](#set-csv-eol-crlf)

**Syntax:** obj \<< Set CSV EOL CRLF

**Description:** Set to 1 to use CRLF as the value that separates lines that will be used to create different rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOL CRLF( 1 );


```

### [Set CSV EOL LF](#set-csv-eol-lf)

**Syntax:** obj \<< Set CSV EOL LF

**Description:** Set to 1 to use LF as the value that separates lines that will be used to create different rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOL LF( 1 );


```

### [Set CSV EOL Other](#set-csv-eol-other)

**Syntax:** obj \<< Set CSV EOL Other

**Description:** Sets the custom value the separates lines in the input file. This value creates rows in the output.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOF Other( "\" );


```

### [Set CSV EOL Semicolon](#set-csv-eol-semicolon)

**Syntax:** obj \<< Set CSV EOL Semicolon

**Description:** Set to 1 to use a semicolon to represent the lines between rows.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV EOL Semicolon( 1 );


```

### [Set CSV Escape](#set-csv-escape)

**Syntax:** obj \<< Set CSV Escape

**Description:** Sets a character that escapes special characters such as end of field, end of line, or quote delimiter.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Escape( "\" );


```

### [Set CSV First Data Line](#set-csv-first-data-line)

**Syntax:** obj \<< Set CSV First Data Line

**Description:** The line number in the import file that contains the first row of data.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV First Data Line( 4 );


```

### [Set CSV First Header Line](#set-csv-first-header-line)

**Syntax:** obj \<< Set CSV First Header Line

**Description:** Sets the first line in the import file that has headers that will be used to create column names.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Has Headers( 1 );
mfi << Set CSV First Header Line( 2 );


```

### [Set CSV Has Headers](#set-csv-has-headers)

**Syntax:** obj \<< Set CSV Has Headers

**Description:** Set to 1 to use "CSV First Header Line" and "CSV Number Of Header Lines".

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Has Headers( 1 );


```

### [Set CSV Number Of Header Lines](#set-csv-number-of-header-lines)

**Syntax:** obj \<< Set CSV Number Of Header Lines

**Description:** Sets the number of lines of headers that will be used for column names.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Has Headers( 1 );
mfi << Set CSV Number Of Header Lines( 2 );


```

### [Set CSV Quote](#set-csv-quote)

**Syntax:** obj \<< Set CSV Quote

**Description:** Sets the value that separates quoted strings.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set CSV Quote( "'" );


```

### [Set Charset](#set-charset)

**Syntax:** obj \<< Set Charset

**Description:** Sets the charset that should be used when importing data.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Charset( "Best Guess" );


```

### [Set Date Enable](#set-date-enable)

**Syntax:** obj \<< Set Date Enable

**Description:** Enables the date time filter. The default value is off which will ignore the date filter even if set.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Date Filter( {05Sep2019:14:30:00, Today()} );
mfi << Set Date Enable( 1 );


```

### [Set Date Filter](#set-date-filter)

**Syntax:** obj \<< Set Date Filter( {start of date time range, end of date time range} )

**Description:** Filters the included files based on a date and time range.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Date Filter( {05Sep2019:14:30:00, Today()} );
mfi << Set Date Enable( 1 );


```

### [Set Excel Add Sheet Name Column](#set-excel-add-sheet-name-column)

**Syntax:** obj \<< Set Excel Add Sheet Name Column

**Description:** If set to 1 a column will be added to the imported table that has the name of the spreadsheet the data came from.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Add Sheet Name Column( 1 );


```

### [Set Excel Best Guess](#set-excel-best-guess)

**Syntax:** obj \<< Set Excel Best Guess

**Description:** Dynamically find the data in each spreadsheet and make a best guess for column names. If this is set no other Excel parameters are used except for "Set Excel Add Sheet Name Column".

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Best Guess( 1 );


```

### [Set Excel Column Headers As Hierarchies](#set-excel-column-headers-as-hierarchies)

**Syntax:** obj \<< Set Excel Column Headers As Hierarchies

**Description:** Set to 1 to treat multiple column header lines as hierarchies. This reorganizes information in spanned cells in the headers and places that data in the rows of the generated table.

**JMP Version Added:** 18

```


Multiple File Import(
    fJust << Set Folder( "$sample_import_data" ),
    <<Set Name Filter( "texas precipitation.xlsx" ),
    <<Set Name Enable( 1 ),
    <<Set Excel Best Guess( 0 ),
    <<Set Excel Has Headers( 1 ),
    <<Set Excel Number of Header Lines( 2 ),
    <<Set Excel First Data Line( 3 ),
    <<Set Excel Last Data Row( 6 ),
    <<Set Excel Column Headers As Hierarchies( 1 )
) << import data;


```

### [Set Excel Column Name Separator](#set-excel-column-name-separator)

**Syntax:** obj \<< Set Excel Column Name Separator

**Description:** Set a string to be used as a separator when concatenating multiple cells into column header names.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Column Name Separator( "+" );


```

### [Set Excel First Data Column](#set-excel-first-data-column)

**Syntax:** obj \<< Set Excel First Data Column

**Description:** Sets the number of the first non-empty column in the spreadsheet that will be imported as data.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel First Data Column( 1 );


```

### [Set Excel First Data Line](#set-excel-first-data-line)

**Syntax:** obj \<< Set Excel First Data Line

**Description:** Sets the number of the first non-empty row in the spreadsheet that will be imported as data.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel First Data Line( 1 );


```

### [Set Excel First Header Line](#set-excel-first-header-line)

**Syntax:** obj \<< Set Excel First Header Line

**Description:** Sets the number of the first non-empty row in the spreadsheet that will be used to define column headers.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel First Header Line( 1 );


```

### [Set Excel Has Headers](#set-excel-has-headers)

**Syntax:** obj \<< Set Excel Has Headers

**Description:** If set the "Set Excel First Header Line" and "Set Excel Number of Header Lines" will be used to define column headers during import.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Has Headers( 1 );


```

### [Set Excel Import Color Cells](#set-excel-import-color-cells)

**Syntax:** obj \<< Set Excel Import Color Cells

**Description:** If set to 1 then the background colors of data cells will be imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Import Color Cells( 1 );


```

### [Set Excel Last Data Column](#set-excel-last-data-column)

**Syntax:** obj \<< Set Excel Last Data Column

**Description:** Sets the last column in the data area of the spreadsheet to be imported. The data area starts after all of the empty columns.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Last Data Column( 2 );


```

### [Set Excel Last Data Row](#set-excel-last-data-row)

**Syntax:** obj \<< Set Excel Last Data Row

**Description:** Set the last row in the data area of the spreadsheet to be imported. The data area starts after all of the empty rows.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Last Data Row( 1 );


```

### [Set Excel Limit Column Type Detection](#set-excel-limit-column-type-detection)

**Syntax:** obj \<< Set Excel Limit Column Type Detection

**Description:** Set to 1 to check only some of the rows in a column when auto detecting a column's data type. A value of 1 is faster, but could pick the wrong data type in cases where the data type differs between the values at the bottom of the column and the top.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Limit Column Type Detection( 1 );


```

### [Set Excel Multiple Series Stack](#set-excel-multiple-series-stack)

**Syntax:** obj \<< Set Excel Multiple Series Stack

**Description:** If set to 1 and "Set Excel Column Headers As Hierarchies" is set to 1, spanned columns will be stacked.

**JMP Version Added:** 18

```


Multiple File Import(
    <<Set Folder( "$sample_import_data" ),
    <<Set Name Filter( "texas precipitation.xlsx" ),
    <<Set Name Enable( 1 ),
    <<Set Excel Best Guess( 0 ),
    <<Set Excel Has Headers( 1 ),
    <<Set Excel Number of Header Lines( 2 ),
    <<Set Excel First Data Line( 3 ),
    <<Set Excel Last Data Row( 6 ),
    <<Set Excel Column Headers As Hierarchies( 1 ), // must be set for Multiple Series Stack
    <<Set Excel Multiple Series Stack( 1 ),

) << import data;


```

### [Set Excel Number of Header Lines](#set-excel-number-of-header-lines)

**Syntax:** obj \<< Set Excel Number of Header Lines

**Description:** Set the number of rows in the spreadsheet to be imported as column headers.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Number of Header Lines( 1 );


```

### [Set Excel Replicate Data In Spanned Rows](#set-excel-replicate-data-in-spanned-rows)

**Syntax:** obj \<< Set Excel Replicate Data In Spanned Rows

**Description:** When creating the column header, if set to 1, where there are multiple header rows and a cell spans those rows but does not span any cells horizontally, the value in the beginning of the merged area is repeated.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Replicate Data In Spanned Rows( 1 );


```

### [Set Excel Replicate Headers In Spanned Rows](#set-excel-replicate-headers-in-spanned-rows)

**Syntax:** obj \<< Set Excel Replicate Headers In Spanned Rows

**Description:** If set to 1 and there are multiple header rows and a cell spans those rows and does not span any cells horizontally, the value in start of the merged area will be repeated when creating the column header.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Replicate Headers In Spanned Rows( 1 );


```

### [Set Excel Suppress Empty Columns](#set-excel-suppress-empty-columns)

**Syntax:** obj \<< Set Excel Suppress Empty Columns

**Description:** Set to 1 to prevent empty columns from being imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Suppress Empty Columns( 1 );


```

### [Set Excel Suppress Hidden Columns](#set-excel-suppress-hidden-columns)

**Syntax:** obj \<< Set Excel Suppress Hidden Columns

**Description:** Set to 1 to prevent hidden columns from being imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Suppress Hidden Columns( 1 );


```

### [Set Excel Suppress Hidden Rows](#set-excel-suppress-hidden-rows)

**Syntax:** obj \<< Set Excel Suppress Hidden Rows

**Description:** Set to 1 to prevent hidden rows from being imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Suppress Hidden Rows( 1 );


```

### [Set Excel Worksheet Filter](#set-excel-worksheet-filter)

**Syntax:** obj \<< Set Excel Worksheet Filter

**Description:** Only worksheets that match the filter are imported.

**JMP Version Added:** 18

```


mfi = Multiple File Import();
mfi << Set Excel Worksheet Filter( "data*;sheet?" );


```

### [Set File List](#set-file-list)

**Syntax:** obj \<< Set File List

**JMP Version Added:** 18

```




```

### [Set Folder](#set-folder)

**Syntax:** obj \<< Set Folder

**Description:** Choose a different folder.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Folder( "$Desktop" );


```

### [Set Import Callback](#set-import-callback)

**Syntax:** obj \<< Set Import Callback

**Description:** Specifies a custom callback function that executes as the final step in the import process. The Multiple File Import() function passes the callback function the Multiple File Import object and a list of data tables that were opened.

**JMP Version Added:** 15

```


Create Directory( "$temp/deleteme" );
Save Text File( "$temp/deleteme/test1.txt", "a1\!n1" );
Save Text File( "$temp/deleteme/test2.txt", "a2\!n1" );
mfi = Multiple File Import(
    <<Set Folder( "$temp/deleteme/" ),
    <<Set Name Filter( "test?.txt;" ),
    <<Set Name Enable( 1 ),
    <<Set Add File Name Column( 1 ),
    <<Set Import Callback(
        Function( {a, b}, 
// a is the same is mfi
            // b is a list of datatables that were created
            Write( "\!na=", a );
            Write( "\!nb=", b );
        )
    )
);
mfi << Import Data;


```

### [Set Import Mode](#set-import-mode)

**Syntax:** obj \<< Set Import Mode

**Description:** Set to "Row Per File" to have each file create one row, "Row Per Line" to create one row for each line in each file, or "CSVData" to use the Settings option for importing.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Import Mode( "Row Per Line" );


```

### [Set JSON Guess](#set-json-guess)

**Syntax:** obj \<< Set JSON Guess( "Tall"|"Wide"|"Huge"|"Pandas" )

**Description:** Sets a JSON guess that best matches the JSON data being imported

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set JSON Method( "Guess" );
mfi << Set JSON Guess( "Tall" );


```

### [Set JSON Method](#set-json-method)

**Syntax:** obj \<< Set JSON Method

**Description:** Set to "Guess" to use a built-in guess or "JSON Settings" to supply a custom jsl.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set JSON Method( "Guess" );
mfi << Set JSON Guess( "Tall" );


```

### [Set JSON Settings](#set-json-settings)

**Syntax:** obj \<< Set JSON Settings

**Description:** Specifies custom JSL that imports JSON data.

**JMP Version Added:** 15

```


dt = Open( "$sample_data\big class.jmp" );
dt << Save( "$Documents\Big Class.json" );
Close( dt );
Multiple File Import(
    <<Set Folder( "$DOCUMENTS" ),
    <<Set Name Filter( "big*.JSON" ),
    <<Set Name Enable( 1 ),
    <<Set JSON Method( "JSON Settings" ),
    <<Set JSON Settings(
        JSON Settings(
            Stack( 0 ),
            Row( "/root" ),
            Col(
                "/root/name",
                Column Name( "name" ),
                Fill( "Use Once" ),
                Type( "Character" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            ),
            Col(
                "/root/age",
                Column Name( "age" ),
                Fill( "Use Once" ),
                Type( "Numeric" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            ),
            Col(
                "/root/sex",
                Column Name( "sex" ),
                Fill( "Use Once" ),
                Type( "Character" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            ),
            Col(
                "/root/height",
                Column Name( "height" ),
                Fill( "Use Once" ),
                Type( "Numeric" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            ),
            Col(
                "/root/weight",
                Column Name( "weight" ),
                Fill( "Use Once" ),
                Type( "Numeric" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            )
        )
    )
) << Import Data;


```

### [Set Name Enable](#set-name-enable)

**Syntax:** obj \<< Set Name Enable

**Description:** Sets whether to apply the current name filter. The default value is 0 which will ignore the name filter even if it is set.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Name Enable( 1 );


```

### [Set Name Filter](#set-name-filter)

**Syntax:** obj \<< Set Name Filter

**Description:** Enables included files to be in a semicolon-delimited list of filters that can include wildcard characters. File names that include semicolons or | must be imported with a wildcard character like ? or \*.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Name Filter( "*.csv;*.txt" );


```

### [Set PDF Method](#set-pdf-method)

**Syntax:** obj \<< Set PDF Method

**Description:** Set to "Guess" to use a built-in guess or "PDF Settings" to supply custom jsl.

**JMP Version Added:** 17

```


mfi = Multiple File Import();
mfi << Set PDF Method( "Guess" );


```

### [Set PDF Settings](#set-pdf-settings)

**Syntax:** obj \<< Set PDF Settings

**Description:** Specifies custom JSL that imports PDF data.

**JMP Version Added:** 17

```


dt = Open( "$sample_data\big class.jmp" );
win = New Window( "temp", Data Table Box( dt ) );
win << Save pdf( "$Documents\big class.PDF" );
win << Close window;
Close( dt );
Multiple File Import(
    <<Set Folder( "$DOCUMENTS" ),
    <<Set Name Filter( "big*.pdf" ),
    <<Set Name Enable( 1 ),
    <<Set PDF Method( "PDF Settings" ),
    <<Set PDF Settings( PDF All Tables( combine( all ) ) )
) << Import Data;


```

### [Set Show Hidden](#set-show-hidden)

**Syntax:** obj \<< Set Show Hidden

**Description:** Sets whether files normally hidden by Windows are included. The default is to not include hidden files.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set Show Hidden( 1 );


```

### [Set Size Enable](#set-size-enable)

**Syntax:** obj \<< Set Size Enable

**Description:** Sets whether to apply the current size filter. The default value is off which will ignore the size filter even if set.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Size Enable( 1 );
mfi << Set Size Filter( {0, 1000} );


```

### [Set Size Filter](#set-size-filter)

**Syntax:** obj \<< Set Size Filter( {smallest size to include, largest size to include} )

**Description:** Filters the included files based on file size.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Size Enable( 1 );
mfi << Set Size Filter( {0, 1000} );


```

### [Set Stack Mode](#set-stack-mode)

**Syntax:** obj \<< Set Stack Mode( "Stack Similar" | "Table Per File )

**Description:** Combines similar files being imported into one table or create one table for each file.

**JMP Version Added:** 14

```


mfi = Multiple File Import();
mfi << Set Stack Mode( "Stack Similar" );


```

### [Set Subfolders](#set-subfolders)

**Syntax:** obj \<< Set Subfolders

**Description:** Sets whether files in subfolders are included. The default is for them not to be included.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set Subfolders( 1 );


```

### [Set Use File List](#set-use-file-list)

**Syntax:** obj \<< Set Use File List

**JMP Version Added:** 18

```




```

### [Set XML Guess](#set-xml-guess)

**Syntax:** obj \<< Set XML Guess( "Tall"|"Wide"|"Huge" )

**Description:** Specifies an XML guess that best matches the XML data being imported.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set XML Method( "Guess" );
mfi << Set XML Guess( "Tall" );


```

### [Set XML Method](#set-xml-method)

**Syntax:** obj \<< Set XML Method

**Description:** Specify "Guess" for JMP to decide whether the data is tall, wide, or huge. Specify "XML Settings" to supply custom JSL.

**JMP Version Added:** 15

```


mfi = Multiple File Import();
mfi << Set XML Method( "Guess" );
mfi << Set XML Guess( "Tall" );


```

### [Set XML Settings](#set-xml-settings)

**Syntax:** obj \<< Set XML Settings

**Description:** Specifies custom JSL that imports XML data.

**JMP Version Added:** 15

```


Multiple File Import(
    <<Set Folder( "$SAMPLE_IMPORT_DATA" ),
    <<Set Name Filter( "*.xml" ),
    <<Set Name Enable( 1 ),
    <<Set XML Method( "XML Settings" ),
    <<Set XML Settings(
        XML Settings(
            Row( "/book/story/chapter/para" ),
            Col(
                "/book/story/chapter/para",
                Column Name( "story.chapter.para" ),
                Fill( "Use Once" ),
                Type( "Numeric" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            ),
            Col(
                "/book/story/chapter/para/price",
                Column Name( "story.chapter.para.price" ),
                Fill( "Use Once" ),
                Type( "Numeric" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            ),
            Col(
                "/book/story/chapter/para/quantity",
                Column Name( "story.chapter.para.quantity" ),
                Fill( "Use Once" ),
                Type( "Numeric" ),
                Format( {"Best"} ),
                Modeling Type( "Continuous" )
            )
        )
    )
) << Import Data;


```

# [Multivariate Embedding](#multivariate-embedding)

## [Associated Constructors](#associated-constructors)

### [Multivariate Embedding](#multivariate-embedding_1)

**Syntax:** Multivariate Embedding( Y( columns ) )

**Description:** Maps data from very high-dimensional spaces to a low-dimensional space, using the Uniform Manifold Approximation and Projection (UMAP) method or the t-Distributed Stochastic Neighbor Embedding (t-SNE) method. Many times, you want to map the data to either two or three dimensions so that the low-dimensional space can be easily visualized. Both methods try to preserve the local structure of the data, but UMAP is generally faster than t-SNE for large data sets.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
/* Parameters can be changed according to data features */
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Maximum Iterations( 1500 ),
    Perplexity( 15 ),
    Initial Principal Component Dimensions( 55 ),
    Random Seed( 2022 ),
    Output Dimensions( 3 )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
/* by group example */
dt << New Column( "_bycol",
    Character,
    Nominal,
    set values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( _bycol )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Item Messages](#item-messages)

### [Batch Mode if N Greater Than](#batch-mode-if-n-greater-than)

**Syntax:** Batch Mode if N greater than( number = 4096 )

**Description:** Specifies that multithreading is used for optimizing the embedding coordinates when the sample size is larger than the specified number. "4096" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Batch Mode if N greater than( 100 )
);


```

### [Convergence Criterion](#convergence-criterion)

**Syntax:** Convergence Criterion( number = 1e-8 )

**Description:** "1e-8" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Convergence Criterion( 1e-8 )
);


```

### [Distance Metric](#distance-metric)

**Syntax:** Distance Metric( "Euclidean" | "Angular" | "Hamming" | "Manhattan")

**Description:** Specifies the metric that is used to compute distances between nearest neighbors. The options for the distance metric are Euclidean (the default), Angular, Hamming, and Manhattan. This option is applicable only when ANNOY is specified as the Nearest Neighbor Method.

### [Eta](#eta)

**Syntax:** Eta( number = 200 )

**Description:** Specifies the learning rate. "200" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Eta( 200 )
);


```

### [Gradient Descent Method](#gradient-descent-method)

**Syntax:** Gradient Descent Method( "SGD" | "ADAM")

**Description:** Specifies the gradient descent method that is used for optimizing the embedding layout. You can choose between Stochastic Gradient Descent (SGD) or Adaptive Moment Estimation (ADAM). The default method is SGD. The ADAM option is available only in batch mode.

### [Inflate Iterations](#inflate-iterations)

**Syntax:** Inflate Iterations( number = 250 )

**Description:** Specifies the iteration after which the perplexities are no longer exaggerated. "250" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Inflate Iterations( 250 )
);


```

### [Initial Principal Component Dimensions](#initial-principal-component-dimensions)

**Syntax:** Initial Principal Component Dimensions( number = 50 )

**Description:** Specifies the number of dimensions that should be retained in the initial PCA step. "50" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Initial Principal Component Dimensions( 50 )
);


```

### [Initial Scale](#initial-scale)

**Syntax:** Initial Scale( number = 0.0001 )

**Description:** Specifies the initial scale that is used for the derived components. ".0001" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Initial Scale( 0.001 )
);


```

### [Learning Rate](#learning-rate)

**Syntax:** Learning Rate( number = 1.0 )

**Description:** Specifies the value of the learning rate in the computations, which impacts how quickly the model adapts to the problem. "1.0" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Learning Rate( 1.0 )
);


```

### [Local Connectivity](#local-connectivity)

**Syntax:** Local Connectivity( number = 1 )

**Description:** Specifies the number of nearest neighbors that are assumed to be connected at a local level. The default value is 1, which assumes that every point in the high-dimensional space has at least one other neighbor to which it is connected. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Local Connectivity( 1 )
);


```

### [Maximum Iterations](#maximum-iterations)

**Syntax:** Maximum Iterations( number = 1000 )

**Description:** Specifies the maximum number of iterations that are used when calculating the embedding components. "1000" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Maximum Iterations( 1500 )
);


```

### [Method](#method)

**Syntax:** Method( "t-SNE" | "UMAP" )

**Description:** Specifies the dimension reduction method.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "UMAP" )
);


```

### [Minimum Distance](#minimum-distance)

**Syntax:** Minimum Distance( number = 0.01 )

**Description:** Specifies the minimum standardized distance that points in the low-dimensional space can be from one another. "0.01" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Minimum Distance( 0.001 )
);


```

### [Missing Value Imputation](#missing-value-imputation)

**Syntax:** Missing Value Imputation( state =0|1 )

**Description:** Specifies that missing values in the data are imputed using a multivariate singular value decomposition (SVD) technique. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Missing Value Imputation( 0 )
);


```

### [Nearest Neighbor Method](#nearest-neighbor-method)

**Syntax:** Nearest Neighbor Method( "Default" | "VPTree (Exact)" | "ANNOY (Approximate)")

**Description:** Specifies the method that is used for finding nearest neighbors. You can choose between a vantage-point tree (VPTree) or the Approximate Nearest Neighbors method (ANNOY). The default option chooses the nearest neighbor method according to the sample size and the number of variables.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Method( "UMAP" ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Nearest Neighbor Method( "VPTree (Exact)" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Method( "UMAP" ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Nearest Neighbor Method( "ANNOY (Approximate)" )
);


```

### [Negative Sample Rate](#negative-sample-rate)

**Syntax:** Negative Sample Rate( number = 5 )

**Description:** Specifies the number of negative 1-simplex samples to use per positive 1-simplex sample in finding the low-dimensional representation of the data. The Negative Sample Rate value can range from 2 to 20. "5" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Negative Sample Rate( 5 )
);


```

### [Number of Epochs](#number-of-epochs)

**Syntax:** Number of Epochs( number = 500 )

**Description:** Specifies the number of training epochs to use when optimizing the low-dimensional representation. This is the number of times the algorithm works through the full training data. "500" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Epochs( 500 )
);


```

### [Number of Neighbors](#number-of-neighbors)

**Syntax:** Number of Neighbors( number = 15 )

**Description:** Specifies the number of near neighbors that are found for each data point. The smaller the number of near neighbors specified, the more the UMAP algorithm concentrates on the local structure of the data. As the number of near neighbors increases, the UMAP algorithm captures more of the global structure of the data. "15" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Method( "UMAP" ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Neighbors( 20 )
);


```

### [Output Dimensions](#output-dimensions)

**Syntax:** Output Dimensions( number = 2 )

**Description:** Specifies the number of components that are derived by the selected method. This number must be >=2. "2" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Output Dimensions( 3 )
);


```

### [Perplexity](#perplexity)

**Syntax:** Perplexity( number = 30 )

**Description:** Specifies the value of the perplexity parameter, which is related to computing similarities of the samples. The value of the perplexity parameter should be between 5 and 50 and should not be greater than one-eighth of the sample size. The default value is the smaller of 30 or one-eighth of the sample size. "30" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Perplexity( 20 )
);


```

### [Random Seed](#random-seed)

**Syntax:** Random Seed( number = 1234 )

**Description:** Specifies the random seed number that is used to obtain reproducible results. "123" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Random Seed( 1234 )
);


```

### [Save Embedding Component Values](#save-embedding-component-values)

**Syntax:** obj \<< Save Embedding Component Values

**Description:** Saves the derived embedding components as new columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Random Seed( 1234 )
);
obj << Save Embedding Component Values;


```

### [Save PQ Matrices](#save-pq-matrices)

**Syntax:** obj \<< Save PQ Matrices

**Description:** Shows the P and Q matrices, which refer to van der Maaten (2008). This option is valid only when Sparse mode for t-SNE is not selected.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Perplexity( 15 ),
    Sparse( 0 )
);
obj << Save PQ Matrices;


```

### [Sparse](#sparse)

**Syntax:** Sparse( state =0|1 )

**Description:** Specifies if sparse mode is used. Sparse mode allows for the computation for high-dimensional data sets. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Sparse( 1 )
);


```

### [Standardize](#standardize)

**Syntax:** Standardize( state =0|1 )

**Description:** Specifies if data is standardized internally prior to distance calculations. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "t-SNE" ),
    Standardize( 1 )
);


```

### [a](#a)

**Syntax:** a( number = 0 )

**Description:** Specifies one of the parameters that control the embedding optimization algorithm. If this value is specified as 0 or a negative number, a is calculated in the algorithm by a nonlinear least squares procedure. "0" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    a( 0 )
);


```

### [b](#b)

**Syntax:** b( number = 0 )

**Description:** Specifies one of the parameters that control the embedding optimization algorithm. If this value is specified as 0 or a negative number, b is calculated in the algorithm by a nonlinear least squares procedure. "0" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    b( 0 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Multivariate Embedding(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Multivariate Embedding(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Multivariate](#multivariate)

## [Associated Constructors](#associated-constructors)

### [Multivariate](#multivariate_1)

**Syntax:** Multivariate( Y( columns ) )

**Description:** Explores correlation and associations among numeric variables using a variety of multivariate analysis techniques. These techniques include both parametric and nonparametric measures of association, scatterplot matrices, principal components analysis, outlier analysis, and item reliability.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Freq( :_freqcol )
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Weight( :_weightcol )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );


```

## [Item Messages](#item-messages)

### [CI of Correlation](#ci-of-correlation)

**Syntax:** obj \<< CI of Correlation( state=0|1 )

**Description:** Shows or hides a report of the correlations between each Y variable and the confidence intervals for each correlation.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << CI of Correlation( 1 );


```

### [Cluster the Correlations](#cluster-the-correlations)

**Syntax:** obj \<< Cluster the Correlations( state=0|1 )

**Description:** Shows or hides a color map on clustered correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Cluster the Correlations( 1 );


```

### [Color Map on Correlations](#color-map-on-correlations)

**Syntax:** obj \<< Color Map on Correlations( state=0|1 )

**Description:** Shows or hides a color map on correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Color Map on Correlations( 1 );


```

### [Color Map on Hoeffding's D](#color-map-on-hoeffdings-d)

**Syntax:** obj \<< Color Map on Hoeffding's D( state=0|1 )

**Description:** Shows or hides a color map on Hoeffding's D nonparametric correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Color Map on Hoeffding's D( 1 );


```

### [Color Map on Kendall's Tau](#color-map-on-kendalls-tau)

**Syntax:** obj \<< Color Map on Kendall's Tau( state=0|1 )

**Description:** Shows or hides a color map on Kendall's Tau nonparametric correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Color Map on Kendall's Tau( 1 );


```

### [Color Map on Kendall's τ](#color-map-on-kendalls)

**Syntax:** obj \<< Color Map on Kendall's τ( state=0|1 )

**Description:** Shows or hides a color map on Kendall's Tau nonparametric correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Color Map on Kendall's Tau( 1 );


```

### [Color Map on Pairwise Correlations](#color-map-on-pairwise-correlations)

**Syntax:** obj \<< Color Map on Pairwise Correlations( state=0|1 )

**Description:** Shows or hides a color map on the pairwise correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Color Map on Pairwise Correlations( 1 );


```

### [Color Map on Spearman's Rho](#color-map-on-spearmans-rho)

**Syntax:** obj \<< Color Map on Spearman's Rho( state=0|1 )

**Description:** Shows or hides a color map on Spearman's Rho nonparametric correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Color Map on Spearman's Rho( 1 );


```

### [Color Map on Spearman's ρ](#color-map-on-spearmans)

**Syntax:** obj \<< Color Map on Spearman's ρ( state=0|1 )

**Description:** Shows or hides a color map on Spearman's Rho nonparametric correlations, starting at blue for negatively correlated and moving to red as the correlations approach one.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Color Map on Spearman's Rho( 1 );


```

### [Color Map on p-Values](#color-map-on-p-values)

**Syntax:** obj \<< Color Map on p-Values( state=0|1 )

**Description:** Shows or hides a color map on p-values, starting at red for p-values close to zero and moving to blue as the p-values approach one.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << "Color Map on p-Values"n( 1 );


```

### [Correlation Probability](#correlation-probability)

**Syntax:** obj \<< Correlation Probability( state=0|1 )

**Description:** Shows or hides a matrix of p-values that each correspond to a test of the null hypothesis that the true correlation between the variables is zero.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Correlation Probability( 1 );


```

### [Correlations Multivariate](#correlations-multivariate)

**Syntax:** obj \<< Correlations Multivariate( state=0|1 )

**Description:** Shows or hides a matrix of correlation coefficients that summarize the strength of the linear relationships between each pair of Y variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Correlations Multivariate( 1 );


```

### [Covariance Matrix](#covariance-matrix)

**Syntax:** obj \<< Covariance Matrix( state=0|1 )

**Description:** Shows or hides a matrix of covariances for each pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Covariance Matrix( 1 );


```

### [Create SAS Job](#create-sas-job)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates SAS Proc Mixed code to run similar estimation methods through SAS.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), Variance Estimation( "REML" ) );
obj << Create SAS Job();


```

### [Cronbach's Alpha](#cronbachs-alpha)

**Syntax:** obj \<< Cronbach's Alpha( state=0|1 )

**Description:** Shows or hides a report of Cronbach's alpha for the entire set of variables as well as the alpha if each Y variable was individually excluded.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Cronbach's alpha( 1 );


```

### [Cronbach's α](#cronbachs)

**Syntax:** obj \<< Cronbach's α( state=0|1 )

**Description:** Shows or hides a report of Cronbach's alpha for the entire set of variables as well as the alpha if each Y variable was individually excluded.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Cronbach's alpha( 1 );


```

### [Ellipsoid 3D Plot](#ellipsoid-3d-plot)

**Syntax:** obj \<< Ellipsoid 3D Plot( column1, column2, column3 )

**Description:** Shows or hides a surface plot that displays a 95% ellipsoid for three chosen Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Ellipsoid 3D Plot( :Ether, :Chloroform, :Benzene );


```

### [Get Correlation Matrix](#get-correlation-matrix)

**Syntax:** obj \<< Get Correlation Matrix

**Description:** Returns the correlation matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
corr = obj << Get Correlation Matrix;
Show( corr );


```

### [Get Inv Correlation Matrix](#get-inv-correlation-matrix)

**Syntax:** obj \<< Get Inv Correlation Matrix

**Description:** Returns the inverse correlation matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), Inverse Correlations( 1 ) );
icorr = obj << Get Inv Correlation Matrix;
Show( icorr );


```

### [Hoeffding's D](#hoeffdings-d)

**Syntax:** obj \<< Hoeffding's D( state=0|1 )

**Description:** Shows or hides a report of Hoeffding's D statistic for every pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Hoeffding's D( 1 );


```

### [Hotelling's T Square Test](#hotellings-t-square-test)

**Syntax:** obj \<< Hotelling's T Square Test

**Description:** Performs a one-sample test for the mean of the multivariate distribution of the Y variables, given the specified mean vector under the null hypothesis.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Hotelling's T Square Test( 1, 0.7, 0.5, 0, -1 );


```

### [Impute Missing Data](#impute-missing-data)

**Syntax:** obj \<< Impute Missing Data

**Description:** Imputes missing values for all the Y variables and creates a new data table containing both the existing values and newly imputed missing data values.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Impute Missing Data;


```

### [Inverse Correlations](#inverse-correlations)

**Syntax:** obj \<< Inverse Correlations( state=0|1 )

**Description:** Shows or hides a matrix of the inverse correlations between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Inverse Correlations( 1 );


```

### [Jackknife Distances](#jackknife-distances)

**Syntax:** obj \<< Jackknife Distances( state = 0|1, <Save Jackknife Distances> )

**Description:** Shows or hides a graph of the jackknife distances for each row, together with a reference line that indicates possible outliers.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Jackknife Distances( 1 );


```

### [Kendall's Tau](#kendalls-tau)

**Syntax:** obj \<< Kendall's Tau( state=0|1 )

**Description:** Shows or hides a report of Kendall's Tau statistic for every pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Kendall's Tau( 1 );


```

### [Kendall's τ](#kendalls)

**Syntax:** obj \<< Kendall's τ( state=0|1 )

**Description:** Shows or hides a report of Kendall's Tau statistic for every pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Kendall's Tau( 1 );


```

### [Mahalanobis Distances](#mahalanobis-distances)

**Syntax:** obj \<< Mahalanobis Distances( state = 0|1, <Save Outlier Distances> )

**Description:** Shows or hides a graph of the Mahalanobis distances for each row, together with a reference line that indicates possible outliers.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Mahalanobis Distances( 1 );


```

### [Matrix Format](#matrix-format)

**Syntax:** obj = Multivariate(...Matrix Format( "Lower Triangular"|"Upper Triangular"|"Square" )...)

**Description:** Specifies how the variables are displayed in the Scatterplot Matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), Matrix Format( "Lower Triangular" ) );


```

### [Multivariate Simple Statistics](#multivariate-simple-statistics)

**Syntax:** obj \<< Multivariate Simple Statistics( state=0|1 )

**Description:** Shows or hides a multivariate simple statistics report, where the statistics are calculated by excluding any row that has a missing value.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :POP, :OZONE, :CO, :SO2, :NO ) );
obj << Multivariate Simple Statistics( 1 );


```

### [Pairwise Correlations](#pairwise-correlations)

**Syntax:** obj \<< Pairwise Correlations( state=0|1 )

**Description:** Shows or hides a report of the pairwise correlations for each combination of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Pairwise Correlations( 1 );


```

### [Parallel Coord Plot](#parallel-coord-plot)

**Syntax:** obj \<< Parallel Coord Plot( state=0|1 )

**Description:** Shows or hides a parallel coordinate plot of the variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Parallel Coord Plot( 1 );


```

### [Partial Correlation Diagram](#partial-correlation-diagram)

**Syntax:** obj \<< Partial Correlation Diagram( state=0|1 )

**Description:** Shows or hides the Partial Correlation Diagram report. This option performs an eigenvalue decomposition on the partial correlation matrix and uses the results to give a visual representation of the partial correlations.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Partial Correlation Diagram( 1 );


```

### [Partial Correlation Probability](#partial-correlation-probability)

**Syntax:** obj \<< Partial Correlation Probability( state=0|1 )

**Description:** Shows or hides a matrix of p-values that each correspond to a test of the null hypothesis that the true partial correlation between the variables is zero.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Partial Correlation Probability( 1 );


```

### [Partial Correlations](#partial-correlations)

**Syntax:** obj \<< Partial Correlations( state=0|1 )

**Description:** Shows or hides a matrix of partial correlations between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Partial Correlations( 1 );


```

### [Save Imputed Formula](#save-imputed-formula)

**Syntax:** obj \<< Save Imputed Formula

**Description:** Imputes values where the Y column values are missing. Creates and saves a new column with an imputation formula to the original data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Imputed Formula;


```

### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** obj \<< Scatterplot Matrix( state=0|1 )

**Description:** Shows or hides a scatterplot matrix for each pair of Y variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( 0 )
);


```

### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj \<< Set Alpha Level( "0.01"|"0.05"|"0.10"|"0.50"|"Other…"=0.05 )

**Description:** Changes the alpha level for the confidence intervals about each correlation. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Set Alpha Level( 0.01 );
obj << CI of Correlation( 1 );


```

### [Set α Level](#set-level)

**Syntax:** obj \<< Set α Level( "0.01"|"0.05"|"0.10"|"0.50"|"Other…"=0.05 )

**Description:** Changes the alpha level for the confidence intervals about each correlation. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Set α Level( 0.01 );
obj << CI of Correlation( 1 );


```

### [Spearman's Rho](#spearmans-rho)

**Syntax:** obj \<< Spearman's Rho( state=0|1 )

**Description:** Shows or hides a report of Spearman's Rho statistic for each pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Spearman's Rho( 1 );


```

### [Spearman's ρ](#spearmans)

**Syntax:** obj \<< Spearman's ρ( state=0|1 )

**Description:** Shows or hides a report of Spearman's Rho statistic for each pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Spearman's Rho( 1 );


```

### [Standardized Alpha](#standardized-alpha)

**Syntax:** obj \<< Standardized Alpha( state=0|1 )

**Description:** Shows or hides a report of Cronbach's standardized alpha for the entire set of variables as well as the standardized alpha if each Y variable was individually excluded.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Standardized alpha( 1 );


```

### [Standardized α](#standardized)

**Syntax:** obj \<< Standardized α( state=0|1 )

**Description:** Shows or hides a report of Cronbach's standardized alpha for the entire set of variables as well as the standardized alpha if each Y variable was individually excluded.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Standardized alpha( 1 );


```

### [T Square](#t-square)

**Syntax:** obj \<< T Square( state = 0|1, <Save T Square> )

**Description:** Shows or hides a graph of the T² values for each row, together with a reference line indicating possible outliers.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << T Square( 1 );


```

### [T²](#t2)

**Syntax:** obj \<< T²( state = 0|1, <Save T Square> )

**Description:** Shows or hides a graph of the T² values for each row, together with a reference line indicating possible outliers.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << T Square( 1 );


```

### [Univariate Simple Statistics](#univariate-simple-statistics)

**Syntax:** obj \<< Univariate Simple Statistics( state=0|1 )

**Description:** Shows or hides a univariate simple statistics report, where the statistics are calculated for each column independently from other columns that might have missing data.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :POP, :OZONE, :CO, :SO2, :NO ) );
obj << Univariate Simple Statistics( 1 );


```

### [Variance Estimation](#variance-estimation)

**Syntax:** Variance Estimation( REML|ML|Robust|Row-wise|Pairwise )

**Description:** Sets the estimation method for computing the correlations.

If there are no missing values, then the default is Row-wise.

If there are missing values, and the number of variables \<= 10 and the number of rows \<=5000, then the default is REML.

If there are missing values, and the number of variables > 10 or number of rows > 5000, then the default is Pairwise.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), Variance Estimation( "ML" ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate( Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Multivariate(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Principal Component Options](#principal-component-options)

### [Item Messages](#item-messages_1)

#### [3D Score Plot](#3d-score-plot)

**Syntax:** obj \<< 3D Score Plot( state=0|1 )

**Description:** Shows or hides a 3-D scatterplot of the principal components as rays in a three-dimensional space.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", "3D Score Plot"n );


```

#### [Bartlett Test](#bartlett-test)

**Syntax:** obj \<< Bartlett Test( state=0|1 )

**Description:** Shows or hides a report of the results of the homogeneity test for each of the principal components.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", Bartlett Test( 1 ) );


```

#### [Eigenvectors](#eigenvectors)

**Syntax:** obj \<< Eigenvectors( state=0|1 )

**Description:** Shows or hides a report of the eigenvectors for each of the principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", Eigenvectors( 1 ) );


```

#### [Factor Rotation](#factor-rotation)

**Syntax:** obj \<< Factor Rotation( \<ML|PC>, 1|SMC, n Rotated, Varimax|Biquartimax| Equamax| Factorparsimax| Orthomax| Parsimax| Quartimax| Biquartimin| Covarimin| Obbiquartimax| Obequamax| Obfactorparsimax| Obequamax| Obfactorparsimax| Oblimin| Obparsimax| Obquartimax| Obvarimax| Quartimin| Promax )

**Description:** Shows or hides a report of the factor rotation pattern for the principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components(
    "on Correlations",
    Factor Rotation( "ML", "SMC", 2, "Varimax" )
);


```

#### [Loading Plot](#loading-plot)

**Syntax:** obj \<< Loading Plot( number )

**Description:** Shows or hides a matrix of plots that are two-dimensional representations of factor loadings.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", Loading Plot( 2 ) );


```

#### [Save Principal Components](#save-principal-components)

**Syntax:** obj \<< Save Principal Components( number )

**Description:** Saves the given number of principal components to new columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", Save Principal Components( 3 ) );


```

#### [Save Principal Components with Imputation](#save-principal-components-with-imputation)

**Syntax:** obj \<< Save Principal Components with Imputation( number )

**Description:** Saves the given number of principal components computed using imputation on missing values to new columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components(
    "on Correlations",
    Save Principal Components with Imputation( 3 )
);


```

#### [Save Rotated Components](#save-rotated-components)

**Syntax:** obj \<< Save Rotated Components

**Description:** Saves the rotated components to new columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components(
    "on Correlations",
    Factor Rotation( "SMC", 2, "Varimax" ),
    Save Rotated Components
);


```

#### [Save Rotated Components with Imputation](#save-rotated-components-with-imputation)

**Syntax:** obj \<< Save Rotated Components with Imputation

**Description:** Saves the rotated components computed using imputation on missing values to new columns in the data table. Note: This option is only available after the Factor Rotation has been run.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components(
    "on Correlations",
    Factor Rotation( "SMC", 2, "Varimax" ),
    Save Rotated Components with Imputation
);


```

#### [Score Plot](#score-plot)

**Syntax:** obj \<< Score Plot( number )

**Description:** Shows or hides a matrix of scatterplots that contain the scores for each pair of the specified number of principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", Score Plot( 2 ) );


```

#### [Score Plot with Imputation](#score-plot-with-imputation)

**Syntax:** obj \<< Score Plot with Imputation( number )

**Description:** Shows or hides a matrix of scatterplots that contain the scores for each pair of the specified number of principal components, using imputation for missing values.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", Score Plot with Imputation( 2 ) );


```

#### [Scree Plot](#scree-plot)

**Syntax:** obj \<< Scree Plot( state=0|1 )

**Description:** Shows or hides a line plot of the eigenvalues for each component.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Multivariate( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Principal Components( "on Correlations", Scree Plot( 1 ) );


```

## [Scatterplot Matrix Message](#scatterplot-matrix-message)

### [Item Messages](#item-messages_2)

#### [Density Ellipses](#density-ellipses)

**Syntax:** Density Ellipses( state=0|1 )

**Description:** Shows or hides the density ellipses on the scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Density Ellipses( 1 ) )
);


```

#### [Ellipse Alpha](#ellipse-alpha)

**Syntax:** obj \<< Ellipse Alpha( "0.90"|"0.95"|"0.99"|"Other…" )

**Description:** Changes the alpha level for the density ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Density Ellipses( 1 ), Ellipse Alpha( 0.1 ) )
);


```

#### [Ellipse Color](#ellipse-color)

**Syntax:** Ellipse Color( color )

**Description:** Changes the color for the density ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Density Ellipses( 1 ), Ellipse Color( "Blue" ) )
);


```

#### [Ellipse α](#ellipse)

**Syntax:** obj \<< Ellipse α( "0.90"|"0.95"|"0.99"|"Other…" )

**Description:** Changes the alpha level for the density ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Density Ellipses( 1 ), Ellipse Alpha( 0.1 ) )
);


```

#### [Ellipses Coverage](#ellipses-coverage)

**Syntax:** obj \<< Ellipses Coverage( "0.90"|"0.95"|"0.99"|"Other…" )

**Description:** Changes the alpha level for the density ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Density Ellipses( 1 ), Ellipses Coverage( 0.9 ) )
);


```

#### [Ellipses Transparency](#ellipses-transparency)

**Syntax:** obj \<< Ellipses Transparency( "0.20"|"0.40"|"0.60"|"Other…" )

**Description:** Changes the transparency for the shaded density ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Ellipses Transparency( 0.6 ), Shaded Ellipses( 1 ) )
);


```

#### [Fit Line](#fit-line)

**Syntax:** obj \<< Fit Line( state=0|1 )

**Description:** Shows or hides the regression line and confidence interval on the scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Fit line( 1 ) )
);


```

#### [Heat Map](#heat-map)

**Syntax:** Heat Map( state=0|1 )

**Description:** Shows or hides a correlation heat map in the upper right triangle of the scatterplot matrix. The color of each cell in the heat map represents the correlation between each pair of variables.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Heat Map( 1 ) )
);


```

#### [Horizontal](#horizontal)

**Syntax:** Horizontal( state=0|1 )

**Description:** Displays histograms horizontally in the diagonal of the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Horizontal( 1 ) )
);


```

#### [Nonpar Density](#nonpar-density)

**Syntax:** Nonpar Density( state=0|1 )

**Description:** Shows or hides shaded nonparametric density contours for the 0.90 and 0.50 quantiles.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Nonpar Density( 1 ) )
);


```

#### [Shaded Ellipses](#shaded-ellipses)

**Syntax:** Shaded Ellipses( state=0|1 )

**Description:** Shades or makes clear the region inside the ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Shaded Ellipses( 1 ) )
);


```

#### [Show Correlations](#show-correlations)

**Syntax:** Show Correlations( state=0|1 )

**Description:** Shows or hides the correlation of each pair of variables in the upper left corner of each scatterplot.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Show Correlations( 1 ) )
);


```

#### [Show Counts](#show-counts)

**Syntax:** Show Counts( state=0|1 )

**Description:** Shows or hides the counts that label each bar in the histograms in the diagonal of the scatterplot matrix between each Y variable. Note: Available only after the histogram has been displayed.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Vertical( 1 ), Show Counts( 1 ) )
);


```

#### [Show Points](#show-points)

**Syntax:** Show Points( state=0|1 )

**Description:** Shows or hides the points on the scatterplot matrix. On by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Show Points( 1 ) )
);


```

#### [Significance Circles](#significance-circles)

**Syntax:** Significance Circles( state=0|1 )

**Description:** Shows or hides correlation circles in the upper right triangle of the scatterplot matrix. The circle color represents the correlation and the circle size represents the significance test between each pair of variables.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Significance Circles( 1 ) )
);


```

#### [Vertical](#vertical)

**Syntax:** Vertical( state=0|1 )

**Description:** Displays histograms vertically in the diagonal of the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Vertical( 1 ) )
);


```

# [Naive Bayes](#naive-bayes)

## [Associated Constructors](#associated-constructors)

### [Naive Bayes](#naive-bayes_1)

**Syntax:** Naive Bayes( Y( column ), X( columns ), Method( "Naive Bayes" ) )

**Description:** Predicts group membership for a categorical variable based on the closeness of its predictor values to the predictor values for each group.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Naive Bayes(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Factor](#factor)

**Syntax:** obj = Naive Bayes(...Factor( column(s) )...)

**Description:** Specifies the categorical or continuous predictor columns.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Freq](#freq)

**Syntax:** obj = Naive Bayes(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = dt << Naive Bayes(
    Y( :clean ),
    X(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Freq( :SampleSize )
);


```

### [Response](#response)

**Syntax:** obj = Naive Bayes(...Response( column )...)

**Description:** Specifies the categorical response column whose values represent the classes of interest.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Validation](#validation)

**Syntax:** obj = Naive Bayes(...\<Validation( column )>...)

**Description:** Specifies a numeric column that defines the validation sets. This column should contain at most three distinct values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Naive Bayes(
    Y( :Y Binary ),
    X( :Age, :Gender, :BMI ),
    Validation( :Validation )
);


```

### [Weight](#weight)

**Syntax:** obj = Naive Bayes(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = dt << Naive Bayes(
    Y( :clean ),
    X(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Weight( :SampleSize )
);


```

### [X](#x)

**Syntax:** obj = Naive Bayes(...X( column(s) )...)

**Description:** Specifies the categorical or continuous predictor columns.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Y](#y)

**Syntax:** obj = Naive Bayes(...Y( column )...)

**Description:** Specifies the categorical response column whose values represent the classes of interest.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Item Messages](#item-messages)

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Get Measures;


```

### [Get Probability Formulas](#get-probability-formulas)

**Syntax:** obj \<< Get Probability Formulas

**Description:** Returns a script to create probability formulas.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Get Probability Formulas;


```

### [Lift Curve](#lift-curve)

**Syntax:** obj \<< Lift Curve( state=0|1 ) )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    ROC Curve( 0 )
);
obj << Lift Curve( 1 );


```

### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Precision Recall Curve( 1 );


```

### [Prior Bias](#prior-bias)

**Syntax:** obj = Naive Bayes(...Prior Bias( fraction=.5 )...)

**Description:** Sets the prior bias value. The value is divided by the number of response levels and then this quantity is added to the counts to ensure nonzero rate estimates. ".5" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Naive Bayes(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Prior Bias( 0.001 )
);


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
Wait( 0 );
obj << Profiler( 1 );


```

### [Publish Probability Formulas](#publish-probability-formulas)

**Syntax:** obj \<< Publish Probability Formulas

**Description:** Creates probability formulas and saves them as formula column scripts in the Formula Depot platform. If a Formula Depot report is not open, this option creates a Formula Depot report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Publish Probability Formulas;


```

### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 ) )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    ROC Curve( 0 )
);
Wait( 1 );
obj << ROC Curve( 1 );


```

### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds

**Description:** Saves a new column to the data table. The column contains the predicted classifications.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Predicteds;


```

### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves a new column to the data table. The column contains the prediction formula for the classifications.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Prediction Formula;


```

### [Save Probability Formula](#save-probability-formula)

**Syntax:** obj \<< Save Probability Formula

**Description:** Saves new columns to the data table. The columns contain the formulas that are used to classify each observation.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Probability Formula;


```

### [Use Excluded Rows for Validation](#use-excluded-rows-for-validation)

**Syntax:** obj = Naive Bayes(...Use Excluded Rows for Validation( state=0|1 )...)

**Description:** Uses the excluded rows in the data table to create a validation set. This option appears in the launch window only if you are using standard JMP and there are excluded rows.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Naive Bayes(
    Y( :Y Binary ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 )
);


```

### [Validation Portion](#validation-portion)

**Syntax:** obj = Naive Bayes(...Validation Portion( fraction=0 )...)

**Description:** Specifies the portion of the data to be used as the Validation set. "0" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Naive Bayes(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Naive Bayes(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Naive Bayes(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Namespace](#namespace)

## [Associated Constructors](#associated-constructors)

### [New Namespace](#new-namespace)

**Syntax:** ns = New Namespace( <name>, <list of expressions> )

**Description:** Creates a namespace where all functions and variables created are defined only within the specified name.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);


```

## [Item Messages](#item-messages)

### [Contains](#contains)

**Syntax:** obj \<< Contains( string )

**Description:** Returns a 1 if the namespace contains the specified string expression, or a 0 otherwise.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << Contains( "nObs" );


```

### [Delete Namespace](#delete-namespace)

**Syntax:** nsref \<< Delete Namespace( < Force( boolean ) > )

**Description:** Deletes this namespace.

**JMP Version Added:** 14

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
nsref << Delete Namespace;
Show( nsref );


```

### [First](#first)

**Syntax:** obj \<< First

**Description:** Returns the string expression for the first item in this namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << First;


```

### [Get Contents](#get-contents)

**Syntax:** obj \<< Get Contents

**Description:** Returns a list of items within this namespace, where each element is a two item list containing a key and its associated value.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << Get Contents;


```

### [Get Keys](#get-keys)

**Syntax:** obj \<< Get Keys

**Description:** Returns a list of keys within this namespace, where a key is string representation of an individual item contained in the namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << Get Keys;


```

### [Get Name](#get-name)

**Syntax:** obj \<< Get Name

**Description:** Returns the name of this namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
space name = nsref << Get Name;


```

### [Get Value](#get-value)

**Syntax:** obj \<< Get Value( string )

**Description:** Returns the value of the specified item within this namespace. The "string" is the key to the item.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << Get Value( "nObs" );


```

### [Get Values](#get-values)

**Syntax:** obj \<< Get Values

**Description:** Returns a list of values corresponding to each item within this namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << Get Values;


```

### [Insert](#insert)

**Syntax:** obj \<< Insert( string, value )

**Description:** Inserts a string expression, with the specified value into this namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
nsref << Insert( "X", 25 );
Show( nsref );


```

### [Lock Namespace](#lock-namespace)

**Syntax:** obj \<< Lock Namespace( \<string, | {string, ...}>\* )

**Description:** Locks all variables or specified named variables in this namespace and prevents variables from being added, changed, or removed.

**JMP Version Added:** 14

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
nsref << Lock Namespace;
Try( Add Class:nObs = 40, "Add Class is locked." );


```

### [N Items](#n-items)

**Syntax:** obj \<< N Items

**Description:** Returns the number of items contains in this namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
n = nsref << N Items;


```

### [Next](#next)

**Syntax:** obj \<< Next( string )

**Description:** Returns the string expression for the next item following the key specified in this namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << Next( "addition" );


```

### [Remove](#remove)

**Syntax:** obj \<< Remove( \<string | {string, ...}>\* )

**Description:** Removes the specified string expression from the namespace.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
nsref << Remove( "nObs" );
Show( nsref );


```

### [Show Contents](#show-contents)

**Syntax:** obj \<< Show Contents

**Description:** Shows the contents of a namespace in the JMP log.

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
result = nsref << Show Contents;


```

### [Unlock Namespace](#unlock-namespace)

**Syntax:** obj \<< Unlock Namespace( \<string | {string, ...}>\* )

**Description:** Unlocks a previously locked namespace with all variables locked in this namespace and prevented variables from being added, changed, or removed.

**JMP Version Added:** 14

```

nsref = New Namespace(
    "Add Class"
);
Add Class:nObs = 20;
Add Class:addition = Function( {x, y}, x + y );
Add Class:append = Function( {a, b},
    Char( a ) || " + " || Char( b )
);
nsref << Lock Namespace( "nObs" );
Try( Add Class:nObs = 30, Show( "Add Class is locked." ) ); 
//Try again after unlocking. 
nsref << Unlock Namespace( "nObs" );
Try( Add Class:nObs = 40, Show( "Add Class is locked." ) );


```

# [Neural](#neural)

## [Associated Constructors](#associated-constructors)

### [Neural](#neural_1)

**Syntax:** Neural( Y( column ), X( columns ), \<Validation( column )> )

**Description:** Predicts one or more response variables using a flexible function of the input variables. The flexible framework incorporates layering and s-shaped functions.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Neural(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);


```

### [Factor](#factor)

**Syntax:** obj = Neural(...Factor( column(s) )...)

**Description:** Specifies the predictor variables.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);


```

### [Freq](#freq)

**Syntax:** obj = Neural(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Freq( :_freqcol ),
    Go
);


```

### [Response](#response)

**Syntax:** obj = Neural(...Response( column(s) )...)

**Description:** Specifies the response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);


```

### [Validation](#validation)

**Syntax:** obj = Neural(...\<Validation( column )>...)

**Description:** Specifies a numeric column that defines the validation sets. This column should contain at most three distinct values.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation )
);
obj << Go;


```

### [X](#x)

**Syntax:** obj = Neural(...X( column(s) )...)

**Description:** Specifies the predictor variables.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);


```

### [Y](#y)

**Syntax:** obj = Neural(...Y( column(s) )...)

**Description:** Specifies the response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);


```

## [Item Messages](#item-messages)

### [Fit](#fit)

**Syntax:** obj \<< Fit( NTanH|NLinear|NTanH2|NLinear2|NGaussian|NGaussian2( number ) )

**Description:** Specifies and fits the hidden layer structure of the neural network to the data. Multiple layers and non-TanH activation functions are only available in JMP Pro. To specify multiple layers and activation functions, separate the arguments with commas.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Fit( NTanH( 4 ) );


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Starts solving the neural net model.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
Wait( 1 );
obj << Go;


```

### [Informative Missing](#informative-missing)

**Syntax:** obj = Neural(...Informative Missing( state=0|1 )...)

**Description:** Enables missing value imputation and coding. When this option is not selected, rows with missing values are ignored.

For continuous variables, missing values are replaced by the mean of the variable. Also, a missingness indicator variable is created and included in the model.

For categorical variables, the missing values are not imputed, but are treated as another level of the variable in the model. This option is available only in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Neural( Y( :weight ), X( :height, :age ), Informative Missing( 1 ), Go );


```

### [Learning Rate](#learning-rate)

**Syntax:** obj \<< Learning Rate( fraction )

**Description:** Specifies the scaling factor for boosting. A learning rate close to 1 results in faster convergence on a final model, but also has a higher tendency to overfit data. This option is available only in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    N Boost( 2 )
);
obj << Learning Rate( 0.2 );
obj << Go;
obj << SendToReport( Dispatch( {}, "Model Launch", OutlineBox, {Close( 0 )} ) );


```

### [Multithreading](#multithreading)

**Syntax:** obj = Neural(...Multithreading( state=0|1 )...)

**Description:** Divides up the calculations among the available threads on the machine. On by default.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 0 )
);
obj << Go;


```

### [N Boost](#n-boost)

**Syntax:** obj \<< N Boost( number )

**Description:** Specifies the maximum number of models that are used for boosting. This option is available only in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << N Boost( 2 );
obj << Go;
obj << SendToReport( Dispatch( {}, "Model Launch", OutlineBox, {Close( 0 )} ) );


```

### [Penalty Method](#penalty-method)

**Syntax:** obj \<< Penalty Method( "Squared"|"Absolute"|"Weight Decay"|"NoPenalty" )

**Description:** Specifies a penalty method to impose a penalty on the likelihood during the fitting process. A penalty parameter mitigates the tendency in neural networks to overfit the data. The Squared option works well if you think most of your X variables are contributing to the predictive ability of the model. The Absolute option and the Weight Decay option work well if you have a large number of X variables and you think that a few contribute more than others.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Penalty Method( "Absolute" );
obj << Go;
obj << SendToReport( Dispatch( {}, "Model Launch", OutlineBox, {Close( 0 )} ) );


```

### [Robust Fit](#robust-fit)

**Syntax:** obj \<< Robust Fit( state=0|1 )

**Description:** Trains the model using least absolute deviations instead of least squares. This option is useful if you want to minimize the impact of response outliers. This option is available only for continuous responses in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Robust Fit( 1 );
obj << Go;
obj << SendToReport( Dispatch( {}, "Model Launch", OutlineBox, {Close( 0 )} ) );


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Neural(...Set Random Seed( number )...)

**Description:** Specifies a random seed that is used to reproduce starting values and validation assignment.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 )
);
Wait( 1 );
obj << Go;


```

### [Transform Covariates](#transform-covariates)

**Syntax:** obj \<< Transform Covariates( state=0|1 )

**Description:** Transforms all continuous variables to near normality using either the Johnson Su or Johnson Sb distribution. Transforming the continuous variables helps to mitigate the negative effects of outliers or heavily skewed distributions. This option is available only in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Transform Covariates( 1 );
obj << Go;
obj << SendToReport( Dispatch( {}, "Model Launch", OutlineBox, {Close( 0 )} ) );


```

### [Validation Method](#validation-method)

**Syntax:** obj = Neural(...Validation Method( "Excluded Rows Holdback"|"Holdback", \<fraction = 0.3333>|"KFold", \<number = 5> )...);

**Description:** Specifies the method used for model validation.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Method( "Holdback", 0.4 ),
    Go
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Neural(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Neural Fit](#neural-fit)

### [Item Messages](#item-messages_1)

#### [Categorical Profiler](#categorical-profiler)

**Syntax:** obj \<< (fit[number] \<< Categorical Profiler( state=0|1 ))

**Description:** Shows or hides a prediction profiler with all categorical responses combined into a single profiler row.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Categorical Profiler( 1 ));


```

#### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< (fit[number] \<< Contour Profiler( state=0|1 ))

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time. Available only when the model contains more than one continuous factor.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Contour Profiler( 1 ));


```

#### [Decision Threshold](#decision-threshold)

**Syntax:** obj \<< fit([number] \<< Decision Threshold( state = 0|1, Set Probability Threshold( number ) ))

**Description:** Shows or hides the distribution of fitted probabilities and actual versus predicted tables for each model. You can change the probability threshold to explore how different thresholds affect the classification results.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
Wait( 0 );
obj << (Fit[1] << Decision Threshold( 1 ));
Wait( 1 );
obj << (Fit[1] << Decision Threshold( 1, Set Probability Threshold( .7 ) ));


```

#### [Diagram](#diagram)

**Syntax:** obj \<< (fit[number] \<< Diagram( state=0|1 ))

**Description:** Shows or hides a diagram that represents the hidden layer structure.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Diagram( 1 ));


```

#### [Get Average Absolute Error Test](#get-average-absolute-error-test)

**Syntax:** obj \<< (fit[number] \<< Get Average Absolute Error Test)

**Description:** Returns the Mean Abs Dev statistic for the test set. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
ae = obj << (Fit[1] << Get Average Absolute Error Test);
Show( ae );


```

#### [Get Average Absolute Error Training](#get-average-absolute-error-training)

**Syntax:** obj \<< (fit[number] \<< Get Average Absolute Error Training)

**Description:** Returns the Mean Abs Dev statistic for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
ae = obj << (Fit[1] << Get Average Absolute Error Training);
Show( ae );


```

#### [Get Average Absolute Error Validation](#get-average-absolute-error-validation)

**Syntax:** obj \<< (fit[number] \<< Get Average Absolute Error Validation)

**Description:** Returns the Mean Abs Dev statistic for the validation set. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
ae = obj << (Fit[1] << Get Average Absolute Error Validation);
Show( ae );


```

#### [Get Average Log Error Test](#get-average-log-error-test)

**Syntax:** obj \<< (fit[number] \<< Get Average Log Error Test)

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the test set. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
avg = obj << (Fit[1] << Get Average Log Error Test);
Show( avg );


```

#### [Get Average Log Error Training](#get-average-log-error-training)

**Syntax:** obj \<< (fit[number] \<< Get Average Log Error Training)

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
avg = obj << (Fit[1] << Get Average Log Error Training);
Show( avg );


```

#### [Get Average Log Error Validation](#get-average-log-error-validation)

**Syntax:** obj \<< (fit[number] \<< Get Average Log Error Validation)

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the validation set. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
avg = obj << (Fit[1] << Get Average Log Error Validation);
Show( avg );


```

#### [Get Confusion Matrix Test](#get-confusion-matrix-test)

**Syntax:** obj \<< (fit[number] \<< Get Confusion Matrix Test)

**Description:** Returns the confusion matrix for the test set. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
cm = obj << (Fit[1] << Get Confusion Matrix Test);
Show( cm );


```

#### [Get Confusion Matrix Training](#get-confusion-matrix-training)

**Syntax:** obj \<< (fit[number] \<< Get Confusion Matrix Training)

**Description:** Returns the confusion matrix for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
cm = obj << (Fit[1] << Get Confusion Matrix Training);
Show( cm );


```

#### [Get Confusion Matrix Validation](#get-confusion-matrix-validation)

**Syntax:** obj \<< (fit[number] \<< Get Confusion Matrix Validation)

**Description:** Returns the confusion matrix for the validation set. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
cm = obj << (Fit[1] << Get Confusion Matrix Validation);
Show( cm );


```

#### [Get Confusion Rates Test](#get-confusion-rates-test)

**Syntax:** obj \<< (fit[number] \<< Get Confusion Rates Test)

**Description:** Returns the confusion rates for the test set. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
cr = obj << (Fit[1] << Get Confusion Rates Test);
Show( cr );


```

#### [Get Confusion Rates Training](#get-confusion-rates-training)

**Syntax:** obj \<< (fit[number] \<< Get Confusion Rates Training)

**Description:** Returns the confusion rates for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
cr = obj << (Fit[1] << Get Confusion Rates Training);
Show( cr );


```

#### [Get Confusion Rates Validation](#get-confusion-rates-validation)

**Syntax:** obj \<< (fit[number] \<< Get Confusion Rates Validation)

**Description:** Returns the confusion rates for the validation set. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
cr = obj << (Fit[1] << Get Confusion Rates Validation);
Show( cr );


```

#### [Get Gen RSquare Test](#get-gen-rsquare-test)

**Syntax:** obj \<< (fit[number] \<< Get Gen RSquare Test)

**Description:** Returns the generalized R-square statistic for the test set. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
rt = obj << (Fit[1] << Get Gen RSquare Test);
Show( rt );


```

#### [Get Gen RSquare Training](#get-gen-rsquare-training)

**Syntax:** obj \<< (fit[number] \<< Get Gen RSquare Training)

**Description:** Returns the generalized R-square statistic for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
rt = obj << (Fit[1] << Get Gen RSquare Training);
Show( rt );


```

#### [Get Gen RSquare Validation](#get-gen-rsquare-validation)

**Syntax:** obj \<< (fit[number] \<< Get Gen RSquare Validation)

**Description:** Returns the generalized R-square statistic for the validation set. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
rt = obj << (Fit[1] << Get Gen RSquare Validation);
Show( rt );


```

#### [Get MM SAS DATA Step](#get-mm-sas-data-step)

**Syntax:** text = obj \<< (fit[number] \<< Get MM SAS Data Step)

**Description:** Creates SAS code that you can register in the SAS Model Manager.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
code = obj << (Fit[1] << Get MM SAS Data Step);


```

#### [Get Measures](#get-measures)

**Syntax:** obj \<< (fit[number] \<< Get Measures)

**Description:** Returns summary measures of fit from the model.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Diagram( 1 ));
obj << (Fit[1] << Get Measures);


```

#### [Get Misclassification Rate Test](#get-misclassification-rate-test)

**Syntax:** obj \<< (fit[number] \<< Get Misclassification Rate Test)

**Description:** Returns the misclassification rate for the test set. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
mr = obj << (Fit[1] << Get Misclassification Rate Test);
Show( mr );


```

#### [Get Misclassification Rate Training](#get-misclassification-rate-training)

**Syntax:** obj \<< (fit[number] \<< Get Misclassification Rate Training)

**Description:** Returns the misclassification rate for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
mrt = obj << (Fit[1] << Get Misclassification Rate Training);
Show( mrt );


```

#### [Get Misclassification Rate Validation](#get-misclassification-rate-validation)

**Syntax:** obj \<< (fit[number] \<< Get Misclassification Rate Validation)

**Description:** Returns the misclassification rate for the validation set. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
mrt = obj << (Fit[1] << Get Misclassification Rate Validation);
Show( mrt );


```

#### [Get NBoost](#get-nboost)

**Syntax:** obj \<< (fit[number] \<< Get NBoost)

**Description:** Returns the number of models that were used for boosting.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    N Boost( 2 ),
    Go
);
n = obj << (fit[1] << Get NBoost);
Show( n );


```

#### [Get Precision Recall Area Test](#get-precision-recall-area-test)

**Syntax:** obj \<< (fit[number] \<< Get Precision Recall Area Test)

**Description:** Returns the area under the precision-recall curve for the test set. The precision-recall curve must be displayed before the area is computed. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Precision Recall Curve( 1 ));
ra = obj << (Fit[1] << Get Precision Recall Area Test);
Show( ra );


```

#### [Get Precision Recall Area Training](#get-precision-recall-area-training)

**Syntax:** obj \<< (fit[number] \<< Get Precision Recall Area Training)

**Description:** Returns the area under the precision-recall curve for the training set. The precision-recall curve must be displayed before the area is computed.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Precision Recall Curve( 1 ));
ra = obj << (Fit[1] << Get Precision Recall Area Training);
Show( ra );


```

#### [Get Precision Recall Area Validation](#get-precision-recall-area-validation)

**Syntax:** obj \<< (fit[number] \<< Get Precision Recall Area Validation)

**Description:** Returns the area under the precision-recall curve for the validation set. The precision-recall curve must be displayed before the area is computed. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Precision Recall Curve( 1 ));
ra = obj << (Fit[1] << Get Precision Recall Area Validation);
Show( ra );


```

#### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< (fit[number] \<< Get Prediction Formula)

**Description:** Constructs a script to create a prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Get Prediction Formula);


```

#### [Get RMS Error Test](#get-rms-error-test)

**Syntax:** obj \<< (fit[number] \<< Get RMS Error Test)

**Description:** Returns the square root of the mean square of the test errors. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
re = obj << (Fit[1] << Get RMS Error Test);
Show( re );


```

#### [Get RMS Error Training](#get-rms-error-training)

**Syntax:** obj \<< (fit[number] \<< Get RMS Error Training)

**Description:** Returns the square root of the mean square of the training errors.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
re = obj << (Fit[1] << Get RMS Error Training);
Show( re );


```

#### [Get RMS Error Validation](#get-rms-error-validation)

**Syntax:** obj \<< (fit[number] \<< Get RMS Error Validation)

**Description:** Returns the square root of the mean square of the validation errors. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
re = obj << (Fit[1] << Get RMS Error Validation);
Show( re );


```

#### [Get ROC Area Test](#get-roc-area-test)

**Syntax:** obj \<< (fit[number] \<< Get ROC Area Test)

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the test data. The ROC curve needs to be displayed before the area is computed. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << ROC Curve( 1 ));
ra = obj << (Fit[1] << Get ROC Area Test);
Show( ra );


```

#### [Get ROC Area Training](#get-roc-area-training)

**Syntax:** obj \<< (fit[number] \<< Get ROC Area Training)

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the training data set. The ROC curve needs to be displayed before the area is computed.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << ROC Curve( 1 ));
ra = obj << (Fit[1] << Get ROC Area Training);
Show( ra );


```

#### [Get ROC Area Validation](#get-roc-area-validation)

**Syntax:** obj \<< (fit[number] \<< Get ROC Area Validation)

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the validation data set. The ROC curve needs to be displayed before the area is computed. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << ROC Curve( 1 ));
ra = obj << (Fit[1] << Get ROC Area Validation);
Show( ra );


```

#### [Get RSquare Test](#get-rsquare-test)

**Syntax:** obj \<< (fit[number] \<< Get RSquare Test)

**Description:** Returns the entropy R-square statistic for the test set. This option is available only when using a validation set in JMP Pro.

```

dt = Open( "$SAMPLE_DATA/Equity.jmp" );
obj = dt << Neural(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON, :JOB, :YOJ, :DEROG, :DELINQ, :CLAGE, :NINQ, :CLNO,
        :DEBTINC
    ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
rt = obj << (Fit[1] << Get RSquare Test);
Show( rt );


```

#### [Get RSquare Training](#get-rsquare-training)

**Syntax:** obj \<< (fit[number] \<< Get RSquare Training)

**Description:** Returns the entropy R-square statistic for the training set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
rt = obj << (Fit[1] << Get RSquare Training);
Show( rt );


```

#### [Get RSquare Validation](#get-rsquare-validation)

**Syntax:** obj \<< (fit[number] \<< Get RSquare Validation)

**Description:** Returns the entropy R-square statistic for the validation set. This option is available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
rt = obj << (Fit[1] << Get RSquare Validation);
Show( rt );


```

#### [Get SAS DATA Step](#get-sas-data-step)

**Syntax:** text = obj \<< (fit[number] \<< Get SAS Data Step)

**Description:** Creates SAS code that you can use to score a new data set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
code = obj << (Fit[1] << Get SAS Data Step);


```

#### [Get Seconds](#get-seconds)

**Syntax:** obj \<< (fit[number] \<< Get Seconds)

**Description:** Returns the number of seconds used to complete the analysis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
s = obj << (Fit[1] << Get Seconds);
Show( s );


```

#### [Lift Curve](#lift-curve)

**Syntax:** obj \<< (fit[number] \<< Lift Curve( state=0|1 ))

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Lift Curve( 1 ));


```

#### [Make SAS DATA Step](#make-sas-data-step)

**Syntax:** obj \<< (fit[number] \<< Make SAS Data Step)

**Description:** Creates SAS code that you can use to score a new data set.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Make SAS Data Step);


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< (fit[number] \<< Plot Actual by Predicted( state=0|1 ))

**Description:** Shows or hides a plot with the actual values on the vertical axis and the predicted values on the horizontal axis. This option is available only for continuous responses. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Plot Actual By Predicted( 1 ));


```

#### [Plot Residual by Predicted](#plot-residual-by-predicted)

**Syntax:** obj \<< (fit[number] \<< Plot Residual by Predicted( state= 0|1 ))

**Description:** Shows or hides a plot with the residuals on the vertical axis and the predicted values on the horizontal axis. This option is available only for continuous responses. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Plot Residual By Predicted( 1 ));


```

#### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< (fit[number] \<< Precision Recall Curve( state=0|1 ))

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Precision Recall Curve( 1 ));


```

#### [Profiler](#profiler)

**Syntax:** obj \<< (fit[number] \<< Profiler( state=0|1 ))

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Profiler( 1 ));


```

#### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< (fit[number] \<< Publish Prediction Formula)

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Publish Prediction Formula);


```

#### [ROC Curve](#roc-curve)

**Syntax:** obj \<< (fit[number] \<< ROC Curve( state=0|1 ))

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << ROC Curve( 1 ));


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (fit[number] \<< Remove Fit)

**Description:** Removes the entire model report.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
Wait( 2 );
obj << (Fit[1] << Remove Fit);


```

#### [Save Fast Formulas](#save-fast-formulas)

**Syntax:** obj \<< (fit[number] \<< Save Fast Formulas)

**Description:** Saves a new formula column to the data table. The column contains a formula for the predicted response that includes embedded formulas for the hidden layer nodes. This option produces formulas that evaluate quickly, but cannot be used by the interactive version of the profiler.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Save Fast Formulas);


```

#### [Save Formulas](#save-formulas)

**Syntax:** obj \<< (fit[number] \<< Save Formulas)

**Description:** Saves new formula columns to the data table. There are separate formula columns for the predicted response and the hidden layer nodes.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Save Formulas);


```

#### [Save Profile Formulas](#save-profile-formulas)

**Syntax:** obj \<< (fit[number] \<< Save Profile Formulas)

**Description:** Saves a new formula column to the data table. The column contains a formula for the predicted response that includes embedded formulas for the hidden layer nodes. This option produces formulas that can be used by the interactive version of the profiler.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Save Profile Formulas);


```

#### [Save Transformed Covariates](#save-transformed-covariates)

**Syntax:** obj \<< (fit[number] \<< Save Transformed Covariates)

**Description:** Saves new formula columns to the data table. The new columns contain the formulas that are used to transform the covariates. This option is available only in JMP Pro and when the Transform Covariates option is specified in the launch.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Transform Covariates( 1 ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Save Transformed Covariates);


```

#### [Save Validation](#save-validation)

**Syntax:** obj \<< (fit[number] \<< Save Validation)

**Description:** Saves a new column to the data table. The column identifies which rows were used in the training and validation sets.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Save Validation);


```

#### [Show Estimates](#show-estimates)

**Syntax:** obj \<< (fit[number] \<< Show Estimates( state=0|1 ))

**Description:** Shows or hides a report of the parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Show Estimates( 1 ));


```

#### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< (fit[number] \<< Surface Profiler( state=0|1 ))

**Description:** Shows or hides a three-dimensional surface plot. This option is available only for models with two or more X variables.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Fit( NTanH( 2 ) ),
    Fit( NGaussian( 3 ) )
);
obj << (Fit[1] << Surface Profiler( 1 ));


```

# [NodeGraphBox](#nodegraphbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Nonlinear](#nonlinear)

## [Associated Constructors](#associated-constructors)

### [Nonlinear](#nonlinear_1)

**Syntax:** Nonlinear( Y( column ), X( column with predictor formula ) )

**Description:** Fits nonlinear models using least squares or a custom loss function.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Nonlinear(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Nonlinear(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish(), Freq( :_freqcol ) );


```

### [Group](#group)

**Syntax:** obj = Nonlinear(...\<Group( column )>...)

**Description:** Specifies a grouping variable. The fitted model has separate parameters for each level of the grouping variable.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Bioassay.jmp" );
dt << Run Script( "Fit Curve" );                     

obj = dt << Nonlinear(
    Y( :Toxicity ),
    X( :Toxicity Predictor Formula ),
    Group( :Formulation ),
    Newton,
    Finish
);


```

### [Loss](#loss)

**Syntax:** obj = Nonlinear(...\<Loss( column )>...)

**Description:** Specifies a formula column that contains a loss function.

```

dt = Open( "$SAMPLE_DATA/Ship Damage.jmp" );
obj = dt << Nonlinear(
    X( :model ),
    Loss( :Poisson ),
    Loss is Neg LogLikelihood( 1 ),
    Newton,
    Finish
);


```

### [Predictor Formula](#predictor-formula)

**Syntax:** obj = Nonlinear(...\<Predictor Formula( column )>...)

**Description:** Specifies a column that contains either the X variable or a model formula with parameters.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );


```

### [Response](#response)

**Syntax:** obj = Nonlinear(...\<Response( column )>...)

**Description:** Specifies the response variable.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );


```

### [Weight](#weight)

**Syntax:** obj = Nonlinear(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish(), Weight( :_weightcol ) );


```

### [X](#x)

**Syntax:** obj = Nonlinear(...\<X( column )>...)

**Description:** Specifies a column that contains either the X variable or a model formula with parameters.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );


```

### [Y](#y)

**Syntax:** obj = Nonlinear(...\<Y( column )>...)

**Description:** Specifies the response variable.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );


```

## [Item Messages](#item-messages)

### [Accept Current Estimates](#accept-current-estimates)

**Syntax:** obj \<< Accept Current Estimates

**Description:** Produces the solution report using the current estimates, even if the estimates did not converge.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Parameter Bounds( B0( 15, . ) ) );
obj << Finish;
obj << Accept Current Estimates;


```

### [CL Alpha](#cl-alpha)

**Syntax:** obj \<< CL Alpha( number=.05 )

**Description:** Specifies the alpha level for the confidence limits for the parameter estimates. ".05" by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << CL Alpha( .01 );
obj << Confidence Limits;


```

### [CL Limit](#cl-limit)

**Syntax:** obj \<< CL Limit( number=.00001 )

**Description:** Specifies the convergence criterion that is used to calculate the confidence limits for the parameter estimates. ".00001" by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << CL Limit( .002 );
obj << Confidence Limits;


```

### [Confidence Limits](#confidence-limits)

**Syntax:** obj \<< Confidence Limits

**Description:** Computes confidence intervals for all of the parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Confidence Limits;


```

### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the contour profiler, which shows the contours of the response graphically for two factors at a time.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
Wait( 0 );
obj << Contour Profiler( 1 );


```

### [Custom Estimate](#custom-estimate)

**Syntax:** obj \<< Custom Estimate( expression )

**Description:** Estimates a user-specified function of the parameters. The expression and the standard error of the expression are calculated using the current parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
obj << Custom Estimate( B0 + A + D );


```

### [Custom Estimation Profiler](#custom-estimation-profiler)

**Syntax:** obj \<< Custom Estimation Profiler( Custom Estimation( {initial values}, expression ), \<Transformation( "Log"|"Logit"|"None" ), Profiler( script )> )

**Description:** Enables you to construct a profiler for a custom expression. Enter an expression that involves parameters and at least one factor. By default, the Transformation option is set to None.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Logistic w Loss.jmp" );
obj = dt << Nonlinear(
    Loss( :Loss ),
    Expand Intermediate Formulas( 1 ),
    Loss is Neg LogLikelihood( 1 ),
    Newton,
    Finish,
    Plot( 0 ),
    Custom Estimation Profiler(
        Custom Estimation( {x = 30}, 1 / (1 + Exp( b0 + b1 * x )) ),
        Transformation( "Logit" ),
        Profiler(
            1,
            Confidence Intervals( 1 ),
            Term Value(
                x(
                    140,
                    Min( -37.4344314814814 ),
                    Max( 392.622262689059 ),
                    Lock( 0 ),
                    Show( 1 )
                )
            )
        )
    )
);


```

### [Custom Inverse Prediction](#custom-inverse-prediction)

**Syntax:** obj \<< Custom Inverse Prediction( Response( l1, l2, ... ), \<Term Value( column( number ) )> )

**Description:** Estimates an X value for each specified response value. Standard errors and confidence limits for the estimated X values are also calculated.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
Wait( 0 );
obj << Custom Inverse Prediction( Response( 100, 150, 200 ) );


```

### [Delta](#delta)

**Syntax:** obj \<< Delta( number=5.0e-6 )

**Description:** Specifies the delta value that is used in the Numeric Derivatives Only option. "5.0e-6" by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << Numeric Derivatives Only( 1 );
obj << Delta( 0.2 );
obj << Finish;


```

### [Expand Intermediate Formulas](#expand-intermediate-formulas)

**Syntax:** obj \<< Expand Intermediate Formulas( state=0|1 )

**Description:** Uses expanded intermediate formulas in solving and in the formulas saved. This affects formulas in the output when the model is dependent on a column with a formula, as it will look through to the original columns.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Logit Model w Loss1.jmp" );
obj = dt << Nonlinear(
    Loss( :Loss ),
    Show Prediction Expression( 1 ),
    Expand Intermediate Formulas( 1 ),
    Finish
);


```

### [Finish](#finish)

**Syntax:** obj \<< Finish

**Description:** Begins the fitting process and only moves to the next command if the solution has converged or finished. In scripts, the Finish option is recommended instead of the Go option.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Finish;
obj << Profiler;


```

### [Get CI](#get-ci)

**Syntax:** obj \<< Get CI

**Description:** Returns the confidence intervals for the parameter estimates. Note: The Confidence Intervals option must be selected before the Get CI option is specified.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Confidence Limits;
G = obj << Get CI;
Show( G );


```

### [Get Corr](#get-corr)

**Syntax:** obj \<< Get Corr

**Description:** Returns the correlation of the estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
G = obj << Get Corr;
Show( G );


```

### [Get Cov](#get-cov)

**Syntax:** obj \<< Get Cov

**Description:** Returns the covariance of the estimates.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
G = obj << Get Cov;
Show( G );


```

### [Get Estimates](#get-estimates)

**Syntax:** obj \<< Get Estimates

**Description:** Returns the parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
G = obj << Get Estimates;
Show( G );


```

### [Get Parameter Names](#get-parameter-names)

**Syntax:** obj \<< Get Parameter Names

**Description:** Returns the parameter names.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
G = obj << Get Parameter Names;
Show( G );


```

### [Get SSE](#get-sse)

**Syntax:** obj \<< Get SSE

**Description:** Returns the sum of squares error (SSE).

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
G = obj << Get SSE;
Show( G );


```

### [Get Std Errors](#get-std-errors)

**Syntax:** obj \<< Get Std Errors

**Description:** Returns the standard errors of the parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
G = obj << Get Std Errors;
Show( G );


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Begins iterating in the background to find the nonlinear solution. In scripts, the Finish option is recommended instead of the Go option.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Go;


```

### [Gradient Limit](#gradient-limit)

**Syntax:** obj \<< Gradient Limit( number=1e-6 )

**Description:** Specifies the stop limit value for the gradient criterion. "1e-6" by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Gradient Limit( 0.0002 );
obj << Finish;


```

### [Iteration Limit](#iteration-limit)

**Syntax:** obj \<< Iteration Limit( number=60 )

**Description:** Specifies the maximum number of iterations. "60" by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Iteration Limit( 10 );
obj << Finish;


```

### [Iteration Log](#iteration-log)

**Syntax:** obj \<< Iteration Log( state=0|1 )

**Description:** Shows or hides the Iterations table. Once this option is selected, the platform records subsequent iterations in the table.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << Iteration Log( 1 );
obj << Finish;
obj << Plot( 0 );
Report( obj )["Iterations"] << Close( 0 );


```

### [Lock Parameter](#lock-parameter)

**Syntax:** obj \<< Lock Parameter( Name, ... )

**Description:** Locks individual parameters at a specified value so they remain constant during the iteration process.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Set Parameter( B0 = 0.2 );
obj << Lock Parameter( B0 );
obj << Finish;


```

### [Loss is Neg LogLikelihood](#loss-is-neg-loglikelihood)

**Syntax:** obj \<< Loss is Neg LogLikelihood( state=0|1 )

**Description:** Assumes that the sum of the specified loss formula is the negative log-likelihood and uses chi-square statistics instead of F statistics in the analysis.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Logit Model w Loss1.jmp" );
obj = dt << Nonlinear(
    Loss( :Loss ),
    Show Prediction Expression( 1 ),
    Expand Intermediate Formulas( 1 )
);
obj << Loss is Neg LogLikelihood( 0 );
obj << Finish;


```

### [Newton](#newton)

**Syntax:** obj \<< Newton

**Description:** Specifies either Gauss-Newton (for regular least squares) or Newton-Raphson (for models that contain loss functions) as the optimization method.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << Newton;
obj << Finish;


```

### [Numeric Chain Deriv Delta](#numeric-chain-deriv-delta)

**Syntax:** obj \<< Numeric Chain Deriv Delta( =1e-5 )

**Description:** Specifies the delta parameter used when approximating the derivative of a nonlinear formula that does not have a built-in derivative. "1e-5" by default.

**JMP Version Added:** 14

### [Numeric Derivatives Only](#numeric-derivatives-only)

**Syntax:** obj \<< Numeric Derivatives Only( state=0|1 )

**Description:** Specifies that only numeric derivatives are used in the fitting method.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << Numeric Derivatives Only( 1 );
obj << Finish;


```

### [Obj Change Limit](#obj-change-limit)

**Syntax:** obj \<< Obj Change Limit( number=1e-15 )

**Description:** Specifies the stop limit value for the objective change criterion. "1e-15" by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Obj Change Limit( 1e-10 );
obj << Finish;


```

### [Parameter Bounds](#parameter-bounds)

**Syntax:** obj \<< Parameter Bounds( \<parameter name( lower, upper )> )

**Description:** Sets bounds on the specified parameters.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << Parameter Bounds( B0( 0, . ) );
obj << Finish;


```

### [Parameter Contour Profiler](#parameter-contour-profiler)

**Syntax:** obj \<< Parameter Contour Profiler( state=0|1 )

**Description:** Shows or hides a contour profiler that profiles the SSE or loss as a function of the parameters.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
Wait( 0 );
obj << Parameter Contour Profiler( 1 );


```

### [Parameter Profiler](#parameter-profiler)

**Syntax:** obj \<< Parameter Profiler( state=0|1 )

**Description:** Shows or hides a prediction profiler that profiles the SSE or loss as a function of the parameters.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
Wait( 0 );
obj << Parameter Profiler( 1 );


```

### [Parameter Surface Profiler](#parameter-surface-profiler)

**Syntax:** obj \<< Parameter Surface Profiler( state=0|1 )

**Description:** Shows or hides a three-dimensional surface plot that profiles the SSE or loss as a function of the parameters. This option is available only for models that contain two or more parameters.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
Wait( 0 );
obj << Parameter Surface Profiler( 1 );


```

### [Plot](#plot)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Shows or hides a graph that plots the prediction formula as a function of exactly one other variable. On by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
Wait( 1 );
obj << Plot( 0 );
obj << Finish;


```

### [Profile Likelihood](#profile-likelihood)

**Syntax:** obj \<< Profile Likelihood( state=0|1 )

**Description:** Shows or hides a plot of the relative likelihood function, scaled to have a maximum value of one, across values of a single parameter while all other parameters are optimized to minimize the loss function. This option is available only when the Nonlinear platform is launched with a loss function that contains two or more parameters.

```

dt = Open( "$Sample_Data/Reliability/Fan.jmp" );
dt << New Column( "Unconstrained Weibull Loss",
    formula(
        Parameter(
            {mu = 10, logSigma = 0},
            If(
                Censor == 0, -Log( Weibull Density( Time, 1 / Exp( logSigma ), Exp( mu ) ) ),
                Censor == 1,
                    -Log( 1 - Weibull Distribution( Time, 1 / Exp( logSigma ), Exp( mu ) ) )
            )
        )
    )
);
obj = dt << Nonlinear(
    Loss( :Unconstrained Weibull Loss ),
    Numeric Derivatives Only( 1 ),
    Loss is Neg LogLikelihood( 1 ),
    Newton,
    Finish
);
Wait( 0 );
obj << Profile Likelihood( 1 );


```

### [Profile Likelihood Contour](#profile-likelihood-contour)

**Syntax:** obj \<< Profile Likelihood Contour( state=0|1 )

**Description:** Shows or hides the likelihood confidence contours for the relative likelihood function across two parameters while all other parameters are optimized to minimize the loss function. This option is available only when the Nonlinear platform is launched with a loss function that contains three or more parameters.

```

dt = Open( "$Sample_Data/Reliability/Fan.jmp" );
dt << New Column( "Partial Unconstrained DS Weibull Loss",
    formula(
        Parameter(
            {mu = 10, logSigma = 0, p = 0.5},
            If(
                p < 0 | p > 1, .,
                Censor == 0,
                    -Log( p * Weibull Density( Time, 1 / Exp( logSigma ), Exp( mu ) ) ),
                Censor == 1,
                    -Log(
                        1 - p * Weibull Distribution( Time, 1 / Exp( logSigma ), Exp( mu ) )
                    )
            )
        )
    )
);
obj = dt << Nonlinear(
    Loss( :Partial Unconstrained DS Weibull Loss ),
    Numeric Derivatives Only( 1 ),
    Loss is Neg LogLikelihood( 1 ),
    Newton,
    Finish
);
Wait( 0 );
obj << Profile Likelihood Contour( 1 );


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
obj << Profiler( 1 );


```

### [QuasiNewton BFGS](#quasinewton-bfgs)

**Syntax:** obj \<< QuasiNewton BFGS

**Description:** Specifies QuasiNewton BFGS as the optimization method. This method is best for large numbers of parameters.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << QuasiNewton BFGS;
obj << Finish;


```

### [QuasiNewton SR1](#quasinewton-sr1)

**Syntax:** obj \<< QuasiNewton SR1

**Description:** Specifies QuasiNewton SR1 as the optimization method. This method avoids recalculating the derivatives at each iteration.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << QuasiNewton SR1;
obj << Finish;


```

### [Relative Gradient](#relative-gradient)

**Syntax:** obj \<< Relative Gradient( number=1e-6 )

**Description:** Specifies the stop limit value for the relative gradient criterion. "1e-6" by default.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Relative Gradient( 0.0001 );
obj << Finish;


```

### [Remember Solution](#remember-solution)

**Syntax:** obj \<< Remember Solution( name )

**Description:** Creates a report called Remembered Models, which contains the current parameter estimates and summary statistics. Results of multiple models can be remembered and compared.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
obj << Remember Solution( "New Model" );


```

### [Reset](#reset)

**Syntax:** obj \<< Reset

**Description:** Resets the convergence criterion after solving. This option is useful when trying to refit the model with different starting values.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Set Parameter( B0 = 0.2 );
obj << Finish;
Wait( 2 );
obj << Reset;


```

### [Revert To Original Parameters](#revert-to-original-parameters)

**Syntax:** obj \<< Revert To Original Parameters

**Description:** Resets the current values of the parameters in the Control Panel to the original values.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
Wait( 1 );
obj << Revert to Original Parameters;


```

### [SSE Grid](#sse-grid)

**Syntax:** obj \<< SSE Grid

**Description:** Creates a grid of values around the solution estimates and computes the error sum of squares for each value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
obj << SSE Grid;


```

### [Save Estimates](#save-estimates)

**Syntax:** obj \<< Save Estimates

**Description:** Saves the current parameter estimates to the parameter values in the formula column.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
Wait( 1 );
obj << Save Estimates;


```

### [Save Estimates To Table](#save-estimates-to-table)

**Syntax:** obj \<< Save Estimates To Table

**Description:** Creates a new data table that contains the parameter estimates.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Estimates To Table;


```

### [Save Indiv Confid Limit Formula](#save-indiv-confid-limit-formula)

**Syntax:** obj \<< Save Indiv Confid Limit Formula

**Description:** Saves new formula columns to the data table. The new columns contain the formulas to calculate the confidence interval for an individual prediction. This is a confidence interval of an individual response value for a given X value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Indiv Confid Limit Formula;


```

### [Save Indiv Confid Limits](#save-indiv-confid-limits)

**Syntax:** obj \<< Save Indiv Confid Limits

**Description:** Saves new columns to the data table. The new columns contain the asymptotic confidence limits for an individual prediction. This is the confidence interval of an individual response value at a given X value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Indiv Confid Limits;


```

### [Save Inverse Prediction Formula](#save-inverse-prediction-formula)

**Syntax:** obj \<< Save Inverse Prediction Formula

**Description:** Saves new formula columns to the data table. The new columns contain the formulas for the inverse prediction of the model, the standard error of an inverse prediction, and the standard error of an individual inverse prediction.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Inverse Prediction Formula;


```

### [Save Pred Confid Limit Formula](#save-pred-confid-limit-formula)

**Syntax:** obj \<< Save Pred Confid Limit Formula

**Description:** Saves new formula columns to the data table. The new columns contain the formulas to calculate the confidence interval for a model prediction. This is a confidence interval for the average response value at a given X value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Pred Confid Limit Formula;


```

### [Save Pred Confid Limits](#save-pred-confid-limits)

**Syntax:** obj \<< Save Pred Confid Limits

**Description:** Saves new columns to the data table. The new columns contain the asymptotic confidence limits for the model prediction. This is the confidence interval for the average response value at a given X value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Pred Confid Limits;


```

### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves a new formula column to the data table. The new column contains the prediction formula using the current parameter estimates.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Prediction Formula;


```

### [Save Residual Formula](#save-residual-formula)

**Syntax:** obj \<< Save Residual Formula

**Description:** Saves a new formula column to the data table. The new column contains the formula for computing the residuals.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Residual Formula;


```

### [Save Specific Solving Formula](#save-specific-solving-formula)

**Syntax:** obj \<< Save Specific Solving Formula( \<column to solve for, {name1=expr1, ...}, Save Formula for Std Error Mean, Save Formula for Std Error Individual> )

**Description:** Saves new formula columns to the data table. The new columns contain formulas for the prediction and standard error for evaluating an X variable given the response variable and either other X values in the data or a constant.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Specific Solving Formula;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Specific Solving Formula( :year, {:pop = 200}, Save Formula for Std Error Mean );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Specific Solving Formula( :pop, Save Formula for Std Error Individual );


```

### [Save Std Error of Individual](#save-std-error-of-individual)

**Syntax:** obj \<< Save Std Error of Individual

**Description:** Saves a new formula column to the data table. The new column contains the formula of the standard error for an individual prediction. This is the standard error for predicting an individual response value for a given X value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Std Error of Individual;


```

### [Save Std Error of Predicted](#save-std-error-of-predicted)

**Syntax:** obj \<< Save Std Error of Predicted

**Description:** Saves a new formula column to the data table. The new column contains the formula of the standard error for a model prediction. This is the standard error for predicting the average response value for a given X value.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish );
obj << Save Std Error of Predicted;


```

### [Second Deriv Method](#second-deriv-method)

**Syntax:** obj \<< Second Deriv Method( state=0|1 )

**Description:** Specifies that the fitting method use second derivatives.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Second Deriv Method( 1 ), Finish );


```

### [Set Parameter](#set-parameter)

**Syntax:** obj \<< Set Parameter( name=expr, ... )

**Description:** Sets one or more parameter values prior to fitting the model. This is useful for both fixing a parameter at a particular value and for setting starting values.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Set Parameter( B0 = 0.2 );
Wait( 2 );
obj << Finish;


```

### [Show Derivatives](#show-derivatives)

**Syntax:** obj \<< Show Derivatives

**Description:** Shows the derivatives of the nonlinear formula in the log.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ) );
obj << Show Derivatives;


```

### [Show Prediction Expression](#show-prediction-expression)

**Syntax:** obj \<< Show Prediction Expression( state=0|1 )

**Description:** Shows or hides the prediction model or the loss function in the report.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Logit Model w Loss1.jmp" );
obj = dt << Nonlinear(
    Loss( :Loss ),
    Show Prediction Expression( 1 ),
    Expand Intermediate Formulas( 1 ),
    Finish
);


```

### [Step](#step)

**Syntax:** obj \<< Step

**Description:** Takes one iteration step toward solving the nonlinear model.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Step;
Wait( 1 );
obj << Step;


```

### [Stop](#stop)

**Syntax:** obj \<< Stop

**Description:** Interrupts the nonlinear model fitting process and stops it at the current iteration.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Go;
obj << Stop;


```

### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides a three-dimensional surface plot. This option is available only for models with two or more X variables.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ), Finish );
Wait( 0 );
obj << Surface Profiler( 1 );


```

### [Unlock Parameter](#unlock-parameter)

**Syntax:** obj \<< Unlock Parameter( Name, ... )

**Description:** Unlocks the specified parameters. Use this option on previously locked factors so that they are free to change during the iteration process.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Nonlinear( Y( :"log($ value)"n ), X( :Model ) );
obj << Set Parameter( B0 = 0.2 );
obj << Lock Parameter( B0, A, D );
obj << Finish;
Wait( 2 );
obj << Unlock Parameter( B0, A );
obj << Finish;


```

### [Unthreaded](#unthreaded)

**Syntax:** obj \<< Unthreaded( state=0|1 )

**Description:** Runs the iterations in the main computational thread.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/Algae Mitscherlich.jmp" );
obj = dt << Nonlinear( Y( :Algae density ), X( :Mitscherlich ) );
obj << Unthreaded( 1 );
obj << Finish;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Nonlinear(
    Y( :pop ),
    X( :"X-formula"n ),
    Finish(),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/US Population.jmp" );
obj = dt << Nonlinear( Y( :pop ), X( :"X-formula"n ), Finish() );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Nonlinear(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Normal Mixtures](#normal-mixtures)

## [Associated Constructors](#associated-constructors)

### [Normal Mixtures](#normal-mixtures_1)

**Syntax:** Normal Mixtures( Y( column(s) ), Number of Clusters( number ) )

**Description:** Clusters rows based on numeric variables when your data come from a mixture of overlapping multivariate normal distributions. You must specify the number of clusters in advance.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Normal Mixtures(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;


```

### [Freq](#freq)

**Syntax:** obj = Normal Mixtures(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = K Means Cluster(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Freq( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = Normal Mixtures(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Freq( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

### [Weight](#weight)

**Syntax:** obj = Normal Mixtures(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = K Means Cluster(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Weight( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = Normal Mixtures(
    Y(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Weight( :SampleSize ),
    Number of Clusters( 2 ),
    Go
);


```

### [Y](#y)

**Syntax:** obj = Normal Mixtures(...Y( column(s) )...)

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);


```

## [Item Messages](#item-messages)

### [Diagonal Variance](#diagonal-variance)

**Syntax:** obj \<< Diagonal Variance( state=0|1 )

**Description:** Assumes the covariances are zero and uses only the diagonal of the variance-covariance matrix for Normal Mixtures.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Diagonal Variance( 1 );
obj << Go;


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Launches the platform by completing the iterations.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;


```

### [Mixtures MaxIter](#mixtures-maxiter)

**Syntax:** obj \<< Mixtures MaxIter( number )

**Description:** Sets the maximum number of iterations for Normal Mixtures. The default is 300.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Mixtures MaxIter( 100 );
obj << Go;


```

### [Mixtures N Starts](#mixtures-n-starts)

**Syntax:** obj \<< Mixtures N Starts( number )

**Description:** Sets the number of times Normal Mixtures starts over in forming clusters. The default is 30. This is referred to as Tours in the Advanced Controls report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Mixtures N Starts( 20 );
obj << Go;


```

### [Mixtures Tolerance](#mixtures-tolerance)

**Syntax:** obj \<< Mixtures Tolerance( number )

**Description:** Sets the convergence criterion for Normal Mixtures. The default is 1e-8. This is referred to as Convergence Criterion in the Advanced Controls report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Mixtures Tolerance( 1e-7 );
obj << Go;


```

### [Number of Clusters](#number-of-clusters)

**Syntax:** obj \<< Number of Clusters( number )

**Description:** Changes the number of clusters.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
Wait( 1 );
obj << Number of Clusters( 5 );
obj << Go;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
Wait( 1 );
obj << Number of Clusters( 5 );
obj << Go;


```

### [Outlier Cluster](#outlier-cluster)

**Syntax:** obj \<< Outlier Cluster( state=0|1 )

**Description:** Provides an extra cluster with uniform distribution to collect outliers. This cluster is designated Cluster 0.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Outlier Cluster( 1 );
obj << Go;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Go;
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Normal Mixtures(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Normal Mixtures Fit](#normal-mixtures-fit)

### [Item Messages](#item-messages_1)

#### [Biplot](#biplot)

**Syntax:** obj \<< Biplot( state=0|1 )

**Description:** Shows or hides a plot of the points and clusters in the first two principal components of the data.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );


```

#### [Biplot 3D](#biplot-3d)

**Syntax:** obj \<< Biplot 3D( state=0|1 )

**Description:** Shows or hides a plot of the points and clusters in the first three principal components of the data.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot 3D( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot 3D( 1 );


```

#### [Biplot Contour Density](#biplot-contour-density)

**Syntax:** obj \<< Biplot Contour Density( density percent )

**Description:** Sets the level for the density contour.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Contour Density( .95 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Contour Density( .95 );


```

#### [Biplot Ray Position](#biplot-ray-position)

**Syntax:** obj \<< Biplot Ray Position( [X, Y, scaling] )

**Description:** Moves the biplot ray display.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Ray Position( [-1, -1, 2] );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Biplot Ray Position( [-1, -1, 2] );


```

#### [Get Statistics](#get-statistics)

**Syntax:** obj \<< Get Statistics

**Description:** Returns the mean and standard deviation for each variable within each cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
stats = obj << Get Statistics;
Show( stats );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
stats = obj << Get Statistics;
Show( stats );


```

#### [Mark Clusters](#mark-clusters)

**Syntax:** obj \<< Mark Clusters

**Description:** Sets the markers in the row state for each row in the data table. Each cluster is assigned a different marker. This affects plots across platforms using rowstate markers, including the Biplot in Cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );
obj << Mark Clusters;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Biplot( 1 );
obj << Mark Clusters;


```

#### [Parallel Coord Plots](#parallel-coord-plots)

**Syntax:** obj \<< Parallel Coord Plots( state=0|1 )

**Description:** Shows or hides a plot for each cluster separately showing connected line segments that represent each row of the data table.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Parallel Coord Plots( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Parallel Coord Plots( 1 );


```

#### [Publish Cluster Formulas](#publish-cluster-formulas)

**Syntax:** obj \<< Publish Cluster Formulas

**Description:** Builds probability formulas and publishes them as a formula column script in Formula Depot.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Publish Cluster Formulas;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Publish Cluster Formulas;


```

#### [Save Cluster Formula](#save-cluster-formula)

**Syntax:** obj \<< Save Cluster Formula

**Description:** Saves a column to the data table with a formula that determines the most likely cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Cluster Formula;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Cluster Formula;


```

#### [Save Clusters](#save-clusters)

**Syntax:** obj \<< Save Clusters

**Description:** Saves a new column to the data table that contains the most likely cluster for each row.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Clusters;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Clusters;


```

#### [Save Colors to Table](#save-colors-to-table)

**Syntax:** obj \<< Save Colors to Table

**Description:** Saves the color assigned to the row state in each row according to the cluster membership.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Colors to Table;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Save Colors to Table;


```

#### [Save Density Formula](#save-density-formula)

**Syntax:** obj \<< Save Density Formula

**Description:** Saves the density formula in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Density Formula;


```

#### [Save Mixture Formulas](#save-mixture-formulas)

**Syntax:** obj \<< Save Mixture Formulas

**Description:** Saves the mixture probability formula to each cluster as a separate column in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Mixture Formulas;


```

#### [Save Mixture Probabilities](#save-mixture-probabilities)

**Syntax:** obj \<< Save Mixture Probabilities

**Description:** Saves the probability of membership to each cluster as a separate column in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Save Mixture Probabilities;


```

#### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** obj \<< Scatterplot Matrix( state=0|1 )

**Description:** Creates a scatterplot matrix in a new window with confidence ellipses based on the current number of clusters.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Scatterplot Matrix;


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 )
);
obj << Go;
obj << Scatterplot Matrix;


```

#### [Show Biplot Rays](#show-biplot-rays)

**Syntax:** obj \<< Show Biplot Rays( state=0|1 )

**Description:** Shows or hides the rays on the biplot. On by default.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Show Biplot Rays( 1 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go( Biplot( 1 ) )
);
obj << Show Biplot Rays( 1 );


```

#### [Simulate Clusters](#simulate-clusters)

**Syntax:** obj \<< Simulate Clusters

**Description:** Creates a new data table with simulated data using the estimated cluster mixing probabilities, means, and standard deviations for each cluster.

**JMP Version Added:** 14

**K Means Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = K Means Cluster(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Simulate Clusters( 1000 );


```

**Normal Mixtures Example**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Normal Mixtures(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Number of Clusters( 3 ),
    Go
);
obj << Simulate Clusters( 1000 );


```

# [Normalization](#normalization)

## [Associated Constructors](#associated-constructors)

### [Normalization](#normalization_1)

**Syntax:** Normalization( Y( columns ) )

**Description:** Adjusts for technical biases and improves suitability for subsequent analysis

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :species )
);


```

### [Length](#length)

**Syntax:** obj \<< Length( column )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method(
        "Read/Fragment Per Kilobase of Transcript Per Million Mapped Reads/Fragments (RPKM/FPKM)"
    ),
    Length( :Sepal length )
);


```

### [X (Control) Columns](#x-control-columns)

**Syntax:** obj \<< X (Control) Columns( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width ),
    Method( "Trimmed Mean of M-Values (TMM)"
    ),
    X( :Petal length, :Petal width )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

## [Item Messages](#item-messages)

### [A Threshold](#a-threshold)

**Syntax:** Mean Expression Threshold ( number = 0.05 )

**Description:** Threshold for X Axis(A values) in MA Plot - TMM | KDMM method "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "Trimmed Mean of M-Values (TMM)"
    ),
    A Threshold( 0.1 )
);


```

### [Create New Tables for Results](#create-new-tables-for-results)

**Syntax:** Create New Tables for Results ( state =0|1 )

**Description:** Create New Tables for Results

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Create New Tables for Results( 1 )
);


```

### [Interpolated Quantiles](#interpolated-quantiles)

**Syntax:** Interpolated Quantiles( state =0|1 )

**Description:** Interpolated Quantiles for Determining Reference Column in TMM | KDMM method

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << normalization(
    y( :sepal length, :sepal width, :petal length, :petal width ),
    Method( "Trimmed Mean of M-Values (TMM)"
    ),
    Interpolated Quantiles( 1 )
);


```

### [Log Transformed](#log-transformed)

**Syntax:** Log Transformation( state =0|1 )

**Description:** Log Transformation of TMM | KDMM Method

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "Trimmed Mean of M-Values (TMM)"
    ),
    Log Transformed( 1 )
);


```

### [M Threshold](#m-threshold)

**Syntax:** Logratio Threshold ( number = 0.3 )

**Description:** Threshold for Y Axis(M values) in MA Plot - TMM | KDMM method "0.3" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "Trimmed Mean of M-Values (TMM)"
    ),
    M Threshold( 0.15 )
);


```

### [Method](#method)

**Syntax:** Method( "Row Standardize | Relative Abundance Percentage (RAP) | Relative Abundance Ratio (RAR) | Centered Log Ratio (CLR) | Count/Read Per Million (CPM/RPM) | Read/Fragment Per Kilobase of Transcript Per Million Mapped Reads/Fragments (RPKM/FPKM) | Transcript Per Million (TPM) | Trimmed Mean of M-Values (TMM) | Kernel Density Mean of M-Component (KDMM)" )

**Description:** Specifies the normalization method.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "Centered Log Ratio (CLR)"
    )
);


```

### [Missing Value Imputation](#missing-value-imputation)

**Syntax:** Missing Value Imputation( state =0|1 )

**Description:** Specifies that missing values in the data are imputed using a multivariate singular value decomposition (SVD) technique.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Missing Value Imputation( 1 )
);


```

### [Prior Count](#prior-count)

**Syntax:** Total Prior Count ( number = 0.25 )

**Description:** Prior Count for Applies to All Samples to Adjust Library Sizes - TMM | KDMM method "0.25" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Method( "Trimmed Mean of M-Values (TMM)"
    ),
    Prior Count( 1.0 )
);


```

### [Replace Y Data](#replace-y-data)

**Syntax:** Replace Y Data( state =0|1 )

**Description:** Specifies that data for the Y variables is replaced in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Replace Y Data( 1 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Normalization(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Normalization( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Normalization(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Notebook](#notebook)

## [Associated Constructors](#associated-constructors)

### [Notebook](#notebook_1)

**Syntax:** nb = Notebook( name|number )

**Description:** Creates a new notebook, or returns the notebook with the provided name or index.

```


nb = Notebook();


```

## [Item Messages](#item-messages)

### [Enable Inline Logging](#enable-inline-logging)

**Syntax:** obj \<< Enable Inline Logging( 0|1 )

**Description:** Enables/disables the logging of output in notebook blocks.

```



nb = Notebook();

nb << Enable Inline Logging( 0 );


```

### [Export to a Workflow](#export-to-a-workflow)

**Syntax:** obj \<< Export to a Workflow( \<Create(wfb name)>|\<AddTo(wfb name)> )

**Description:** Exports the blocks of the notebook to a workflow.

```



nb = Notebook();

nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );
nb << Add New Block(
    "JSL", "Data Table ( \!"Big Class\!" ) << Distribution ( Y(:age, :sex) )"
);
nb << Export to a Workflow;


```

### [Get Window](#get-window)

**Syntax:** obj \<< Get Window

**Description:** Returns the window of this notebook.

```



nb = Notebook();

nb << Get Window;


```

### [Import .ipynb File](#import-ipynb-file)

**Syntax:** obj \<< Import .ipynb File( file path )

**Description:** Loads the provided .ipynb file as blocks in the notebook.

```



nb = Notebook();

nb << Import .ipynb File( NOTEBOOKPATH );


```

### [Run All Scripts](#run-all-scripts)

**Syntax:** obj \<< Run All Scripts

**Description:** Runs the full notebook.

```



nb = Notebook();

nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );
nb << Add New Block(
    "JSL", "Data Table ( \!"Big Class\!" ) << Distribution ( Y(:age, :sex) )"
);
Wait( 1 );
nb << Run All Scripts;


```

### [Show Embedded Log](#show-embedded-log)

**Syntax:** obj \<< Show Embedded Log( 0|1 )

**Description:** Enables/disables the embedded log in the notebook.

```



nb = Notebook();

nb << Show Embedded Log( 1 );


```

### [Title](#title)

**Syntax:** obj \<< Title( title )

**Description:** Sets the title of this notebook.

```



nb = Notebook();

nb << Title( "Example Title" );
Show( nb << Title );


```

## [Block](#block)

### [Associated Constructors](#associated-constructors_1)

#### [Block](#block_1)

**Syntax:** Block

```


nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );


```

### [Item Messages](#item-messages_1)

#### [Block Name](#block-name)

**Syntax:** obj \<< Block Name( name )

**Description:** Sets/gets the title of this block.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block << Block Name( "Test Block Name" );


```

#### [Duplicate Block](#duplicate-block)

**Syntax:** obj \<< Duplicate Block

**Description:** Duplicates this block and adds the new block as its sibling.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block << Duplicate Block;


```

#### [Get Content](#get-content)

**Syntax:** obj \<< Get Content

**Description:** Gets the content of the block.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

Show( block << Get Content );


```

#### [Get Output](#get-output)

**Syntax:** obj \<< Get Output

**Description:** Gets the display tree output of the block.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block2 = nb << Add New Block(
    "JSL", "Data Table ( \!"Big Class\!" ) << Distribution ( Y(:age, :sex) )"
);
Wait( 1 );
nb << Run All Scripts;
block2 << Get Output;


```

#### [Import .ipynb File](#import-ipynb-file_1)

**Syntax:** obj \<< Import .ipynb File( file path )

**Description:** Loads the provided .ipynb file as blocks added to this section.

```


nb = Notebook();
section = nb << Add New Block( "Section" );
section << Import .ipynb File( NOTEBOOKPATH );


```

#### [Line Count](#line-count)

**Syntax:** obj \<< Line Count( number )

**Description:** Sets the maximum number of lines shown in this block before enabling scrolling. Set to zero to enable auto-sizing.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block << Line Count( 1 );


```

#### [Move Block Down](#move-block-down)

**Syntax:** obj \<< Move Block Down

**Description:** Moves this block down by one in the list.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block2 = nb << Add New Block(
    "JSL", "Data Table ( \!"Big Class\!" ) << Distribution ( Y(:age, :sex) )"
);
block << Move Block Down;


```

#### [Move Block Up](#move-block-up)

**Syntax:** obj \<< Move Block Up

**Description:** Moves this block up by one in the list.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block2 = nb << Add New Block(
    "JSL", "Data Table ( \!"Big Class\!" ) << Distribution ( Y(:age, :sex) )"
);
block2 << Move Block Up;


```

#### [Popout Results](#popout-results)

**Syntax:** obj \<< Popout Results

**Description:** Sends the current output of this block to a new window.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block2 = nb << Add New Block(
    "JSL", "Data Table ( \!"Big Class\!" ) << Distribution ( Y(:age, :sex) )"
);
Wait( 1 );
nb << Run All Scripts;
block2 << Popout Results;


```

#### [Remove Block](#remove-block)

**Syntax:** obj \<< Remove Block

**Description:** Removes this block from its parent.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block << Remove Block;


```

#### [Remove Section](#remove-section)

**Syntax:** obj \<< Remove Section

**Description:** Removes this section from its parent.

```


nb = Notebook();
section = nb << Add New Block( "Section" );
section << Remove Section;


```

#### [Run Script](#run-script)

**Syntax:** obj \<< Run Script

**Description:** Executes the contents of the current block.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

Wait( 1 );
block << Run Script;


```

#### [Run Section](#run-section)

**Syntax:** obj \<< Run Section

**Description:** Runs the children of this section in order.

```


nb = Notebook();
section = nb << Add New Block( "Section" );
section << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );
Wait( 1 );
section << Run Section;


```

#### [Set Content](#set-content)

**Syntax:** obj \<< Set Content( content )

**Description:** Sets the content of the block.

```



nb = Notebook();
block = nb << Add New Block( "JSL", "Open (\!"$SAMPLE_DATA/Big Class.jmp\!")" );

block << Set Content( "Print(Char(Pi(), 10))" );


```

# [NumberEditableBox](#numbereditablebox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Parallel Plot](#parallel-plot)

## [Associated Constructors](#associated-constructors)

### [Parallel Plot](#parallel-plot_1)

**Syntax:** Parallel Plot( Y( columns ), \<X( column )> )

**Description:** Produces a plot of two or more variables with connecting line segments for each row.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Parallel Plot( Y( :hist0, :hist1, :hist3, :hist5 ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( columns )

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( columns )

**Description:** Create groups of graphs for rows with the same value in this column.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_xCol",
    Character,
    Nominal,
    set values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    X( _xCol )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_groupCol",
    Character,
    Nominal,
    set values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    Grouping( _groupCol )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( columns )

**Description:** Columns that will have all of the values in each row connected with a single line.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Response(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

### [X](#x)

**Syntax:** obj \<< X( columns )

**Description:** Create groups of graphs for rows with the same value in this column.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_xCol",
    Character,
    Nominal,
    set values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    X( _xCol )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_groupCol",
    Character,
    Nominal,
    set values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    Grouping( _groupCol )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( columns )

**Description:** Columns that will have all of the values in each row connected with a single line.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Response(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);


```

## [Item Messages](#item-messages)

### [Center at zero](#center-at-zero)

**Syntax:** Parallel Plot( Y( columns ), Center at Zero( state=0|1 ) )

**Description:** Centers all the plots at zero.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Parallel Plot( Y( :hist0, :hist1, :hist3, :hist5 ), Center at Zero( 1 ) );


```

### [Reversed](#reversed)

**Syntax:** obj \<< Reversed( columns )

**Description:** Identifies Y variables with reversed axes.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Parallel Plot( Y( :hist0, :hist1, :hist3, :hist5 ) );
obj << Show Reversing Checkboxes( 1 );
obj << Reversed( :hist0, :hist1 );


```

### [Scale Uniformly](#scale-uniformly)

**Syntax:** Parallel Plot( Y( columns ), Scale Uniformly( state=0|1 ) )

**Description:** Scales all the plots uniformly.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Parallel Plot( Y( :hist0, :hist1, :hist3, :hist5 ), Scale Uniformly( 1 ) );


```

### [Show Reversing Checkboxes](#show-reversing-checkboxes)

**Syntax:** obj \<< Show Reversing Checkboxes( state=0|1 )

**Description:** Shows or hides check boxes for reversing the axes on the different Y variables.

```

dt = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj = dt << Parallel Plot( Y( :hist0, :hist1, :hist3, :hist5 ) );
obj << Show Reversing Checkboxes( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Parallel Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
        :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
        :"1992 Math"n
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Parallel Plot(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Pareto Plot](#pareto-plot)

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );


```

### [Cause](#cause)

**Syntax:** obj \<< Cause( column )

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    Freq( :_freqcol )
);
obj << Show Pareto Bars( 0 );


```

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column(s) )

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );


```

### [Subcategory](#subcategory)

**Syntax:** obj \<< Subcategory( column )

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    Weight( :_weightcol )
);
obj << Show Pareto Bars( 0 );


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );


```

### [Y](#y)

**Syntax:** obj \<< Y( column )

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );


```

## [Item Messages](#item-messages)

### [Alias](#alias)

**Syntax:** obj \<< Alias( cause, alias )

**Description:** Sets a different name for a cause.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Alias( "doping", "substitution" ) );


```

### [Bar Label Format](#bar-label-format)

**Syntax:** obj \<< Bar Label Format

**Description:** Sets the format for the Pareto bar labels.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Label( 1 ),
    Bar Label Format( "Currency", "USD", Use thousands separator( 0 ), 12, 0 )
);


```

### [Bar Style](#bar-style)

**Syntax:** obj \<< Bar Style( "Bar"|"Float" )

**Description:** Controls the display of the Pareto bars.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Bar Style( Float );


```

### [Cause Colors](#cause-colors)

**Syntax:** obj \<< Cause Colors( { { causeName, color }, ...} )

**Description:** Changes the color of the specified bars.

**JMP Version Added:** 17

#### [All Colors](#all-colors)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Show Cum Percent Points( 1 ) );
obj << Cause Colors( "Orange" );


```

#### [Multiple Color List](#multiple-color-list)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Show Cum Percent Points( 1 ) );
obj << Cause Colors( {{"miscellaneous", "Purple"}, {"silicon defect", "Red"}} );


```

#### [Single Color List](#single-color-list)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Show Cum Percent Points( 1 ) );
obj << Cause Colors( {"corrosion", "Light Gray"} );


```

#### [Single RGB Color](#single-rgb-color)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Show Cum Percent Points( 1 ) );
obj << Cause Colors( {117, 150, 200} );


```

### [Cause Labels](#cause-labels)

**Syntax:** obj \<< Cause Labels( { { causeName, 0|1 }, ...} )

**Description:** Displays the count as a label for the specified bars.

**JMP Version Added:** 17

#### [All Causes](#all-causes)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Cause Labels( 1 ) );


```

#### [List of Causes](#list-of-causes)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Cause Labels( {{"contamination", 1}, {"oxide defect", 1}} )
);


```

#### [Single Cause](#single-cause)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Cause Labels( {"contamination", 1} )
);


```

### [Cause Markers](#cause-markers)

**Syntax:** obj \<< Cause Markers( { { causeName, marker }, ...} )

**Description:** Changes the cumulative percent marker shown on the graph for the specified bars.

**JMP Version Added:** 17

#### [All Causes](#all-causes_1)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Show Cum Percent Points( 1 ) );
obj << Cause Markers( 1 );


```

#### [List of Causes](#list-of-causes_1)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Show Cum Percent Points( 1 ) );
obj << Cause Markers( {{"miscellaneous", "Square"}, {"silicon defect", "Diamond"}} );


```

#### [Single Cause](#single-cause_1)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ), Show Cum Percent Points( 1 ) );
obj << Cause Markers( {"silicon defect", "Diamond"} );


```

### [Combine Causes](#combine-causes)

**Syntax:** obj \<< Combine Causes( {cause1, cause2, ... } | \<< First(N) | \<< Last(N), <label> )

**Description:** Combines the specified causes into a single cause. The causes can be specified as a list of cause names or sending the First or Last message with a number of causes to combine. Optionally, a label for the combined cause can be specified.

#### [Labeled](#labeled)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Combine Causes( {"miscellaneous", "silicon defect", "doping"}, "Others" )
);


```

#### [No Label](#no-label)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
Wait( 2 );
obj << Combine Causes( {"miscellaneous", "silicon defect", "doping"} );


```

#### [Send Last](#send-last)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Combine Causes( <<Last( 2 ), "Last 2" )
);


```

### [Cum Line Connect Style](#cum-line-connect-style)

**Syntax:** obj \<< Cum Line Connect Style( "Line"|"Curve"|"Step" )

**Description:** Controls the connection style of the cumulative percent line.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Cum Line Connect Style( "Step" );


```

### [Cum Percent Curve Color](#cum-percent-curve-color)

**Syntax:** obj \<< Cum Percent Curve Color( color )

**Description:** Changes the color of the cumulative percent curve on the graph.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Cum Percent Curve Color( "Red" );


```

### [Cum Percent Label Format](#cum-percent-label-format)

**Syntax:** obj \<< Cum Percent Label Format

**Description:** Sets the format for the cumulative percent marker labels.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Label Cum Percent Points( 1 ),
    Cum Percent Label Format( "Percent", 12, 1 )
);


```

### [Get Causes](#get-causes)

**Syntax:** obj \<< Get Causes( \<"First" | "Last" | "First %" | "Last %", number> )

**Description:** Returns a list of cause names from the Pareto plot based on the current order of appearance. If no options are provided, then all causes are returned. Otherwise, it uses the keyword and the number to return either the first N, last N, first N percent, or last N percent.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), Freq( :Count ) );
obj << Get Causes;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), Freq( :Count ) );
obj << Get Causes( "First", 3 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), Freq( :Count ) );
obj << Get Causes( "Last %", 10 );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot(
    Cause( :Causes ),
    Freq( :Count ),
    Combine Causes( {"Corrosion", "Metallization", "Doping"}, "3 Others" ),
    Move to Last( {"3 Others"} )
);
obj << Get Causes( "Last", 3 );


```

### [Group Settings](#group-settings)

**Syntax:** obj \<< Group Settings( Column, \<Levels In View( number )>, \<Start Level( number ), \<Show Title (0|1)>, \<Title Color( color )>, \<Levels Color( color )> )

**Description:** Controls the appearance of the grouped Pareto

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Group Settings(
        :clean,
        Levels In View( 1 ),
        Start Level( 1 ),
        Title Color( "Blue" ),
        Levels Color( "Light Blue" )
    )
);


```

### [Label Cum Percent Points](#label-cum-percent-points)

**Syntax:** obj \<< Label Cum Percent Points( state=0|1 )

**Description:** Displays or hides the labels showing cumulative percentages for each bar on the graph.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Label Cum Percent Points( 1 );


```

### [Legend Position](#legend-position)

**Syntax:** obj \<< Legend Position( ("Right" | "Bottom" | "Left" | "Top") )

**Description:** Sets the position of the legend.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Legend Position( "Bottom" );


```

### [Legend Settings](#legend-settings)

**Syntax:** obj \<< Legend Settings

**Description:** Opens a dialog to modify the properties of the legend.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
Wait( 1 );
obj << Legend Settings();


```

### [Move to First](#move-to-first)

**Syntax:** obj \<< Move to First( {level1, level2, ...} | \<< First(N) | \<< Last(N) )

**Description:** Moves the bar(s) for the specified level(s) to appear first. The levels can be specified as a list of cause names or by sending the First or Last message with a number of causes to combine.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure Raw Data.jmp" );
obj = dt << Pareto Plot( Cause( :failure ) );
obj << Move to First( {"corrosion", "doping"} );


```

### [Move to Last](#move-to-last)

**Syntax:** obj \<< Move to Last( {level1, level2, ...} | \<< First(N) | \<< Last(N) )

**Description:** Moves the bar(s) for the specified level(s) to appear last. The levels can be specified as a list of cause names or by sending the First or Last message with a number of causes to combine.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure Raw Data.jmp" );
obj = dt << Pareto Plot( Cause( :failure ) );
obj << Move to Last( {"miscellaneous"} );


```

### [N Legend](#n-legend)

**Syntax:** obj \<< N Legend( state=0|1 )

**Description:** Displays the total sample size in the plot area.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure Raw Data.jmp" );
obj = dt << Pareto Plot( Cause( :failure ) );
obj << N Legend( 1 );


```

### [No Plot](#no-plot)

**Syntax:** obj \<< No Plot( state=0|1 )

**Description:** Closes the outline node for the Pareto plot.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), Freq( :Count ), Per Unit Rates( 1 ) );
obj << No Plot( 1 );


```

### [Orientation](#orientation)

**Syntax:** obj \<< Orientation( "Vertical"|"Horizontal" )

**Description:** Controls the orientation of the Pareto plot.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Orientation( "Horizontal" );


```

### [Pareto Line Connect Style](#pareto-line-connect-style)

**Syntax:** obj \<< Pareto Line Connect Style( "Line"|"Curve"|"Step" )

**Description:** Controls the connection style of the Pareto line.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    Show Pareto Bars( 0 )
);
obj << Pareto Line Connect Style( "Step" );


```

### [Per Unit Rates](#per-unit-rates)

**Syntax:** obj \<< Per Unit Rates( state=0|1 )

**Description:** Compares defect rates across groups. If a sample size is specified, defects per unit (DPU) and parts per million (PPM) columns are added to the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot(
    Cause( :Causes ),
    Per Unit Analysis( Constant( Sample Size( 1000 ) ) ),
    Freq( :Count )
);
obj << Per Unit Rates( 1 );


```

### [Percent Scale](#percent-scale)

**Syntax:** obj \<< Percent Scale( state=0|1 )

**Description:** Displays the left vertical axis as a percent scale.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure Raw Data.jmp" );
obj = dt << Pareto Plot( Cause( :failure ) );
obj << Percent Scale( 1 );


```

### [Pie Chart](#pie-chart)

**Syntax:** obj \<< Pie Chart( state=0|1 )

**Description:** Displays the bars as a pie chart.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
obj << Pie Chart( 1 );


```

### [Reorder Horizontal](#reorder-horizontal)

**Syntax:** obj \<< Reorder Horizontal( level1, level2, ... )

**Description:** Reorders horizontally grouped Pareto plots when there are two or more groups.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
Wait( 2 );
obj << Reorder Horizontal( "before", "after" );


```

### [Reorder Vertical](#reorder-vertical)

**Syntax:** obj \<< Reorder Vertical( level1, level2, ... )

**Description:** Reorders vertically grouped Pareto plots when there are two or more variables.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), X( :Process, :Day ), Freq( :Count ) );
Wait( 2 );
obj << Reorder Vertical( "Process B", "Process A" );


```

### [Separate Causes](#separate-causes)

**Syntax:** obj \<< Separate Causes

**Description:** Separates combined causes into separate bars.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Combine Causes( {"miscellaneous", "silicon defect", "doping"} );
Wait( 2 );
obj << Separate Causes;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Combine Causes( {"miscellaneous", "silicon defect", "doping"}, "Other Causes" );
Wait( 2 );
obj << Separate Causes( "Other Causes" );


```

### [Show Cum Percent Axis](#show-cum-percent-axis)

**Syntax:** obj \<< Show Cum Percent Axis( state=0|1 )

**Description:** Displays or hides the cumulative percent axis on the right side of the plot. Note: Only available on the right most plot when an X or Grouping variable is present. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
obj << Show Cum Percent Axis( 1 );


```

### [Show Cum Percent Curve](#show-cum-percent-curve)

**Syntax:** obj \<< Show Cum Percent Curve( state=0|1 )

**Description:** Displays or hides the cumulative percent curve. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
obj << Show Cum Percent Curve( 1 );


```

### [Show Cum Percent Points](#show-cum-percent-points)

**Syntax:** obj \<< Show Cum Percent Points( state=0|1 )

**Description:** Displays or hides the cumulative percent points on the graph.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Show Cum Percent Points( 1 );


```

### [Show Error Bars](#show-error-bars)

**Syntax:** obj \<< Show Error Bars( state=0|1 )

**Description:** Shows or hides error bars on the Pareto bars for confidence range.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
obj << Show Error Bars( 1 );


```

### [Show Pareto Bars](#show-pareto-bars)

**Syntax:** obj \<< Show Pareto Bars( state=0|1 )

**Description:** Shows or hides the bars displaying the value for each cause. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );


```

### [Show Pareto Line](#show-pareto-line)

**Syntax:** obj \<< Show Pareto Line( state=0|1 )

**Description:** Shows or hides a line that connects the values for each cause.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
obj << Show Pareto Line( 1 );


```

### [Show Pareto Markers](#show-pareto-markers)

**Syntax:** obj \<< Show Pareto Markers( state=0|1 )

**Description:** Shows or hides markers at the value for each cause.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
obj << Show Pareto Markers( 1 );


```

### [Subcategory Bar Style](#subcategory-bar-style)

**Syntax:** obj \<< Subcategory Bar Style( "Side by side"|"Stacked"|"Bullet"|"Nested"|"Single"|"Needle"|"Float" )

**Description:** Controls the display of the bars when a subcategory is present.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Subcategory( :clean ),
    Freq( :N ),
    Subcategory Bar Style( Stacked )
);


```

### [Subset](#subset)

**Syntax:** obj \<< Subset

**Description:** Creates a subset data table from the selections in the Pareto plot

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
dt << Select Where( :Causes == "Corrosion" );
obj = dt << Pareto Plot( Cause( :Causes ), Freq( :Count ) );
obj << Subset;


```

### [Swap Group Orientation](#swap-group-orientation)

**Syntax:** obj \<< Swap Group Orientation( state=0|1 )

**Description:** Swaps the horizontal and vertical groups. If there is only one group, changes the display orientation.

**JMP Version Added:** 17

#### [One Group](#one-group)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), X( :Process ), Freq( :Count ) );
Wait( 2 );
obj << Swap Group Orientation( true );


```

#### [Two Groups](#two-groups)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), X( :Process, :Day ), Freq( :Count ) );
Wait( 2 );
obj << Swap Group Orientation( true );


```

### [Synchronize Y Axes](#synchronize-y-axes)

**Syntax:** obj \<< Synchronize Y Axes( state=0|1 )

**Description:** Locks the right y-axis so that zooming and panning is synchronized with the left y-axis On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), Freq( :N ) );
obj << Synchronize Y Axes( 0 );


```

### [Tables Match Plot](#tables-match-plot)

**Syntax:** obj \<< Tables Match Plot( {\<Per Unit Rates( 0|1 )>, \<Test Rate Within Groups( 0|1 )>, \<Test Rates Across Groups( 0|1 )>} )

**Description:** Controls whether the count analysis tables display the combined cause values that match the Pareto plot or the uncombined original causes. A value of 1 will show the combined cause values. A value of 0 will show the uncombined values. Not all tables must be specified in the command.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Per Unit Rates( 1 ),
    Test Rate Within Groups( 1 ),
    Test Rates Across Groups( 1 ),
    Combine Causes( {"silicon defect", "oxide defect", "doping"}, "3 Others" ),
    Move to Last( {"corrosion", "miscellaneous", "3 Others"} )
);
obj << Tables Match Plot(
    {Per Unit Rates( 1 ), Test Rate Within Groups( 1 ), Test Rates Across Groups( 1 )}
);


```

### [Test Rate Within Groups](#test-rate-within-groups)

**Syntax:** obj \<< Test Rate Within Groups( state=0|1 )

**Description:** Performs a likelihood ratio test within groups, testing whether the causes have equal ratios within the groups.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), X( :Process ), Freq( :Count ) );
obj << Test Rate Within Groups( 1 );


```

### [Test Rates Across Groups](#test-rates-across-groups)

**Syntax:** obj \<< Test Rates Across Groups( state=0|1 )

**Description:** Performs a likelihood ratio test across groups, testing whether the causes have equal ratios across the groups.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Pareto Plot( Cause( :Causes ), X( :Process, :Day ), Freq( :Count ) );
obj << Test Rates Across Groups( 1 );


```

### [Threshold of Combined Causes](#threshold-of-combined-causes)

**Syntax:** obj \<< Threshold of Combined Causes

**Description:** Combines causes which fall below the threshold. This happens on initial platform launch.

#### [Count](#count)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Threshold of Combined Causes( Count( 5 ) )
);


```

#### [Tail %](#tail)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot(
    Cause( :failure ),
    Freq( :N ),
    Threshold of Combined Causes( Tail %( 25 ) )
);


```

### [Ungroup Plots](#ungroup-plots)

**Syntax:** obj \<< Ungroup Plots( state=0|1 )

**Description:** Separates grouped Pareto plots when there are two or more groups.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ) );
Wait( 2 );
obj << Ungroup Plots( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Pareto Plot(
    Cause( :failure ),
    X( :clean ),
    Freq( :N ),
    Show Pareto Line( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Show Pareto Bars( 0 );
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure2.jmp" );
obj = dt << Pareto Plot( Cause( :failure ), X( :clean ), Freq( :N ), Show Pareto Line( 1 ) );
obj << Show Pareto Bars( 0 );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Show Pareto Bars(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Partial Least Squares](#partial-least-squares)

## [Associated Constructors](#associated-constructors)

### [Partial Least Squares](#partial-least-squares_1)

**Syntax:** Partial Least Squares( Y( columns ), X( columns ) )

**Description:** Fits a model to one or more response variables using latent factors. This permits models to be fit when explanatory variables are highly correlated, or when there are more explanatory variables than there are observations.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Go
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);


```

### [Factor](#factor)

**Syntax:** obj \<< Factor( column(s) )

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Freq( :_freqcol ),
    Go
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);


```

## [Item Messages](#item-messages)

### [Centering](#centering)

**Syntax:** obj = Partial Least Squares(...Centering( state=0|1)...)

**Description:** Centers all Y variables and model effects by subtracting the mean from each column. On by default.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Centering( 0 ),
    Validation Method( KFold( 7 ) ),
    Go
);


```

### [Fit](#fit)

**Syntax:** obj \<< Fit( SVD( Fast|Classical ), Method( NIPALS|SIMPLS ), Number of Factors( number ) )

**Description:** Fits a partial least squares model with a specified method and number of factors.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Method( NIPALS ), Number of Factors( 7 ) ),
    Go
);


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Launches the partial least squares model fit.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    )
);
obj << Go;


```

### [Imputation Method](#imputation-method)

**Syntax:** obj = Partial Least Squares(...Imputation Method( "Mean"|"EM" )...)

**Description:** Specifies the imputation method. The Mean method replaces missing values with the mean of the nonmissing values in the same column. The EM method uses an iterative Expectation-Maximization (EM) approach to impute missing values.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Partial Least Squares(
    Y( :Y ),
    X( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    Impute Missing Data( 1 ),
    Imputation Method( "EM" ),
    Max Iterations( 2 ),
    Validation Method( None, Initial Number of Factors( 6 ) ),
    Fit( Method( NIPALS ), Number of Factors( 6 ) )
);


```

### [Impute Missing Data](#impute-missing-data)

**Syntax:** obj = Partial Least Squares(...Impute Missing Data( state=0|1 )...)

**Description:** Replaces missing data values in the responses and regressors with nonmissing values. Otherwise, rows with missing values are excluded from the analysis.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Partial Least Squares(
    Y( :Y ),
    X( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    Impute Missing Data( 1 ),
    Validation Method( None, Initial Number of Factors( 6 ) ),
    Go
);


```

### [Initial Number of Factors](#initial-number-of-factors)

**Syntax:** obj \<< Partial Least Squares( Validation Method(...Initial Number of Factors( number )...) )

**Description:** Specifies the initial number of factors for cross validation.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Validation Method( KFold( 7 ), Initial Number of Factors( 10 ) ), 

);
obj << Go;


```

### [Max Iterations](#max-iterations)

**Syntax:** obj = Partial Least Squares(...Max Iterations( number=1 )...)

**Description:** Specifies the maximum number of iterations to perform in the EM imputation loop. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Partial Least Squares(
    Y( :Y ),
    X( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    Impute Missing Data( 1 ),
    Imputation Method( "EM" ),
    Max Iterations( 2 ),
    Validation Method( None, Initial Number of Factors( 6 ) ),
    Fit( Method( NIPALS ), Number of Factors( 6 ) )
);


```

### [Method](#method)

**Syntax:** obj = Partial Least Squares(...Fit( Method( NIPALS|SIMPLS)... )

**Description:** Specifies the method used to fit the partial least squares model.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Method( NIPALS ), Number of Factors( 11 ) ),
    Go
);


```

### [Model Dialog](#model-dialog)

**Syntax:** obj \<< Model Dialog

**Description:** Opens the Fit Model launch window. You can fit a Partial Least Squares model from this launch window by selecting the Partial Least Squares personality.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Model Dialog;


```

### [SVD](#svd)

**Syntax:** obj \<< SVD( Fast|Classical )

**Description:** Sets the implementation of the SVD algorithm for computing the partial least squares model to Fast or Classical. The Fast option implements the Lanczos SVD routine and the Classical option implements the Golub-Kahan routine.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Validation Method( KFold( 7 ) ),
    Go
);
obj << Fit( SVD( Classical ), Method( SIMPLS ) );


```

### [Scaling](#scaling)

**Syntax:** obj = Partial Least Squares(...Scaling( state=0|1)...)

**Description:** Scales all Y variables and model effects by dividing each column by its standard deviation. On by default.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Scaling( 0 ),
    Validation Method( KFold( 7 ) ),
    Go
);


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number )

**Description:** Specifies the random seed for running a partial least squares model with cross validation.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Set Random Seed( 12345 ),
    Validation Method( KFold( 7 ) ),
    Go
);


```

### [Validation Method](#validation-method)

**Syntax:** obj \<< Validation Method( KFold( number )|Holdback( fraction )|"Leave-One-Out"|None, Initial Number of Factors( number ) )

**Description:** Sets the method used for model validation.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Validation Method( KFold( 7 ), Initial Number of Factors( 15 ) ),
    Go
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Wine Tasting.jmp" );
obj = dt << Partial Least Squares(
    Y( :Hedonic, :Goes with meat, :Goes with dessert ),
    X( :Price, :Sugar, :Alcohol, :Acidity ),
    Go
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Partial Least Squares(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Partial Least Squares Fit](#partial-least-squares-fit)

### [Item Messages](#item-messages_1)

#### [Coefficient Plots](#coefficient-plots)

**Syntax:** obj \<< (Fit[number] \<< Coefficient Plots( state=0|1 ))

**Description:** Shows or hides plots of the model coefficients for each response across the X variables. There is a plot for the centered and scaled data and a plot for the original data.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Coefficient Plots( 1 ));


```

#### [Correlation Loading Plot](#correlation-loading-plot)

**Syntax:** obj \<< (Fit[number] \<< Correlation Loading Plot( state=0|1 ))

**Description:** Shows or hides either a single scatterplot or a scatterplot matrix of the X and Y loadings overlaid on the same plot. The scatterplot matrix is shown if the specified number of factors is greater than 2.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Correlation Loading Plot( 2 ));


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Correlation Loading Plot( 4 ));


```

#### [Diagnostics Plots](#diagnostics-plots)

**Syntax:** obj \<< (Fit[number] \<< Diagnostics Plots( state=0|1 ))

**Description:** Shows or hides diagnostic plots.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Diagnostics Plots( 1 ));


```

#### [Distance Plots](#distance-plots)

**Syntax:** obj \<< (Fit[number] \<< Distance Plots( state=0|1 ))

**Description:** Shows or hides the distance plots. There is a plot of the distance from each observation to the X model, a plot of the distance from each observation to the Y model, and a scatterplot of distances to both the X and Y models.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Distance Plots( 1 ));


```

#### [Fit Line](#fit-line)

**Syntax:** obj \<< (Fit[number] \<< Fit Line( state=0|1 ))

**Description:** Shows or hides a fitted line through the points on the X-Y Scores Plots. On by default.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
Wait( 2 );
obj << (Fit[1] << Fit Line( 0 ));


```

#### [Get Measures](#get-measures)

**Syntax:** obj \<< (Fit[number] \<< Get Measures)

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Get Measures);


```

#### [Loading Plots](#loading-plots)

**Syntax:** obj \<< (Fit[number] \<< Loading Plots( state=0|1 ))

**Description:** Shows or hides plots of the X and Y loadings for each extracted factor. There are separate plots for the X and Y variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Loading Plots( 1 ));


```

#### [Loading Scatterplot Matrices](#loading-scatterplot-matrices)

**Syntax:** obj \<< (Fit[number] \<< Loading Scatterplot Matrices( state=0|1 ))

**Description:** Shows or hides scatterplot matrices of the X and Y loadings. There are separate scatterplot matrices for the X and Y variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Loading Scatterplot Matrices( 1 ));


```

#### [Make Model Using VIP](#make-model-using-vip)

**Syntax:** obj \<< (Fit[number] \<< Make Model Using VIP)

**Description:** Opens and populates a launch window with the appropriate responses entered as Ys and the variables whose VIPs exceed the specified threshold entered as Xs.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Make Model Using VIP);


```

#### [Model Driven Multivariate Control Chart for Saved X Scores](#model-driven-multivariate-control-chart-for-saved-x-scores)

**Syntax:** obj \<< (Fit[number] \<< Model Driven Multivariate Control Chart for Saved X Scores)

**Description:** Saves the formulas for each X Score and launches the Model Driven Multivariate Control Chart (MDMCC) launch window.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Model Driven Multivariate Control Chart for Saved X Scores);


```

#### [Percent Variation Plots](#percent-variation-plots)

**Syntax:** obj \<< (Fit[number] \<< Percent Variation Plots( state=0|1 ))

**Description:** Shows or hides plots of the percent of variation explained for X Effects and for Y Responses.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Percent variation plots( 1 ));


```

#### [Profiler](#profiler)

**Syntax:** obj \<< (Fit[number] \<< Profiler( state=0|1 ))

**Description:** Shows or hides a profiler for each response.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Profiler( 1 ));


```

#### [Profiler for Predicteds](#profiler-for-predicteds)

**Syntax:** obj \<< (Fit[number] \<< Model Driven Multivariate Control Chart for Saved X Scores)

**Description:** Saves the formulas for each Y as a function of the X Score and launches the Profiler launch window.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Profiler for Predicteds);


```

#### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< (Fit[number] \<< Publish Prediction Formula)

**Description:** Creates a prediction formula and publishes it as a formula column script in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Publish Prediction Formula);


```

#### [Publish Score Formula](#publish-score-formula)

**Syntax:** obj \<< (Fit[number] \<< Publish Score Formula)

**Description:** Creates X and Y score formulas and saves them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Publish Score Formula);


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (Fit[number] \<< Remove Fit)

**Description:** Removes the model report from the main platform report.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
Wait( 3 );
obj << (Fit[1] << Remove Fit);


```

#### [Save Distance](#save-distance)

**Syntax:** obj \<< (Fit[number] \<< Save Distance)

**Description:** Saves new columns to the original data table. The new columns contain the Distance to X Model (DModX) and Distance to Y Model (DModY) values.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Distance);


```

#### [Save Distance as X Score Formula](#save-distance-as-x-score-formula)

**Syntax:** obj \<< (Fit[number] \<< Save Distance as X Score Formula)

**Description:** Saves new formula columns to the original data table. The new columns contain the Distance to X Model (DModX) and Distance to Y Model (DModY) formulas that are functions of the X Score formulas.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Distance as X Score Formula);


```

#### [Save Imputation](#save-imputation)

**Syntax:** obj \<< (Fit[number] \<< Save Imputation)

**Description:** Saves columns to a new data table. For each X and Y variable, there is a column that contains the original data column with missing values replaced by their imputed values.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Partial Least Squares(
    Y( :Y ),
    X( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    Impute Missing Data( 1 ),
    Imputation Method( "EM" ),
    Max Iterations( 2 ),
    Validation Method( None, Initial Number of Factors( 6 ) ),
    Fit( Method( NIPALS ), Number of Factors( 6 ) )
);
obj << (Fit[1] << Save Imputation);


```

#### [Save Indiv Confidence Limit Formula](#save-indiv-confidence-limit-formula)

**Syntax:** obj \<< (Fit[number] \<< Save Indiv Confidence Limit Formula)

**Description:** Saves new formula columns to the original data table. For each Y variable, there are columns for the lower and upper confidence limits for an individual prediction that are functions of the X Score formulas. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Indiv Confidence Limit Formula);


```

#### [Save Loadings](#save-loadings)

**Syntax:** obj \<< (Fit[number] \<< Save Loadings)

**Description:** Saves columns to two new data tables. There is a data table that contains the loadings for the X variables and a data table that contains the loadings for the Y variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Loadings);


```

#### [Save Mean Confidence Limit Formula](#save-mean-confidence-limit-formula)

**Syntax:** obj \<< (Fit[number] \<< Save Mean Confidence Limit Formula( \<alpha=0.05> ))

**Description:** Saves new formula columns to the original data table. For each Y variable, there are columns for the lower and upper confidence limits for the mean response that are functions of the X Score formulas. The default level for alpha is 0.05, which creates 95% confidence limits.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Mean Confidence Limit Formula);


```

#### [Save Percent Variation Explained For X Effects](#save-percent-variation-explained-for-x-effects)

**Syntax:** obj \<< (Fit[number] \<< Save Percent Variation Explained For X Effects)

**Description:** Saves columns to a new data table. For each X variable, there is a column that contains the percent of variation explained across all extracted factors.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Percent Variation Explained For X Effects);


```

#### [Save Percent Variation Explained For Y Responses](#save-percent-variation-explained-for-y-responses)

**Syntax:** obj \<< (Fit[number] \<< Save Percent Variation Explained For Y Responses)

**Description:** Saves columns to a new data table. For each Y variable, there is a column that contains the percent of variation explained across all extracted factors.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Percent Variation Explained For Y Responses);


```

#### [Save Prediction As X Score Formula](#save-prediction-as-x-score-formula)

**Syntax:** obj \<< (Fit[number] \<< Save Prediction as X Score Formula)

**Description:** Saves new formula columns to the original data table. For each Y variable, there is a column that contains a prediction formula that is a function of the X Score formulas.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Prediction as X Score Formula);


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< (Fit[number] \<< Save Prediction Formula)

**Description:** Saves new formula columns to the original data table. For each Y variable, there is a column that contains a prediction formula that is a function of the X variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Prediction Formula);


```

#### [Save Score Formula](#save-score-formula)

**Syntax:** obj \<< (Fit[number] \<< Save Score Formula)

**Description:** Saves new formula columns to the original data table. For each extracted factor, there is a column that contains an X Score formula and a column that contains a Y Score formula. The X Score formulas are functions of the X variables and the Y Score formulas are functions of the X Score formulas.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Score Formula);


```

#### [Save Scores](#save-scores)

**Syntax:** obj \<< (Fit[number] \<< Save Scores)

**Description:** Saves new columns to the original data table. For each extracted factor, there is a column that contains the X scores and a column that contains the Y scores.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Scores);


```

#### [Save Standard Errors of Prediction Formula](#save-standard-errors-of-prediction-formula)

**Syntax:** obj \<< (Fit[number] \<< Save Standard Errors of Prediction Formula)

**Description:** Saves new formula columns to the original data table. For each Y variable, there is a column that contains the formula for the standard error of the predicted mean that is a function of the X variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Standard Errors of Prediction Formula);


```

#### [Save Standardized Loadings](#save-standardized-loadings)

**Syntax:** obj \<< (Fit[number] \<< Save Standardized Loadings)

**Description:** Saves columns to two new data tables. There is a data table that contains the standardized loadings for the X variables and a data table that contains the standardized loadings for the Y variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Standardized Loadings);


```

#### [Save Standardized Scores](#save-standardized-scores)

**Syntax:** obj \<< (Fit[number] \<< Save Standardized Scores)

**Description:** Saves new columns to the original data table. The new columns contain the X and Y standardized scores for each extracted factor.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Standardized Scores);


```

#### [Save T Square](#save-t-square)

**Syntax:** obj \<< (Fit[number] \<< Save T Square)

**Description:** Saves a new formula column to the original data table. The new column contains the T squared formula as a function of the X variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save T Square);


```

#### [Save T Square as X Score Formula](#save-t-square-as-x-score-formula)

**Syntax:** obj \<< (Fit[number] \<< Save T Square as X Score Formula)

**Description:** Saves a new formula column to the original data table. The new column contains the T squared formula as a function of the X Score formulas.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save T Square as X Score Formula);


```

#### [Save Validation](#save-validation)

**Syntax:** obj \<< (Fit[number] \<< Save Validation)

**Description:** Saves a new column to the original data table. The new column contains numbers that indicate how each observation was used in validation.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Validation);


```

#### [Save X Predicted Values](#save-x-predicted-values)

**Syntax:** obj \<< (Fit[number] \<< Save X Predicted Values)

**Description:** Saves new columns to the original data table. For each X variable, there is a column that contains the predicted X values.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save X Predicted Values);


```

#### [Save X Prediction as X Score Formula](#save-x-prediction-as-x-score-formula)

**Syntax:** obj \<< (Fit[number] \<< Save X Prediction as X Score Formula)

**Description:** Saves new formula columns to the original data table. For each X variable, there is a column that contains a prediction formula that is a function of the X Score formulas.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save X Prediction as X Score Formula);


```

#### [Save X Residuals](#save-x-residuals)

**Syntax:** obj \<< (Fit[number] \<< Save X Residuals)

**Description:** Saves new columns to the original data table. For each X variable, there is a column that contains the X residual values.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save X Residuals);


```

#### [Save X Score Formula](#save-x-score-formula)

**Syntax:** obj \<< Save X Score Formula

#### [Save X Weights](#save-x-weights)

**Syntax:** obj \<< (Fit[number] \<< Save X Weights)

**Description:** Saves columns to a new data table. For each extracted factor, there is a column that contains the weights for the X variables.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save X Weights);


```

#### [Save Y Predicted Values](#save-y-predicted-values)

**Syntax:** obj \<< (Fit[number] \<< Save Y Predicted Values)

**Description:** Saves new columns to the original data table. For each Y variable, there is a column that contains the predicted Y values.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Y Predicted Values);


```

#### [Save Y Residuals](#save-y-residuals)

**Syntax:** obj \<< (Fit[number] \<< Save Y Residuals)

**Description:** Saves new columns to the original data table. For each Y variable, there is a column that contains the Y residual values.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Save Y Residuals);


```

#### [Score Scatterplot Matrices](#score-scatterplot-matrices)

**Syntax:** obj \<< (Fit[number] \<< Score Scatterplot Matrices( state=0|1 ))

**Description:** Shows or hides a scatterplot matrix of the X scores and a scatterplot matrix of the Y scores.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Score Scatterplot Matrices( 1 ));


```

#### [Set VIP Threshold](#set-vip-threshold)

**Syntax:** obj \<< (Fit[number] \<< Set VIP Threshold( number=0.8 ))

**Description:** Sets the threshold level for the Variable Importance Plot, Variance Importance Table, and the VIP vs Coefficients Plots. "0.8" by default.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Variable Importance Plot( 1 ));
Wait( 3 );
obj << (Fit[1] << Set VIP Threshold( 0.5 ));


```

#### [Show Confidence Band](#show-confidence-band)

**Syntax:** obj \<< (Fit[number] \<< Show Confidence Band( state=0|1 ))

**Description:** Shows or hides 95% confidence bands for the fitted lines on the X-Y Scores Plots.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Show Confidence Band( 1 ));


```

#### [Spectral Profiler](#spectral-profiler)

**Syntax:** obj \<< (Fit[number] \<< Spectral Profiler( state=0|1 ))

**Description:** Shows or hides a single profiler where all of the response variables appear in the first cell of the plot.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Spectral Profiler( 1 ));


```

#### [T Square Plot](#t-square-plot)

**Syntax:** obj \<< (Fit[number] \<< T Square Plot( state=0|1 ))

**Description:** Shows or hides a plot of T square statistics for each observation, along with a control limit.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << T Square Plot( 1 ));


```

#### [VIP vs Coefficients Plots](#vip-vs-coefficients-plots)

**Syntax:** obj \<< (Fit[number] \<< VIP vs Coefficients Plots( state=0|1 ))

**Description:** Shows or hides a plot of the VIP statistics against the model coefficients.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << VIP vs Coefficients Plots( 1 ));


```

#### [Variable Importance Plot](#variable-importance-plot)

**Syntax:** obj \<< (Fit[number] \<< Variable Importance Plot( state=0|1 ))

**Description:** Shows or hides a plot that summarizes the contribution each variable makes to the model.

```

dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7, :v8, :v9, :v10, :v11, :v12, :v13, :v14, :v15, :v16,
        :v17, :v18, :v19, :v20, :v21, :v22, :v23, :v24, :v25, :v26, :v27
    ),
    Fit( Number of Factors( 5 ) )
);
obj << (Fit[1] << Variable Importance Plot( 1 ));


```

# [Partition Platform](#partition-platform)

## [Associated Constructors](#associated-constructors)

### [Partition](#partition)

**Syntax:** Partition( Y( column ), X( columns ) )

**Description:** Constructs a decision tree by recursively partitioning the data according to a relationship between the predictor and response values. Both the response and predictors can be either continuous or categorical.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best( 2 );


```

## [Item Messages](#item-messages)

### [Method](#method)

**Syntax:** Method( "Decision Tree" )

**Description:** Specifies the method used for partitioning the data. Decision Tree is the default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" )
);
obj << Split Best( 2 );


```

## [Decision Tree](#decision-tree)

### [Associated Constructors](#associated-constructors_1)

#### [Decision Tree](#decision-tree_1)

**Syntax:** Partition(Y( column ), X( columns ), Method( "Decision Tree" ))

**Description:** Recursively partition the data to predict a response. This is also called Classification and Regression Trees.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );


```

### [Columns](#columns)

#### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );


```

#### [Factor](#factor)

**Syntax:** obj \<< Factor( column(s) )

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );


```

#### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    Freq( :_freqcol ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    Freq( :_freqcol )
);
obj << Split Best( 2 );


```

#### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );


```

#### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );


```

#### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    Weight( :_weightcol ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    Weight( :_weightcol )
);
obj << Split Best( 2 );


```

#### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );


```

#### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );


```

### [Item Messages](#item-messages_1)

#### [Color Points](#color-points)

**Syntax:** obj \<< Color Points

**Description:** Colors the points according to their classification.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Color Points;


```

#### [Column Contributions](#column-contributions)

**Syntax:** obj \<< Column Contributions( state=0|1 )

**Description:** Shows or hides a report with each input column and its corresponding contribution to the fit.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Column Contributions( 1 );


```

#### [Decision Threshold](#decision-threshold)

**Syntax:** obj \<< Decision Threshold( state = 0|1, Set Probability Threshold( number ) )

**Description:** Shows or hides the distribution of fitted probabilities and actual versus predicted tables for each model. You can change the probability threshold to explore how different thresholds affect the classification results.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
obj << Split Best( 5 );
obj << Show Tree( 0 );
obj << Decision Threshold( 1 );


```

#### [Get Average Absolute Error Test](#get-average-absolute-error-test)

**Syntax:** obj \<< Get Average Absolute Error Test

**Description:** Returns the Mean Abs Dev statistic for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

#### [Get Average Absolute Error Training](#get-average-absolute-error-training)

**Syntax:** obj \<< Get Average Absolute Error Training

**Description:** Returns the Mean Abs Dev statistic for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

#### [Get Average Absolute Error Validation](#get-average-absolute-error-validation)

**Syntax:** obj \<< Get Average Absolute Error Validation

**Description:** Returns the Mean Abs Dev statistic for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

#### [Get Average Log Error Test](#get-average-log-error-test)

**Syntax:** obj \<< Get Average Log Error Test

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

#### [Get Average Log Error Training](#get-average-log-error-training)

**Syntax:** obj \<< Get Average Log Error Training

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

#### [Get Average Log Error Validation](#get-average-log-error-validation)

**Syntax:** obj \<< Get Average Log Error Validation

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

#### [Get Confusion Matrix Test](#get-confusion-matrix-test)

**Syntax:** obj \<< Get Confusion Matrix Test

**Description:** Returns the confusion matrix for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

#### [Get Confusion Matrix Training](#get-confusion-matrix-training)

**Syntax:** obj \<< Get Confusion Matrix Training

**Description:** Returns the confusion matrix for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

#### [Get Confusion Matrix Validation](#get-confusion-matrix-validation)

**Syntax:** obj \<< Get Confusion Matrix Validation

**Description:** Returns the confusion matrix for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

#### [Get Confusion Rates Test](#get-confusion-rates-test)

**Syntax:** obj \<< Get Confusion Rates Test

**Description:** Returns the confusion rates for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

#### [Get Confusion Rates Training](#get-confusion-rates-training)

**Syntax:** obj \<< Get Confusion Rates Training

**Description:** Returns the confusion rates for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

#### [Get Confusion Rates Validation](#get-confusion-rates-validation)

**Syntax:** obj \<< Get Confusion Rates Validation

**Description:** Returns the confusion rates for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

#### [Get Gen RSquare Test](#get-gen-rsquare-test)

**Syntax:** obj \<< Get Gen RSquare Test

**Description:** Returns the generalized RSquare for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

#### [Get Gen RSquare Training](#get-gen-rsquare-training)

**Syntax:** obj \<< Get Gen RSquare Training

**Description:** Returns the generalized RSquare for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

#### [Get Gen RSquare Validation](#get-gen-rsquare-validation)

**Syntax:** obj \<< Get Gen RSquare Validation

**Description:** Returns the generalized RSquare for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

#### [Get MM SAS DATA Step](#get-mm-sas-data-step)

**Syntax:** obj \<< Get MM SAS DATA Step

**Description:** Creates SAS code that you can register in the SAS Model Manager and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
code = obj << Get MM SAS Data Step;


```

#### [Get MM Tolerant SAS DATA Step](#get-mm-tolerant-sas-data-step)

**Syntax:** obj \<< Get MM Tolerant SAS DATA Step

**Description:** Creates SAS code for data that includes missing values that you can register in the SAS Model Manager and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
code = obj << Get MM Tolerant SAS Data Step;


```

#### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Get Measures;


```

#### [Get Microseconds](#get-microseconds)

**Syntax:** obj \<< Get Microseconds

**Description:** Returns the number of microseconds used to complete the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
time = obj << Get Microseconds;
Show( time );


```

#### [Get Misclassification Rate Test](#get-misclassification-rate-test)

**Syntax:** obj \<< Get Misclassification Rate Test

**Description:** Returns the misclassification rate for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

#### [Get Misclassification Rate Training](#get-misclassification-rate-training)

**Syntax:** obj \<< Get Misclassification Rate Training

**Description:** Returns the misclassification rate for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Method( "Decision Tree" )
);
obj << Split Best( 2 );
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

#### [Get Misclassification Rate Validation](#get-misclassification-rate-validation)

**Syntax:** obj \<< Get Misclassification Rate Validation

**Description:** Returns the misclassification rate for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Method( "Decision Tree" ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

#### [Get Precision Recall Area Test](#get-precision-recall-area-test)

**Syntax:** obj \<< Get Precision Recall Area Test

**Description:** Returns the area under the precision-recall curve for the test set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

#### [Get Precision Recall Area Training](#get-precision-recall-area-training)

**Syntax:** obj \<< Get Precision Recall Area Training

**Description:** Returns the area under the precision-recall curve for the training set. The precision-recall curve must be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

#### [Get Precision Recall Area Validation](#get-precision-recall-area-validation)

**Syntax:** obj \<< Get Precision Recall Area Validation

**Description:** Returns the area under the precision-recall curve for the validation set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

#### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< Get Prediction Formula

**Description:** Constructs a script to create a prediction formula column and returns it.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Get Prediction Formula;


```

#### [Get RMS Error Test](#get-rms-error-test)

**Syntax:** obj \<< Get RMS Error Test

**Description:** Returns the square root of the mean square of the test errors. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
rms = obj << Get RMS Error Test;
Show( rms );


```

#### [Get RMS Error Training](#get-rms-error-training)

**Syntax:** obj \<< Get RMS Error Training

**Description:** Returns the square root of the mean square of the training errors.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
rms = obj << Get RMS Error Training;
Show( rms );


```

#### [Get RMS Error Validation](#get-rms-error-validation)

**Syntax:** obj \<< Get RMS Error Validation

**Description:** Returns the square root of the mean square of the validation errors. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
rms = obj << Get RMS Error Validation;
Show( rms );


```

#### [Get ROC Area Test](#get-roc-area-test)

**Syntax:** obj \<< Get ROC Area Test

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the test data. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

#### [Get ROC Area Training](#get-roc-area-training)

**Syntax:** obj \<< Get ROC Area Training

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the training data set. The ROC curve needs to be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

#### [Get ROC Area Validation](#get-roc-area-validation)

**Syntax:** obj \<< Get ROC Area Validation

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the validation data set. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

#### [Get RSquare Test](#get-rsquare-test)

**Syntax:** obj \<< Get RSquare Test

**Description:** Returns the RSquare for the test set. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
r = obj << Get RSquare Test;
Show( r );


```

#### [Get RSquare Training](#get-rsquare-training)

**Syntax:** obj \<< Get RSquare Training

**Description:** Returns the RSquare for the training set.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
r = obj << Get RSquare Training;
Show( r );


```

#### [Get RSquare Validation](#get-rsquare-validation)

**Syntax:** obj \<< Get RSquare Validation

**Description:** Returns the RSquare for the validation set. Available only when using a validation set.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
r = obj << Get RSquare Validation;
Show( r );


```

#### [Get SAS DATA Step](#get-sas-data-step)

**Syntax:** obj \<< Get SAS DATA Step

**Description:** Creates a SAS DATA step to score the data and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
code = obj << Get SAS Data Step;


```

#### [Get Seconds](#get-seconds)

**Syntax:** obj \<< Get Seconds

**Description:** Returns the number of seconds used to complete the analysis.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
time = obj << Get Seconds;
Show( time );


```

#### [Get Tolerant Prediction Formula](#get-tolerant-prediction-formula)

**Syntax:** obj \<< Get Tolerant Prediction Formula

**Description:** Constructs a script to create a tolerant prediction formula column and returns it to the Log window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Get Tolerant Prediction Formula;


```

#### [Get Tolerant SAS DATA Step](#get-tolerant-sas-data-step)

**Syntax:** obj \<< Get Tolerant SAS DATA Step

**Description:** Creates a SAS DATA step to score data that includes missing values and returns it to the Log window. Missing values are randomly assigned to a tree branch.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
code = obj << Get Tolerant SAS Data Step;


```

#### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Begins iterating after K Fold Crossvalidation has been selected. If using JMP Pro, Go begins iterating after Validation column is specified.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << K Fold Crossvalidation( 5 );
obj << Go;


```

#### [Informative Missing](#informative-missing)

**Syntax:** obj = Decision Tree(...Informative Missing( state=0|1 )...)

**Description:** For categorical variables, treats missing as a category. For continuous variables, treats missing as either low or high, whichever fits better. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Boosted Tree( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Partition( Y( :height ), X( :age ), Informative Missing( 0 ) );
obj << Split Best( 1 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt:Age[3] = .;
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Informative Missing( 0 ),
    Split Best( 3 )
);


```

#### [Initial Splits](#initial-splits)

**Syntax:** obj = Partition(...Initial Splits( condition, {left condition}, {right condition} )...)

**Description:** Describes the splits that are performed. The condition argument specifies the left side of the first split. The {left condition} and {right condition} arguments specify a split on the respective side and this format continues recursively for the desired number of splits. To specify a split on the right and not the left, assign the left argument as an empty list. To specify a split on the left and not the right, omit the right argument.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Initial Splits( :size == {"Large"} )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Initial Splits( :size == {"Large"}, {}, {:size == {"Medium"}, {:age >= 25}} )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Initial Splits( :size == {"Large"}, {:type == {"Family", "Sporty"}} )
);


```

#### [K Fold Crossvalidation](#k-fold-crossvalidation)

**Syntax:** obj \<< K Fold Crossvalidation

**Description:** This is a deprecated feature.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Split Best( 2 )
);
obj << K Fold Crossvalidation( 5 );


```

#### [Leaf Report](#leaf-report)

**Syntax:** obj \<< Leaf Report( state=0|1 )

**Description:** Shows or hides a report with the mean and count (continuous response) or the response rate and count (categorical response) of the leaf nodes.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Show Tree( 0 );
obj << Leaf Report( 1 );


```

#### [Lift Curve](#lift-curve)

**Syntax:** obj \<< Lift Curve( state=0|1 )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best( 5 );
obj << Show Tree( 0 );
obj << Lift Curve( 1 );


```

#### [Lock Columns](#lock-columns)

**Syntax:** obj \<< Lock Columns( state=0|1, columns )

**Description:** Locks out specified columns from being used for splits.

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Lock Columns( 1, :age, :size );
(obj << report)[CheckboxBox( 1 )] << Select;
Wait( .5 );
obj << Lock Columns( 0 );
Wait( .5 );
obj << Lock Columns( 1 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion )
);
obj << Lock Columns( 1, :Age, :Hair Color );
(obj << report)[CheckboxBox( 1 )] << Select;
Wait( .5 );
obj << Lock Columns( 0 );
Wait( .5 );
obj << Lock Columns( 1 );


```

#### [Make SAS DATA Step](#make-sas-data-step)

**Syntax:** obj \<< Make SAS DATA Step

**Description:** Creates a SAS DATA step to score the data and returns it to a script window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Make SAS Data Step;


```

#### [Make Tolerant SAS DATA Step](#make-tolerant-sas-data-step)

**Syntax:** obj \<< Make Tolerant SAS DATA Step

**Description:** Creates a SAS DATA step to score data that includes missing values and returns it to a script window. Missing values are randomly assigned to a tree branch.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Make Tolerant SAS Data Step;


```

#### [Method](#method_1)

**Syntax:** Method( "Decision Tree" )

**Description:** Specifies the method used for partitioning the data. Decision Tree is the default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" )
);
obj << Split Best( 2 );


```

#### [Minimum Size Split](#minimum-size-split)

**Syntax:** obj \<< Minimum Size Split( number )

**Description:** Sets the minimum group size when deciding whether to split a group.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Minimum Size Split( 15 );
obj << Split Best( 4 );


```

#### [Missing Value Order](#missing-value-order)

**Syntax:** Missing Value Order( Low(list of numeric columns),High(list of numeric columns))

**Description:** Specifies if missing values are treated as low or high.

**JMP Version Added:** 16

#### [Multithreading](#multithreading)

**Syntax:** Multithreading( state=0|1 )

**Description:** Divides up the calculations among the available threads on the machine. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Split Best( 2 )
);


```

#### [Ordinal Restricts Order](#ordinal-restricts-order)

**Syntax:** obj = Decision Tree(...Ordinal Restricts Order( state=0|1 )...)

**Description:** For ordinal columns, considers only splits that preserve order. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Boosted Tree( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Partition( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ) );
obj << Split Best( 3 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Ordinal Restricts Order( 1 ),
    Split Best( 2 )
);


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides a plot using the training data with the predicted values on the X axis and actual values on the Y axis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);
obj << Plot Actual By Predicted;


```

#### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< Precision Recall Curve( state=0|1 )

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best( 5 );
obj << Show Tree( 0 );
obj << Precision Recall Curve( 1 );


```

#### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Profiler( 1 );


```

#### [Prune Worst](#prune-worst)

**Syntax:** obj \<< Prune Worst

**Description:** Removes the terminal split that has the least discrimination ability.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Prune Worst;
Wait( .5 );
obj << Prune Worst;


```

#### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Publish Prediction Formula;


```

#### [Publish Tolerant Prediction Formula](#publish-tolerant-prediction-formula)

**Syntax:** obj \<< Publish Tolerant Prediction Formula

**Description:** Builds a prediction formula that predicts even when there are missing values and publishes it as a formula column script in Formula Depot.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Publish Tolerant Prediction Formula;


```

#### [ROC Curve](#roc-curve)

**Syntax:** obj \<< ROC Curve( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best( 5 );
obj << Show Tree( 0 );
obj << ROC Curve( 1 );


```

#### [Save Leaf Label Formula](#save-leaf-label-formula)

**Syntax:** obj \<< Save Leaf Label Formula

**Description:** Saves the leaf label formula in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Leaf Label Formula;


```

#### [Save Leaf Labels](#save-leaf-labels)

**Syntax:** obj \<< Save Leaf Labels

**Description:** Saves the leaf labels in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Leaf Labels;


```

#### [Save Leaf Number Formula](#save-leaf-number-formula)

**Syntax:** obj \<< Save Leaf Number Formula

**Description:** Saves the leaf number formula in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Leaf Number Formula;


```

#### [Save Leaf Numbers](#save-leaf-numbers)

**Syntax:** obj \<< Save Leaf Numbers

**Description:** Saves the leaf numbers in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Leaf Numbers;


```

#### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds

**Description:** Saves the predicted values in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Predicteds;


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the prediction formula in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Prediction Formula;


```

#### [Save Residuals](#save-residuals)

**Syntax:** obj \<< Save Residuals

**Description:** Saves the residuals in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Residuals;


```

#### [Save Tolerant Prediction Formula](#save-tolerant-prediction-formula)

**Syntax:** obj \<< Save Tolerant Prediction Formula

**Description:** Save a formula that predicts even when there are missing values in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Tolerant Prediction Formula;


```

#### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number )

**Description:** Specifies a random seed to reproduce the results for future launches of the platform.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

#### [Show Fit Details](#show-fit-details)

**Syntax:** obj \<< Show Fit Details( state=0|1 )

**Description:** Shows or hides a report with the definition of all the measures, the misclassification rates, and the confusion matrices.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Show Tree( 0 );
obj << Show Fit Details( 1 );


```

#### [Show Graph](#show-graph)

**Syntax:** obj \<< Show Graph( state=0|1 )

**Description:** Shows or hides the partition graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << ShowGraph( 0 );
Wait( .5 );
obj << ShowGraph( 1 );


```

#### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows the points (1 or on) or shows color panels (0 or off) in the partition graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << ShowPoints( 0 );
Wait( .5 );
obj << ShowPoints( 1 );


```

#### [Show Split Bar](#show-split-bar)

**Syntax:** obj \<< Show Split Bar( state=0|1 )

**Description:** Shows or hides the colored bars that indicate the split proportions in each leaf. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Show Split Bar( 0 );
Wait( .5 );
obj << Show Split Bar( 1 );


```

#### [Show Split Candidates](#show-split-candidates)

**Syntax:** obj \<< Show Split Candidates( state=0|1 )

**Description:** Shows or hides the Candidates report in the terminal splits. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Show Split Candidates( 1 );
(obj << Report)["Candidates"] << Close( 0 ) << select;


```

#### [Show Split Count](#show-split-count)

**Syntax:** obj \<< Show Split Count( state=0|1 )

**Description:** Shows or hides the response counts for each level in each tree node.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Show Split Count( 0 );
Wait( .5 );
obj << Show Split Count( 1 );


```

#### [Show Split Prob](#show-split-prob)

**Syntax:** obj \<< Show Split Prob( state=0|1 )

**Description:** Shows or hides the response rates for each level in each tree node.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Show Split Prob( 0 );
Wait( .5 );
obj << Show Split Prob( 1 );


```

#### [Show Split Stats](#show-split-stats)

**Syntax:** obj \<< Show Split Stats( state=0|1 )

**Description:** Shows or hides the count and the split statistics. The statistics shown include the G² or the mean and standard deviation. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Show Split Stats( 0 );
Wait( .5 );
obj << Show Split Stats( 1 );


```

#### [Show Tree](#show-tree)

**Syntax:** obj \<< Show Tree( state=0|1 )

**Description:** Shows or hides the tree structure with the partition information. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << ShowTree( 1 );


```

#### [Small Tree View](#small-tree-view)

**Syntax:** obj \<< Small Tree View( state=0|1 )

**Description:** Shows or hides a smaller version of the partition tree to the right of the Partition Graph.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Small Tree View( 1 );


```

#### [Sort Split Candidates](#sort-split-candidates)

**Syntax:** obj \<< Sort Split Candidates( state=0|1 )

**Description:** Sorts the candidates by significance.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
(obj << Report)["Candidates"] << Close( 0 ) << select;
Wait( 1 );
obj << Sort Split Candidates;


```

#### [Specify Profit Matrix](#specify-profit-matrix)

**Syntax:** obj \<< Specify Profit Matrix

**Description:** Enables you to specify profits or costs associated with correct or incorrect classification decisions.

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Split Best( 3 ),
    Specify Profit Matrix( [0 -1, -1 0, . .], "Married", "Single", "Undecided" ),
    Show Fit Details( 1 )
);


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 ),
    Specify Profit Matrix( [0 -1, -1 0, . .], "Yes", "No", "Undecided" ),
    Show Fit Details( 1 )
);


```

#### [Split Best](#split-best)

**Syntax:** obj \<< Split Best( <number of splits> )

**Description:** Splits the tree at the optimal split point.

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best;
Wait( .5 );
obj << Split Best( 2 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion )
);
obj << Split Best;
Wait( 1 );
obj << Split Best( 2 );


```

#### [Split History](#split-history)

**Syntax:** obj \<< Split History( state=0|1 )

**Description:** Shows or hides a graph showing each split on the X axis and the corresponding R² value for the model on the Y axis.

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best( 5 );
obj << Show Tree( 0 );
obj << Split History;


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion )
);
obj << Split Best( 2 );
obj << Show Tree( 0 );
obj << Split History;


```

#### [Tree 3D](#tree-3d)

**Syntax:** obj \<< Tree 3D( state=0|1 )

**Description:** Shows or hides a 3D plot of the tree structure.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best( 14 );
obj << Show Tree( 0 );
obj << Tree 3D( 1 );


```

#### [Use Excluded Rows for Validation](#use-excluded-rows-for-validation)

**Syntax:** obj = Decision Tree(...Use Excluded Rows for Validation( state=0|1 )...)

**Description:** Uses the excluded rows in the data table to create a validation set. This option appears in the launch window only if you are using standard JMP and there are excluded rows.

**JMP Version Added:** 15

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 )
);
obj << Split Best( 5 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Use Excluded Rows for Validation( 1 ),
    Split Best( 2 )
);


```

#### [Validation Portion](#validation-portion)

**Syntax:** obj = Decision Tree(...Validation Portion( fraction=0 )...)

**Description:** Forms a validation set by randomly selecting rows with each row having probability p (fraction) of being selected. "0" by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :country, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 )
);
obj << Split Best( 2 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation Portion( 0.2 ),
    Go
);


```

### [Shared Item Messages](#shared-item-messages)

#### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

**Anonymous preset**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

**Search by name**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

**Search within folder(s)**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

#### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

#### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

#### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );
obj[1] << Copy ByGroup Script;


```

#### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Copy Script;


```

#### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Data Table Window;


```

#### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

#### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );
t = obj[1] << Get ByGroup Script;
Show( t );


```

#### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

**General**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

**Platform with Filter**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

#### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

#### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

#### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
t = obj << Get Script;
Show( t );


```

#### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
t = obj << Get Script With Data Table;
Show( t );


```

#### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
t = obj << Get Timing;
Show( t );


```

#### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

#### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

#### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

#### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

#### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

#### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

#### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Redo Analysis;


```

#### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Relaunch Analysis;


```

#### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

#### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

#### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Report View( "Summary" );


```

#### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );
obj[1] << Save ByGroup Script to Data Table;


```

#### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );
obj[1] << Save ByGroup Script to Journal;


```

#### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );
obj[1] << Save ByGroup Script to Script Window;


```

#### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Script for All Objects;


```

#### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Make Validation Column(
    Training Set( .5 ),
    Validation Set( .3 ),
    Test Set( .2 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) ),
    Go
);
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Split Best( 2 );
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

#### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

#### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Script to Journal;


```

#### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Script to Report;


```

#### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Save Script to Script Window;


```

#### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

#### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

#### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

#### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

#### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
obj << Title( "My Platform" );


```

#### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .5 ), Validation Set( .3 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Method( "Decision Tree" ),
    Validation( :Validation )
);
obj << Split Best( 2 );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

#### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

#### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

#### [Window View](#window-view)

**Syntax:** obj = Decision Tree(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [PictureBox](#picturebox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Predictor Screening](#predictor-screening)

## [Associated Constructors](#associated-constructors)

### [Predictor Screening](#predictor-screening_1)

**Syntax:** Predictor Screening( Y( columns ), X( columns ) )

**Description:** Identifies significant predictors from a large number of candidates by using bootstrap forest partitioning to evaluate the contribution of the predictors on the response.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Predictor Screening(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Response](#response)

**Syntax:** obj = Predictor Screening(...Response( column(s) )...)

**Description:** Specifies the response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );


```

### [X](#x)

**Syntax:** obj = Predictor Screening(...X( column(s) )...)

**Description:** Specifies the predictor variables.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );


```

### [Y](#y)

**Syntax:** obj = Predictor Screening(...Y( column(s) )...)

**Description:** Specifies the response variable or variables that you want to analyze.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );


```

## [Item Messages](#item-messages)

### [Number Trees](#number-trees)

**Syntax:** obj = Predictor Screening(...Number Trees( number=100 )...)

**Description:** Specifies the number of decision trees in the bootstrap forest model. "100" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    Number Trees( 200 )
);


```

### [Save Results](#save-results)

**Syntax:** obj \<< Save Results

**Description:** Creates a new data table that contains the predictor ranking table from the report.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Save Results;


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Predictor Screening(...Set Random Seed( number )...)

**Description:** Sets the seed for the starting values that are used in the fitting procedures.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    Set Random Seed( 1047 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Predictor Screening(
    Y( :Banding? ),
    X( Column Group( "Predictors" ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Bands Data.jmp" );
obj = dt << Predictor Screening( Y( :Banding? ), X( Column Group( "Predictors" ) ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Predictor Screening(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Preferences](#preferences)

## [Item Messages](#item-messages)

### [Add Color Theme](#add-color-theme)

**Syntax:** obj \<< Add Color Theme( Add Color Theme({"Name", \<type|style>, {color, ..., \<Missing(color)>}, \<{position, ...}>}, <color blindness discernability>) )

**Description:** Creates a new custom color theme and registers it with the theme picker.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Set Preference(
    Add Color Theme(
        {"Sunny", {{255, 255, 0}, {255, 128, 64}, {255, 0, 0}, {163, 12, 27}}, {0, 0.5,
        0.642857142857143, 1}}
    )
);
Show( Get Color Theme Detail( "Sunny" ) );


```

### [Add Rows default number of rows](#add-rows-default-number-of-rows)

**Syntax:** obj \<< Add Rows default number of rows( number )

**Description:** Initial number of rows in the Add Rows window

**JMP Version Added:** 18

### [Add Rows recall last value](#add-rows-recall-last-value)

**Syntax:** obj \<< Add Rows recall last value( state=0|1 )

**Description:** The last entered value is used for the number of rows to add

**JMP Version Added:** 18

### [Add files opened by scripts to the Recent Files list](#add-files-opened-by-scripts-to-the-recent-files-list)

**Syntax:** obj \<< Add files opened by scripts to the Recent Files list( state=0|1 )

**Description:** Changes the default setting for whether files opened with the JSL Open() function are added to the Recent Files list.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Add files opened by scripts to the Recent Files list( 1 ) );


```

### [Allow 16 Bit List Check Compression](#allow-16-bit-list-check-compression)

**Syntax:** obj \<< Allow 16 Bit List Check Compression( state=0|1 )

**Description:** Specifies whether to use List Check to encode values when there are more than 255 distinct values in the column. If encoded, these columns cannot be read by JMP 14 and earlier.

**JMP Version Added:** 15

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Allow 16 Bit List Check Compression( 1 ) );


```

### [Allow Compress Selected Columns to create compact columns](#allow-compress-selected-columns-to-create-compact-columns)

**Syntax:** obj \<< Allow Compress Selected Columns to create compact columns( state=0|1 )

**Description:** Compress Selected Columns will compact columns if that uses less disk space.

**JMP Version Added:** 18

### [Allow Unquoted Strings in JSL](#allow-unquoted-strings-in-jsl)

**Syntax:** obj \<< Allow Unquoted Strings in JSL( "No"|"Yes (with a warning)"|"Yes (no warning)" )

### [Allow mixed ISO format patterns](#allow-mixed-iso-format-patterns)

**Syntax:** obj \<< Allow mixed ISO format patterns( state=0|1 )

**Description:** Allow format pattern dates with both ISO weeks () and non-ISO years ( or ), and with both non-ISO weeks ( or ) and ISO years ( or ). ISO weeks and years are not compatible with non-ISO weeks and years. They should not be mixed. By default, JMP will not allow such date format to be created.

**JMP Version Added:** 18

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Allow mixed ISO format patterns( 1 ) );


```

### [Allow short numeric data format](#allow-short-numeric-data-format)

**Syntax:** obj \<< Allow short numeric data format( state=0|1 )

**Description:** Changes the default setting for allowing short numeric data format.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Allow short numeric data format( 1 ) );


```

### [Always allow publishing to JMP Public](#always-allow-publishing-to-jmp-public)

**Syntax:** obj \<< Always allow publishing to JMP Public( state=0|1 )

**Description:** Always enable the menu item for publishing to JMP Public, even if there are other JMP Live connections configured.

**JMP Version Added:** 19

### [Auto Hide Menus](#auto-hide-menus)

**Syntax:** obj \<< Auto Hide Menus( "Always"|"Never"|"Based on window size" )

**Description:** Determines if and when JMP auto-hides the menu and toolbars. Note: This is available on Windows only.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Auto Hide Menus( "Always" ) );


```

### [Auto Run Recent JSL](#auto-run-recent-jsl)

**Syntax:** obj \<< Auto Run Recent JSL( state=0|1 )

**Description:** Changes the default behavior for automatically running recently submitted JSL scripts. Note: This is available on Windows only.

```

//Caution: Changing a preference will affect 
//the default behavior of JMP. 

Preferences[1] << Set( Auto Run Recent JSL( 1 ) );


```

### [Auto match brackets in script editor](#auto-match-brackets-in-script-editor)

**Syntax:** obj \<< Auto match brackets in script editor( state=0|1 )

**Description:** Changes the default setting for automatically matching brackets in the script window. Note: This is available on Windows only.

```

//Caution: Changing a preference will affect 
//the default behavior of JMP. 

Preferences[1] << Set( Auto match brackets in script editor( 1 ) );


```

### [Autosave maximum data table columns](#autosave-maximum-data-table-columns)

**Syntax:** obj \<< Autosave maximum data table columns( number )

**Description:** Maximum number of data table columns that will be automatically saved.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Autosave Maximum Data Table Columns( 1000 ) );


```

### [Autosave maximum data table rows](#autosave-maximum-data-table-rows)

**Syntax:** obj \<< Autosave maximum data table rows( number )

**Description:** Maximum number of data table rows that will be automatically saved.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Autosave Maximum Data Table Rows( 10000 ) );


```

### [Autosave timeout](#autosave-timeout)

**Syntax:** obj \<< Autosave timeout( number )

**Description:** Autosave time-out interval is in minutes. When the time-out interval has been met, all open and modified files are saved. The default value is "0", which indicates that no autosave processing will be performed.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Autosave Timeout( 15 ) );


```

### [Axis Title Above](#axis-title-above)

**Syntax:** obj \<< Axis Title Above( state=0|1 )

**Description:** Changes the position of the y-axis label in graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Axis Title Above( 1 ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color )

**Description:** Changes the default setting for the background color in all windows. Note: Available for Windows only.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Background Color( "Light Blue" ) );


```

### [Bad to Good Color Theme](#bad-to-good-color-theme)

**Syntax:** obj \<< Bad to Good Color Theme( "name" )

**Description:** Changes the default setting for the continuous color theme appearing in all graphs.

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Show( Get Preference( Continuous Color Theme ) );
Set Preference( Bad to Good Color Theme( "Green to Purple" ) );
Show( Get Preference( Bad to Good Color Theme ) );


```

### [Box Plot Line Width](#box-plot-line-width)

**Syntax:** obj \<< Box Plot Line Width( number )

**Description:** Changes the default line width for box plots.

```

//Caution: Changing a preference will
//affect the default behavior of JMP.

Preferences[1] << Set( Box Plot Line Width( 2 ) );


```

### [Bypass Proxy](#bypass-proxy)

**Syntax:** obj \<< Bypass Proxy( text )

**Description:** Disable proxy use for specific hosts

**JMP Version Added:** 15

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Bypass Proxy( "www.example.com" ) );


```

### [Categorical Color Theme](#categorical-color-theme)

**Syntax:** obj \<< Categorical Color Theme( "name" )

**Description:** Changes the default setting for the categorical color theme appearing in all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Show( Get Preference( Categorical Color Theme ) );
Set Preference( Categorical Color Theme( "Jet" ) );
Show( Get Preference( Categorical Color Theme ) );


```

### [Categorical graph type](#categorical-graph-type)

**Syntax:** obj \<< Categorical graph type( "Auto"|"Histogram"|"Bars"|"Heat Map"|"Mosaic"|"Run Chart"|"Run Chart" )

**Description:** Default graph to display in column header for nominal and ordinal columns.

**JMP Version Added:** 18

### [Classic Data Table Selection](#classic-data-table-selection)

**Syntax:** obj \<< Classic Data Table Selection( state=0|1 )

**Description:** Enables classic click selection behavior in the data table. In this mode, selecting a column will have no effect on row selection, and selecting a row will have no effect on column selection.

**JMP Version Added:** 19

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Classic Data Table Selection( 1 ) );


```

### [Color Mode](#color-mode)

**Syntax:** obj \<< Color Mode( "Use System Setting"|"Light"|"Dark"|"High Contrast" )

**Description:** Changes whether JMP uses a specific window coloring theme or honors the operating system setting.

```

//Caution: Changing a preference will affect 
//the default behavior of JMP. 

Preferences[1] << Set( Color Mode( Dark ) );


```

### [Columns Manager](#columns-manager)

**Syntax:** obj \<< Columns Manager

**JMP Version Added:** 18

### [Conditional formatting rules](#conditional-formatting-rules)

**Syntax:** obj \<< Conditional formatting rules

**Description:** Creates a custom conditional rule that is shown or not according to the Show conditional formatting preference setting.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences(
    Conditional Formatting Rules(
        RuleSet(
            RuleName( "My Special Rule" ),
            GreaterThan(
                Value( 0 ),
                Inclusive( 0 ),
                Format(
                    Text Color( "Medium Dark Red" ),
                    Back Color( "Light Yellow" ),
                    Annotation( 1 ),
                    FontStyle( Bold )
                )
            )
        )
    )
);


```

### [Continuous Color Theme](#continuous-color-theme)

**Syntax:** obj \<< Continuous Color Theme( "name" )

**Description:** Changes the default setting for the continuous color theme appearing in all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Show( Get Preference( Continuous Color Theme ) );
Set Preference( Continuous Color Theme( "Green to Purple" ) );
Show( Get Preference( Continuous Color Theme ) );


```

### [Continuous graph type](#continuous-graph-type)

**Syntax:** obj \<< Continuous graph type( "Auto"|"Histogram"|"Bars"|"Heat Map"|"Mosaic"|"Run Chart"|"Run Chart" )

**Description:** Default graph to display in column header for continuous columns.

**JMP Version Added:** 18

### [Custom Locale Settings](#custom-locale-settings)

**Syntax:** obj \<< Custom Locale Settings

**Description:** Overrides locale settings such as decimal separator and thousands separator

**JMP Version Added:** 16

**Example 1**

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Custom Locale Settings( Decimal Separator( "," ) ) );
Print( Format( 1.25, "Best" ) );
Preferences( Custom Locale Settings( Decimal Separator( "." ) ) );
Print( Format( 1.25, "Best" ) );
Preferences( Custom Locale Settings( Decimal Separator() ) );


```

**Example 2**

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

// Clear all locale overrides...
Preferences( Custom Locale Settings( Reset to Defaults ) );


```

**Example 3**

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Get Preferences( Custom Locale Settings );


```

### [Data Filter Auto Clear](#data-filter-auto-clear)

**Syntax:** obj \<< Data Filter Auto Clear( state=0|1 )

### [Data Filter Check Box Display](#data-filter-check-box-display)

**Syntax:** obj \<< Data Filter Check Box Display( state=0|1 )

**Description:** Default display for categorical filter column is check box display.

### [Data Filter Conditional](#data-filter-conditional)

**Syntax:** obj \<< Data Filter Conditional( state=0|1 )

### [Data Filter Group is AND](#data-filter-group-is-and)

**Syntax:** obj \<< Data Filter Group is AND( state=0|1 )

### [Data Filter Histograms and Bars](#data-filter-histograms-and-bars)

**Syntax:** obj \<< Data Filter Histograms and Bars( state=0|1 )

**Description:** Show Histograms and Bars for filter columns where available

**JMP Version Added:** 15

### [Data Filter Include Check](#data-filter-include-check)

**Syntax:** obj \<< Data Filter Include Check( state=0|1 )

### [Data Filter Select Check](#data-filter-select-check)

**Syntax:** obj \<< Data Filter Select Check( state=0|1 )

### [Data Filter Show Check](#data-filter-show-check)

**Syntax:** obj \<< Data Filter Show Check( state=0|1 )

### [Data Table Actions](#data-table-actions)

**Syntax:** obj \<< Data Table Actions( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Data Table Actions( 1 ) );


```

### [Data Table Title on Output](#data-table-title-on-output)

**Syntax:** obj \<< Data Table Title on Output( state=0|1 )

**Description:** Changes the default setting for displaying the data table names at the top of the report's output.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Data Table Title on Output( 1 ) );


```

### [Date Title on Output](#date-title-on-output)

**Syntax:** obj \<< Date Title on Output( state=0|1 )

**Description:** Changes the default setting for displaying the date in the title of the output.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Date Title on Output( 1 ) );


```

### [Default Field Width](#default-field-width)

**Syntax:** obj \<< Default Field Width( number )

**Description:** Change the default field width used for new numeric columns.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Default Field Width( 16 ) );


```

### [Default Project Show Bookmarks](#default-project-show-bookmarks)

**Syntax:** obj \<< Default Project Show Bookmarks( state=0|1 )

**Description:** Show the Project pane in new projects

**JMP Version Added:** 16

### [Default Project Show Contents](#default-project-show-contents)

**Syntax:** obj \<< Default Project Show Contents( state=0|1 )

**Description:** Show the Contents pane in new projects

**JMP Version Added:** 16

### [Default Project Show Log](#default-project-show-log)

**Syntax:** obj \<< Default Project Show Log( state=0|1 )

**Description:** Show the Log pane in new projects

**JMP Version Added:** 16

### [Default Project Show Recent Files](#default-project-show-recent-files)

**Syntax:** obj \<< Default Project Show Recent Files( state=0|1 )

**Description:** Show the Recent Files pane in new projects

**JMP Version Added:** 16

### [Default Project Show Workspace](#default-project-show-workspace)

**Syntax:** obj \<< Default Project Show Workspace( state=0|1 )

**Description:** Show the Workspace pane in new projects

**JMP Version Added:** 16

### [Display JSL SAS results as HTML](#display-jsl-sas-results-as-html)

**Syntax:** obj \<< Display JSL SAS results as HTML( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "Display JSL SAS results as HTML"n( 1 ) );


```

### [Display indexes in English](#display-indexes-in-english)

**Syntax:** obj \<< Display indexes in English( state=0|1 )

**Description:** Displays the Object Scripting Index, the JSL Functions Index, and the Display Box Index in English.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Display indexes in English( 1 ) );


```

### [Double Click Opens Column Info](#double-click-opens-column-info)

**Syntax:** obj \<< Double Click Opens Column Info( state=0|1 )

**Description:** Double clicking on a column header will open the column info dialog rather than editing the column name.

**JMP Version Added:** 19

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Double Click Opens Column Info( 1 ) );


```

### [Empty Project at Startup](#empty-project-at-startup)

**Syntax:** obj \<< Empty Project at Startup( "Always"|"If no other project is open"|"Never" )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Create an empty project when starting JMP( "Always" ) );


```

### [Emulate Zoom Mode](#emulate-zoom-mode)

**Syntax:** obj \<< Emulate Zoom Mode( state=0|1 )

**Description:** Determines whether JMP includes the Window List in maximized windows

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Emulate Zoom Mode( 1 ) );


```

### [Enable Advanced Linear Algebra Routines](#enable-advanced-linear-algebra-routines)

**Syntax:** obj \<< Enable Advanced Linear Algebra Routines( state=0|1 )

**Description:** Changes the linear algebra computation routines that are used in multiple platforms and JSL functions. When selected, this preference enables advanced linear algebra routines that are based on the BLAS and LAPACK libraries. The JMP documentation contains more information about the platforms and JSL functions that are affected by this preference.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enable Advanced Linear Algebra Routines( 0 ) );


```

### [Enable Telemetry](#enable-telemetry)

**Syntax:** obj \<< Enable Telemetry( state=0|1 )

### [Enable direct input from IME](#enable-direct-input-from-ime)

**Syntax:** obj \<< Enable direct input from IME( state=0|1 )

### [End Menu Item Marking After Deadline](#end-menu-item-marking-after-deadline)

**Syntax:** obj \<< End Menu Item Marking After Deadline( state=0|1 )

**Description:** Menu items will no longer be marked after the time limit elapses

**JMP Version Added:** 17

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( End Menu Item Marking After Deadline( 0 ) );


```

### [Enhanced Log Alternate Table Rows](#enhanced-log-alternate-table-rows)

**Syntax:** obj \<< Enhanced Log Alternate Table Rows( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Shade Alternate Table Rows( 1 ) );


```

### [Enhanced Log Color By Window](#enhanced-log-color-by-window)

**Syntax:** obj \<< Enhanced Log Color By Window( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Color By Window( 1 ) );


```

### [Enhanced Log Color By Window Color Theme](#enhanced-log-color-by-window-color-theme)

**Syntax:** obj \<< Enhanced Log Color By Window Color Theme( "name" )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Show( Get Preference( Enhanced Log Color By Window Color Theme ) );
Set Preference( Enhanced Log Color By Window Color Theme( "Jet" ) );
Show( Get Preference( Enhanced Log Color By Window Color Theme ) );


```

### [Enhanced Log Filter Action](#enhanced-log-filter-action)

**Syntax:** obj \<< Enhanced Log Filter Action( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Filter Action( 1 ) );


```

### [Enhanced Log Filter Error](#enhanced-log-filter-error)

**Syntax:** obj \<< Enhanced Log Filter Error( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Filter Error( 1 ) );


```

### [Enhanced Log Filter Log](#enhanced-log-filter-log)

**Syntax:** obj \<< Enhanced Log Filter Log( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Filter Log( 1 ) );


```

### [Enhanced Log Filter Result](#enhanced-log-filter-result)

**Syntax:** obj \<< Enhanced Log Filter Result( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Filter Result( 1 ) );


```

### [Enhanced Log Filter Script](#enhanced-log-filter-script)

**Syntax:** obj \<< Enhanced Log Filter Script( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Filter Script( 1 ) );


```

### [Enhanced Log Filter Warn](#enhanced-log-filter-warn)

**Syntax:** obj \<< Enhanced Log Filter Warn( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Filter Warn( 1 ) );


```

### [Enhanced Log Origin Column](#enhanced-log-origin-column)

**Syntax:** obj \<< Enhanced Log Origin Column( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Origin Column( 1 ) );


```

### [Enhanced Log Result Column](#enhanced-log-result-column)

**Syntax:** obj \<< Enhanced Log Result Column( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Result Column( 1 ) );


```

### [Enhanced Log Shade Table Cells](#enhanced-log-shade-table-cells)

**Syntax:** obj \<< Enhanced Log Shade Table Cells( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Shade Table Cells( 1 ) );


```

### [Enhanced Log Shade Table Headings](#enhanced-log-shade-table-headings)

**Syntax:** obj \<< Enhanced Log Shade Table Headings( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Shade Table Headings( 1 ) );


```

### [Enhanced Log Table Column Borders](#enhanced-log-table-column-borders)

**Syntax:** obj \<< Enhanced Log Table Column Borders( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Table Column Borders( 1 ) );


```

### [Enhanced Log Table Heading Column Borders](#enhanced-log-table-heading-column-borders)

**Syntax:** obj \<< Enhanced Log Table Heading Column Borders( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Table Heading Column Borders( 1 ) );


```

### [Enhanced Log Table Row Borders](#enhanced-log-table-row-borders)

**Syntax:** obj \<< Enhanced Log Table Row Borders( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Table Row Borders( 1 ) );


```

### [Enhanced Log Timestamp Column](#enhanced-log-timestamp-column)

**Syntax:** obj \<< Enhanced Log Timestamp Column( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Timestamp Column( 1 ) );


```

### [Enhanced Log Underline Table Headings](#enhanced-log-underline-table-headings)

**Syntax:** obj \<< Enhanced Log Underline Table Headings( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enhanced Log Underline Table Headings( 1 ) );


```

### [Enter Key moves down](#enter-key-moves-down)

**Syntax:** obj \<< Enter Key moves down( state=0|1 )

**Description:** Changes the default setting for the Enter key movement.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Enter Key moves down( 1 ) );


```

### [Evaluate OnOpen Scripts](#evaluate-onopen-scripts)

**Syntax:** obj \<< Evaluate OnOpen Scripts( "Prompt"|"Never"|"Always" )

**Description:** Set to "Never" to never allow OnOpen scripts to run. Scripts from unknown sources should not be run.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Evaluate OnOpen Scripts( "Prompt" ) );


```

### [Excel Open Method](#excel-open-method)

**Syntax:** obj \<< Excel Open Method( "Open All Sheets"|"Select Individual Worksheets"|"Use Excel Wizard" )

### [Fast Marker Threshold](#fast-marker-threshold)

**Syntax:** obj \<< Fast Marker Threshold( number )

**Description:** Changes the default setting for refreshing markers on graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Fast Marker Threshold( 100000 ) );


```

### [Fill Hollow Markers](#fill-hollow-markers)

**Syntax:** obj \<< Fill Hollow Markers( state=0|1 )

**Description:** Hollow markers will be filled with the graph background color

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Fill Hollow Markers( 1 ) );


```

### [Fill Selection Color](#fill-selection-color)

**Syntax:** obj \<< Fill Selection Color( color )

**Description:** Color of filled selections when Fill Selection Mode is Selected Same Color.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Fill Selection Color( "Red" ) );


```

### [Fill Selection Fade](#fill-selection-fade)

**Syntax:** obj \<< Fill Selection Fade( number )

**Description:** Changes the default setting for the amount unselected fills are faded.

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Fill Selection Fade( 50 ) );


```

### [Fill Selection Mode](#fill-selection-mode)

**Syntax:** obj \<< Fill Selection Mode( "Selected Patterned"|"Selected Darker"|"Selected Outlined"|"Selected Same Color"|"Unselected Faded" )

**Description:** Changes the way that the selection is indicated for filled areas. Default is patterned.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Fill Selection Mode( "Selected Patterned" ) );


```

### [Formula Evaluation](#formula-evaluation)

**Syntax:** obj \<< Formula Evaluation( "When Idle"|"Immediate" )

**Description:** Determines if formula evaluation happens during idle time or if it runs immediately in the foreground

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Formula Evaluation( "Immediate" ) );


```

### [Frame Border](#frame-border)

**Syntax:** obj \<< Frame Border( state=0|1 )

**Description:** Changes the default setting for displaying the frame border on non-axis sides of all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Frame Border( 1 ) );


```

### [Frame Color](#frame-color)

**Syntax:** obj \<< Frame Color( color )

**Description:** Changes the default setting for the color of frame borders drawn on all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Frame Color( "Green" ) );


```

### [Get](#get)

**Syntax:** obj \<< Get

**Description:** Returns the script for setting a specified preference.

```

a = Preferences[1] << Get( Show the Tip of the Day at startup );
Show( a );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Returns the script for setting the preferences.

```

a = Preferences[1] << Get Script;
Show( a );


```

### [Graph Background Color](#graph-background-color)

**Syntax:** obj \<< Graph Background Color( color )

**Description:** Changes the default setting for the background color in all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Graph Background Color( "Light Green" ) );


```

### [Graph Border](#graph-border)

**Syntax:** obj \<< Graph Border( state=0|1 )

**Description:** Changes the default setting for displaying the graph border on all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Graph Border( 1 ) );


```

### [Graph Height](#graph-height)

**Syntax:** obj \<< Graph Height( number )

**Description:** Changes the default setting for the graph height for all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Graph Height( 1 ) );


```

### [Graph Marker](#graph-marker)

**Syntax:** obj \<< Graph Marker( marker )

**Description:** Changes the default setting for the marker shape appearing in all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Graph Marker( "Diamond" ) );


```

### [Graph Marker Theme](#graph-marker-theme)

**Syntax:** obj \<< Graph Marker Theme( "Standard"|"Hollow"|"Solid"|"Paired"|"Classic"|"Alphanumeric" )

**Description:** Changes the default setting for the marker theme appearing in all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Graph Marker Theme( "Classic" ) );


```

### [Graph Marker Unselected Fade](#graph-marker-unselected-fade)

**Syntax:** obj \<< Graph Marker Unselected Fade( number )

**Description:** Changes the default setting for the amount unselected markers are faded.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Graph Marker Unselected Fade( 45 ) );


```

### [Graph Marker size](#graph-marker-size)

**Syntax:** obj \<< Graph Marker size( "Dot"|"Small"|"Medium"|"Large"|"XL"|"XXL"|"XXXL" )

**Description:** Changes the default setting for the marker size appearing in all graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Graph Marker size( "Large" ) );


```

### [HDF5PathDelimiter](#hdf5pathdelimiter)

**Syntax:** obj \<< HDF5PathDelimiter( text )

**JMP Version Added:** 17

### [Header summary heat map color theme](#header-summary-heat-map-color-theme)

**Syntax:** obj \<< Header summary heat map color theme( "name" )

**Description:** Changes the default setting for the continuous color theme appearing in all graphs.

**JMP Version Added:** 18

```

//Caution: Changing a preference will
//affect the default behavior of JMP.
Show( Get Preference( Header summary heat map color theme ) );
Set Preference( Header summary heat map color theme( "Green to Purple" ) );
Show( Get Preference( Header summary heat map color theme ) );


```

### [Hide 'Find and Replace' window](#hide-find-and-replace-window)

**Syntax:** obj \<< Hide 'Find and Replace' window( state=0|1 )

**Description:** Changes the default setting for keeping the 'Find and Replace' window open after finding and replacing.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "Hide 'Find and Replace' window"n( 1 ) );


```

### [Hide ODBC Connection Strings](#hide-odbc-connection-strings)

**Syntax:** obj \<< Hide ODBC Connection Strings( state=0|1 )

### [Hide Overlapping Labels](#hide-overlapping-labels)

**Syntax:** obj \<< Hide Overlapping Labels( state=0|1 )

**Description:** Hides the overlapping labels in a graph.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Hide Overlap Labels( 0 ) );


```

### [Histogram Color](#histogram-color)

**Syntax:** obj \<< Histogram Color( color )

**Description:** Changes the default color for histograms.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Histogram Color( "Light Yellow" ) );


```

### [Histogram Line Color](#histogram-line-color)

**Syntax:** obj \<< Histogram Line Color( color )

**Description:** Changes the default line color for histograms.

**JMP Version Added:** 17

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Histogram Line Color( "Red" ) );


```

### [Hover Help](#hover-help)

**Syntax:** obj \<< Hover Help( state=0|1 )

**Description:** Tooltip-style help responding to circular mouse motions

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Hover Help( 1 ) );


```

### [Image Format for PowerPoint](#image-format-for-powerpoint)

**Syntax:** obj \<< Image Format for PowerPoint( "Default OS format"|"PNG"|"JPEG" )

### [Include Responses Not in Data](#include-responses-not-in-data)

**Syntax:** obj \<< Include Responses Not in Data( state=0|1 )

**Description:** Show the labels of those responses with no occurrence in the data table.

### [Initial JMP Window](#initial-jmp-window)

**Syntax:** obj \<< Initial JMP Window( "Home Window"|"JMP Starter"|"Window List" )

**Description:** Determines the JMP window that is created when JMP starts

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Initial JMP Window( "Home Window" ) );


```

### [Initial Log Window](#initial-log-window)

**Syntax:** obj \<< Initial Log Window( state=0|1 )

**Description:** Changes the default setting for displaying the initial log window.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Initial Log Window( 1 ) );


```

### [Initial Splash Window](#initial-splash-window)

**Syntax:** obj \<< Initial Splash Window( state=0|1 )

**Description:** Changes the default setting for displaying the initial splash window.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Initial Splash Window( 1 ) );


```

### [Inside Ticks](#inside-ticks)

**Syntax:** obj \<< Inside Ticks( state=0|1 )

**Description:** Changes the default setting for displaying axis tick marks on the inside of graph frames.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Inside Ticks( 1 ) );


```

### [Interactive HTML Color](#interactive-html-color)

**Syntax:** obj \<< Interactive HTML Color( "Light Background"|"Dark Background"|"Gray Background" )

**Description:** Changes the default setting for the interactive HTML color theme.

**JMP Version Added:** 15

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Interactive HTML Color( "Light Background" ) );


```

### [Internet Open Timeout](#internet-open-timeout)

**Syntax:** obj \<< Internet Open Timeout( number )

**Description:** Internet Open will wait this many seconds before giving up.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Internet Open Timeout( 300 /* 5 minutes */ ) );


```

### [JMP Live Timeout](#jmp-live-timeout)

**Syntax:** obj \<< JMP Live Timeout( number )

**Description:** Sets the timeout value for publishing to JMP Live. The default is 180 seconds.

**JMP Version Added:** 15

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( JMP Live Timeout( 120 ) );


```

### [JMP Theme](#jmp-theme)

**Syntax:** obj \<< JMP Theme( "Traditional"|"Comfortable"|"JMP Live"|"JMP Clinical" )

**Description:** Switches theme for all of JMP.

**JMP Version Added:** 19

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );

restore theme = Get Preference( JMP Theme );
Set Preference( JMP Theme( "Traditional" ) );
Wait( 2 );
Set Preference( JMP Theme( "Comfortable" ) );
Wait( 2 );
Set Preference( JMP Theme( "JMP Live" ) );
Wait( 2 );
restore theme;


```

### [JSL save column groups with group name](#jsl-save-column-groups-with-group-name)

**Syntax:** obj \<< JSL save column groups with group name( state=0|1 )

**Description:** When saving script with list of columns, use 'column group' syntax if the list of columns is a column group

**JMP Version Added:** 16

### [JSS Dir](#jss-dir)

**Syntax:** obj \<< JSS Dir( text )

**Description:** Changes the JSS directory for development use.

**JMP Version Added:** 19

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Set Preference( JSS Dir( "C:\My\Path\To\jss\" ) );


```

### [Journal Freeze Backward Compatible](#journal-freeze-backward-compatible)

**Syntax:** obj \<< Journal Freeze Backward Compatible( state=0|1 )

### [Language Switch Warning](#language-switch-warning)

**Syntax:** obj \<< Language Switch Warning( state=0|1 )

**Description:** Changes the default setting for warning when detecting change in language. Note: Available on Windows only.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Language Switch Warning( 1 ) );


```

### [Laser pointer](#laser-pointer)

**Syntax:** obj \<< Laser pointer( "Off"|"Purple"|"Blue"|"Green"|"Yellow"|"Orange"|"Red" )

**Description:** Changes the default setting for displaying a laser pointer for emphasizing parts of a report.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Laser pointer( "Purple" ) );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( number )

**Description:** Changes the default line width for graph content.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Line Width( 2 ) );


```

### [Log Mode](#log-mode)

**Syntax:** obj \<< Log Mode( "Enhanced"|"Text" )

**Description:** Changes the default setting for how the logs are displayed. This includes the main and project logs.

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Log Mode( "Text" ) );


```

### [Log Window Height](#log-window-height)

**Syntax:** obj \<< Log Window Height( number )

**Description:** Changes the default setting for the size of the log window. Note: This is available on Windows only.

```

//Caution: Changing a preference will affect 
//the default behavior of JMP. 

Preferences[1] << Set( Log Window Height( 200 ) );


```

### [Major Grid Line Color](#major-grid-line-color)

**Syntax:** obj \<< Major Grid Line Color( color )

**Description:** Changes the default color of major grid lines in graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Major Grid Line Color( "Blue" ) );


```

### [Major Grid Lines](#major-grid-lines)

**Syntax:** obj \<< Major Grid Lines( state=0|1 )

**Description:** Changes the default setting for displaying major grid lines in graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Major Grid Lines( 1 ) );


```

### [Mark Menu Items Added Since](#mark-menu-items-added-since)

**Syntax:** obj \<< Mark Menu Items Added Since( "None"|"Current Version"|"18"|"17"|"16"|"15"|"14" )

**Description:** Mark menu items newer than a particular JMP version.

**JMP Version Added:** 17

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Mark Items Added Since( "16" ) );


```

### [Marker Label Color](#marker-label-color)

**Syntax:** obj \<< Marker Label Color( color )

**Description:** Color of marker labels if "Marker Label Color Style" is set to "Fixed"

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Marker Label Color( "Blue" ) );


```

### [Marker Label Color Style](#marker-label-color-style)

**Syntax:** obj \<< Marker Label Color Style( "Marker Color"|"Marker Color Faded"|"Fixed Color" )

**Description:** Changes the default coloring style for marker labels

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Marker Label Color Style( "Marker Color" ) );


```

### [Marker Selection Mode](#marker-selection-mode)

**Syntax:** obj \<< Marker Selection Mode( "Unselected Faded"|"Selected Larger"|"Selected Haloed"|"Selected Outlined"|"Selected Same Color" )

**Description:** Changes the default setting for the marker selection mode. The default is Unselected Faded.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Marker Selection Mode( "Selection Haloed" ) );


```

### [Maximum Auto Size Column List Width](#maximum-auto-size-column-list-width)

**Syntax:** obj \<< Maximum Auto Size Column List Width( number )

**JMP Version Added:** 18

### [Maximum JMP Call Depth](#maximum-jmp-call-depth)

**Syntax:** obj \<< Maximum JMP Call Depth( number )

**Description:** Changes the default setting for the Maximum JMP call depth.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Maximum JMP call depth( 50 ) );


```

### [Maximum Parse Depth](#maximum-parse-depth)

**Syntax:** obj \<< Maximum Parse Depth( number )

**Description:** Changes the default setting for the Maximum Parsing Depth. Default value is 512.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Maximum Parse Depth( 600 ) );


```

### [Maximum Symbol Evaluation Recursion Depth](#maximum-symbol-evaluation-recursion-depth)

**Syntax:** obj \<< Maximum Symbol Evaluation Recursion Depth( number )

**Description:** Changes the default setting for the Maximum Symbol Evaluation Recursion Depth. Default value is 25.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Maximum Symbol Evaluation Recursion Depth( 50 ) );


```

### [Minor Grid Line Color](#minor-grid-line-color)

**Syntax:** obj \<< Minor Grid Line Color( color )

**Description:** Changes the default color of minor grid lines in graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Minor Grid Line Color( "Black" ) );


```

### [Minor Grid Lines](#minor-grid-lines)

**Syntax:** obj \<< Minor Grid Lines( state=0|1 )

**Description:** Changes the default setting for displaying minor grid lines in graphs.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Minor Grid Lines( 1 ) );


```

### [New Project Template](#new-project-template)

**Syntax:** obj \<< New Project Template( text )

**Description:** File to use for new, empty projects.

**JMP Version Added:** 16

### [New character columns default to compact](#new-character-columns-default-to-compact)

**Syntax:** obj \<< New character columns default to compact( state=0|1 )

**Description:** New character columns or columns switched to the character data type are automatically made compact columns

**JMP Version Added:** 18

### [OAuth2 Authentication Browser](#oauth2-authentication-browser)

**Syntax:** obj \<< OAuth2 Authentication Browser( text=Default )

**Description:** Sign in to OAuth2 servers with the specified browser type. Valid values are "Default", "Embedded", "External". "Default" by default.

**JMP Version Added:** 17

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set(
    Sign in to OAuth2 servers with the specified browser type( "Embedded" )
);


```

### [ODBC Allow Table Replace](#odbc-allow-table-replace)

**Syntax:** Preferences[1] \<< Name("ODBC Allow Table Replace") ( state = 0|1 )

**Description:** Select this option to allow ODBC table replace. This option is selected by default. Replacing an ODBC table will drop the existing table in the database and replace it with a new table.

```

//Caution: Changing a preference will
//affect the default behavior of JMP.

Preferences[1] << Name( "ODBC Allow Table Replace" )(0);


```

### [ODBC Hide Connection String](#odbc-hide-connection-string)

**Syntax:** obj \<< ODBC Hide Connection String( state=0|1 )

### [Open Text File Charset](#open-text-file-charset)

**Syntax:** obj \<< Open Text File Charset( "Best Guess"|"ASMO-708"|"big5"|"cp1025"|"cp866"|"cp875"|"csISO2022JP"|"DOS-720"|"DOS-862"|"EUC-CN"|"EUC-JP"|"euc-kr"|"GB18030"|"gb2312"|"hz-gb-2312"|"IBM00858"|"IBM00924"|"IBM01047"|"IBM01140"|"IBM01141"|"IBM01142"|"IBM01143"|"IBM01144"|"IBM01145"|"IBM01146"|"IBM01147"|"IBM01148"|"IBM01149"|"IBM037"|"IBM1026"|"IBM273"|"IBM277"|"IBM278"|"IBM280"|"IBM284"|"IBM285"|"IBM290"|"IBM297"|"IBM420"|"IBM423"|"IBM424"|"IBM437"|"IBM500"|"ibm737"|"ibm775"|"ibm850"|"ibm852"|"IBM855"|"ibm857"|"IBM860"|"ibm861"|"IBM863"|"IBM864"|"IBM865"|"ibm869"|"IBM870"|"IBM871"|"IBM880"|"IBM905"|"IBM-Thai"|"iso-2022-jp"|"iso-2022-jp"|"iso-2022-kr"|"iso-8859-1"|"iso-8859-13"|"iso-8859-15"|"iso-8859-2"|"iso-8859-3"|"iso-8859-4"|"iso-8859-5"|"iso-8859-6"|"iso-8859-7"|"iso-8859-8"|"iso-8859-8-i"|"iso-8859-9"|"Johab"|"koi8-r"|"koi8-u"|"ks_c_5601-1987"|"macintosh"|"shift_jis"|"us-ascii"|"utf-16"|"utf-16BE"|"utf-32"|"utf-7"|"utf-8"|"windows-1250"|"windows-1251"|"Windows-1252"|"windows-1253"|"windows-1254"|"windows-1255"|"windows-1256"|"windows-1257"|"windows-1258"|"windows-874"|"x-Chinese-CNS"|"x-Chinese-Eten"|"x-cp20001"|"x-cp20003"|"x-cp20004"|"x-cp20005"|"x-cp20261"|"x-cp20269"|"x-cp20936"|"x-cp20949"|"x-cp50227"|"x-EBCDIC-KoreanExtended"|"x-IA5"|"x-IA5-German"|"x-IA5-Norwegian"|"x-IA5-Swedish"|"x-iscii-as"|"x-iscii-be"|"x-iscii-de"|"x-iscii-gu"|"x-iscii-ka"|"x-iscii-ma"|"x-iscii-or"|"x-iscii-pa"|"x-iscii-ta"|"x-iscii-te"|"x-mac-arabic"|"x-mac-ce"|"x-mac-chinesesimp"|"x-mac-chinesetrad"|"x-mac-croatian"|"x-mac-cyrillic"|"x-mac-greek"|"x-mac-hebrew"|"x-mac-icelandic"|"x-mac-japanese"|"x-mac-korean"|"x-mac-romanian"|"x-mac-thai"|"x-mac-turkish"|"x-mac-ukrainian" )

**Description:** Specifies the encoding to use if no Unicode Byte Order Mark is found; the default is to guess the encoding based on the file's content.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Open Text File Charset( "utf-8" ) );


```

### [Open character columns as compact columns](#open-character-columns-as-compact-columns)

**Syntax:** obj \<< Open character columns as compact columns( state=0|1 )

**Description:** Automatically open character columns as compact columns when JMP determines it's advantageous

**JMP Version Added:** 18

### [Open files from outside projects in](#open-files-from-outside-projects-in)

**Syntax:** obj \<< Open files from outside projects in( "No Project"|"Open Project or No Project"|"Open Project or New Project"|"New Project" )

**JMP Version Added:** 16

### [Outline Close Orientation](#outline-close-orientation)

**Syntax:** obj \<< Outline Close Orientation( "Auto"|"Horizontal"|"Vertical" )

**Description:** Option for Outline Boxes to collapse vertically to save horizontal space

### [Parallel Data Table Column Decompression](#parallel-data-table-column-decompression)

**Syntax:** obj \<< Parallel Data Table Column Decompression( state=0|1 )

**Description:** Changes the default setting for decompressing columns in parallel. The default value is enabled. Turning off the option might allow some very large tables to load.

```

//Caution: Changing a preference will
//affect the default behavior of JMP.

Preferences[1] << Set( Parallel Data Table Column Decompression( 0 ) );


```

### [Partial Selection Indicator](#partial-selection-indicator)

**Syntax:** obj \<< Partial Selection Indicator( "None"|"Bar"|"Pie"|"Waffle" )

**Description:** How a partial selection of a group is indicated.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Partial Selection Mode( "Bar" ) );


```

### [Platform Launch Actions](#platform-launch-actions)

**Syntax:** obj \<< Platform Launch Actions( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Platform Launch Actions( 1 ) );


```

### [Prefer DSN-less ODBC Connection Strings](#prefer-dsn-less-odbc-connection-strings)

**Syntax:** Preferences[1] \<< Name("Prefer DSN-less ODBC Connection Strings") ( state = 0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Name( "Prefer DSN-less ODBC Connection Strings" )(1);


```

### [Preserve SAS formats when exporting to SAS](#preserve-sas-formats-when-exporting-to-sas)

**Syntax:** obj \<< Preserve SAS formats when exporting to SAS( state=0|1 )

**Description:** Changes the default setting for preserving SAS formats when exporting to SAS.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Preserve SAS formats when exporting to SAS( 1 ) );


```

### [Preserve SAS variable names when exporting to SAS](#preserve-sas-variable-names-when-exporting-to-sas)

**Syntax:** obj \<< Preserve SAS variable names when exporting to SAS( state=0|1 )

**Description:** Changes the default setting for preserving SAS variable names when exporting to SAS.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Preserve SAS variable names when exporting to SAS( 1 ) );


```

### [Print Data Grid as is](#print-data-grid-as-is)

**Syntax:** obj \<< Print Data Grid as is( state=0|1 )

**Description:** Changes the default setting for printing the data grid as it appears on the screen.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Print Data Grid as is( 1 ) );


```

### [Prompt to save when closing summary tables](#prompt-to-save-when-closing-summary-tables)

**Syntax:** obj \<< Prompt to save when closing summary tables( state=0|1 )

**Description:** Prompt or no prompt when closing the summary table.

**JMP Version Added:** 14

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Close report action( "Prompt" ) );


```

### [Proxy Port](#proxy-port)

**Syntax:** obj \<< Proxy Port( number )

**Description:** Use the specified proxy port.

**JMP Version Added:** 15

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Proxy Port( 80 ) );


```

### [Proxy Server](#proxy-server)

**Syntax:** obj \<< Proxy Server( text )

**Description:** Use the specified proxy.

**JMP Version Added:** 15

```


//Caution: Changing a preference will 
//affect the default behavior of JMP.

url = "http:://myproxy.com:80";
Preferences[1] << Set( Proxy Server( url ) );


```

### [Proxy User](#proxy-user)

**Syntax:** obj \<< Proxy User( text )

**Description:** The user name and password to use for proxy authentication. \[user name\]:[password]

**JMP Version Added:** 15

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Proxy User( "clark%20kent:superman" ) );


```

### [Reopen the initial JMP window on last window close](#reopen-the-initial-jmp-window-on-last-window-close)

**Syntax:** obj \<< Reopen the initial JMP window on last window close( state=0|1 )

**Description:** Determines whether the initial JMP window is automatically reopened when the last JMP window is closed

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Reopen the initial JMP window on last window close( 1 ) );


```

### [Report Invalid Display Box Messages](#report-invalid-display-box-messages)

**Syntax:** obj \<< Report Invalid Display Box Messages( state=0|1 )

**Description:** Changes the default setting for outputting errors on invalid messages for display boxes.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Report Invalid Display Box Messages( 1 ) );


```

### [Report JSL warnings and errors interactively](#report-jsl-warnings-and-errors-interactively)

**Syntax:** obj \<< Report JSL warnings and errors interactively( state=0|1 )

**Description:** Warnings and errors from submitting JSL will be logged and shown interactively. When disabled, warnings and errors will only be logged

**JMP Version Added:** 15

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Report JSL warnings and errors interactively( 1 ) );


```

### [Report Recent Problems](#report-recent-problems)

**Syntax:** obj \<< Report Recent Problems( state=0|1 )

### [Report Snapshot On Close](#report-snapshot-on-close)

**Syntax:** obj \<< Report Snapshot On Close( state=0|1 )

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Report Snapshot On Close( 1 ) );


```

### [Row Editor Always Show All Columns](#row-editor-always-show-all-columns)

**Syntax:** obj \<< Row Editor Always Show All Columns( state=0|1 )

**Description:** If checked, the row editor will shows all the columns in the data table whether or not there are selected columns.

**JMP Version Added:** 16

### [Ruler Tool Units](#ruler-tool-units)

**Syntax:** obj \<< Ruler Tool Units( "Kilometers"|"Miles" )

**Description:** Changes the units shown by the graph tools ruler when used on a map in Graph Builder.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Ruler Tool Units( "Miles" ) );


```

### [SAS Automatically Generate ODS results](#sas-automatically-generate-ods-results)

**Syntax:** obj \<< SAS Automatically Generate ODS results( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "SAS Automatically Generate ODS results"n( 1 ) );


```

### [SAS Connect to CAS with SAS Viya](#sas-connect-to-cas-with-sas-viya)

**Syntax:** obj \<< SAS Connect to CAS with SAS Viya( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "SAS Connect to CAS with SAS Viya"n( 1 ) );


```

### [SAS Data Import Close Warning](#sas-data-import-close-warning)

**Syntax:** obj \<< SAS Data Import Close Warning( state=0|1 )

**JMP Version Added:** 19

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "SAS Data Import Close Warning"n( 0 ) );


```

### [SAS Data Import Uses Labels](#sas-data-import-uses-labels)

**Syntax:** obj \<< SAS Data Import Uses Labels( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "SAS Data Import Uses Labels"n( 1 ) );


```

### [SAS Import generated datasets into JMP](#sas-import-generated-datasets-into-jmp)

**Syntax:** obj \<< SAS Import generated datasets into JMP( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "SAS Import generated datasets into JMP"n( 1 ) );


```

### [SAS ODS Results Format](#sas-ods-results-format)

**Syntax:** obj \<< SAS ODS Results Format( "HTML"|"TEXT" )

### [SAS ODS Style](#sas-ods-style)

**Syntax:** obj \<< SAS ODS Style( text=Statistical )

**Description:** "Statistical" by default.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "SAS ODS Style"n( "HTMLBlue" ) );


```

### [SAS Organize results in JMP project](#sas-organize-results-in-jmp-project)

**Syntax:** obj \<< SAS Organize results in JMP project( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "SAS Organize results in JMP project"n( 1 ) );


```

### [SAS Transport Use UTF8](#sas-transport-use-utf8)

**Syntax:** obj \<< SAS Transport Use UTF8( state=0|1 )

**Description:** Change the default character encoding for Transport files to UTF-8

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( SAS Transport Use UTF8( 1 ) );


```

### [SPSSMultiResponseDelimiter](#spssmultiresponsedelimiter)

**Syntax:** obj \<< SPSSMultiResponseDelimiter( text=| )

**Description:** "|" by default.

**JMP Version Added:** 16

### [Save Data Table Columns GZ Compressed](#save-data-table-columns-gz-compressed)

**Syntax:** obj \<< Save Data Table Columns GZ Compressed( state=0|1 )

**Description:** Changes the default setting for saving data tables in a GZip compressed format.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Save Data Table Columns GZ Compressed( 1 ) );


```

### [Save Image DPI](#save-image-dpi)

**Syntax:** obj \<< Save Image DPI( number )

**Description:** Specifies a DPI setting to use when saving images, otherwise a default value is used.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Save Image DPI( 300 ) );


```

### [Save Journals GZ Compressed](#save-journals-gz-compressed)

**Syntax:** obj \<< Save Journals GZ Compressed( state=0|1 )

**Description:** Changes the default setting for saving journals in a GZip compressed format.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Save Journals GZ Compressed( 1 ) );


```

### [Save Scripts in English](#save-scripts-in-english)

**Syntax:** obj \<< Save Scripts in English( state=0|1 )

**Description:** Changes the default setting for saving scripts in English rather than in the language displayed.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Save Scripts in English( 1 ) );


```

### [Save Text Files as Unicode](#save-text-files-as-unicode)

**Syntax:** obj \<< Save Text Files as Unicode( state=0|1 )

**Description:** Changes the default setting for saving text files in Unicode format.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Save Text Files as Unicode( 1 ) );


```

### [Save table with report](#save-table-with-report)

**Syntax:** obj \<< Save table with report( "Embed"|"Separate"|"Prompt" )

**Description:** Changes how data is stored with saved reports

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Save table with report( prompt | embed | separate ) );


```

### [Save the session when exiting](#save-the-session-when-exiting)

**Syntax:** obj \<< Save the session when exiting( "Always"|"Never"|"Prompt" )

**Description:** Changes the default setting for saving the session on exiting JMP.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Save table with report( "Prompt" ) );


```

### [Selected Marker Color](#selected-marker-color)

**Syntax:** obj \<< Selected Marker Color( color )

**Description:** Changes the color of selected markers when using Selected Same Color in Markers Selection Mode

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Selected Marker Color( "Cyan" ) );


```

### [Semantic formatting](#semantic-formatting)

**Syntax:** obj \<< Semantic formatting

**Description:** Creates a semantic format that is used when its criteria matches the current report context.

**JMP Version Added:** 17

**Example 1**

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );

Preferences(
    Semantic formatting(
        Add Semantic Format(
            Format Name( "My Format 1" ),
            Semantic Format( Format( "Fixed Dec", 11, 1 ) ),
            Criteria(
                Object Name( "*mean*" ),
                Outline Path( "** :: Means for Oneway Anova" )
            )
        ),
        Add Semantic Format(
            Format Name( "My Format 2" ),
            Semantic Format( Format( "Fixed Dec", 11, 2 ) ),
            Criteria(
                Object Name( "*mean*" ),
                Outline Path( "** :: Means for Oneway Anova" ),
                Row Name( "M" )
            )
        )
    )
);


```

**Example 2**

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Semantic formatting( Clear ) );


```

### [Sequential Color Theme](#sequential-color-theme)

**Syntax:** obj \<< Sequential Color Theme( "name" )

**Description:** Changes the default setting for the continuous color theme appearing in all graphs.

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Show( Get Preference( Continuous Color Theme ) );
Set Preference( Sequential Color Theme( "Green to Purple" ) );
Show( Get Preference( Sequential Color Theme ) );


```

### [Set](#set)

**Syntax:** obj \<< Set

**Description:** Sets a specified preference.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 
Preferences[1] << Set( Show the Tip of the Day at startup( 1 ) );


```

### [Set ODBC Primary Key as Link ID](#set-odbc-primary-key-as-link-id)

**Syntax:** Preferences[1] \<< Name("Set ODBC Primary Key as Link ID") ( state = 0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Name( "Set ODBC Primary Key as Link ID" )(1);


```

### [Shade Alternate Table Rows](#shade-alternate-table-rows)

**Syntax:** obj \<< Shade Alternate Table Rows( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Shade Alternate Table Rows( 1 ) );


```

### [Shade Table Cells](#shade-table-cells)

**Syntax:** obj \<< Shade Table Cells( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Shade Table Cells( 1 ) );


```

### [Shade Table Headings](#shade-table-headings)

**Syntax:** obj \<< Shade Table Headings( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Shade Table Headings( 1 ) );


```

### [Shape Boundary Color](#shape-boundary-color)

**Syntax:** obj \<< Shape Boundary Color( color )

**Description:** Changes the default setting for the color of shape boundaries drawn on all graphs, such as background maps.

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Shape Boundary Color( "Black" ) );


```

### [Show Alternate Column Name](#show-alternate-column-name)

**Syntax:** obj \<< Show Alternate Column Name( state=0|1 )

**Description:** Change default setting for showing alternate name in dialog and data table columns panel

### [Show Personalization at startup](#show-personalization-at-startup)

**Syntax:** obj \<< Show Personalization at startup( state=0|1 )

**Description:** Personalization Dialog will show the next time JMP starts.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Show Personalization at startup( 1 ) );


```

### [Show SAS Log](#show-sas-log)

**Syntax:** obj \<< Show SAS Log( "Never"|"Always"|"On Error" )

### [Show Search box on Columns Panel](#show-search-box-on-columns-panel)

**Syntax:** obj \<< Show Search box on Columns Panel( state=0|1 )

**Description:** Show the search edit box on the columns panel by default

**JMP Version Added:** 16

### [Show Status Bar](#show-status-bar)

**Syntax:** obj \<< Show Status Bar( state=0|1 )

**Description:** Changes the default setting for displaying the Status Bar.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Show Status Bar( 1 ) );


```

### [Show conditional formatting](#show-conditional-formatting)

**Syntax:** obj \<< Show conditional formatting( "Always"|"Screen only"|"Never" )

**Description:** Changes the default setting for displaying the conditional formatting in reports.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Show conditional formatting( "Always" ) );


```

### [Show menu tips](#show-menu-tips)

**Syntax:** obj \<< Show menu tips( state=0|1 )

**Description:** Changes the default setting for displaying the menu tips that appear when you hover the mouse over a red triangle menu item.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Show menu tips( 1 ) );


```

### [Show missing data bars or bins in summary graphs](#show-missing-data-bars-or-bins-in-summary-graphs)

**Syntax:** obj \<< Show missing data bars or bins in summary graphs( state=0|1 )

**Description:** Whether missing data bars or bins are initially displayed in summary graphs. Whatever the value here, they can be toggled for individual summary graphs by right-clicking on the summary graph and selecting "Missing values bar" or "Missing values bin".

**JMP Version Added:** 16

### [Show semantic formatting](#show-semantic-formatting)

**Syntax:** obj \<< Show semantic formatting( "Always"|"No Row Matching"|"Never" )

**Description:** Changes the default setting for using semantic formatting in reports. Possible values are: "Always", "No Row Matching", and "Never". Use "No Row Matching" to disable row-specific semantic formats.

**JMP Version Added:** 17

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Show semantic formatting( "Always" ) );


```

### [Show summary graphs below column names](#show-summary-graphs-below-column-names)

**Syntax:** obj \<< Show summary graphs below column names( state=0|1 )

**Description:** Whether the summary graphs are initially displayed in the data table between the column names and the data cells, if the number of rows is under some performance threshold (3 million rows). Whatever the initial state, the display can be toggled for an individual data table with the icon next to the column names.

**JMP Version Added:** 15

### [Show the Quick Start at startup](#show-the-quick-start-at-startup)

**Syntax:** obj \<< Show the Quick Start at startup( state=0|1 )

**Description:** Changes the default setting for displaying the Quick Start window.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Show the Quick Start at startup( 1 ) );


```

### [Summary Graph Continuous Color](#summary-graph-continuous-color)

**Syntax:** obj \<< Summary Graph Continuous Color( color )

**Description:** Set the color for continuous data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Continuous Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Continuous Highlight Color](#summary-graph-continuous-highlight-color)

**Syntax:** obj \<< Summary Graph Continuous Highlight Color( color )

**Description:** Set the highlight color for continuous data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Continuous Highlight Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Continuous Missing Color](#summary-graph-continuous-missing-color)

**Syntax:** obj \<< Summary Graph Continuous Missing Color( color )

**Description:** Set the color for missing continuous data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Continuous Missing Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Continuous Missing Highlight Color](#summary-graph-continuous-missing-highlight-color)

**Syntax:** obj \<< Summary Graph Continuous Missing Highlight Color( color )

**Description:** Set the highlight color for missing continuous data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Continuous Missing Highlight Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Name Ordered Color](#summary-graph-name-ordered-color)

**Syntax:** obj \<< Summary Graph Name Ordered Color( color )

**Description:** Set the color for name-ordered data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Name Ordered Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Name Ordered Highlight Color](#summary-graph-name-ordered-highlight-color)

**Syntax:** obj \<< Summary Graph Name Ordered Highlight Color( color )

**Description:** Set the highlight color for name-ordered data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Name Ordered Highlight Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Other Color](#summary-graph-other-color)

**Syntax:** obj \<< Summary Graph Other Color( color )

**Description:** Set the color for the other bar in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Other Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Other Highlight Color](#summary-graph-other-highlight-color)

**Syntax:** obj \<< Summary Graph Other Highlight Color( color )

**Description:** Set the highlight color for the other bar in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Other Highlight Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Run Chart Color](#summary-graph-run-chart-color)

**Syntax:** obj \<< Summary Graph Run Chart Color( color )

**Description:** Set the color for the other bar in summary graphs and data filters

**JMP Version Added:** 18

```

//Caution: Changing a preference will
//affect the default behavior of JMP.

Preferences( Summary Graph Run Chart Color( RGB Color( 0.5, 0.1, 0.9 ) ) );


```

### [Summary Graph Size Ordered Color](#summary-graph-size-ordered-color)

**Syntax:** obj \<< Summary Graph Size Ordered Color( color )

**Description:** Set the color for size-ordered data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Size Ordered Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Summary Graph Size Ordered Highlight Color](#summary-graph-size-ordered-highlight-color)

**Syntax:** obj \<< Summary Graph Size Ordered Highlight Color( color )

**Description:** Set the highlight color for size-ordered data in summary graphs and data filters

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Summary Graph Size Ordered Highlight Color( RGB Color( 0.5, 0.9, 0.9 ) ) );


```

### [Suppress Formula Eval on Open](#suppress-formula-eval-on-open)

**Syntax:** obj \<< Suppress Formula Eval on Open( state=0|1 )

**Description:** Changes the default setting for suppressing formula evaluations when opening a data table.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Suppress Formula Eval on Open( 1 ) );


```

### [Table Column Borders](#table-column-borders)

**Syntax:** obj \<< Table Column Borders( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Table Column Borders( 1 ) );


```

### [Table Column Group Borders](#table-column-group-borders)

**Syntax:** obj \<< Table Column Group Borders( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Table Column Group Borders( 1 ) );


```

### [Table Heading Column Borders](#table-heading-column-borders)

**Syntax:** obj \<< Table Heading Column Borders( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Table Heading Column Borders( 1 ) );


```

### [Table Row Borders](#table-row-borders)

**Syntax:** obj \<< Table Row Borders( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Table Row Borders( 1 ) );


```

### [Task Bar Strategy](#task-bar-strategy)

**Syntax:** obj \<< Task Bar Strategy( "All windows"|"Main window only"|"Main and data tables" )

**Description:** Determines which JMP windows are displayed on the Windows task bar

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Task Bar Strategy( "All Windows" ) );


```

### [Transparent background for report PNG images](#transparent-background-for-report-png-images)

**Syntax:** obj \<< Transparent background for report PNG images( state=0|1 )

**Description:** When reports or portions of reports are saved as PNG images, the background will be transparent.

**JMP Version Added:** 14

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Transparent background for report PNG images( 1 ) );


```

### [Underline Table Headings](#underline-table-headings)

**Syntax:** obj \<< Underline Table Headings( state=0|1 )

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Underline Table Headings( 1 ) );


```

### [Use Excel Labels as Headings](#use-excel-labels-as-headings)

**Syntax:** obj \<< Use Excel Labels as Headings( "Use best guess"|"Always"|"Never" )

**Description:** Changes the default setting for importing Excel labels as JMP Column names when opening Excel files.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use Excel Labels as Headings( "Always" ) );


```

### [Use Greek letters](#use-greek-letters)

**Syntax:** obj \<< Use Greek letters( state=0|1 )

**Description:** Changes the default setting for enabling Greek letters in JMP reports.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use Greek letters( 1 ) );


```

### [Use JMP Locale Settings](#use-jmp-locale-settings)

**Syntax:** obj \<< Use JMP Locale Settings( state=0|1 )

**Description:** Changes the default behavior for displaying number, date and currency formats. Note: This is available on Windows only.

```

//Caution: Changing a preference will affect 
//the default behavior of JMP. 

Preferences[1] << Set( Use JMP Locale Settings( 1 ) );


```

### [Use Numerical Ordering](#use-numerical-ordering)

**Syntax:** obj \<< Use Numerical Ordering( state=0|1 )

**Description:** Configure column sorting for new columns so that text containing numbers is sorted in numerical order. Columns converted to character type will also be affected if they don't already contain a Value Order property.

**JMP Version Added:** 16

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences( Use Numerical Ordering( 0 ) );


```

### [Use Project Log](#use-project-log)

**Syntax:** obj \<< Use Project Log( "Always"|"If Open"|"Never" )

**Description:** Whether to send log messages generated by scripts and windows in a project to the project log window (instead of the main log window)

**JMP Version Added:** 16

### [Use SPSS labels for column names during import](#use-spss-labels-for-column-names-during-import)

**Syntax:** obj \<< Use SPSS labels for column names during import( state=0|1 )

**Description:** Changes the default setting for importing SPSS labels as JMP Column names when opening SPSS files.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use SPSS labels for column names during import( 1 ) );


```

### [Use Thousands Separator](#use-thousands-separator)

**Syntax:** obj \<< Use Thousands Separator( state=0|1 )

**Description:** Changes the default setting for using the thousands separator in numeric output.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use Thousands Separator( 1 ) );


```

### [Use Triple-S Labels as Headings](#use-triple-s-labels-as-headings)

**Syntax:** obj \<< Use Triple-S Labels as Headings( state=0|1 )

**Description:** Changes the default setting for use of labels as column names for Triple-S variables

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( "Use Triple-S Labels as Headings"n( 1 ) );


```

### [Use a Floating Window for Data Filters](#use-a-floating-window-for-data-filters)

**Syntax:** obj \<< Use a Floating Window for Data Filters( state=0|1 )

**Description:** When set, data filters use a window that floats above their data tables and associated windows. Otherwise, data filters use a window that can be arranged with other windows normally.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use a Floating Window for Data Filters( 1 ) );


```

### [Use an Asterisk with the PValue Format](#use-an-asterisk-with-the-pvalue-format)

**Syntax:** obj \<< Use an Asterisk with the PValue Format( state=0|1 )

**Description:** PValue format will append an asterisk in numeric columns

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use an Asterisk with the PValue Format( 1 ) );


```

### [Use column references in Dispatch](#use-column-references-in-dispatch)

**Syntax:** obj \<< Use column references in Dispatch( state=0|1 )

**Description:** When saving report customizations, use column references instead of strings when referring to customized elements. This generates scripts that are more robust against column name changes. Note that customizations that are saved using this preference might work only in JMP 18.0 and newer.

**JMP Version Added:** 18

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use column references in Dispatch( 1 ) );


```

### [Use math symbols](#use-math-symbols)

**Syntax:** obj \<< Use math symbols( state=0|1 )

**Description:** Changes the default setting for enabling math symbols in JMP reports.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Preferences[1] << Set( Use math symbols( 1 ) );


```

### [Virtual Join Auto Open Linked Table](#virtual-join-auto-open-linked-table)

**Syntax:** obj \<< Virtual Join Auto Open Linked Table( state=0|1 )

**Description:** Automatically open the data table that this column references.

**JMP Version Added:** 16

### [Virtual Join Use Linked Column Name](#virtual-join-use-linked-column-name)

**Syntax:** obj \<< Virtual Join Use Linked Column Name( state=0|1 )

**Description:** Name the virtual column with the linked column's name.

**JMP Version Added:** 16

### [Warn that compact columns cannot be opened in JMP 17 and earlier](#warn-that-compact-columns-cannot-be-opened-in-jmp-17-and-earlier)

**Syntax:** obj \<< Warn that compact columns cannot be opened in JMP 17 and earlier( state=0|1 )

**Description:** The compact file format cannot be opened in JMP 17 and earlier.

**JMP Version Added:** 18

### [Warn when referenced table name has changed](#warn-when-referenced-table-name-has-changed)

**Syntax:** obj \<< Warn when referenced table name has changed( state=0|1 )

**Description:** Give a warning message when a virtually linked (referenced) table's name has changed.

**JMP Version Added:** 15

## [Platform Preferences](#platform-preferences)

### [Item Messages](#item-messages_1)

#### [Get](#get_1)

**Syntax:** obj \<< Get

**Description:** Returns the script for setting a specified preference.

```

a = Platform Preferences[1] << Get( Distribution );
Show( a );


```

#### [Get Script](#get-script_1)

**Syntax:** obj \<< Get Script

**Description:** Returns the script for setting the preferences.

```

a = Platform Preferences[1] << Get Script;
Show( a );


```

#### [Set](#set_1)

**Syntax:** obj \<< Set

**Description:** Sets a specified preference.

```

//Caution: Changing a preference will 
//affect the default behavior of JMP. 

Platform Preferences[1] << Set( Distribution( Vertical( 1 ) ) );


```

# [Principal Components](#principal-components)

## [Associated Constructors](#associated-constructors)

### [Principal Components](#principal-components_1)

**Syntax:** Principal Components( Y( columns ) )

**Description:** Models the variation in a set of variables in terms of a smaller number of independent linear combinations (principal components) of those variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Principal Components(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Principal Components(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Freq( :_freqcol )
);


```

### [Supplementary Variable](#supplementary-variable)

**Syntax:** obj \<< Supplementary Variable( column(s) )

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Z( :Species ),
    Standardize( "Standardized" )
);


```

### [Weight](#weight)

**Syntax:** obj = Principal Components(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Weight( :_weightcol )
);


```

### [Y](#y)

**Syntax:** obj = Principal Components(...\<Y( column(s) )>...)

**Description:** Specifies the variables to analyze for components.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane )
);


```

### [Z](#z)

**Syntax:** obj \<< Z( column(s) )

**Description:** Specifies one or more supplementary variables. Supplementary variables are not used in any of the calculations in the platform and including them does not affect the results. These variables can improve data interpretation or be used in future analyses.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Z( :Species ),
    Standardize( "Standardized" )
);


```

## [Item Messages](#item-messages)

### [3D Score Plot](#3d-score-plot)

**Syntax:** obj \<< 3D Score Plot( state=0|1 )

**Description:** Shows or hides a 3-D scatterplot of the principal components as rays in a three-dimensional space.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << "3D Score Plot"n( 1 );


```

### [Arrow Lines](#arrow-lines)

**Syntax:** obj \<< Arrow Lines( state=0|1 )

**Description:** Shows or hides the arrow lines in the graph.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Arrow Lines( 0 );


```

### [Bartlett Test](#bartlett-test)

**Syntax:** obj \<< Bartlett Test( state=0|1 )

**Description:** Shows or hides a report of the results of the homogeneity test for each of the principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Bartlett Test( 1 );


```

### [Biplot](#biplot)

**Syntax:** obj \<< Biplot( number )

**Description:** Shows or hides a plot that overlays the score plot and the loading plot for the specified number of components.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Biplot( 2 );


```

### [Cluster Components](#cluster-components)

**Syntax:** obj \<< Cluster Components( state=0|1 )

**Description:** Shows or hides the Standardized Components report, which contains the eigenvectors of the first principal component within each cluster. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Correlations" );
obj << Cluster Variables( Cluster Components( 1 ) );


```

### [Cluster Members](#cluster-members)

**Syntax:** obj \<< Cluster Members( state=0|1 )

**Description:** Shows or hides a report of the variables in each cluster. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Correlations" );
obj << Cluster Variables( Cluster Members( 1 ) );


```

### [Cluster Summary](#cluster-summary)

**Syntax:** obj \<< Cluster Summary( state=0|1 )

**Description:** Shows or hides a report that summarizes the results of variable clustering. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Correlations" );
obj << Cluster Variables( Cluster Summary( 1 ) );


```

### [Cluster Variables](#cluster-variables)

**Syntax:** obj \<< Cluster Variables( state=0|1 )

**Description:** Clusters variables into similar groups.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Cluster Variables( 1 );


```

### [Color Map on Correlations](#color-map-on-correlations)

**Syntax:** obj \<< Color Map on Correlations( state=0|1 )

**Description:** Shows or hides a color map of the correlations between variables, where the variables are arranged so that members of the same cluster are adjacent in the plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Correlations" );
obj << Cluster Variables( Color Map On Correlations( 1 ) );


```

### [Coordinate Matrix](#coordinate-matrix)

**Syntax:** obj \<< Coordinate Matrix( state=0|1 )

**Description:** Shows or hides a table that contains the component coordinates. This option is available only when there is a categorical variable in the analysis.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width, :Species ),
    Standardize( "Standardized" )
);
obj << Coordinate  Matrix( 1 );


```

### [Correlations](#correlations)

**Syntax:** obj \<< Correlations( state=0|1 )

**Description:** Shows or hides a matrix of correlation coefficients that summarize the strength of the linear relationships between each pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Correlations( 1 );


```

### [Covariance Matrix](#covariance-matrix)

**Syntax:** obj \<< Covariance Matrix( state=0|1 )

**Description:** Shows or hides a matrix of covariances for each pair of Y variables.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Covariance Matrix( 1 );


```

### [Eigenvalues](#eigenvalues)

**Syntax:** obj \<< Eigenvalues( state=0|1 )

**Description:** Shows or hides the sorted eigenvalues, their percent of variation, and the cumulative percent of variation.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Eigenvalues( 1 );


```

### [Eigenvectors](#eigenvectors)

**Syntax:** obj \<< Eigenvectors( state=0|1 )

**Description:** Shows or hides a report of the eigenvectors for each of the principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Eigenvectors( 1 );


```

### [Estimation Method](#estimation-method)

**Syntax:** Estimation Method( REML | ML | Robust | Row-wise | Pairwise | Full SVD | Truncated SVD | Randomized SVD | Robust SVD | Sparse SVD)

**Description:** Sets the estimation method for computing the correlations.

If there are no missing values, then the default is Row-wise.

If there are missing values, and the number of variables \<= 10 and the number of rows \<=5000, then the default is REML.

If there are missing values, and the number of variables > 10 or number of rows > 5000, then the default is Pairwise. "Default" by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" ),
    Estimation Method( "REML" )
);


```

### [Factor Analysis](#factor-analysis)

**Syntax:** obj \<< Factor Analysis( ML|PC, ONE|SMC, n Rotated, Varimax| Biquartimax| Equamax| Factorparsimax| Orthomax| Parsimax| Quartimax| Biquartimin| Covarimin| Obbiquartimax| Obequamax| Obfactorparsimax| Obequamax| Obfactorparsimax| Oblimin| Obparsimax| Obquartimax| Obvarimax| Quartimin| UnRotated| Promax )

**Description:** Shows or hides a report of the factor rotation pattern for the principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Factor Analysis( "ML", "SMC", 2, "Varimax" );


```

### [Formatted Loading Matrix](#formatted-loading-matrix)

**Syntax:** obj \<< Formatted Loading Matrix( state=0|1 )

**Description:** Shows or hides a report that contains the formatted component loadings.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Formatted Loading Matrix( 1 );


```

### [Impute Missing Data](#impute-missing-data)

**Syntax:** obj \<< Impute Missing Data

**Description:** Imputes missing values for all the Y variables and creates a new data table containing both the existing values and newly imputed missing data values.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Impute Missing Data( 1 );


```

### [Launch Fit Model](#launch-fit-model)

**Syntax:** obj \<< Launch Fit Model

**Description:** Launches Fit Model with the Most Representative variables as predictors. Select Save Cluster Components first if you want to use these as predictors.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Correlations" );
obj << Cluster Variables( Launch Fit Model );


```

### [Loading Matrix](#loading-matrix)

**Syntax:** obj \<< Loading Matrix( number )

**Description:** Show or hides a table that contains the component loadings.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Loading Matrix( 1 );


```

### [Loading Plot](#loading-plot)

**Syntax:** obj \<< Loading Plot( number )

**Description:** Shows or hides a matrix of plots that are two-dimensional representations of factor loadings.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Loading Plot( 2 );


```

### [Missing value imputation](#missing-value-imputation)

**Syntax:** obj = Principal Components(...Missing value imputation( state=0|1 )...)

**Description:** Imputes missing values through matrix completion. This option is applicable to wide methods. On by default.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10, :Lead ),
    Estimation Method( "Truncated SVD" ),
    Number of Components( 6 ),
    Missing value imputation( 0 ),
    Standardize( "Standardized" )
);


```

### [Model Driven Multivariate Control Chart](#model-driven-multivariate-control-chart)

**Syntax:** obj \<< Model Driven Multivariate Control Chart

**Description:** Launches Model Driven Multivariate Control Chart for specified number of Components

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Model Driven Multivariate Control Chart( 2 );


```

### [Number of Components](#number-of-components)

**Syntax:** obj = Principal Components(...Number of Components( number=10 )...)

**Description:** Sets the number of components to be extracted. To reduce computation time, enter a small number of components. "10" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Estimation Method( "Sparse" ),
    Number of Components( 3 ),
    Standardize( "Standardized" )
);


```

### [Outlier Analysis](#outlier-analysis)

**Syntax:** obj \<< Outlier Analysis( state=0|1 )

**Description:** Shows or hides the Outlier Analysis report, which enables you to detect outliers in the data through T² and contribution statistics.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Estimation Method( "Default" ),
    Standardize( "Standardized" ),
    Outlier Analysis( 1 )
);


```

### [Partial Contribution of Variables](#partial-contribution-of-variables)

**Syntax:** obj \<< Partial Contribution of Variables( number )

**Description:** Shows or hides a table that contains the partial contributions of variables and a plot of the partial contributions for the first three principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Partial Contribution of Variables(
    Plot of Partial Contribution of Variables( Overview( 3 ), "Side by side" )
);


```

### [Profiler for Predicteds](#profiler-for-predicteds)

**Syntax:** obj \<< Profiler for Predicteds

**Description:** Launches a profiler for the predictions using the specified number of components.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Profiler for Predicteds( 2 );


```

### [Publish Components Formulas](#publish-components-formulas)

**Syntax:** obj \<< Publish Components Formulas( number )

**Description:** Creates a specified number of principal component formulas and saves them as formula column scripts in the Formula Depot platform. If a Formula Depot report is not open, this option creates a Formula Depot report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Estimation Method( "Wide" )
);
obj << Publish Components Formulas( 3 );


```

### [Publish Normalized DModX Formula](#publish-normalized-dmodx-formula)

**Syntax:** obj \<< Publish Normalized DModX Formula( number )

**Description:** Saves the normalized DModX formula based on a specified number of principal components as a formula column script in the Formula Depot platform. If a Formula Depot report is not open, this option creates a Formula Depot report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Publish Normalized DModX Formula( 3 );


```

### [Save Cluster Components](#save-cluster-components)

**Syntax:** obj \<< Save Cluster Components

**Description:** Saves the cluster (first principal) component for each cluster to the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Correlations" );
obj << Cluster Variables( Save Cluster Components );


```

### [Save Imputed Formula](#save-imputed-formula)

**Syntax:** obj \<< Save Imputed Formula

**Description:** Imputes values where the Y column values are missing. Creates and saves a new column with an imputation formula to the original data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ) );
obj << Save Imputed Formula( 1 );


```

### [Save Individual Partial Contributions](#save-individual-partial-contributions)

**Syntax:** obj \<< Save Individual Partial Contributions( number )

**Description:** Saves individual partial contributions to new columns in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Covariances" );
obj << Save Individual Partial Contributions( 3 );


```

### [Save Individual Squared Cosines](#save-individual-squared-cosines)

**Syntax:** obj \<< Save Individual Squared Cosines( number )

**Description:** Saves individual squared cosines to new columns in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Covariances" );
obj << Save Individual Squared Cosines( 3 );


```

### [Save Low Rank Principal Components](#save-low-rank-principal-components)

**Syntax:** obj \<< Save Low Rank Principal Components( number )

**Description:** Saves the principal component scores from the low-rank data, cleaned of outliers and noise. This option applies only to the Robust PCA estimation method.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" ),
    Estimation Method( "Robust PCA" ),
    Number of Components( 3 )
);
obj << Save Low Rank Principal Components( 3 );


```

### [Save Normalized DModX](#save-normalized-dmodx)

**Syntax:** obj \<< Save Normalized DModX( number )

**Description:** Saves the normalized DModX values to a new column in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Covariances" );
obj << Save Normalized DMODX( 3 );


```

### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds( number )

**Description:** Saves the predicted variables with a specified number of principal components to new columns in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components( Y( :OZONE, :CO, :SO2, :NO, :PM10 ), "on Covariances" );
obj << Save Predicteds( 3 );


```

### [Save Predicteds as Component Formulas](#save-predicteds-as-component-formulas)

**Syntax:** obj \<< Save Predicteds as Component Formulas

**Description:** Saves the component formulas for a specified number of principal components to new columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Save Predicteds As Component Formulas( 3 );


```

### [Save Principal Component Script](#save-principal-component-script)

**Syntax:** obj \<< Save Principal Component Script( number )

**Description:** Saves a script to the script window that when run will create new columns in the data table for the given number of principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << save principal Component script( 3 );


```

### [Save Principal Component Values](#save-principal-component-values)

**Syntax:** obj \<< Save Principal Component Values( number )

**Description:** Saves the given number of principal components to new non-formula columns in the data table, including from imputed cells.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Save Principal Component Values( 3 );


```

### [Save Principal Components](#save-principal-components)

**Syntax:** obj \<< Save Principal Components( number )

**Description:** Saves the given number of principal components to new formula columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Save Principal Components( 3 );


```

### [Save Principal Components with Imputation](#save-principal-components-with-imputation)

**Syntax:** obj \<< Save Principal Components with Imputation( number )

**Description:** Saves the given number of principal components computed using imputation on missing values to new columns in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Save Principal Components with Imputation( 3 );


```

### [Save Rotated Components](#save-rotated-components)

**Syntax:** obj \<< Save Rotated Components

**Description:** Saves the rotated components to new columns in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" ),
    Factor Analysis( "SMC", 2, "Varimax" )
);
obj << Save Rotated Components;


```

### [Save Rotated Components with Imputation](#save-rotated-components-with-imputation)

**Syntax:** obj \<< Save Rotated Components with Imputation

**Description:** Saves the rotated components computed using imputation on missing values to new columns in the data table. Note: This option is only available after the Factor Rotation has been run.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" ),
    Factor Analysis( "SMC", 2, "Varimax" )
);
obj << Save Rotated Components with Imputation;


```

### [Scatterplot Matrix](#scatterplot-matrix)

**Syntax:** obj \<< Scatterplot Matrix( number )

**Description:** Shows or hides a matrix of score and loading plots for a specified number of principal components.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Scatterplot Matrix( 4 );


```

### [Score Ellipse Coverage](#score-ellipse-coverage)

**Syntax:** obj \<< Score Ellipse Coverage( "0.90"|"0.95"|"0.99"|"1-sigma"|"2-sigma"|"3-sigma"|"Other…" )

**Description:** Changes the alpha level for the confidence ellipses on the score plot for each pair of principal components.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Score Ellipse Coverage( 0.9 );


```

### [Score Ellipses](#score-ellipses)

**Syntax:** obj \<< Score Ellipses( state=0|1 )

**Description:** Shows or hides confidence ellipses on the score plot for each pair of principal components.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Score Ellipses( 1 );


```

### [Score Plot](#score-plot)

**Syntax:** obj \<< Score Plot( number )

**Description:** Shows or hides a matrix of scatterplots that contain the scores for each pair of the specified number of principal components.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Score Plot( 2 );


```

### [Score Plot with Imputation](#score-plot-with-imputation)

**Syntax:** obj \<< Score Plot with Imputation( number of principal components )

**Description:** Shows or hides a matrix of scatterplots that contain the scores for each pair of the specified number of principal components, using imputation for missing values.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Score Plot with Imputation( 2 );


```

### [Scree Plot](#scree-plot)

**Syntax:** obj \<< Scree Plot( state=0|1 )

**Description:** Shows or hides a line plot of the eigenvalues for each component.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Scree Plot( 1 );


```

### [Select component](#select-component)

**Syntax:** obj \<< Select component( <specify dimension to plot> )

**Description:** Selects the dimensions that are used as axes in the summary plots.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Standardize( "Standardized" )
);
obj << Select Component( 1, 3 );


```

### [Show Supplementary Variable](#show-supplementary-variable)

**Syntax:** obj \<< Show Supplementary Variable( state=0|1 )

**Description:** Shows or hides the arrow lines for supplementary variables in the graph.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Z( :Species ),
    Standardize( "Standardized" )
);
obj << Show Supplementary Variable( 0 );


```

### [Squared Cosines of Variables](#squared-cosines-of-variables)

**Syntax:** obj \<< Squared Cosines of Variables( number )

**Description:** Shows or hides a table that contains the squared cosines of variables.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Principal Components(
    Y( :OZONE, :CO, :SO2, :NO, :PM10 ),
    Standardize( "Standardized" )
);
obj << Squared Cosines of Variables(
    Plot of Squared Cosines of Variables( Overview( 3 ), "Stacked", "Horizontal" )
);


```

### [Standardize](#standardize)

**Syntax:** obj = Principal Components(...Standardize( "Standardized"|"Unscaled"|"Unscaled and Uncentered" )...)

**Description:** Specifies whether each column should be standardized individually.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Principal Components(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Estimation Method( "Row-wise" ),
    Standardize( "Standardized" )
);


```

### [Summary Plots](#summary-plots)

**Syntax:** obj \<< Summary Plots( state=0|1 )

**Description:** Shows or hides an outline node that contains a plot of the eigenvalues, a score plot, and a loading plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);
obj << Summary Plots( 1 );


```

### [on Correlations](#on-correlations)

**Syntax:** Principal Components( Y( columns ), On Correlations )

**Description:** Creates a principal components report using the correlation matrix.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Standardize( "Standardized" )
);


```

### [on Covariances](#on-covariances)

**Syntax:** Principal Components( Y( columns ), On Covariances )

**Description:** Creates a principal components report using the covariance matrix.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    "on Covariances"
);


```

### [on Unscaled](#on-unscaled)

**Syntax:** Principal Components( Y( column ), On Unscaled )

**Description:** Creates a principal components report using the unscaled data.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = dt << Principal Components(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    "on Unscaled"
);


```

# [Process Capability](#process-capability)

## [Associated Constructors](#associated-constructors)

### [Process Capability](#process-capability_1)

**Syntax:** Process Capability( Process Variables (columns), < Spec Limits() > )

**Description:** Computes a process capability analysis for each process and creates graphs useful for analyzing the capability of multiple processes at one time. Specification limits can also be defined.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Process Capability(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Grouping](#grouping)

**Syntax:** obj = Process Capability( Process Variables( columns), Grouping( columns) )

**Description:** Specifies columns as grouping variables.

**Example 1**

```


dtLimits = Open( "$SAMPLE_DATA/Cheese Manufacturing Limits.jmp" );
dt = Open( "$SAMPLE_DATA/Cheese Manufacturing Data.jmp" );
dt << Process Capability(
    Process Variables( :pH, :Salt Concentration, :Moisture Content ),
    Grouping( :Cheese Type ),
    Spec Limits( Use Limits Table( dtLimits ) ),
    Moving Range Method( Average of Moving Ranges ),
    Goal Plot( 1 ),
    Capability Index Plot( 1 ),
    Process Performance Plot( 0 )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables( :NPN1[:lot_id], :PNP1[:lot_id], :PNP2[:lot_id] ),
    Grouping( :site )
);


```

### [Process Variables](#process-variables)

**Syntax:** obj = Process Capability(...Process Variables( column(s) )...)

**Description:** Specifies the columns of process data that contain the measurements to be analyzed.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);


```

## [Item Messages](#item-messages)

### [AIAG (Ppk) Labeling](#aiag-ppk-labeling)

**Syntax:** obj \<< "AIAG (Ppk) Labeling"n( state=0|1 )

**Description:** Turns on or off the AIAG labeling of the capability indices by changing the "Cp" labeling to "Pp" labeling. On by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables( :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer] )
);
obj << Individual Detail Reports( 1 );
Wait( 1 );
obj << "AIAG (Ppk) Labeling"n( 0 );


```

### [Capability Box Plots](#capability-box-plots)

**Syntax:** obj \<< Capability Box Plots( state=0|1 )

**Description:** Shows or hides a box plot for each process. To create the box plots, the values for each process are centered by their target and scaled by their specification limits. On by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 )
);
Wait( 1 );
obj << Capability Box Plots( 1 );


```

### [Capability Index Plot](#capability-index-plot)

**Syntax:** obj \<< Capability Index Plot( state=0|1, <plot options> )

**Description:** Shows or hides a graph that plots the overall Ppk for each process. On by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :Process 1 & Dist( Lognormal ), :Process 2 & Dist( Lognormal ),
        :Process 3 & Dist( Weibull ), :Process 4 & Dist( Lognormal ),
        :Process 5 & Dist( Weibull ), :Process 6 & Dist( Johnson ), :Process 7
    ),
    Capability Index Plot( 0 ),
    Goal Plot( 0 )
);
Wait( 1 );
obj << Capability Index Plot( 1 );


```

### [Color Out of Spec Values](#color-out-of-spec-values)

**Syntax:** obj \<< Color Out of Spec Values( state=0|1 )

**Description:** Colors the cells in the data table for values that are out of spec. Cells with values below the lower specification limit (LSL) are colored red, and cells with values above the upper specification limit (USL) are colored blue.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Process Capability(
    Process Variables( :OZONE, :CO, :SO2, :NO ),
    Spec Limits( Import Spec Limits( "$SAMPLE_DATA/CitySpecLimits.jmp" ) )
);
obj << Color Out of Spec Values( 1 );


```

### [Get Limits](#get-limits)

**Syntax:** obj = Process Capability(...Spec Limits(Get Limits( data table ) )...)

**Description:** Loads specification limits from a limits data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt << Process Capability(
    Process Variables( :OZONE, :CO, :SO2, :NO ),
    Spec Limits( Get Limits( dt2 ) )
);


```

### [Goal Plot](#goal-plot)

**Syntax:** obj \<< Goal Plot( state=0|1, <plot options> )

**Description:** Shows or hides a graph with a point for each process. The spec-standardized mean is on the horizontal axis and the spec-standardized standard deviation is on the vertical axis. Points that appear above the goal arc represent processes that are below the specified Ppk (Cpk) threshold. On by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Goal Plot( 0 )
);
Wait( 1 );
obj << Goal Plot( 1 );


```

### [Individual Detail Reports](#individual-detail-reports)

**Syntax:** obj \<< Individual Detail Reports( state=0|1 )

**Description:** Shows or hides a separate individual detail capability report for each process.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Individual Detail Reports( 1 );


```

### [Individual Detail Reports Cutoff](#individual-detail-reports-cutoff)

**Syntax:** obj \<< Individual Detail Reports Cutoff( number=1 )

**Description:** Shows the Individual Detail Reports and hides the Goal Plot and Capability Box Plots if the number of process variables is less than or equal to the cutoff value. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Individual Detail Reports Cutoff( 7 );


```

### [Make Goal Plot Summary Table](#make-goal-plot-summary-table)

**Syntax:** obj \<< Make Goal Plot Summary Table

**Description:** Creates a new data table that contains the coordinates for both the within and overall points that are plotted in the Goal Plot.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Make Goal Plot Summary Table;


```

### [Order By](#order-by)

**Syntax:** obj \<< Order By( "Initial Order"|"Reverse Initial Order"|"Within Sigma Cpk Ascending"|"Within Sigma Cpk Descending"|"Overall Sigma Ppk Ascending"|"Overall Sigma Ppk Descending" )

**Description:** Reorders all box plots, summary reports, and individual detail reports into the specified order.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Within Sigma Summary Report( 1 );
Wait( 1 );
obj << Order By( "Within Sigma Cpk Ascending" );


```

### [Overall Sigma Normalized Box Plots](#overall-sigma-normalized-box-plots)

**Syntax:** obj \<< Overall Sigma Normalized Box Plots( state=0|1 )

**Description:** Shows or hides a box plot for each process. The values for the box plots are centered by the overall mean and scaled by the overall estimate of the standard deviation.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 0 );
obj << Overall Sigma Normalized Box Plots( 1 );


```

### [Overall Sigma Summary Report](#overall-sigma-summary-report)

**Syntax:** obj \<< Overall Sigma Summary Report( state=0|1 )

**Description:** Shows or hides a summary report of capability indices. The capability indices are calculated using the overall estimate of standard deviation.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 0 );
obj << Overall Sigma Summary Report( 1 );


```

### [Process Performance Plot](#process-performance-plot)

**Syntax:** obj \<< Process Performance Plot( state=0|1, <plot options> )

**Description:** Shows or hides a four-quadrant plot of Overall Capability Ppk versus stability.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Capability Index Plot( 0 ),

);
obj << Process Performance Plot( 1 );


```

### [Save Distributions as Column Properties](#save-distributions-as-column-properties)

**Syntax:** obj \<< Save Distributions as Column Properties

**Description:** Saves the distribution that is used to calculate capability as a Process Capability Distribution column property. A column property is saved for each process variable in the analysis.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Process Capability(
    Process Variables( :OZONE & Dist( Johnson ), :CO, :SO2 & Dist( Lognormal ), :NO ),
    Spec Limits( Import Spec Limits( "$SAMPLE_DATA/CitySpecLimits.jmp" ) )
);
obj << Save Distributions as Column Properties;


```

### [Save In Spec Indicator Formulas](#save-in-spec-indicator-formulas)

**Syntax:** obj \<< Save In Spec Indicator Formulas

**Description:** Creates a new formula column in the data table. The new column contains a value that indicates whether or not a row is within the specification limits.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Save In Spec Indicator Formulas;


```

### [Save Spec Limits as Column Properties](#save-spec-limits-as-column-properties)

**Syntax:** obj \<< Save Spec Limits as Column Properties

**Description:** Saves the specification limits to a column property for each process variable in the analysis.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Process Capability(
    Process Variables( :OZONE, :CO, :SO2, :NO ),
    Spec Limits( Import Spec Limits( "$SAMPLE_DATA/CitySpecLimits.jmp" ) )
);
obj << Save Spec Limits as Column Properties;


```

### [Save Spec Limits to New Table](#save-spec-limits-to-new-table)

**Syntax:** obj \<< Save Spec Limits to New Table

**Description:** Creates a new data table that contains the specification limits, process importance, and distributions for each process variable. The table is in a tall format and contains a row for each process variable. Process importance and distribution type are saved only when applicable.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Save Spec Limits to New Table;


```

### [Select Out of Spec Values](#select-out-of-spec-values)

**Syntax:** obj \<< Select Out of Spec Values( state=0|1 )

**Description:** Selects all rows and columns in the data table that contain at least one value that does not fall within the specification limits.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Process Capability(
    Process Variables( :OZONE, :CO, :SO2, :NO ),
    Spec Limits( Import Spec Limits( "$SAMPLE_DATA/CitySpecLimits.jmp" ) )
);
obj << Select Out of Spec Values( 1 );


```

### [Use Limits Table](#use-limits-table)

**Syntax:** obj = Process Capability(...Spec Limits(Use Limits Table( data table ) )...)

**Description:** Loads specification limits from a limits data table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt << Process Capability(
    Process Variables( :OZONE, :CO, :SO2, :NO ),
    Spec Limits( Use Limits Table( dt2 ) )
);


```

### [Within Sigma Normalized Box Plots](#within-sigma-normalized-box-plots)

**Syntax:** obj \<< Within Sigma Normalized Box Plots( state=0|1 )

**Description:** Shows or hides a graph that contains a box plot for each process. The values for the box plots are centered by the mean and divided by the within-subgroup estimate of the standard deviation.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 0 );
obj << Within Sigma Normalized Box Plots( 1 );


```

### [Within Sigma Summary Report](#within-sigma-summary-report)

**Syntax:** obj \<< Within Sigma Summary Report( state=0|1 )

**Description:** Shows or hides a summary report of capability indices. The capability indices are calculated using the within-subgroup estimate of standard deviation. Results are shown only for variables with specified normal distributions.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 0 );
obj << Within Sigma Summary Report( 1 );


```

### [Within or Between-and-Within Sigma Normalized Box Plots](#within-or-between-and-within-sigma-normalized-box-plots)

**Syntax:** obj \<< "Within or Between-and-Within Sigma Normalized Box Plots"n( state=0|1 )

**Description:** Shows or hides a graph that contains a box plot for each process. The values for the box plots are centered by the mean and divided by the within-group estimate of the standard deviation or, if specified, the between-and-within estimate.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 0 );
obj << "Within or Between-and-Within Sigma Normalized Box Plots"n( 1 );


```

### [Within or Between-and-Within Sigma Summary Report](#within-or-between-and-within-sigma-summary-report)

**Syntax:** obj \<< "Within or Between-and-Within Sigma Summary Report"n( state=0|1 )

**Description:** Shows or hides a summary report of capability indices. The capability indices are calculated using the within-group estimate of the standard deviation or, if specified, the between-and-within group estimate. This option is available only when the Calculate Between-and-Within Capability option is selected for at least one process in the launch window.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 0 );
obj << "Within or Between-and-Within Sigma Summary Report"n( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Relaunch Analysis;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Process Capability(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Process Capability Analysis > Process Capability Analysis Comparisons > Process Capability Probability Plots](#process-capability-analysis-process-capability-analysis-comparisons-process-capability-probability-plots)

### [Item Messages](#item-messages_1)

#### [Parametric Fit Confidence Limits Shading](#parametric-fit-confidence-limits-shading)

**Syntax:** scrobj \<< Parametric Fit Confidence Limits Shading( state=0|1 )

**Description:** Shows or hides the confidence limits shading for the parametric fit.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    Capability Box Plots( 1 ),
    Capability Index Plot( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis(
        Compare Distributions(
            1,
            <<Fit Lognormal,
            Probability Plots(
                1,
                Lognormal Probability Plot( Parametric Fit Confidence Limits Shading( 1 ) )
            )
        )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1(Lognormal) Probability Plot"] << get scriptable object);
scrobj << Parametric Fit Confidence Limits Shading( 0 );


```

#### [Parametric Fit Line](#parametric-fit-line)

**Syntax:** scrobj \<< Parametric Fit Line( state=0|1 )

**Description:** Shows or hides the line for the parametric fit. On by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    Capability Box Plots( 1 ),
    Capability Index Plot( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis(
        Compare Distributions(
            1,
            <<Fit Lognormal,
            Probability Plots( 1, Lognormal Probability Plot( Parametric Fit Line( 0 ) ) )
        )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1(Lognormal) Probability Plot"] << get scriptable object);
scrobj << Parametric Fit Line( 1 );


```

#### [Simultaneous Empirical Confidence Limits](#simultaneous-empirical-confidence-limits)

**Syntax:** scrobj \<< Simultaneous Empirical Confidence Limits( state=0|1 )

**Description:** Shows or hides the simultaneous empirical confidence limits. On by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    Capability Box Plots( 1 ),
    Capability Index Plot( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis(
        Compare Distributions(
            1,
            <<Fit Lognormal,
            Probability Plots(
                1,
                Lognormal Probability Plot( Simultaneous Empirical Confidence Limits( 0 ) )
            )
        )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1(Lognormal) Probability Plot"] << get scriptable object);
scrobj << Simultaneous Empirical Confidence Limits( 1 );


```

#### [Simultaneous Empirical Confidence Limits Shading](#simultaneous-empirical-confidence-limits-shading)

**Syntax:** scrobj \<< Simultaneous Empirical Confidence Limits Shading( state=0|1 )

**Description:** Shows or hides the shading for the simultaneous empirical confidence limits. On by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    Capability Box Plots( 1 ),
    Capability Index Plot( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis(
        Compare Distributions(
            1,
            <<Fit Lognormal,
            Probability Plots(
                1,
                Lognormal Probability Plot(
                    Simultaneous Empirical Confidence Limits Shading( 0 )
                )
            )
        )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1(Lognormal) Probability Plot"] << get scriptable object);
scrobj << Simultaneous Empirical Confidence Limits Shading( 1 );


```

## [Process Capability Analysis > Process Capability Analysis Comparisons](#process-capability-analysis-process-capability-analysis-comparisons)

### [Item Messages](#item-messages_2)

#### [Comparison Details](#comparison-details)

**Syntax:** scrobj \<< Comparison Details( state=0|1 )

**Description:** Shows or hides a report that contains the AICc, BIC, and -2Loglikelihood values for each distribution. On by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    Capability Box Plots( 1 ),
    Capability Index Plot( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis(
        Compare Distributions(
            1,
            <<Fit Normal,
            <<Fit Gamma,
            <<Fit Johnson,
            <<Fit Lognormal,
            <<Fit Weibull,
            Comparison Details( 0 )
        )
    )}
);
Wait( 1 );
scrobj = Report( obj )["Compare Distributions"] << Get Scriptable Object;
scrobj << Comparison Details( 1 );


```

#### [Comparison Histogram](#comparison-histogram)

**Syntax:** scrobj \<< Comparison Histogram( state=0|1 )

**Description:** Shows or hides the distribution comparison histogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    Capability Box Plots( 1 ),
    Capability Index Plot( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis(
        Compare Distributions(
            1,
            <<Fit Normal,
            <<Fit Gamma,
            <<Fit Johnson,
            <<Fit Lognormal,
            <<Fit Weibull,
            Comparison Histogram( 0 )
        )
    )}
);
Wait( 1 );
scrobj = Report( obj )["Compare Distributions"] << Get Scriptable Object;
scrobj << Comparison Histogram( 1 );


```

#### [Fit Beta](#fit-beta)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Beta )

**Description:** Shows the beta distribution fit statistics in the comparison details report and the density curve in the histogram.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/cities.jmp" );
obj = dt << Process Capability(
    Process Variables( :OZONE ),
    Spec Limits( OZONE( LSL( 0.05 ), Target( 0.15 ), USL( 0.4 ) ) ),
    Individual Detail Reports( 1 ),
    {:OZONE << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["OZONE Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Beta );


```

#### [Fit Exponential](#fit-exponential)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Exponential )

**Description:** Shows the exponential distribution fit statistics in the comparison details report and the density curve in the histogram.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Exponential );


```

#### [Fit Gamma](#fit-gamma)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Gamma )

**Description:** Shows the gamma distribution fit statistics in the comparison details report and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Gamma );


```

#### [Fit Johnson](#fit-johnson)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Johnson )

**Description:** Shows the Johnson distribution fit statistics in the comparison details report and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Johnson );


```

#### [Fit Largest Extreme Value](#fit-largest-extreme-value)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Largest Extreme Value )

**Description:** Shows the largest extreme value distribution fit statistics in the comparison details report and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Largest Extreme Value );


```

#### [Fit Lognormal](#fit-lognormal)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Lognormal )

**Description:** Shows the lognormal distribution fit statistics in the comparison details report and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Lognormal );


```

#### [Fit Nonparametric](#fit-nonparametric)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Nonparametric )

**Description:** Shows the nonparametric distribution kernel bandwidth slider and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Nonparametric );


```

#### [Fit Normal](#fit-normal)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Normal )

**Description:** Shows the normal distribution fit statistics in the comparison details report and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);


```

#### [Fit SHASH](#fit-shash)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit SHASH )

**Description:** Shows the SHASH distribution fit statistics in the comparison details report and the density curve in the histogram.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit SHASH );


```

#### [Fit Smallest Extreme Value](#fit-smallest-extreme-value)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Smallest Extreme Value )

**Description:** Shows the smallest extreme value distribution fit statistics in the comparison details report and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Smallest Extreme Value );


```

#### [Fit Weibull](#fit-weibull)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Fit Weibull )

**Description:** Shows the Weibull distribution fit statistics in the comparison details report and the density curve in the histogram.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit Weibull );


```

#### [Mixture of 2 Normals](#mixture-of-2-normals)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Mixture of 2 Normals )

**Description:** Shows the Mixture of 2 Normals distribution fit statistics in the comparison details report and the density curve in the histogram.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Mixture of 2 Normals );


```

#### [Mixture of 3 Normals](#mixture-of-3-normals)

**Syntax:** scrobj \<< Compare Distributions( 1, \<<Mixture of 3 Normals )

**Description:** Shows the Mixture of 3 Normals distribution fit statistics in the comparison details report and the density curve in the histogram.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Mixture of 3 Normals );


```

#### [Order by Comparison Criterion](#order-by-comparison-criterion)

**Syntax:** scrobj \<< Order by Comparison Criterion( "AICc"|"BIC"|"-2Loglikelihood" )

**Description:** Reorders the comparison details report. It can be reordered by AICc, BIC, or -2Loglikelihood.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Individual Detail Reports( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis(
        Compare Distributions(
            1, <<Fit Normal, <<Fit Gamma, <<Fit Johnson, <<Fit Lognormal, <<Fit Weibull,
        )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Compare Distributions"] << get scriptable object);
scrobj << Order by Comparison Criterion( "-2Loglikelihood" );


```

#### [Probability Plots](#probability-plots)

**Syntax:** scrobj \<< Probability Plots( state=0|1 )

**Description:** Shows or hides the distribution comparison probability plots.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Individual Detail Reports( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis( Compare Distributions( 1, <<Fit Normal, <<Fit Lognormal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Compare Distributions"] << get scriptable object);
scrobj << Probability Plots( 1 );


```

## [Process Capability Analysis > Process Capability Analysis Histogram](#process-capability-analysis-process-capability-analysis-histogram)

### [Item Messages](#item-messages_3)

#### [Show Between-and-Within Sigma Density](#show-between-and-within-sigma-density)

**Syntax:** scrobj \<< "Show Between-and-Within Sigma Density"n( state=0|1 )

**Description:** Shows or hides the density curve that uses between-and-within sigma in the histogram. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] & Between ),
    Within Subgroup Variation( Average of Unbiased Standard Deviations ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date] & Between) << Process Capability Analysis(
        Histogram( 1, "Show Between-and-Within Sigma Density"n( 0 ) )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Histogram"] << get scriptable object);
scrobj << "Show Between-and-Within Sigma Density"n( 1 );


```

#### [Show Count Axis](#show-count-axis)

**Syntax:** scrobj \<< Show Count Axis( state=0|1 )

**Description:** Shows or hides a count axis to the right of the histogram frame.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date]) << Process Capability Analysis( Histogram( 1, Show Count Axis( 0 ) ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Histogram"] << get scriptable object);
scrobj << Show Count Axis( 1 );


```

#### [Show Density Axis](#show-density-axis)

**Syntax:** scrobj \<< Show Density Axis( state=0|1 )

**Description:** Shows or hides a density axis to the right of the histogram frame.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date]) << Process Capability Analysis( Histogram( 1, Show Density Axis( 0 ) ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Histogram"] << get scriptable object);
scrobj << Show Density Axis( 1 );


```

#### [Show Overall Sigma Density](#show-overall-sigma-density)

**Syntax:** scrobj \<< Show Overall Sigma Density( state=0|1 )

**Description:** Shows or hides the density curve that uses overall sigma in the histogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date]) << Process Capability Analysis(
        Histogram( 1, Show Overall Sigma Density( 0 ) )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Histogram"] << get scriptable object);
scrobj << Show Overall Sigma Density( 1 );


```

#### [Show Spec Limits](#show-spec-limits)

**Syntax:** scrobj \<< Show Spec Limits( state=0|1 )

**Description:** Shows or hides the lower and upper specification limits in the histogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date]) << Process Capability Analysis( Histogram( 1, Show Spec Limits( 0 ) ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Histogram"] << get scriptable object);
scrobj << Show Spec Limits( 1 );


```

#### [Show Target](#show-target)

**Syntax:** scrobj \<< Show Target( state=0|1 )

**Description:** Shows or hides the target line in the histogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date]) << Process Capability Analysis( Histogram( 1, Show Target( 0 ) ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Histogram"] << get scriptable object);
scrobj << Show Target( 1 );


```

#### [Show Within Sigma Density](#show-within-sigma-density)

**Syntax:** scrobj \<< Show Within Sigma Density( state=0|1 )

**Description:** Shows or hides the density curve that uses within sigma in the histogram. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date]) << Process Capability Analysis(
        Histogram( 1, Show Within Sigma Density( 0 ) )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Histogram"] << get scriptable object);
scrobj << Show Within Sigma Density( 1 );


```

## [Process Capability Analysis > Process Capability Interactive Plot](#process-capability-analysis-process-capability-interactive-plot)

### [Item Messages](#item-messages_4)

#### [Capability](#capability)

**Syntax:** scrobj \<< Capability( state=0|1 )

**Description:** Shows or hides the capability indices. The original capability indices are based on the overall sigma. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables( :PNP1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:PNP1 << Process Capability Analysis(
        Process Summary( 0 ),
        Overall Sigma Capability( 0 ),
        Nonconformance( 0 ),
        Within Sigma Capability( 0 ),
        Histogram( 0 ),
        Interactive Capability Plot( 1, Capability( 0 ) )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Interactive Capability Plot"] << get scriptable object);
scrobj << Capability( 1 );


```

#### [Nonconformance](#nonconformance)

**Syntax:** scrobj \<< Nonconformance( state=0|1 )

**Description:** Shows or hides the nonconformance. The original nonconformance values are based on the overall sigma. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables( :PNP1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:PNP1 << Process Capability Analysis(
        Process Summary( 0 ),
        Overall Sigma Capability( 0 ),
        Nonconformance( 0 ),
        Within Sigma Capability( 0 ),
        Histogram( 0 ),
        Interactive Capability Plot( 1, Nonconformance( 0 ) )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Interactive Capability Plot"] << get scriptable object);
scrobj << Nonconformance( 1 );


```

#### [Revert to Original Values](#revert-to-original-values)

**Syntax:** scrobj \<< Revert to Original Values

**Description:** Reverts the interactive capability plot back to its original values.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables( :PNP1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:PNP1 << Process Capability Analysis(
        Process Summary( 0 ),
        Overall Sigma Capability( 0 ),
        Nonconformance( 0 ),
        Within Sigma Capability( 0 ),
        Histogram( 0 ),
        Interactive Capability Plot( 1, New Values( Mean( 400 ) ) )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Interactive Capability Plot"] << get scriptable object);
scrobj << Revert to Original Values;


```

#### [Save New Spec Limits as a Column Property](#save-new-spec-limits-as-a-column-property)

**Syntax:** scrobj \<< Save New Spec Limits as a Column Property

**Description:** Saves the new specification limits as a column property in the original data table.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables( :PNP1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:PNP1 << Process Capability Analysis(
        Process Summary( 0 ),
        Overall Sigma Capability( 0 ),
        Nonconformance( 0 ),
        Within Sigma Capability( 0 ),
        Histogram( 0 ),
        Interactive Capability Plot( 1, New Values( LSL( 150 ), Target( 300 ), USL( 450 ) ) )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Interactive Capability Plot"] << get scriptable object);
scrobj << Save New Spec Limits as a Column Property;


```

## [Process Capability Analysis > Process Capability Normal Probability Plot](#process-capability-analysis-process-capability-normal-probability-plot)

### [Item Messages](#item-messages_5)

#### [Normal Fit Confidence Limits Shading](#normal-fit-confidence-limits-shading)

**Syntax:** scrobj \<< Normal Fit Confidence Limits Shading( state=0|1 )

**Description:** Shows or hides the normal fit confidence limits shading in the normal probability plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis(
        Normal Probability Plot( 1, Normal Fit Confidence Limits Shading( 0 ) )
    )}
);
Wait( 2 );
scrobj = Report( obj )["Normal Probability Plot"] << get scriptable object;
scrobj << Normal Fit Confidence Limits Shading( 1 );


```

#### [Normal Fit Line](#normal-fit-line)

**Syntax:** scrobj \<< Normal Fit Line( state=0|1 )

**Description:** Shows or hides the normal fit line in the normal probability plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis(
        Normal Probability Plot( 1, Normal Fit Line( 0 ) )
    )}
);
Wait( 2 );
scrobj = Report( obj )["Normal Probability Plot"] << get scriptable object;
scrobj << Normal Fit Line( 1 );


```

#### [Simultaneous Empirical Confidence Limits](#simultaneous-empirical-confidence-limits_1)

**Syntax:** scrobj \<< Simultaneous Empirical Confidence Limits( state=0|1 )

**Description:** Shows or hides the simultaneous empirical confidence limits in the normal probability plot in the Process Capability report. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis(
        Normal Probability Plot( 1, Simultaneous Empirical Confidence Limits( 0 ) )
    )}
);
Wait( 2 );
scrobj = Report( obj )["Normal Probability Plot"] << get scriptable object;
scrobj << Simultaneous Empirical Confidence Limits( 1 );


```

#### [Simultaneous Empirical Confidence Limits Shading](#simultaneous-empirical-confidence-limits-shading_1)

**Syntax:** scrobj \<< Simultaneous Empirical Confidence Limits Shading( state=0|1 )

**Description:** Shows or hides the simultaneous empirical confidence limits shading in the normal probability plot in the Process Capability report. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis(
        Normal Probability Plot( 1, Simultaneous Empirical Confidence Limits Shading( 0 ) )
    )}
);
Wait( 2 );
scrobj = Report( obj )["Normal Probability Plot"] << get scriptable object;
scrobj << Simultaneous Empirical Confidence Limits Shading( 1 );


```

## [Process Capability Analysis](#process-capability-analysis)

### [Item Messages](#item-messages_6)

#### [Between-and-Within Sigma Capability](#between-and-within-sigma-capability)

**Syntax:** scrobj \<< "Between-and-Within Sigma Capability"n( state=0|1 )

**Description:** Shows or hides the capability indices that use between-and-within sigma. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] & Between ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date] & Between) << Process Capability Analysis(
        "Between-and-Within Sigma Capability"n( 0 )
    )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << Get Scriptable Object;
scrobj << "Between-and-Within Sigma Capability"n( 1 );


```

#### [Between-and-Within Sigma Target Index](#between-and-within-sigma-target-index)

**Syntax:** scrobj \<< "Between-and-Within Sigma Target Index"n( state=0|1 )

**Description:** Shows or hides an estimate of the target index that is based on the between-and-within sigma.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] & Between ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date] & Between) << Process Capability Analysis(
        "Between-and-Within Sigma Target Index"n( 1 )
    )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << "Between-and-Within Sigma Target Index"n( 0 );


```

#### [Between-and-Within Sigma Z Benchmark](#between-and-within-sigma-z-benchmark)

**Syntax:** scrobj \<< "Between-and-Within Sigma Z Benchmark"n( state=0|1 )

**Description:** Shows or hides the Z benchmark indices that use between-and-within sigma.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] & Between ),
    Individual Detail Reports( 1 ),
    {(:Gap[:Date] & Between) << Process Capability Analysis(
        "Between-and-Within Sigma Z Benchmark"n( 0 )
    )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << "Between-and-Within Sigma Z Benchmark"n( 1 );


```

#### [Compare Distributions](#compare-distributions)

**Syntax:** scrobj \<< Compare Distributions( state=0|1, < \<<distribution options > )

**Description:** Shows or hides the control panel for comparing distributions for the process.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Individual Detail Reports( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis( Compare Distributions( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Process 1(Lognormal) Capability"] << get scriptable object;
scrobj << Compare Distributions( 1, <<Fit Lognormal );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 1, <<Fit SHASH );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Lognormal ) ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    Capability Box Plots( 1 ),
    Capability Index Plot( 1 ),
    {(:Process 1 & Dist( Lognormal )) <<
    Process Capability Analysis( Compare Distributions( 1, <<Fit Normal ) )}
);
Wait( 1 );
scrobj = Report( obj )["Process 1(Lognormal) Capability"] << Get Scriptable Object;
scrobj << Compare Distributions(
    1, <<Fit Gamma, <<Fit Johnson, <<FitLognormal, <<Fit Weibull
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 ),
    Moving Range Method( Average of Moving Ranges ),
    Individual Detail Reports( 1 ),
    {:Process 1 << Process Capability Analysis(
        Compare Distributions( 1, <<Fit Normal, <<Fit Gamma )
    )}
);
Wait( 1 );
scrobj = (Report( obj )["Process 1 Capability"] << get scriptable object);
scrobj << Compare Distributions( 0 );


```

#### [Fix Parameters](#fix-parameters)

**Syntax:** scrobj \<< Fix Parameters( vector )

**Description:** Fixes certain parameters to the specified values and re-estimates the rest.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Process 1 & Dist( Weibull ) ),
    Individual Detail Reports( 1 ),
    {(:Process 1 & Dist( Weibull )) <<
    Process Capability Analysis( Fix Parameters( [11, .] ) )}
);
Wait( 1 );
scrobj = Report( obj )["Process 1(Weibull*) Capability"] << get scriptable object;
scrobj << Fix Parameters( [., .] );


```

#### [Histogram](#histogram)

**Syntax:** scrobj \<< Histogram( state=0|1 )

**Description:** Shows or hides the histogram of the process data in the Individual Detail Report. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Histogram( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Histogram( 1 );


```

#### [Interactive Capability Plot](#interactive-capability-plot)

**Syntax:** scrobj \<< Interactive Capability Plot( state=0|1 )

**Description:** Shows or hides an interactive capability report that enables you to explore how changes to the process or the specification limits affect capability.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables( :PNP1 ),
    Individual Detail Reports( 1 ),
    {:PNP1 << Process Capability Analysis( Interactive Capability Plot( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["PNP1 Capability"] << get scriptable object;
scrobj << Interactive Capability Plot( 1 );


```

#### [Nonconformance](#nonconformance_1)

**Syntax:** scrobj \<< Nonconformance( state=0|1 )

**Description:** Shows or hides a report of the observed and expected percentage of observations that fall outside the specifications limits. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Nonconformance( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Nonconformance( 1 );


```

#### [Nonparametric Density](#nonparametric-density)

**Syntax:** scrobj \<< Nonparametric Density( state=0|1 )

**Description:** Shows or hides the Nonparametric Density report, which provides the kernel bandwidth that is used to fit the nonparametric distribution. On by default.

```

dt = Open( "$SAMPLE_DATA/Tablet Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Purity & Dist( Nonparametric ) ),
    Individual Detail Reports( 1 ),
    {(:Purity & Dist( Nonparametric )) <<
    Process Capability Analysis( Nonparametric Density( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Purity(Nonparametric) Capability"] << get scriptable object;
scrobj << Nonparametric Density( 1 );


```

#### [Normal Probability Plot](#normal-probability-plot)

**Syntax:** scrobj \<< Normal Probability Plot( state=0|1 )

**Description:** Shows or hides a normal probability plot.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),

);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Normal Probability Plot( 1 );


```

#### [Overall Sigma Capability](#overall-sigma-capability)

**Syntax:** scrobj \<< Overall Sigma Capability( state=0|1 )

**Description:** Shows or hides the capability indices that are based on the overall sigma. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Overall Sigma Capability( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Overall Sigma Capability( 1 );


```

#### [Overall Sigma Z Benchmark](#overall-sigma-z-benchmark)

**Syntax:** scrobj \<< Overall Sigma Z Benchmark( state=0|1 )

**Description:** Shows or hides the Z benchmark indices that are based on the overall sigma.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Overall Sigma Z Benchmark( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Overall Sigma Z Benchmark( 1 );


```

#### [Parameter Estimates](#parameter-estimates)

**Syntax:** scrobj \<< Parameter Estimates( state=0|1 )

**Description:** Shows or hides the parameter estimate report for nonnormal parametric distributions. On by default.

```

dt = Open( "$SAMPLE_DATA/Tablet Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables( :Thickness & Dist( Johnson ) ),
    Individual Detail Reports( 1 ),
    {(:Thickness & Dist( Johnson )) <<
    Process Capability Analysis( Parameter Estimates( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Thickness(Johnson) Capability"] << get scriptable object;
scrobj << Parameter Estimates( 1 );


```

#### [Process Summary](#process-summary)

**Syntax:** scrobj \<< Process Summary( state=0|1 )

**Description:** Shows or hides the process summary statistics. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Process Summary( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Process Summary( 1 );


```

#### [Within Sigma Capability](#within-sigma-capability)

**Syntax:** scrobj \<< Within Sigma Capability( state=0|1 )

**Description:** Shows or hides the capability indices and their confidence intervals that are based on the within sigma. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Within Sigma Capability( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Within Sigma Capability( 1 );


```

#### [Within Sigma Target Index](#within-sigma-target-index)

**Syntax:** scrobj \<< Within Sigma Target Index( state=0|1 )

**Description:** Shows or hides an estimate of the target index that is based on the within sigma.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Within Sigma Target Index( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Within Sigma Target Index( 1 );


```

#### [Within Sigma Z Benchmark](#within-sigma-z-benchmark)

**Syntax:** scrobj \<< Within Sigma Z Benchmark( state=0|1 )

**Description:** Shows or hides the Z benchmark indices that are based on the within sigma.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Clips2.jmp" );
obj = dt << Process Capability(
    Process Variables( :Gap[:Date] ),
    Individual Detail Reports( 1 ),
    {:Gap[:Date] << Process Capability Analysis( Within Sigma Z Benchmark( 0 ) )}
);
Wait( 1 );
scrobj = Report( obj )["Gap[Date] Capability"] << get scriptable object;
scrobj << Within Sigma Z Benchmark( 1 );


```

## [Process Capability Goal Plot](#process-capability-goal-plot)

### [Item Messages](#item-messages_7)

#### [Capability Lines](#capability-lines)

**Syntax:** obj \<< Goal Plot( 1, Capability Lines( number=1.0 ) ); scrobj \<< Capability Lines( number=1.0 )

**Description:** Sets the Ppk (Cpk) value that controls the goal triangle lines in the Goal Plot. This value also appears in the Ppk (Cpk) edit box. "1.0" by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Goal Plot( 1, Capability Lines( 1.5 ) );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
Wait( 1 );
scrobj << Capability Lines( 1 );


```

#### [Defect Rate Contour](#defect-rate-contour)

**Syntax:** obj \<< Goal Plot( 1, Defect Rate Contour( number=0.0001 ) ); scrobj \<< Defect Rate Contour( number=0.0001 )

**Description:** Shows or hides the specified defect rate contour. "0.0001" by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Goal Plot( 1, Defect Rate Contour( 0.01 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << Defect Rate Contour( 0.01 );


```

#### [Label Overall Sigma Points](#label-overall-sigma-points)

**Syntax:** obj \<< Goal Plot( 1, Label Overall Sigma Points( state=0|1 ) ); scrobj \<< Label Overall Sigma Points( state=0|1 )

**Description:** Shows or hides labels for points on the goal plot. The points are calculated using the overall sigma estimate.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Goal Plot( 1, Label Overall Sigma Points( 0 ) );
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << Label Overall Sigma Points( 1 );


```

#### [Label Within Sigma Points](#label-within-sigma-points)

**Syntax:** obj \<< Goal Plot( 1, Label Within Sigma Points( state=0|1 ) ); scrobj \<< Label Within Sigma Points( state=0|1 )

**Description:** Shows or hides labels for points on the goal plot. The points are calculated using the within sigma estimate.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),

);
obj << Goal Plot(
    1,
    Show Within Sigma Points( 1 ),
    Show Overall Sigma Points( 0 ),
    Label Within Sigma Points( 1 )
);
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << Label Within Sigma Points( 0 );


```

#### [Label Within or Between-and-Within Sigma Points](#label-within-or-between-and-within-sigma-points)

**Syntax:** obj \<< Goal Plot( 1, "Label Within or Between-and-Within Sigma Points"n( state=0|1 ) ); scrobj \<< "Label Within or Between-and-Within Sigma Points"n( state=0|1 )

**Description:** Shows or hides labels for points on the goal plot. The points are calculated using the within sigma estimate or, if specified, the between-and-within sigma estimate.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),

);
obj << Goal Plot(
    1,
    "Show Within or Between-and-Within Sigma Points"n( 1 ),
    Show Overall Sigma Points( 0 ),
    "Label Within or Between-and-Within Sigma Points"n( 1 )
);
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << "Label Within or Between-and-Within Sigma Points"n( 0 );


```

#### [Shade Levels](#shade-levels)

**Syntax:** obj \<< Goal Plot( 1, Shade Levels( state=0|1 ) ); scrobj \<< Shade Levels( state=0|1 )

**Description:** Shows or hides the Ppk (Cpk) level shading in the goal plot. If p represents the Ppk (Cpk) goal entered in the edit box, processes with Ppk (Cpk) greater than 2\*p are shaded green; processes with Ppk (Cpk) less than p are shaded red; and the processes with Ppk (Cpk) greater than p and less than 2\*p are shaded yellow.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
obj << Goal Plot( 1, Shade Levels( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << Shade Levels( 0 );


```

#### [Show Overall Sigma Points](#show-overall-sigma-points)

**Syntax:** obj \<< Goal Plot( 1, Show Overall Sigma Points( state=0|1 ) ); scrobj \<< Show Overall Sigma Points( state=0|1 )

**Description:** Shows or hides points on the goal plot. The points are calculated using the overall sigma estimate. On by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),

);
Wait( 1 );
obj << Goal Plot( 1, Show Overall Sigma Points( 0 ) );
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << Show Overall Sigma Points( 1 );


```

#### [Show Within Sigma Points](#show-within-sigma-points)

**Syntax:** obj \<< Goal Plot( 1, Show Within Sigma Points( state=0|1 ) ); scrobj \<< Show Within Sigma Points( state=0|1 )

**Description:** Shows or hides points on the goal plot. The points are calculated using the within sigma estimate.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 1 );
obj << Goal Plot( 1, Show Within Sigma Points( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << Show Within Sigma Points( 0 );


```

#### [Show Within or Between-and-Within Sigma Points](#show-within-or-between-and-within-sigma-points)

**Syntax:** obj \<< Goal Plot( 1, "Show Within or Between-and-Within Sigma Points"n( state=0|1 ) ); scrobj \<< "Show Within or Between-and-Within Sigma Points"n( state=0|1 )

**Description:** Shows or hides points on the goal plot. The points are calculated using the within sigma estimate or, if specified, the between-and-within sigma estimate.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    )
);
Wait( 1 );
obj << Goal Plot( 1, "Show Within or Between-and-Within Sigma Points"n( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Goal Plot"] << get scriptable object);
scrobj << "Show Within or Between-and-Within Sigma Points"n( 0 );


```

## [Process Capability Index Plot](#process-capability-index-plot)

### [Item Messages](#item-messages_8)

#### [Capability Lines](#capability-lines_1)

**Syntax:** obj \<< Capability Index Plot( 1, Capability Lines( number=1.0 ) ); scrobj \<< Capability Lines( number=1.0 )

**Description:** Sets the Ppk (Cpk) value that controls the Ppk (Cpk) reference line in the capability index plot. This value also appears in the Ppk (Cpk) edit box. "1.0" by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :Process 1 & Dist( Johnson ), :Process 2 & Dist( Lognormal ), :Process 3,
        :Process 4 & Dist( Lognormal )
    ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot( 1, Capability Lines( 2.0 ) );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
Wait( 1 );
scrobj << Capability Lines( 1.0 );


```

#### [Label Overall Sigma Points](#label-overall-sigma-points_1)

**Syntax:** obj \<< Capability Index Plot( 1, Label Overall Sigma Points( state=0|1 ) ); scrobj \<< Label Overall Sigma Points( state=0|1 )

**Description:** Shows or hides labels for points on the capability index plot. The points are calculated using the overall sigma estimate.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :Process 1, :Process 2 & Dist( Lognormal ), :Process 3,
        :Process 4 & Dist( Lognormal ), :Process 5 & Dist( Weibull ), :Process 6, :Process 7
    ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot( 1, Label Overall Sigma Points( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
scrobj << Label Overall Sigma Points( 0 );


```

#### [Label Within Sigma Points](#label-within-sigma-points_1)

**Syntax:** obj \<< Capability Index Plot( 1, Label Within Sigma Points( state=0|1 ) ); scrobj \<< Label Within Sigma Points( state=0|1 )

**Description:** Shows or hides labels for points on the capability index plot. The points are calculated using the within sigma estimate.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :Process 1, :Process 2 & Dist( Lognormal ), :Process 3,
        :Process 4 & Dist( Lognormal ), :Process 5 & Dist( Weibull ), :Process 6, :Process 7
    ),
    Moving Range Method( Average of Moving Ranges ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot(
    1,
    Show Within Sigma Points( 1 ),
    Label Within Sigma Points( 1 )
);
Wait( 1 );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
scrobj << Label Within Sigma Points( 0 );


```

#### [Label Within or Between-and-Within Sigma Points](#label-within-or-between-and-within-sigma-points_1)

**Syntax:** obj \<< Capability Index Plot( 1, "Label Within or Between-and-Within Sigma Points"n( state=0|1 ) ); scrobj \<< "Label Within or Between-and-Within Sigma Points"n( state=0|1 )

**Description:** Shows or hides labels for points on the capability index plot. The points are calculated using the within sigma estimate or, if specified, the between-and-within sigma estimate.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot(
    1,
    "Show Within or Between-and-Within Sigma Points"n( 1 ),
    "Label Within or Between-and-Within Sigma Points"n( 1 )
);
Wait( 1 );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
scrobj << "Label Within or Between-and-Within Sigma Points"n( 0 );


```

#### [Shade Levels](#shade-levels_1)

**Syntax:** obj \<< Capability Index Plot( 1, Shade Levels( state=0|1 ) ); scrobj \<< Shade Levels( state=0|1 )

**Description:** Shows or hides the Ppk (Cpk) level shading in the capability index plot. If p represents the Ppk (Cpk) value entered in the edit box, processes with Ppk (Cpk) greater than 2\*p are shaded green; processes with Ppk (Cpk) less than p are shaded red; and the processes with Ppk (Cpk) greater than p and less than 2\*p are shaded yellow.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :Process 1, :Process 2 & Dist( Lognormal ), :Process 3,
        :Process 4 & Dist( Lognormal ), :Process 5 & Dist( Weibull ), :Process 6, :Process 7
    ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot( 1, Shade Levels( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
scrobj << Shade Levels( 0 );


```

#### [Show Overall Sigma Points](#show-overall-sigma-points_1)

**Syntax:** obj \<< Capability Index Plot( 1, Show Overall Sigma Points( state=0|1 ) ); scrobj \<< Show Overall Sigma Points( state=0|1 )

**Description:** Shows or hides points on the capability index plot. The points are calculated using the overall sigma estimate. On by default.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :Process 1, :Process 2 & Dist( Lognormal ), :Process 3,
        :Process 4 & Dist( Lognormal ), :Process 5 & Dist( Weibull ), :Process 6, :Process 7
    ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot(
    1,
    Show Within Sigma Points( 1 ),
    Show Overall Sigma Points( 0 )
);
Wait( 1 );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
scrobj << Show Overall Sigma Points( 1 );


```

#### [Show Within Sigma Points](#show-within-sigma-points_1)

**Syntax:** obj \<< Capability Index Plot( 1, Show Within Sigma Points( state=0|1 ) ); scrobj \<< Show Within Sigma Points( state=0|1 )

**Description:** Shows or hides points on the capability index plot. The points are calculated using the within sigma estimate.

```

dt = Open( "$SAMPLE_DATA/Process Measurements.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :Process 1, :Process 2 & Dist( Lognormal ), :Process 3,
        :Process 4 & Dist( Lognormal ), :Process 5 & Dist( Weibull ), :Process 6, :Process 7
    ),
    Moving Range Method( Average of Moving Ranges ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot( 1, Show Within Sigma Points( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
scrobj << Show Within Sigma Points( 0 );


```

#### [Show Within or Between-and-Within Sigma Points](#show-within-or-between-and-within-sigma-points_1)

**Syntax:** obj \<< Capability Index Plot( 1, "Show Within or Between-and-Within Sigma Points"n( state=0|1 ) ); scrobj \<< "Show Within or Between-and-Within Sigma Points"n( state=0|1 )

**Description:** Shows or hides points on the capability index plot. The points are calculated using the within sigma estimate or, if specified, the between-and-within sigma estimate.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer] & Between, :PNP1[:lot_id, :wafer] & Between,
        :PNP2[:lot_id, :wafer], :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 ),
    Goal Plot( 0 ),
    Process Performance Plot( 0 )
);
obj << Capability Index Plot( 1, "Show Within or Between-and-Within Sigma Points"n( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Capability Index Plot"] << get scriptable object);
scrobj << "Show Within or Between-and-Within Sigma Points"n( 0 );


```

## [Process Capability Performance Plot](#process-capability-performance-plot)

### [Item Messages](#item-messages_9)

#### [Capability Boundary](#capability-boundary)

**Syntax:** obj \<< Process Performance Plot( 1, Capability Boundary( number=1.0 ) ); scrobj \<< Capability Boundary( number=1.0 )

**Description:** Sets the overall capability Ppk value that controls the process performance plot boundaries for capable versus not capable. This value also appears in the Overall Ppk edit box. "1.0" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 ),
    Process Performance Plot( 1 ),
    Goal Plot( 0 ),
    Capability Index Plot( 0 )
);
Wait( 1 );
obj << Process Performance Plot( 1, Capability Boundary( 1.33 ) );
scrobj = (Report( obj )["Process Performance Plot"] << get scriptable object);
Wait( 1 );
scrobj << Capability Boundary( 1 );


```

#### [Label Points](#label-points)

**Syntax:** obj \<< Process Performance Plot( 1, Label Points( state=0|1 ) ); scrobj \<< Label Points( state=0|1 )

**Description:** Shows or hides the process names as labels for the points in the process performance plot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 ),
    Process Performance Plot( 1 ),
    Goal Plot( 0 ),
    Capability Index Plot( 0 )
);
obj << Process Performance Plot( 1, Label Points( 1 ) );
Wait( 1 );
scrobj = (Report( obj )["Process Performance Plot"] << get scriptable object);
scrobj << Label Points( 0 );


```

#### [Show Within Cpk Curve](#show-within-cpk-curve)

**Syntax:** obj \<< Process Performance Plot( 1, Show Within Cpk Curve( state=0|1 ) ); scrobj \<< Show Within Cpk Curve( state=0|1 )

**Description:** Shows or hides the Within Cpk curve in the process performance plot. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 ),
    Process Performance Plot( 1 ),
    Goal Plot( 0 ),
    Capability Index Plot( 0 )
);
obj << Process Performance Plot( 1, Show Within Cpk Curve( 0 ) );
Wait( 1 );
scrobj = (Report( obj )["Process Performance Plot"] << get scriptable object);
scrobj << Show Within Cpk Curve( 1 );


```

#### [Stability Boundary](#stability-boundary)

**Syntax:** obj \<< Process Performance Plot( 1, Stability Boundary( number=1.25 ) ); scrobj \<< Stability Boundary( number=1.25 )

**Description:** Sets the stability ratio value that controls the process performance plot boundaries for stable versus unstable. "1.25" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Capability(
    Process Variables(
        :NPN1[:lot_id, :wafer], :PNP1[:lot_id, :wafer], :PNP2[:lot_id, :wafer],
        :NPN2[:lot_id, :wafer], :PNP3[:lot_id, :wafer]
    ),
    Capability Box Plots( 0 ),
    Process Performance Plot( 1 ),
    Goal Plot( 0 ),
    Capability Index Plot( 0 )
);
Wait( 1 );
obj << Process Performance Plot( 1, Stability Boundary( 1.7 ) );
scrobj = (Report( obj )["Process Performance Plot"] << get scriptable object);
Wait( 1 );
scrobj << Stability Boundary( 1.25 );


```

# [Process History Explorer](#process-history-explorer)

## [Associated Constructors](#associated-constructors)

### [Process History Explorer](#process-history-explorer_1)

**Syntax:** Process History Explorer( Y( columns ),ID( columns), X( columns ), Step( columns ), Timestamp( columns ) )

**Description:** Identifies process steps associated with poor yield.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [ID](#id)

**Syntax:** obj \<< ID( column(s) )

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

### [Order](#order)

**Syntax:** obj \<< Order( column )

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

### [Process](#process)

**Syntax:** obj \<< Process( column(s) )

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

### [Step](#step)

**Syntax:** obj \<< Step( column(s) )

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

### [Timestamp](#timestamp)

**Syntax:** obj \<< Timestamp( column(s) )

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

## [Item Messages](#item-messages)

### [Goal is to Minimize Y](#goal-is-to-minimize-y)

**Syntax:** obj = Process History Explorer(...Goal is to Minimize Y( state=0|1 )...)

**Description:** Specifies that the goal of the analysis is to minimize the response.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    Goal is to Minimize Y( 1 )
);


```

### [Levels with Lowest Yield](#levels-with-lowest-yield)

**Syntax:** obj \<< Levels with Lowest Yield( state=0|1 )

**Description:** Shows or hides a table of summary statistics for the yield for each level of each X, Process variable.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Levels with Lowest Yield( 1 );


```

### [Levels with Lowest Yield with Time Filter](#levels-with-lowest-yield-with-time-filter)

**Syntax:** obj \<< Levels with Lowest Yield with Time Filter( state=0|1 )

**Description:** Shows or hides a table of summary statistics for the time intervals of the top 50 levels with the lowest yields.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Levels with Lowest Yield with Time Filter( 1 );


```

### [Order Interaction](#order-interaction)

**Syntax:** obj \<< Order Interaction

**Description:** Shows or hides a report of a one-way analysis of the yield on the Order column.

**JMP Version Added:** 14

### [Save Count Table](#save-count-table)

**Syntax:** obj \<< Save Count Table

**Description:** Saves a new data table that contains counts of how many units went through each level of the X, Process variables.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Save Count Table;


```

### [Save Log Count Table](#save-log-count-table)

**Syntax:** obj \<< Save Log Count Table

**Description:** Saves a new data table that has the same format as the Count table, except with entries of Log(Count + 1).

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Save Log Count Table;


```

### [Save Waiting Time](#save-waiting-time)

**Syntax:** obj \<< Save Waiting Time

**Description:** Saves each table in the Waiting Time Analysis report to a separate data table.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Waiting Time Analysis;
obj << Save Waiting Time;


```

### [Stepwise Regression](#stepwise-regression)

**Syntax:** obj \<< Stepwise Regression( Goal( "Biggest Individual Difference" | "Biggest Total Difference" | "Most Predictive"), Time Filtering( "None" | "Starting Time"), X Transform( "None" | "Log(Count+1)"), N Steps( number ) )

**Description:** Performs a stepwise regression analysis based on the specified options. A table is provided that shows the order in which terms entered the model at each step of the regression.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Stepwise Regression(
    Goal( "Biggest Total Difference" ),
    Time Filtering( "Starting Time" ),
    X Transform( "None" ),
    N Steps( 10 )
);


```

### [Transition Analysis](#transition-analysis)

**Syntax:** obj \<< Transition Analysis( columns, {"level1", "level2", ... } )

**Description:** Shows a report that helps you identify transitions from one component to another that are problematic for the resulting yield.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Transition Analysis(
    Route,
    {"Dep2Route001", "Dep2Route002", "Dep2Route003", "Dep2Route004", "Dep2Route005"}
);


```

### [Utilization](#utilization)

**Syntax:** obj \<< Utilization

**JMP Version Added:** 14

### [Waiting Time Analysis](#waiting-time-analysis)

**Syntax:** obj \<< Waiting Time Analysis

**Description:** Provides a table of waiting time summary statistics for each ID. In this table, waiting time is the amount of time between when an ID is done with one step and when it starts another step.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Waiting Time Analysis;


```

### [Yield Columns](#yield-columns)

**Syntax:** Yield Columns( columns )

**Description:** Specifies the column in the yield data table that contains the yield values.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

### [Yield Table](#yield-table)

**Syntax:** Yield Table( data table )

**Description:** Specifies the data table that contains the yields for each ID.

**JMP Version Added:** 14

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$sample_data\Quality Control\Lot Wafer History.jmp" );
dt2 = Open( "$sample_data\Quality Control\Lot Wafer Yield.jmp" );
obj = dt << Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Process History Explorer(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Process Screening](#process-screening)

## [Associated Constructors](#associated-constructors)

### [Process Screening](#process-screening_1)

**Syntax:** Process Screening( Process Variables( columns ) )

**Description:** Examines many processes from several perspectives, including stability, capability, control chart tests, and shift (drift). Assists with the ability to focus on which processes need attention.

#### [Screen Count Processes with Alarm Graph for Environmental Monitoring](#screen-count-processes-with-alarm-graph-for-environmental-monitoring)

```


dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Alarm Graph( 1 ),
    Show Charts as Selected( 1 ),
    Select Where( Action >= 1 )
);


```

#### [Screen Many Processes with Grouping Column](#screen-many-processes-with-grouping-column)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Grouping( :Site )
);


```

#### [Screen Many Processes with Individual-and-Moving-Range Control Chart Metrics](#screen-many-processes-with-individual-and-moving-range-control-chart-metrics)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);


```

#### [Screen Many Processes with XBar-and-R Control Chart Metrics](#screen-many-processes-with-xbar-and-r-control-chart-metrics)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "XBar and R" )
);


```

#### [Screen Many Processes with XBar-and-S Control Chart Metrics](#screen-many-processes-with-xbar-and-s-control-chart-metrics)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Subgroup( :wafer ),
    Control Chart Type( "XBar and S" )
);


```

#### [Screen Nonnegative Continuous Data for Environmental Monitoring](#screen-nonnegative-continuous-data-for-environmental-monitoring)

```


dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Nonnegative Continuous" ),
    Time( :Time ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Alarm Graph( 1 ),
    Show Charts as Selected( 1 )
);


```

#### [Screen Process with a 3-Way Chart (XBar-MR-and-R)](#screen-process-with-a-3-way-chart-xbar-mr-and-r)

```


dt = Open( "$Sample_Data/Quality Control/Vial Fill Weights.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fill Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar MR and R" ),
    Moving Range Limit Exceeded( 1 ),
    Chart Options as Selected( Dispersion Chart( 1 ) ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] )
);


```

#### [Screen Process with a 3-Way Chart (XBar-MR-and-S)](#screen-process-with-a-3-way-chart-xbar-mr-and-s)

```


dt = Open( "$Sample_Data/Quality Control/Vial Fill Weights.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fill Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar MR and S" ),
    Moving Range Limit Exceeded( 1 ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] )
);


```

#### [Screen Process with a Proportion Chart](#screen-process-with-a-proportion-chart)

```


dt = Open( "$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp" );
obj = dt << Process Screening(
    Process Variables( :N Defective ),
    Control Chart Type( "Proportion" ),
    n Trials( :N Units ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] )
);


```

#### [Screen Processes to Show Control Charts for Selected Processes](#screen-processes-to-show-control-charts-for-selected-processes)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    Show Charts as Selected( 1 ),
    Select Where( Alarm Rate > 0.006 ),     // what selects in the table
    Filter Where( Alarm Rate > 0.005 )  // what shows in the table
);


```

#### [Screen Processes with Capability Goal Plot](#screen-processes-with-capability-goal-plot)

```



dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Goal Plot( 1 )
);


```

#### [Screen Processes with Process Performance Graph](#screen-processes-with-process-performance-graph)

```



dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Set Scrolling( 10 ), // table shows only the first 10 processes
    Process Performance Graph( 1 )
);


```

#### [Screen Processes with Process Potential Graph](#screen-processes-with-process-potential-graph)

```


dt = Open( "$Sample_Data/Quality Control/Coating.jmp" );
Column( "Weight" ) << Set Property(
    "Process Screening",
    {Centerline( 20.5 ), Specified Sigma( 1.5 ), Measurement Sigma( .8 )}
);
Column( "Weight" ) << Set Property( "Spec Limits", {LSL( 17 ), USL( 24 )} );
obj = dt << Process Screening(
    Process Variables( :Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar and R" ),
    Out of Spec Count( 0 ),
    Out of Spec Rate( 0 ),
    Latest Out of Spec( 0 ),
    Process Potential Graph( 1 )
);


```

#### [Screen Processes with Shift Detection](#screen-processes-with-shift-detection)

```


dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Current.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure ),
    Control Chart Type( "Indiv and MR" ),
    Shift Graph( 1 ),
    Show Charts as Selected( 1 ),
    Select Where( Stability Index > 2 )
);


```

#### [Screen Processes with Specification Limits in a Separate Table](#screen-processes-with-specification-limits-in-a-separate-table)

```


dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Process Screening(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Grouping](#grouping)

**Syntax:** obj = Process Screening(...\<Grouping( column(s) )>...)

**Description:** Analyzes each process variable at every combination of levels of the specified grouping columns.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);


```

### [Process Variables](#process-variables)

**Syntax:** obj = Process Screening(...Process Variables( column(s) )...)

**Description:** Specifies the columns of process data that contain the measurements to be analyzed.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);


```

### [Subgroup](#subgroup)

**Syntax:** obj = Process Screening(...\<Subgroup( column(s) )>...)

**Description:** Assigns one or more subgroup variables.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( Eval( 5 :: 132 ) ),
    Control Chart Type( "XBar and R" ),
    Subgroup( :wafer ),
    Sort by Subgroup( 1 )
);


```

### [Time](#time)

**Syntax:** obj = Process Screening(...\<Time( column )>...)

**Description:** Assigns a column that specifies the time order for the data. The process data are sorted by the Time variable before calculations are performed.

```

dt = Open( "$SAMPLE_DATA/Consumer Prices.jmp" );
obj = dt << Process Screening(
    Process Variables( :Price ),
    Grouping( :Series ),
    Control Chart Type( "XBar and R" ),
    Time( :Date ),
    Subgroup Sample Size( 3 )
);


```

### [n Trials](#n-trials)

**Syntax:** obj = Process Screening(...\<n Trials( column )>...)

**Description:** Assigns a column that contains the number of trials. This number is used as the denominator of the proportion defective for a P chart.

```

dt = Open( "$Sample_Data/Quality Control/Washers.jmp" );
dt << Process Screening(
    Process Variables( :"# defective"n ),
    Control Chart Type( "Proportion" ),
    n Trials( :Lot Size 2 ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] )
);


```

## [Item Messages](#item-messages)

### [Action Lower Quantile Prob](#action-lower-quantile-prob)

**Syntax:** obj = Process Screening(...Action Lower Quantile Prob( number=. )...)

**Description:** Specifies a probability that determines the value for the Action Limit. For count processes, if the Action Limit is not specified in the limits table, it is set from the estimated quantile based on this probability. "." by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Alert Lower Quantile Prob( 0.05 ),
    Action Lower Quantile Prob( 0.01 )
);


```

### [Action Upper Quantile Prob](#action-upper-quantile-prob)

**Syntax:** obj = Process Screening(...Action Upper Quantile Prob( number=0.9985 )...)

**Description:** Specifies a probability that determines the value for the Action Limit. For count processes, if the Action Limit is not specified in the limits table, it is set from the estimated quantile based on this probability. "0.9985" by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Alert Upper Quantile Prob( 0.95 ),
    Action Upper Quantile Prob( 0.99 )
);


```

### [Alarm Graph](#alarm-graph)

**Syntax:** obj \<< Alarm Graph( state=0|1 )

**Description:** Shows or hides a plot of alarms, with the processes that have alarms on the Y axis, and the time occurrence on the X axis.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Alarm Graph( 1 )
);


```

### [Alert Lower Quantile Prob](#alert-lower-quantile-prob)

**Syntax:** obj = Process Screening(...Alert Lower Quantile Prob( number=. )...)

**Description:** Specifies a probability that determines the value for the Alert Limit. For count processes, if the Alert Limit is not specified in the limits table, it is set from the estimated quantile based on this probability. "." by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Alert Lower Quantile Prob( 0.05 ),
    Action Lower Quantile Prob( 0.01 )
);


```

### [Alert Upper Quantile Prob](#alert-upper-quantile-prob)

**Syntax:** obj = Process Screening(...Alert Upper Quantile Prob( number=0.975 )...)

**Description:** Specifies a probability that determines the value for the Alert Limit. For count processes, if the Alert Limit is not specified in the limits table, it is set from the estimated quantile based on this probability. "0.975" by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Alert Upper Quantile Prob( 0.95 ),
    Action Upper Quantile Prob( 0.99 )
);


```

### [Chart Options Drift Graph](#chart-options-drift-graph)

**Syntax:** obj \<< Chart Options Drift Graph( options )

**Description:** Enables you to script additional options for the charts that are produced by the Drift Graph Selected option.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Select All,
    Drift Graph Selected
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Markers( 1 ), Connect Points( 0 ) );


```

### [Chart Options Graphlet](#chart-options-graphlet)

**Syntax:** obj \<< Chart Options Graphlet( options )

**Description:** Enables you to script additional options for graphlets.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( :NPN1, :PNP1, :PNP2, :NPN2, :PNP3 ),
    Subgroup( :lot_id, :wafer ),
    Control Chart Type( "XBar and R" ),
    Process Performance Graph( 1 ),
    Chart Options Graphlet( Show Markers( 1 ) ),
    SendToReport(
        Dispatch( {"Process Performance Graph"}, "ProcessScreening Graph", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 4 ),
                Index Row( 4 ),
                UniqueID( 4 ),
                FoundPt( {320, 564} ),
                Origin( {1, 0.24} ),
                RightOfCenter( 0 ),
                Tag Line( 1 )
            )
        )
    )
);


```

### [Chart Options as Selected](#chart-options-as-selected)

**Syntax:** obj \<< Chart Options as Selected( options )

**Description:** Enables you to script additional options for the charts that are produced by the Show Charts as Selected option.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Select All,
    Show Charts as Selected
);
Wait( 1 );
obj << Chart Options as Selected( Show Markers( 0 ) );


```

### [Chart Options for Selected](#chart-options-for-selected)

**Syntax:** obj \<< Chart Options for Selected( options )

**Description:** Enables you to script additional options for the charts that are produced by the Show Charts for Selected option.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Select All,
    Show Charts for Selected
);
Wait( 1 );
obj << Chart Options for Selected( Show Markers( 1 ) );


```

### [Color Out of Spec Values](#color-out-of-spec-values)

**Syntax:** obj \<< Color Out of Spec Values

**Description:** Colors values in the data table based on the specification limits. Blue indicates that the value is below the lower specification limit. Red indicates that the value is above the upper specification limit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :PNP3, :IVP1, :IVP2 ) );
obj << Color Out of Spec Values;


```

### [Color Selected Items](#color-selected-items)

**Syntax:** obj \<< Color Selected Items( color )

**Description:** Applies the specified color to the selected rows in the summary table.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Find and Select( "PNP1" ),
    Color Selected Items( "Blue" )
);
obj << Find and Select( "NPN1" );
obj << Color Selected Items( "Red" );
obj << Find and Select( "NPN2" );


```

### [Control Chart Builder](#control-chart-builder)

**Syntax:** obj \<< Control Chart Builder

**Description:** Opens a Control Chart Builder report window for the processes that you selected in the summary table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Select All,
    Control Chart Builder
);


```

### [Control Chart Type](#control-chart-type)

**Syntax:** obj = Process Screening(...Control Chart Type( "Indiv and MR"|"XBar and R"|"XBar and S"|"XBar MR and R"|"XBar MR and S"|"Count"|"Nonnegative Continuous"|"Proportion" )...)

**Description:** Specifies one of five types of control chart calculations. "Indiv and MR" by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Control Chart Type( "XBar and R" )
);


```

### [Count](#count)

**Syntax:** obj \<< Count( state=0|1 )

**Description:** Shows or hides the Count column in the summary table. This column contains the number of observations. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ) );
Wait( 1 );
obj << Count( 0 );


```

### [Cp](#cp)

**Syntax:** obj \<< Cp( state=0|1 )

**Description:** Shows or hides the Cp column in the summary table. This column contains the potential capability if target and drift issues are resolved.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Cp( 1 ) );


```

### [Cpk](#cpk)

**Syntax:** obj \<< Cpk( state=0|1 )

**Description:** Shows or hides the Cpk column in the summary table. This column contains the Cpk short-run capability index based on Within Sigma or Between-and-Within Sigma and assuming a normal distribution. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Cpk( 0 ) );
Wait( 1 );
obj << Cpk( 1 );


```

### [Drift Alpha](#drift-alpha)

**Syntax:** obj = Process Screening(...Drift Alpha( number=. )...)

**Description:** Specifies the Holt-Winters smoothing weight for position in drift detection. This value is usually estimated, rather than specified. If it is specified, you must specify it in the launch script. "." by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Alpha( .6 ),
    Select All,
    Drift Graph Selected
);


```

### [Drift Beta](#drift-beta)

**Syntax:** obj = Process Screening(...Drift Beta( number=.05 )...)

**Description:** Specifies the weight that is used in the Holt Double-Exponential Smoother for drift detection. ".05" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Beta( .1 ),
    Select All,
    Drift Graph Selected
);


```

### [Drift Graph Selected](#drift-graph-selected)

**Syntax:** obj \<< Drift Graph Selected( \<{ process list }> )

**Description:** Shows a drift graph for each process that you select in the summary table. The values that are plotted are the slope estimates from a Holt Double-Exponential Smoothing model.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Select All,
    Drift Graph Selected
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), );
Wait( 1 );
obj << Drift Graph Selected( {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}} );


```

### [Drift Summaries](#drift-summaries)

**Syntax:** obj \<< Drift Summaries( state=0|1 )

**Description:** Shows or hides drift summary columns in the summary table. These columns contain the mean up drift, mean down drift, and mean absolute drift.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Summaries( 1 )
);


```

### [Enable All Tests](#enable-all-tests)

**Syntax:** obj \<< Enable All Tests

**Description:** Includes all of the Nelson tests in the alarm rates and counts.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Enable All Tests
);


```

### [Expected Out of Spec Rate](#expected-out-of-spec-rate)

**Syntax:** obj \<< Expected Out of Spec Rate( state=0|1 )

**Description:** Shows or hides the Expected Out of Spec Rate column in the summary table. This column contains the expected proportion of observations that fall outside of the specification limits. The Expected Out of Spec Rate value assumes a stable and normally distributed process and uses the overall sigma.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Expected Out of Spec Rate( 1 )
);


```

### [Filter Where](#filter-where)

**Syntax:** obj \<< Filter Where( condition )

**Description:** Filters and removes the processes in the summary table. The filter is based on the specified condition.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Filter Where( Alarm Rate > 0 )
);
Wait( 1 );
obj << Reset Filter;
obj << Filter Where( Stability Index > 1.3 | Mean <= 4.3 );


```

### [Find and Select](#find-and-select)

**Syntax:** obj \<< Find and Select( condition )

**Description:** Finds all columns and groups where the search string appears and selects those processes in the summary table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Find and Select( "DIAMETER", {"C334", "A455"}, 2 )
);


```

### [Goal Plot](#goal-plot)

**Syntax:** obj \<< Goal Plot( state=0|1 )

**Description:** Shows or hides a plot that contains a point for each variable. The spec-normalized mean shift is on the horizontal axis and the spec-normalized standard deviation is on the vertical axis. This option is available only if specification limits are defined for at least one process variable.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Goal Plot( 1 ) );


```

### [KSigma](#ksigma)

**Syntax:** obj = Process Screening(...KSigma( number=3 )...)

**Description:** Specifies the number of standard deviations (in terms of sigma) that the control limits should be from the centerline. "3" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( X( :Process ), Y( Eval( 5 :: 132 ) ), K Sigma( 4 ) );


```

### [KSigma for Proportion](#ksigma-for-proportion)

**Syntax:** obj = Process Screening(...KSigma for Proportion( number=3 )...)

**Description:** Specifies the number of standard deviations (in terms of sigma) that the control limits should be from the centerline. "3" by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp" );
dt << Process Screening(
    Process Variables( :N Defective ),
    n Trials( :N Units ),
    Time( :Day ),
    Control Chart Type( "Proportion" ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] ),
    K Sigma for Proportion( 2.5 ),
    Use Upper Limit( 1 ),
    Use Lower Limit( 1 )
);


```

### [Keep Distribution Details](#keep-distribution-details)

**Syntax:** obj = Process Screening(...Keep Distribution Details( state=0|1 )...)

**Description:** Retains the parameter estimates and quantile details of fitting all the distributions so that they are available to show in the report.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Keep Distribution Details( 1 ),
    SendToReport(
        Dispatch( {}, "Poisson λ", NumberColBox, {Visibility( "Visible" )} ),
        Dispatch( {}, "NegBin λ", NumberColBox, {Visibility( "Visible" )} ),
        Dispatch( {}, "NegBin σ", NumberColBox, {Visibility( "Visible" )} ),
        Dispatch( {}, "ZIP π", NumberColBox, {Visibility( "Visible" )} ),
        Dispatch( {}, "ZIP λ", NumberColBox, {Visibility( "Visible" )} ),
        Dispatch( {}, "ZINB π", NumberColBox, {Visibility( "Visible" )} ),
        Dispatch( {}, "ZINB λ", NumberColBox, {Visibility( "Visible" )} ),
        Dispatch( {}, "ZINB σ", NumberColBox, {Visibility( "Visible" )} )
    )
);


```

### [Largest Downshift](#largest-downshift)

**Syntax:** obj \<< Largest Downshift( state=0|1 )

**Description:** Shows or hides the Largest Downshift and Downshift Position columns in the summary table. These columns contain the largest downward shift in the series that exceeds one within sigma unit and the position in the series at which this shift occurred.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Largest Downshift( 1 )
);


```

### [Largest Upshift](#largest-upshift)

**Syntax:** obj \<< Largest Upshift( state=0|1 )

**Description:** Shows or hides the Largest Upshift and Upshift Position columns in the summary table. These columns contain the largest upward shift in the series that exceeds one within sigma unit and the position in the series at which this shift occurred.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Largest Upshift( 1 )
);


```

### [Latest Out of Spec](#latest-out-of-spec)

**Syntax:** obj \<< Latest Out of Spec( state=0|1 )

**Description:** Shows or hides the Latest Out of Spec column in the summary table. This column contains the number of observations between the last observation that is outside of the specification limits and the final observation. If the last observation is outside of the specification limits, the Latest Out of Spec value is 1. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Latest Out of Spec( 0 ) );
Wait( 1 );
obj << Latest Out of Spec( 1 );


```

### [Make Detailed Shift Data](#make-detailed-shift-data)

**Syntax:** obj = Process Screening(...Make Detailed Shift Data( state=0|1 )...)

**Description:** Stores all of the shift information so that it can be saved to a data table later using the Save Shift Table option. This option must be specified in the launch script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Current.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure ),
    Control Chart Type( "Indiv and MR" ),
    RowStates( [5 1] ),
    Shift Graph( 1 ),
    Make Detailed Shift Data( 1 )
);
obj << Save Shift Table;


```

### [Maximum](#maximum)

**Syntax:** obj \<< Maximum( state=0|1 )

**Description:** Shows or hides the Maximum for Count and Nonnegative Continuous chart types. On by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time )
);
Wait( 1 );
obj << Maximum( 0 );


```

### [Mean](#mean)

**Syntax:** obj \<< Mean( state=0|1 )

**Description:** Shows or hides the Mean column in the summary table. This column contains the average of the process data. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ) );
Wait( 1 );
obj << Mean( 0 );


```

### [Minimum Process Length](#minimum-process-length)

**Syntax:** obj = Process Screening(...Minimum Process Length( number=3 )...)

**Description:** Specifies the minimum number of data values that a process must have to be included in the analysis. "3" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Minimum Process Length( 40 )
);


```

### [Moving Range Limit Exceeded](#moving-range-limit-exceeded)

**Syntax:** obj \<< Moving Range Limit Exceeded( state=0|1 )

**Description:** Shows or hides the Moving Range Limited Exceeded column in the summary table. This column contains the number of subgroups that exceed the moving range limit on the three way control chart calculation.

```

dt = Open( "$Sample_Data/Quality Control/Vial Fill Weights.jmp" );
obj = dt << Process Screening(
    Y( :Fill Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar MR and R" ),
    Moving Range Limit Exceeded( 1 )
);


```

### [N Subgroups](#n-subgroups)

**Syntax:** obj \<< N Subgroups( state=0|1 )

**Description:** Shows or hides the N Subgroups column in the summary table. This column contains the number of subgroups. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Control Chart Type( "XBar and R" )
);
Wait( 1 );
obj << N Subgroups( 0 );


```

### [Out of Spec Count](#out-of-spec-count)

**Syntax:** obj \<< Out of Spec Count( state=0|1 )

**Description:** Shows or hides the Out of Spec Count column in the summary table. This column contains the number of observations that fall outside of the specification limits. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Out of Spec Count( 0 ) );
Wait( 1 );
obj << Out of Spec Count( 1 );


```

### [Out of Spec Rate](#out-of-spec-rate)

**Syntax:** obj \<< Out of Spec Rate( state=0|1 )

**Description:** Shows or hides the Out of Spec Rate column in the summary table. This column contains the proportion of observations that fall outside of the specification limits. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Out of Spec Rate( 0 ) );
Wait( 1 );
obj << Out of Spec Rate( 1 );


```

### [Outlier Threshold](#outlier-threshold)

**Syntax:** obj = Process Screening(...Outlier Threshold( number=5 )...)

**Description:** Specifies the number of within sigma units that an observation must exceed in magnitude from its two neighbors in order to be treated as an outlier. "5" by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Shift Threshold( 2 ),
    Outlier Threshold( 1.1 ),
    Shift Graph( 1 )
);


```

### [Overall Sigma](#overall-sigma)

**Syntax:** obj \<< Overall Sigma( state=0|1 )

**Description:** Shows or hides the Overall Sigma column in the summary table. This column contains an estimate of the standard deviation based on all of the observations. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ) );
Wait( 1 );
obj << Overall Sigma( 0 );


```

### [Performance Graph Boundaries](#performance-graph-boundaries)

**Syntax:** obj \<< Performance Graph Boundaries( \<Capability Ppk boundary, Stability Ratio boundary> )

**Description:** Specifies boundaries for the Capability Ppk and Stability Ratio regions in the Process Performance Graph. If no arguments are specified, this option opens a window in which you can specify the boundaries.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Select All,
    Process Performance Graph( 1 )
);
Wait( 1 );
obj << Performance Graph Boundaries( 1.7, 1.2 );


```

### [Ppk](#ppk)

**Syntax:** obj \<< Ppk( state=0|1 )

**Description:** Shows or hides the Ppk column in the summary table. This column contains the Ppk long-run capability index based on Overall Sigma and assuming a normal distribution. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Ppk( 0 ) );
Wait( 1 );
obj << Ppk( 1 );


```

### [Ppk Capability Boundary](#ppk-capability-boundary)

**Syntax:** obj \<< Ppk Capability Boundary( number=1.33 )

**Description:** Specifies a boundary between the capable and incapable regions for Capability Ppk in the Process Performance Graph. "1.33" by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Select All,
    Ppk Capability Boundary( 1.7 ),
    Process Performance Graph( 1 )
);


```

### [Process Capability](#process-capability)

**Syntax:** obj \<< Process Capability

**Description:** Opens a Process Capability report window that shows Individual Detail Reports for the processes that you select in the summary table.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Select All,
    Process Capability
);


```

### [Process Performance Graph](#process-performance-graph)

**Syntax:** obj \<< Process Performance Graph( state=0|1 )

**Description:** Shows or hides a graph of Capability Ppk by Stability Ratio with four colored quadrants. By default, a stability ratio that exceeds 1.5 indicates that the process is unstable and a Ppk that is smaller than 1.33 indicates that the process is not capable.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Select All,
    Process Performance Graph( 1 )
);


```

### [Process Potential Graph](#process-potential-graph)

**Syntax:** obj \<< Process Potential Graph( state=0|1 )

**Description:** Shows or hides the Process Potential Graph, which plots Cp on the vertical axis and % Measurement Sigma^2 on the horizontal axis. This graph shows the relative benefits of improving the measurement system or the process.

```

dt = Open( "$Sample_Data/Quality Control/Coating.jmp" );
Column( "Weight" ) << Set Property(
    "Process Screening",
    {Centerline( 20.5 ), Specified Sigma( 1.5 ), Measurement Sigma( .8 )}
);
Column( "Weight" ) << Set Property( "Spec Limits", {LSL( 17 ), USL( 24 )} );
obj = dt << Process Screening(
    Process Variables( :Weight ),
    Subgroup( :Sample ),
    Control Chart Type( "XBar and R" ),
    Out of Spec Count( 0 ),
    Out of Spec Rate( 0 ),
    Latest Out of Spec( 0 ),
    Process Potential Graph( 1 )
);


```

### [Range Limit Exceeded](#range-limit-exceeded)

**Syntax:** obj \<< Range Limit Exceeded( state=0|1 )

**Description:** Shows or hides the Range Limit Exceeded column in the summary table. This column contains the number of subgroups that exceed the upper control limit on the R, S, or MR chart calculation.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Range Limit Exceeded( 1 )
);


```

### [Relaunch Selected Processes](#relaunch-selected-processes)

**Syntax:** obj \<< Relaunch Selected Processes

**Description:** Relaunches the Process Screening platform to create a new report that contains only the selected processes from the original report.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Show Charts as Selected( 1 ),
    RowStates( [51 1, 52 1, 66 1, 85 1] )
);
Wait( 1 );
obj << Relaunch Selected Processes;


```

### [Remove](#remove)

**Syntax:** obj = Process Screening(...Remove( columns )...)

**Description:** Specifies processes to be excluded from the analysis. This option must be specified in the launch script and applies only when a Column Group is specified.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( dt << get Column Group( "Processes" ) ),
    Remove( :NPN2 ),
    Process Performance Graph( 1 )
);


```

### [Remove Selected Items](#remove-selected-items)

**Syntax:** obj \<< Remove Selected Items

**Description:** Removes the rows that are selected in the summary table and reruns the analysis without those processes.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Find and Select( "DIAMETER", {"C334", "A455"}, 2 )
);
Wait( 1 );
obj << Remove Selected Items;


```

### [Reset Filter](#reset-filter)

**Syntax:** obj \<< Reset Filter

**Description:** Removes any filter that is currently applied to the summary table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ) );
Wait( 1 );
obj << Filter Where( Alarm Rate > 0 );
Wait( 3 );
obj << Reset Filter;


```

### [RowStates](#rowstates)

**Syntax:** obj \<< RowStates( matrix )

**Description:** Sets the row states for the rows in the summary table. The input is an m by 2 matrix. The first column contains row numbers (zero-based in original order) and the second column contains numeric row state values. See the JMP User's Guide for more information about numeric row state values.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Process Variables( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Control Chart Type( "XBar and R" ),
    RowStates( [0 1, 5 768] ) //Select first and Color Red the sixth of original order
);
Wait( 1 );
// sort columns to show original order
obj << SendToReport( Dispatch( {}, "", TableBox, {Sort By Column( 3, 1 )} ) );
obj << SendToReport( Dispatch( {}, "", TableBox, {Sort By Column( 2, 1 )} ) );


```

### [Save Details Table](#save-details-table)

**Syntax:** obj \<< Save Details Table

**Description:** Creates a new data table that contains the test alarm information for each combination of process and grouping variables.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( Eval( 5 :: 132 ) ), Subgroup Sample Size( 6 ) );
obj << Save Details Table;


```

### [Save Selected Details](#save-selected-details)

**Syntax:** obj \<< Save Selected Details

**Description:** Creates a new data table that contains the test alarm information for the selected rows in the summary table.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Find and Select( "DIAMETER", {"C334", "A455"}, 2 )
);
obj << Save Selected Details;


```

### [Save Shift Table](#save-shift-table)

**Syntax:** obj \<< Save Shift Table

**Description:** Creates a new data table that contains the saved shift gap data. This option requires that the Make Detailed Shift Data option is specified in the launch script.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Current.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure ),
    Control Chart Type( "Indiv and MR" ),
    RowStates( [5 1] ),
    Shift Graph( 1 ),
    Make Detailed Shift Data( 1 )
);
obj << Save Shift Table;


```

### [Save Summary Table](#save-summary-table)

**Syntax:** obj \<< Save Summary Table

**Description:** Creates a new data table that contains all of the process summary information for all variables and groups.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( Eval( 5 :: 132 ) ), Subgroup Sample Size( 6 ) );
obj << Save Summary Table;


```

### [Save Summary Table with Graphs](#save-summary-table-with-graphs)

**Syntax:** obj \<< Save Summary Table with Graphs

**Description:** Creates a new data table that contains all of the process summary information and a column of quick graphs.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( Eval( 5 :: 132 ) ), Subgroup Sample Size( 6 ) );
obj << Save Summary Table with Graphs;


```

### [Select All](#select-all)

**Syntax:** obj \<< Select All

**Description:** Selects all columns and groups and performs subsequent commands on these.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Select All );


```

### [Select Where](#select-where)

**Syntax:** obj \<< Select Where( condition )

**Description:** Selects process columns in the summary table. The selected columns correspond to the specified condition.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Select Where( Alarm Rate > 0 )
);


```

### [Set Scrolling](#set-scrolling)

**Syntax:** obj \<< Set Scrolling( number=50 )

**Description:** Specifies how many rows to show in the scrolling summary table. "50" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Set Scrolling( 3 )
);


```

### [Shift Graph](#shift-graph)

**Syntax:** obj \<< Shift Graph( state=0|1 )

**Description:** Shows or hides a plot of the time occurrence of all process shifts that exceed the number of within sigma units that are specified by the Shift Threshold option. Green markers indicate upshifts and red markers indicate downshifts.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Current.jmp" );
obj = dt << Process Screening(
    Y( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure ),
    Control Chart Type( "Indiv and MR" )
);
obj << Shift Graph( 1 );


```

### [Shift Lambda](#shift-lambda)

**Syntax:** obj = Process Screening(...Shift Lambda( number=.3 )...)

**Description:** Specifies the weight that is used in the exponentially weighted moving average (EWMA) for shift detection. ".3" by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Current.jmp" );
obj = dt << Process Screening(
    Process Variables( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure ),
    Control Chart Type( "Indiv and MR" ),
    Show Charts as Selected( 1 ),
    RowStates( [5 1] ),
    Shift Lambda( 0.2 ),
    Shift Graph( 1 )
);


```

### [Shift Threshold](#shift-threshold)

**Syntax:** obj = Process Screening(...Shift Threshold( number=3 )...)

**Description:** Specifies the number of within sigma units that a shift must exceed in magnitude in order to be shown in the Shift Graph. "3" by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Shift Threshold( 2 ),
    Shift Graph( 1 )
);


```

### [Show Charts as Selected](#show-charts-as-selected)

**Syntax:** obj \<< Show Charts as Selected( state=0|1 )

**Description:** Plots small graphs of the processes that are selected in the summary table. The graphs are shown in a Charts as Selected report that automatically updates as you select and deselect processes in the summary table.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ) );
obj << Select Where( :MACHINE == "C334" );
obj << Show Charts as Selected( 1 );
Wait( 2 );
obj << Select Where( :MACHINE == "A455" );


```

### [Show Charts for Selected](#show-charts-for-selected)

**Syntax:** obj \<< Show Charts for Selected( <process list> )

**Description:** Plots small graphs of the processes that are selected in the summary table. The graphs are shown in a Charts for Selected report where it is possible to view and compare many processes at once.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Select All,
    Show Charts for Selected
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :OPERATOR, :MACHINE ),
    Show Charts for Selected( {{:DIAMETER, "DRJ", "C334"}, {:DIAMETER, "MKS", "A386"}} )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :IVP7, :B1, :IVP8 ),
    Show Charts for Selected( {:IVP7, :IVP8} )
);


```

### [Show Shifts in Graphs](#show-shifts-in-graphs)

**Syntax:** obj \<< Show Shifts in Graphs( state=0|1 )

**Description:** Shows or hides the locations of the shifts in the quick graphs using green and red vertical lines.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Steam Turbine Current.jmp" );
obj = dt << Process Screening(
    Y( :Fuel, :Steam Flow, :Steam Temp, :MW, :Cool Temp, :Pressure ),
    Control Chart Type( "Indiv and MR" ),
    Select All,
    Show Charts for Selected,
    Show Shifts in Graphs( 1 )
);


```

### [Show Tests](#show-tests)

**Syntax:** obj \<< Show Tests( state=0|1 )

**Description:** Shows or hides the Nelson tests that are selected under Choose Tests. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Test 2( 1 ),
    Test 3( 1 )
);
Wait( 1 );
obj << Show Tests( 0 );


```

### [Sort by Subgroup](#sort-by-subgroup)

**Syntax:** obj = Process Screening(...Sort by Subgroup( state=0|1 )...)

**Description:** Sorts the process data by the subgroup variable, or combination of nested subgroup variables, before calculations are performed. This option is available only if a Subgroup variable is specified.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( Eval( 5 :: 132 ) ),
    Control Chart Type( "XBar and R" ),
    Subgroup( :wafer ),
    Sort by Subgroup( 1 )
);


```

### [Spec Centered Mean](#spec-centered-mean)

**Syntax:** obj \<< Spec Centered Mean( state=0|1 )

**Description:** Shows or hides the (Mean-Tgt)/SpecRange column in the summary table. This column contains the mean relative to the specification limits.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Spec Centered Mean( 1 ) );


```

### [Spec Limits](#spec-limits)

**Syntax:** obj \<< Spec Limits( state=0|1 )

**Description:** Shows or hides the specification limit columns in the summary table. These columns contain the lower specification limit (LSL), upper specification limit (USL), and target values.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Spec Limits( 1 ) );


```

### [Spec Scaled Std Dev](#spec-scaled-std-dev)

**Syntax:** obj \<< Spec Scaled Std Dev( state=0|1 )

**Description:** Shows or hides the StdDev/SpecRange column in the summary table. This column contains the overall standard deviation divided by the range of the specification limits.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Spec Scaled Std Dev( 1 ) );


```

### [Stability Index](#stability-index)

**Syntax:** obj \<< Stability Index( state=0|1 )

**Description:** Shows or hides the Stability Index column in the summary table. This column is a measure of the stability of a process, where a stable process has a stability index near 1. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ) );
Wait( 1 );
obj << Stability Index( 0 );


```

### [Stability Index Boundary](#stability-index-boundary)

**Syntax:** obj \<< Stability Index Boundary( number=1.25 )

**Description:** Specifies the boundary between the stable and unstable regions for Stability Index in the Process Performance Graph. "1.25" by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( :NPN1, :PNP1, :PNP2, :NPN2 ),
    Select All,
    Process Performance Graph( 1 )
);
Wait( 1 );
obj << Stability Index Boundary( 1.5 );


```

### [Stability Ratio](#stability-ratio)

**Syntax:** obj \<< Stability Ratio( state=0|1 )

**Description:** Shows or hides the Stability Ratio column in the summary table. This column is a measure of the stability of a process, where a stable process has a stability ratio near 1.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ) );
obj << Stability Ratio( 1 );


```

### [Subgroup Sample Size](#subgroup-sample-size)

**Syntax:** obj = Process Screening(...Subgroup Sample Size( number=5 )...)

**Description:** Specifies the number of observations in each subgroup. The minimum subgroup size is 2. "5" by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( Eval( 5 :: 132 ) ),
    Control Chart Type( "XBar and R" ),
    Subgroup Sample Size( 6 )
);


```

### [Summary](#summary)

**Syntax:** obj \<< Summary( state=0|1 )

**Description:** Shows or hides the summary table in the report. On by default.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Y( Eval( 5 :: 132 ) ),
    Subgroup Sample Size( 6 ),
    Summary( 0 )
);
Wait( 1 );
obj << Summary( 1 );


```

### [Target Index](#target-index)

**Syntax:** obj \<< Target Index( state=0|1 )

**Description:** Shows or hides the Target Index column in the summary table. This column contains the number of short-term standard deviations that the process average differs from the target value.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Target Index( 1 ) );


```

### [Test 1](#test-1)

**Syntax:** obj \<< Test 1( state=0|1 )

**Description:** Shows or hides the Test1 column in the summary table. This test is triggered when one point is more than three standard deviations from the center line. On by default.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 1( 0 ) );


```

### [Test 2](#test-2)

**Syntax:** obj \<< Test 2( state=0|1 )

**Description:** Shows or hides the Test2 column in the summary table. This test is triggered when nine or more consecutive points are on the same side of the center line.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 2( 1 ) );


```

### [Test 3](#test-3)

**Syntax:** obj \<< Test 3( state=0|1 )

**Description:** Shows or hides the Test3 column in the summary table. This test is triggered when six or more consecutive points are continually increasing or decreasing.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 3( 1 ) );


```

### [Test 4](#test-4)

**Syntax:** obj \<< Test 4( state=0|1 )

**Description:** Shows or hides the Test4 column in the summary table. This test is triggered when fourteen consecutive points alternate in direction: increasing and then decreasing or decreasing and then increasing.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 4( 1 ) );


```

### [Test 5](#test-5)

**Syntax:** obj \<< Test 5( state=0|1 )

**Description:** Shows or hides the Test5 column in the summary table. This test is triggered when two out of three consecutive points on the same side of the center line are more than two standard deviations from the center line.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 5( 1 ) );


```

### [Test 6](#test-6)

**Syntax:** obj \<< Test 6( state=0|1 )

**Description:** Shows or hides the Test6 column in the summary table. This test is triggered when four out of five consecutive points on the same side of the center line are more than one standard deviation from the center line.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 6( 1 ) );


```

### [Test 7](#test-7)

**Syntax:** obj \<< Test 7( state=0|1 )

**Description:** Shows or hides the Test7 column in the summary table. This test is triggered when fifteen consecutive points, on either side of the center line, are all within one standard deviation of the center line.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 7( 1 ) );


```

### [Test 8](#test-8)

**Syntax:** obj \<< Test 8( state=0|1 )

**Description:** Shows or hides the Test8 column in the summary table. This test is triggered when eight consecutive points, on either side of the center line, all fall beyond one standard deviation of the center line.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening( Y( :DIAMETER ), Grouping( :MACHINE, :Phase ), Test 8( 1 ) );


```

### [Test Action](#test-action)

**Syntax:** obj \<< Test Action( state=0|1 )

**Description:** Shows or hides the Action column in the summary table. This test is triggered when a point is greater than an Upper Action Limit or less than a Lower Action Limit. On by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Alarm Graph( 1 )
);
Wait( 1 );
obj << Test Action( 0 );


```

### [Test Alert](#test-alert)

**Syntax:** obj \<< Test Alert( state=0|1 )

**Description:** Shows or hides the Alert column in the summary table. This test is triggered when a point is greater than the Upper Alert Limit or less than the Lower Alert Limit.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Alarm Graph( 1 )
);
Wait( 1 );
obj << Test Alert( 1 );


```

### [Test Alert Increasing](#test-alert-increasing)

**Syntax:** obj \<< Test Alert Increasing( state=0|1 )

**Description:** Shows or hides the Alert Increasing column in the summary table. This column counts where the process is increasing and the previous point is above the upper alert limit or if a process is decreasing and the previous point is below the lower alert limit.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Environmental Monitor Sim.jmp" );
obj = dt << Process Screening(
    Process Variables( :Count ),
    Grouping( :Type, :Grade, :Site ),
    Control Chart Type( "Count" ),
    Time( :Time ),
    Show Charts as Selected( 1 ),
    Alarm Graph( 1 )
);
Wait( 1 );
obj << Test Alert Increasing( 0 );


```

### [Use Limits Table](#use-limits-table)

**Syntax:** obj = Process Screening(...Use Limits Table( state=0|1, data table, <options>)...)

**Description:** Imports historical control limits and specification limits from a data table.

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    )
);


```

### [Use Lower Limit](#use-lower-limit)

**Syntax:** obj = Process Screening(...Use Lower Limit( state=0|1 )...)

**Description:** Specifies whether to use the K-Sigma lower limit. This option is available only for Proportion charts.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp" );
dt << Process Screening(
    Process Variables( :N Defective ),
    n Trials( :N Units ),
    Time( :Day ),
    Control Chart Type( "Proportion" ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] ),
    Use Lower Limit( 1 )
);


```

### [Use Medians instead of Means](#use-medians-instead-of-means)

**Syntax:** obj = Process Screening(...Use Medians instead of Means( state=0|1 )...)

**Description:** Estimates the center line using the median of the observations to reduce the effect of outliers on tests.

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Use Medians instead of Means( 1 )
);


```

### [Use Upper Limit](#use-upper-limit)

**Syntax:** obj = Process Screening(...Use Upper Limit( state=0|1 )...)

**Description:** Specifies whether to use the K-Sigma upper limit. This option is available only for Proportion charts. On by default.

**JMP Version Added:** 19

```

dt = Open( "$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp" );
dt << Process Screening(
    Process Variables( :N Defective ),
    n Trials( :N Units ),
    Time( :Day ),
    Control Chart Type( "Proportion" ),
    Show Charts as Selected( 1 ),
    RowStates( [0 1] ),
    Use Upper Limit( 0 ),
    Use Lower Limit( 1 )
);


```

### [Within Sigma](#within-sigma)

**Syntax:** obj \<< Within Sigma( state=0|1 )

**Description:** Shows or hides the Within Sigma column in the summary table. This column contains an estimate of the standard deviation based on within subgroup variation. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening( Y( :NPN1, :PNP1, :PNP2, :NPN2 ), Within Sigma( 0 ) );
Wait( 1 );
obj << Within Sigma( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp" );
obj = dt << Process Screening(
    Process Variables( Column Group( "Processes" ) ),
    Control Chart Type( "Indiv and MR" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Process Screening(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Chart Options Drift Graph](#chart-options-drift-graph_1)

### [Item Messages](#item-messages_1)

#### [Circle Alarm Points](#circle-alarm-points)

**Syntax:** obj \<< Chart Options as Selected( Circle Alarm Points( state=0|1 ) ); obj \<< Chart Options for Selected( Circle Alarm Points( state=0|1 ) )

**Description:** Shows or hides red circles around points that are in an alarm state. The corresponding alarm code is shown next to each circled point. This option is not available for Drift Graphs. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All,
    Chart Options as Selected( Circle Alarm Points( 0 ) )
);
Wait( 1 );
obj << Chart Options as Selected( Circle Alarm Points( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Circle Alarm Points( 1 ) );


```

#### [Connect Points](#connect-points)

**Syntax:** obj \<< Chart Options as Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options for Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options Drift Graph( Connect Points( state=0|1 ) )

**Description:** Shows or hides lines that connect the points. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Connect Points( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options Drift Graph( Connect Points( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Connect Points( 0 ) );


```

#### [Dispersion Chart](#dispersion-chart)

**Syntax:** obj \<< Chart Options as Selected( Dispersion Chart( state=0|1 ) ); obj \<< Chart Options for Selected( Dispersion Chart( state=0|1 ) )

**Description:** Shows or hides a range, standard deviation, or moving range chart in addition to the control chart for each process. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Dispersion Chart( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Dispersion Chart( 1 ) );


```

#### [Frame Size](#frame-size)

**Syntax:** obj \<< Chart Options as Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options for Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options Drift Graph( Frame Size( width=500, height=170 ) )

**Description:** Sets the size of the graph. "500,170" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Frame Size( 500, 400 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Frame Size( 600, 200 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Frame Size( 300, 100 ) );


```

#### [Number of Plots Across](#number-of-plots-across)

**Syntax:** obj \<< Chart Options as Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options for Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options Drift Graph( Number of Plots Across( number=1 ) )

**Description:** Specifies the layout for the charts. "1" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Number of Plots Across( 2 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Number of Plots Across( 2 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Number of Plots Across( 4 ) );


```

#### [Remove](#remove_1)

**Syntax:** obj \<< Chart Options as Selected( Remove ); obj \<< Chart Options for Selected( Remove ); obj \<< Chart Options Drift Graph( Remove )

**Description:** Removes the charts from the report.

**JMP Version Added:** 14

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Remove );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Remove );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Remove );


```

#### [Show Centerline](#show-centerline)

**Syntax:** obj \<< Chart Options as Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options for Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Centerline( state=0|1 ) )

**Description:** Shows or hides a solid green line for the average of the process. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Centerline( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Centerline( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Centerline( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Centerline( 1 ) );


```

#### [Show Control Limits](#show-control-limits)

**Syntax:** obj \<< Chart Options as Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Control Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower control limits. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Control Limits( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Control Limits( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Control Limits( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Control Limits( 1 ) );


```

#### [Show Markers](#show-markers)

**Syntax:** obj \<< Chart Options as Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options for Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Markers( state=0|1 ) )

**Description:** Shows or hides the individual points on the charts.

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Markers( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options Drift Graph( Show Markers( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Show Markers( 1 ) );


```

#### [Show Spec Limits](#show-spec-limits)

**Syntax:** obj \<< Chart Options as Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Spec Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower specification limits as dotted blue lines.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Select All,
    Show Charts as Selected
);
Wait( 1 );
obj << Chart Options as Selected( Show Spec Limits( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Drift Graph Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Spec Limits( 1 ) );


```

**Chart Options for Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Show Charts for Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options for Selected( Show Spec Limits( 1 ) );


```

#### [Show Zones](#show-zones)

**Syntax:** obj \<< Chart Options as Selected( Show Zones( state=0|1 ) ); obj \<< Chart Options for Selected( Show Zones( state=0|1 ) )

**Description:** Shows or hides the one and two standard deviation zones on the charts. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( Show Zones( 1 ) ),
    Select All
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
obj << Chart Options for Selected( Show Zones( 1 ) );


```

#### [V Axis Label](#v-axis-label)

**Syntax:** obj \<< Chart Options as Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options for Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options Drift Graph( V Axis Label( state=0|1 ) )

**Description:** Shows or hides the vertical axis label on each chart. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( V Axis Label( 0 ) ),
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( V Axis Label( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( V Axis Label( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( V Axis Label( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( V Axis Label( 1 ) );


```

## [Chart Options Graphlet](#chart-options-graphlet_1)

### [Item Messages](#item-messages_2)

#### [Circle Alarm Points](#circle-alarm-points_1)

**Syntax:** obj \<< Chart Options as Selected( Circle Alarm Points( state=0|1 ) ); obj \<< Chart Options for Selected( Circle Alarm Points( state=0|1 ) )

**Description:** Shows or hides red circles around points that are in an alarm state. The corresponding alarm code is shown next to each circled point. This option is not available for Drift Graphs. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All,
    Chart Options as Selected( Circle Alarm Points( 0 ) )
);
Wait( 1 );
obj << Chart Options as Selected( Circle Alarm Points( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Circle Alarm Points( 1 ) );


```

#### [Connect Points](#connect-points_1)

**Syntax:** obj \<< Chart Options as Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options for Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options Drift Graph( Connect Points( state=0|1 ) )

**Description:** Shows or hides lines that connect the points. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Connect Points( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options Drift Graph( Connect Points( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Connect Points( 0 ) );


```

#### [Dispersion Chart](#dispersion-chart_1)

**Syntax:** obj \<< Chart Options as Selected( Dispersion Chart( state=0|1 ) ); obj \<< Chart Options for Selected( Dispersion Chart( state=0|1 ) )

**Description:** Shows or hides a range, standard deviation, or moving range chart in addition to the control chart for each process. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Dispersion Chart( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Dispersion Chart( 1 ) );


```

#### [Frame Size](#frame-size_1)

**Syntax:** obj \<< Chart Options as Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options for Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options Drift Graph( Frame Size( width=500, height=170 ) )

**Description:** Sets the size of the graph. "500,170" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Frame Size( 500, 400 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Frame Size( 600, 200 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Frame Size( 300, 100 ) );


```

#### [Number of Plots Across](#number-of-plots-across_1)

**Syntax:** obj \<< Chart Options as Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options for Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options Drift Graph( Number of Plots Across( number=1 ) )

**Description:** Specifies the layout for the charts. "1" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Number of Plots Across( 2 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Number of Plots Across( 2 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Number of Plots Across( 4 ) );


```

#### [Remove](#remove_2)

**Syntax:** obj \<< Chart Options as Selected( Remove ); obj \<< Chart Options for Selected( Remove ); obj \<< Chart Options Drift Graph( Remove )

**Description:** Removes the charts from the report.

**JMP Version Added:** 14

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Remove );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Remove );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Remove );


```

#### [Show Centerline](#show-centerline_1)

**Syntax:** obj \<< Chart Options as Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options for Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Centerline( state=0|1 ) )

**Description:** Shows or hides a solid green line for the average of the process. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Centerline( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Centerline( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Centerline( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Centerline( 1 ) );


```

#### [Show Control Limits](#show-control-limits_1)

**Syntax:** obj \<< Chart Options as Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Control Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower control limits. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Control Limits( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Control Limits( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Control Limits( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Control Limits( 1 ) );


```

#### [Show Markers](#show-markers_1)

**Syntax:** obj \<< Chart Options as Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options for Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Markers( state=0|1 ) )

**Description:** Shows or hides the individual points on the charts.

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Markers( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options Drift Graph( Show Markers( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Show Markers( 1 ) );


```

#### [Show Spec Limits](#show-spec-limits_1)

**Syntax:** obj \<< Chart Options as Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Spec Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower specification limits as dotted blue lines.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Select All,
    Show Charts as Selected
);
Wait( 1 );
obj << Chart Options as Selected( Show Spec Limits( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Drift Graph Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Spec Limits( 1 ) );


```

**Chart Options for Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Show Charts for Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options for Selected( Show Spec Limits( 1 ) );


```

#### [Show Zones](#show-zones_1)

**Syntax:** obj \<< Chart Options as Selected( Show Zones( state=0|1 ) ); obj \<< Chart Options for Selected( Show Zones( state=0|1 ) )

**Description:** Shows or hides the one and two standard deviation zones on the charts. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( Show Zones( 1 ) ),
    Select All
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
obj << Chart Options for Selected( Show Zones( 1 ) );


```

#### [V Axis Label](#v-axis-label_1)

**Syntax:** obj \<< Chart Options as Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options for Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options Drift Graph( V Axis Label( state=0|1 ) )

**Description:** Shows or hides the vertical axis label on each chart. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( V Axis Label( 0 ) ),
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( V Axis Label( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( V Axis Label( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( V Axis Label( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( V Axis Label( 1 ) );


```

## [Chart Options as Selected](#chart-options-as-selected_1)

### [Item Messages](#item-messages_3)

#### [Circle Alarm Points](#circle-alarm-points_2)

**Syntax:** obj \<< Chart Options as Selected( Circle Alarm Points( state=0|1 ) ); obj \<< Chart Options for Selected( Circle Alarm Points( state=0|1 ) )

**Description:** Shows or hides red circles around points that are in an alarm state. The corresponding alarm code is shown next to each circled point. This option is not available for Drift Graphs. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All,
    Chart Options as Selected( Circle Alarm Points( 0 ) )
);
Wait( 1 );
obj << Chart Options as Selected( Circle Alarm Points( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Circle Alarm Points( 1 ) );


```

#### [Connect Points](#connect-points_2)

**Syntax:** obj \<< Chart Options as Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options for Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options Drift Graph( Connect Points( state=0|1 ) )

**Description:** Shows or hides lines that connect the points. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Connect Points( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options Drift Graph( Connect Points( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Connect Points( 0 ) );


```

#### [Dispersion Chart](#dispersion-chart_2)

**Syntax:** obj \<< Chart Options as Selected( Dispersion Chart( state=0|1 ) ); obj \<< Chart Options for Selected( Dispersion Chart( state=0|1 ) )

**Description:** Shows or hides a range, standard deviation, or moving range chart in addition to the control chart for each process. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Dispersion Chart( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Dispersion Chart( 1 ) );


```

#### [Frame Size](#frame-size_2)

**Syntax:** obj \<< Chart Options as Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options for Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options Drift Graph( Frame Size( width=500, height=170 ) )

**Description:** Sets the size of the graph. "500,170" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Frame Size( 500, 400 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Frame Size( 600, 200 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Frame Size( 300, 100 ) );


```

#### [Number of Plots Across](#number-of-plots-across_2)

**Syntax:** obj \<< Chart Options as Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options for Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options Drift Graph( Number of Plots Across( number=1 ) )

**Description:** Specifies the layout for the charts. "1" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Number of Plots Across( 2 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Number of Plots Across( 2 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Number of Plots Across( 4 ) );


```

#### [Remove](#remove_3)

**Syntax:** obj \<< Chart Options as Selected( Remove ); obj \<< Chart Options for Selected( Remove ); obj \<< Chart Options Drift Graph( Remove )

**Description:** Removes the charts from the report.

**JMP Version Added:** 14

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Remove );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Remove );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Remove );


```

#### [Show Centerline](#show-centerline_2)

**Syntax:** obj \<< Chart Options as Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options for Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Centerline( state=0|1 ) )

**Description:** Shows or hides a solid green line for the average of the process. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Centerline( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Centerline( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Centerline( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Centerline( 1 ) );


```

#### [Show Control Limits](#show-control-limits_2)

**Syntax:** obj \<< Chart Options as Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Control Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower control limits. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Control Limits( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Control Limits( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Control Limits( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Control Limits( 1 ) );


```

#### [Show Markers](#show-markers_2)

**Syntax:** obj \<< Chart Options as Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options for Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Markers( state=0|1 ) )

**Description:** Shows or hides the individual points on the charts.

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Markers( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options Drift Graph( Show Markers( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Show Markers( 1 ) );


```

#### [Show Spec Limits](#show-spec-limits_2)

**Syntax:** obj \<< Chart Options as Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Spec Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower specification limits as dotted blue lines.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Select All,
    Show Charts as Selected
);
Wait( 1 );
obj << Chart Options as Selected( Show Spec Limits( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Drift Graph Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Spec Limits( 1 ) );


```

**Chart Options for Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Show Charts for Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options for Selected( Show Spec Limits( 1 ) );


```

#### [Show Zones](#show-zones_2)

**Syntax:** obj \<< Chart Options as Selected( Show Zones( state=0|1 ) ); obj \<< Chart Options for Selected( Show Zones( state=0|1 ) )

**Description:** Shows or hides the one and two standard deviation zones on the charts. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( Show Zones( 1 ) ),
    Select All
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
obj << Chart Options for Selected( Show Zones( 1 ) );


```

#### [V Axis Label](#v-axis-label_2)

**Syntax:** obj \<< Chart Options as Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options for Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options Drift Graph( V Axis Label( state=0|1 ) )

**Description:** Shows or hides the vertical axis label on each chart. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( V Axis Label( 0 ) ),
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( V Axis Label( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( V Axis Label( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( V Axis Label( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( V Axis Label( 1 ) );


```

## [Chart Options for Selected](#chart-options-for-selected_1)

### [Item Messages](#item-messages_4)

#### [Circle Alarm Points](#circle-alarm-points_3)

**Syntax:** obj \<< Chart Options as Selected( Circle Alarm Points( state=0|1 ) ); obj \<< Chart Options for Selected( Circle Alarm Points( state=0|1 ) )

**Description:** Shows or hides red circles around points that are in an alarm state. The corresponding alarm code is shown next to each circled point. This option is not available for Drift Graphs. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All,
    Chart Options as Selected( Circle Alarm Points( 0 ) )
);
Wait( 1 );
obj << Chart Options as Selected( Circle Alarm Points( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Circle Alarm Points( 1 ) );


```

#### [Connect Points](#connect-points_3)

**Syntax:** obj \<< Chart Options as Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options for Selected( Connect Points( state=0|1 ) ); obj \<< Chart Options Drift Graph( Connect Points( state=0|1 ) )

**Description:** Shows or hides lines that connect the points. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Connect Points( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options Drift Graph( Connect Points( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Markers( 1 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Connect Points( 0 ) );


```

#### [Dispersion Chart](#dispersion-chart_3)

**Syntax:** obj \<< Chart Options as Selected( Dispersion Chart( state=0|1 ) ); obj \<< Chart Options for Selected( Dispersion Chart( state=0|1 ) )

**Description:** Shows or hides a range, standard deviation, or moving range chart in addition to the control chart for each process. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Dispersion Chart( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Dispersion Chart( 1 ) );


```

#### [Frame Size](#frame-size_3)

**Syntax:** obj \<< Chart Options as Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options for Selected( Frame Size( width=500, height=170 ) ); obj \<< Chart Options Drift Graph( Frame Size( width=500, height=170 ) )

**Description:** Sets the size of the graph. "500,170" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Frame Size( 500, 400 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Frame Size( 600, 200 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Frame Size( 300, 100 ) );


```

#### [Number of Plots Across](#number-of-plots-across_3)

**Syntax:** obj \<< Chart Options as Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options for Selected( Number of Plots Across( number=1 ) ); obj \<< Chart Options Drift Graph( Number of Plots Across( number=1 ) )

**Description:** Specifies the layout for the charts. "1" by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Number of Plots Across( 2 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options Drift Graph( Number of Plots Across( 2 ) )
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Number of Plots Across( 4 ) );


```

#### [Remove](#remove_4)

**Syntax:** obj \<< Chart Options as Selected( Remove ); obj \<< Chart Options for Selected( Remove ); obj \<< Chart Options Drift Graph( Remove )

**Description:** Removes the charts from the report.

**JMP Version Added:** 14

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Remove );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Remove );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options for Selected( Remove );


```

#### [Show Centerline](#show-centerline_3)

**Syntax:** obj \<< Chart Options as Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options for Selected( Show Centerline( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Centerline( state=0|1 ) )

**Description:** Shows or hides a solid green line for the average of the process. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Centerline( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Centerline( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Centerline( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Centerline( 1 ) );


```

#### [Show Control Limits](#show-control-limits_3)

**Syntax:** obj \<< Chart Options as Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Control Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Control Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower control limits. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Control Limits( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Control Limits( 0 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( Show Control Limits( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( Show Control Limits( 1 ) );


```

#### [Show Markers](#show-markers_3)

**Syntax:** obj \<< Chart Options as Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options for Selected( Show Markers( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Markers( state=0|1 ) )

**Description:** Shows or hides the individual points on the charts.

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( Show Markers( 0 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options Drift Graph( Show Markers( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),

);
Wait( 1 );
obj << Chart Options for Selected( Show Markers( 1 ) );


```

#### [Show Spec Limits](#show-spec-limits_3)

**Syntax:** obj \<< Chart Options as Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options for Selected( Show Spec Limits( state=0|1 ) ); obj \<< Chart Options Drift Graph( Show Spec Limits( state=0|1 ) )

**Description:** Shows or hides the upper and lower specification limits as dotted blue lines.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Select All,
    Show Charts as Selected
);
Wait( 1 );
obj << Chart Options as Selected( Show Spec Limits( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Drift Graph Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options Drift Graph( Show Spec Limits( 1 ) );


```

**Chart Options for Selected Example**

```

dt1 = Open( "$SAMPLE_DATA/Cities.jmp" );
dt2 = Open( "$SAMPLE_DATA/CitySpecLimits.jmp" );
obj = dt1 << Process Screening(
    Y( :OZONE, :CO, :SO2, :NO ),
    Use Limits Table(
        1,
        dt2,
        Process Variables( :Column 1 ),
        LSL( :_LSL ),
        USL( :_USL ),
        Target( :_Target ),
        Go
    ),
    Show Charts for Selected( {:NO, :OZONE, :CO, :SO2} )
);
Wait( 1 );
obj << Chart Options for Selected( Show Spec Limits( 1 ) );


```

#### [Show Zones](#show-zones_3)

**Syntax:** obj \<< Chart Options as Selected( Show Zones( state=0|1 ) ); obj \<< Chart Options for Selected( Show Zones( state=0|1 ) )

**Description:** Shows or hides the one and two standard deviation zones on the charts. This option is not available for Drift Graphs.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( Show Zones( 1 ) ),
    Select All
);


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
obj << Chart Options for Selected( Show Zones( 1 ) );


```

#### [V Axis Label](#v-axis-label_3)

**Syntax:** obj \<< Chart Options as Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options for Selected( V Axis Label( state=0|1 ) ); obj \<< Chart Options Drift Graph( V Axis Label( state=0|1 ) )

**Description:** Shows or hides the vertical axis label on each chart. On by default.

**JMP Version Added:** 17

**Chart Options as Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts as Selected,
    Chart Options as Selected( V Axis Label( 0 ) ),
    Select All
);
Wait( 1 );
obj << Chart Options as Selected( V Axis Label( 1 ) );


```

**Chart Options Drift Graph Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Drift Graph Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    )
);
Wait( 1 );
obj << Chart Options Drift Graph( V Axis Label( 1 ) );


```

**Chart Options for Selected Example**

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
obj = dt << Process Screening(
    Y( :DIAMETER ),
    Grouping( :MACHINE, :Phase ),
    Show Charts for Selected(
        {{:DIAMETER, "C334", 2}, {:DIAMETER, "A455", 1}, {:DIAMETER, "A455", 2}, {:DIAMETER,
        "A386", 2}, {:DIAMETER, "A386", 1}, {:DIAMETER, "C334", 1}}
    ),
    Chart Options for Selected( V Axis Label( 0 ) )
);
Wait( 1 );
obj << Chart Options for Selected( V Axis Label( 1 ) );


```

# [Profiler](#profiler)

## [Associated Constructors](#associated-constructors)

### [Profiler](#profiler_1)

**Syntax:** Profiler( Y( column1, <column2>, ..., \<PredSE column1, PredSE column2>, ... ), <Expand> )

**Description:** Produces an interactive graph that enables you to explore how a predicted response changes as you change factor settings. For each factor, the profiler shows prediction traces that are based on saved predictions formulas and linear constraints and illustrate how the response changes with respect to that factor. The Expand argument corresponds to the Expand Intermediate Formulas option in the launch window.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);


```

**Example 2**

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
colNum = N Items( dt << Get Column Names );
obj = dt << Fit Model(
    Validation( :Validation ),
    Y( :Y ),
    Effects( :Age, :Gender, :BMI, :BP, :Total Cholesterol ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Effect Screening" ),
    Run()
);
obj << Save Columns( Prediction Formula( 1 ), StdErr Pred Formula( 1 ) );
obj << Close Window( 1 );
predCol = Column( dt, colNum + 1 );
stderrCol = Column( dt, colNum + 2 );
dt << Profiler(
    Y( predCol, stderrCol ),
    Profiler( 1, Confidence Intervals( 1 ), ),
    Use SE Formula( 1 )
);


```

**Example 3**

```

dt = Open( "$Sample_Data/Stochastic Optimization.jmp" );
dt << Profiler( Y( :Yield ), Profiler( 1, Desirability Functions( 1 ), ), Expand );


```

## [Columns](#columns)

### [Noise Factors](#noise-factors)

**Syntax:** obj = Profiler(...\<Noise Factors( column(s) )>...)

**Description:** Specifies noise factors, which must be columns that are ingredients to the formula columns. Noise factors are used to study robustness (or flatness) with respect to transmitted variation from these factors. The resulting profiler includes derivatives of the formulas with respect to the noise factors.

**Contour Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Contour Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Custom Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Custom Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

**Mixture Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Mixture Profiler( Y( :Pred Formula Y ), Noise Factors( :p1 ) );


```

**Profiler Example**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Noise Factors( :SILANE )
);


```

### [Prediction Formula](#prediction-formula)

**Syntax:** obj = Profiler(...Prediction Formula( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);


```

### [Y](#y)

**Syntax:** obj = Profiler(...Y( column(s) )...)

**Description:** Specifies the response columns that contain formulas.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);


```

## [Item Messages](#item-messages)

### [Adapt Y Axis](#adapt-y-axis)

**Syntax:** obj \<< Adapt Y Axis( state=0|1 )

**Description:** Rescales the vertical axis if the response is outside the axis range, so that the range of the response is included.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Maximize Desirability;
Wait( 1 );
obj << Adapt Y Axis;


```

### [Add Shapley graph scripts to data table](#add-shapley-graph-scripts-to-data-table)

**Syntax:** obj \<< Add Shapley graph scripts to data table( state=0|1 )

**Description:** Adds JSL Graph Builder bar chart scripts of the Shapley values by rows for each response in the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler(
    1,
    Add Shapley graph scripts to data table( 1 ),
    Save Shapley Values
));


```

### [Animation](#animation)

**Syntax:** obj \<< Animation( \<Tour Type( "Sequential"|("Single Factor",factorname)|"Random"|"Data Sequential"|"Data Random" )>, \<Speed(ticks)>, <Go>, <Stop> )

**Description:** Starts or stops the animation of the profiler. You can also specify how the animation cycles through factor combinations.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Animation( Tour Type( "Sequential" ), Go );
Wait( 3 );
obj << Animation( "Stop" );


```

### [Append Settings to Table](#append-settings-to-table)

**Syntax:** obj \<< Append Settings to Table

**Description:** Saves the settings of the current profiler as a new row at the end of the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Append Settings to Table;


```

### [Arrange in Rows](#arrange-in-rows)

**Syntax:** obj \<< Arrange in Rows( number )

**Description:** Specifies the number of plots that appear in a row.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
Wait( 2 );
obj << Arrange in Rows( 2 );


```

### [Broadcast Factor Settings](#broadcast-factor-settings)

**Syntax:** obj \<< Broadcast Factor Settings

**Description:** Sends the factor settings for the current profiler to all other profilers. This option does not link the profilers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 ),
    Term Value(
        SILICA( 1.75, Lock( 0 ), Show( 1 ) ),
        SILANE( 45.2, Lock( 0 ), Show( 1 ) ),
        SULFUR( 2.45, Lock( 0 ), Show( 1 ) )
    )
);
obj << Contour Profiler( 1 );
Wait( 1 );
obj << Broadcast Factor Settings;


```

### [Colorize](#colorize)

**Syntax:** obj \<< Colorize( matrix )

**Description:** Specifies a matrix of proportions between 0 for uncolored and 1 for dark red. The rows and columns of the matrix correspond to the Y and X variables in the Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Colorize( [.0 .4 .5, .1 .2 .3, .4 .5 .3, .5 .1 .1] );


```

### [Colorize Profiler](#colorize-profiler)

**Syntax:** subobj \<< Colorize Profiler

**Description:** Colors cells in the profiler by Total Effect importance indices using a red to white intensity scale.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Independent Uniform Inputs( 1 );
Wait( 1 );
subobj = (Report( obj )["Variable Importance: Independent Uniform Inputs"] <<
get scriptable object);
subobj << Colorize Profiler;


```

### [Combinations](#combinations)

**Syntax:** obj \<< Combinations( "Mixed"|"Two-Way"|"Many-Way" )

**Description:** Specifies the types of interactions that are shown as overlaid interaction curves in the profiler.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Overlaid Interactions( 1 );
Wait( 1 );
obj << Combinations( "Many-Way" );


```

### [Compute Shapley values for all rows](#compute-shapley-values-for-all-rows)

**Syntax:** obj \<< Compute Shapley values for all rows( state=0|1 )

**Description:** Computes the Shapley values for all rows in the data table, excluded and not excluded.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
r = dt << Select Rows( [5, 7, 8, 10] );
r << Exclude;
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler(
    1,
    Compute Shapley values for all rows( 1 ),
    Save Shapley Values
));


```

### [Conditional Predictions](#conditional-predictions)

**Syntax:** obj \<< Conditional Predictions( state=0|1 )

**Description:** Includes random effects when formulating the predicted value and profiles. This option is available only in the Fit Mixed personality of the Fit Model platform when random effects are included in the model.

```

dt = Open( "$SAMPLE_DATA/Animals.jmp" );
obj1 = dt << Run Script( "Repeated Measures Model" );
obj1 << Profiler( Conditional Predictions( 1 ) );


```

### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< Confidence Intervals( state=0|1 )

**Description:** Shows or hides 95% confidence intervals for the simulated means on the curves of the profiler graph. Available only if a Std Error formula is specified in the launch window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj1 = dt << Run Script( "RSM for 4 Responses" );
obj1 << Prediction Formula;
obj1 << StdErr Pred Formula;
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION 2, :Pred Formula MODULUS 2, :Pred SE ABRASION,
        :Pred SE MODULUS
    )
);
Wait( 1 );
obj << Confidence Intervals( 0 );


```

### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler( state=0|1 )

**Description:** Shows or hides the Contour Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Contour Profiler( 1 );


```

### [Converge Limit](#converge-limit)

**Syntax:** obj \<< Converge Limit( number )

**Description:** Specifies the criterion for convergence for the optimization algorithm. If the convergence criterion is less than this value for two consecutive iterations, the algorithm stops.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Converge limit( 0.0001 );
obj << Optimize;


```

### [Copy Settings Script](#copy-settings-script)

**Syntax:** obj \<< Copy Settings Script

**Description:** Copies the current factor settings to the clipboard. The settings can then be pasted into another profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Custom Profiler](#custom-profiler)

**Syntax:** obj \<< Custom Profiler( state=0|1 )

**Description:** Shows or hides the Custom Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Custom Profiler( 1 );


```

### [Data Points](#data-points)

**Syntax:** obj \<< Data Points( state=0|1 )

**Description:** Shows or hides the individual data points in the Prediction Profiler plot. The data points fade according to how far away they are from the plane of each profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Data Points( 1 );


```

### [Default N Grid Points](#default-n-grid-points)

**Syntax:** obj \<< Default N Grid Points( number )

**Description:** Sets the number of levels for each continuous factor.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Default N Grid Points( 5 );


```

### [Default N Levels](#default-n-levels)

**Syntax:** obj \<< Default N Levels( number )

### [Dependent Resampled Inputs](#dependent-resampled-inputs)

**Syntax:** obj \<< Dependent Resampled Inputs( state=0|1 )

**Description:** Calculates the indices that are used in the Assess Variable Importance option by resampling the data table assuming that the inputs are dependent.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Dependent Resampled Inputs( 1 );


```

### [Design Space](#design-space)

**Syntax:** obj \<< Design Space( state=0|1 )

### [Design Space Profiler](#design-space-profiler)

**Syntax:** obj \<< Design Space Profiler( state=0|1 )

**Description:** Launches the Design Space Profiler, which helps map specification limits on the Y variables to specification limits on the X variables.

```


dt = Open( "$Sample_Data/Tiretread.jmp" );
dt:Pred Formula ABRASION << Set Property( "Spec Limits", {LSL( 120 ), Show Limits( 1 )} );
dt:Pred Formula MODULUS << Set Property( "Spec Limits", {LSL( 1200 ), Show Limits( 1 )} );
dt:Pred Formula ELONG << Set Property(
    "Spec Limits",
    {LSL( 350 ), USL( 500 ), Show Limits( 1 )}
);
dt:Pred Formula HARDNESS << Set Property(
    "Spec Limits",
    {LSL( 65 ), USL( 75 ), Show Limits( 1 )}
);
dt:Pred Formula ABRASION << Set Property(
    "Predicting",
    {:ABRASION, Creator( "Fit Least Squares" ), RMSE( 3 )}
);
dt:Pred Formula MODULUS << Set Property(
    "Predicting",
    {:MODULUS, Creator( "Fit Least Squares" ), RMSE( 100 )}
);
dt:Pred Formula ELONG << Set Property(
    "Predicting",
    {:ELONG, Creator( "Fit Least Squares" ), RMSE( 10 )}
);
dt:Pred Formula HARDNESS << Set Property(
    "Predicting",
    {:HARDNESS, Creator( "Fit Least Squares" ), RMSE( .6 )}
);
Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Profiler( 1, Desirability Functions( 0 ), Design Space Profiler( 1 ) )
);


```

### [Desirability Functions](#desirability-functions)

**Syntax:** obj \<< Desirability Functions( state=0|1 )

**Description:** Shows or hides the desirability functions, which are useful when optimizing across several responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );


```

### [Edit Constraints](#edit-constraints)

**Syntax:** obj \<< Edit Constraints

**Description:** Adds, changes, or deletes linear constraints.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Edit Constraints;


```

### [Extrapolation Control Option](#extrapolation-control-option)

**Syntax:** obj \<< Extrapolation Control Option( "Off"|"On"|"Warning On" )

**Description:** Specifies if extrapolation control is turned on or off, or if only extrapolation control warnings are turned on.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Age, :Weight, :Runtime, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Profiler( Extrapolation Control Option( "On" ) );


```

### [Extrapolation Details](#extrapolation-details)

**Syntax:** obj \<< Extrapolation Details( state=0|1 )

**Description:** Shows or hides the extrapolation control details that give the extrapolation metric of the current point and the extrapolation threshold.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Fitness.jmp" );
obj = dt << Fit Model(
    Y( :Oxy ),
    Effects( :Age, :Weight, :Runtime, :RunPulse, :RstPulse, :MaxPulse ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run
);
obj << Profiler( Extrapolation Control Option( "On" ), Extrapolation Details( 1 ) );


```

### [Extrapolation Type Option](#extrapolation-type-option)

**Syntax:** obj \<< Extrapolation Type Option( "Regularized T2"|"K Nearest Neighbors" )

**JMP Version Added:** 18

### [Formulas for OPTMODEL](#formulas-for-optmodel)

**Syntax:** obj \<< Formulas for OPTMODEL

**Description:** Saves the prediction formulas from the model in a new file as SAS statements for PROC OPTMODEL.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Formulas for OPTMODEL;


```

### [Get Constraints](#get-constraints)

**Syntax:** obj \<< Get Constraints

**Description:** Returns a list of factor constraints.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Profiler(
    Y( :Pred Formula Y ),
    Profiler( 1, Profile at Boundary( "Stop at Boundaries" ), )
);
obj << Get Constraints;


```

### [Get Desirability](#get-desirability)

**Syntax:** obj \<< Get Desirability

**Description:** Returns the current desirability settings.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
d = obj << Get Desirability;
Show( d );


```

### [Get Factor Settings](#get-factor-settings)

**Syntax:** obj \<< Get Factor Settings

**Description:** Returns the current factor settings as a list.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Get Factor Settings;


```

### [Get Factor Settings Script](#get-factor-settings-script)

**Syntax:** obj \<< Get Factor Settings Script

**Description:** Returns the current factor settings as an expression that can be used in a script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Get Factor Settings Script;


```

### [Get Main Indices](#get-main-indices)

**Syntax:** obj \<< Get Main Indices

**Description:** Saves the main indices from the Assess Variable Importance analysis to a new file as SAS statements for PROC OPTMODEL.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Independent Resampled Inputs( 1 );
obj << Get Main Indices;


```

### [Get Simulator](#get-simulator)

**Syntax:** obj \<< Get Simulator

**Description:** Returns a reference to the Simulator.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ), SILANE << Fixed( 50 ),
        SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << Add Random Noise( 1 ),
        Pred Formula HARDNESS << Add Random Weighted Noise( 1 )
    )
);
obj2 = obj << Get Simulator;
obj2 << Simulation Experiment;


```

### [Get Total Indices](#get-total-indices)

**Syntax:** obj \<< Get Total Indices

**Description:** Saves the total indices from the Assess Variable Importance analysis to a new file as SAS statements for PROC OPTMODEL.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Independent Resampled Inputs( 1 );
obj << Get Total Indices;


```

### [Graph Spacing](#graph-spacing)

**Syntax:** obj \<< Graph Spacing( number )

**Description:** Sets the amount of horizontal space between graph panels.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
Wait( 2 );
obj << Graph Spacing( 20 );


```

### [Hide Desirability Row](#hide-desirability-row)

**Syntax:** obj \<< Hide Desirability Row( state=0|1 )

**Description:** Hides or unhides the row of desirability profiles.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Desirability Functions( 1 );
Wait( 1 );
obj << Hide Desirability Row( 1 );


```

### [Hide Y Variables](#hide-y-variables)

**Syntax:** obj \<< Hide Y Variables( Y columns )

**Description:** Specifies the response variables that you would like to show or hide in the profiler.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 0.5 );
obj << Hide Y Variables( :Pred Formula MODULUS );


```

### [Independent Resampled Inputs](#independent-resampled-inputs)

**Syntax:** obj \<< Independent Resampled Inputs( state=0|1 )

**Description:** Calculates the indices that are used in the Assess Variable Importance option by resampling the data table assuming that the inputs are independent.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Independent Resampled Inputs( 1 );


```

### [Independent Uniform Inputs](#independent-uniform-inputs)

**Syntax:** obj \<< Independent Uniform Inputs( state=0|1 )

**Description:** Calculates the indices that are used in the Assess Variable Importance option by resampling the data table assuming that the inputs have independent uniform distributions.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Independent Uniform Inputs( 1 );


```

### [Interaction Profiler](#interaction-profiler)

**Syntax:** obj \<< Interaction Profiler( state=0|1 )

**Description:** Shows or hides an interaction profiler for each response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Interaction Profiler( 1 );


```

### [Linearly Constrained Inputs](#linearly-constrained-inputs)

**Syntax:** obj \<< Linearly Constrained Inputs( state=0|1 )

**Description:** Calculates the indices that are used in the Assess Variable Importance option by resampling the data table over a uniform distribution defined by the linear constraints.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Script( "Constraint", {1 * :LDL + 1 * :HDL <= 250} );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Linearly Constrained Inputs( 1 );


```

### [Link Profilers](#link-profilers)

**Syntax:** obj \<< Link Profilers( state=0|1 )

**Description:** Links all the profilers in a single report together, so that a change in a factor in one profiler causes that factor to change to that value in all other profilers.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Prediction Profiler( 1 );
obj << Contour Profiler( 1 );
obj << Link Profilers( 1 );
Wait( 1 );
obj << Term Value( :Silica( 1.78 ), :Sulfur( 2.34 ) );


```

### [Load Constraints from Table](#load-constraints-from-table)

**Syntax:** obj \<< Load Constraints from Table

**Description:** Loads linear constraints from a data table.

```


dtlc = New Table( "Linear Constraints",
    Add Rows( 2 ),
    New Column( "SILICA", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 2] ) ),
    New Column( "SILANE", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [0, 0] ) ),
    New Column( "SULFUR", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 1] ) ),
    New Column( "Comparison", Character, "Nominal", Set Values( {">=", "<="} ) ),
    New Column( "RHS", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [3, 6] ) )
);
dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Load Constraints from Table( dtlc );
obj << Profile at Boundary( "Stop at Boundaries" );


```

### [Log Iterations](#log-iterations)

**Syntax:** obj \<< Log Iterations( state=0|1 )

**Description:** Creates a new data table that contains iterations of the optimization algorithm.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Log Iterations( 1 );
obj << Optimize;


```

### [Max Cycles](#max-cycles)

**Syntax:** obj \<< Max Cycles( number )

**Description:** Specifies the maximum number of cycles within each trip in the optimization algorithm.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Max Cycles( 5 );
obj << Optimize;


```

### [MaxIter](#maxiter)

**Syntax:** obj \<< MaxIter( number )

**Description:** Specifies the maximum number of iterations within each trip in the optimization algorithm.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << MaxIter( 10 );
obj << Optimize;


```

### [Maximize Desirability](#maximize-desirability)

**Syntax:** obj \<< Maximize Desirability

**Description:** Sets the current factor values to maximize the desirability functions.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
Wait( 2 );
obj << Maximize Desirability;


```

### [Maximize and Remember](#maximize-and-remember)

**Syntax:** obj \<< Maximize and Remember

**Description:** Maximizes the desirability functions and remembers the associated settings.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Maximize and Remember;


```

### [Maximize for Each Grid Point](#maximize-for-each-grid-point)

**Syntax:** obj \<< Maximize for Each Grid Point

**Description:** Maximizes the desirability functions for each grid point, holding one or more factors constant. This option requires locking at least one factor.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Term Value( SILANE( 60, Lock( 1 ) ) );
obj << Maximize For Each Grid Point;


```

### [Maximum Number of Curves](#maximum-number-of-curves)

**Syntax:** obj \<< Maximum Number of Curves( number=500 )

**Description:** Specifies the maximum number of curves to show when the Overlaid Interactions option is selected. If the total possible number of curves is greater than the specified maximum number of curves, an arbitrary sample is drawn. "500" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Overlaid Interactions( 1 );
Wait( 1 );
obj << Maximum Number of Curves( 100 );


```

### [Optimization Control Panel](#optimization-control-panel)

**Syntax:** obj \<< Optimization Control Panel( state=0|1 )

### [Output Grid Table](#output-grid-table)

**Syntax:** obj \<< Output Grid Table

**Description:** Creates a new data table that contains columns for the factors that contain grid values, columns for each of the responses with computed values at each grid point, and the desirability computation at each grid point.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Output Grid Table;


```

### [Output Random Table](#output-random-table)

**Syntax:** obj \<< Output Random Table( number of runs,<Add Random Noise> )

**Description:** Creates a new data table of random factor settings and predicted values over those factor settings for the specified number of runs. There is also an option to add random noise to the responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Output Random Table( 1000 );


```

### [Overlaid Interactions](#overlaid-interactions)

**Syntax:** obj \<< Overlaid Interactions( state=0|1 )

**Description:** Shows or hides faded curves in the Prediction Profiler plots. The faded curves represent the profilers for different types of interactions among the ranges of the factors.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Overlaid Interactions( 1 );


```

### [Paste Settings Script](#paste-settings-script)

**Syntax:** obj \<< Paste Settings Script

**Description:** Pastes the profiler settings from the clipboard to a profiler in another report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Set to Data in Row( 4 );
obj << Copy Settings Script;
obj2 = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj2 << Paste Settings Script;


```

### [Predict for Another Table](#predict-for-another-table)

**Syntax:** obj \<< Predict for Another Table( <data table> )

**Description:** Adds prediction columns to a specified data table, using the factors in that table. This option is available only for continuous responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
dt2 = dt << Subset(
    All rows,
    columns( :SILICA, :SILANE, :SULFUR ),
    Output Table( "Subset" )
);
obj << Predict For Another Table( dt2 );


```

### [Prediction Intervals](#prediction-intervals)

**Syntax:** obj \<< Prediction Intervals( state=0|1 )

**Description:** Shows or hides the 95% prediction intervals that include both the variation in estimating the model and the variation in the residual error.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << Fit Model(
    Y( :ELONG ),
    Effects( :SILICA, :SILANE, :SULFUR, :SILANE * :SILANE ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run(
        Profiler(
            1,
            Confidence Intervals( 1 ),
            Prediction Intervals( 1 ),
            Desirability Functions( 0 )
        ),
        :ELONG << {Summary of Fit( 0 ), Analysis of Variance( 0 ), Parameter Estimates( 1 ),
        Effect Tests( 0 ), Effect Details( 0 ), Lack of Fit( 0 ),
        Plot Actual by Predicted( 0 ), Plot Regression( 0 ), Plot Residual by Predicted( 0 ),
        Effect Summary( 0 )}
    )
);


```

### [Prediction Profiler](#prediction-profiler)

**Syntax:** obj \<< Prediction Profiler( state=0|1 )

**Description:** Shows or hides the Prediction Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Prediction Profiler( 1 );


```

### [Profile at Boundary](#profile-at-boundary)

**Syntax:** obj \<< Profile at Boundary( "Turn at Boundaries"|"Stop at Boundaries" )

**Description:** Identifies the boundary handling method for factors that have constraints. This option is available only for prediction models containing mixture variables, when there is a linear constraint, or when the Alter Linear Constraints option is specified.

```

dt = Open( "$SAMPLE_DATA/Design Experiment/Donev Mixture Data.jmp" );
obj1 = Fit Model(
    Y( :Damping ),
    Effects( :CuSO4 & RS & Mixture, :Na2S2O3 & RS & Mixture, :Glyoxal & RS & Mixture ),
    Personality( "Standard Least Squares" ),
    Run Model( 1 )
);
obj1 << Prediction Formula;
obj2 = Profiler( Y( :Pred Formula Damping ) );
Wait( 1 );
obj2 << Profile at Boundary( "Stop at Boundaries" );


```

### [Prop of Error Bars](#prop-of-error-bars)

**Syntax:** obj \<< Prop of Error Bars( state=0|1 )

**Description:** Shows or hides error bars on the profiler graph. This option is available only when the column contains a Sigma column property.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
:Pred Formula ABRASION << Set Property( Sigma, 5 );
:Pred Formula MODULUS << Set Property( Sigma, 100 );
obj = dt << Profiler( Y( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Prop of Error Bars( 1 );


```

### [Remember Settings](#remember-settings)

**Syntax:** obj \<< Remember Settings

**Description:** Adds an outline node to the report with the values of the factor settings.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Remember Settings;


```

### [Remove Profiler](#remove-profiler)

**Syntax:** scobj \<< Remove Profiler

**Description:** Removes the profiler from the platform report. This option is available only in a limited number of platforms.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Path Analysis w / Latent" );
rpt = obj << Report();
rpt["Model Specification"] << Close( 1 );
obj << Prediction Profiler(
    1,
    Confidence Intervals( 1 ),
    Term Value( Leadership( 0, Lock( 0 ), Show( 1 ) ), Conflict( 0, Lock( 0 ), Show( 1 ) ) ),
    Y Terms( Conflict, Satisfaction )
);
scobj = rpt[Outline Box( "Prediction Profiler" )] << Get Scriptable Object();
scobj << Remove Profiler;


```

### [Reorder X Variables](#reorder-x-variables)

**Syntax:** obj \<< Reorder X Variables( columns )

**Description:** Reorders the model main effects in the profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 2 );
obj << Reorder X Variables( :SULFUR, :SILANE, :SILICA );


```

### [Reorder Y Variables](#reorder-y-variables)

**Syntax:** obj \<< Reorder Y Variables( columns )

**Description:** Reorders the response variables.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 2 );
obj << Reorder Y Variables(
    :Pred Formula HARDNESS, :Pred Formula MODULUS, :Pred Formula ELONG
);


```

### [Reorder factors by main effect importance](#reorder-factors-by-main-effect-importance)

**Syntax:** subobj \<< Reorder factors by main effect importance

**Description:** Reorders the cells in the Prediction Profiler in accordance with the importance indices for the main effects.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Independent Uniform Inputs( 1 );
Wait( 1 );
subobj = (Report( obj )["Variable Importance: Independent Uniform Inputs"] <<
get scriptable object);
subobj << Reorder factors by main effect importance;


```

### [Reorder factors by total importance](#reorder-factors-by-total-importance)

**Syntax:** subobj \<< Reorder factors by total importance

**Description:** Reorders the cells in the Prediction Profiler in accordance with the total importance indices for the factors.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
fit = Neural(
    Y( :Y ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
fit << Save Formulas;
obj = Profiler( Y( :Predicted Y ), Expand );
obj << Independent Uniform Inputs( 1 );
subobj = (Report( obj )["Variable Importance: Independent Uniform Inputs"] <<
get scriptable object);
subobj << Reorder factors by main effect importance;
Wait( 1 );
subobj << Reorder factors by total importance;


```

### [Reset](#reset)

**Syntax:** obj \<< Reset

**Description:** Resets the desirability functions.

### [Reset Factor Grid](#reset-factor-grid)

**Syntax:** obj \<< Reset Factor Grid

### [Reset Factors](#reset-factors)

**Syntax:** obj \<< Reset Factors

**Description:** Opens a window for changing the factor grid.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Reset Factor Grid;


```

### [Response Limits](#response-limits)

**Syntax:** Pred Y \<< Response Limits( {Lower( value, fraction ), Middle( value, fraction ), Upper( value, fraction ), Goal( Minimize|Maximize|Target ), Importance( number )} )

**Description:** Sets the desirability function settings for an individual response as well as the associated desirability values.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Pred Formula ABRASION << Response Limits(
        {Lower( 90, 0.9819 ), Middle( 145, 0.5 ), Upper( 200, 0.066 ), Goal( Minimize ),
        Importance( 1 )}
    )
);
obj << Desirability Functions( 1 );


```

### [Samples per Factor](#samples-per-factor)

**Syntax:** obj \<< Samples per Factor( number=6 )

**Description:** Specifies the number of sample values taken for each continuous factor for two-way interactions. This value is reduced for many-way interactions and is conditional on the maximum number of curves. "6" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Overlaid Interactions( 1 );
Wait( 1 );
obj << Samples per Factor( 10 );


```

### [Save Bagged Predictions](#save-bagged-predictions)

**Syntax:** obj \<< Save Bagged Predictions( nsample, Random Seed(number), Fractional Weights(0|1), Save Prediction Formulas(0|1) )

**Description:** Uses bootstrap aggregating (bagging) to make predictions and saves the bagged prediction means and standard errors to the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Neural(
    Y( :ABRASION, :MODULUS, :ELONG, :HARDNESS ),
    X( :SILICA, :SILANE, :SULFUR ),
    Crossvalidation( No Crossvalidation ),
    Go
);
obj << Profiler( Save Bagged Predictions( 10 ) );


```

### [Save Constraints to New Table](#save-constraints-to-new-table)

**Syntax:** obj \<< Save Constraints to New Table

**Description:** Saves existing linear constraints to a new data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Script(
    "Constraint",
    {1 * :SILICA + 1 * :SULFUR >= 3, 2 * :SILICA + 1 * :SULFUR <= 6}
);
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Constraints to New Table;


```

### [Save Constraints to Table Script](#save-constraints-to-table-script)

**Syntax:** obj \<< Save Constraints to Table Script

**Description:** Saves existing linear constraints to a table script called Constraint.

```

dtlc = New Table( "Linear Constraints",
    Add Rows( 2 ),
    New Column( "SILICA", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 2] ) ),
    New Column( "SILANE", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [0, 0] ) ),
    New Column( "SULFUR", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [1, 1] ) ),
    New Column( "Comparison", Character, "Nominal", Set Values( {">=", "<="} ) ),
    New Column( "RHS", Numeric, "Continuous", Format( "Best", 12 ), Set Values( [3, 6] ) )
);
dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Load Constraints from Table( dtlc );
obj << Save Constraints to Table Script;


```

### [Save Desirabilities](#save-desirabilities)

**Syntax:** obj \<< Save Desirabilities

**Description:** Saves the three desirability function settings for each response, as well as the associated desirability values, as a Response Limits column property in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Save Desirabilities;


```

### [Save Desirability Formula](#save-desirability-formula)

**Syntax:** obj \<< Save Desirability Formula

**Description:** Saves a new formula column in the data table. The new column contains a formula for the combined desirability across the responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Save Desirability Formula;


```

### [Save Expanded Formulas](#save-expanded-formulas)

**Syntax:** obj \<< Save Expanded Formulas

**Description:** Saves a new formula column to the data table. The new column contains resolved formula references within the formulas used as Y variables to see the underlying variables. This is available only after the Expand Intermediate Formulas option is selected in the launch window or the Expand message is specified in the Profiler script.

```

dt = Open( "$SAMPLE_DATA/Nonlinear Examples/CES Production Function.jmp" );
obj = dt << Profiler( Y( :GP Fit, :NL Fit, :Difference ), Expand, Contour Profiler( 1 ) );
obj << Save Expanded Formulas;


```

### [Save Shapley Values](#save-shapley-values)

**Syntax:** obj \<< Save Shapley Values

**Description:** Calculates Shapley values for each row in the data table that is not excluded.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler( 1, Save Shapley Values ));


```

### [Sensitivity Indicator](#sensitivity-indicator)

**Syntax:** obj \<< Sensitivity Indicator( state=0|1 )

**Description:** Shows or hides a purple triangle that can help quickly spot sensitive cells in large profiles. The triangle's height and direction correspond to the value of the partial derivative of the profile function at its current value.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Sensitivity Indicator( 1 );


```

### [Set Desirabilities](#set-desirabilities)

**Syntax:** obj \<< Set Desirabilities

**Description:** Opens the Response Goal window where you can set specific desirability values.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Set Desirabilities;


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( Function( {arguments}, \<{locals}>, expr ) )

**Description:** Sets a script that is run each time a factor changes.

```

ProfileCallbackLog = Function( {arg}, Show( arg ) );
dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Set Script( ProfileCallbackLog );
obj << Term Value( :Silica( 1 ) );


```

### [Set Threshold Criterion](#set-threshold-criterion)

**Syntax:** obj \<< Set Threshold Criterion( Extrapolation Control Criterion( "Num Model Terms / Num Observations " | "Maximum Leverage" ), <multiplier> )

**Description:** Can be used to specify the general extrapolation threshold multiplier. Alternatively, you can use this function to open a window that enables you to adjust the extrapolation threshold multiplier.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Neural(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Informative Missing( 0 ),
    Validation Method( "Holdback", 0.3333 ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler(
    1,
    Desirability Functions( 1 ),
    Extrapolation Details( 1 ),
    Extrapolation Control Option( "Warning On" ),
    Set Threshold Criterion( General Extrapolation Control Multiplier( 4 ) )
));


```

### [Set to Data in Row](#set-to-data-in-row)

**Syntax:** obj \<< Set to Data in Row( row number )

**Description:** Assigns the values of a data table row to the X variables in the profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
Wait( 2 );
obj << Set to Data in Row( 4 );


```

### [Shapley Background Data Choice](#shapley-background-data-choice)

**Syntax:** obj \<< Shapley Background Data Choice( "Percent training data set"|"Number of rows of training data set" )

**Description:** Specifies the background data in the Shapley computations as either a percentage of the training data or a number of rows of the training data.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler(
    1,
    Shapley Background Data Choice( Number of rows of training data set ),
    Shapley Number of Rows of Training Data( 150 ),
    Save Shapley Values
));


```

### [Shapley Number of Permutations](#shapley-number-of-permutations)

**Syntax:** obj \<< Shapley Number of Permutations( number=10 )

**Description:** Sets the number of permutations to be used for calculating the Shapley values. "10" by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler( 1, Shapley Number of Permutations( 15 ), Save Shapley Values ));


```

### [Shapley Number of Rows of Training Data](#shapley-number-of-rows-of-training-data)

**Syntax:** obj \<< Shapley Number of Rows of Training Data( number=100 )

**Description:** Sets the number of rows of the training data that was used to fit the model for use as the background data in the Shapley computations. "100" by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler(
    1,
    Shapley Background Data Choice( Number of rows of training data set ),
    Shapley Number of Rows of Training Data( 125 ),
    Save Shapley Values
));


```

### [Shapley Percent Training Data](#shapley-percent-training-data)

**Syntax:** obj \<< Shapley Percent Training Data( number=100 )

**Description:** Sets the percentage of the training data that was used to fit the model for use as the background data in the Shapley computations. "100" by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler(
    1,
    Shapley Background Data Choice( Percent training data set ),
    Shapley Percent Training Data( 50 ),
    Save Shapley Values
));


```

### [Shapley Set Random Seed](#shapley-set-random-seed)

**Syntax:** obj \<< Shapley Set Random Seed( number )

**Description:** Sets a random seed for calculating the Shapley values.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Body Fat.jmp" );
obj = dt << Neural(
    Y( :Percent Body Fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n, :"Height (inches)"n, :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n, :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n, :"Thigh circumference (cm)"n, :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n, :"Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n, :"Wrist circumference (cm)"n
    ),
    Validation Method( :Validation ),
    Set Random Seed( 123 ),
    Fit( NTanH( 3 ) )
);
obj << (Fit[1] << Profiler( 1, Shapley Set Random Seed( 12345 ), Save Shapley Values ));


```

### [Show Creator](#show-creator)

**Syntax:** obj \<< Show Creator( state=0|1 )

**Description:** Shows or hides the name of the platform that created the formula in the response column. The platform name appears on the vertical axis. Available only if the response column contains a Creator named argument in the Predicting column property.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Drug.jmp" );
fm = dt << Fit Model(
    Y( :y ),
    Effects( :Drug, :x, :Drug * :x ),
    Personality( "Standard Least Squares" ),
    Emphasis( "Minimal Report" ),
    Run(
        :y << {Summary of Fit( 0 ), Analysis of Variance( 0 ), Parameter Estimates( 1 ),
        Effect Tests( 0 ), Effect Details( 0 ), Lack of Fit( 0 ), Scaled Estimates( 0 ),
        Plot Actual by Predicted( 0 ), Plot Regression( 0 ), Plot Residual by Predicted( 0 ),
        Plot Studentized Residuals( 0 ), Plot Effect Leverage( 0 ),
        Plot Residual by Normal Quantiles( 0 ), Box Cox Y Transformation( 0 )},
        Effect Summary( 0 )
    )
);

predForm = fm << Save Columns( "Prediction Formula" );

Profiler( Y( predForm ), Show Creator( 1 ) );


```

### [Show Formulas](#show-formulas)

**Syntax:** obj \<< Show Formulas

**Description:** Opens a script window that contains JSL for all formulas that are being profiled.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Show Formulas;


```

### [Simulator](#simulator)

**Syntax:** obj \<< Simulator( state=0|1 )

**Description:** Shows or hides the Simulator.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Simulator( 1 );


```

### [Spanning Range](#spanning-range)

**Syntax:** obj \<< Spanning Range( "Inner Axis Range"|"Full Axis Range"|"One Standard Deviation"|"Two Standard Deviations"|"Data Range" )

**Description:** Specifies how the sampling range of each continuous factor is determined. The sampling range for each factor defines the lowest and highest values for which the interaction curves are created.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Overlaid Interactions( 1 );
Wait( 1 );
obj << Spanning Range( "Two Standard Deviations" );


```

### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler( state=0|1 )

**Description:** Shows or hides the Surface Profiler.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Surface Profiler( 1 );


```

### [Term Value](#term-value)

**Syntax:** obj \<< Term Value( factor( current value, \<Lock( 0|1 )>, \<Min( number )>, \<Max( number)> ) )

**Description:** Specifies settings for individual factors, including the current value, lock status, and range.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
Wait( 2 );
obj << Term Value( SILANE( 60, Lock( 1 ) ) );


```

### [Trips](#trips)

**Syntax:** obj \<< Trips( number )

**Description:** Specifies the number of random starts in the optimization algorithm. Each trip restarts the algorithm at a different starting point.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Trips( 10 );
obj << Optimize;


```

### [Unthreaded](#unthreaded)

**Syntax:** obj \<< Unthreaded( state=0|1 )

**Description:** To suppress any multithreading in evaluating the profile traces, the contour grid, and the optimizer trips.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Desirability Functions( 1 );
obj << Unthreaded( 1 );
obj << Maximize Desirability;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Desirability Functions( 1 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [Design Space Profiler](#design-space-profiler_1)

### [Associated Constructors](#associated-constructors_1)

#### [Design Space Profiler](#design-space-profiler_2)

**Syntax:** Design Space Profiler

**Description:** Launches the Design Space Profiler, which helps map specification limits on the Y variables to specification limits on the X variables.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );


```

### [Item Messages](#item-messages_1)

#### [Connect Hide Mode](#connect-hide-mode)

**Syntax:** obj \<< Connect Hide Mode( state=0|1 )

**Description:** For the connected table, instead of selecting points that fall within the limits, this option hides points that fall outside of the limits.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Connect Hide Mode( 1 );
dt2 = obj2 << Make and Connect Random Table( 10000, Add Random Noise );
dt2 << Run Script( (dt2 << Get Table Script Names)[1] );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );


```

#### [Connect to Table](#connect-to-table)

**Syntax:** obj \<< Connect to Table( data table )

**Description:** Connects the Design Space Profiler report to the specified data table. The rows that contain factors that are within the current lower and upper limits are selected in the connected table.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
dt2 = obj << Output Random Table( 10000, Add Random Noise );
dt2 << Run Script( (dt2 << Get Table Script Names)[1] );
obj2 << Connect to Table( dt2 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );


```

#### [Error StdDev](#error-stddev)

**Syntax:** obj \<< Error StdDev( Set Error StdDev(colume name(value),...) )

**Description:** Sets the standard deviation used to simulate the error for the responses.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Error StdDev( Pred Formula Yield( 2.0 ) );


```

#### [Get Midpoints from Profiler](#get-midpoints-from-profiler)

**Syntax:** obj \<< Get Midpoints from Profiler( fraction )

**Description:** Obtains the current factor settings from the Prediction Profiler and sets the midpoints for each factor in the Design Space Profiler to those values. Limits are constructed around each midpoint value using a specified fraction of the factor range.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Get Midpoints from Profiler( 0.5 );


```

#### [Lock](#lock)

**Syntax:** obj \<< Lock( Lock(colume name(lock_value),...) )

**Description:** Locks the continuous factor at the specified value. This lock is temporary.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Lock( Ethanol( 5 ) );


```

#### [Make and Connect Random Table](#make-and-connect-random-table)

**Syntax:** obj \<< Make and Connect Random Table( number, \<Add Random Noise( state=0|1 )>, <Embed Factor Space Scatterplots>, <Embed Response Space Scatterplots> )

**Description:** Creates a new data table that contains uniformly distributed factor settings and their corresponding simulated responses. There are options to specify how the responses are simulated and whether to embed response and factor scatterplots in the report. The selection of rows in the data table is connected to the profilers in the report.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
dt2 = obj2 << Make and Connect Random Table(
    10000,
    Add Random Noise( 1 ),
    Embed Factor Space Scatterplots
);
Wait( 1 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );


```

#### [Move Corner Inward](#move-corner-inward)

**Syntax:** obj \<< Move Corner Inward

#### [Move Corner Outward](#move-corner-outward)

**Syntax:** obj \<< Move Corner Outward

#### [Move Inward](#move-inward)

**Syntax:** obj \<< Move Inward( \<number=1> )

**Description:** Finds the specification limit with the steepest upward path and moves that specification limit inward. Use the optional number argument to specify how many times this process is performed.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Move Inward( 4 );
Wait( 2 );
obj2 << Move Outward;


```

#### [Move Outward](#move-outward)

**Syntax:** obj \<< Move Outward( \<number=1> )

**Description:** Finds the specification limit with the least steep downward path and moves that specification limit outward. Use the optional number argument to specify how many times this process is performed.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );
obj2 << Move Outward( 2 );
Wait( 2 );
obj2 << Move Outward;


```

#### [Reset Factor Space](#reset-factor-space)

**Syntax:** obj \<< Reset Factor Space( factor1( lower, upper ), factor2( lower, upper ), ... )

**Description:** Changes the factor space to narrow, widen, or shift the range of one or more factors. If the intervals of the limits are too narrow, this can result in a small limits volume and create inaccurate simulation-based estimates.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
Wait( 1 );
obj2 << Reset Factor Space(
    Butanol( -0.275, 11 ),
    Ethanol( -0.25, 10.25 ),
    Methanol( -0.25, 10.25 ),
    Propanol( -0.25, 10.25 ),
    Time( 0.95, 3 )
);


```

#### [Save Simulation Table](#save-simulation-table)

**Syntax:** obj \<< Save Simulation Table( state=0|1 )

#### [Save X Spec Limits](#save-x-spec-limits)

**Syntax:** obj \<< Save X Spec Limits

**Description:** Saves the current X specification limits as column properties.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );
obj2 << Save X Spec Limits;


```

#### [Send Limits to Profiler as Constraints](#send-limits-to-profiler-as-constraints)

**Syntax:** obj \<< Send Limits to Profiler as Constraints

**Description:** Sends the current X limits to the Profiler as bound constraints.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );
obj2 << Send Limits to Profiler as Constraints;


```

#### [Send Limits to Simulator](#send-limits-to-simulator)

**Syntax:** obj \<< Send Limits to Simulator( "Uniform" | "Normal with limits at 2 sigma" | "Normal with limits at 3 sigma" | "Normal weighted with limits at 2 sigma" | "Normal weighted with limits at 3 sigma" )

**Description:** Sends the current X limits to the Simulator as parameters to a specified distribution. Also sends the Error StdDev values for each response as the standard deviation for added random noise.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );
obj2 << Send Limits to Simulator( "Normal with Limits at 3 Sigma" );


```

#### [Send Midpoints to Profiler](#send-midpoints-to-profiler)

**Syntax:** obj \<< Send Midpoints to Profiler

**Description:** Sends the midpoints for the current X limits to the Profiler.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );
obj2 << Send Midpoints to Profiler;


```

#### [Set Limits](#set-limits)

**Syntax:** obj \<< Set Limits( Set Limits(colume name(lower limit,upper limit),...) )

**Description:** Sets the factor limits using a script.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Set Limits( Ethanol( 1.9, 10 ), Methanol( 4.5, 10 ), Time( 1.2, 2 ) );


```

#### [Show Corners](#show-corners)

**Syntax:** obj \<< Show Corners( state=0|1 )

**Description:** Shows or hides the Corners report. This report contains a table of the in-specification probabilities at the extremes of the factor space. The probabilities are calculated using a normal distribution centered at the predicted values and cut at the specification limits.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Show Corners;


```

#### [Show Current Profiler Values](#show-current-profiler-values)

**Syntax:** obj \<< Show Current Profiler Values( state=0|1 )

**Description:** Shows the current value from the profiler as a vertical gray sparse-dotted line.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Show Current Profiler Values( 1 );


```

#### [Show Impact Ratios](#show-impact-ratios)

**Syntax:** obj \<< Show Impact Ratios( state=0|1 )

**Description:** Shows or hides the impact ratios. These ratios show how sensitive changes in each factor, from midpoint to each limit, affect how far the predictions are from their specification limits.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 30 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.8 )} )
);
obj = Profiler( Y( :Pred Formula Yield ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Show Impact Ratios;


```

#### [Show Portion for Each Response](#show-portion-for-each-response)

**Syntax:** obj \<< Show Portion for Each Response( state=0|1 )

**Description:** Adds a column that contains the in-specification portion for each response at the current X limits.

```


Open( "$Sample_Data/Design Experiment/Extraction Data.jmp" );
New Column( "Pred Formula Yield",
    Numeric,
    Continuous,
    Formula(
        42.69 + -0.347 * :Butanol - 6.650 * :Ethanol - 2.286 * :Methanol - 0.326 * :Propanol
         - 10.380 * :Time + 0.415 * :Methanol ^ 2 + 0.0467 * :Butanol * :Methanol + 0.111 *
        :Ethanol * :Propanol + 4.313 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {LSL( 26 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 12321 ), Std Dev( 2.1 )} )
);
New Column( "Pred Formula Impurities",
    Numeric,
    Continuous,
    Formula(
        0.3 + -0.08 * :Ethanol + 0.06 * :Propanol + 0.12 * :Time + 0.06 * :Ethanol * :Time
    ),
    Set Property( "Spec Limits", {USL( 1 ), Show Limits( 1 )} ),
    Set Property( "Predicting", {:Yield, Creator( "DEMO" ), ID( 24642 ), Std Dev( 0.2 )} )
);
obj = Profiler( Y( :Pred Formula Yield, :Pred Formula Impurities ) );
obj2 = obj << Design Space Profiler( 1 );
obj2 << Show Portion for Each Response( 1 );
obj2 << Set Limits( Methanol( 5, 10 ), Propanol( 0, 5 ) );


```

## [Simulator](#simulator_1)

### [Associated Constructors](#associated-constructors_2)

#### [Simulator](#simulator_2)

**Syntax:** obj \<< Simulator( state=0|1, \<Factors( column \<< Random( )|Fixed( constant )| Expression( )| Multivariate( ) )>, \<Responses( column \<< No Noise| Add Random Noise| Add Random Weighted Noise| Add Multivariate Noise ) )>

**Description:** Launches the Simulator.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    )
);


```

### [Item Messages](#item-messages_2)

#### [Automatic Histogram Update](#automatic-histogram-update)

**Syntax:** simuobj \<< Automatic Historgram Update( state=0|1 )

**Description:** Updates the histogram with new simulated values when the distributions of the factors change.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    ),
    Simulate
);
simobj = obj << Get Simulator;
simobj << Automatic Histogram Update( 1 );
Wait( 1 );
obj << Term Value( SILANE( 60, Lock( 1 ) ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    ),
    Automatic Histogram Update( 1 ),
    Simulate
);
Wait( 1 );
obj << Term Value( SILANE( 60, Lock( 1 ) ) );


```

#### [Defect Parametric Profile](#defect-parametric-profile)

**Syntax:** simobj \<< Defect Parametric Profile( state=0|1 )

**Description:** Graphs the mean defect rate by distributional parameters. This option is available only after the Defect Profiler is selected.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
:Pred Formula ABRASION << Set Property( "Spec Limits", {LSL( 110 )} );
:Pred Formula MODULUS << Set Property( "Spec Limits", {LSL( 750 ), USL( 1700 )} );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Simulator(
        1,
        Factors(
            SILICA << Random( Normal( 1.25, 0.3266 ) ),
            SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
        ),
        Responses(
            Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
            Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
        ),
        Defect Profiler( 1 ),
        Simulate
    )
);

simobj = obj << Get Simulator;
simobj << Defect Parametric Profile( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
:Pred Formula ABRASION << Set Property( "Spec Limits", {LSL( 110 )} );
:Pred Formula MODULUS << Set Property( "Spec Limits", {LSL( 750 ), USL( 1700 )} );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Simulator(
        1,
        Factors(
            SILICA << Random( Normal( 1.25, 0.3266 ) ),
            SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
        ),
        Responses(
            Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
            Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
        ),
        Defect Profiler( 1 ),
        Defect Parametric Profile( 1 ),
        Simulate
    )
);


```

#### [Defect Profiler](#defect-profiler)

**Syntax:** simobj \<< Defect Profiler( state=0|1 )

**Description:** Shows the defect rate as an isolated function of each factor. This option is available only if specification limits are defined.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
:Pred Formula ABRASION << Set Property( "Spec Limits", {LSL( 110 )} );
:Pred Formula MODULUS << Set Property( "Spec Limits", {LSL( 750 ), USL( 1700 )} );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Simulator(
        1,
        Factors(
            SILICA << Random( Normal( 1.25, 0.3266 ) ),
            SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
        ),
        Responses(
            Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
            Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
        ),
        Simulate
    )
);
simobj = obj << Get Simulator;
simobj << Defect Profiler( 1 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
:Pred Formula ABRASION << Set Property( "Spec Limits", {LSL( 110 )} );
:Pred Formula MODULUS << Set Property( "Spec Limits", {LSL( 750 ), USL( 1700 )} );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Simulator(
        1,
        Factors(
            SILICA << Random( Normal( 1.25, 0.3266 ) ),
            SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
        ),
        Responses(
            Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
            Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
        ),
        Defect Profiler( 1 ),
        Simulate
    )
);


```

#### [N Runs](#n-runs)

**Syntax:** obj \<< Simulator( N Runs(number=1000) )

**Description:** Sets the number of runs for the simulation. "10000" by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    ),

);
obj << Simulator( N Runs( 2500 ), Simulate );


```

#### [Resimulate](#resimulate)

**Syntax:** simobj \<< Resimulate

**Description:** Reruns the simulation. This option is useful after any changes to the distributions of the factors have been made.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Simulate
);
Wait( 1 );
obj << Term Value( SILANE( 60, Lock( 1 ) ) );
simobj = obj << Get Simulator;
simobj << Resimulate;


```

#### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Simulator( Set Random Seed( number ) )

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    ),

);
obj << Simulator( Set Random Seed( 1234 ), Simulate );


```

#### [Simulate to table](#simulate-to-table)

**Syntax:** simobj \<< Simulate To Table(N Runs(n),factorName\<<Sequence Location(low,high,nSteps),factorName2\<<Sequence Spread(low,high,nSteps),factorName3\<<Not Sequenced)

**Description:** Creates a table of simulation results, sequenced across different means or spreads.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    )
);
simobj = obj << Get Simulator;
simobj << Simulate to table(
    N Runs( 20 ),
    SILICA << Sequence Location( .5, 2, 4 ),
    SILANE << Sequence Location( 35, 65, 4 ),
    SULFUR << Sequence Location( 1.5, 3, 4 )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    )
);
obj << Simulator(
    Simulate to table(
        N Runs( 20 ),
        SILICA << Sequence Location( .5, 2, 4 ),
        SILANE << Sequence Location( 35, 65, 4 ),
        SULFUR << Sequence Location( 1.5, 3, 4 )
    )
);


```

#### [Simulation Experiment](#simulation-experiment)

**Syntax:** simobj \<< Simulation Experiment( NRun(number of experimental runs=128), Portion(factor space portion=1),NSim(number of simulations per experimental run=10000),<Run>,\<Selected Factors(factor1,..)> )

**Description:** Runs a designed simulation experiment based on the locations of the factor distributions within the model.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    )
);
simobj = obj << Get Simulator;
simobj << Simulation Experiment( NRun( 100 ), Portion( 0.6 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    )
);
obj << Simulator( Simulation Experiment( NRun( 128 ), NSim( 20000 ), Portion( 1.0 ), Run ) );


```

#### [X Correlations](#x-correlations)

**Syntax:** obj \<< Simulator( X Correlations( state=0|1, {factor1, factor2, ..., factorN}, [NxN correlations] ) )

**Description:** Sets the correlations on the X factors when the simulation setting for the factors is set to Multivariate.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Multivariate( 1.2, 0.3266 ), SILANE << Multivariate( 50, 6.532 ),
        SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << No Noise, Pred Formula MODULUS << No Noise,
        Pred Formula ELONG << No Noise, Pred Formula HARDNESS << No Noise
    ),
    Automatic Histogram Update( 1 ),
    X Correlations( 1, {SILICA, SILANE, SULFUR}, [1 0.3 0, 0.3 1 0, 0 0 1] ),
    Simulate
);


```

#### [Y Correlations](#y-correlations)

**Syntax:** obj \<< Simulator( Y Correlations( state=0|1, {response1, response2, ..., responseN}, [NxN correlations] ) )

**Description:** Sets the correlations on the Y responses when multivariate noise is added to the responses.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Profiler(
    Y(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Simulator(
    1,
    Factors(
        SILICA << Random( Normal( 1.25, 0.3266 ) ),
        SILANE << Random( Normal weighted( 50, 6.532 ) ), SULFUR << Fixed( 2.25 )
    ),
    Responses(
        Pred Formula ABRASION << Add Multivariate Noise( 1 ),
        Pred Formula MODULUS << No Noise, Pred Formula ELONG << Add Multivariate Noise( 1 ),
        Pred Formula HARDNESS << No Noise
    ),
    Y Correlations(
        1,
        {Pred Formula ABRASION, Pred Formula MODULUS, Pred Formula ELONG,
        Pred Formula HARDNESS},
        [1 0.15 0.27 0, 0.15 1 0 0, 0.27 0 1 0, 0 0 0 1]
    ),
    Simulate
);


```

# [Python Connection](#python-connection)

## [Item Messages](#item-messages)

### [Create JPIP CMD](#create-jpip-cmd)

**Syntax:** obj \<< Create JPIP CMD()

**Description:** Triggers the creation of a jpip command line wrapper script for Python's pip command. A directory picker dialog will ask where to save the generated script. This script then provides the full capabilities of pip, while correctly establishing the necessary environment variables for JMP's isolated Python environment.

**JMP Version Added:** 18

**Example 1**

```


conn = Python Connect();
conn << Create JPIP CMD();


```

**Example 2**

```

Python Create JPIP CMD();


```

### [Disconnect](#disconnect)

**Syntax:** obj \<< Disconnect

**Description:** Note: This function is deprecated as of JMP 18 and has no effect.

**JMP Version Added:** 14

### [Execute](#execute)

**Syntax:** list = obj \<< Execute( { list of Inputs }, { list of Outputs }, statements < , echo( 1 | 0 ) > )

**Description:** Sends a list of inputs, executes statements and returns a list of outputs. Optional echo() parameter defaults to True. The echo parameter controls echoing the Python source to the log. Logical True (1) enables echo of source while 0 suppresses the echo to the log.

**JMP Version Added:** 14

**Example 1**

```

PythonConnection = Python Connect();
// NOTE: a,d,x,z must be declared before Execute()
// as this is the location the results will be written.
a = "abcdef";
d = 3.141;
x = 0;
z = 0;
v = [1 0 0, 0 1 0, 0 0 1];
// pi, e, phi, c, Plank's, Faraday, 345 triangle
m = [3.141 2.718 1.618,
2.997 6.626 9.648,
3 4 5];
ml = PythonConnection << Execute(
    {v, m, a, d},
    {x, z, a, d},
    "\[
import numpy as np
a = np.multiply(v, m) # matrix product
d = np.divide(v, m) # matrix division
z = np.multiply(m, np.linalg.inv(v)) # m * inv(v) called Left division
x = np.multiply(np.linalg.inv(m), v) # inv(m) * v called right division
    ]\"
);
Show( v, m, ml, x, z, a, d );


```

**Example 2**

```

PythonConnection = Python Connect();
x1 = 0;
x2 = 0;
y1 = 0;
y2 = 0;
z1 = 0;
z2 = 0;
v = [1 0 0, 0 1 0, 0 0 1];
// pi, e, phi, c, Plank's, Faraday, 345 triangle
m = [3.141 2.718 1.618,
2.997 6.626 9.648,
3 4 5];
ml = Python Execute(
    {v, m},
    {x1, x2, y1, y2, z1, z2},
    "\[
import numpy as np
x1 = np.multiply(v, m) # matrix product
print('x1=', x1)
x2 = np.divide(v, m) # matrix division
print('x2=', x2)
y1 = np.dot(v, m) # dot product of v and m
print('y1=', y1)
y2 = np.dot(m, v) # dot product of m and v
print('y2=', y2)
z1 = np.inner(v, m) # inner product of v and m
print('z1=', z1)
z2 = np.inner(m, v) # innder product of m and v
print('z2=', z2)
        ]\"
);
Show( v, m, ml, x1, x2, y1, y2, z1, z2 );


```

### [Get](#get)

**Syntax:** y = obj \<< Get( name )

**Description:** Returns data from Python, where the name argument can represent any of the following Python data types ( numeric | string | matrix | list | dict | data table | data frame | datetime | numpy.datetime64 ).

**JMP Version Added:** 14

#### [Datetime](#datetime)

```


PythonConnection = Python Connect();
date1 = As Date( Today() );
PythonConnection << Set( date1 );
date2 = PythonConnection << Get( date1 );
Show( date1, date2 );


```

**Example 1**

```


PythonConnection = Python Connect();
x1 = [1, 2, 3];
PythonConnection << Set( x1 );
x2 = PythonConnection << Get( x1 );
Show( x1, x2 );
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
PythonConnection << Set( dt1 );
dt2 = PythonConnection << Get( dt1 );
dt2 << New Data View;
Close( dt1 );


```

#### [numpy.datetime64](#numpydatetime64)

```


PythonConnection = Python Connect();
PythonConnection << Install Packages( "numpy" );
PythonConnection << Submit( "import numpy as np" );
PythonConnection << Submit( "datetime64 = np.datetime64('1989-10-05')" );
numpy_datetime = PythonConnection << Get( datetime64 );
Show( numpy_datetime );


```

### [Get Version](#get-version)

**Syntax:** version = obj \<< Get Version

**Description:** Returns the version number of Python used in the current connection.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
version = PythonConnection << Get Version;
Show( version );


```

### [Install Packages](#install-packages)

**Syntax:** obj \<< Install Packages( packages )

**Description:** This wraps the install of Python packages into the JMP site-packages directory. For operations beyond simple package installation, see Python Create JPIP CMD() to create a command line pip wrapper script in a directory chosen with Directory Pick(). Alternatively, to run the install from a JMP Python script window, look at jmputils.jpip under the Python category here in the Scripting Index.

**JMP Version Added:** 18

**Example 1**

```

// install numpy and pandas packages
conn = Python Connect();
conn << Install Packages( "numpy pandas" );


```

**Example 2**

```

// install numpy and pandas packages
Python Install Packages( "numpy pandas" );


```

**Example 3**

```

// install numpy and pandas packages
Python Install Packages( {"numpy", "pandas"} );


```

### [Is Connected](#is-connected)

**Syntax:** x = obj \<< Is Connected

**Description:** Note: This function is deprecated as of JMP 18 and always returns 1.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
x = PythonConnection << Is Connected;
Show( x );


```

### [JMP Name To Python Name](#jmp-name-to-python-name)

**Syntax:** Python Name = PythonConnection \<< JMP Name To Python Name( JMP name )

**Description:** Maps a JMP variable name to a Python variable name using Python variable naming rules.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
Python Name = PythonConnection << JMP Name To Python Name( a b c );
Show( Python Name );


```

### [Reset](#reset)

**Syntax:** PythonConnection \<< Reset

**Description:** Reset the shared Python environment.

**JMP Version Added:** 19

```

PythonConnection = Python Connect();
pi = 3.1415927;
PythonConnection << Send( pi );
PythonConnection << Submit( "print(pi)" );
PythonConnection << Reset();
// will show error, pi not defined
PythonConnection << Submit( "print(pi)" );


```

### [Send](#send)

**Syntax:** y = obj \<< Send( name, \<Python Name( name )> )

**Description:** Sends data to Python, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table | date ).

**JMP Version Added:** 14

#### [Date](#date)

```


PythonConnection = Python Connect();
date = As Date( Today() );
PythonConnection << Send( date );
PythonConnection << Submit( "print(date)" );


```

**Example 1**

```

PythonConnection = Python Connect();
x = [1, 2, 3];
PythonConnection << Send( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
PythonConnection << Send( dt );
PythonConnection << Submit( "print(x)" );
PythonConnection << Submit( "print(dt)" );


```

### [Send File](#send-file)

**Syntax:** y = obj \<< Send File( filename, \<Python Name( name )> )

**Description:** Sends a data file to Python, where the filename argument is a string specifying a pathname to the file to be sent to Python.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
PythonConnection << Send File( "$SAMPLE_DATA/Big Class.jmp" );
dtname = "$SAMPLE_DATA/Baseball.jmp";
PythonConnection << Send File( dtname );
PythonConnection << Submit( "print(Big_Class)" );
PythonConnection << Submit( "print(Baseball)" );


```

### [Set](#set)

**Syntax:** y = obj \<< Set( name, \<Python Name( name )> )

**Description:** Sends data to Python, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table | date ).

**JMP Version Added:** 14

#### [Date](#date_1)

```


PythonConnection = Python Connect();
date = As Date( Today() );
PythonConnection << Set( date );
PythonConnection << Submit( "print(date)" );


```

**Example 1**

```

PythonConnection = Python Connect();
x = [1, 2, 3];
PythonConnection << Set( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
PythonConnection << Set( dt );
PythonConnection << Submit( "print(x)" );
PythonConnection << Submit( "print(dt)" );


```

### [Submit](#submit)

**Syntax:** obj \<< Submit( statements < , echo( 1 | 0 ) > )

**Description:** Submits statements to Python. Statements can be in the form of a string value or list of string values. Optional echo() parameter defaults to True. The echo parameter controls echoing the Python source to the log. Logical True (1) enables echo of source while 0 suppresses the echo to the log.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
PythonConnection << Submit(
    "\[
str = 'The quick brown fox jumps over the lazy dog';
a = 200;
]\"
);
getStr = PythonConnection << Get( str );
getNum = PythonConnection << Get( a );
Show( getStr, getNum );


```

### [Submit File](#submit-file)

**Syntax:** obj \<< Submit File( path )

**Description:** Submits statements to Python using a file specified by the path argument.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
PythonConnection << Submit File( "some_Python_source.py" );


```

# [R Connection](#r-connection)

## [Associated Constructors](#associated-constructors)

### [R Connect](#r-connect)

**Syntax:** RConnection = R Connect()

**Description:** Returns an R connection scriptable object.

```

RConnection = R Connect();
x = RConnection << Is Connected;
Show( x );


```

## [Item Messages](#item-messages)

### [Control](#control)

**Syntax:** obj \<< Control( Echo( Boolean ) )

**Description:** Changes the control options for R.

```

RConnection = R Connect();
RConnection << Control( Echo( 0 ) );
RConnection << Submit( "rnorm(10)" );


```

### [Disconnect](#disconnect)

**Syntax:** obj \<< Disconnect

**Description:** Deprecated in JMP 19 and has no effect.

```

RConnection = R Connect();
RConnection << Disconnect;


```

### [Execute](#execute)

**Syntax:** list = obj \<< Execute( { list of Inputs }, { list of Outputs }, statements )

**Description:** Sends a list of inputs, executes statements and returns a list of outputs.

```


RConnection = R Connect();
a = "abcdef";
d = 3.1415927;
x = 0;
z = 0;
v = [9 8 7, 6 5 4, 3 2 1];
m = [1 2 3, 4 5 6, 7 8 9];
rc = RConnection << Execute( {v, m, a, d}, {x, z, a, d}, "\[
x <- rnorm(5)
z <- v * m
]\" );
Show( v, m, rc, x, z, a, d );


```

### [Get](#get)

**Syntax:** y = obj \<< Get( name )

**Description:** Returns data from R, where the name argument can represent any of the following R data types ( numeric | string | matrix | list | data frame).

```

RConnection = R Connect();
x1 = [1, 2, 3];
RConnection << Set( x1 );
x2 = RConnection << Get( x1 );
Show( x1, x2 );
dt1 = New Table( "Test", New Column( "Col", Values( [10, 20, 30] ) ) );
RConnection << Set( dt1 );
dt2 = RConnection << Get( dt1 );
Close( dt1, No Save );


```

### [Get Graphics](#get-graphics)

**Syntax:** R graphics = obj \<< Get Graphics( format )

**Description:** DEPRECATED in JMP 19 and has no effect. As a replacement, set device to a file name such as png("r_plot.png"), and then open the file to retrieve the image. This option will be removed from JMP 20. Code below shows workaround.

```

RConnection = R Connect();
img_path = Get Path Variable( "TEMP" ) || "r_plot.png";
RConnection << Execute( {img_path}, {}, "\[
png(img_path)
plot(1:10)
dev.off()
]\" );
plot = Open( img_path );
rc = Delete File( img_path );


```

### [Get Version](#get-version)

**Syntax:** version = obj \<< Get Version

**Description:** Returns the version number of R used in the current connection.

```

RConnection = R Connect();
version = RConnection << Get Version;
Show( version );


```

### [Is Connected](#is-connected)

**Syntax:** x = obj \<< Is Connected

**Description:** Returns 1 if there is an active R connection; otherwise, returns 0.

```

RConnection = R Connect();
x = RConnection << Is Connected;
Show( x );


```

### [JMP Name To R Name](#jmp-name-to-r-name)

**Syntax:** Rname = JMP Name To R Name( JMP name )

**Description:** Maps a JMP variable name to an R variable name using R variable naming rules.

```

RConnection = R Connect();
RName = RConnection << JMP Name To R Name( a b c );
Show( RName );


```

### [Send](#send)

**Syntax:** y = obj \<< Send( name, \<R Name( name )> )

**Description:** Sends data to R, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table).

```

RConnection = R Connect();
x = [1, 2, 3];
RConnection << Send( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
RConnection << Send( dt );
Close( dt );
RConnection << Submit( "dt" );


```

### [Send File](#send-file)

**Syntax:** y = obj \<< Send File( filename, \<R Name( name )> )

**Description:** Sends a data file to R, where the filename argument is a string specifying a pathname to the file to be sent to R.

```

RConnection = R Connect();
RConnection << Send File( "$SAMPLE_DATA/Big Class.jmp" );
RConnection << Disconnect;
dtname = "$SAMPLE_DATA/Baseball.jmp";
RConnection << Send File( dtname );


```

### [Set](#set)

**Syntax:** y = obj \<< Set( name, \<R Name( name )> )

**Description:** Sends data to R, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table).

```

RConnection = R Connect();
x = [1, 2, 3];
RConnection << Set( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
RConnection << Set( dt );
Close( dt );
RConnection << Submit( "dt" );


```

### [Submit](#submit)

**Syntax:** obj \<< Submit( statements )

**Description:** Submit statements to R. Statements can be in the form of a string value or list of string values.

```


RConnection = R Connect();
img_path = Get Path Variable( "TEMP" ) || "r_plot.png";
code =
"\[
x <- rnorm(1000)
hx <- hist(x, breaks=100, plot=FALSE)
png("IMG_PATH")
plot(hx, col=ifelse(abs(hx$breaks) < 1.669, 4, 2))
dev.off()
x <- rnorm (100)
y <- x**2 + rnorm (100)
summary(y)
]\";
// substitue portable path into R code
r_code = Substitute( code, "IMG_PATH", img_path );
RConnection << Submit( r_code );
Wait( 3 );
plot = Open( img_path );
rc = Delete File( img_path );


```

### [Submit File](#submit-file)

**Syntax:** obj \<< Submit File( path )

**Description:** Submits statements to R using a file specified by the path argument.

```

RConnection = R Connect();
RConnection << Submit File( "file containing R source." );


```

# [Recurrence Analysis](#recurrence-analysis)

## [Associated Constructors](#associated-constructors)

### [Recurrence Analysis](#recurrence-analysis_1)

**Syntax:** Recurrence Analysis( Y( column ), Cost( column ), Label( column ), \<Grouping( column )> )

**Description:** Analyzes how a recurring event is distributed over time, per system, or until the system goes out of service.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

## [Columns](#columns)

### [Age](#age)

**Syntax:** obj \<< Age( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Cause](#cause)

**Syntax:** obj \<< Cause( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Cost](#cost)

**Syntax:** obj \<< Cost( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Event Timestamp](#event-timestamp)

**Syntax:** obj \<< Event Timestamp( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Failure Mode](#failure-mode)

**Syntax:** obj \<< Failure Mode( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Label](#label)

**Syntax:** obj \<< Label( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [System ID](#system-id)

**Syntax:** obj \<< System ID( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Timestamp at End](#timestamp-at-end)

**Syntax:** obj \<< Timestamp at End( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Timestamp at Start](#timestamp-at-start)

**Syntax:** obj \<< Timestamp at Start( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column )

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);


```

## [Item Messages](#item-messages)

### [Calendar Event Plot](#calendar-event-plot)

**Syntax:** obj \<< Calendar Event Plot( state=0|1 )

**Description:** Shows or hides a plot of events by time, instead of age.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Reliability/Diesel Ship Engines.jmp" );
obj = dt << Recurrence Analysis(
    Y( :event time ),
    Label( :System ID ),
    Grouping( :System ID ),
    Timestamp at Start( :orig time ),
    Timestamp at End( :end time )
);
obj << Calendar Event Plot( 1 );


```

### [Event Plot](#event-plot)

**Syntax:** obj \<< Event Plot( state=0|1 )

**Description:** Shows or hides the Event Plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 )
);
Wait( 1 );
obj << Event Plot( 1 );


```

### [Fit Model](#fit-model)

**Syntax:** obj \<< Fit Model

**Description:** Enables you to fit models for the recurrence intensity and cumulative functions.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 )
);
obj << Fit Model;


```

### [MCF Confid Limits](#mcf-confid-limits)

**Syntax:** obj \<< MCF Confid Limits( state=0|1 )

**Description:** Shows or hides lines on the MCF plot that correspond to the approximate 95% confidence limits of the mean cumulative function (MCF).

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 )
);
obj << MCF Confid Limits( 1 );


```

### [MCF Plot](#mcf-plot)

**Syntax:** obj \<< MCF Plot( state=0|1 )

**Description:** Shows or hides the MCF or Mean Cumulative Function Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 ),
    MCF Plot( 0 )
);
Wait( 1 );
obj << MCF Plot( 1 );


```

### [MCF Plot Each Group](#mcf-plot-each-group)

**Syntax:** obj \<< MCF Plot Each Group( state=0|1 )

**Description:** Shows or hides a report that contains a mean cumulative function (MCF) plot for each level of the grouping variable. This option is available only when you specify a Grouping variable.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 )
);
obj << MCF Plot Each Group( 1 );


```

### [Plot Interarrival by Age](#plot-interarrival-by-age)

**Syntax:** obj \<< Plot Interarrival by Age( state=0|1 )

**Description:** Shows or hides a plot of the time since the last event by the age of the current event.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Reliability/Diesel Ship Engines.jmp" );
obj = dt << Recurrence Analysis(
    Y( :event time ),
    Label( :System ID ),
    Grouping( :System ID ),
    Timestamp at Start( :orig time ),
    Timestamp at End( :end time )
);
obj << Plot Interarrival by Age( 1 );


```

### [Plot MCF Differences](#plot-mcf-differences)

**Syntax:** obj \<< Plot MCF Differences( state=0|1 )

**Description:** Shows or hides a plot for each difference of mean cumulative functions (MCFs), including a 95% confidence interval for that difference. This option is available only when you specify a Grouping variable.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 )
);
obj << Plot MCF Differences( 1 );


```

### [Save MCF Differences](#save-mcf-differences)

**Syntax:** obj \<< Save MCF Differences( <Last> )

**Description:** Creates a new data table that contains the differences in the mean cumulative function (MCF) for each level of the grouping variable. The optional argument specifies that only the final row of each difference is saved to the new data table. This option is available only when you specify a Grouping variable.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 )
);
obj << Save MCF Differences;
obj << Save MCF Differences( Last );


```

### [Show MCF Legend](#show-mcf-legend)

**Syntax:** obj \<< Show MCF Legend( state=0|1 )

**Description:** Shows or hides the legend for the mean cumulative function (MCF) plot. This option is available only when you specify a Grouping variable. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Event Plot( 0 ),
    Show MCF Legend( 0 )
);
Wait( 1 );
obj << Show MCF Legend( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Bladder Cancer.jmp" );
obj = dt << Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Recurrence Analysis(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Reliability Forecast](#reliability-forecast)

## [Associated Constructors](#associated-constructors)

### [Reliability Forecast](#reliability-forecast_1)

**Syntax:** Reliability Forecast

**Description:** Predicts future failures based on observed data and future units at risk. The platform accepts several input formats. See each format for specification details.

#### [Dates Format](#dates-format)

```


dt1 = Open( "$SAMPLE_DATA/Reliability/Small Production part1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Reliability/Small Production part2.jmp" );

obj = dt1 << Reliability Forecast(
    Input Format( Dates ),
    Production Data Table(
        dt1,
        Production Count( :Sold Quantity ),
        Timestamp( :Sold Month )
    ),
    Failure Data Table(
        dt2,
        Failure Time( :Return Month ),
        Timestamp( :Sold Month ),
        Failure Count( :Return Quantity )
    ),
    Life Time Unit( Month ),
    Show Legend( 1 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group( "" ),
        Risk Set( [2550, 2600, 2650, 2700, 2750, 2800, 2850] ),
        Future Risk Set(
            [3082.5, 3052.5, 3367.5, 3952.5, 3667, 3667],
            [3347740800, 3350160000, 3352579200, 3355257600, 3357849600, 3360528000]
        ),
        Forecast To( "02/2011" ),
        Distribution( Weibull ),
        Contract( 6, Month ),
        Forecast Type( Sequential ),
        Interval Type( Prediction Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 1 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

#### [Nevada Format](#nevada-format)

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

#### [Time to Event Format](#time-to-event-format)

```


dt = Open( "$SAMPLE_DATA/Reliability/Small Production Time to Event.jmp" );
obj = dt << Reliability Forecast(
    Input Format( Time to Event ),
    Time to Event( :"Time (Month)"n, :Time Right ),
    Freq( :Freq ),
    Life Time Unit( Month ),
    Forecast Start( Informat( "03/01/2010", "Locale Date" ) ),
    Forecast(
        Group( "" ),
        Future Risk Set( [33, 33, 33], [3352924800, 3355516800, 3358195200] ),
        Forecast To( "09/01/2010" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( [1] ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( 0 ),
        Use Approximate Distribution( 1 )
    )
);


```

## [Item Messages](#item-messages)

### [Contract](#contract)

**Syntax:** obj \<< Forecast( Contract( length, unit ) )

**Description:** Specifies the length and time unit for the contract that is used to forecast future risk.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Distribution](#distribution)

**Syntax:** obj \<< Forecast( Distribution( name ) )

**Description:** Specifies the distribution that is used to forecast future risk.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Forecast Options](#forecast-options)

**Syntax:** obj \<< Forecast Options( forecast message(), ... ); (obj \<< Forecast Options) \<< forecast message()

**Description:** Sends messages to the Forecast report scriptable object. You can specify one or more options from the Forecast report red triangle menu. If there are no arguments, this option returns a JSL reference to the Forecast report scriptable object. If there are arguments, this option returns a JSL reference to the platform object. See the entries under Forecast Options for more information.

#### [With Arguments](#with-arguments)

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
obj << Forecast Options( Animation( 0 ), Use Contract Length( 1 ), Show Interval( 1 ) );


```

#### [Without Arguments](#without-arguments)

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
(obj << Forecast Options) << Show Interval( 0 );


```

### [Forecast To](#forecast-to)

**Syntax:** obj \<< Forecast( Forecast To( time ) )

**Description:** Specifies the final time at which future risk is forecasted.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Forecast Type](#forecast-type)

**Syntax:** obj \<< Forecast( Forecast Type( type ) )

**Description:** Specifies the type of quantity that is used to forecast future risk. The type argument can be Incremental or Cumulative.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Future Risk Set](#future-risk-set)

**Syntax:** obj \<< Forecast( Future Risk Set( count vector, time vector ) )

**Description:** Specifies the future risk set that is used to forecast future risk. The arguments are a vector of production counts and a vector of future times.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Get Results](#get-results)

**Syntax:** obj \<< Get Results

**Description:** Returns a named list that contains forecasting results.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
result = obj << Get Results;


```

### [Group](#group)

**Syntax:** obj \<< Forecast( Group( group ), ... )

**Description:** Identifies the group to which all messages in the same Forecast clause should be sent.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Input Format](#input-format)

**Syntax:** obj = Reliability Forecast(...Input Format( Nevada|Dates|Time to Event )...)

**Description:** Specifies the format type of the input data for the analysis.

#### [Dates Format](#dates-format_1)

```


dt1 = Open( "$SAMPLE_DATA/Reliability/Small Production part1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Reliability/Small Production part2.jmp" );

obj = dt1 << Reliability Forecast(
    Input Format( Dates ),
    Production Data Table(
        dt1,
        Production Count( :Sold Quantity ),
        Timestamp( :Sold Month )
    ),
    Failure Data Table(
        dt2,
        Failure Time( :Return Month ),
        Timestamp( :Sold Month ),
        Failure Count( :Return Quantity )
    ),
    Life Time Unit( Month ),
    Show Legend( 1 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group( "" ),
        Risk Set( [2550, 2600, 2650, 2700, 2750, 2800, 2850] ),
        Future Risk Set(
            [3082.5, 3052.5, 3367.5, 3952.5, 3667, 3667],
            [3347740800, 3350160000, 3352579200, 3355257600, 3357849600, 3360528000]
        ),
        Forecast To( "02/2011" ),
        Distribution( Weibull ),
        Contract( 6, Month ),
        Forecast Type( Sequential ),
        Interval Type( Prediction Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 1 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

#### [Nevada Format](#nevada-format_1)

```

dt = Open( "$SAMPLE_DATA/Reliability/Small Production.jmp" );
dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Sold Quantity ),
    Timestamp( :Sold Month ),
    Failure Count(
        :"08/2009"n, :"09/2009"n, :"10/2009"n, :"11/2009"n, :"12/2009"n, :"01/2010"n,
        :"02/2010"n
    ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 1 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group( "" ),
        Risk Set( [2550, 2600, 2650, 2700, 2750, 2800, 2850] ),
        Future Risk Set(
            [3022.5, 3307.5, 3502, 3502, 3502, 3502],
            [3347827200, 3350246400, 3352924800, 3355516800, 3358195200, 3360787200]
        ),
        Forecast To( "02/2011" ),
        Distribution( Weibull ),
        Contract( 12, Month ),
        Forecast Type( Sequential ),
        Interval Type( No Interval ),
        Alpha( 0.05 )
    )
);


```

#### [Time to Event Format](#time-to-event-format_1)

```


dt = Open( "$SAMPLE_DATA/Reliability/Small Production Time to Event.jmp" );
obj = dt << Reliability Forecast(
    Input Format( Time to Event ),
    Time to Event( :"Time (Month)"n, :Time Right ),
    Freq( :Freq ),
    Life Time Unit( Month ),
    Forecast Start( Informat( "03/01/2010", "Locale Date" ) ),
    Forecast(
        Group( "" ),
        Future Risk Set( [33, 33, 33], [3352924800, 3355516800, 3358195200] ),
        Forecast To( "09/01/2010" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( [1] ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( 0 ),
        Use Approximate Distribution( 1 )
    )
);


```

### [Interval Type](#interval-type)

**Syntax:** obj \<< Forecast( Interval Type( type ) )

**Description:** Specifies the type of interval that is used to forecast the error around the future risk. The interval type can be No Interval, Plugin Interval, or Prediction Interval.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Risk Set](#risk-set)

**Syntax:** obj \<< Forecast( Risk Set( count vector ) )

**Description:** Specifies the existing risk set that is used to forecast future risk.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Save Data in Time to Event Format](#save-data-in-time-to-event-format)

**Syntax:** obj \<< Save Data in Time to Event Format

**Description:** Saves Nevada or Dates formatted data in a new Time to Event formatted data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
obj << Save Data in Time to Event Format;


```

### [Save Forecast Data Table](#save-forecast-data-table)

**Syntax:** obj \<< Save Forecast Data Table

**Description:** Saves the cumulative and incremental number of returns in a new data table, along with the variables that you selected in the launch window. For grouped analyses, table names include the group ID and the word "Aggregated". Existing returns are also included in the aggregated data tables.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
dt results = obj << Save Forecast Data Table;


```

### [Set Interval Level](#set-interval-level)

**Syntax:** obj \<< Forecast( Set Interval Level( value ) )

**Description:** Specifies the confidence level for the interval that is used to forecast the error around the future risk.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
n = N Rows( dt );
mat = dt << get as matrix;
mat = (mat || J( n, 1, 1 )) |/ (mat || J( n, 1, 2 ));
dt = As Table( mat );
Column( dt, 2 ) << Format( "m/y", 7 );
Column( dt, 2 ) << set name( "Time" );
Column( dt, 1 ) << set name( "Volume" );
For Each( {i}, 3 :: 38,
    Column( dt, i ) << set name(
        Format( Date Increment( Column( dt, 2 )[i - 2], "Month", 1 ), "m/y", 7 )
    )
);
Column( dt, 39 ) << set name( "Group" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Group ID( :Group ),
    Life Time Unit( Month ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast Options( Show Interval( 1 ) )
);
obj << Forecast(
    Group( "1" ),
    Risk Set(
        [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026, 1950,
        1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966,
        2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
    ),
    Future Risk Set( [2003, 2003], [3139862400, 3142540800] ),
    Forecast To( "01/2004" ),
    Distribution( Weibull ),
    Contract( 5, Month ),
    Forecast Type( Cumulative ),
    Interval Type( No Interval ),
    Set Interval Level( 0.9 )
);
obj << Forecast(
    Group( "2" ),
    Risk Set(
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2026, 1950, 1989, 1963, 1954, 2030, 1981, 2006,
        1991, 1950, 2025, 1996, 1987, 1957, 1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045,
        2018, 2036]
    ),
    Future Risk Set( [2000, 3000], [3139862400, 3142540800] ),
    Forecast To( "08/2005" ),
    Distribution( Weibull ),
    Contract( 36, Month ),
    Forecast Type( Incremental ),
    Interval Type( Prediction Interval ),
    Set Interval Level( 0.9 )
);


```

### [Show Graph Filter](#show-graph-filter)

**Syntax:** obj \<< Show Graph Filter( state=0|1 )

**Description:** Shows or hides the Graph Filter so that you can select which production periods to show in the Observed Data graphs. Bars fade for deselected periods. Deselect the periods to show the graph in its original state. This option is not available for Time to Event data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
obj << Show Graph Filter( 1 );


```

### [Show Legend](#show-legend)

**Syntax:** obj \<< Show Legend( state=0|1 )

**Description:** Shows or hides a legend for the Observed Data report. This option is not available for Time to Event data.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
obj << Show Legend( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ), By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ), By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [Forecast Options](#forecast-options_1)

### [Item Messages](#item-messages_1)

#### [Animation](#animation)

**Syntax:** obj \<< Animation( state=0|1 )

**Description:** Controls the flashing of the hotspots in the Forecast graphs. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Forecasting Interval Type](#forecasting-interval-type)

**Syntax:** obj \<< Forecasting Interval Type( type )

**Description:** Specifies the type of interval that is used to forecast the error around the future risk. The interval type can be Plugin Interval or Prediction Interval.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Import Future Risk Set](#import-future-risk-set)

**Syntax:** obj \<< Import Future Risk Set

**Description:** Enables you to import future production data from another open data table. The new predictions then appear in the future risk graph. The imported data table must have a column for timestamps and for production counts.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
import set = [3139862400 2000, 3142540800 2050, 3145219200 2100, 3147811200 2150, 3150489600
2200, 3153081600 2250];
dt import = As Table( import set, <<Column Names( {"Time", "Volume"} ) );
option << Import Future Risk Set;


```

#### [Interactive Configuration of Risk Sets](#interactive-configuration-of-risk-sets)

**Syntax:** obj \<< Interactive Configuration of Risk Sets( state=0|1 )

**Description:** Determines whether you can drag hotspots in the graphs.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Monte Carlo Sample Size](#monte-carlo-sample-size)

**Syntax:** obj \<< Monte Carlo Sample Size( number )

**Description:** Specifies the sample size of the simulation that is used to generate the prediction intervals.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Random Seed](#random-seed)

**Syntax:** obj \<< Random Seed( number )

**Description:** Specifies a random seed that can be used to reproduce the simulated prediction intervals.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Save Forecast Data Table](#save-forecast-data-table_1)

**Syntax:** obj \<< Save Forecast Data Table

**Description:** Saves the cumulative and incremental number of returns in a new data table, along with the variables that you selected in the launch window. For grouped analyses, table names include the group ID and the word "Aggregated". Existing returns are also included in the aggregated data tables.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Save Forecast Data Table;


```

#### [Set Failure Cost](#set-failure-cost)

**Syntax:** obj \<< Set Failure Cost( number )

**Description:** Specifies the cost for each failure.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Show Interval](#show-interval)

**Syntax:** obj \<< Show Interval( state=0|1 )

**Description:** Shows or hides 95% confidence limits in the graph.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Spreadsheet Configuration of Risk Sets](#spreadsheet-configuration-of-risk-sets)

**Syntax:** obj \<< Spreadsheet Configuration of Risk Sets( state=0|1 )

**Description:** Shows or hides a report that enables you to enter specific production counts and timestamps instead of adding them to the interactive graphs.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Use Approximate Distribution](#use-approximate-distribution)

**Syntax:** obj \<< Use Approximate Distribution( state=0|1 )

**Description:** Specifies that the prediction intervals are generated using a Poisson distribution to approximate the number of failures in each interval. If this option is not selected, the prediction intervals use a multinomial distribution to simulate the number of failures in each interval.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Use Contract Length](#use-contract-length)

**Syntax:** obj \<< Use Contract Length( state=0|1 )

**Description:** Determines whether the specified contract length is considered in the forecast.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

#### [Use Failure Cost](#use-failure-cost)

**Syntax:** obj \<< Use Failure Cost( state=0|1 )

**Description:** Shows failure cost instead of the failure count in the future risk graph.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
obj = dt << Run Script( "Reliability Forecast" );
option = obj << Forecast Options;
option << Animation( 0 );
option << Interactive Configuration of Risk Sets( 0 );
option << Spreadsheet Configuration of Risk Sets( 1 );
option << Show Interval( 1 );
option << Forecasting Interval Type( Prediction Interval );
option << Use Contract Length( 1 );
option << Use Failure Cost( 1 );
option << Set Failure Cost( 100 );
option << Monte Carlo Sample Size( 10000 );
option << Random Seed( 1111 );
option << Use Approximate Distribution( 1 );


```

## [Reliability Forecast for Dates Format](#reliability-forecast-for-dates-format)

### [Columns](#columns)

#### [Failure Count](#failure-count)

**Syntax:** obj \<< Failure Count( column )

#### [Failure Time](#failure-time)

**Syntax:** obj \<< Failure Time( column(s) )

#### [Group ID](#group-id)

**Syntax:** obj \<< Group ID( column )

#### [Left Censor](#left-censor)

**Syntax:** obj \<< Left Censor( column )

#### [Production Count](#production-count)

**Syntax:** obj \<< Production Count( column )

#### [Timestamp](#timestamp)

**Syntax:** obj \<< Timestamp( column )

### [Item Messages](#item-messages_2)

#### [Censor Code](#censor-code)

**Syntax:** obj = Reliability Forecast(...Input Format( Dates ), Censor Code( value=1 )...)

**Description:** Identifies the value in the Censor column that designates right-censored observations.

#### [Life Time Unit](#life-time-unit)

**Syntax:** obj = Reliability Forecast(...Input Format( Dates ), Life Time Unit( unit )...)

**Description:** Specifies the physical date-time format of all time stamps, including the format of the column titles for the return counts. This setting is used in forecasting step increments. The unit argument can be any of the following: Numeric, Year, Month, Week, Day, Hour, Minute, or Second.

```


dt1 = Open( "$SAMPLE_DATA/Reliability/Small Production part1.jmp" );
dt2 = Open( "$SAMPLE_DATA/Reliability/Small Production part2.jmp" );

obj = dt1 << Reliability Forecast(
    Input Format( Dates ),
    Production Data Table(
        dt1,
        Production Count( :Sold Quantity ),
        Timestamp( :Sold Month )
    ),
    Failure Data Table(
        dt2,
        Failure Time( :Return Month ),
        Timestamp( :Sold Month ),
        Failure Count( :Return Quantity )
    ),
    Life Time Unit( Month ),
    Show Legend( 1 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group( "" ),
        Risk Set( [2550, 2600, 2650, 2700, 2750, 2800, 2850] ),
        Future Risk Set(
            [3082.5, 3052.5, 3367.5, 3952.5, 3667, 3667],
            [3347740800, 3350160000, 3352579200, 3355257600, 3357849600, 3360528000]
        ),
        Forecast To( "02/2011" ),
        Distribution( Weibull ),
        Contract( 6, Month ),
        Forecast Type( Sequential ),
        Interval Type( Prediction Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 1 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

## [Reliability Forecast for Nevada Format](#reliability-forecast-for-nevada-format)

### [Columns](#columns_1)

#### [Failure Count](#failure-count_1)

**Syntax:** obj \<< Failure Count( column(s) )

#### [Group ID](#group-id_1)

**Syntax:** obj \<< Group ID( column )

#### [Production Count](#production-count_1)

**Syntax:** obj \<< Production Count( column )

#### [Timestamp](#timestamp_1)

**Syntax:** obj \<< Timestamp( column )

### [Item Messages](#item-messages_3)

#### [Interval Censored Failure](#interval-censored-failure)

**Syntax:** obj = Reliability Forecast(...Input Format( Nevada ), Interval Censored Failure( state=0|1 )...)

**Description:** Specifies that returned quantities be treated as interval-censored observations. The interval is between the last recorded time and the time that the failure was observed. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

#### [Life Time Unit](#life-time-unit_1)

**Syntax:** obj = Reliability Forecast(...Input Format( Nevada ), Life Time Unit( unit )...)

**Description:** Specifies the physical date-time format of all time stamps, including the format of the column titles for the return counts. This setting is used in forecasting step increments. The unit argument can be any of the following: Numeric, Year, Month, Week, Day, Hour, Minute, or Second.

```

dt = Open( "$SAMPLE_DATA/Reliability/Widgets.jmp" );
collist = Transform Each( {i}, 3 :: 38, Output( "List" ), Column( dt, i ) );
obj = dt << Reliability Forecast(
    Input Format( Nevada ),
    Production Count( :Volume ),
    Timestamp( :Time ),
    Failure Count( Eval List( collist ) ),
    Life Time Unit( Month ),
    Interval Censored Failure( 1 ),
    Show Legend( 0 ),
    Show Graph Filter( 0 ),
    Forecast(
        Group(),
        Risk Set(
            [1991, 2000, 1999, 2024, 1959, 1958, 2000, 2001, 1986, 1966, 1983, 2011, 2026,
            1950, 1989, 1963, 1954, 2030, 1981, 2006, 1991, 1950, 2025, 1996, 1987, 1957,
            1988, 1966, 2038, 2014, 1962, 1965, 1952, 2045, 2018, 2036]
        ),
        Forecast To( "01/2004" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( . ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( -1 ),
        Use Approximate Distribution( 1 )
    )
);


```

## [Reliability Forecast for Time to Event Format](#reliability-forecast-for-time-to-event-format)

### [Columns](#columns_2)

#### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

#### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

#### [Group ID](#group-id_2)

**Syntax:** obj \<< Group ID( column )

#### [Time to Event](#time-to-event)

**Syntax:** obj \<< Time to Event( column(s) )

### [Item Messages](#item-messages_4)

#### [Censor Code](#censor-code_1)

**Syntax:** obj = Reliability Forecast(...Input Format( Time to Event ), Censor Code( value=1 )...)

**Description:** Identifies the value in the Censor column that designates right-censored observations.

#### [Forecast Start](#forecast-start)

**Syntax:** obj = Reliability Forecast(...Input Format( Time to Event ), Forecast Start( time )...)

**Description:** Specifies the time at which the forecast begins. The format of the time depends on the setting of the Life Time Unit option.

```


dt = Open( "$SAMPLE_DATA/Reliability/Small Production Time to Event.jmp" );
obj = dt << Reliability Forecast(
    Input Format( Time to Event ),
    Time to Event( :"Time (Month)"n, :Time Right ),
    Freq( :Freq ),
    Life Time Unit( Month ),
    Forecast Start( Informat( "03/01/2010", "Locale Date" ) ),
    Forecast(
        Group( "" ),
        Future Risk Set( [33, 33, 33], [3352924800, 3355516800, 3358195200] ),
        Forecast To( "09/01/2010" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( [1] ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( 0 ),
        Use Approximate Distribution( 1 )
    )
);


```

#### [Life Time Unit](#life-time-unit_2)

**Syntax:** obj = Reliability Forecast(...Input Format( Time to Event ), Life Time Unit( unit )...)

**Description:** Specifies the physical date-time format of all time stamps, including the format of the column titles for the return counts. This setting is used in forecasting step increments. The unit argument can be any of the following: Numeric, Year, Month, Week, Day, Hour, Minute, or Second.

```


dt = Open( "$SAMPLE_DATA/Reliability/Small Production Time to Event.jmp" );
obj = dt << Reliability Forecast(
    Input Format( Time to Event ),
    Time to Event( :"Time (Month)"n, :Time Right ),
    Freq( :Freq ),
    Life Time Unit( Month ),
    Forecast Start( Informat( "03/01/2010", "Locale Date" ) ),
    Forecast(
        Group( "" ),
        Future Risk Set( [33, 33, 33], [3352924800, 3355516800, 3358195200] ),
        Forecast To( "09/01/2010" ),
        Distribution( Weibull ),
        Contract( 5, Month ),
        Forecast Type( Incremental ),
        Interval Type( No Interval ),
        Set Interval Level( 0.9 )
    ),
    Forecast Options(
        Animation( 1 ),
        Interactive Configuration of Risk Sets( 1 ),
        Spreadsheet Configuration of Risk Sets( 0 ),
        Show Interval( 0 ),
        Forecasting Interval Type( Prediction Interval ),
        Use Contract Length( 1 ),
        Use Failure Cost( 0 ),
        Set Failure Cost( [1] ),
        Monte Carlo Sample Size( 10000 ),
        Random Seed( 0 ),
        Use Approximate Distribution( 1 )
    )
);


```

# [Reliability Growth](#reliability-growth)

## [Associated Constructors](#associated-constructors)

### [Reliability Growth](#reliability-growth_1)

**Syntax:** obj = Reliability Growth( Input Format( Time to Event ), Time to Event( column, <column> ), \<Event Count( column )>, \<Phase( column )> ); obj = Reliability Growth( Input Format( Dates ), Timestamp( column, <column> ), \<Event Count( column )>, \<Phase( column )> ); obj = Reliability Growth( Input Format( Concurrent Systems ), Time to Event( column, column, ... ), System ID( column ), \<Phase( column )> ) obj = Reliability Growth( Input Format( Parallel Systems ), Time to Event( column, column, ... ), \<Event Count( column )>, System ID( column ), \<Phase( column )> )

**Description:** Models the change in reliability of a single repairable system over time as improvements are incorporated into its design. The platform accepts several input formats. See each format for specification details.

#### [Concurrent Systems](#concurrent-systems)

```

dt = Open( "$SAMPLE_DATA/Reliability/Concurrent Systems.jmp" );
obj = dt << Reliability Growth(
    Input Format( Concurrent Systems ),
    Time to Event( :Prototype 1, :Prototype 2 ),
    System ID( :Failed System ),

);
obj << Crow AMSAA;


```

#### [Dates](#dates)

```

dt = Open( "$SAMPLE_DATA/Reliability/BrakeReliability.jmp" );
obj = dt << Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes )
);


```

#### [Parallel Systems](#parallel-systems)

```

dt = Open( "$SAMPLE_DATA/Reliability/Parallel Systems Multiple Phases.jmp" );
obj = dt << Reliability Growth(
    Input Format( Parallel Systems ),
    Time to Event( :Hours ),
    Event Count( :Fixes ),
    System ID( :System ID ),
    Phase( :Phase )
);
obj << Piecewise Weibull NHPP with Different Intercepts;


```

#### [Time to Event](#time-to-event)

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;


```

## [Item Messages](#item-messages)

### [Crow AMSAA](#crow-amsaa)

**Syntax:** obj \<< Crow AMSAA

**Description:** Fits a Crow-AMSAA model. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;


```

### [Crow AMSAA with Modified MLE](#crow-amsaa-with-modified-mle)

**Syntax:** obj \<< Crow AMSAA with Modified MLE

**Description:** Fits a Crow-AMSAA model with bias correction for beta. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA with Modified MLE;


```

### [Distinct Phase Weibull NHPP](#distinct-phase-weibull-nhpp)

**Syntax:** obj \<< Distinct Phase Weibull NHPP

**Description:** Fits a Distinct Phase Weibull NHPP model, where each system in a multi-phase study follows the same Crow-AMSAA model in each phase. This model contains one beta parameter and one lambda parameter for each phase. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Parallel Systems Different Intercepts.jmp" );
obj = dt << Reliability Growth(
    Input Format( Parallel Systems ),
    Time to Event( :Hours ),
    Event Count( :Fixes ),
    System ID( :System ID ),
    Phase( :Phase )
);
obj << Distinct Phase Weibull NHPP;


```

### [Distinct System Weibull NHPP](#distinct-system-weibull-nhpp)

**Syntax:** obj \<< Distinct System Weibull NHPP

**Description:** Fits a Distinct System Weibull NHPP model, where each system in the study follows a separate Crow-AMSAA model with different parameters. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Parallel Systems One Phase.jmp" );
obj = dt << Reliability Growth(
    Input Format( Parallel Systems ),
    Time to Event( :Hours ),
    Event Count( :Repairs ),
    System ID( :System ID )
);
obj << Distinct System Weibull NHPP;


```

### [Distinct Weibull NHPP](#distinct-weibull-nhpp)

**Syntax:** obj \<< Distinct Weibull NHPP

**Description:** Fits a Distinct Weibull NHPP model, where each system in a multi-phase study follows a separate Crow-AMSAA model in each phase. This model contains one beta parameter and one lambda parameter for each combination of system and phase in the study. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Parallel Systems Different Intercepts.jmp" );
obj = dt << Reliability Growth(
    Input Format( Parallel Systems ),
    Time to Event( :Hours ),
    Event Count( :Fixes ),
    System ID( :System ID ),
    Phase( :Phase )
);
obj << Distinct Weibull NHPP;


```

### [Fixed Parameter Crow AMSAA](#fixed-parameter-crow-amsaa)

**Syntax:** obj \<< Fixed Parameter Crow AMSAA( \<lambda ( number )>, \<beta ( number )> )

**Description:** Fits a Fixed Parameter Crow-AMSAA model. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Fixed Parameter Crow AMSAA( lambda( .02 ) );


```

### [Get Results](#get-results)

**Syntax:** obj \<< Get Results

**Description:** Returns a named list that contains the model estimation results.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
Show( obj << Get Results );


```

### [Identical System Weibull NHPP](#identical-system-weibull-nhpp)

**Syntax:** obj \<< Identical System Weibull NHPP

**Description:** Fits an Identical System Weibull NHPP model, where each system in the study follows a single Crow-AMSAA model. The differences among the systems are assumed to be due to the randomness of individual realizations of the same model. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Parallel Systems One Phase.jmp" );
obj = dt << Reliability Growth(
    Input Format( Parallel Systems ),
    Time to Event( :Hours ),
    Event Count( :Repairs ),
    System ID( :System ID )
);
obj << Identical System Weibull NHPP;


```

### [Piecewise Weibull NHPP](#piecewise-weibull-nhpp)

**Syntax:** obj \<< Piecewise Weibull NHPP

**Description:** Fits a Piecewise Weibull NHPP model. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
obj << Piecewise Weibull NHPP;


```

### [Piecewise Weibull NHPP Change Point Detection](#piecewise-weibull-nhpp-change-point-detection)

**Syntax:** obj \<< Piecewise Weibull NHPP Change Point Detection

**Description:** Estimates a change point in the data and fits a Piecewise Weibull NHPP model. This option is not available when a Phase variable is specified. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/BrakeReliability.jmp" );
obj = dt << Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes )
);
obj << Piecewise Weibull NHPP Change Point Detection;


```

### [Piecewise Weibull NHPP with Different Intercepts](#piecewise-weibull-nhpp-with-different-intercepts)

**Syntax:** obj \<< Piecewise Weibull NHPP with Different Intercepts

**Description:** Fits a Piecewise Weibull NHPP with Different Intercepts model, where each system in a multi-phase study follows a separate piecewise Weibull NHPP model. This model contains one beta parameter for each phase and one lambda parameter for each system. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Parallel Systems Multiple Phases.jmp" );
obj = dt << Reliability Growth(
    Input Format( Parallel Systems ),
    Time to Event( :Hours ),
    Event Count( :Fixes ),
    System ID( :System ID ),
    Phase( :Phase )
);
obj << Piecewise Weibull NHPP with Different Intercepts;


```

### [Reinitialized Weibull NHPP](#reinitialized-weibull-nhpp)

**Syntax:** obj \<< Reinitialized Weibull NHPP

**Description:** Fits a Reinitialized Weibull NHPP model. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/ProductionEquipment.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Hours of Operation ),
    Event Count( :Fixes ),
    Phase( :Design Stage )
);
obj << Reinitialized Weibull NHPP;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Hours ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Crow AMSAA;
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Hours ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj << Crow AMSAA;
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [Crow AMSAA](#crow-amsaa_1)

### [Item Messages](#item-messages_1)

#### [Achieved MTBF](#achieved-mtbf)

**Syntax:** scrobj \<< Achieved MTBF( state=0|1 )

**Description:** Shows or hides the Achieved MTBF report. Use the optional alpha argument to specify alpha.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Achieved MTBF( .01 );


```

#### [Goodness of Fit](#goodness-of-fit)

**Syntax:** scrobj \<< Goodness of Fit( state=0|1 )

**Description:** Shows or hides the Goodness of Fit report that contains a test of the null hypothesis that the data follow a Crow-AMSAA model.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Goodness of Fit( 1 );


```

#### [Show Cumulative Events Plot](#show-cumulative-events-plot)

**Syntax:** scrobj \<< Show Cumulative Events Plot( state=0|1 )

**Description:** Shows or hides the Cumulative Events plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Cumulative Events Plot( 1 );


```

#### [Show Intensity Plot](#show-intensity-plot)

**Syntax:** scrobj \<< Show Intensity Plot( state=0|1 )

**Description:** Shows or hides the Intensity plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Intensity Plot( 1 );


```

#### [Show MTBF Plot](#show-mtbf-plot)

**Syntax:** scrobj \<< Show MTBF Plot( state=0|1 )

**Description:** Shows or hides the mean time between failures (MTBF) plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show MTBF Plot( 0 );


```

#### [Show Profilers](#show-profilers)

**Syntax:** scrobj \<< Show Profilers( state=0|1 )

**Description:** Shows or hides the profilers for mean time between failures (MTBF), failure intensity, and cumulative events.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Profilers( 1 );


```

## [Cumulative Events Plot](#cumulative-events-plot)

### [Associated Constructors](#associated-constructors_1)

#### [Cumulative Events Plot](#cumulative-events-plot_1)

**Syntax:** obj \<< Cumulative Events Plot( ... ); scrobj = obj \<< Cumulative Events Plot

**Description:** Enables you to show or hide models in the Cumulative Events plot. If specified without an argument, this option returns a scriptable reference to the plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
plot = obj << Cumulative Events Plot;
plot << Crow AMSAA( 0 );


```

### [Item Messages](#item-messages_2)

#### [Crow AMSAA](#crow-amsaa_2)

**Syntax:** obj \<< Cumulative Events Plot( Crow AMSAA( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Crow AMSAA( state=0|1 ) ); scrobj \<< Crow AMSAA( state=0|1 ) )

**Description:** Shows or hides the Crow-AMSAA model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA;
Wait( 1 );
obj << Cumulative Events Plot( Crow AMSAA( 0 ) );
obj << Mean Time Between Failures Plot( Crow AMSAA( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Crow AMSAA( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Crow AMSAA( 0 );


```

#### [Crow AMSAA with Modified MLE](#crow-amsaa-with-modified-mle_1)

**Syntax:** obj \<< Cumulative Events Plot( Crow AMSAA with Modified MLE( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Crow AMSAA with Modified MLE( state=0|1 ) ); scrobj \<< Crow AMSAA with Modified MLE( state=0|1 ) )

**Description:** Shows or hides the Crow-AMSAA model with bias correction for beta in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA with Modified MLE;
Wait( 1 );
obj << Cumulative Events Plot( Crow AMSAA with Modified MLE( 0 ) );
obj << Mean Time Between Failures Plot( Crow AMSAA with Modified MLE( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA with Modified MLE;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Crow AMSAA with Modified MLE( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Crow AMSAA with Modified MLE( 0 );


```

#### [Fixed Parameter Crow AMSAA](#fixed-parameter-crow-amsaa_1)

**Syntax:** obj \<< Cumulative Events Plot( Fixed Parameter Crow AMSAA( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Fixed Parameter Crow AMSAA( state=0|1 ) ); scrobj \<< Fixed Parameter Crow AMSAA( state=0|1 ) )

**Description:** Shows or hides the Fixed Parameter Crow-AMSAA model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Fixed Parameter Crow AMSAA;
Wait( 1 );
obj << Cumulative Events Plot( Fixed Parameter Crow AMSAA( 0 ) );
obj << Mean Time Between Failures Plot( Fixed Parameter Crow AMSAA( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Fixed Parameter Crow AMSAA;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Fixed Parameter Crow AMSAA( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Fixed Parameter Crow AMSAA( 0 );


```

#### [Piecewise Weibull NHPP](#piecewise-weibull-nhpp_1)

**Syntax:** obj \<< Cumulative Events Plot( Piecewise Weibull NHPP( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Piecewise Weibull NHPP( state=0|1 ) ); scrobj \<< Piecewise Weibull NHPP( state=0|1 ) )

**Description:** Shows or hides the Piecewise Weibull NHPP model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP;
Wait( 1 );
obj << Cumulative Events Plot( Piecewise Weibull NHPP( 0 ) );
obj << Mean Time Between Failures Plot( Piecewise Weibull NHPP( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Piecewise Weibull NHPP( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Piecewise Weibull NHPP( 0 );


```

#### [Piecewise Weibull NHPP Change Point Detection](#piecewise-weibull-nhpp-change-point-detection_1)

**Syntax:** obj \<< Cumulative Events Plot( Piecewise Weibull NHPP Change Point Detection( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Piecewise Weibull NHPP Change Point Detection( state=0|1 ) ); scrobj \<< Piecewise Weibull NHPP Change Point Detection( state=0|1 ) )

**Description:** Shows or hides the Reinitialized Weibull NHPP model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/BrakeReliability.jmp" );
obj = dt << Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP Change Point Detection;
Wait( 1 );
obj << Cumulative Events Plot( Piecewise Weibull NHPP Change Point Detection( 0 ) );
obj << Mean Time Between Failures Plot( Piecewise Weibull NHPP Change Point Detection( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/BrakeReliability.jmp" );
obj = dt << Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP Change Point Detection;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Piecewise Weibull NHPP Change Point Detection( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Piecewise Weibull NHPP Change Point Detection( 0 );


```

#### [Reinitialized Weibull NHPP](#reinitialized-weibull-nhpp_1)

**Syntax:** obj \<< Cumulative Events Plot( Reinitialized Weibull NHPP( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Reinitialized Weibull NHPP( state=0|1 ) ); scrobj \<< Reinitialized Weibull NHPP( state=0|1 ) )

**Description:** Shows or hides the Reinitialized Weibull NHPP model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/ProductionEquipment.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Hours of Operation ),
    Event Count( :Fixes ),
    Phase( :Design Stage )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Reinitialized Weibull NHPP;
Wait( 1 );
obj << Cumulative Events Plot( Reinitialized Weibull NHPP( 0 ) );
obj << Mean Time Between Failures Plot( Reinitialized Weibull NHPP( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/ProductionEquipment.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Hours of Operation ),
    Event Count( :Fixes ),
    Phase( :Design Stage )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Reinitialized Weibull NHPP;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Reinitialized Weibull NHPP( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Reinitialized Weibull NHPP( 0 );


```

## [Fixed Parameter Crow AMSAA](#fixed-parameter-crow-amsaa_2)

### [Item Messages](#item-messages_3)

#### [Show Cumulative Events Plot](#show-cumulative-events-plot_1)

**Syntax:** scrobj \<< Show Cumulative Events Plot( state=0|1 )

**Description:** Shows or hides the Cumulative Events plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Cumulative Events Plot( 1 );


```

#### [Show Intensity Plot](#show-intensity-plot_1)

**Syntax:** scrobj \<< Show Intensity Plot( state=0|1 )

**Description:** Shows or hides the Intensity plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Intensity Plot( 1 );


```

#### [Show MTBF Plot](#show-mtbf-plot_1)

**Syntax:** scrobj \<< Show MTBF Plot( state=0|1 )

**Description:** Shows or hides the mean time between failures (MTBF) plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show MTBF Plot( 0 );


```

#### [Show Profilers](#show-profilers_1)

**Syntax:** scrobj \<< Show Profilers( state=0|1 )

**Description:** Shows or hides the profilers for mean time between failures (MTBF), failure intensity, and cumulative events.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Profilers( 1 );


```

#### [beta](#beta)

**Syntax:** obj \<< Fixed Parameter Crow AMSAA( beta( number ) )

**Description:** Specifies the value of the fixed beta parameter. If the argument is a missing value, then the parameter is not fixed.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
obj << Fixed Parameter Crow AMSAA( Beta( 0.8 ) );
Report( obj )["Crow-AMSAA"] << Close( 1 );


```

#### [lambda](#lambda)

**Syntax:** obj \<< Fixed Parameter Crow AMSAA( lambda( number ) )

**Description:** Specifies the value of the fixed lambda parameter. If the argument is a missing value, then the parameter is not fixed.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
obj << Fixed Parameter Crow AMSAA( lambda( 0.02 ) );
Report( obj )["Crow-AMSAA"] << Close( 1 );


```

## [Mean Time Between Failures Plot](#mean-time-between-failures-plot)

### [Associated Constructors](#associated-constructors_2)

#### [Mean Time Between Failures Plot](#mean-time-between-failures-plot_1)

**Syntax:** obj \<< Mean Time Between Failures Plot( ... ); scrobj = obj \<< Mean Time Between Failures Plot

**Description:** Enables you to show or hide models in the Mean Time Between Failures plot. If specified without an argument, this option returns a scriptable reference to the plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Crow AMSAA;
Report( obj )["Mean Time Between Failures"] << Close( 0 );
plot = obj << Mean Time Between Failures Plot;
plot << Crow AMSAA( 0 );


```

### [Item Messages](#item-messages_4)

#### [Crow AMSAA](#crow-amsaa_3)

**Syntax:** obj \<< Cumulative Events Plot( Crow AMSAA( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Crow AMSAA( state=0|1 ) ); scrobj \<< Crow AMSAA( state=0|1 ) )

**Description:** Shows or hides the Crow-AMSAA model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA;
Wait( 1 );
obj << Cumulative Events Plot( Crow AMSAA( 0 ) );
obj << Mean Time Between Failures Plot( Crow AMSAA( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Crow AMSAA( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Crow AMSAA( 0 );


```

#### [Crow AMSAA with Modified MLE](#crow-amsaa-with-modified-mle_2)

**Syntax:** obj \<< Cumulative Events Plot( Crow AMSAA with Modified MLE( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Crow AMSAA with Modified MLE( state=0|1 ) ); scrobj \<< Crow AMSAA with Modified MLE( state=0|1 ) )

**Description:** Shows or hides the Crow-AMSAA model with bias correction for beta in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA with Modified MLE;
Wait( 1 );
obj << Cumulative Events Plot( Crow AMSAA with Modified MLE( 0 ) );
obj << Mean Time Between Failures Plot( Crow AMSAA with Modified MLE( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Crow AMSAA with Modified MLE;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Crow AMSAA with Modified MLE( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Crow AMSAA with Modified MLE( 0 );


```

#### [Customize Average MTBF](#customize-average-mtbf)

**Syntax:** obj \<< Mean Time Between Failures( Options( Sample MTBF Type( "Customized Average MTBF" ), Customize Average MTBF( vector ) ) ); scrobj \<< Options( Sample MTBF Type( "Customized Average MTBF" ), Customize Average MTBF( vector ) )

**Description:** Specifies a set of disjoint intervals that are used to calculate mean time between failures (MTBF).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
obj << Mean Time Between Failures Plot(
    Options(
        Sample MTBF Type( "Customized Average MTBF" ),
        Customize Average MTBF( [2500, 5000, 7500, 11000] )
    )
);
(obj << report)["Mean Time Between Failures"] << Close( 0 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
plot = obj << Mean Time Between Failures Plot;
plot << Options(
    Sample MTBF Type( "Customized Average MTBF" ),
    Customize Average MTBF( [2500, 5000, 7500, 11000] )
);
(obj << report)["Mean Time Between Failures"] << Close( 0 );


```

#### [Fixed Parameter Crow AMSAA](#fixed-parameter-crow-amsaa_3)

**Syntax:** obj \<< Cumulative Events Plot( Fixed Parameter Crow AMSAA( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Fixed Parameter Crow AMSAA( state=0|1 ) ); scrobj \<< Fixed Parameter Crow AMSAA( state=0|1 ) )

**Description:** Shows or hides the Fixed Parameter Crow-AMSAA model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Fixed Parameter Crow AMSAA;
Wait( 1 );
obj << Cumulative Events Plot( Fixed Parameter Crow AMSAA( 0 ) );
obj << Mean Time Between Failures Plot( Fixed Parameter Crow AMSAA( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Fixed Parameter Crow AMSAA;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Fixed Parameter Crow AMSAA( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Fixed Parameter Crow AMSAA( 0 );


```

#### [Interval Size](#interval-size)

**Syntax:** obj \<< Mean Time Between Failures( Options( Sample MTBF Type( "Equal Interval Average MTBF" ), Interval Size( number ) ) ); scrobj \<< Options( Sample MTBF Type( "Equal Interval Average MTBF" ), Interval Size( number ) )

**Description:** Specifies the size of the interval that is used to calculate mean time between failures (MTBF).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Mean Time Between Failures Plot(
    Options( Sample MTBF Type( "Equal Interval Average MTBF" ), Interval Size( 2500 ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Mean Time Between Failures"] << Close( 0 );
plot = obj << Mean Time Between Failures Plot;
plot << Options( Sample MTBF Type( "Equal Interval Average MTBF" ), Interval Size( 2500 ) );


```

#### [Options](#options)

**Syntax:** obj \<< Mean Time Between Failures( Options( ... ) ); scrobj \<< Options( ... )

**Description:** Enables you to configure the Mean Time Between Failures plot.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Mean Time Between Failures Plot(
    Options( Sample MTBF Type( "Equal Interval Average MTBF" ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Options( Sample MTBF Type( "Equal Interval Average MTBF" ) );


```

#### [Piecewise Weibull NHPP](#piecewise-weibull-nhpp_2)

**Syntax:** obj \<< Cumulative Events Plot( Piecewise Weibull NHPP( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Piecewise Weibull NHPP( state=0|1 ) ); scrobj \<< Piecewise Weibull NHPP( state=0|1 ) )

**Description:** Shows or hides the Piecewise Weibull NHPP model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP;
Wait( 1 );
obj << Cumulative Events Plot( Piecewise Weibull NHPP( 0 ) );
obj << Mean Time Between Failures Plot( Piecewise Weibull NHPP( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Piecewise Weibull NHPP( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Piecewise Weibull NHPP( 0 );


```

#### [Piecewise Weibull NHPP Change Point Detection](#piecewise-weibull-nhpp-change-point-detection_2)

**Syntax:** obj \<< Cumulative Events Plot( Piecewise Weibull NHPP Change Point Detection( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Piecewise Weibull NHPP Change Point Detection( state=0|1 ) ); scrobj \<< Piecewise Weibull NHPP Change Point Detection( state=0|1 ) )

**Description:** Shows or hides the Reinitialized Weibull NHPP model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/BrakeReliability.jmp" );
obj = dt << Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP Change Point Detection;
Wait( 1 );
obj << Cumulative Events Plot( Piecewise Weibull NHPP Change Point Detection( 0 ) );
obj << Mean Time Between Failures Plot( Piecewise Weibull NHPP Change Point Detection( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/BrakeReliability.jmp" );
obj = dt << Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Piecewise Weibull NHPP Change Point Detection;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Piecewise Weibull NHPP Change Point Detection( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Piecewise Weibull NHPP Change Point Detection( 0 );


```

#### [Reinitialized Weibull NHPP](#reinitialized-weibull-nhpp_2)

**Syntax:** obj \<< Cumulative Events Plot( Reinitialized Weibull NHPP( state=0|1 ) ); obj \<< Mean Time Between Failures Plot( Reinitialized Weibull NHPP( state=0|1 ) ); scrobj \<< Reinitialized Weibull NHPP( state=0|1 ) )

**Description:** Shows or hides the Reinitialized Weibull NHPP model in the Cumulative Events or Mean Time Between Failures plot. On by default.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/ProductionEquipment.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Hours of Operation ),
    Event Count( :Fixes ),
    Phase( :Design Stage )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Reinitialized Weibull NHPP;
Wait( 1 );
obj << Cumulative Events Plot( Reinitialized Weibull NHPP( 0 ) );
obj << Mean Time Between Failures Plot( Reinitialized Weibull NHPP( 0 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/ProductionEquipment.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Hours of Operation ),
    Event Count( :Fixes ),
    Phase( :Design Stage )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Reinitialized Weibull NHPP;
Wait( 1 );
cep = obj << Cumulative Events Plot;
cep << Reinitialized Weibull NHPP( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Reinitialized Weibull NHPP( 0 );


```

#### [Sample MTBF Type](#sample-mtbf-type)

**Syntax:** obj \<< Mean Time Between Failures( Options( Sample MTBF Type( "Equal Interval Average MTBF"|"Customized Average MTBF" ) ) ); scrobj \<< Options( Sample MTBF Type( "Equal Interval Average MTBF"|"Customized Average MTBF" ) )

**Description:** Specifies the calculation method for the Mean Time Between Failures plot.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
obj << Mean Time Between Failures Plot(
    Options( Sample MTBF Type( "Equal Interval Average MTBF" ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/TurbineEngineDesign1.jmp" );
obj = dt << Reliability Growth(
    Input Format( Time to Event ),
    Time to Event( :Day ),
    Event Count( :Fixes ),
    Phase( :Design Phase )
);
Report( obj )["Mean Time Between Failures"] << Close( 0 );
mtbf = obj << Mean Time Between Failures Plot;
mtbf << Options( Sample MTBF Type( "Equal Interval Average MTBF" ) );


```

## [Reliability Growth Report](#reliability-growth-report)

### [Item Messages](#item-messages_5)

#### [Show Cumulative Events Plot](#show-cumulative-events-plot_2)

**Syntax:** scrobj \<< Show Cumulative Events Plot( state=0|1 )

**Description:** Shows or hides the Cumulative Events plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Cumulative Events Plot( 1 );


```

#### [Show Intensity Plot](#show-intensity-plot_2)

**Syntax:** scrobj \<< Show Intensity Plot( state=0|1 )

**Description:** Shows or hides the Intensity plot.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Intensity Plot( 1 );


```

#### [Show MTBF Plot](#show-mtbf-plot_2)

**Syntax:** scrobj \<< Show MTBF Plot( state=0|1 )

**Description:** Shows or hides the mean time between failures (MTBF) plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show MTBF Plot( 0 );


```

#### [Show Profilers](#show-profilers_2)

**Syntax:** scrobj \<< Show Profilers( state=0|1 )

**Description:** Shows or hides the profilers for mean time between failures (MTBF), failure intensity, and cumulative events.

```

dt = Open( "$SAMPLE_DATA/Reliability/NewEngineOperation.jmp" );
obj = dt << Reliability Growth( Input Format( Time to Event ), Time to Event( :Hours ) );
Report( obj )["Observed Data"] << Close( 1 );
report = obj << Crow AMSAA;
report << Show Profilers( 1 );


```

# [Repeated Measures Degradation](#repeated-measures-degradation)

## [Associated Constructors](#associated-constructors)

### [Repeated Measures Degradation](#repeated-measures-degradation_1)

**Syntax:** Repeated Measures Degradation( Y( column ), Time( column ), \<X( column )>, \<Freq( column )>, \<Censor( column ), Censor Code( value )> )

**Description:** Models repeated measures degradation data over time with random parameters.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

## [Columns](#columns)

### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    Freq( :_freqcol )
);


```

### [Label](#label)

**Syntax:** obj \<< Label( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [System ID](#system-id)

**Syntax:** obj \<< System ID( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [Time](#time)

**Syntax:** obj \<< Time( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [X](#x)

**Syntax:** obj \<< X( column )

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

## [Item Messages](#item-messages)

### [Bayesian Models](#bayesian-models)

**Syntax:** obj \<< Bayesian Models

**Description:** Specify Bayesian models.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 190 ),
    Bayesian Models(
        Y Transformation( "Linear" ),
        X Transformation( "Linear" ),
        Degradation Path Name( "First Order Kinetics Type2" ),
        Models(
            Model(
                Parameter( {"b1", "Lognormal"}, {"b2", "Lognormal"} ),
                Prior(
                    {"μ[log|b1|]", Distribution( "Normal < >" ),
                    Prior Parameter( "Lower 99% Limit", -1 ),
                    Prior Parameter( "Upper 99% Limit", 3 )},
                    {"σ[log|b1|]", Distribution( "Half Cauchy ( )" ),
                    Prior Parameter( "Scale", 0.5 )},
                    {"μ[log|b2|]", Distribution( "Normal < >" ),
                    Prior Parameter( "Lower 99% Limit", -10 ),
                    Prior Parameter( "Upper 99% Limit", -5 )},
                    {"σ[log|b2|]", Distribution( "Half Cauchy ( )" ),
                    Prior Parameter( "Scale", 0.5 )},
                    {"ρ[log|b1|,log|b2|]", Distribution( "Normal ( )" ),
                    Prior Parameter( "Location", 0 ), Prior Parameter( "Scale", 4 )},
                    {"b3", Distribution( "Normal < >" ),
                    Prior Parameter( "Lower 99% Limit", -10 ),
                    Prior Parameter( "Upper 99% Limit", 10 )},
                    {"σ[ε]", Distribution( "Half Cauchy ( )" ), Prior Parameter( "Scale", 3 )
                    }
                ),
                Random Seed( 32323 ),
                Number of Monte Carlo Iterations( 5000 ),
                Warmup Laps( 10 ),
                Auto Thinning( 1 ),
                Thinning( 1 ),
                N Chains( 1 ),
                Run()
            ),

        )
    ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),

);


```

### [Control](#control)

**Syntax:** obj \<< Control

**Description:** Specifies the transformation of the response, the transformation of time, and the model type.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Lower Spec Limit( -0.5 ),
    Reference X( "Celsius", 195 ),
    Control( "Linear", "Linear", "Linear" )
);


```

### [Reference Temperature](#reference-temperature)

**Syntax:** obj \<< Reference Temperature

**Description:** Sets the reference temperature value used by appropriate models.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Lower Spec Limit( -0.5 ),
    Use Condition( 80 ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);


```

### [Reference X](#reference-x)

**Syntax:** obj \<< Reference X

**Description:** Sets the reference value used by appropriate models.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Lower Spec Limit( -0.5 ),
    Use Condition( 80 ),
    Reference X( 195 ),
    Control( "Linear", "Linear", "Polynomial Rate" )
);


```

### [Save Posterior To Script](#save-posterior-to-script)

**Syntax:** obj \<< Save Posterior To Script( state=0|1 )

**Description:** Specifies that when you save the script for the current report, the script contains the posterior samples. If you run the saved script, the posterior samples are loaded directly from the script into the Repeated Measures Degradation analysis. On by default.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 190 ),
    Bayesian Models(
        Y Transformation( "Linear" ),
        X Transformation( "Linear" ),
        Degradation Path Name( "First Order Kinetics Type2" ),
        Models(
            Model(
                Parameter( {"b1", "Lognormal"}, {"b2", "Lognormal"} ),
                Prior(
                    {"μ[log|b1|]", Distribution( "Normal < >" ),
                    Prior Parameter( "Lower 99% Limit", -1 ),
                    Prior Parameter( "Upper 99% Limit", 3 )},
                    {"σ[log|b1|]", Distribution( "Half Cauchy ( )" ),
                    Prior Parameter( "Scale", 0.5 )},
                    {"μ[log|b2|]", Distribution( "Normal < >" ),
                    Prior Parameter( "Lower 99% Limit", -10 ),
                    Prior Parameter( "Upper 99% Limit", -5 )},
                    {"σ[log|b2|]", Distribution( "Half Cauchy ( )" ),
                    Prior Parameter( "Scale", 0.5 )},
                    {"ρ[log|b1|,log|b2|]", Distribution( "Normal ( )" ),
                    Prior Parameter( "Location", 0 ), Prior Parameter( "Scale", 4 )},
                    {"b3", Distribution( "Normal < >" ),
                    Prior Parameter( "Lower 99% Limit", -10 ),
                    Prior Parameter( "Upper 99% Limit", 10 )},
                    {"σ[ε]", Distribution( "Half Cauchy ( )" ), Prior Parameter( "Scale", 3 )
                    }
                ),
                Random Seed( 32323 ),
                Number of Monte Carlo Iterations( 5000 ),
                Warmup Laps( 10 ),
                Auto Thinning( 1 ),
                Thinning( 1 ),
                N Chains( 1 ),
                Run()
            ),

        )
    ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),

);
obj << Save Posterior to Script( 1 );
obj << Save Script to Script Window;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$SAMPLE_DATA/Reliability/Device B.jmp" );
obj = dt << Repeated Measures Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Reference Temperature( "Celsius", 195 ),
    Control( "Linear", "Linear", "First Order Kinetics Type 2" )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Repeated Measures Degradation(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Response Screening](#response-screening)

## [Associated Constructors](#associated-constructors)

### [Response Screening](#response-screening_1)

**Syntax:** Response Screening( Y( columns ), X( columns ) )

**Description:** Automates the process of conducting tests for linear model effects across a large number of responses. Test results and summary statistics are presented in data tables and plots. The false discovery rate (FDR) guards against incorrect declarations of significance. A robust estimation method reduces the sensitivity of tests to outliers.

#### [Response Screening in subgroups with volcano plot selected](#response-screening-in-subgroups-with-volcano-plot-selected)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( :Trait1, :Trait2, :Trait3, :Trait4 ),
    X( :Father, :Mother, :Sex, :Disease Status ),
    Subgroup( Column Group( "Markers" ) ),
    Common Y Scale( 1 ),
    SendToReport( Dispatch( {}, "", TabListBox, {Set Selected( 4 )} ) )
);


```

#### [Response Screening of 4 Responses and 26 Prospective Predictors](#response-screening-of-4-responses-and-26-prospective-predictors)

```


dt = Open( "$SAMPLE_DATA/Baltic.jmp" );
obj = dt << Response Screening( Y( :ls, :ha, :dt ), X( Column Group( "Intensities" ) ) );


```

#### [Response Screening of Many Columns in Groups](#response-screening-of-many-columns-in-groups)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Markers" ) ),
    X( :Trait1, :Trait2, :Trait3, :Trait4 ),
    Grouping( "Sex" )
);


```

#### [Response Screening of Many Columns on Each of Four Predictors](#response-screening-of-many-columns-on-each-of-four-predictors)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Markers" ) ),
    X( :Trait1, :Trait2, :Trait3, :Trait4 )
);


```

#### [Response Screening of Many Columns with Means Differences Volcano Plot](#response-screening-of-many-columns-with-means-differences-volcano-plot)

```


dt = Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Markers" ) ),
    X( :Father, :Mother, :Sex, :Disease Status ),
    Common Y Scale( 1 ),
    Volcano Plots Use FDR Axis( 1 ),
    SendToReport(
        Dispatch( {}, "", TabListBox( 1 ), {Set Selected( 4 )} ),
        Dispatch( {}, "", TabListBox( 2 ), {Set Selected( 2 )} )
    )
);


```

#### [Response Screening Specified with Column Numbers](#response-screening-specified-with-column-numbers)

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );


```

#### [Response Screening with Robust Fitting](#response-screening-with-robust-fitting)

```


dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = dt << Response Screening(
    Y( Column Group( "Responses" ) ),
    X( :Process ),
    Robust( 1 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Response Screening(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Freq](#freq)

**Syntax:** obj = Response Screening(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ), Freq( :_freqcol ) );


```

### [Grouping](#grouping)

**Syntax:** obj = Response Screening(...\<Grouping( column(s) )>...)

**Description:** Specifies categorical columns as grouping variables. The rows assigned to each level of the specified column are analyzed separately.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Grouping( :Site )
);


```

### [Response](#response)

**Syntax:** obj = Response Screening(...Response( column(s) )...)

**Description:** Specifies the response variables that contain the measurements to be analyzed.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );


```

### [Subgroup](#subgroup)

**Syntax:** obj = Response Screening(...\<Subgroup( column(s) )>...)

**Description:** Specifies one or more subgroup variables. When a subgroup variable is defined, additional fits are performed for each category of the subgroup variable.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Subgroup( :Site )
);


```

### [Weight](#weight)

**Syntax:** obj = Response Screening(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ), Weight( :_weightcol ) );


```

### [X](#x)

**Syntax:** obj = Response Screening(...X( column(s) )...)

**Description:** Specifies the predictor variables.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );


```

### [Y](#y)

**Syntax:** obj = Response Screening(...Y( column(s) )...)

**Description:** Specifies the response variables that contain the measurements to be analyzed.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );


```

## [Item Messages](#item-messages)

### [Cauchy](#cauchy)

**Syntax:** obj = Response Screening(...Cauchy( state=0|1 )...)

**Description:** Estimates parameters using maximum likelihood and a Cauchy link function. This estimation method assumes that the errors have a Cauchy distribution, which has fatter tails than the normal distribution. This method reduces the emphasis on outliers.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << Response Screening( X( :Process ), Y( Eval( 8 :: 48 ) ), Cauchy( 1 ) );


```

### [Common X Scale](#common-x-scale)

**Syntax:** obj = Response Screening(...Common X Scale( state=0|1 )...)

**Description:** Notifies the platform that all continuous X variables are on the same scale. This is necessary to compare the slopes of different X variables.

```

dt = Open( "$Sample_Data/Iris.jmp" );
dt << Response Screening(
    Y( :Sepal length, :Sepal width ),
    X( :Petal length, :Petal width ),
    Common X Scale
);


```

### [Common Y Scale](#common-y-scale)

**Syntax:** obj = Response Screening(...Common Y Scale( state=0|1 )...)

**Description:** Notifies the platform that all continuous responses are on the same scale. This is necessary to compare the means differences or slopes.

```

dt = Open( "$Sample_Data/Iris.jmp" );
dt << Response Screening(
    X( :Species ),
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Common Y Scale
);


```

### [Comparisons](#comparisons)

**Syntax:** obj = Response Screening(...Comparisons( "Each with Control"|"All Combinations" )...)

**Description:** Specifies the method for comparing means or rates. You can compare each level with a control group level or compare all possible level combinations.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Response Screening(
    X( :Age Group ),
    Y( :Single Status, :Gender, :I am working on my career ),
    Comparisons( "All combinations" ),
    Name( "2 by M Table" )(1)
);


```

### [Corr](#corr)

**Syntax:** obj = Response Screening(...Corr( state=0|1 )...)

**Description:** Computes the Pearson product-moment correlation in terms of the indices that are defined by the value ordering.

```

dt = Open( "$Sample_Data/Consumer Preferences.jmp" );
dt << Response Screening(
    X( :Employee Tenure, :Position Tenure, :Age Group ),
    Y( :Job Satisfaction ),
    Corr( 1 )
);


```

### [Empirical Bayes Shrinkage](#empirical-bayes-shrinkage)

**Syntax:** obj = Response Screening(...Empirical Bayes Shrinkage( state=0|1 )...)

**Description:** Shrinks residual variance estimates toward an estimated prior mode, borrowing strength across all estimates. This is useful when screening many continuous Y variables on a common scale.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 88 ) ),
    Common Y Scale,
    Empirical Bayes Shrinkage( 1 )
);


```

### [Fit Selected Items](#fit-selected-items)

**Syntax:** obj \<< Fit Selected Items

**Description:** Adds Fit Y by X reports to the Response Screening report. The added reports correspond to selected points in the plots or selected rows in the Result Table.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = Response Screening( X( :Process ), Y( Column Group( "Responses" ) ) );
obj << Select Where( FDR Logworth > 200 );
obj << Fit Selected Items;


```

### [Force X Categorical](#force-x-categorical)

**Syntax:** obj = Response Screening(...Force X Categorical( state=0|1 )...)

**Description:** Ignores the modeling type and treats all X columns as categorical.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Response Screening( X( :height, :sex ), Y( :age, :weight ), Force X Categorical( 1 ) );


```

### [Force X Continuous](#force-x-continuous)

**Syntax:** obj = Response Screening(...Force X Continuous( state=0|1 )...)

**Description:** Ignores the modeling type and treats all X columns as continuous.

```

dt = Open( "$Sample_Data/Consumer Preferences.jmp" );
dt << Response Screening(
    X( :Age Group, :Job Satisfaction ),
    Y( :Gender, :Single Status ),
    Force X Continuous( 1 )
);


```

### [Force Y Categorical](#force-y-categorical)

**Syntax:** obj = Response Screening(...Force Y Categorical( state=0|1 )...)

**Description:** Ignores the modeling type and treats all Y columns as categorical.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Response Screening( Y( :height, :sex ), X( :age, :weight ), Force Y Categorical( 1 ) );


```

### [Force Y Continuous](#force-y-continuous)

**Syntax:** obj = Response Screening(...Force Y Continuous( state=0|1 )...)

**Description:** Ignores the modeling type and treats all Y columns as continuous.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Response Screening( Y( :age ), X( :height, :weight ), Force Y Continuous( 1 ) );


```

### [Get Crosstab RTF](#get-crosstab-rtf)

**Syntax:** obj \<< Get Crosstab RTF( state=0|1 )

**Description:** Get an RTF source for a crosstab table.

**JMP Version Added:** 19

### [Get Crosstab Script](#get-crosstab-script)

**Syntax:** obj \<< Get Crosstab Script( state=0|1 )

**Description:** Get a JSL display script for a crosstab table.

**JMP Version Added:** 19

### [Get PValues](#get-pvalues)

**Syntax:** obj \<< Get PValues

**Description:** Returns a reference to the PValues table.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Save Outlier Indicator
);
pvals = obj << Get PValues;
Show( pvals );


```

### [Kappa](#kappa)

**Syntax:** obj = Response Screening(...Kappa( state=0|1 )...)

**Description:** Adds a new column called Kappa to the Result Table. Kappa is a measure of agreement between Y and X.

```

dt = Open( "$Sample_Data/Mail Messages.jmp" );
dt << Response Screening( X( :From ), Y( :To ), Kappa( 1 ) );


```

### [Kruskal Wallis Test](#kruskal-wallis-test)

**Syntax:** obj = Response Screening(...Kruskal Wallis Test( state=0|1 )...)

**Description:** Computes the Kruskal-Wallis test, a nonparametric (Wilcoxon) rank-based test for continuous Y by categorical X.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Response Screening( X( :sex ), Y( :height, :weight ), Kruskal Wallis Test( 1 ) );


```

### [Max Comparison Levels](#max-comparison-levels)

**Syntax:** obj = Response Screening(...Max Comparison Levels( number=100 )...)

**Description:** Specifies the number of levels that are supported in comparisons. "100" by default.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Wafer Number ),
    Y( Column Group( "Responses" ) ),
    Max Comparison Levels( 24 )
);


```

### [Max Logworth](#max-logworth)

**Syntax:** obj = Response Screening(...Max Logworth( number )...)

**Description:** Controls the scale of plots involving logworth values. Logworth values that exceed the specified value are plotted as the specified value to prevent extreme scales in logworth plots.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Max Logworth( 1000 )
);


```

### [Missing is Category](#missing-is-category)

**Syntax:** obj = Response Screening(...Missing is Category( state=0|1 )...)

**Description:** Treats the missing values of a categorical variable as a separate category.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
Row() = 1;
:age = .;
Row() = 8;
:age = .;
dt << Response Screening( X( :age ), Y( :sex ), Missing is Category( 1 ) );


```

### [Negative Binomial Y](#negative-binomial-y)

**Syntax:** obj = Response Screening(...Negative Binomial Y( state=0|1 )...)

**Description:** Fits each Y response as a count having a Negative Binomial distribution.

```

dt = Open( "$Sample_Data/Quality Control/Failure2.jmp" );
dt << Response Screening(
    X( :clean ),
    Grouping( :failure ),
    Y( :N ),
    Negative Binomial Y( 1 )
);


```

### [No Report](#no-report)

**Syntax:** obj = Response Screening(...No Report( state=0|1 )...)

**Description:** Suppresses the report window. Use this option to run Save commands to obtain results without the report window appearing.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Save PValues,
    No Report( 1 )
);


```

### [PValues Table on Launch](#pvalues-table-on-launch)

**Syntax:** obj = Response Screening(...PValues Table on Launch( state=0|1 )...)

**Description:** Creates a data table for the p-values and individual model fit statistics. "0" by default.

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 88 ) ),
    Robust,
    PValues Table on Launch( 1 )
);


```

### [Paired X and Y](#paired-x-and-y)

**Syntax:** obj = Response Screening(...Paired X and Y( state=0|1 )...)

**Description:** Performs tests only for Y columns paired with X columns according to their order in the launch window. For example, Y1 is paired with X1 and Y2 is paired with X2.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Response Screening( X( :age, :sex ), Y( :height, :weight ), Paired X and Y( 1 ) );


```

### [Poisson Y](#poisson-y)

**Syntax:** obj = Response Screening(...Poisson Y( state=0|1 )...)

**Description:** Fits each Y response as a count having a Poisson distribution.

```

dt = Open( "$Sample_Data/Quality Control/Failure2.jmp" );
dt << Response Screening( X( :clean ), Grouping( :failure ), Y( :N ), Poisson Y( 1 ) );


```

### [Practical Difference Portion](#practical-difference-portion)

**Syntax:** obj \<< Practical Difference Portion( number=0.10 )

**Description:** Specifies the fraction of the specification range that represents a difference that you consider practically meaningful. "0.10" by default.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 48 ) ),
    Practical Difference Portion( .2 ),
    Save Compare Means
);


```

### [Practical Differences and Equivalences](#practical-differences-and-equivalences)

**Syntax:** obj \<< Practical Differences and Equivalences( Practical Portion(fraction) | Specific Difference(number) )

**Description:** Given a difference to detect, tests if the actual difference is significantly greater than or significantly less than that difference to detect in absolute value.

### [Quartiles per Group](#quartiles-per-group)

**Syntax:** obj = Response Screening(...Quartiles per Group( state=0|1 )...)

**Description:** Computes the quartiles and range for each group for continuous Y by categorical X.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Response Screening( X( :sex ), Y( :height, :weight ), Quartiles per Group( 1 ) );


```

### [Ratio Adjustment](#ratio-adjustment)

**Syntax:** obj = Response Screening(...Ratio Adjustment( "No Adjustment"|"Add 0.5 when any zero"|"Add 0.5 always" )...)

**Description:** Provides options to add 0.5 to cell counts when calculating risk ratios, odds ratios, and risk differences. This adjustment avoids problems that arise from dividing by zero.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Response Screening(
    X( :Age Group ),
    Y( :Single Status, :Gender, :I am working on my career ),
    Ratio Adjustment( "Add 0.5 Always" ),
    Name( "2 by M Table" )(1)
);


```

### [Robust](#robust)

**Syntax:** obj = Response Screening(...Robust( state=0|1 )...)

**Description:** Fits regression and ANOVA models using the Huber M-estimation method, which is resistant to outliers.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << Response Screening( X( :Process ), Y( Eval( 8 :: 88 ) ), Robust( 1 ) );


```

### [Save 2 by M](#save-2-by-m)

**Syntax:** obj \<< Name( "Save 2 by M table" )

**Description:** Saves the information in the 2 by M Results report, as well as other test statistics, to a new data table.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Response Screening(
    X( :Age Group ),
    Y( :Single Status, :Gender, :I am working on my career )
);
obj << Name( "2 by M Table" )(1);
obj << Name( "Save 2 by M Table" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Response Screening(
    X( :Age Group ),
    Y( :Single Status, :Gender, :I am working on my career )
);
obj << "2 by M Table"n( 1 );
obj << "Save 2 by M Table"n;


```

### [Save Compare Means](#save-compare-means)

**Syntax:** obj \<< Save Compare Means

**Description:** Creates a data table that contains the results from testing all pairwise comparisons across the levels of the categorical variable.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Save Compare Means
);


```

### [Save Means](#save-means)

**Syntax:** obj \<< Save Means

**Description:** Creates a data table that contains the counts, means, and standard deviations for each level of the categorical variable.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening( X( :Process ), Y( Column Group( "Responses" ) ), Save Means );


```

### [Save Means Differences](#save-means-differences)

**Syntax:** obj \<< Save Means Differences

**Description:** Creates a data table that contains the results from testing all pairwise comparisons across the levels of the categorical variable.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Save Means Differences
);


```

### [Save Outlier Indicator](#save-outlier-indicator)

**Syntax:** obj \<< Save Outlier Indicator

**Description:** Saves a group of indicator columns to the original data table to indicate outliers.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Save Outlier Indicator
);


```

### [Save PValues](#save-pvalues)

**Syntax:** obj \<< Save PValues

**Description:** Creates a data table that contains the information in the Result Table.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening( X( :Process ), Y( Column Group( "Responses" ) ), Save PValues );


```

### [Save Std Residuals](#save-std-residuals)

**Syntax:** obj \<< Save Std Residuals

**Description:** For each fit, adds a column to the original data table that contains the residuals divided by their estimated standard deviation.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Column Group( "Responses" ) ),
    Save Std Residuals
);


```

### [Select Columns](#select-columns)

**Syntax:** obj \<< Select Columns( condition )

**Description:** Selects columns in the original data table that correspond to selected rows in the Result Table.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = Response Screening( X( :Process ), Y( Column Group( "Responses" ) ) );
obj << Select Where( FDR Logworth > 200 );
obj << Select Columns;


```

### [Select Where](#select-where)

**Syntax:** obj \<< Select Where

**Description:** Selects items in the report table that correspond to a particular condition.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = Response Screening( X( :Process ), Y( Column Group( "Responses" ) ) );
obj << Select Where( FDR Logworth > 200 );


```

### [Show Crosstab Report](#show-crosstab-report)

**Syntax:** obj \<< Show Crosstab Report( state=0|1 )

**Description:** Experimental Hidden Feature: Show the details for each X and Y combination in a crosstab cell

**JMP Version Added:** 19

### [Show Means Differences](#show-means-differences)

**Syntax:** obj \<< Show Means Differences

**Description:** Shows the Logworth by Difference plot and the Means Differences report in the Response Screening report window. This option assumes that the Y variables are on a common scale.

```


Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
Response Screening(
    Y( Column Group( "Markers" ) ),
    X( :Sex, :Disease Status ),
    Common Y Scale( 1 ),
    Show Means Differences( 1 ),
    SendToReport(
        Dispatch( {}, "", TabListBox, {Set Selected( 4 )} ),
        Dispatch( {}, "", TabListBox( 2 ), {Set Selected( 2 )} )
    )
);


```

### [Show Plots](#show-plots)

**Syntax:** obj \<< Show Plots( state=0|1 )

**Description:** Shows or hides the plots in the report window. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = Response Screening( X( :Process ), Y( Column Group( "Responses" ) ) );
obj << Show Result Tables( 0 );


```

### [Show Report Tables](#show-report-tables)

**Syntax:** obj \<< Show Report Tables( state=0|1 )

**Description:** Shows or hides the result tables in the report window. On by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
obj = Response Screening( X( :Process ), Y( Column Group( "Responses" ) ) );
obj << Show Result Tables( 0 );


```

### [Show Slopes](#show-slopes)

**Syntax:** obj \<< Show Slopes

**Description:** Shows the Logworth by Slope plot in the Response Screening report window. This option assumes that the Y variables are on a common scale and the X variables are on a common scale.

```


Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
Response Screening(
    Y( :Trait1, :Trait2, :Trait3, :Trait4 ),
    X( Column Group( "Markers" ) ),
    Show Slopes( 1 ),
    SendToReport( Dispatch( {}, "", TabListBox, {Set Selected( 4 )} ) )
);


```

### [Specific Difference to Detect](#specific-difference-to-detect)

**Syntax:** obj \<< Specific Difference to Detect( number )

**Description:** Specifies a difference to detect rather than a portion of a specification range or sigma. This option assumes that all Y variables are on the same scale.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 48 ) ),
    Practical Difference Portion( .2 ),
    Save Compare Means
);


```

### [Subgroup Twoway](#subgroup-twoway)

**Syntax:** obj = Response Screening(...Subgroup Twoway( state=0|1 )...)

**Description:** Fits all of the two-way subgroup combinations. This option is available only when at least one Subgroup variable is defined.

```

dt = Open( "$Sample_Data/Big Class.jmp" );
dt << Response Screening(
    X( :height ),
    Y( :weight ),
    Subgroup( :age, :sex ),
    Subgroup Twoway( 1 )
);


```

### [Tabbed Report Layout](#tabbed-report-layout)

**Syntax:** obj \<< Tabbed Report Layout( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 17

### [Unthreaded](#unthreaded)

**Syntax:** obj = Response Screening(...Unthreaded( state=0|1 )...)

**Description:** Suppresses multithreading.

```

dt = Open( "$SAMPLE_DATA/Probe.jmp" );
dt << Response Screening(
    Y( :DELL_RPNBR, :DELL_RPPBR, :DELW_M1, :DELW_M2, :DELW_NBASE ),
    X( :Process ),
    Unthreaded( 1 )
);


```

### [Volcano Plots Use FDR Axis](#volcano-plots-use-fdr-axis)

**Syntax:** obj = Response Screening(...Volcano Plots Use FDR Axis( state=0 )...)

**Description:** Use FDR-adjusted Logworth instead of unadjusted Logworth on vertical axis for volcano plots. "0" by default.

**JMP Version Added:** 18

```


Open( "$Sample_Data/Life Sciences/Genotypes Pedigree.jmp" );
Response Screening(
    Y( :Trait1, :Trait2, :Trait3, :Trait4 ),
    X( Column Group( "Markers" ) ),
    Common Y Scale( 1 ),
    Common X Scale( 1 ),
    Volcano Plots Use FDR Axis( 1 ),
    SendToReport( Dispatch( {}, "", TabListBox, {Set Selected( 4 )} ) )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$Sample_Data/Probe.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Response Screening(
    X( :Process ),
    Y( Eval( 8 :: 108 ) ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```


dt = Open( "$Sample_Data/Probe.jmp" );
obj = dt << Response Screening( X( :Process ), Y( Eval( 8 :: 108 ) ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Response Screening(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Run Program](#run-program)

## [Associated Constructors](#associated-constructors)

### [Run Program](#run-program_1)

**Syntax:** obj = Run Program( Executable( "path/etc.exe" ), < Options( {"/a", "/b etc" } ) >, < Parameter( optParm ) >, < Read Function( Function( {this, optParm}, etc ) | "text" | "blob" ) >, < Write Function( Function( {this, optParm}, etc ) ) > )

**Description:** Control an external program using stdin and stdout.

```

RP = Run Program(
    Executable( "PING.EXE"/*path probably not needed*/ ),
    Options( {"-n 5", "localhost"} ),
    ReadFunction( Function( {this}, Write( this << read ) ) )
);


```

## [Item Messages](#item-messages)

### [Can Read](#can-read)

**Syntax:** bool = obj \<< Can Read

**Description:** Returns 1 if the RunProgram object can be read from and 0 if not.

```


value = "";
rp = Run Program( Executable( "ping.exe" ), Options( {"-n 5", "localhost"} ) );
While( !(rp << Is Read EOF), If( rp << Can Read, value ||= rp << Read, Wait( 0.01 ) ) );
Show( value );


```

### [Can Write](#can-write)

**Syntax:** bool = obj \<< Can Write

**Description:** Returns boolean for whether or not the RunProgram object can be written to via standard input.

### [Is Read EOF](#is-read-eof)

**Syntax:** bool = obj \<< Is Read EOF

**Description:** Returns 1 if the program has finished writing to standard output and 0 if not.

```


value = "";
rp = Run Program( Executable( "ping.exe" ), Options( {"-n 5", "localhost"} ) );
While( !(rp << Is Read EOF), If( rp << Can Read, value ||= rp << Read, Wait( 0.01 ) ) );
Show( value );


```

### [Read](#read)

**Syntax:** value = obj \<< Read( < "blob" > )

**Description:** Read standard output from executable as text or blob.

```


value = "";
rp = Run Program(
    Executable( "ping.exe" ),
    Options( {"-n 5", "localhost"} ),
    ReadFunction(
        Function( {this},
            value ||= this << read;
            Show( value );
        )
    )
);


```

### [Write](#write)

**Syntax:** obj \<< Write( string )

**Description:** Write text to the program's standard input.

### [Write EOF](#write-eof)

**Syntax:** obj \<< Write EOF

**Description:** Write the end of file for the RunProgram object.

# [SAS Cloud Analytic Services (CAS)](#sas-cloud-analytic-services-cas)

## [CAS Action](#cas-action)

### [Item Messages](#item-messages)

#### [Action](#action)

**Syntax:** action \<< Action(...)

**Description:** Sets the action name for the CAS action. The Action message can accept fully qualified actionset.action specification.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
echo = [=> ];
echo["a"] = 1;
echo["b"] = JSON Literal( true );
echo["c"] = 3.141559;
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );
rc = cas << Submit( action );


```

#### [Action Set](#action-set)

**Syntax:** action \<< Action Set(...)

**Description:** Sets the action set for the CAS action. CAS actions are grouped by action set. This is optional since the CAS Action message can accept fully qualified actionset.action specification.

**JMP Version Added:** 15

```


action = New CAS Action();
action << Action Set( "builtins" );


```

#### [Authorization](#authorization)

**Syntax:** action \<< Authorization(\<1|0>)

**Description:** Sets an authorization requirement for a CAS action. CAS actions automatically require Connect, Login, Authorization, and Session.

**JMP Version Added:** 15

```


code =
"\[
  data temp;
  x = 9.1; y = 6; z = sqrt(x**2 + y**2);
  A = "SAS"; B = "Statistics";
  put _ALL_;              /* display all variables and values */
  run;
  ]\";
runCode = [=> ];
runCode["code"] = code;
action = New CAS Action( Action( "dataStep.runCode" ), JSON( runCode ), Authorization( 1 ) );


```

#### [Connection](#connection)

**Syntax:** action \<< Connection(\<1|0>)

**Description:** Sets a connection requirement for a CAS action. CAS actions automatically require Connect, Login, Authorization, and Session.

**JMP Version Added:** 15

```


code =
"\[
  data temp;
  x = 9.1; y = 6; z = sqrt(x**2 + y**2);
  A = "SAS"; B = "Statistics";
  put _ALL_;              /* display all variables and values */
  run;
  ]\";
runCode = [=> ];
runCode["code"] = code;
action = New CAS Action( Action( "dataStep.runCode" ), JSON( runCode ), Connection( 1 ) );


```

#### [Endpoint](#endpoint)

**Syntax:** action \<< Endpoint(...)

**Description:** Sets the endpoint for the CAS action. An endpoint is the resource relative to the base CAS server URL. In the case of http://cloud.example.com:8777/cas/sessions, /cas/sessions is the endpoint. For most CAS actions use the Action message where the correct endpoint will automatically be selected.

**JMP Version Added:** 15

```


action = New CAS Action();
action << Endpoint( "/cas/sessions" );


```

#### [File](#file)

**Syntax:** action \<< File(...)

**Description:** Sets the file parameter for a CAS action. Any path variables in the file name are expanded. The CAS action automatically moves any JSON argument to a JSON Parameters argument if the File message is used.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
args =
"\[
{
    "casout": {
        "caslib": "casuser",
        "name": "UN Malaria 2012",
        "replace":true
    },
    "importOptions": {
        "fileType": "CSV"
    }
}
]\";

action = New CAS Action(
    Action( "table.upload" ),
    File( "$SAMPLE_IMPORT_DATA\UN Malaria 2012.csv" ),
    JSON( args )
);
rc = cas << Submit( action );
If( rc,
    Write( "\!nJSON: " || Char( action << Get JSON ) || "\!n" )
);


```

#### [Get Changed Resources](#get-changed-resources)

**Syntax:** action \<< Get Changed Resources()

**Description:** Gets the changed resources from a submitted action as an associative array.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
dt = Open( "$SAMPLE_DATA/Animals.jmp", invisible );
cas << Export Data( dt, "CASUSER.Animals" );
Close( dt, NOSAVE );
aa_json = [=> ];
aa_json["table"] = ["name" => "Animals", "caslib" => "CASUSER"];
aa_json["class"] = {"species", "subject", "season"};
aa_json["model"] = ["depVar" => "miles",
"effects" => {["vars" => {"species", "season"}, "interaction" => "BAR"]}, "printsol" =>
JSON Literal( true ), "cl" => JSON Literal( false ), "dfmethod" => "RESIDUAL"];
aa_json["random"] = {["depVars" => "miles", "effects" => {["vars" => {"subject"}, "nest" =>
{"species"}]}]};
aa_json["method"] = "REML";
action = New CAS Action( Action( "mixed.mixed" ), JSON( aa_json ) );
cas << Submit( action );
Write( "\!Changed Resources: " || Char( action << Get Changed Resources ) || "\!n" );


```

#### [Get Disposition](#get-disposition)

**Syntax:** action \<< Get Disposition()

**Description:** Gets the disposition from a submitted action as an associative array.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
dt = Open( "$SAMPLE_DATA/Animals.jmp", invisible );
cas << Export Data( dt, "CASUSER.Animals" );
Close( dt, NOSAVE );
aa_json = [=> ];
aa_json["table"] = ["name" => "Animals", "caslib" => "CASUSER"];
aa_json["class"] = {"species", "subject", "season"};
aa_json["model"] = ["depVar" => "miles",
"effects" => {["vars" => {"species", "season"}, "interaction" => "BAR"]}, "printsol" =>
JSON Literal( true ), "cl" => JSON Literal( false ), "dfmethod" => "RESIDUAL"];
aa_json["random"] = {["depVars" => "miles", "effects" => {["vars" => {"subject"}, "nest" =>
{"species"}]}]};
aa_json["method"] = "REML";
action = New CAS Action( Action( "mixed.mixed" ), JSON( aa_json ) );
cas << Submit( action );
Write( "\!Disposition: " || Char( action << Get Disposition ) || "\!n" );


```

#### [Get JSON](#get-json)

**Syntax:** action \<< Get JSON()

**Description:** Gets the returned values from a submitted CAS action as a JSON string.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
echo = "\[
{
    "a": 1,
    "b": true,
    "c": 3.141559
}
]\";
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );
cas << Submit( action );
Write( "\!nJSON: " || Char( action << Get JSON ) || "\!n" );


```

#### [Get Log](#get-log)

**Syntax:** action \<< Get Log()

**Description:** Gets the log from a submitted CAS action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
echo = "\[
{
    "a": 1,
    "b": true,
    "c": 3.141559
}
]\";
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );
cas << Submit( action );
Write( "\!Log: " || Char( action << Get Log ) || "\!n" );


```

#### [Get Log Entries](#get-log-entries)

**Syntax:** action \<< Get Log Entries()

**Description:** Gets the log as list of log entries from a submitted CAS action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
echo = "\[
{
    "a": 1,
    "b": true,
    "c": 3.141559
}
]\";
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );
cas << Submit( action );
Write( "\!Log Entries: " || Char( action << Get Log Entries ) || "\!n" );


```

#### [Get Metrics](#get-metrics)

**Syntax:** action \<< Get Metrics

**Description:** Gets the metrics from a submitted action as an associative array.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
dt = Open( "$SAMPLE_DATA/Animals.jmp", invisible );
cas << Export Data( dt, "CASUSER.Animals" );
Close( dt, NOSAVE );
aa_json = [=> ];
aa_json["table"] = ["name" => "Animals", "caslib" => "CASUSER"];
aa_json["class"] = {"species", "subject", "season"};
aa_json["model"] = ["depVar" => "miles",
"effects" => {["vars" => {"species", "season"}, "interaction" => "BAR"]}, "printsol" =>
JSON Literal( true ), "cl" => JSON Literal( false ), "dfmethod" => "RESIDUAL"];
aa_json["random"] = {["depVars" => "miles", "effects" => {["vars" => {"subject"}, "nest" =>
{"species"}]}]};
aa_json["method"] = "REML";
action = New CAS Action( Action( "mixed.mixed" ), JSON( aa_json ) );
cas << Submit( action );
Write( "\!Get Metrics: " || Char( action << Get Metrics ) || "\!n" );


```

#### [Get Results](#get-results)

**Syntax:** action \<< Get Results()

**Description:** Gets the results from a submitted action as an associative array.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
dt = Open( "$SAMPLE_DATA/Animals.jmp", invisible );
cas << Export Data( dt, "CASUSER.Animals" );
Close( dt, NOSAVE );
aa_json = [=> ];
aa_json["table"] = ["name" => "Animals", "caslib" => "CASUSER"];
aa_json["class"] = {"species", "subject", "season"};
aa_json["model"] = ["depVar" => "miles",
"effects" => {["vars" => {"species", "season"}, "interaction" => "BAR"]}, "printsol" =>
JSON Literal( true ), "cl" => JSON Literal( false ), "dfmethod" => "RESIDUAL"];
aa_json["random"] = {["depVars" => "miles", "effects" => {["vars" => {"subject"}, "nest" =>
{"species"}]}]};
aa_json["method"] = "REML";
action = New CAS Action( Action( "mixed.mixed" ), JSON( aa_json ) );
cas << Submit( action );
Write( "\!Results: " || Char( action << Get Results ) || "\!n" );


```

#### [JSON](#json)

**Syntax:** action \<< JSON(...)

**Description:** Sets the JSON argument for the CAS action. CAS actions will take JSON strings or JSL associative arrays as arguments. The JSON arguments are documented for each SAS CAS action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
echo = "\[
{
    "a": 1,
    "b": true,
    "c": 3.141559
}
]\";
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );
rc = cas << Submit( action );


```

#### [JSON Parameters](#json-parameters)

**Syntax:** action \<< JSON Parameters(...)

**Description:** Sets the JSON parameter argument for the CAS action. CAS actions like table.upload use a file in combination with JSON parameters to move a table to CAS. The CAS action will automatically move any JSON argument to a JSON Parameters argument if the File message is used.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
args =
"\[
{
    "casout": {
        "caslib": "casuser",
        "name": "UN Malaria 2012",
        "replace":true
    },
    "importOptions": {
        "fileType": "CSV"
    }
}
]\";

action = New CAS Action(
    Action( "table.upload" ),
    File( "$SAMPLE_IMPORT_DATA\UN Malaria 2012.csv" ),
    JSON Parameters( args )
);
rc = cas << Submit( action );
If( rc,
    Write( "\!nJSON: " || Char( action << Get JSON ) || "\!n" )
);


```

#### [Login](#login)

**Syntax:** action \<< Login(\<1|0>s))

**Description:** Sets a login requirement for a CAS action. CAS actions automatically require Connect, Login, Authorization, and Session.

**JMP Version Added:** 15

```


code =
"\[
  data temp;
  x = 9.1; y = 6; z = sqrt(x**2 + y**2);
  A = "SAS"; B = "Statistics";
  put _ALL_;              /* display all variables and values */
  run;
  ]\";
runCode = [=> ];
runCode["code"] = code;
action = New CAS Action( Action( "dataStep.runCode" ), JSON( runCode ), Login( 1 ) );


```

#### [Make Report](#make-report)

**Syntax:** action \<< Make Report

**Description:** Generates a report from a submitted CAS action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
data temp;
x = 9.1; y = 6; z = sqrt(x**2 + y**2);
A = "SAS"; B = "Statistics";
put _ALL_;              /* display all variables and values */
run;
]\";
runCode = [=> ];
runCode["code"] = code;
action = New CAS Action( Action( "dataStep.runCode" ), JSON( runCode ) );
cas << Submit( action );
action << Make Report();


```

#### [Method](#method)

**Syntax:** action \<< Method(\<"PUT" | "POST" | "GET" | "PATCH"| "HEAD">)

**Description:** Sets the HTTP method for the CAS action. HTTP methods include "PUT", "POST", "GET", "PATCH", "HEAD". For most CAS actions the correct HTTP method will automatically be selected.

**JMP Version Added:** 15

```


action = New CAS Action();
action << Method( "PUT" );


```

#### [Session](#session)

**Syntax:** action \<< Session(\<1|0>)

**Description:** Sets a session requirement for a CAS action. CAS actions automatically require Connect, Login, Authorization, and Session.

**JMP Version Added:** 15

```


code =
"\[
  data temp;
  x = 9.1; y = 6; z = sqrt(x**2 + y**2);
  A = "SAS"; B = "Statistics";
  put _ALL_;              /* display all variables and values */
  run;
  ]\";
runCode = [=> ];
runCode["code"] = code;
action = New CAS Action( Action( "dataStep.runCode" ), JSON( runCode ), Session( 1 ) );


```

#### [Timeout](#timeout)

**Syntax:** action \<< Timeout(120)

**Description:** Sets a new timeout value in the CAS action.

**JMP Version Added:** 17

```


cas = Current CAS Connection();
code =
"\[
data temp;
x = 9.1; y = 6; z = sqrt(x**2 + y**2);
A = "SAS"; B = "Statistics";
put _ALL_;              /* display all variables and values */
run;
]\";
runCode = [=> ];
runCode["code"] = code;
action = New CAS Action( Action( "dataStep.runCode" ), JSON( runCode ) );
action << Timeout( 120 );
cas << Submit( action );
action << Make Report();


```

## [CAS DATA Step Action](#cas-data-step-action)

### [Item Messages](#item-messages_1)

#### [Code](#code)

**Syntax:** action \<< Code(...)

**Description:** Sets the DATA step code to run. The CAS server is capable of running a subset of SAS DATA step code. See SAS documentation for specific limitations.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );


```

#### [File](#file_1)

**Syntax:** action \<< File(...)

**Description:** Sets the DATA step code to run. All path variables are expanded. The CAS server can run a subset of SAS DATA step code. See SAS documentation for specific limitations.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

filename = "$TEMP/Cas DataStep Action.sas";
file = Save Text File( filename, code, "replace" );
action = New CAS DATA Step action( File( filename ) );
cas << Submit( action );


```

#### [Get Changed Resources](#get-changed-resources_1)

**Syntax:** action \<< Get Changed Resources

**Description:** Gets the changed resources from a submitted action as a list.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
Write( "\!Get Changed Resources: " || Char( action << Get Changed Resources ) || "\!n" );


```

#### [Get Disposition](#get-disposition_1)

**Syntax:** action \<< Get Disposition

**Description:** Gets the disposition from a submitted action as an associative array.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
Write( "\!Get Disposition: " || Char( action << Get Disposition ) || "\!n" );


```

#### [Get JSON](#get-json_1)

**Syntax:** action \<< Get JSON

**Description:** Gets the returned values from a submitted CAS action as a JSON string.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
Write( "\!nJSON: " || Char( action << Get JSON ) || "\!n" );


```

#### [Get Log](#get-log_1)

**Syntax:** action \<< Get Log

**Description:** Gets the log from a submitted CAS action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
Write( "\!nLog: " || Char( action << Get Log ) || "\!n" );


```

#### [Get Log Entries](#get-log-entries_1)

**Syntax:** action \<< Get Log Entries

**Description:** Gets the log as list of log entries from a submitted CAS action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
Write( "\!Get Log Entries: " || Char( action << Get Log Entries ) || "\!n" );


```

#### [Get Metrics](#get-metrics_1)

**Syntax:** action \<< Get Metrics

**Description:** Gets the metrics from a submitted action as an associative array.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
Write( "\!Get Metrics: " || Char( action << Get Metrics ) || "\!n" );


```

#### [Get Output Data Sets](#get-output-data-sets)

**Syntax:** action \<< Get Output Data Sets()

**Description:** Gets a list of output data sets (libray.tablename) produced by the submitted action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
output_ds = action << Get Output Data Sets;
Show( output_ds );


```

#### [Get Results](#get-results_1)

**Syntax:** action \<< Get Results

**Description:** Gets the results from a submitted action as an associative array.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
Write( "\!Get Results: " || Char( action << Get Results ) || "\!n" );


```

#### [Has Output Data Sets](#has-output-data-sets)

**Syntax:** action \<< Has Output Data Sets

**Description:** Returns 1 if the CAS DATA step action produced output data.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";

action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );
has_output = action << Has Output Data Sets;
Show( has_output );


```

#### [NThreads](#nthreads)

**Syntax:** action \<< NThreads(\<integer|"MAX">)

**Description:** Specifies the number of threads that are used to run the program. For distributed servers, this value specifies the number of threads on each worker to use for running the program.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
 data temp;
 x = 9.1; y = 6; z = sqrt(x**2 + y**2);
 A = "SAS"; B = "Statistics";
 put _ALL_;              /* display all variables and values */
 run;
 ]\";

action = New CAS DATA Step action( Code( code ), NThreads( 2 ) );
cas << Submit( action );


```

#### [Single](#single)

**Syntax:** action \<< Single(\<NO|NOINPUT|YES>)

**Description:** Specifies when to restrict execution to a single thread. "NO" specifies to run the program in the number of threads specified by the nThreads parameter. "NOINPUT" specifies to run the program in one thread when there are no input data sets. When there are input data sets, the nThreads parameter specifies the number of threads to use. For distributed servers, if the program has no input data sets, the program runs in one thread on one worker. Otherwise, the nThreads parameter specifies the number of threads to use. "YES" specifies to override the nThreads parameter and run the program in one thread. For distributed servers, the program runs on one thread on one worker. The default is "NO"

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
data temp;
x = 9.1; y = 6; z = sqrt(x**2 + y**2);
A = "SAS"; B = "Statistics";
put _ALL_;              /* display all variables and values */
run;
]\";

action = New CAS DATA Step action( Code( code ), Single( "YES" ) );
cas << Submit( action );


```

## [CAS](#cas)

### [Item Messages](#item-messages_2)

#### [Connect](#connect)

**Syntax:** cas \<< Connect(\<URL(..)>,\<Username(...)>, \<Password(...)>, \<Prompt(Always | Never | IfNeeded>), \<Session("session id")>, \<Proxy Server("http://my_proxy:80")>, \<Proxy User("proxy_username")>, \<Bypass Proxy("http://localhost:80")>, \<Certificates("my_certificates.crt")>, \<Verify Certificates(1 | 0)>, \<No Verify Certificates(1 | 0)>, \<Timeout(seconds)>, \<Authorization Method("BASIC" | "BEARER")>)

**Description:** Connects to a new CAS server. CAS Connect uses URL, User name, Password arguments and optionally Prompt and Session. Prompt can be IfNeeded, Always, or Never. URL, user name, password can be omitted if the Prompt argument is IfNeeded or Always. The default value for Prompt is Never. Session can be used to reconnect to an existing CAS session. The session must be valid for the URL, user name, and password used in the connection. The optional Certificates argument is useful for supplying trusted certificates for https connections to CAS. The optional Verify Certificates or No Verify Certificates argument is useful to temporarily accept self-signed certificates. The optional Proxy Server argument is useful for supplying a proxy host in a proxy environment. The optional Proxy User argument is useful for supplying user and password information for a proxy environment. The optional Bypass Proxy argument is use for bypassing the proxy for certain hosts. The optional Timeout argument sets a timeout value for the CAS connection operations. The optional Authorization Method argument specifies how JMP connects to CAS. This is dependent on the CAS deployment.

**JMP Version Added:** 15

```


cas = New CAS Server();
url = "http://myCasURL";
cas << Connect( URL( url ), Username( "my_username" ), Prompt( "IfNeeded" ) );
session_id = cas << Get Session;
cas << Disconnect( NoTerminate ); //disconnect CAS without terminating
cas = CAS Connect(
    URL( url ),
    Username( "my_username" ),
    Prompt( "IfNeeded" ),
    Session( session_id )
); //reconnect to the session


```

#### [Delete Table](#delete-table)

**Syntax:** cas \<< Delete Table(tablename, \<Quiet(0|1), reMACs(0|1), Remove(0|1)>)

**Description:** This action deletes the filesystem table. The in memory table is not affected. Specifying Quiet will suppress errors for a non-existent table. Specifying remACs will remove access controls for a table. Specifying Remove will also remove the table from memory.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class", Save( 1 ) );
cas << Delete Table( "Casuser", "Big Class" );


```

#### [Disconnect](#disconnect)

**Syntax:** cas \<< Disconnect(\<Terminate | NoTerminate>)

**Description:** Disconnects from a CAS server and optionally terminates the session. By default, the session is terminated when disconnected.

**JMP Version Added:** 15

```


cas = New CAS Server();
url = "http://myCasURL";
cas << Connect( URL( url ), Username( "my_username" ), Prompt( "IfNeeded" ) );
cas << Disconnect( Terminate( 1 ) ); //disconnect CAS and terminate


```

#### [Export Data](#export-data)

**Syntax:** cas \<< Export Data(jmp_data_table, cas_libref, cas_dataset, \<named_arguments>)

**Description:** Exports a table to a CAS server. jmp_data_table is the JMP data table to export while cas_libref and cas_dataset are the target locations on the CAS server. The optional named argument is Save(1|0). When a table is exported to CAS, it is not persisted to CAS filesystem unless the Save option is used. Most CAS actions occur in memory.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );


```

#### [Get Data Sets](#get-data-sets)

**Syntax:** cas \<< Get Data Sets(\<"caslib">)

**Description:** Gets a list of available CAS data sets. These data sets are found on the CAS filesystem. The optional argument limits the list of data sets to the CAS library. If no argument is used, then the data set list contains the fully qualified data set name (library.dataset). If the argument is used, then the data set list is a list of data set names.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class", Save( 1 ) );
datasets = cas << Get Data Sets( "casuser" );
Show( datasets );
cas << Delete Table( "Casuser", "Big Class" );
datasets = cas << Get Data Sets( "casuser" );
Show( datasets );


```

#### [Get Libraries](#get-libraries)

**Syntax:** cas \<< Get Libraries()

**Description:** Gets a list of available CAS libraries.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
libraries = cas << Get Libraries();
Show( libraries );


```

#### [Get Session](#get-session)

**Syntax:** cas \<< Get Session()

**Description:** Gets the session id from the CAS server. This can be used for subsequent re-connections as long as the CAS session remains available.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = CAS Connect( URL( url ), Username( "my_username" ), Prompt( "IfNeeded" ) );
session_id = cas << Get Session;
cas << Disconnect( NoTerminate ); //disconnect CAS without terminating
cas = CAS Connect(
    URL( url ),
    Username( "my_username" ),
    Prompt( "IfNeeded" ),
    Session( session_id )
); //reconnect to the session


```

#### [Get Sessions](#get-sessions)

**Syntax:** cas \<< Get Sessions()

**Description:** Gets the available sessions for the current user.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = CAS Connect( URL( url ), Username( "my_username" ), Prompt( "IfNeeded" ) );
session_ids = cas << Get Sessions();
Show( session_ids );


```

#### [Import Data](#import-data)

**Syntax:** cas \<< Import Data(libref, dataset, \<named_arguments>)

**Description:** Imports a table from a CAS server. Optional named arguments are Invisible(0|1), Private(0|1) and UseLabelsForVarNames(0|1).

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
cas << Import Data( "Casuser.Big Class" );


```

#### [Is Connected](#is-connected)

**Syntax:** cas \<< Is Connected()

**Description:** Returns 1 if there is an active CAS server connection. Otherwise, returns 0.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
connected = cas << Is Connected();
Show( connected );


```

#### [Remove Table](#remove-table)

**Syntax:** cas \<< Remove Table(tablename, \<Quiet(0|1), reMACs(0|1), Delete(0|1)>)

**Description:** This action drops the in-memory table. The file that was created with the save action is not affected. Specifying delete will also delete the table from the file system.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
cas << Remove Table( "Casuser", "Big Class" );


```

#### [Submit](#submit)

**Syntax:** cas \<< Submit(action)

**Description:** Submits a CAS action to the CAS server.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
echo = [=> ];
echo["a"] = 1;
echo["b"] = JSON Literal( true );
echo["c"] = 3.141559;
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );
cas = Current CAS Connection();
rc = cas << Submit( action );


```

#### [Terminate](#terminate)

**Syntax:** cas \<< Terminate(sessionId))

**Description:** Terminates a CAS session owned by the current user. A user cannot terminate a connected session ID

**JMP Version Added:** 15

```


cas = Current CAS Connection();
session_id = cas << Get Session();
cas << Disconnect( NoTerminate );
cas = CAS Connect( Prompt( IfNeeded ) );
cas << Terminate( session_id );


```

#### [Terminate Sessions](#terminate-sessions)

**Syntax:** cas \<< Terminate Sessions()

**Description:** Terminates all CAS sessions owned by the current user.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Terminate Sessions();


```

# [SAS Integration](#sas-integration)

## [Associated Constructors](#associated-constructors)

### [Check SAS Dependencies](#check-sas-dependencies)

**Syntax:** Check SAS Dependencies()

**Description:** Checks the status of the SAS Integration dependencies. Returns 1 for success.

**JMP Version Added:** 19

```


If( !Check SAS Dependencies(),
    Install SAS Dependencies();
    Print( "Dependencies are installed" );
,
    Print( "Dependencies are installed" )
);


```

### [Current SAS Connection](#current-sas-connection)

**Syntax:** sas = Current SAS Connection()

**Description:** Returns the active SAS server connection, if any, as a scriptable object.

```

SAS Connect( "my sas connection" );
sas = Current SAS Connection();
sas << Submit( "proc print data=sashelp.class; run;" );


```

### [Current SAS Connections](#current-sas-connections)

**Syntax:** array = Current SAS Connections()

**JMP Version Added:** 19

```

array = Current SAS Connections();
array["my connection"] << Submit( "proc print data=sashelp.class; run;" );


```

### [Install SAS Dependencies](#install-sas-dependencies)

**Syntax:** Install SAS Dependencies()

**Description:** Installs the required dependencies for SAS Integration. Returns 1 for success.

**JMP Version Added:** 19

```


If( !Check SAS Dependencies(),
    Install SAS Dependencies(),
    Print( "Dependencies are installed" )
);


```

### [SAS Connect](#sas-connect)

**Syntax:** SAS Connect(\<( data_connector_or_id )>, \<Prompt( Always|Never|IfNeeded )>)

**Description:** Opens a SAS connection.

**JMP Version Added:** 19

**Example 1**

```

SAS Connect( "my sas connection" );


```

**Example 2**

```


iom_win = New Data Connector( Type( "SAS Local" ) );
SAS Connect( iom_win );
sas = Current SAS Connection();
librefs = sas << Get Librefs();
For( i = 1, i <= N Items( librefs ), i++,
    tables = sas << Get Data Sets( librefs[i] );
    Write( "\!n\!nLibref:" || librefs[i] );
    Write( "\!nTables:" || Char( tables ) );
);
sas << Disconnect();


```

**Example 3**

```

SAS Connect(
    New Data Connector(
        ID( "com.jmp.sas_remote" ),
        Port( 8591 ),
        User( "jmpuser" ),
        Host Name( "sashost.com" )
    ),
    Prompt( If Needed )
);


```

**Example 4**

```

SAS Connect( "sashost.com", 8591, Username( "jmpuser" ), Prompt( "Always" ) );


```

### [Update SAS Dependencies](#update-sas-dependencies)

**Syntax:** Update SAS Dependencies()

**Description:** Updates the required dependencies for SAS Integration. Returns 1 for success.

**JMP Version Added:** 19

```


If( Check SAS Dependencies(),
    Update SAS Dependencies(),
    Print( "Dependencies are not installed" )
);


```

## [SAS Results](#sas-results)

### [Item Messages](#item-messages)

#### [Get Log](#get-log)

**Syntax:** obj \<< Get Log

**Description:** Returns a string containing the Log Window contents of the active SAS server connection.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit(
    "proc print data=sashelp.class; run;",
    NoOutputWindow( True ),
    GetSASLog( False )
);
result = sas << Get Results;
log = result << Get Log();
Show( log );


```

#### [Get Output](#get-output)

**Syntax:** obj \<< Get Output

**Description:** Returns a string containing the Log Window contents of the active SAS server connection.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit( "proc print data=sashelp.class; run;", NoOutputWindow( True ) );
result = sas << Get Results;
out = result << Get Output();
Show( out );


```

#### [Get Output Datasets](#get-output-datasets)

**Syntax:** obj \<< Get Output Datasets

**Description:** Returns a string containing the Log Window contents of the active SAS server connection.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit(
    "proc corr data=sashelp.class
    outp=pearson outs=spearman;
    var height weight;
    run;",
    NoOutputWindow( True )
);
result = sas << Get Results;
data = result << Get Output Datasets;
Show( data );


```

## [SAS Server](#sas-server)

### [Item Messages](#item-messages_1)

#### [Connect](#connect)

**Syntax:** sas \<< Connect( \<( data_connector_or_id )>, \<Prompt( Always|Never|IfNeeded )>)

**Description:** Attempt to reconnect a SAS server connection object that has become disconnected.

**JMP Version Added:** 19

```

SAS Connect( "my sas connection" );
sas = Current SAS Connection();
sas << Disconnect();
sas << Connect();


```

#### [Current CAS Connection](#current-cas-connection)

**Syntax:** result = sas \<< Current CAS Connection()

**Description:** Obtains the connection to the current CAS Server.

**JMP Version Added:** 19

**Example 1**

```

sas = Current SAS Connection();
cas = sas << Current CAS Connection;
Show( cas );


```

**Example 2**

```

sas = Current SAS Connection();
cas = sas << Current CAS Connection;
connected = cas << Is Connected();
Show( connected );


```

#### [Data Set Exists](#data-set-exists)

**Syntax:** result = sas \<< Data Set Exists( libref, dsname )

**Description:** Returns 1 if a SAS data set exists.

**JMP Version Added:** 19

**Example 1**

```

sas = Current SAS Connection();
result = sas << Data Set Exists( "SASHELP", "AIRLINE" );
Show( result );


```

**Example 2**

```

sas = Current SAS Connection();
result = sas << Data Set Exists( "SASHELP.AIRLINE" );
Show( result );


```

#### [Disconnect](#disconnect)

**Syntax:** obj \<< Disconnect

**Description:** Disconnect this SAS server connection.

**JMP Version Added:** 19

```

SAS Connect( "my sas connection" );
sas = Current SAS Connection();
sas << Disconnect();


```

#### [Export Data](#export-data)

**Syntax:** y = sas \<< Export Data( dt, libref, dataset, \<named_arguments> ); y = sas \<< SAS Export Data( dt, libref.dataset, \<named_arguments> )

**Description:** Exports a JMP data table as a SAS dataset onto the active SAS server connection. Named optional arguments include Columns(list|col1,col2,...,coln), string-valued arguments Password, AlterPassword, ReadPassword, and WritePassword, as well as Boolean-valued arguments HonorExcludedRows, PreserveSASColumnNames, PreserveSASFormats, ReplaceExisting, ExistingAlterPassword, and SaveJMPMetadata. Returns 1 if the export was successful, 0 otherwise.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Export Data( Open( "$SAMPLE_DATA/Big Class.jmp" ), "WORK", "BIGCLASS" );


```

#### [Get Data Sets](#get-data-sets)

**Syntax:** result = sas \<< Get Data Sets( libref )

**Description:** Returns a list of the data sets defined in a SAS library.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Data Sets( "SASHELP" );
Show( result );


```

#### [Get Host Name](#get-host-name)

**Syntax:** var = sas \<< Get Host Name( )

**Description:** Get the host name of the SAS server

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Host Name();
Show( result );


```

#### [Get Lib Refs](#get-lib-refs)

**Syntax:** result = sas \<< Get Lib Refs()

**Description:** Returns a list of the currently defined SAS librefs from the active SAS server connection.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Lib Refs();
Show( result );


```

#### [Get Log](#get-log_1)

**Syntax:** result = sas \<< Get Log()

**Description:** Returns a string containing the Log Window contents of the active SAS server connection.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit(
    "proc print data=sashelp.class; run;",
    NoOutputWindow( True ),
    GetSASLog( False )
);
result = sas << Get Log();
Show( result );


```

#### [Get Macro Var](#get-macro-var)

**Syntax:** var = sas \<< GetMacroVar( "name" )

**Description:** Get the value of a SAS Macro Variable

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Macro Var( "SYSVLONG" );
Show( result );


```

#### [Get Macro Var Names](#get-macro-var-names)

**Syntax:** var = sas \<< GetMacroVarNames( )

**Description:** Get a list of SAS Macro Variables

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Macro Var Names();
Show( result );


```

#### [Get Option Names](#get-option-names)

**Syntax:** var = sas \<< GetOptionNames( )

**Description:** Get a list of SAS Options

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Option Names();
Show( result );


```

#### [Get Option Value](#get-option-value)

**Syntax:** var = sas \<< Get Option Value( "name" )

**Description:** Get the value of a SAS Option

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Option Value( "MEMLIB" );
Show( result );


```

#### [Get Output](#get-output_1)

**Syntax:** result = sas \<< Get Output()

**Description:** Returns a string containing the listing output from the last submission of SAS code to the active SAS server connection.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit( "proc print data=sashelp.class; run;", NoOutputWindow( True ) );
result = sas << Get Output();
Show( result );


```

#### [Get Results](#get-results)

**Syntax:** result = sas \<< Get Results()

**Description:** Get the results of the last submit for this server

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit( "proc print data=sashelp.class; run;" );
result = sas << Get Results();
Show( result );


```

#### [Get Submit Status](#get-submit-status)

**Syntax:** result = sas \<< Get Submit Status()

**Description:** Get the status of the last submit for this server

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit( "proc print data=sashelp.class; run;" );
result = sas << Get Submit Status;
Show( result );


```

#### [Get Var Info](#get-var-info)

**Syntax:** result = sas \<< Get Var Info( libref, dataset ); result = sas \<< Get Var Info( libref.dataset )

**Description:** Get information about the variables in a SAS data set

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Var Info( "SASHELP", "CLASS" );
Show( result );


```

#### [Get Var Names](#get-var-names)

**Syntax:** result = sas \<< Get Var Names( libref, dataset ); result = sas \<< SAS Get Var Names( libref.dataset )

**Description:** Retrieves the variable names contained in the specified data set from the active SAS server connection.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Var Names( "SASHELP", "CLASS" );
Show( result );


```

#### [Get Version](#get-version)

**Syntax:** ver = sas \<< GetVersion( < Long > )

**Description:** Get the version of SAS

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Version;
Show( result );


```

#### [Get Work Folder](#get-work-folder)

**Syntax:** obj \<< Get Work Folder

**Description:** Get the server's WORK library folder

**JMP Version Added:** 19

```

sas = Current SAS Connection();
result = sas << Get Work Folder;
Show( result );


```

#### [Import Data](#import-data)

**Syntax:** dt = sas \<< Import Data( libref, dataset, \<named_arguments> ); dt = sas \<< Import Data( libref.dataset|path, \<named_arguments> )

**Description:** Imports a SAS data set from the active SAS server connection into a JMP data table. Named optional arguments include Sample(), Columns(list|col1,col2,...,coln), string-valued arguments Where, as well as Boolean-valued arguments ConvertCustomFormats, Invisible, UseLabelsForVarNames, SQLTableVariable. Returns a JMP data table object.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
dt = sas << Import Data( "SASHELP.CLASS" );


```

#### [List Output Data Sets](#list-output-data-sets)

**Syntax:** sas \<< List Output Data Sets(sas code)

**Description:** Lists output datasets for the specified SAS code

**JMP Version Added:** 19

```

sas = Current SAS Connection();
datasets = sas << List Output Datasets(
    "\[
proc means data=sashelp.class;
    var age height weight;
run;
]\"
);
Show( datasets );


```

#### [Name](#name)

**Syntax:** serverName = sas \<< Name

**Description:** Returns the name of the server.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
serverName = sas << Name;
Show( serverName );


```

#### [Submit](#submit)

**Syntax:** result = sas \<< Submit( \<GetSASLog(\<True|False|OnError>, \<OnSubmitComplete(script)>, \<OpenOutputDatasets(\<All|None, UseLabelsForVarNames(1|0),dataset1,dataset2,...,datasetN>)>, <ODSFormat>, <ODS Style>, <Title>, <OpenODSResults>, <NoOutputWindow>

**Description:** Submits SAS code to the active SAS server connection. Returns 1 if successful, 0 otherwise.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit(
    "proc reg data=sashelp.class; model height=weight; output out=result_height_weight residual=res; run; quit;",
    ODSStyle( "default" ),
    OpenODSResults( true ),
    OpenOutputDatasets( All )
);


```

#### [Submit File](#submit-file)

**Syntax:** result = sas \<< Submit File( "filename.sas" )

**Description:** Submits a file containing SAS code to the active SAS server connection. Named optional arguments are the same as those for SAS Submit. Returns 1 if successful, 0 otherwise.

**JMP Version Added:** 19

```

sas = Current SAS Connection();
sas << Submit File( "MySASProgram.sas" );


```

# [Scatterplot 3D](#scatterplot-3d)

## [Associated Constructors](#associated-constructors)

### [Scatterplot 3D](#scatterplot-3d_1)

**Syntax:** Scatterplot 3D( Y( columns ) )

**Description:** Produces a rotating three-dimensional scatterplot for three or more variables. If you specify more than three variables, you can cycle through which variables are shown in the scatterplot.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Coloring](#coloring)

**Syntax:** obj \<< Coloring( column )

**Description:** Colors the markers according to the selected variable.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Coloring( :Sepal length )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** A column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Freq( :_freqcol )
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** A column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Weight( :_weightcol )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

**Description:** Variables that will be available for the X, Y, and Z coordinates in the 3D graph.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

## [Item Messages](#item-messages)

### [Biplot Rays](#biplot-rays)

**Syntax:** obj \<< Biplot Rays( state=0|1 )

**Description:** Shows or hides the biplot rays on the graph. On by default with principal components.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Principal Components( 1 );
obj << Biplot Rays( 1 );


```

### [Circle Size](#circle-size)

**Syntax:** obj \<< Circle Size( number=0.2 )

**Description:** Sets the marker size when "Sized Points" is set or a Weight or Freq role is used. "0.2" by default.

**JMP Version Added:** 18

```

// slightly larger circles
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length ),
    Weight( :Petal width ),
    Circle Size( .3 )
);


```

### [Connect Points](#connect-points)

**Syntax:** obj \<< Connect Points( state=0|1, <group column name> )

**Description:** Displays or hides lines connecting the points. Optionally, the points can be grouped.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Connect Points( 1, :Species );


```

### [Drop Line Thickness](#drop-line-thickness)

**Syntax:** obj \<< Drop Line Thickness( fraction=0.03 )

**Description:** Sets the line thickness of the drop line. "0.03" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Drop Lines( 1 );
Wait( 2 );
obj << Drop Line Thickness( 0.8 );


```

### [Drop Lines](#drop-lines)

**Syntax:** obj \<< Drop Lines( state=0|1 )

**Description:** Draws or hides lines from the floor defined by the first and third variables to each point in the graph.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Drop Lines( 1 );


```

### [Ellipsoid Coverage](#ellipsoid-coverage)

**Syntax:** obj \<< Ellipsoid Coverage( fraction=0.5 )

**Description:** Sets the coverage for the ellipse. For example, 0.5 covers the most dense half of the data. "0.5" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Ellipsoid Coverage( 0.8 );
obj << Normal Contour Ellipsoids( 1, :Species );


```

### [Ellipsoid Transparency](#ellipsoid-transparency)

**Syntax:** obj \<< Ellipsoid Transparency( fraction=0.5 )

**Description:** Sets the transparency for the ellipse. 0 [clear] and 1 [opaque]. "0.5" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Ellipsoid Transparency( 0.4 );
obj << Normal Contour Ellipsoids( 1, :Species );


```

### [Frame3D](#frame3d)

**Syntax:** obj \<< Frame3D( <commands passed to Frame3D> )

**Description:** Sends display commands to the 3D plot.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set View Zoom( 0.9075 ) );


```

### [Jitter](#jitter)

**Syntax:** obj \<< Jitter( state=0|1 )

**Description:** Jitters the points by moving them slightly on the scatterplot. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Petal length, :Petal width, :Species ), Jitter( 0 ) );


```

### [Legend](#legend)

**Syntax:** obj \<< Legend( <Legend Model ID> )

### [Nonpar Density Contour](#nonpar-density-contour)

**Syntax:** obj \<< Nonpar Density Contour( state=0|1, <group column name> )

**Description:** Draws a 95% kernel contour shell around the points.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Nonpar Density Contour( 1, :Species );


```

### [Nonpar Density Contour Settings](#nonpar-density-contour-settings)

**Syntax:** obj \<< Nonpar Density Contour Settings( surface, on=0|1, <quantile>, <transparency>, <color> )

**Description:** Settings for the isosurface

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Nonpar Density Contour( 1 );
obj << Nonpar Density Contour Settings( 1, 1, .5, .6, Green );


```

### [Normal Contour Ellipsoids](#normal-contour-ellipsoids)

**Syntax:** obj \<< Normal Contour Ellipsoids( state=0|1, <group column name> )

**Description:** Displays or hides the normal contour ellipsoids.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Normal Contour Ellipsoids( 1, :Species );


```

### [Principal Components](#principal-components)

**Syntax:** obj \<< Principal Components( state=0|1 )

**Description:** Displays both the Principal Components report and the rays on the graph.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Principal Components;


```

### [Remove Prin Comp](#remove-prin-comp)

**Syntax:** obj \<< Remove Prin Comp

**Description:** Removes the Principal Components report and the rays on the graph.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Principal Components( 1 );
Wait( 2 );
obj << Remove Prin Comp;


```

### [Rotated Components](#rotated-components)

**Syntax:** obj \<< Rotated Components( PC|ML, ONE|SMC , number, Varimax| Biquartimax| Quartimax|Equamax|Orthomax| Factorparsimax... )

**Description:** Displays a report with rotated principal components, where the components more closely align with the coordinate space. The second parameter defines the diagonals used in the prior communality and can be either SMC or ONE (principal components).

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Rotated Components( PC, ONE, 3, Varimax );


```

### [Save Prin Components](#save-prin-components)

**Syntax:** obj \<< Save Prin Components( number )

**Description:** Saves the principal components as new columns in the data table

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Principal Components( 1 );
obj << Save Prin Components( 3 );


```

### [Save Rotated Components](#save-rotated-components)

**Syntax:** obj \<< Save Rotated Components

**Description:** Saves the rotated principal components as new columns in the data table

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Rotated Components( PC, ONE, 3, Varimax );
obj << Save Rotated Components;


```

### [Show Controls](#show-controls)

**Syntax:** obj \<< Show Controls( state=0|1 )

**Description:** Shows or hides the control panel at the bottom of the scatterplot. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Show Controls( 1 );


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the points on the scatterplot. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Show Points( 1 );


```

### [Show Ray Labels](#show-ray-labels)

**Syntax:** obj \<< Show Ray Labels( state=0|1 )

**Description:** Shows or hides labels on rays. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Principal Components( 1 );
obj << Biplot Rays( 1 );
obj << Show Ray Labels( 1 );


```

### [Sized Points](#sized-points)

**Syntax:** obj \<< Sized Points( state=0|1 )

**Description:** Grows or shrinks the points on the scatterplot.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Sized Points( 1 );


```

### [Std Prin Components](#std-prin-components)

**Syntax:** obj \<< Std Prin Components( state=0|1 )

**Description:** Displays both the standardized Principal Components report and the rays on the graph.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Std Prin Components;


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot 3D(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Scatterplot 3D(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Frame3D](#frame3d_1)

### [Associated Constructors](#associated-constructors_1)

#### [Graph 3D Box](#graph-3d-box)

**Syntax:** y = Graph 3D Box()

**Description:** Sends display commands to the 3D plot.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

### [Item Messages](#item-messages_1)

#### [Add Ellipsoid](#add-ellipsoid)

**Syntax:** obj \<< Add Ellipsoid( 4x4 matrix ) obj \<< Add Ellipsoid(3x3 cov,3x1 means) obj \<< Add Ellipsoid(3x3 corr,3x1 means,3x1 std dev)

**Description:** Draws an ellipsoid on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D(
    Add Ellipsoid(
        [1 0.42632 0.85183, 0.42632 1 0.34418, 0.85183 0.34418 1],
        [6.55099 2.96919 5.5066],
        [0.57829 0.29087 0.53668]
    )
);


```

#### [Add Markers](#add-markers)

**Syntax:** obj \<< Add Markers( [ nx1 X matrix ], [ nx1 Y matrix ], [ nx1 Z matrix ] )

**Description:** Draws n markers on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Add Markers( [2 3 4], [5 6 7], [1 8 9] ) );


```

#### [Add Vector](#add-vector)

**Syntax:** obj \<< Add Vector( [ 3xn from matrix ], [ 3xn to matrix ], FromCap( CutOff|Sphere|Point|Feather ), ToCap( CutOff|Sphere|Point|Feather ), Facets( Triangle|Square|Round ), Shaft Color( color ), Shaft Thickness( number ), From Thickness( number ), To Thickness( number ), From Color( number ), To Color( number ) ) )

**Description:** Draws a vector or arrow on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Add Vector( [4.5 2 1], [7.5 4 6], FromCap( "Feather" ), ToCap( "Point" ) ) );


```

#### [Get Axes](#get-axes)

**Syntax:** obj \<< Get Axes

**Description:** Returns the state of displaying the axes on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Axes );
Show( s );


```

#### [Get Box](#get-box)

**Syntax:** obj \<< Get Box

**Description:** Returns the state of displaying the box frame on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Box );
Show( s );


```

#### [Get Grab Handles](#get-grab-handles)

**Syntax:** obj \<< Get Grab Handles

**Description:** Returns the state of displaying the grab handles on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Box );
Show( s );


```

#### [Get Graph Size](#get-graph-size)

**Syntax:** obj \<< Get Graph Size

**Description:** Returns the size of the graph.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Graph Size );
Show( s );


```

#### [Get Grids](#get-grids)

**Syntax:** obj \<< Get Grids

**Description:** Returns the state of displaying the grids on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Grids );
Show( s );


```

#### [Get Hide Lights Border](#get-hide-lights-border)

**Syntax:** obj \<< Get Hide Lights Border

**Description:** Returns the state of the lights border around the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
state = obj << Frame3D( Get Hide Lights Border );
Show( state );


```

#### [Get Line Scale](#get-line-scale)

**Syntax:** obj \<< Get Line Scale

**Description:** Returns the line width for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
w = obj << Frame3D( Get Line Scale );
Show( w );


```

#### [Get Marker Quality](#get-marker-quality)

**Syntax:** obj \<< Get Marker Quality

**Description:** Returns the marker characteristics such as shape and shade for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
q = obj << Frame3D( Get Marker Quality );
Show( q );


```

#### [Get Marker Scale](#get-marker-scale)

**Syntax:** obj \<< Get Marker Scale

**Description:** Returns the marker size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Marker Scale );
Show( s );


```

#### [Get Marker Transparency](#get-marker-transparency)

**Syntax:** obj \<< Get Marker Transparency

**Description:** Returns the marker transparency for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Frame3D( Get Marker Transparency );
Show( t );


```

#### [Get Rotation](#get-rotation)

**Syntax:** obj \<< Get Rotation

**Description:** Returns the current rotation for the frame.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Frame3D( Get Rotation() );
Show( r );


```

#### [Get Text Scale](#get-text-scale)

**Syntax:** obj \<< Get Text Scale

**Description:** Returns the text size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Text Scale );
Show( s );


```

#### [Get View Ortho](#get-view-ortho)

**Syntax:** obj \<< Get View Ortho

**Description:** Returns the state of the orthographic view for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
o = obj << Frame3D( Get View Ortho );
Show( o );


```

#### [Get View Perspective](#get-view-perspective)

**Syntax:** obj \<< Get View Perspective

**Description:** Returns the view perspective for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
p = obj << Frame3D( Get View Perspective );
Show( p );


```

#### [Get View Zoom](#get-view-zoom)

**Syntax:** obj \<< Get View Zoom

**Description:** Returns the current zoom for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
z = obj << Frame3D( Get View Zoom );
Show( z );


```

#### [Get Wall Color](#get-wall-color)

**Syntax:** obj \<< Get Wall Color

**Description:** Returns the wall color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get Wall Color );
Show( c );


```

#### [Get Walls](#get-walls)

**Syntax:** obj \<< Get Walls

**Description:** Returns the state of displaying the walls on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Walls );
Show( s );


```

#### [Get X Axis Color](#get-x-axis-color)

**Syntax:** obj \<< Get X Axis Color

**Description:** Returns the x axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get X Axis Color );
Show( c );


```

#### [Get X Axis Label](#get-x-axis-label)

**Syntax:** obj \<< Get X Axis Label

**Description:** Returns the label for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
label = obj << Frame3D( Get X Axis Label );
Show( label );


```

#### [Get Y Axis Color](#get-y-axis-color)

**Syntax:** obj \<< Get Y Axis Color

**Description:** Returns the y axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get Y Axis Color );
Show( c );


```

#### [Get Y Axis Label](#get-y-axis-label)

**Syntax:** obj \<< Get Y Axis Label

**Description:** Returns the label for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
label = obj << Frame3D( Get Y Axis Label );
Show( label );


```

#### [Get Z Axis Color](#get-z-axis-color)

**Syntax:** obj \<< Get Z Axis Color

**Description:** Returns the z axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get Z Axis Color );
Show( c );


```

#### [Get Z Axis Label](#get-z-axis-label)

**Syntax:** obj \<< Get Z Axis Label

**Description:** Returns the label for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
label = obj << Frame3D( Get Z Axis Label );
Show( label );


```

#### [Set Axes](#set-axes)

**Syntax:** obj \<< Set Axes( state=0|1 )

**Description:** Shows or hides the x, y, and z axes on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Axes( 1 ) );


```

#### [Set Box](#set-box)

**Syntax:** obj \<< Set Box( state=0|1 )

**Description:** Shows or hides the box frame on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Box( 1 ) );


```

#### [Set Graph Size](#set-graph-size)

**Syntax:** obj \<< Set Graph Size( x, y )

**Description:** Sets the size of the graph.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Graph Size( 700, 800 ) );


```

#### [Set Grids](#set-grids)

**Syntax:** obj \<< Set Grids( state=0|1 )

**Description:** Shows or hides the grids on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Grids( 1 ) );


```

#### [Set Hide Lights Border](#set-hide-lights-border)

**Syntax:** obj \<< Set Hide Lights Border( state=0|1 )

**Description:** Hides or displays the lights border around the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ) );


```

#### [Set Line Scale](#set-line-scale)

**Syntax:** obj \<< Set Line Scale( number )

**Description:** Sets the line width for the grid on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Line Scale( 6.5 ) );


```

#### [Set Marker Quality](#set-marker-quality)

**Syntax:** obj \<< Set Marker Quality( number )

**Description:** Sets the marker characteristics such as shape and shade for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Marker Scale( 3 ), Set Marker Quality( 0.2625 ) );


```

#### [Set Marker Scale](#set-marker-scale)

**Syntax:** obj \<< Set Marker Scale( number )

**Description:** Sets the marker size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Marker Scale( 3.5 ) );


```

#### [Set Marker Transparency](#set-marker-transparency)

**Syntax:** obj \<< Set Marker Transparency( fraction )

**Description:** Sets the marker transparency for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Marker Transparency( 0.4125 ) );


```

#### [Set Oscillation](#set-oscillation)

**Syntax:** obj \<< Set Oscillation( X, Y, Z, duration )

**Description:** Sets oscillation rate on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Rotation( -60, -3, 35 ), Set Oscillation( -54, 0, 38, 100 ) );


```

#### [Set Rotation](#set-rotation)

**Syntax:** obj \<< Set Rotation( X, Y, Z )

**Description:** Rotates the frame to the specified coordinates.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Rotation( -60, -3, 35 ) );


```

#### [Set Spin](#set-spin)

**Syntax:** obj \<< Set Spin( dx, dy, sx, sy )

**Description:** Spins the graph on a specified axis. The values dx and dy are a delta motion of the mouse from the point, (sx, sy).

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Spin( .01, .01, 0, 0 ) );


```

#### [Set Text Scale](#set-text-scale)

**Syntax:** obj \<< Set Text Scale( number )

**Description:** Sets the text size for the axis text on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Text Scale( 1.4 ) );


```

#### [Set View Ortho](#set-view-ortho)

**Syntax:** obj \<< Set View Ortho( state=0|1 )

**Description:** Displays the plot orthographically or linearly.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set View Ortho( 1 ) );


```

#### [Set View Perspective](#set-view-perspective)

**Syntax:** obj \<< Set View Perspective( fraction )

**Description:** Sets the view perspective on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set View Perspective( 0.275 ) );


```

#### [Set View Zoom](#set-view-zoom)

**Syntax:** obj \<< Set View Zoom( number )

**Description:** Sets the zoom on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set View Zoom( 0.5 ) );
Wait( 2 );
obj << Frame3D( Set View Zoom( 2 ) );


```

#### [Set Wall Color](#set-wall-color)

**Syntax:** obj \<< Set Wall Color( number )

**Description:** Sets the wall color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Wall Color( -16775543 ) );


```

#### [Set Walls](#set-walls)

**Syntax:** obj \<< Set Walls( state=0|1 )

**Description:** Shows or hides the walls on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Walls( 1 ) );


```

#### [Set X Axis Color](#set-x-axis-color)

**Syntax:** obj \<< Set X Axis Color( color )

**Description:** Sets the x axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set X Axis Color( 5 ) );


```

#### [Set X Axis Label](#set-x-axis-label)

**Syntax:** obj \<< Set X Axis Label( string )

**Description:** Sets the label for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set X Axis Label( "Iris Sepal Length" ) );


```

#### [Set Y Axis Color](#set-y-axis-color)

**Syntax:** obj \<< Set Y Axis Color( color )

**Description:** Sets the y axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Y Axis Color( 11 ) );


```

#### [Set Y Axis Label](#set-y-axis-label)

**Syntax:** obj \<< Set Y Axis Label( string )

**Description:** Sets the label for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Y Axis Label( "Iris Petal Length" ) );


```

#### [Set Z Axis Color](#set-z-axis-color)

**Syntax:** obj \<< Set Z Axis Color( color )

**Description:** Sets the z axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Z Axis Color( "Green" ) );


```

#### [Set Z Axis Label](#set-z-axis-label)

**Syntax:** obj \<< Set Z Axis Label( string )

**Description:** Sets the label for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Z Axis Label( "Iris Sepal Width" ) );


```

#### [XAxis](#xaxis)

**Syntax:** obj \<< XAxis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( XAxis( Min( 3 ), Max( 10 ) ) );


```

#### [YAxis](#yaxis)

**Syntax:** obj \<< YAxis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( YAxis( Min( 1 ), Max( 10 ), Inc( 0.5 ) ) );


```

#### [Z Axis](#z-axis)

**Syntax:** obj \<< Z Axis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( ZAxis( Min( 1 ), Max( 5 ), Inc( 0.25 ) ) );


```

#### [get light active](#get-light-active)

**Syntax:** obj \<< get light active( light number )

**Description:** Returns the specified light activation shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
p = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Active( 2 ) );
Show( p );


```

#### [get light color](#get-light-color)

**Syntax:** obj \<< get light color( light number )

**Description:** Returns the specified light color shining on the plot as a list {red, green, blue}.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Color( 1 ) );
Show( c );


```

#### [get light position](#get-light-position)

**Syntax:** obj \<< get light position( light number )

**Description:** Returns the specified light position shining on the plot as a list {x, y, z}.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
p = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Position( 2 ) );
Show( p );


```

#### [set light active](#set-light-active)

**Syntax:** obj \<< set light active( light number, state=0|1 )

**Description:** Turns on the specified light shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Active( 4, 1 ) );


```

#### [set light color](#set-light-color)

**Syntax:** obj \<< set light color( light number, red value, green value, blue value )

**Description:** Sets the color of the light shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Color( 2, 240, 50, 70 ) );


```

#### [set light position](#set-light-position)

**Syntax:** obj \<< set light position( light number, X, Y, Z )

**Description:** Sets the light position shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Position( 2, -1.5833, 10, 0 ) );


```

# [Scatterplot Matrix](#scatterplot-matrix)

## [Associated Constructors](#associated-constructors)

### [Scatterplot Matrix](#scatterplot-matrix_1)

**Syntax:** Scatterplot Matrix( Y( columns ), \<X( columns )>, \<Group( column )>, \<By( column )> )

**Description:** Produces a grid of scatterplots that enables you to explore bivariate relationships. If no X variables are specified, the scatterplots are for all pairs of the Y variables. If one or more X variables are specified, the scatterplots are for the Y variables plotted against the X variables.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Group](#group)

**Syntax:** obj \<< Group( column )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Item Messages](#item-messages)

### [Density Ellipses](#density-ellipses)

**Syntax:** obj \<< Density Ellipses( state=0|1 )

**Description:** Shows or hides the density ellipses on the scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :POP, :Max deg. F Jan, :OZONE, :CO, :SO2, :NO, :PM10, :Lead )
);
obj << Density Ellipses( 1 );


```

### [Ellipse Color](#ellipse-color)

**Syntax:** Ellipse Color( color )

**Description:** Changes the color for the density ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Solubility.jmp" );
obj = Multivariate(
    Y( :Ether, :Chloroform, :Benzene, :Carbon Tetrachloride, :Hexane ),
    Scatterplot Matrix( Density Ellipses( 1 ), Ellipse Color( "Blue" ) )
);


```

### [Ellipses Coverage](#ellipses-coverage)

**Syntax:** obj \<< Ellipses Coverage( "0.90"|"0.95"|"0.99"|"Other…" )

**Description:** Sets the coverage level, which is (1 - alpha) for the ellipses displayed on the scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Group( :Species )
);
obj << Density Ellipses( 1 );
Wait( 2 );
obj << Ellipses Coverage( 0.99 );


```

### [Ellipses Transparency](#ellipses-transparency)

**Syntax:** obj \<< Ellipses Transparency( "0.20"|"0.40"|"0.60"|"Other…" )

**Description:** Sets the transparency for the ellipses displayed on the scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Group( :Species )
);
obj << Density Ellipses( 1 );
obj << Shaded Ellipses( 1 );
Wait( 2 );
obj << Ellipses Transparency( 0.40 );


```

### [Fit Line](#fit-line)

**Syntax:** obj \<< Fit Line( state=0|1 )

**Description:** Shows or hides the regression line and confidence interval on the scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :POP, :Max deg. F Jan, :OZONE, :CO, :SO2, :NO, :PM10, :Lead )
);
obj << Fit line( 1 );


```

### [Group By](#group-by)

**Syntax:** obj \<< Group By( column )

**Description:** Identifies a grouping variable whose levels are used to create separate ellipses displayed on the scatterplot matrix.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Group By( :Species );
obj << Density Ellipses( 1 );


```

### [Lock Scales](#lock-scales)

**Syntax:** obj \<< Lock Scales( state=0|1 )

**Description:** Locks axis ranges so they do not change in response to data or filtering changes.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = Scatterplot Matrix( Y( :POP, :Max deg. F Jan, :OZONE, :CO, :SO2, :NO, :PM10, :Lead ) );
obj << Lock Scales( 1 );
dt << Select Where( :CO < 10 );
Wait( 1 );
dt << Hide and Exclude;


```

### [Matrix Format](#matrix-format)

**Syntax:** obj = Scatterplot Matrix(...Matrix Format( "Lower Triangular"|"Upper Triangular"|"Square" )...)

**Description:** Specifies how the variables are displayed in the Scatterplot Matrix.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Matrix Format( Square )
);


```

### [Nonpar Density](#nonpar-density)

**Syntax:** obj \<< Nonpar Density( state=0|1 )

**Description:** Shows or hides shaded nonparametric density contours for the 0.90 and 0.50 quantiles.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Nonpar Density( 1 );


```

### [Points Jittered](#points-jittered)

**Syntax:** obj \<< Points Jittered( "None"|"Auto"|"Random Uniform"|"Random Normal"|"Density Random"|"Packed"|"Grid"|"Hex Grid"|"Beeswarm"="Auto" )

**Description:** Jitters the points by moving them slightly on the scatterplot matrix. "Auto" by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width, Species )
);
obj << Points Jittered( "Binned" );


```

### [Shaded Ellipses](#shaded-ellipses)

**Syntax:** obj \<< Shaded Ellipses( state=0|1 )

**Description:** Shades or makes clear the region inside the ellipses on the scatterplot matrix between each Y variable.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Group( :Species )
);
obj << Shaded Ellipses( 1 );


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the points on the scatterplot matrix. On by default.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Show Points( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Scatterplot Matrix(
    Y( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Scatterplot Matrix(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Scheduler](#scheduler)

## [Associated Constructors](#associated-constructors)

### [Schedule](#schedule)

**Syntax:** Schedule( sec, scpt )

**Description:** Schedules an event that runs the scpt script argument after sec seconds have elapsed. Note: the scheduler only runs during idle times.

```

s = Schedule(
    10,
    Beep();
    Print( "Hello World!" );
);


```

## [Item Messages](#item-messages)

### [Clear Schedule](#clear-schedule)

**Syntax:** obj \<< Clear Schedule

**Description:** Clears the scheduler of all events currently scheduled.

```

s = Schedule(
    10,
    Beep();
    Print( "Hello World!" );
);
s << Clear Schedule;


```

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Closes the scheduler.

```

s = Schedule(
    10,
    Beep();
    Print( "Hello World!" );
);
Wait( 2 );
s << Close;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

```

s = Schedule(
    10,
    Beep();
    Print( "Hello World!" );
);
t = s << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

### [Restart](#restart)

**Syntax:** obj \<< Restart

**Description:** Restarts the scheduler after it was stopped from running all events currently scheduled.

```

s = Schedule(
    10,
    Beep();
    Print( "Hello World!" );
);
s << Stop;
Wait( 2 );
s << Restart;


```

### [Show Schedule](#show-schedule)

**Syntax:** obj \<< Show Schedule

**Description:** Shows the next event currently scheduled.

```

s = Schedule(
    10,
    Beep();
    Print( "Hello World!" );
);
s << Show Schedule;


```

### [Stop](#stop)

**Syntax:** obj \<< Stop

**Description:** Stops the scheduler from running all events currently scheduled.

```

s = Schedule(
    10,
    Beep();
    Print( "Hello World!" );
);
s << Stop;


```

# [Score Ellipse Coverage](#score-ellipse-coverage)

## [Item Messages](#item-messages)

### [Remove Fit](#remove-fit)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 15

### [Shaded Contour](#shaded-contour)

**Syntax:** obj \<< Shaded Contour( state=0|1 )

**Description:** Shows or hides the shaded contour.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Flight Delays.jmp" );
obj = dt << Model Driven Multivariate Control Chart(
    Process( :AA, :CO, :DL, :F9, :FL, :NW, :UA, :US, :WN )
);
obj << Score Plot( Score Ellipse Coverage( 0.95, {Shaded Contour( 1 )} ) );


```

# [Sequencing Variants Toolset](#sequencing-variants-toolset)

## [Associated Constructors](#associated-constructors)

### [Sequencing Variants Toolset](#sequencing-variants-toolset_1)

**Syntax:** Sequencing Variants Toolset

**Description:** Provides a framework to process and analyze high-throughput sequencing data with SamTools and BcfTools.

## [Item Messages](#item-messages)

### [Arguments](#arguments)

**Syntax:** obj \<< Arguments

**Description:** Enables specification of options to run the platform from the scripting window.

### [Run Cmd](#run-cmd)

**Syntax:** obj \<< Run Cmd

**Description:** Determines the sequencing variants toolset task to be run from the scripting window.

### [Run Spec](#run-spec)

**Syntax:** obj \<< Run Spec

**Description:** Determines the sequencing variants toolset task to be run from the interface window.

### [Specification](#specification)

**Syntax:** obj \<< Specification

**Description:** Enables specification of a task.

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

obj << Copy Script;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [Sequencing Variants Toolset Run](#sequencing-variants-toolset-run)

### [Item Messages](#item-messages_1)

#### [Auto Send Output to Files List](#auto-send-output-to-files-list)

**Syntax:** obj \<< Auto Send Output to Files List( state=0|1 )

**Description:** Sends output files to the files list panel.

#### [Bam Files](#bam-files)

**Syntax:** obj \<< Bam Files

**Description:** Specifies BAM files.

#### [Bcf Files](#bcf-files)

**Syntax:** obj \<< Bcf Files

**Description:** Specifies BCF files.

#### [Caller](#caller)

**Syntax:** obj \<< Caller( "Multiallelic"|"Consensus"="Multiallelic" )

**Description:** "Multiallelic" by default.

#### [Copy Task Specification](#copy-task-specification)

**Syntax:** obj \<< Copy Task Specification

**Description:** Copies the current sequencing variants toolset specifications to the clipboard.

**JMP Version Added:** 19

#### [Files](#files)

**Syntax:** obj \<< Files

**Description:** Load input files to be run in samtools.

#### [Ploidy](#ploidy)

**Syntax:** obj \<< Ploidy( number=2 )

**Description:** "2" by default.

#### [Recall in Task Specification](#recall-in-task-specification)

**Syntax:** obj \<< Recall in Task Specification

**Description:** Sets the task specification in the Task Specification report to the specified model.

#### [Ref Files](#ref-files)

**Syntax:** obj \<< Ref Files

**Description:** Specifies Reference Genome files.

#### [Remove Run](#remove-run)

**Syntax:** obj \<< ( Run[number] \<< Remove Run( state=0|1 ) )

**Description:** Removes the specified run report from the report window.

#### [Results Folder](#results-folder)

**Syntax:** obj \<< Results Folder

**Description:** Specifies the result folder.

#### [Sam Files](#sam-files)

**Syntax:** obj \<< Sam Files

**Description:** Specifies SAM files.

#### [Send Output to Files List](#send-output-to-files-list)

**Syntax:** obj \<< Send Output to Files List( state=0|1 )

**Description:** Sends output files to the file list panel.

#### [Sort Reads By](#sort-reads-by)

**Syntax:** obj \<< Sort Reads By( "Coordinates"|"Alpha-numeric"|"Lexicographical"="Coordinates" )

**Description:** "Coordinates" by default.

#### [Summary](#summary)

**Syntax:** obj \<< Summary( state=0|1 )

**Description:** Shows or hides a report that contains details of the run. On by default.

#### [Target Regions](#target-regions)

**Syntax:** obj \<< Target Regions

**Description:** Sets target regions. The specification of regions requires that the BAM file be coordinate-sorted and indexed.

#### [Task](#task)

**Syntax:** obj \<< Task( "Index Fasta"|"Convert SAM to BAM"|"Sort Reads"|"Add Mate Coordinates"|"Remove Duplicates"|"Merge Files"|"Index BAM"|"Convert BAM To SAM"|"Extract Mapped Reads"|"Extract Unmapped Reads"|"Extract Target Regions"|"Extract Properly Aligned"|"Extract First Read"|"Tag Mismatches and Insertions"|"Count Alignment"|"Count Alignment By Flag"|"Count Alignment By Reference"|"Generate Statistics"|"Generate Base Alignment Quality"|"Generate Read Depth"|"Bgzip Compress"|"Bgzip Decompress"|"Generate Genotype Likelihoods"|"Generate Genotype Calls"|"Convert Bcf to Vcf"|"Convert Vcf to Bcf" )

**Description:** Determines the task to run.

#### [Title](#title_1)

**Syntax:** obj \<< Title

**Description:** Sets a title.

#### [Unthreaded](#unthreaded)

**Syntax:** obj \<< Unthreaded( state=0|1 )

**Description:** Use only the main thread for calculations

#### [Vcf Files](#vcf-files)

**Syntax:** obj \<< Vcf Files

**Description:** Specifies VCF files.

## [Sequencing Variants Toolset Specification](#sequencing-variants-toolset-specification)

### [Item Messages](#item-messages_2)

#### [Auto Send Output to Files List](#auto-send-output-to-files-list_1)

**Syntax:** obj \<< Auto Send Output to Files List( state=0|1 )

**Description:** Sends output files to the files list panel.

#### [Bam Files](#bam-files_1)

**Syntax:** obj \<< Bam Files

**Description:** Specifies BAM files.

#### [Bcf Files](#bcf-files_1)

**Syntax:** obj \<< Bcf Files

**Description:** Specifies BCF files.

#### [Caller](#caller_1)

**Syntax:** obj \<< Caller( "Multiallelic"|"Consensus"="Multiallelic" )

**Description:** "Multiallelic" by default.

#### [Files](#files_1)

**Syntax:** obj \<< Files

**Description:** Load input files to be run in samtools.

#### [Ploidy](#ploidy_1)

**Syntax:** obj \<< Ploidy( number=2 )

**Description:** Specifies a positive number that indicates the ploidy level. "2" by default.

#### [Ref Files](#ref-files_1)

**Syntax:** obj \<< Ref Files

**Description:** Specifies Reference Genome files.

#### [Results Folder](#results-folder_1)

**Syntax:** obj \<< Results Folder

**Description:** Specifies the result folder.

#### [Sam Files](#sam-files_1)

**Syntax:** obj \<< Sam Files

**Description:** Specifies SAM files.

#### [Sort Reads By](#sort-reads-by_1)

**Syntax:** obj \<< Sort Reads By( "Coordinates"|"Alpha-numeric"|"Lexicographical"="Coordinates" )

**Description:** "Coordinates" by default.

#### [Target Regions](#target-regions_1)

**Syntax:** obj \<< Target Regions

**Description:** Sets target regions. The specification of regions requires that the BAM file be coordinate-sorted and indexed.

#### [Task](#task_1)

**Syntax:** obj \<< Task( "Index Fasta"|"Convert SAM to BAM"|"Sort Reads"|"Add Mate Coordinates"|"Remove Duplicates"|"Merge Files"|"Index BAM"|"Convert BAM To SAM"|"Extract Mapped Reads"|"Extract Unmapped Reads"|"Extract Target Regions"|"Extract Properly Aligned"|"Extract First Read"|"Tag Mismatches and Insertions"|"Count Alignment"|"Count Alignment By Flag"|"Count Alignment By Reference"|"Generate Statistics"|"Generate Base Alignment Quality"|"Generate Read Depth"|"Bgzip Compress"|"Bgzip Decompress"|"Generate Genotype Likelihoods"|"Generate Genotype Calls"|"Convert Bcf to Vcf"|"Convert Vcf to Bcf"="Index Fasta" )

**Description:** Determines the task to run. "Index Fasta" by default.

#### [Title](#title_2)

**Syntax:** obj \<< Title

**Description:** Sets a title.

#### [Unthreaded](#unthreaded_1)

**Syntax:** obj \<< Unthreaded( state=0|1 )

**Description:** Use only the main thread for calculations

#### [Vcf Files](#vcf-files_1)

**Syntax:** obj \<< Vcf Files

**Description:** Specifies VCF files.

# [Socket](#socket)

## [Associated Constructors](#associated-constructors)

### [Socket](#socket_1)

**Syntax:** socketHandle = Socket( \<STREAM | DGRAM> )

**Description:** Creates a socket variable that can communicate with sockets on this or another networked computer. The default argument is STREAM. Try your own company's website.

```


// see the socket's OBJECT messages in the scripting index for better examples
tCall = Socket();
tcall << Ioctl( FIONBIO, 1 );
rc = tCall << connect( "www.jmp.com", "80" );
If( rc[2] == "ok",
    tCall << <<Char To Blob(
        "GET /en_us/home.html HTTP/1.1~0d~0aHost: www.jmp.com~0d~0aConnection: Close~0d~0a~0d~0a",
        "ASCII~HEX"
    );
    While( 1,
        tMessage = tCall << Recv( 100000 );
        If(
            tMessage[2] == "ok",
                Show( Length( tMessage[3] ) ); //typically about six chunks of around 5-20K bytes
        ,
            Starts With( tMessage[2], "WOULDBLOCK" ),
                Show( "waiting" ) // sometimes data might not be available yet
        ,
            Starts With( tMessage[2], "CLOSED" ),
                Break(); // this is the desired result
        , // else
            Show( tMessage );
            Stop();
        );
    );
    tCall << Close();// done
, // else
    Show( rc );
    Stop();
);


```

## [Item Messages](#item-messages)

### [Accept](#accept)

**Syntax:** obj \<< Accept

**Description:** Accept a connection from a remote computer on a Listening socket

```


// see Listen for a complete example
skt = Socket();
// lots of missing code goes here
rc = skt << accept();
// IMPORTANT: check the rc[2]=="ok", then get the conskt from rc[4].  See Listen example.


```

### [Accept Fast](#accept-fast)

**Syntax:** obj \<< Accept Fast

**Description:** Accept a connection from a remote computer on a Listening socket

**JMP Version Added:** 14

```


// see Listen for a complete example
// Same as <<accept, but does not resolve the client address to a name.
// Sometimes the resolve can take many seconds. 
// remoteaddr = rc[3]; <<< this will be an empty string with <<acceptFast
skt = Socket();
// lots of missing code goes here
rc = skt << AcceptFast();
// IMPORTANT: check the rc[2]=="ok", then get the conskt from rc[4].  See Listen example.


```

### [Bind](#bind)

**Syntax:** obj \<< Bind

**Description:** Bind a socket to a port on your computer in preparation for Listening for connections.

```


// see Listen for complete example
skt = Socket();
rc = skt << bind( "localhost", "80" );


```

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Close a socket. The socket should be recreated before using it again. Connected sockets can be closed locally or remotely. Listening sockets can be closed locally.

```

x = Socket();/* use the socket...*/ x << Close();


```

### [Connect](#connect)

**Syntax:** obj \<< Connect

**Description:** Connect to a remote computer.

```


// <<connect is used to connect to a remote computer with an open listening socket.
// some web sites require www, some don't like it.  Some require the HTTP/1.1 format, some are happy with HTTP/1.0 in the GET.
// You'll want to make the error handling more robust...
skt = Socket();
rc = skt << connect( "www.jmp.com", "80" );
If( rc[2] != "ok",
    Show( rc );
    Stop();
); 

// request a resource from the remote computer.  the trailing slash in the example might or might not be needed.
skt << Send(
    Char To Blob(
        "GET /en_us/home.html HTTP/1.1~0d~0aHost: www.jmp.com~0d~0aConnection: Close~0d~0a~0d~0a",
        "ascii~hex"
    )
);
// gather the response, it might be more than one buffer
blob = Char To Blob( "" ); // start with nothing
blobtext = "";
timeout = 50; // give remote a short time to send a response.  you might need to tune the timeout behavior.
While( timeout-- > 0,
    rc = skt << recv( 10000 );
    If(
        rc[2] == "ok",
            blob = blob || rc[3]; // recv always returns a blob, not text
            Write( "\!nsome text received" ); // typically about three of these, ymmv
            timeout = 50; // reset, still receiving ok
    , // else
        Starts With( rc[2], "CLOSED" ),
            Break(); // done
    , // else
        Starts With( rc[2], "WOULDBLOCK" ), //
            Write( "\!nwaiting..." ) // still fetching, maybe
    , // else...what?
        Show( rc );
        Stop(); // that was unexpected
    );
    blobtext = Blob To Char( blob, encoding = "utf-8" );
    If( timeout == 0,
        Write( "\!nTimed out waiting for remote request" );
        Stop();
    );
    Wait( .05 ); // give the OS some cycles to work with the incoming data
);

Show( Length( blob ) );


```

### [GetPeerName](#getpeername)

**Syntax:** obj \<< GetPeerName

**Description:** Get the name of the remote computer.

```


tCall = Socket();
rc = tCall << connect( "www.jmp.com", "80" );
Show( rc, tCall << getPeerName );


```

### [GetSockName](#getsockname)

**Syntax:** obj \<< GetSockName

**Description:** Get the name of the local computer.

```


tCall = Socket();
rc = tCall << connect( "www.jmp.com", "80" );
Show( rc, tCall << getSockName );


```

### [Ioctl](#ioctl)

**Syntax:** obj \<< Ioctl

**Description:** Switch a socket into non-blocking mode or determine how much data is waiting to be read.

```


// see Listen for complete example
skt = Socket();
skt << Ioctl( FIONBIO, 0 | 1 ); // block/non-block
len = skt << Ioctl( FIONREAD ); // how much data available
// you should not use FIONREAD to poll for data availability.  Use something like Listen or Connect examples


```

### [Listen](#listen)

**Syntax:** obj \<< Listen

**Description:** Puts the socket in Listen mode. Use Accept to accept a connection from a remote computer.

```


// this example puts the listening socket into non blocking mode so
// it can be polled for connection attempts.  In blocking mode, the
// <<accept will not return until a connection is made from a remote
// computer.  That will be frustrating if you have not saved your work.
// you can use a web browser to connect to localhost on the same
// computer to make a connection (blocking or non-blocking)
sk = Socket( IPV4 );
// The IPV4/IPV6 parameter is optional and probably should be left out if
// your computer does not have both.  It is used by <<bind and <<connect
// to help choose an interface.
rc = sk << bind( "localhost", "8081" );
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
rc = sk << Ioctl( "FIONBIO", 1 ); // non-blocking mode
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
Write( "\!nlistening on ", (sk << getSockName)[3] );
sk << Listen();

Web( "http://localhost:8081/someResource" ); // demo a connection.
// the browser will try to connect.  
// the local and remote computer are the same computer.
// generally you would run the browser from outside this JSL.

conskt = Empty();
For( i = 1, i < 10, i++, // poll several times, once a second
    Wait( 1 );
    rc = sk << accept();
    If( Starts With( rc[2], "WOULDBLOCK" ),
        Print( "no connect attempt yet" ) //
    , // else probably a connect attempt
        If( rc[2] == "ok", // and it was!
            remoteaddr = rc[3];
            Write( "\!nConnection from ", remoteaddr );
            conskt = rc[4];
            Break(); //
        , // else...what was it?
            Show( rc );
            Stop();
        )
    );
);
sk << Close(); // otherwise the listener is still listening, but this JSL won't answer a 2nd time
// timeout or connect?
If( Is Empty( conskt ),
    Write( "\!nTimeout, no connections requested.  Stopped.\!n" )
);
// find out what the remote computer wants
//
// << recv will only return the data that is available, up to a limit you specify.
// to get ALL the data, you must ask in a loop, in a way that you know when to
// stop asking...In this case, a request ends with CR LF CR LF
blob = Char To Blob( "" ); // start with nothing
blobtext = "";
timeout = 5; // give remote about 5 seconds to send a request
While( timeout-- > 0,
    rc = conskt << recv( 10000 );
    If(
        rc[2] == "ok",
            blob = blob || rc[3]; // recv always returns a blob, not text
    ,
        Starts With( rc[2], "WOULDBLOCK" ), //
            Write( "\!n..." ), // else...what?
        Show( rc );
        Stop();
    );
    blobtext = Blob To Char( blob, encoding = "utf-8" );
    If( Right( blobtext, 4 ) == "\!r\!n\!r\!n",
        Break()
    );
    If( timeout == 0,
        Write( "\!nTimed out waiting for remote request" );
        Stop();
    );
    Wait( 1 );
);

Write( "\!n", blobtext );

requested = Regex( blobtext, "^GET /([^ ]*)", "\1" ); // you may need a better pattern

// send an HTML page to the remote computer

conskt << Send(
    Char To Blob(
        "HTTP/1.0 200 OK\!nContent-Type: text/html\!n\!n<html><body>here's the doc for " ||
        requested || ".<br><br>This page was served by JMP.</body></html>"
    )
);
conskt << close; // nothing else to send to the browser


```

### [Recv](#recv)

**Syntax:** obj \<< Recv

**Description:** Receive data from a remote computer. Specify the maximum bytes you want to receive. If the socket is in blocking mode, the receive will not return until there is some data or the connection is closed remotely. In non-blocking mode, zero bytes and a Would Block return code might happen.

```


// see Listen and Connect for complete examples)
skt = Socket();
// connection code goes here
rc = skt << recv( 1000 ); // specifie the UPPER limit on the amount of data returned.
// the socket may be in blocking or non-blocking mode; in blocking mode it
// will not return until at least 1 byte is available or the connection is closed.
// in non-blocking mode the rc[2] may start with WOULDBLOCK if no data
// is available.  The Listen and Connect examples show how to retrieve *ALL*
// the expected data.  You might get lucky and have 1K bytes in the first recv.


```

### [RecvFrom](#recvfrom)

**Syntax:** obj \<< RecvFrom

**Description:** (DGram support, avoid this message if you don't know why you need it.) Receive a DGram from a remote computer.

```


// DGRAM is a connectionless, unreliable protocol.  this self-contained
// example sends itself a short message, which will probably arrive, and
// displays the message at the end.  A more realistic example would use two 
// computers and spend a LOT more effort looking at the return codes.
// ***Don't build a system around DGRAM if you don't have a REALLY good reason***
// you'll most likely be re-inventing TCP, which is built on top of UDP
// which is the datagram protocol.  JSL Socket() with no parameter or Socket(STREAM)
// will create the robust TCP connection.  DGRAM is here because you might
// have an existing system that needs it.
xxx = Socket( DGRAM );
yyy = Socket( DGRAM );
rc = xxx << bind( "127.0.0.1", "12345" ); // 12345 is the port for the recv socket
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
rc = xxx << ioctl( FIONBIO, 1 ); // must be non-blocking so...
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
rc = xxx << recvFrom( 100 );// this read always fails with "WouldBlock" because...
If( !Pat Match( rc[2], "WOULDBLOCK" ),
    Show( rc );
    Stop();
);
rc = yyy << sendTo( "127.0.0.1", "12345", Char To Blob( "this is a test" ) );// this data was not sent earlier.
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
rc = xxx << recvFrom( 100 ); // now it (might) work.  its always been here in time so far.
If( Pat Match( rc[2], "WOULDBLOCK" ),
    Wait( 1 );
    rc = xxx << recvFrom( 100 );
);
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
Show( rc ); // this return code tells who sent the message
result = Blob To Char( rc[3] );
rc = xxx << Close();
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
rc = yyy << Close();
If( rc[2] != "ok",
    Show( rc );
    Stop();
);
Show( result );


```

### [Send](#send)

**Syntax:** obj \<< Send

**Description:** Send data to a remote computer.

```


// see Listen and Connect for complete examples
skt = Socket();
// connection code goes here
rc = skt << Send( Char To Blob( "Hello World" ) );


```

### [SendTo](#sendto)

**Syntax:** obj \<< SendTo

**Description:** (DGram support, avoid this message if you don't know why you need it.) Send a DGram to a remote computer.

```

// See RecvFrom example


```

# [Structural Equation Models](#structural-equation-models)

## [Associated Constructors](#associated-constructors)

### [Structural Equation Models](#structural-equation-models_1)

**Syntax:** Structural Equation Models( Model Variables ( columns ) )

**Description:** Provides a framework to fit a variety of models, including confirmatory factor analysis, path models with or without latent variables, measurement error models, and latent growth curve models.

**JMP Version Added:** 15

#### [Confirmatory Factor Analysis](#confirmatory-factor-analysis)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);


```

#### [Higher Order Confirmatory Factor Analysis](#higher-order-confirmatory-factor-analysis)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables(
        :Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C, :Inter_C, :General_S,
        :Growth_S, :Coworker_S, :Supervisor_S
    ),
    Fit(
        Model Name( "Higher Order CFA" ),
        New Latent( "Leadership", "Conflict", "Satisfaction", "General" ),
        Means(
            {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C,
            :Inter_C, :General_S, :Growth_S, :Coworker_S, :Supervisor_S}}
        ),
        Loadings(
            {"Leadership", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}},
            {"Conflict", {:Person_C, :Intra_C, :Inter_C}, {1}},
            {"Satisfaction", {:General_S, :Growth_S, :Coworker_S, :Supervisor_S}, {1}},
            {"General", {"Leadership", "Conflict", "Satisfaction"}, {1}}
        ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {:Person_C, {:Person_C}},
            {:Intra_C, {:Intra_C}},
            {:Inter_C, {:Inter_C}},
            {:General_S, {:General_S}},
            {:Growth_S, {:Growth_S}},
            {:Coworker_S, {:Coworker_S}},
            {:Supervisor_S, {:Supervisor_S}},
            {"Leadership", {"Leadership"}},
            {"Conflict", {"Conflict"}},
            {"Satisfaction", {"Satisfaction"}},
            {"General", {"General"}}
        )
    )
);


```

#### [Linear Latent Growth Curve Model](#linear-latent-growth-curve-model)

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Linear Growth Curve Model" ),
        New Latent( "Intercept", "Slope" ),
        Means( {"Constant", {"Intercept", "Slope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}, {"b1"}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}, {"b1"}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}, {"b1"}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}, {"b1"}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}}
        ),
        Covariances( {"Intercept", {"Slope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);


```

#### [Multiple Linear Regression with SEM](#multiple-linear-regression-with-sem)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables( :Satisfaction_Avg, :Support_L, :Goal_L, :Work_L ),
    Fit(
        Model Name( "Multiple Regression" ),
        Means( {"Constant", {:Satisfaction_Avg, :Support_L, :Goal_L, :Work_L}} ),
        Regressions(
            {:Support_L, {:Satisfaction_Avg}},
            {:Goal_L, {:Satisfaction_Avg}},
            {:Work_L, {:Satisfaction_Avg}}
        ),
        Variances(
            {:Satisfaction_Avg, {:Satisfaction_Avg}},
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}}
        ),
        Covariances( {:Support_L, {:Goal_L, :Work_L}}, {:Goal_L, {:Work_L}} ),

    )
);


```

#### [Path Analysis Model](#path-analysis-model)

```

dt = Open( "$SAMPLE_DATA/Online Consumer Data.jmp" );
dt << Structural Equation Models(
    Model Variables( :Privacy, :Reputation, :Trust, :Purchase Int ),
    Fit(
        Model Name( "Path Analysis with Observed Variables" ),
        Means( {"Constant", {:Privacy, :Reputation, :Trust, :Purchase Int}} ),
        Regressions(
            {:Privacy, {:Trust}},
            {:Reputation, {:Trust, :Purchase Int}},
            {:Trust, {:Purchase Int}}
        ),
        Variances(
            {:Privacy, {:Privacy}},
            {:Reputation, {:Reputation}},
            {:Trust, {:Trust}},
            {:Purchase Int, {:Purchase Int}}
        ),
        Covariances( {:Privacy, {:Reputation}} )
    )
);


```

#### [Path Analysis with Latent Variables](#path-analysis-with-latent-variables)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables(
        :Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C, :Inter_C, :General_S,
        :Growth_S, :Coworker_S, :Supervisor_S
    ),
    Fit(
        Model Name( "Path Analysis with Latent Variables" ),
        New Latent( "Leadership", "Conflict", "Satisfaction" ),
        Means(
            {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L, :Person_C, :Intra_C,
            :Inter_C, :General_S, :Growth_S, :Coworker_S, :Supervisor_S}}
        ),
        Loadings(
            {"Leadership", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}},
            {"Conflict", {:Person_C, :Intra_C, :Inter_C}, {1}},
            {"Satisfaction", {:General_S, :Growth_S, :Coworker_S, :Supervisor_S}, {1}}
        ),
        Regressions(
            {"Leadership", {"Conflict", "Satisfaction"}},
            {"Conflict", {"Satisfaction"}}
        ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {:Person_C, {:Person_C}},
            {:Intra_C, {:Intra_C}},
            {:Inter_C, {:Inter_C}},
            {:General_S, {:General_S}},
            {:Growth_S, {:Growth_S}},
            {:Coworker_S, {:Coworker_S}},
            {:Supervisor_S, {:Supervisor_S}},
            {"Leadership", {"Leadership"}},
            {"Conflict", {"Conflict"}},
            {"Satisfaction", {"Satisfaction"}}
        )
    )
);


```

#### [Quadratic Latent Growth Curve Model](#quadratic-latent-growth-curve-model)

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Quadratic Growth Model" ),
        New Latent( "Intercept", "Slope", "QuadSlope" ),
        Means( {"Constant", {"Intercept", "Slope", "QuadSlope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}},
            {"QuadSlope", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {0, 1, 4, 9}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}},
            {"QuadSlope", {"QuadSlope"}}
        ),
        Covariances( {"Intercept", {"Slope", "QuadSlope"}}, {"Slope", {"QuadSlope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);


```

#### [Simple Linear Regression with SEM](#simple-linear-regression-with-sem)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Satisfaction_Avg ),
    Fit(
        Model Name( "Simple Regression" ),
        Means( {"Constant", {:Leadership_Avg, :Satisfaction_Avg}} ),
        Regressions( {:Leadership_Avg, {:Satisfaction_Avg}} ),
        Variances(
            {:Leadership_Avg, {:Leadership_Avg}},
            {:Satisfaction_Avg, {:Satisfaction_Avg}}
        )
    )
);


```

#### [Simple Mediation Model](#simple-mediation-model)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg, :Satisfaction_Avg ),
    Fit(
        Model Name( "Mediation Analysis" ),
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg, :Satisfaction_Avg}} ),
        Regressions(
            {:Leadership_Avg, {:Conflict_Avg, :Satisfaction_Avg}},
            {:Conflict_Avg, {:Satisfaction_Avg}}
        ),
        Variances(
            {:Leadership_Avg, {:Leadership_Avg}},
            {:Conflict_Avg, {:Conflict_Avg}},
            {:Satisfaction_Avg, {:Satisfaction_Avg}}
        )
    )
);


```

## [Columns](#columns)

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    Freq( :_freqcol )
);


```

### [Groups](#groups)

**Syntax:** obj \<< Groups( column )

**Description:** Specifies the grouping variable for performing multiple group analysis.

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
dt << Structural Equation Models( Model Variables( 4 :: 7 ), Groups( :Sex ) );


```

### [Mean](#mean)

**Syntax:** obj = Structural Equation Models(...\<Mean( column )>...)

**Description:** Specifies means for each manifest variable in a correlation or covariance matrix.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
mat = dt[0, 2 :: 5];
mat_cor = Correlation( mat );
mat_means = V Mean( mat );
mat_sds = V Std( mat );
As Table( mat_cor || mat_means` || mat_sds` ) << Set Name( "Correlation" );
Data Table( "Correlation" ) << Structural Equation Models(
    Data Format( "Matrix" ),
    Model Variables( 1 :: 4 ),
    Mean( :Col5 ),
    Std Dev( :Col6 ),
    Sample Size( 200 )
);


```

### [Model Variables](#model-variables)

**Syntax:** obj \<< Model Variables( column(s) )

**Description:** Specifies the variables that will be submitted for analysis.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L )
);


```

### [Std Dev](#std-dev)

**Syntax:** obj = Structural Equation Models(...\<Std Dev( column )>...)

**Description:** Specifies standard deviations for each manifest variable in a correlation matrix.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
mat = dt[0, 2 :: 5];
mat_cor = Correlation( mat );
mat_means = V Mean( mat );
mat_sds = V Std( mat );
As Table( mat_cor || mat_means` || mat_sds` ) << Set Name( "Correlation" );
Data Table( "Correlation" ) << Structural Equation Models(
    Data Format( "Matrix" ),
    Model Variables( 1 :: 4 ),
    Mean( :Col5 ),
    Std Dev( :Col6 ),
    Sample Size( 200 )
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    Weight( :_weightcol )
);


```

## [Item Messages](#item-messages)

### [Add Manifest Variables](#add-manifest-variables)

**Syntax:** obj \<< Add Manifest Variables

**Description:** Relaunches the platform using the existing model specification and including the newly added manifest variables.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: CFA 1Factor Conflict UI" );
obj << Add Manifest Variables();


```

### [Bootstrap Inference](#bootstrap-inference)

**Syntax:** obj \<< Bootstrap Inference

**Description:** Performs bootstrapping for a user-specified selection of estimates in available fitted models of the SEM report.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Bootstrap Inference( Parameter Estimates( 1 ), Indirect Effects( 1 ) );


```

### [Compare Selected Models](#compare-selected-models)

**Syntax:** obj \<< Compare Selected Models

**Description:** Compares models selected in the Model Comparison table.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Measurement Models" );
obj << Compare Selected Models( {"Orthogonal 3-Factor CFA", "3-Factor CFA"} );


```

### [Copy Diagram Properties](#copy-diagram-properties)

**Syntax:** obj \<< Copy Diagram Properties

**Description:** Copies the current path diagram properties to the clipboard. You can then paste the properties into another SEM path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt2 = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt2 << Run Script( "SEM: Compare Growth Trajectories" );
obj << Copy Diagram Properties();
obj2 = dt << Structural Equation Models( Model Variables( 2 :: 12 ) );
obj2 << Paste Diagram Properties();


```

### [Copy Model Specification](#copy-model-specification)

**Syntax:** obj \<< Copy Model Specification

**Description:** Copies the current structural equation model specifications to the clipboard. You can then paste the model specifications into another SEM platform report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Path Analysis no Latent" );
obj << Copy Model Specification();
obj2 = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg, :Satisfaction_Avg )
);
obj2 << Paste Model Specification();


```

### [Estimation Method](#estimation-method)

**Syntax:** obj = Structural Equation Models(...Estimation Method( "Maximum Likelihood (ML and FIML)"|"Maximum Likelihood with Robust Inference"|"MIIV Two-Stage Least Squares" )...)

**Description:** Enables using different estimators for analysis.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Estimation Method( "MIIV Two-Stage Least Squares" ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Goal_L, :Work_L, :Interact_L, "Leader"}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 ),
        Assess Measurement Model( 1 )
    )
);


```

### [Fit](#fit)

**Syntax:** obj \<< Fit

**Description:** Determines the structural equation model to be fit.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        )
    )
);


```

### [Fit Independence Model](#fit-independence-model)

**Syntax:** obj = Structural Equation Models(...Fit Independence Model( state=0|1 )...)

**Description:** Disables fitting the independence model upon launching the platform. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit Independence Model( 0 )
);


```

### [Fit Unrestricted Model](#fit-unrestricted-model)

**Syntax:** obj \<< Fit Unrestricted Model( state=0|1 )

**Description:** Disables fitting the unrestricted, also known as saturated, model upon launching the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit Unrestricted Model( 0 )
);


```

### [Full Information Multivariate Statistics](#full-information-multivariate-statistics)

**Syntax:** obj \<< Full Information Multivariate Statistics( state=0|1 )

**Description:** Shows or hides a multivariate simple statistics report, where the statistics are estimated with full information maximum likelihood to account for missing data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L )
);
obj << Full Information Multivariate Statistics( 1 );


```

### [Generate R Code](#generate-r-code)

**Syntax:** obj \<< Generate R Code

**Description:** Generates R code for the currently specified model. The code is written to a script editor window.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Path Analysis no Latent" );
obj << Generate R Code();


```

### [Hide Model](#hide-model)

**Syntax:** obj \<< Hide Model

**Description:** Hides models according to selections in the model comparison table.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        )
    ),
    Hide Model( {3} )
);


```

### [Launch Explore Missing Values](#launch-explore-missing-values)

**Syntax:** obj \<< Launch Explore Missing Values

**Description:** Launches the Explore Missing Values platform.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L )
);
obj << Launch Explore Missing Values( 1 );


```

### [Launch Explore Outliers](#launch-explore-outliers)

**Syntax:** obj \<< Launch Explore Outliers

**Description:** Launches the Explore Outliers platform.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L )
);
obj << Launch Explore Outliers( 1 );


```

### [Model Specification](#model-specification)

**Syntax:** obj \<< Model Specification

**Description:** Enables specification of a structural equation model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Model Name( "Means and Variances Model" ),
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

### [Paste Diagram Properties](#paste-diagram-properties)

**Syntax:** obj \<< Paste Diagram Properties

**Description:** Pastes the path diagram properties from the clipboard into the current SEM path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt2 = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt2 << Run Script( "SEM: Compare Growth Trajectories" );
obj << Copy Diagram Properties();
obj2 = dt << Structural Equation Models( Model Variables( 2 :: 12 ) );
obj2 << Paste Diagram Properties();


```

### [Paste Model Specification](#paste-model-specification)

**Syntax:** obj \<< Paste Model Specification

**Description:** Pastes the model specifications from the clipboard into the current model specifications.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Path Analysis no Latent" );
obj << Copy Model Specification();
obj2 = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg, :Satisfaction_Avg )
);
obj2 << Paste Model Specification();


```

### [Path Diagram Properties](#path-diagram-properties)

**Syntax:** obj \<< Path Diagram Properties

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Linear Growth Model" ),
        New Latent( "Intercept", "Slope" ),
        Means( {"Constant", {"Intercept", "Slope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}, {"b1"}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}, {"b1"}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}, {"b1"}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}, {"b1"}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}}
        ),
        Covariances( {"Intercept", {"Slope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);


```

### [Remove Manifest Variables](#remove-manifest-variables)

**Syntax:** obj \<< Remove Manifest Variables

**Description:** Relaunches the platform using the existing model specification but without the removed manifest variables.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: CFA 1Factor Conflict UI" );
obj << Remove Manifest Variables();


```

### [Reset Independence Model](#reset-independence-model)

**Syntax:** obj \<< Reset Independence Model

**Description:** Replaces a user-specified independence model with the default one.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Run Script( "SEM: Compare Growth Trajectories" );
obj << Set as Independence Model( 2 );
obj << Reset Independence Model();


```

### [Robust Inference](#robust-inference)

**Syntax:** obj \<< Robust Inference( state=0|1 )

**Description:** Computes sandwich standard errors for the ML or FIML parameter estimates and the robust fit statistics. This option is used for non-normally distributed outcomes where a continuous underlying distribution is assumed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Robust Inference( 1 );


```

### [Set as Independence Model](#set-as-independence-model)

**Syntax:** obj \<< Set as Independence Model( number )

**Description:** Replaces the default independence model with a user-specified one.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Run Script( "SEM: Compare Growth Trajectories" );
obj << Set as Independence Model( 2 );


```

### [Standardize Latent Variables](#standardize-latent-variables)

**Syntax:** obj = Structural Equation Models(...Standardize Latent Variables( state=0|1 )...)

**Description:** Sets the variance of latent variables to unity upon specification.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Standardize Latent Variables( 1 )
);


```

### [Univariate Simple Statistics](#univariate-simple-statistics)

**Syntax:** obj \<< Univariate Simple Statistics( state=0|1 )

**Description:** Shows or hides a univariate simple statistics report, where the statistics are calculated for each column independently from other columns that might have missing data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L )
);
obj << Univariate Simple Statistics( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        Model Name( "One Factor CFA" ),
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        ),
        Standardized Parameter Estimates( 1 ),
        Normalized Residuals Heat Map( 1 )
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Structural Equation Models(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Structural Equation Models Fit > Structural Equation Models Equation Details](#structural-equation-models-fit-structural-equation-models-equation-details)

### [Item Messages](#item-messages_1)

#### [Composite Error](#composite-error)

**Syntax:** obj \<< Composite Error( state=0|1 )

**Description:** Shows or hides the composite error of the model-implied instrumental variable two-stage least squares equations.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA\Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989) MIIV-2SLS Estimator" );
obj << Equation Details( Composite Error( 1 ) );


```

#### [Show All Equations](#show-all-equations)

**Syntax:** obj \<< Show All Equations( state=0|1 )

**Description:** Shows or hides equations in the model that have only the Constant as a predictor.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA\Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989) MIIV-2SLS Estimator" );
obj << Equation Details( Show All Equations( 1 ) );


```

#### [Variance of the Error](#variance-of-the-error)

**Syntax:** obj \<< Variance of the Error( state=0|1 )

**Description:** Shows or hides the variance of the error for each equation in the model.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA\Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989) MIIV-2SLS Estimator" );
obj << Equation Details( Variance of the Error( 1 ) );


```

## [Structural Equation Models Fit > Structural Equation Models Remove Effects](#structural-equation-models-fit-structural-equation-models-remove-effects)

### [Item Messages](#item-messages_2)

#### [Remove Effects](#remove-effects)

**Syntax:** obj \<< Remove Effects

**Description:** Removes specific indirect effects from the report.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA\Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Path Analysis no Latent" );
obj << Specific Indirect Effects( {"Leadership_Avg", "Satisfaction_Avg"} );
rpt = obj << Report();
scrobj = rpt[Outline Box( "Specific Indirect Effects" )] << Get Scriptable Object();
scrobj << Remove Effects( 1 );


```

## [Structural Equation Models Fit](#structural-equation-models-fit)

### [Item Messages](#item-messages_3)

#### [All Modification Indices](#all-modification-indices)

**Syntax:** obj \<< All Modification Indices( state=0|1 )

**Description:** Shows or hides a report that contains the estimates of model modification indices. These values can be used to determine which parameters might be added to the model to improve model fit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Modification Indices( 1 );


```

#### [Assess Measurement Model](#assess-measurement-model)

**Syntax:** obj \<< Assess Measurement Model( state=0|1 )

**Description:** Shows or hides a variety of statistics for quantifying the reliability and validity of tests and measures, including indicator reliability, coefficients omega and H, and a construct validity matrix.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Measurement Models" );
obj << Assess Measurement Model( 1 );


```

#### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< Confidence Intervals( state=0|1 )

**Description:** Shows or hides 95% confidence intervals for all parameter estimates.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Confidence Intervals( 1 );


```

#### [Copy Diagram Properties](#copy-diagram-properties_1)

**Syntax:** obj \<< Copy Diagram Properties

**Description:** Copies the current path diagram properties to the clipboard. You can then paste the properties into another SEM path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt2 = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt2 << Run Script( "SEM: Compare Growth Trajectories" );
obj << Copy Diagram Properties();
obj2 = dt << Structural Equation Models( Model Variables( 2 :: 12 ) );
obj2 << Paste Diagram Properties();


```

#### [Copy Model Specification](#copy-model-specification_1)

**Syntax:** obj \<< Copy Model Specification

**Description:** Copies the current structural equation model specifications to the clipboard. You can then paste the model specifications into another SEM platform report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Path Analysis w/ Latent" );
obj << (Fit[1] << Copy Model Specification());
obj2 = dt << Structural Equation Models( Model Variables( 2 :: 12 ) );
obj2 << Paste Model Specification();


```

#### [Correlation of Estimates](#correlation-of-estimates)

**Syntax:** obj \<< Correlation of Estimates( state=0|1 )

**Description:** Shows or hides a report that contains the correlation matrix of the parameter estimates for the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Correlation of Estimates( 1 );


```

#### [Correlation of Estimates Heat Map](#correlation-of-estimates-heat-map)

**Syntax:** obj \<< Correlation of Estimates Heat Map( state=0|1 )

**Description:** Shows or hides a report that contains a heat map of the correlations among the estimates of the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Correlation of Estimates Heat Map( 1 );


```

#### [Covariance of Estimates](#covariance-of-estimates)

**Syntax:** obj \<< Covariance of Estimates( state=0|1 )

**Description:** Shows or hides a report that contains the covariance matrix of the parameter estimates for the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Covariance of Estimates( 1 );


```

#### [Covariance of Estimates Heat Map](#covariance-of-estimates-heat-map)

**Syntax:** obj \<< Covariance of Estimates Heat Map( state=0|1 )

**Description:** Shows or hides a report that contains a heat map of the covariances among the estimates of the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Covariance of Estimates Heat Map( 1 );


```

#### [Covariances](#covariances)

**Syntax:** obj \<< Covariances

**Description:** Adds covariances between variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Covariances( {:Leadership_Avg, {:Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

#### [Define Time Values](#define-time-values)

**Syntax:** obj \<< Define Time Values

**Description:** Defines the occasions of measurement for the repeated observations. These values are used for specifying longitudinal models.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Multiple Choice Year1, :Multiple Choice Year3, :Multiple Choice Year4 ),
    Fit(
        Model Name( "Linear Growth Model" ),
        Define Time Values( {0, 2, 3} ),
        New Latent( "Intercept", "Slope" ),
        Means( {"Constant", {"Intercept", "Slope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year3,
            :Multiple Choice Year4}, {1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year3, :Multiple Choice Year4
            }, {0, 2, 3}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}, {"b1"}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}, {"b1"}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}, {"b1"}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}}
        ),
        Covariances( {"Intercept", {"Slope"}} ),
        Path Diagram Properties( Show Means( 1 ) ),
        Predicted Values Plot( 1, 1 )
    )
);


```

#### [Equation Details](#equation-details)

**Syntax:** obj \<< Equation Details( state=0|1 )

**Description:** Shows or hides a report that contains details of each equation in the model.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Estimation Method( "MIIV Two-Stage Least Squares" ),
    Fit(
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        )
    )
);
obj << Equation Details( 0 );


```

#### [Fit Indices](#fit-indices)

**Syntax:** obj \<< Fit Indices( state=0|1 )

**Description:** Shows or hides a report that contains fit indices for the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Fit Indices( 1 );


```

#### [Indirect Effects](#indirect-effects)

**Syntax:** obj \<< Indirect Effects( state=0|1 )

**Description:** Shows or hides all available indirect effects in the model.

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Indirect Effects( 1 );


```

#### [Loadings](#loadings)

**Syntax:** obj \<< Loadings

**Description:** Adds loadings to latent variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        )
    )
);


```

#### [Means/Intercepts](#meansintercepts)

**Syntax:** obj \<< Means/Intercepts

**Description:** Adds means or intercepts to the variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Model Specification(
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}}
        )
    )
);


```

#### [Model Implied Correlations](#model-implied-correlations)

**Syntax:** obj \<< Model Implied Correlations( state=0|1 )

**Description:** Shows or hides a report that contains the correlation matrix that is implied by the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Model Implied Correlations( 1 );


```

#### [Model Implied Correlations Heat Map](#model-implied-correlations-heat-map)

**Syntax:** obj \<< Model Implied Correlations Heat Map( state=0|1 )

**Description:** Shows or hides a report that contains a heat map of the correlations implied by the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Model Implied Correlations Heat Map( 1 );


```

#### [Model Implied Covariances](#model-implied-covariances)

**Syntax:** obj \<< Model Implied Covariances( state=0|1 )

**Description:** Shows or hides a report that contains the covariance matrix that is implied by the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Model Implied Covariances( 1 );


```

#### [Model Implied Covariances Heat Map](#model-implied-covariances-heat-map)

**Syntax:** obj \<< Model Implied Covariances Heat Map( state=0|1 )

**Description:** Shows or hides a report that contains a heat map of the covariances implied by the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Model Implied Covariances Heat Map( 1 );


```

#### [Model Implied Means](#model-implied-means)

**Syntax:** obj \<< Model Implied Means( state=0|1 )

**Description:** Shows or hides a report that contains the means for each variable that are implied by the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Model Implied Means( 1 );


```

#### [Model Name](#model-name)

**Syntax:** obj \<< Model Name

**Description:** Sets a model name.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Model Name( "Means and Variances Model" ),
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

#### [Modification Indices](#modification-indices)

**Syntax:** obj \<< Modification Indices( state=0|1 )

**Description:** Shows or hides a report that contains the estimates of model modification indices. These values can be used to determine which parameters might be added to the model to improve model fit.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Modification Indices( 1 );


```

#### [Modification Indices for Covariances](#modification-indices-for-covariances)

**Syntax:** obj \<< Modification Indices for Covariances( state=0|1 )

**Description:** Shows or hides a report that contains the estimates of model modification indices. These values can be used to determine which parameters might be added to the model to improve model fit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Modification Indices for Covariances( 1 );


```

#### [Modification Indices for Loadings](#modification-indices-for-loadings)

**Syntax:** obj \<< Modification Indices for Loadings( state=0|1 )

**Description:** Shows or hides a report that contains the estimates of model modification indices. These values can be used to determine which parameters might be added to the model to improve model fit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Modification Indices for Loadings( 1 );


```

#### [Modification Indices for Means](#modification-indices-for-means)

**Syntax:** obj \<< Modification Indices for Means( state=0|1 )

**Description:** Shows or hides a report that contains the estimates of model modification indices. These values can be used to determine which parameters might be added to the model to improve model fit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Linear Growth Model" ),
        New Latent( "Intercept", "Slope" ),
        Means( {"Constant", {"Intercept", "Slope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}, {"b1"}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}, {"b1"}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}, {"b1"}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}, {"b1"}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}}
        ),
        Covariances( {"Intercept", {"Slope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);
obj << Modification Indices for Means( 1 );


```

#### [Modification Indices for Regressions](#modification-indices-for-regressions)

**Syntax:** obj \<< Modification Indices for Regressions( state=0|1 )

**Description:** Shows or hides a report that contains the estimates of model modification indices. These values can be used to determine which parameters might be added to the model to improve model fit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Modification Indices for Regressions( 1 );


```

#### [Modification Indices for Variances](#modification-indices-for-variances)

**Syntax:** obj \<< Modification Indices for Variances( state=0|1 )

**Description:** Shows or hides a report that contains the estimates of model modification indices. These values can be used to determine which parameters might be added to the model to improve model fit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Linear Growth Model" ),
        New Latent( "Intercept", "Slope" ),
        Means( {"Constant", {"Intercept", "Slope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}, {.25}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}, {.25}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}, {.25}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}, {.25}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}}
        ),
        Covariances( {"Intercept", {"Slope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);
obj << Modification Indices for Variances( 1 );


```

#### [New Latent](#new-latent)

**Syntax:** obj \<< New Latent

**Description:** Adds a new latent variable in the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Model Specification(
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        )
    )
);


```

#### [Normalized Residuals](#normalized-residuals)

**Syntax:** obj \<< Normalized Residuals( state=0|1 )

**Description:** Shows or hides a report that contains a matrix of the normalized residuals for the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Normalized Residuals( 1 );


```

#### [Normalized Residuals Heat Map](#normalized-residuals-heat-map)

**Syntax:** obj \<< Normalized Residuals Heat Map( state=0|1 )

**Description:** Shows or hides a report that contains a heat map of the normalized residuals for the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Normalized Residuals Heat Map( 1 );


```

#### [Parameter Estimates](#parameter-estimates)

**Syntax:** obj \<< Parameter Estimates( state=0|1 )

**Description:** Shows or hides a report that contains the unstandardized parameter estimates for the model. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Parameter Estimates( 0 );


```

#### [Paste Diagram Properties](#paste-diagram-properties_1)

**Syntax:** obj \<< Paste Diagram Properties

**Description:** Pastes the path diagram properties from the clipboard into the current SEM path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
dt2 = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt2 << Run Script( "SEM: Compare Growth Trajectories" );
obj << Copy Diagram Properties();
obj2 = dt << Structural Equation Models( Model Variables( 2 :: 12 ) );
obj2 << Paste Diagram Properties();


```

#### [Path Diagram Properties](#path-diagram-properties_1)

**Syntax:** obj \<< Path Diagram Properties

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables(
        :Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
        :Multiple Choice Year4
    ),
    Fit(
        Model Name( "Linear Growth Model" ),
        New Latent( "Intercept", "Slope" ),
        Means( {"Constant", {"Intercept", "Slope"}} ),
        Loadings(
            {"Intercept", {:Multiple Choice Year1, :Multiple Choice Year2,
            :Multiple Choice Year3, :Multiple Choice Year4}, {1, 1, 1, 1}},
            {"Slope", {:Multiple Choice Year1, :Multiple Choice Year2, :Multiple Choice Year3,
            :Multiple Choice Year4}, {0, 1, 2, 3}}
        ),
        Variances(
            {:Multiple Choice Year1, {:Multiple Choice Year1}, {"b1"}},
            {:Multiple Choice Year2, {:Multiple Choice Year2}, {"b1"}},
            {:Multiple Choice Year3, {:Multiple Choice Year3}, {"b1"}},
            {:Multiple Choice Year4, {:Multiple Choice Year4}, {"b1"}},
            {"Intercept", {"Intercept"}},
            {"Slope", {"Slope"}}
        ),
        Covariances( {"Intercept", {"Slope"}} ),
        Path Diagram Properties( Show Means( 1 ) )
    )
);


```

#### [Predicted Values Plot](#predicted-values-plot)

**Syntax:** obj \<< Predicted Values Plot( state=0|1 )

**Description:** Shows or hides a plot of predicted values for endogenous variables in the model.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Run Script( "SEM: LGC with LDF" );
obj << Predicted Values Plot( 1, 1 );


```

#### [Prediction Profiler](#prediction-profiler)

**Syntax:** obj \<< Prediction Profiler

**Description:** Shows or hides a prediction profiler for the selected outcomes given the selected predictors and the specified model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Run Script( "SEM: Path Analysis w / Latent" );
obj << Prediction Profiler(
    1,
    Confidence Intervals( 1 ),
    Term Value( Leadership( 0, Lock( 0 ), Show( 1 ) ), Conflict( 0, Lock( 0 ), Show( 1 ) ) ),
    Y Terms( Conflict, Satisfaction )
);


```

#### [R Square for Endogenous Variables](#r-square-for-endogenous-variables)

**Syntax:** obj \<< R Square for Endogenous Variables( state=0|1 )

**Description:** Shows or hides a report with RSquare values for all endogenous variables in the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << R Square for Endogenous Variables( 1 );


```

#### [RAM Matrices](#ram-matrices)

**Syntax:** obj \<< RAM Matrices( state=0|1 )

**Description:** Shows or hides a report that contains the model matrices used in reticular action model (RAM) notation.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << RAM Matrices( 1 );


```

#### [Recall in Model Specification](#recall-in-model-specification)

**Syntax:** obj \<< Recall in Model Specification

**Description:** Sets the model in the Model Specification report to the specified model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Recall in Model Specification( 1 );


```

#### [Regressions](#regressions)

**Syntax:** obj \<< Regressions

**Description:** Adds regression paths to the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Regressions( {:Leadership_Avg, {:Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< Remove Fit

**Description:** Removes the specified model report from the report window.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Remove Fit( 1 );


```

#### [Residuals](#residuals)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Shows or hides a report that contains a matrix of the residuals for the model. This matrix is the difference between the model implied covariance matrix and the sample covariance matrix.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Residuals( 1 );


```

#### [Save Bartlett Factor Scores](#save-bartlett-factor-scores)

**Syntax:** obj \<< Save Bartlett Factor Scores

**Description:** Saves a column with the factor score for each variable to columns in the data table. The factor scores are calculated in a hidden column that is also added to the data table. Bartlett's method is used to estimate these scores.

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Save Bartlett Factor Scores();


```

#### [Save Factor Scores](#save-factor-scores)

**Syntax:** obj \<< Save Factor Scores

**Description:** Saves a column with the factor score for each variable to columns in the data table. The factor scores are calculated in a hidden column that is also added to the data table. The regression method is used to estimate these scores.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Save Factor Scores();


```

#### [Save Observational Residuals](#save-observational-residuals)

**Syntax:** obj \<< Save Observational Residuals

**Description:** Saves columns to the data table that contain residual values of the observed outcomes in the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Save Observational Residuals();


```

#### [Save Prediction Formulas](#save-prediction-formulas)

**Syntax:** obj \<< Save Prediction Formulas

**Description:** Saves columns to the data table that contain formulas for predicted values of the observed outcomes in the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Save Prediction Formulas();


```

#### [Show Path Diagram](#show-path-diagram)

**Syntax:** obj \<< Show Path Diagram( state=0|1 )

**Description:** Shows or hides the SEM path diagram. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Show Path Diagram( 0 );


```

#### [Specific Indirect Effects](#specific-indirect-effects)

**Syntax:** obj \<< Specific Indirect Effects

**Description:** Enables you to indicate the specific indirect effects to estimate from the model.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Specific Indirect Effects( {"Ind60", "Dem65"} );


```

#### [Standardized Parameter Estimates](#standardized-parameter-estimates)

**Syntax:** obj \<< Standardized Parameter Estimates( state=0|1 )

**Description:** Shows or hides a report that contains the standardized parameter estimates for the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Standardized Parameter Estimates( 1 );


```

#### [Summary of Fit](#summary-of-fit)

**Syntax:** obj \<< Summary of Fit( state=0|1 )

**Description:** Shows or hides a report that contains details of the model fit. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Summary of Fit( 0 );


```

#### [Total Effects](#total-effects)

**Syntax:** obj \<< Total Effects( state=0|1 )

**Description:** Shows or hides all available total effects in the model.

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Total Effects( 1 );


```

#### [Variances](#variances)

**Syntax:** obj \<< Variances

**Description:** Adds variances to the variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Model Specification(
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}}
        )
    )
);


```

## [Structural Equation Models Path Diagram](#structural-equation-models-path-diagram)

### [Associated Constructors](#associated-constructors_1)

#### [SEM Node Graph Display](#sem-node-graph-display)

**Syntax:** SEM Node Graph Display

### [Item Messages](#item-messages_4)

#### [Constant Border Color](#constant-border-color)

**Syntax:** obj \<< Path Diagram Properties( Constant Border Color ( color ) );

**Description:** Modifies the border color of Constant variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Means( 1 ), Constant Border Color( "Blue" ) );


```

#### [Constant Fill Color](#constant-fill-color)

**Syntax:** obj \<< Path Diagram Properties( Constant Fill Color ( color ) );

**Description:** Modifies the fill color of Constant variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Means( 1 ), Constant Fill Color( "Blue" ) );


```

#### [Constant Font](#constant-font)

**Syntax:** obj \<< Path Diagram Properties( Constant Font ( font ) );

**Description:** Modifies the font of Manifest variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Means( 1 ), Constant Font( "Sitka Small" ) );


```

#### [Constant Height](#constant-height)

**Syntax:** obj \<< Path Diagram Properties( Constant Height ( number ) );

**Description:** Modifies the height (pixels) of Constant variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Means( 1 ), Constant Height( 20 ) );


```

#### [Constant Shape](#constant-shape)

**Syntax:** obj \<< Constant Shape

**Description:** Modifies the default appearance of the Constant in the path diagram, which is used to represent variables' means and intercepts.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties(
    Show Means( 1 ),
    Constant Shape( {Fill Color( "Medium Light BlueCyan" ), Width( 80 ), Height( 40 )} )
);


```

#### [Constant Size Option](#constant-size-option)

**Syntax:** obj \<< Path Diagram Properties( Constant Size Option ( \<Default | Scale To Text | Custom> ) );

**Description:** Changes the size mode for the Constant in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Constant Size Option( "Scale To Text" ) );


```

#### [Constant Text Color](#constant-text-color)

**Syntax:** obj \<< Path Diagram Properties( Constant Text Color ( color ) );

**Description:** Modifies the text color of Constant variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Means( 1 ), Constant Text Color( "Blue" ) );


```

#### [Constant Width](#constant-width)

**Syntax:** obj \<< Path Diagram Properties( Constant Width ( number ) );

**Description:** Modifies the width (pixels) of Constant variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Means( 1 ), Constant Width( 71 ) );


```

#### [Copy Diagram](#copy-diagram)

**Syntax:** obj \<< Copy Diagram

**Description:** Saves a picture of the diagram window to the clipboard.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
rpt = obj << Report();
rpt[Node Graph Box( 1 )] << Copy Diagram;


```

#### [Copy Diagram Properties](#copy-diagram-properties_2)

**Syntax:** obj \<< Copy Diagram Properties

**Description:** Saves a copy of the diagram-specific script settings to the clipboard. These settings can then be applied to other diagrams.

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
rpt = obj << Report();
diagram = rpt[Node Graph Box( 1 )];
diagram << Latent Fill Color( "Blue" );
diagram << Paths Color( "Green" );
diagram << Copy Diagram Properties;
obj = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" ) <<
Run Script( "SEM: Path Analysis w/ Latent" );
rpt = obj << Report();
other_diagram = rpt[Node Graph Box( 1 )];
other_diagram << Paste Diagram Properties;


```

#### [Dashed Lines for Nonsignificant p-values](#dashed-lines-for-nonsignificant-p-values)

**Syntax:** obj \<< Path Diagram Properties ("Dashed Lines for Nonsignificant p - values"n( 0 | 1 ) )

**Description:** Shows or hides dashed lines for paths with non-significant p-values. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( "Dashed Lines for Nonsignificant p - values"n( 0 ) );


```

#### [Diagram Size](#diagram-size)

**Syntax:** obj \<< Path Diagram Properties( Diagram Size ( {x, y} ) )

**Description:** Changes the size of the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties(
    Place Nodes(
        {{"Energy60", 88, 184}, {"Fair60", 374, 94}, {"Fair65", 660, 184}, {"FrOpp60", 301,
        94}, {"FrOpp65", 587, 184}, {"FrPress60", 229, 94}, {"FrPress65", 515, 184},
        {"Labor60", 161, 184}, {"Legis60", 447, 94}, {"Legis65", 732, 184}, {"Prod60", 16,
        184}}
    ),
    Rotate Loops(
        {{"Dem60", 1.571}, {"Dem65", 1.571}, {"Energy60", 4.712}, {"Fair60", 4.712},
        {"Fair65", 4.712}, {"FrOpp60", 4.712}, {"FrOpp65", 4.712}, {"FrPress60", 4.712},
        {"FrPress65", 4.712}, {"Ind60", 1.571}, {"Labor60", 4.712}, {"Legis60", 4.712},
        {"Legis65", 4.712}, {"Prod60", 4.712}}
    )
);


```

#### [Enable Grid](#enable-grid)

**Syntax:** obj \<< Path Diagram Properties ( Enable Grid( 0|1) )

**Description:** Enables a visual grid in the Path Diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Enable Grid( 1 ) );


```

#### [Fill Nodes With R Squared](#fill-nodes-with-r-squared)

**Syntax:** obj \<< Path Diagram Properties ( Fill Nodes With R Squared ( 0|1) )

**Description:** Specifies that nodes in the fitted model be partially filled based on their estimated coefficient of determination. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Fill Nodes With R Squared( 1 ) );


```

#### [Latent Border Color](#latent-border-color)

**Syntax:** obj \<< Path Diagram Properties( Latent Border Color ( color ) );

**Description:** Modifies the border color of Latent variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Latent Border Color( "Blue" ) );


```

#### [Latent Fill Color](#latent-fill-color)

**Syntax:** obj \<< Path Diagram Properties( Latent Fill Color ( color ) );

**Description:** Modifies the fill color of Latent variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Latent Fill Color( "Blue" ) );


```

#### [Latent Font](#latent-font)

**Syntax:** obj \<< Path Diagram Properties( Manifest Font ( font ) );

**Description:** Modifies the font of Latent variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Latent Font( "Sitka Small" ) );


```

#### [Latent Height](#latent-height)

**Syntax:** obj \<< Path Diagram Properties( Latent Height ( number ) );

**Description:** Modifies the height (pixels) of Latent variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Latent Height( 30 ) );


```

#### [Latent Shape](#latent-shape)

**Syntax:** obj \<< Latent Shape

**Description:** Modifies the default appearance of Latent Variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties(
    Latent Shape( {Fill Color( "Medium Light BlueCyan" ), Width( 80 ), Height( 40 )} )
);


```

#### [Latent Size Option](#latent-size-option)

**Syntax:** obj \<< Path Diagram Properties( Latent Size Option ( \<Default | Scale To Text | Custom> ) );

**Description:** Changes the size mode for Latent nodes in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Latent Size Option( "Scale To Text" ) );


```

#### [Latent Text Color](#latent-text-color)

**Syntax:** obj \<< Path Diagram Properties( Latent Text Color ( color ) );

**Description:** Modifies the text color of Latent variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Latent Text Color( "Blue" ) );


```

#### [Latent Width](#latent-width)

**Syntax:** obj \<< Path Diagram Properties( Latent Width ( number ) );

**Description:** Modifies the width (pixels) of Latent variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Latent Width( 71 ) );


```

#### [Layout](#layout)

**Syntax:** obj \<< Path Diagram Properties ( Layout("Left To Right"|"Top To Bottom") )

**Description:** Sets the initial layout of the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Layout( "Top To Bottom" ) );


```

#### [Lock Diagram](#lock-diagram)

**Syntax:** obj \<< Path Diagram Properties ( Lock Diagram( 0|1) )

**Description:** Locks the Path Diagram so that modifications to the model do not cause the layout to change.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Lock Diagram( 1 ) );


```

#### [Manifest Border Color](#manifest-border-color)

**Syntax:** obj \<< Path Diagram Properties( Manifest Border Color ( color ) );

**Description:** Modifies the border color of Manifest variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Border Color( "Blue" ) );


```

#### [Manifest Fill Color](#manifest-fill-color)

**Syntax:** obj \<< Path Diagram Properties( Manifest Fill Color ( color ) );

**Description:** Modifies the fill color of Manifest variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Fill Color( "Blue" ) );


```

#### [Manifest Font](#manifest-font)

**Syntax:** obj \<< Path Diagram Properties( Manifest Font ( font ) );

**Description:** Modifies the font of Manifest variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Font( "Sitka Small" ) );


```

#### [Manifest Height](#manifest-height)

**Syntax:** obj \<< Path Diagram Properties( Manifest Height ( number ) );

**Description:** Modifies the height (pixels) of Manifest variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Height( 30 ) );


```

#### [Manifest Shape](#manifest-shape)

**Syntax:** obj \<< Manifest Shape

**Description:** Modifies the default appearance of Manifest Variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Shape( {Fill Color( "Green" )} ) );


```

#### [Manifest Size Option](#manifest-size-option)

**Syntax:** obj \<< Path Diagram Properties( Manifest Size Option ( \<Default | Scale To Text | Custom> ) );

**Description:** Changes the size mode for Manifest Nodes in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Size Option( "Scale To Text" ) );


```

#### [Manifest Text Color](#manifest-text-color)

**Syntax:** obj \<< Path Diagram Properties( Manifest Text Color ( color ) );

**Description:** Modifies the text color of Manifest variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Text Color( "Blue" ) );


```

#### [Manifest Width](#manifest-width)

**Syntax:** obj \<< Path Diagram Properties( Manifest Width ( number ) );

**Description:** Modifies the width (pixels) of Manifest variables in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Manifest Width( 67 ) );


```

#### [Paste Diagram Properties](#paste-diagram-properties_2)

**Syntax:** obj \<< Paste Diagram Properties

**Description:** Pastes a copy of the diagram-specific script settings from the clipboard.

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
rpt = obj << Report();
diagram = rpt[Node Graph Box( 1 )];
diagram << Latent Fill Color( "Blue" );
diagram << Paths Color( "Green" );
diagram << Copy Diagram Properties;
obj = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" ) <<
Run Script( "SEM: Path Analysis w/ Latent" );
rpt = obj << Report();
other_diagram = rpt[Node Graph Box( 1 )];
other_diagram << Paste Diagram Properties;


```

#### [Path Styles](#path-styles)

**Syntax:** obj \<< Path Styles

**Description:** Modifies the default appearance of paths in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Path Styles( {Color( "Green" )} ) );


```

#### [Path Thickness](#path-thickness)

**Syntax:** obj \<< Path Diagram Properties (Path Thickness( "Fixed"|"Map to Stdz. Estimates" ) )

**Description:** Toggles whether the thickness of paths in the diagram is kept at a fixed value or is tied to the strength of its standardized estimate. "Fixed" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Path Thickness( "Map to Stdz. Estimates" ) );


```

#### [Path Transparency](#path-transparency)

**Syntax:** obj \<< Path Diagram Properties (Path Transparency( "Fixed"|"Map to Stdz. Estimates" ) )

**Description:** Toggles whether the transparency of paths in the diagram is kept at a fixed value or is tied to the strength of its standardized estimate.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Path Transparency( "Fixed" ) );


```

#### [Paths Alpha Level](#paths-alpha-level)

**Syntax:** obj \<< Path Diagram Properties( Paths Alpha Level ( number) );

**Description:** Modifies the minimum p-value threshold for using dashed-lines in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Paths Alpha Level( 0.01 ) );


```

#### [Paths Color](#paths-color)

**Syntax:** obj \<< Path Diagram Properties( Paths Color ( color) );

**Description:** Modifies the color of paths in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Paths Color( "Green" ) );


```

#### [Paths Font](#paths-font)

**Syntax:** obj \<< Path Diagram Properties( Paths Font ( font ) );

**Description:** Modifies the font used for labeling the paths in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Paths Font( "Segoe Script", 12, "Bold" ) );


```

#### [Paths Opacity](#paths-opacity)

**Syntax:** obj \<< Path Diagram Properties( Paths Opacity ( number) );

**Description:** Modifies the opacity of paths in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Paths Opacity( 0.5 ), Path Transparency( "Fixed" ) );


```

#### [Paths Thickness](#paths-thickness)

**Syntax:** obj \<< Path Diagram Properties( Paths Thickness ( number) );

**Description:** Modifies the thickness of paths in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Paths Thickness( 2.7103 ) );


```

#### [Place Nodes](#place-nodes)

**Syntax:** obj \<< Path Diagram Properties( Place Nodes ( { {name1, x1, y1}, {name2, x2, y2}, ...} ) )

**Description:** Controls the placement of individual nodes in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties(
    Place Nodes(
        {{"Energy60", 88, 184}, {"Fair60", 374, 94}, {"Fair65", 660, 184}, {"FrOpp60", 301,
        94}, {"FrOpp65", 587, 184}, {"FrPress60", 229, 94}, {"FrPress65", 515, 184},
        {"Labor60", 161, 184}, {"Legis60", 447, 94}, {"Legis65", 732, 184}, {"Prod60", 16,
        184}}
    ),
    Rotate Loops(
        {{"Dem60", 1.571}, {"Dem65", 1.571}, {"Energy60", 4.712}, {"Fair60", 4.712},
        {"Fair65", 4.712}, {"FrOpp60", 4.712}, {"FrOpp65", 4.712}, {"FrPress60", 4.712},
        {"FrPress65", 4.712}, {"Ind60", 1.571}, {"Labor60", 4.712}, {"Legis60", 4.712},
        {"Legis65", 4.712}, {"Prod60", 4.712}}
    )
);


```

#### [R2 Fill Color](#r2-fill-color)

**Syntax:** obj \<< Path Diagram Properties ( R2 Fill Color ( Color ) )

**Description:** Specifies the color for the partial fill that represents a variable's estimated R-square value.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( R2 Fill Color( Cyan ) );


```

#### [Rotate Latent Groups](#rotate-latent-groups)

**Syntax:** obj \<< Rotate Latent Groups

**Description:** Rotates the orientation of all latent indicators in the diagram. If any latent groups are selected, this option rotates the orientation of only the selected latent groups.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
rpt = obj << Report();
diagram = rpt[Node Graph Box( 1 )];
diagram << Rotate Latent Groups;


```

#### [Rotate Loops](#rotate-loops)

**Syntax:** obj \<< Path Diagram Properties( Rotate Loops ( { {name1, angle1}, {name2, angle2}, ...} ) )

**Description:** Controls the rotation of variance loops within the path diagram. Angles are measured clockwise in radians.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties(
    Place Nodes(
        {{"Energy60", 88, 184}, {"Fair60", 374, 94}, {"Fair65", 660, 184}, {"FrOpp60", 301,
        94}, {"FrOpp65", 587, 184}, {"FrPress60", 229, 94}, {"FrPress65", 515, 184},
        {"Labor60", 161, 184}, {"Legis60", 447, 94}, {"Legis65", 732, 184}, {"Prod60", 16,
        184}}
    ),
    Rotate Loops(
        {{"Dem60", 1.571}, {"Dem65", 1.571}, {"Energy60", 4.712}, {"Fair60", 4.712},
        {"Fair65", 4.712}, {"FrOpp60", 4.712}, {"FrOpp65", 4.712}, {"FrPress60", 4.712},
        {"FrPress65", 4.712}, {"Ind60", 1.571}, {"Labor60", 4.712}, {"Legis60", 4.712},
        {"Legis65", 4.712}, {"Prod60", 4.712}}
    )
);


```

#### [Show Constant Mean Square](#show-constant-mean-square)

**Syntax:** obj \<< Show Constant Mean Square( state=0|1 )

**Description:** Shows or hides the edge associated with the constant in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Constant Mean Square( 1 ) );


```

#### [Show Covariances](#show-covariances)

**Syntax:** obj \<< Show Covariances( state=0|1 )

**Description:** Shows or hides the bidirectional arrows that represent covariances in the path diagram. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Covariances( 0 ) );


```

#### [Show Equality Constraints](#show-equality-constraints)

**Syntax:** obj \<< Show Equality Constraints( state=0|1 )

**Description:** Shows or hides the equality constraints (Fixed Values or Labels) on edges in the path diagram. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Equality Constraints( 0 ) );


```

#### [Show Estimates](#show-estimates)

**Syntax:** obj \<< Show Estimates( "Unstandardized"|"Standardized"|"None" )

**Description:** Shows or hides the unstandardized parameter estimates in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Estimates( "None" ) );


```

#### [Show Loadings](#show-loadings)

**Syntax:** obj \<< Show Loadings( state=0|1 )

**Description:** Shows or hides the latent variable indicators in the path diagram. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Loadings( 0 ) );


```

#### [Show Means/Intercepts](#show-meansintercepts)

**Syntax:** obj \<< Show Means/Intercepts( state=0|1 )

**Description:** Shows or hides the means in the SEM Platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Means( 1 ) );


```

#### [Show R Squared Values](#show-r-squared-values)

**Syntax:** obj \<< Show R Squared Values( state=0|1 )

**Description:** Shows or hides the R-square values inside the nodes in the path diagram.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show R Squared Values( 1 ) );


```

#### [Show Regressions](#show-regressions)

**Syntax:** obj \<< Show Regressions( state=0|1 )

**Description:** Shows or hides regressions in the SEM Platform. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Regressions( 0 ) );


```

#### [Show Variances](#show-variances)

**Syntax:** obj \<< Show Variances( state=0|1 )

**Description:** Shows or hides the bidirectional arrows that represent variances in the path diagram. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Political Democracy.jmp" );
obj = dt << Run Script( "SEM: Bollen (1989)" );
obj << Path Diagram Properties( Show Variances( 0 ) );


```

## [Structural Equation Models Specification](#structural-equation-models-specification)

### [Item Messages](#item-messages_5)

#### [Covariances](#covariances_1)

**Syntax:** obj \<< Covariances

**Description:** Adds covariances between variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Covariances( {:Leadership_Avg, {:Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

#### [Define Time Values](#define-time-values_1)

**Syntax:** obj \<< Define Time Values

**Description:** Defines the occasions of measurement for the repeated observations. These values are used for specifying longitudinal models.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Academic Achievement.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Multiple Choice Year1, :Multiple Choice Year3, :Multiple Choice Year4 ),
    Model Specification(
        Model Name( "Longitudinal Model" ),
        Define Time Values( {0, 2, 3} )
    )
);


```

#### [Loadings](#loadings_1)

**Syntax:** obj \<< Loadings

**Description:** Adds loadings to latent variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Fit(
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        )
    )
);


```

#### [Max Iterations](#max-iterations)

**Syntax:** Structural Equation Models(..., Max Iterations( 3 )

**Description:** Sets the maximum number of iterations for convergence. "1000" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Covariances( {:Leadership_Avg, {:Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} ),
        Max Iterations( 3 )
    )
);


```

#### [Means/Intercepts](#meansintercepts_1)

**Syntax:** obj \<< Means/Intercepts

**Description:** Adds means or intercepts to the variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Model Specification(
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}}
        )
    )
);


```

#### [Model Name](#model-name_1)

**Syntax:** obj \<< Model Name

**Description:** Specifies a name for the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Model Name( "Means and Variances Model" ),
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

#### [Model Notes](#model-notes)

**Syntax:** obj \<< Model Notes

**Description:** Specifies notes for the model.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Model Name( "Means and Variances Model" ),
        Model Notes(
            "This is a simple model with only means and variances for each variable"
        ),
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

#### [New Latent](#new-latent_1)

**Syntax:** obj \<< New Latent

**Description:** Adds a new latent variable in the model.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Model Specification(
        New Latent( "Leader" ),
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Loadings( {"Leader", {:Support_L, :Goal_L, :Work_L, :Interact_L}, {1}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}},
            {"Leader", {"Leader"}}
        )
    )
);


```

#### [Regressions](#regressions_1)

**Syntax:** obj \<< Regressions

**Description:** Adds regression paths to the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Leadership_Avg, :Conflict_Avg ),
    Model Specification(
        Means( {"Constant", {:Leadership_Avg, :Conflict_Avg}} ),
        Regressions( {:Leadership_Avg, {:Conflict_Avg}} ),
        Variances( {:Leadership_Avg, {:Leadership_Avg}}, {:Conflict_Avg, {:Conflict_Avg}} )
    )
);


```

#### [Variances](#variances_1)

**Syntax:** obj \<< Variances

**Description:** Adds variances to the variables in the model.

```

dt = Open( "$SAMPLE_DATA/Job Satisfaction.jmp" );
obj = dt << Structural Equation Models(
    Model Variables( :Support_L, :Goal_L, :Work_L, :Interact_L ),
    Model Specification(
        Means( {"Constant", {:Support_L, :Goal_L, :Work_L, :Interact_L}} ),
        Variances(
            {:Support_L, {:Support_L}},
            {:Goal_L, {:Goal_L}},
            {:Work_L, {:Work_L}},
            {:Interact_L, {:Interact_L}}
        )
    )
);


```

# [Support Vector Machines](#support-vector-machines)

## [Associated Constructors](#associated-constructors)

### [Support Vector Machines](#support-vector-machines_1)

**Syntax:** Support Vector Machines(Y( column ), X( columns ))

**Description:** Predicts a response based on the support vectors in the space of the X variables. One of the goals of the Support Vector Machines algorithm is to use training data to learn how to classify new data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Support Vector Machines(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Factor](#factor)

**Syntax:** obj = Support Vector Machines(...Factor( column(s) )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Freq](#freq)

**Syntax:** obj = Support Vector Machines(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failure3Freq.jmp" );
obj = Support Vector Machines(
    Y( :clean ),
    X(
        :contamination, :corrosion, :doping, :metallization, :miscellaneous, :oxide defect,
        :silicon defect
    ),
    Freq( :SampleSize )
);


```

### [Response](#response)

**Syntax:** obj = Support Vector Machines(...Response( column )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Validation](#validation)

**Syntax:** obj = Support Vector Machines(...\<Validation( column )>...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = Support Vector Machines(
    Y( :Y Binary ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation )
);


```

### [X](#x)

**Syntax:** obj = Support Vector Machines(...X( column(s) )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

### [Y](#y)

**Syntax:** obj = Support Vector Machines(...Y( column )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);


```

## [Item Messages](#item-messages)

### [Cost](#cost)

**Syntax:** obj \<< Cost( number )

**Description:** Sets the cost parameter for the SVM fit.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit(
        Kernel Function( "Radial Basis Function" ),
        Gamma( 0.25 ),
        Cost( 1 ),
        Validation Method( "None" )
    )
);


```

### [Cost Max](#cost-max)

**Syntax:** obj \<< Cost Max( number )

**Description:** Sets the maximum Cost for a tuning design.

**JMP Version Added:** 16

```

Random Reset( 1234 );
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Tuning Design( 1 ),
    Cost Min( .1 ),
    Cost Max( 4 ),
    Gamma Min( 0.01 ),
    Gamma Max( 0.4 ),
    Fit( Kernel Function( "Radial Basis Function" ), Validation Method( "None" ) )
);


```

### [Cost Min](#cost-min)

**Syntax:** obj \<< Cost Min( number )

**Description:** Sets the minimum Cost for a tuning design.

**JMP Version Added:** 16

```

Random Reset( 1234 );
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Tuning Design( 1 ),
    Cost Min( .1 ),
    Cost Max( 4 ),
    Gamma Min( 0.01 ),
    Gamma Max( 0.4 ),
    Fit( Kernel Function( "Radial Basis Function" ), Validation Method( "None" ) )
);


```

### [Fit](#fit)

**Syntax:** obj \<< Fit

**Description:** Specifies and fits the kernel structure for the support vector machine to the data.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);


```

### [Gamma](#gamma)

**Syntax:** obj \<< Gamma( number )

**Description:** Sets the gamma parameter for the Radial Basis kernel.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit(
        Kernel Function( "Radial Basis Function" ),
        Gamma( 0.25 ),
        Cost( 1 ),
        Validation Method( "None" )
    )
);


```

### [Gamma Max](#gamma-max)

**Syntax:** obj \<< Gamma Max( number )

**Description:** Sets the maximum Gamma for a tuning design.

**JMP Version Added:** 16

```

Random Reset( 1234 );
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Tuning Design( 1 ),
    Cost Min( .1 ),
    Cost Max( 4 ),
    Gamma Min( 0.01 ),
    Gamma Max( 0.4 ),
    Fit( Kernel Function( "Radial Basis Function" ), Validation Method( "None" ) )
);


```

### [Gamma Min](#gamma-min)

**Syntax:** obj \<< Gamma Min( number )

**Description:** Sets the minimum Gamma for a tuning design.

**JMP Version Added:** 16

```

Random Reset( 1234 );
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Tuning Design( 1 ),
    Cost Min( .1 ),
    Cost Max( 4 ),
    Gamma Min( 0.01 ),
    Gamma Max( 0.4 ),
    Fit( Kernel Function( "Radial Basis Function" ), Validation Method( "None" ) )
);


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Starts solving the support vector machine.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Go;


```

### [Number of Runs](#number-of-runs)

**Syntax:** obj \<< Number of Runs( number )

**Description:** Sets the number of runs for a tuning design.

**JMP Version Added:** 16

```

Random Reset( 1234 );
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Tuning Design( 1 ),
    Cost Min( .1 ),
    Cost Max( 4 ),
    Gamma Min( 0.01 ),
    Gamma Max( 0.4 ),
    Number of Runs( 15 ),
    Fit( Kernel Function( "Radial Basis Function" ), Validation Method( "None" ) )
);


```

### [Set Random Seed](#set-random-seed)

**Syntax:** Set Random Seed( number )

**Description:** Sets the random seed for the randomization process used for KFold and Holdback validation. This is useful if you want to reproduce an analysis.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit(
        Set Random Seed( 1234 ),
        Kernel Function( "Radial Basis Function" ),
        Gamma( 0.25 ),
        Cost( 1 ),
        Validation Method( "Holdback", 0.3333 )
    )
);


```

### [Tuning Design](#tuning-design)

**Syntax:** obj \<< Tuning Design( state=0|1 )

**JMP Version Added:** 16

```

Random Reset( 1234 );
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Tuning Design( 1 ),
    Fit( Kernel Function( "Radial Basis Function" ), Validation Method( "None" ) )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Support Vector Machines(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [SVM Fit](#svm-fit)

### [Item Messages](#item-messages_1)

#### [Confusion Matrix](#confusion-matrix)

**Syntax:** obj \<< (fit[number] \<< Confusion Matrix( state=0|1 ))

**Description:** Shows or hides a crosstabulation matrix of actual and predicted responses. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Confusion Matrix( 0 ));


```

#### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< (fit[number] \<< Contour Profiler( state=0|1 ))

**Description:** Displays or hides the contour profiler.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (Fit[1] << Contour Profiler( 1 ));


```

#### [Get Measures](#get-measures)

**Syntax:** obj \<< (fit[number] \<< Get Measures)

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (Fit[1] << Response Profile Plot( 0 ));
obj << (Fit[1] << Get Measures);


```

#### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< (fit[number] \<< Get Prediction Formula)

**Description:** Constructs a script to create a prediction formula column and returns it.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Get Prediction Formula);


```

#### [Lift Curve](#lift-curve)

**Syntax:** obj \<< (fit[number] \<< Lift Curve( state=0|1 ))

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model. If you used validation, a plot is shown for each of the training, validation, and test sets.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
Wait( 0 );
obj << (fit[1] << Lift Curve( 1 ));


```

#### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< (fit[number] \<< Plot Actual By Predicted( state=0|1 ))

**Description:** For the specified fit, shows or hides a plot for the training set with actual values on the Y axis and predicted values on the X axis. If you are using validation or test sets, plots are shown for these as well. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Support Vector Machines(
    Y( :Y ),
    X( :Age, :BMI, :Total Cholesterol, :Glucose ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Plot Actual By Predicted( 0 ));


```

#### [Plot Residual by Predicted](#plot-residual-by-predicted)

**Syntax:** obj \<< (fit[number] \<< Plot Residual By Predicted( state=0|1 ))

**Description:** For the specified fit, shows or hides a plot for the training set with residual values on the Y axis and predicted values on the X axis. If you are using validation or test sets, plots are shown for these as well.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Support Vector Machines(
    Y( :Y ),
    X( :Age, :BMI, :Total Cholesterol, :Glucose ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Plot Residual By Predicted( 1 ));


```

#### [Precision Recall Curve](#precision-recall-curve)

**Syntax:** obj \<< (fit[number] \<< Precision Recall Curve( state=0|1 ))

**Description:** Shows or hides the Precision-Recall Curve plot that contains a curve for each level of the response variable. A precision-recall curve plots the precision values against the recall values at a variety of thresholds. If you used validation, a plot is shown for each of the training, validation, and test sets.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
Wait( 0 );
obj << (fit[1] << Precision Recall Curve( 1 ));


```

#### [Profiler](#profiler)

**Syntax:** obj \<< (fit[number] \<< Profiler( state=0|1 ))

**Description:** Shows a Prediction Profiler plot for the specified fit.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Profiler( 1 ));


```

#### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< (fit[number] \<< Publish Prediction Formula)

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Publish Prediction Formula);


```

#### [Publish Probability Formula](#publish-probability-formula)

**Syntax:** obj \<< (fit[number] \<< Publish Probability Formula)

**Description:** Saves the probability of each response level as a separate column in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Support Vector Machines(
    Y( :Y Binary ),
    X( :Age, :BMI, :Total Cholesterol, :Glucose ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Publish Probability Formula);


```

#### [ROC Curve](#roc-curve)

**Syntax:** obj \<< (fit[number] \<< ROC Curve( state=0|1 ))

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity). If you used validation, a plot is shown for each of the training, validation, and test sets.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
Wait( 0 );
obj << (fit[1] << ROC Curve( 1 ));


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< (fit[number] \<< Remove Fit)

**Description:** Removes the entire model report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) ),
    Fit( Kernel Function( "Linear" ), Cost( 1 ), Validation Method( "None" ) )
);
Wait( 2 );
obj << (Fit[1] << Remove Fit);


```

#### [Response Profile Plot](#response-profile-plot)

**Syntax:** obj \<< (fit[number] \<< Response Profile Plot( state=0|1 ))

**Description:** Displays or hides the Response Profile plot. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (Fit[1] << Response Profile Plot( 0 ));


```

#### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< (fit[number] \<< Save Predicteds)

**Description:** Saves the predicted values in a new column in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Save Predicteds);


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< (fit[number] \<< Save Prediction Formula)

**Description:** Creates new columns in the data table that contain the prediction formulas.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Save Prediction Formula);


```

#### [Save Probabilities](#save-probabilities)

**Syntax:** obj \<< (fit[number] \<< Save Probabilities)

**Description:** Saves the probability of each response level as a separate column in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Save Probabilities);


```

#### [Save Probability Formula](#save-probability-formula)

**Syntax:** obj \<< (fit[number] \<< Save Probability Formula)

**Description:** Saves the probability of each response level as a separate column in the data table.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Support Vector Machines(
    Y( :Y Binary ),
    X( :Age, :BMI, :Total Cholesterol, :Glucose ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (fit[1] << Save Probability Formula);


```

#### [Save Validation](#save-validation)

**Syntax:** obj \<< (fit[number] \<< Save Validation)

**Description:** Creates a new column in the data table that identifies which rows were used in the training, validation and test data sets.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit(
        Kernel Function( "Radial Basis Function" ),
        Gamma( 0.25 ),
        Cost( 1 ),
        Validation Method( "Holdback", 0.3333 ), 

    )
);
obj << (Fit[1] << Save Validation);


```

#### [Support Vector Coefficients](#support-vector-coefficients)

**Syntax:** obj \<< (fit[number] \<< Support Vector Coefficients( state=0|1 ))

**Description:** Displays or hides the table of support vector coefficients.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (Fit[1] << Support Vector Coefficients( 1 ));


```

#### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< (fit[number] \<< Surface Profiler( state=0|1 ))

**Description:** Displays or hides the surface profiler.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Support Vector Machines(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit( Kernel Function( "Radial Basis Function" ), Gamma( 0.25 ), Cost( 1 ) )
);
obj << (Fit[1] << Surface Profiler( 1 ));


```

# [Surface Plot](#surface-plot)

## [Associated Constructors](#associated-constructors)

### [Surface Plot](#surface-plot_1)

**Syntax:** Surface Plot( Columns() )

**Description:** Produces a rotating three-dimensional plot of points or a surface defined by a saved formula.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Factors](#factors)

**Syntax:** obj \<< Factors( column(s) )

**Description:** Variables that will be available for the X, Y, and Z coordinates in the 3D graph.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Factors( :silane, :silica, :hardness ) );


```

## [Item Messages](#item-messages)

### [Clip Sheet](#clip-sheet)

**Syntax:** obj \<< Clip Sheet( state=0|1 ); obj \<< Clip Sheet1( state=0|1 )

**Description:** Clips the surface at the ranges of the columns that are used in the first response column formula.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( :Pred Formula ABRASION );
Wait( 1 );
obj << Clip Sheet( 1 );


```

### [Clip Sheet1](#clip-sheet1)

**Syntax:** obj \<< Clip Sheet( state=0|1 ); obj \<< Clip Sheet1( state=0|1 )

**Description:** Clips the surface at the ranges of the columns that are used in the first response column formula.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( :Pred Formula ABRASION );
Wait( 1 );
obj << Clip Sheet( 1 );


```

### [Clip Sheet2](#clip-sheet2)

**Syntax:** obj \<< Clip Sheet2( state=0|1 )

**Description:** Clips the surface at the ranges of the columns that are used in the second response column formula.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( "Pred Formula MODULUS", :Pred Formula MODULUS );
obj << Show Surface2( "Both Sides" );
Wait( 1 );
obj << Clip Sheet2( 1 );


```

### [Clip Sheet3](#clip-sheet3)

**Syntax:** obj \<< Clip Sheet3( state=0|1 )

**Description:** Clips the surface at the ranges of the columns that are used in the third response column formula.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( "Pred Formula ELONG", "Pred Formula ELONG", :Pred Formula ELONG );
obj << Show Surface3( "Both sides" );
Wait( 1 );
obj << Clip Sheet3( 1 );


```

### [Clip Sheet4](#clip-sheet4)

**Syntax:** obj \<< Clip Sheet4( state=0|1 )

**Description:** Clips the surface at the ranges of the columns that are used in the fourth response column formula.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ELONG, :Pred Formula ABRASION, :Pred Formula MODULUS,
        :Pred Formula HARDNESS
    )
);
obj << Response(
    "Pred Formula HARDNESS", "Pred Formula HARDNESS", "Pred Formula HARDNESS",
    :Pred Formula HARDNESS
);
obj << Show Surface4( "Both sides" );
Wait( 1 );
obj << Clip Sheet4( 1 );


```

### [Contour Color](#contour-color)

**Syntax:** obj \<< Contour Color( color ); obj \<< Contour Color1( color )

**Description:** Specifies the color of the contour on the surface for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ), Show Contour( "On Surface" ) );
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Contour Color( {255, 128, 0} );


```

### [Contour Color1](#contour-color1)

**Syntax:** obj \<< Contour Color( color ); obj \<< Contour Color1( color )

**Description:** Specifies the color of the contour on the surface for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ), Show Contour( "On Surface" ) );
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Contour Color( {255, 128, 0} );


```

### [Contour Color2](#contour-color2)

**Syntax:** obj \<< Contour Color2( color )

**Description:** Specifies the color of the contour on the surface for the second response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Show Surface2( "Both Sides" )
);
obj << Show Contour2( "On Surface" );
Wait( 1 );
obj << Contour Color2( {255, 128, 0} );


```

### [Contour Color3](#contour-color3)

**Syntax:** obj \<< Contour Color3( color )

**Description:** Specifies the color of the contour on the surface for the third response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Show Surface3( "Both Sides" )
);
obj << Show Contour3( "On Surface" );
Wait( 1 );
obj << Contour Color3( {255, 0, 0} );


```

### [Contour Color4](#contour-color4)

**Syntax:** obj \<< Contour Color4( color )

**Description:** Specifies the color of the contour on the surface for the fourth response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface4( "Both Sides" ),
    Show Surface1( "Off" )
);
obj << Show Contour4( "On Surface" );
Wait( 1 );
obj << Contour Color4( {100, 0, 200} );


```

### [Control Panel](#control-panel)

**Syntax:** obj \<< Control Panel( state=0|1 )

**Description:** Shows or hides the Control Panel, which includes the controls for appearance, independent variables, and dependent variables. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Control Panel( 0 );


```

### [Data points Color](#data-points-color)

**Syntax:** obj \<< Data Points Color( color ); obj \<< Data Points Color1( color )

**Description:** Changes the color of the data points for the first dependent variable drawn on the surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Response( :Pred Formula ABRASION );
obj << Datapoints Choice( "Mesh" );
obj << Data Points Color( {0, 0, 255} );


```

### [Data points Color1](#data-points-color1)

**Syntax:** obj \<< Data Points Color( color ); obj \<< Data Points Color1( color )

**Description:** Changes the color of the data points for the first dependent variable drawn on the surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Response( :Pred Formula ABRASION );
obj << Datapoints Choice( "Mesh" );
obj << Data Points Color( {0, 0, 255} );


```

### [Data points Color2](#data-points-color2)

**Syntax:** obj \<< Data points Color2( color )

**Description:** Changes the color of the data points for the second dependent variable drawn on the surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Response( "Pred Formula MODULUS", :Pred Formula MODULUS );
obj << Datapoints Choice2( "Mesh" );
obj << Data Points Color2( {0, 0, 255} );


```

### [Data points Color3](#data-points-color3)

**Syntax:** obj \<< Data points Color3( color )

**Description:** Changes the color of the data points for the third dependent variable drawn on the surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG )
);
obj << Response( "Pred Formula ELONG", "Pred Formula ELONG", :Pred Formula ELONG );
obj << Datapoints Choice3( "Needles" );
obj << Data Points Color3( {255, 0, 0} );


```

### [Data points Color4](#data-points-color4)

**Syntax:** obj \<< Data points Color4( color )

**Description:** Changes the color of the data points for the forth dependent variable drawn on the surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Datapoints Choice4( "Surface" );
obj << Data points Color4( 100, 0, 200 );
obj << Response(
    "Pred Formula HARDNESS", "Pred Formula HARDNESS", "Pred Formula HARDNESS",
    :Pred Formula HARDNESS
);
obj << Frame3D( Set Rotation( -79.3688859847019, -1.23001727812475, 27.7096879560307 ) );


```

### [Datapoints Choice](#datapoints-choice)

**Syntax:** obj \<< Datapoints Choice( "Off"|"Points"|"Needles"|"Mesh"|"Surface" ); obj \<< Datapoints Choice1( "Off"|"Points"|"Needles"|"Mesh"|"Surface" )

**Description:** Specifies how points are displayed on the surface for the first response. The default style is the Points option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( :Pred Formula ABRASION );
obj << Datapoints Choice( "Needles" );


```

### [Datapoints Choice1](#datapoints-choice1)

**Syntax:** obj \<< Datapoints Choice( "Off"|"Points"|"Needles"|"Mesh"|"Surface" ); obj \<< Datapoints Choice1( "Off"|"Points"|"Needles"|"Mesh"|"Surface" )

**Description:** Specifies how points are displayed on the surface for the first response. The default style is the Points option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( :Pred Formula ABRASION );
obj << Datapoints Choice( "Needles" );


```

### [Datapoints Choice2](#datapoints-choice2)

**Syntax:** obj \<< Datapoints Choice2( "Off"|"Points"|"Needles"|"Mesh"|"Surface" )

**Description:** Specifies how points are displayed on the surface for the second response. The default style is the Points option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( ":Pred Formula MODULUS", :Pred Formula MODULUS );
Wait( 1 );
obj << Datapoints Choice2( "Off" );


```

### [Datapoints Choice3](#datapoints-choice3)

**Syntax:** obj \<< Datapoints Choice3( "Off"|"Points"|"Needles"|"Mesh"|"Surface" )

**Description:** Specifies how points are displayed on the surface for the third response. The default style is the Points option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Response( "Pred Formula ELONG", "Pred Formula ELONG", :Pred Formula ELONG );
obj << Datapoints Choice3( "Mesh" );


```

### [Datapoints Choice4](#datapoints-choice4)

**Syntax:** obj \<< Datapoints Choice4( "Off"|"Points"|"Needles"|"Mesh"|"Surface" )

**Description:** Specifies how points are displayed on the surface for the fourth response. The default style is the Points option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ELONG, :Pred Formula ABRASION, :Pred Formula MODULUS,
        :Pred Formula HARDNESS
    )
);
obj << Response(
    "Pred Formula HARDNESS", "Pred Formula HARDNESS", "Pred Formula HARDNESS",
    :Pred Formula HARDNESS
);
obj << Datapoints Choice4( "Surface" );


```

### [Dependent Variables Points](#dependent-variables-points)

**Syntax:** obj \<< Dependent Variables Points( state=0|1 )

**Description:** Shows or hides the options for points in the Dependent Variables controls. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Dependent Variables Points( 0 );


```

### [Dependent Variables Response Grid](#dependent-variables-response-grid)

**Syntax:** obj \<< Dependent Variables Response Grid( state=0|1 )

**Description:** Shows or hides the grid options in the Dependent Variables controls. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Dependent Variables Response Grid( 0 );


```

### [Equation](#equation)

**Syntax:** obj \<< Equation( equation1, <equation2>, <equation3>, <equation4> )

**Description:** Assigns equations to the sheets in a specified order in the Dependent Variables section. To skip a response, specify a missing value using a period.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG )
);
obj << Show Surface2( "Both sides" );
obj << Equation( ., ".7*:Silane+5*:Silica" );
obj << Show Formula( 1 );


```

### [Fit to Window](#fit-to-window)

**Syntax:** obj \<< Fit to Window( "Auto"|"On"|"Off" )

**Description:** Sets the auto stretching behavior of the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Fit to Window( "Off" );


```

### [Formula](#formula)

**Syntax:** obj \<< Formula( column, <column>, <column>, <column> )

**Description:** Assigns formulas in columns to the sheets in a specified order in the Dependent Variables section.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Datapoints Choice2( "Surface" )
);
obj << Show Surface2( "Both sides" );
obj << Formula( :Pred Formula ABRASION, :Pred Formula ELONG );


```

### [Frame3D](#frame3d)

**Syntax:** obj \<< Frame3D( Scatterplot 3D options )

**Description:** Changes the display options on the surface. This option uses messages from the Scatterplot 3D platform. See full description under Scatterplot 3D for details.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Show Surface2( "Both sides" )
);
obj << Frame3D(
    Set Graph Size( 692, 671 ),
    Set Rotation( -54, 0, 38 ),
    Background Color( 255, 177, 125 )
);


```

### [Hide Lights Border](#hide-lights-border)

**Syntax:** obj \<< Hide Lights Border( state=0|1 )

**Description:** Shows or hides the lighting controls.

```

obj = Surface Plot();
Wait( 1 );
obj << Hide Lights Border( 1 );


```

### [Iso Value](#iso-value)

**Syntax:** obj \<< Iso Value( id, value )

**Description:** Changes the value of the isosurface slider for a particular dependent variable. The id argument identifies the dependent variable using a zero-based index.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Mode( "Isosurface" );
Wait( 1 );
obj << Iso Value( 0, 100 );
obj << Iso Value( 1, 1500 );


```

### [Lock Z Scale](#lock-z-scale)

**Syntax:** obj \<< Lock Z Scale( state=0|1 )

**Description:** Locks the Z axis to its current values.

```

obj = Surface Plot();
obj << Lock Z Scale( 1 );


```

### [Mesh Color](#mesh-color)

**Syntax:** obj \<< Mesh Color( color ); obj \<< Mesh Color1( color )

**Description:** Specifies the color of the surface mesh for the first dependent variable. This option is available only when a value other than Off is selected for the Mesh option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Show Mesh( "X and Y" );
Wait( 1 );
obj << Mesh Color( {0, 0, 255} );


```

### [Mesh Color1](#mesh-color1)

**Syntax:** obj \<< Mesh Color( color ); obj \<< Mesh Color1( color )

**Description:** Specifies the color of the surface mesh for the first dependent variable. This option is available only when a value other than Off is selected for the Mesh option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Show Mesh( "X and Y" );
Wait( 1 );
obj << Mesh Color( {0, 0, 255} );


```

### [Mesh Color2](#mesh-color2)

**Syntax:** obj \<< Mesh Color2( color )

**Description:** Specifies the color of the surface mesh for the second dependent variable. This option is available only when a value other than Off is selected for the Mesh option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Mode( "Isosurface" );
obj << Show Mesh2( "X and Y" );
Wait( 1 );
obj << Mesh Color2( {255, 0, 0} );


```

### [Mesh Color3](#mesh-color3)

**Syntax:** obj \<< Mesh Color3( color )

**Description:** Specifies the color of the surface mesh for the third dependent variable. This option is available only when a value other than Off is selected for the Mesh option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG )
);
obj << Mode( "Isosurface" );
obj << Show Mesh3( "X and Y" );
Wait( 1 );
obj << Mesh Color3( {50, 0, 100} );


```

### [Mesh Color4](#mesh-color4)

**Syntax:** obj \<< Mesh Color4( color )

**Description:** Specifies the color of the surface mesh for the fourth dependent variable. This option is available only when a value other than Off is selected for the Mesh option.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Mode( "Isosurface" );
obj << Show Mesh4( "X and Y" );
Wait( 1 );
obj << Mesh Color4( {0, 250, 0} );


```

### [Mode](#mode)

**Syntax:** obj \<< Mode( "Sheet, points"|"Isosurface"|"Density grid" )

**Description:** Specifies how surfaces are displayed on the plot. The Sheets, points option shows sheets, points, and lines on the surface. The Isosurface options uses a formula with three independent variables.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Surface 2( "Both Sides" );
obj << Show Surface 4( "Both Sides" );
obj << Mode( "Isosurface" );


```

### [Resolution](#resolution)

**Syntax:** obj \<< Resolution( number ) obj \<< X Resolution( number ) obj \<< Y Resolution( number )

**Description:** Changes the resolution that is used to draw the surface plot.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Mode( "Isosurface" );
Wait( 1 );
obj << Resolution( 4 );
Wait( 1 );
obj << Resolution( 12 );


```

### [Response](#response)

**Syntax:** obj \<< Response( column, <column>, <column>, <column> )

**Description:** Identifies up to four response columns for plotting overlaid points. To skip a response, use any quoted string as a placeholder.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Datapoints Choice3( "Surface" )
);
obj << Response( :Pred Formula ABRASION, "", :Pred Formula ELONG );


```

### [Response Column Color Theme](#response-column-color-theme)

**Syntax:** obj \<< Response Column Color Theme( color theme ); obj \<< Response Column Color Theme1( color theme )

**Description:** Changes the color theme of the surface for the first response. This option is available only for point response columns that use a continuous gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response Column Fill( "Continuous Gradients" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Color Theme( "Jet" );


```

### [Response Column Color Theme1](#response-column-color-theme1)

**Syntax:** obj \<< Response Column Color Theme( color theme ); obj \<< Response Column Color Theme1( color theme )

**Description:** Changes the color theme of the surface for the first response. This option is available only for point response columns that use a continuous gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response Column Fill( "Continuous Gradients" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Color Theme( "Jet" );


```

### [Response Column Color Theme2](#response-column-color-theme2)

**Syntax:** obj \<< Response Column Color Theme2( color theme )

**Description:** Changes the color theme of the surface for the second response. This option is available only for point response columns that use a continuous gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Equation( ., ., ., . ),
    Datapoints Choice2( "Surface" ),
    Response Column Fill2( "Continuous Gradients" ),
    Response( "Pred Formula MODULUS", :Pred Formula MODULUS )
);
Wait( 1 );
obj << Response Column Color Theme2( "White to Black" );


```

### [Response Column Color Theme3](#response-column-color-theme3)

**Syntax:** obj \<< Response Column Color Theme3( color theme )

**Description:** Changes the color theme of the surface for the third response. This option is available only for point response columns that use a continuous gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Equation( ., ., ., . ),
    Datapoints Choice3( "Surface" ),
    Response Column Fill3( "Continuous Gradients" ),
    Response( "Pred Formula ELONG", "Pred Formula ELONG", :Pred Formula ELONG )
);
Wait( 1 );
obj << Response Column Color Theme3( "Blue to Gray to Red" );


```

### [Response Column Color Theme4](#response-column-color-theme4)

**Syntax:** obj \<< Response Column Color Theme4( color theme )

**Description:** Changes the color theme of the surface for the fourth response. This option is available only for point response columns that use a continuous gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Equation( ., ., ., . ),
    Datapoints Choice4( "Surface" ),
    Response Column Fill4( "Continuous Gradients" ),
    Response(
        "Pred Formula HARDNESS", "Pred Formula HARDNESS", "Pred Formula HARDNESS",
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Response Column Color Theme4( "White to Red" );


```

### [Response Column Fill](#response-column-fill)

**Syntax:** obj \<< Response Column Fill( "Solid"|"Continuous Gradients"|"Discrete Gradients" ); obj \<< Response Column Fill1( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies if the first surface is colored using a solid color, continuous gradients, or discrete gradients. This option is available only if the surface is generated using a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Fill( "Discrete Gradients" );


```

### [Response Column Fill1](#response-column-fill1)

**Syntax:** obj \<< Response Column Fill( "Solid"|"Continuous Gradients"|"Discrete Gradients" ); obj \<< Response Column Fill1( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies if the first surface is colored using a solid color, continuous gradients, or discrete gradients. This option is available only if the surface is generated using a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Fill( "Discrete Gradients" );


```

### [Response Column Fill2](#response-column-fill2)

**Syntax:** obj \<< Response Column Fill2( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies if the second surface is colored using a solid color, continuous gradients, or discrete gradients. This option is available only if the surface is generated using a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Equation( ., ., ., . ),
    Datapoints Choice2( "Surface" ),
    Response( "Pred Formula MODULUS", :Pred Formula MODULUS )
);
Wait( 1 );
obj << Response Column Fill2( "Continuous Gradients" );


```

### [Response Column Fill3](#response-column-fill3)

**Syntax:** obj \<< Response Column Fill3( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies if the third surface is colored using a solid color, continuous gradients, or discrete gradients. This option is available only if the surface is generated using a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Equation( ., ., ., . ),
    Datapoints Choice3( "Surface" ),
    Response( "Pred Formula ELONG", "Pred Formula ELONG", :Pred Formula ELONG )
);
Wait( 1 );
obj << Response Column Fill3( "Discrete Gradients" );


```

### [Response Column Fill4](#response-column-fill4)

**Syntax:** obj \<< Response Column Fill4( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies if the fourth surface is colored using a solid color, continuous gradients, or discrete gradients. This option is available only if the surface is generated using a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Equation( ., ., ., . ),
    Datapoints Choice4( "Surface" ),
    Response(
        "Pred Formula HARDNESS", "Pred Formula HARDNESS", "Pred Formula HARDNESS",
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Response Column Fill4( "Continuous Gradients" );


```

### [Response Column Gradient Lines](#response-column-gradient-lines)

**Syntax:** obj \<< Response Column Gradient Lines( state=0|1 ); obj \<< Response Column Gradient Lines1( state=0|1 )

**Description:** Shows or hides lines between the gradient levels on the surface for the first response. This option is available only if the surface is generated using discrete gradients with a dependent point column response. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response Column Fill( "Discrete Gradients" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Gradient Lines( 0 );


```

### [Response Column Gradient Lines1](#response-column-gradient-lines1)

**Syntax:** obj \<< Response Column Gradient Lines( state=0|1 ); obj \<< Response Column Gradient Lines1( state=0|1 )

**Description:** Shows or hides lines between the gradient levels on the surface for the first response. This option is available only if the surface is generated using discrete gradients with a dependent point column response. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response Column Fill( "Discrete Gradients" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Gradient Lines( 0 );


```

### [Response Column Gradient Lines2](#response-column-gradient-lines2)

**Syntax:** obj \<< Response Column Gradient Lines2( state=0|1 )

**Description:** Shows or hides lines between the gradient levels on the surface for the second response. This option is available only if the surface is generated using discrete gradients with a dependent point column response. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Equation( ., ., ., . ),
    Datapoints Choice2( "Surface" ),
    Response Column Fill2( "Discrete Gradients" ),
    Response( "Pred Formula MODULUS", :Pred Formula MODULUS )
);
Wait( 1 );
obj << Response Column Gradient Lines2( 0 );


```

### [Response Column Gradient Lines3](#response-column-gradient-lines3)

**Syntax:** obj \<< Response Column Gradient Lines3( state=0|1 )

**Description:** Shows or hides lines between the gradient levels on the surface for the third response. This option is available only if the surface is generated using discrete gradients with a dependent point column response. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Equation( ., ., ., . ),
    Datapoints Choice3( "Surface" ),
    Response Column Fill3( "Discrete Gradients" ),
    Response( "Pred Formula ELONG", "Pred Formula ELONG", :Pred Formula ELONG )
);
obj << Response Column Gradient Lines3( 0 );
Wait( 1 );
obj << Response Column Gradient Lines3( 1 );


```

### [Response Column Gradient Lines4](#response-column-gradient-lines4)

**Syntax:** obj \<< Response Column Gradient Lines4( state=0|1 )

**Description:** Shows or hides lines between the gradient levels on the surface for the fourth response. This option is available only if the surface is generated using discrete gradients with a dependent point column response. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Equation( ., ., ., . ),
    Datapoints Choice4( "Surface" ),
    Response Column Fill4( "Discrete Gradients" ),
    Response(
        "Pred Formula HARDNESS", "Pred Formula HARDNESS", "Pred Formula HARDNESS",
        :Pred Formula HARDNESS
    ),
    Response Column Gradient Lines4( 0 )
);
Wait( 1 );
obj << Response Column Gradient Lines4( 1 );


```

### [Response Column Gradients](#response-column-gradients)

**Syntax:** obj \<< Response Column Gradients( number ); obj \<< Response Column Gradients1( number )

**Description:** Specifies the number of gradients on the surface for the first response. This option is available only if the surface is generated using discrete gradients with a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response Column Fill( "Discrete Gradients" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Gradients( 9 );


```

### [Response Column Gradients1](#response-column-gradients1)

**Syntax:** obj \<< Response Column Gradients( number ); obj \<< Response Column Gradients1( number )

**Description:** Specifies the number of gradients on the surface for the first response. This option is available only if the surface is generated using discrete gradients with a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Equation( ., ., ., . ),
    Datapoints Choice( "Surface" ),
    Response Column Fill( "Discrete Gradients" ),
    Response( :Pred Formula ABRASION )
);
Wait( 1 );
obj << Response Column Gradients( 9 );


```

### [Response Column Gradients2](#response-column-gradients2)

**Syntax:** obj \<< Response Column Gradients2( number )

**Description:** Specifies the number of gradients on the surface for the second response. This option is available only if the surface is generated using discrete gradients with a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Equation( ., ., ., . ),
    Datapoints Choice2( "Surface" ),
    Response Column Fill2( "Discrete Gradients" ),
    Response( "Pred Formula MODULUS", :Pred Formula MODULUS )
);
Wait( 1 );
obj << Response Column Gradients2( 8 );


```

### [Response Column Gradients3](#response-column-gradients3)

**Syntax:** obj \<< Response Column Gradients3( number )

**Description:** Specifies the number of gradients on the surface for the third response. This option is available only if the surface is generated using discrete gradients with a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Equation( ., ., ., . ),
    Datapoints Choice3( "Surface" ),
    Response Column Fill3( "Discrete Gradients" ),
    Response( "Pred Formula ELONG", "Pred Formula ELONG", :Pred Formula ELONG )
);
Wait( 1 );
obj << Response Column Gradients3( 7 );


```

### [Response Column Gradients4](#response-column-gradients4)

**Syntax:** obj \<< Response Column Gradients4( number )

**Description:** Specifies the number of gradients on the surface for the fourth response. This option is available only if the surface is generated using discrete gradients with a dependent point response column.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Equation( ., ., ., . ),
    Datapoints Choice4( "Surface" ),
    Response Column Fill4( "Discrete Gradients" ),
    Response(
        "Pred Formula HARDNESS", "Pred Formula HARDNESS", "Pred Formula HARDNESS",
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Response Column Gradients4( 10 );


```

### [Scale response axes independently](#scale-response-axes-independently)

**Syntax:** obj = Surface Plot(...Scale response axes indenpendently( state=0|1 )...); obj \<< Scale response axes independently( state=0|1 )

**Description:** Specifies whether there is a separate scale for each response or if the axis scale for all responses matches the scale for the first response entered in the launch window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Scale response axes independently( 1 )
);
obj << Show Surface4( "Both sides" );
Wait( 1 );
obj << Scale response axes independently( 0 );


```

### [Set Z Variable](#set-z-variable)

**Syntax:** obj \<< Set Z Variable( column )

**Description:** Sets the specified column as the Z variable on the surface plot. This option is available only for isosurfaces.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Mode( "Isosurface" )
);
obj << Set Y Variable( :SULFUR );
Wait( 1 );
obj << Set Z Variable( :SILANE );


```

### [SetVariableAxis](#setvariableaxis)

**Syntax:** obj \<< SetVariableAxis( column, \<Current Value( number )>, \<Axis Data( axis options )> )

**Description:** Specifies attributes for the specified independent variable axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << Set Variable Axis( :SULFUR, Current Value( 2.925 ) );
Wait( 1 );
obj << Set Variable Axis( :SILANE, Axis Data( {Format( "Fixed", 8, 1 )} ) );


```

### [SetXVariable](#setxvariable)

**Syntax:** obj \<< SetXVariable( column )

**Description:** Sets the specified column as the X variable on the surface plot.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << Set X Variable( :SULFUR );


```

### [SetYVariable](#setyvariable)

**Syntax:** obj \<< SetYVariable( column )

**Description:** Sets the specified column as the Y variable on the surface plot.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << Set Y Variable( :SULFUR );


```

### [SetZAxis](#setzaxis)

**Syntax:** obj \<< SetZAxis( column, Current Value( number ), \<Axis Data( axis options )> )

**Description:** Specifies attributes for the Z axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << Set Z Axis( :Pred Formula ABRASION, Axis Data( {Format( "Fixed", 8, 1 )} ) );


```

### [Show Contour](#show-contour)

**Syntax:** obj \<< Show Contour( "Off"|"Below"|"Above"|"On Surface" ); obj \<< Show Contour1( "Off"|"Below|Above"|"On Surface" )

**Description:** Specifies the placement of the contour lines on the plot in relation to the surface for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Contour( "On Surface" );


```

### [Show Contour1](#show-contour1)

**Syntax:** obj \<< Show Contour( "Off"|"Below"|"Above"|"On Surface" ); obj \<< Show Contour1( "Off"|"Below|Above"|"On Surface" )

**Description:** Specifies the placement of the contour lines on the plot in relation to the surface for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Contour( "On Surface" );


```

### [Show Contour2](#show-contour2)

**Syntax:** obj \<< Show Contour2( "Off"|"Below"|"Above"|"On Surface" )

**Description:** Specifies the placement of the contour lines on the plot in relation to the surface for the second response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Contour2( "Above" );


```

### [Show Contour3](#show-contour3)

**Syntax:** obj \<< Show Contour3( "Off"|"Below"|"Above"|"On Surface" )

**Description:** Specifies the placement of the contour lines on the plot in relation to the surface for the third response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Surface3( "Both Sides" );
Wait( 1 );
obj << Show Contour3( "Below" );


```

### [Show Contour4](#show-contour4)

**Syntax:** obj \<< Show Contour4( "Off"|"Below"|"Above"|"On Surface" )

**Description:** Specifies the placement of the contour lines on the plot in relation to the surface for the fourth response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Surface4( "Both Sides" );
Wait( 1 );
obj << Show Contour4( "On Surface" );


```

### [Show Mesh](#show-mesh)

**Syntax:** obj \<< Show Mesh( "Off"|"X"|"Y"|"X and Y" ); obj \<< Show Mesh1( "Off"|"X"|"Y"|"X and Y" )

**Description:** Specifies the style of the surface mesh for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Mesh( "X and Y" );


```

### [Show Mesh1](#show-mesh1)

**Syntax:** obj \<< Show Mesh( "Off"|"X"|"Y"|"X and Y" ); obj \<< Show Mesh1( "Off"|"X"|"Y"|"X and Y" )

**Description:** Specifies the style of the surface mesh for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Mesh( "X and Y" );


```

### [Show Mesh2](#show-mesh2)

**Syntax:** obj \<< Show Mesh2( "Off"|"X and Y"|"X"|"Y" )

**Description:** Specifies the style of the surface mesh for the second response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Mesh2( "X" );


```

### [Show Mesh3](#show-mesh3)

**Syntax:** obj \<< Show Mesh3( "Off"|"X and Y"|"X"|"Y" )

**Description:** Specifies the style of the surface mesh for the third response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Mesh3( "Y" );


```

### [Show Mesh4](#show-mesh4)

**Syntax:** obj \<< Show Mesh4( "Off"|"X and Y"|"X"|"Y" )

**Description:** Specifies the style of the surface mesh for the fourth response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Mesh4( "X and Y" );


```

### [Show Surface](#show-surface)

**Syntax:** obj \<< Show Surface( "Off"|"Both sides"|"Above only"|"Below only" ); obj \<< Show Surface1( "Off"|"Both sides"|"Above only"|"Below only" )

**Description:** Specifies how the surface for the first response appears. This option is available only for surfaces that are generated by a formula column response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Surface( "Below Only" );


```

### [Show Surface1](#show-surface1)

**Syntax:** obj \<< Show Surface( "Off"|"Both sides"|"Above only"|"Below only" ); obj \<< Show Surface1( "Off"|"Both sides"|"Above only"|"Below only" )

**Description:** Specifies how the surface for the first response appears. This option is available only for surfaces that are generated by a formula column response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Surface( "Below Only" );


```

### [Show Surface2](#show-surface2)

**Syntax:** obj \<< Show Surface2( "Off"|"Both sides"|"Above only"|"Below only" )

**Description:** Specifies how the surface for the second response appears. This option is available only for surfaces that are generated by a formula column response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Surface2( "Both Sides" );


```

### [Show Surface3](#show-surface3)

**Syntax:** obj \<< Show Surface3( "Off"|"Both sides"|"Above only"|"Below only" )

**Description:** Specifies how the surface for the third response appears. This option is available only for surfaces that are generated by a formula column response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Surface3( "Above Only" );


```

### [Show Surface4](#show-surface4)

**Syntax:** obj \<< Show Surface4( "Off"|"Both sides"|"Above only"|"Below only" )

**Description:** Specifies how the surface for the fourth response appears. This option is available only for surfaces that are generated by a formula column response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ELONG, :Pred Formula ABRASION, :Pred Formula MODULUS,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Show Surface4( "Both Sides" );


```

### [Show formula](#show-formula)

**Syntax:** obj \<< Show formula( state=0|1 )

**Description:** Shows or hides the formula for all dependent variables that currently appear in the surface plot.

```

obj = Surface Plot();
obj << Show Formula( 1 );


```

### [Surface Alpha](#surface-alpha)

**Syntax:** obj \<< Surface Alpha( number ); obj \<< Surface Alpha1( number )

**Description:** Specifies the opacity of the isosurface for the first response variable.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Mode( "Isosurface" );
Wait( 1 );
obj << Surface Alpha( 0.25 );


```

### [Surface Alpha1](#surface-alpha1)

**Syntax:** obj \<< Surface Alpha( number ); obj \<< Surface Alpha1( number )

**Description:** Specifies the opacity of the isosurface for the first response variable.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Mode( "Isosurface" );
Wait( 1 );
obj << Surface Alpha( 0.25 );


```

### [Surface Alpha2](#surface-alpha2)

**Syntax:** obj \<< Surface Alpha2( number )

**Description:** Specifies the opacity of the isosurface for the second response variable.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Mode( "Isosurface" );
obj << Show Surface2( "Both sides" );
Wait( 1 );
obj << Surface Alpha2( 0.3 );


```

### [Surface Alpha3](#surface-alpha3)

**Syntax:** obj \<< Surface Alpha3( number )

**Description:** Specifies the opacity of the isosurface for the third response variable.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Mode( "Isosurface" );
obj << Show Surface3( "Both sides" );
Wait( 1 );
obj << Surface Alpha3( 0.75 );


```

### [Surface Alpha4](#surface-alpha4)

**Syntax:** obj \<< Surface Alpha4( number )

**Description:** Specifies the opacity of the isosurface for the fourth response variable.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Mode( "Isosurface" );
obj << Show Surface4( "Both sides" );
Wait( 1 );
obj << Surface Alpha4( 0.90 );


```

### [Surface Color](#surface-color)

**Syntax:** obj \<< Surface Color( color ); obj \<< Surface Color1( color )

**Description:** Specifies the color of the surface for the first response when the fill type is solid.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ), Show Surface( "Both Sides" ) );
Wait( 1 );
obj << Surface Color( {0, 0, 255} );


```

### [Surface Color Method](#surface-color-method)

**Syntax:** obj \<< Surface Color Method( "Solid"|formula, \<"Solid"|formula>, \<"Solid"|formula>, \<"Solid"|formula> )

**Description:** Specifies the method that is used for coloring each of the four possible surfaces. Note that the formula can differ from the formula that is used to draw the surface.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Show Surface2( "Both sides" )
);
obj << Surface Gradient Type( "Continuous Gradients" );
obj << Surface Color Method( "Solid", ":Pred Formula MODULUS" );
Wait( 1 );
obj << Surface Color Theme2( "Blue to Gray to Red" );


```

### [Surface Color Range](#surface-color-range)

**Syntax:** obj \<< Surface Color Range( "Data"|"Axis" ); obj \<< Surface Color Range1( "Data"|"Axis" )

**Description:** Specifies the endpoints for the color gradient on the surface for the first response. This option is available only when a gradient is used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface( "Both Sides" )
);
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Surface Color Range( "Axis" );


```

### [Surface Color Range1](#surface-color-range1)

**Syntax:** obj \<< Surface Color Range( "Data"|"Axis" ); obj \<< Surface Color Range1( "Data"|"Axis" )

**Description:** Specifies the endpoints for the color gradient on the surface for the first response. This option is available only when a gradient is used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface( "Both Sides" )
);
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Surface Color Range( "Axis" );


```

### [Surface Color Range2](#surface-color-range2)

**Syntax:** obj \<< Surface Color Range2( "Data"|"Axis" )

**Description:** Specifies the endpoints for the color gradient on the surface for the second response. This option is available only when a gradient is used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface2( "Both Sides" )
);
obj << Surface Color Method( "Solid", ":Pred Formula MODULUS" );
Wait( 1 );
obj << Surface Color Range2( "Data" );


```

### [Surface Color Range3](#surface-color-range3)

**Syntax:** obj \<< Surface Color Range3( "Data"|"Axis" )

**Description:** Specifies the endpoints for the color gradient on the surface for the third response. This option is available only when a gradient is used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface3( "Both Sides" )
);
obj << Surface Color Method( "Solid", "Solid", ":Pred Formula ELONG" );
Wait( 1 );
obj << Surface Color Range3( "Axis" );


```

### [Surface Color Range4](#surface-color-range4)

**Syntax:** obj \<< Surface Color Range4( "Data"|"Axis" )

**Description:** Specifies the endpoints for the color gradient on the surface for the fourth response. This option is available only when a gradient is used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface4( "Both Sides" )
);
obj << Surface Color Method( "Solid", "Solid", "Solid", ":Pred Formula HARDNESS" );
Wait( 1 );
obj << Surface Color Range4( "Data" );


```

### [Surface Color Theme](#surface-color-theme)

**Syntax:** obj \<< Surface Color Theme( color theme ); obj \<< Surface Color Theme1( color theme )

**Description:** Specifies the color theme of the surface for the first response. This option is available only for formula response columns that use a gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Surface Gradient Type( "Continuous Gradients" );
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Surface Color Theme( "Blue to Gray to Red" );


```

### [Surface Color Theme1](#surface-color-theme1)

**Syntax:** obj \<< Surface Color Theme( color theme ); obj \<< Surface Color Theme1( color theme )

**Description:** Specifies the color theme of the surface for the first response. This option is available only for formula response columns that use a gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Surface Gradient Type( "Continuous Gradients" );
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Surface Color Theme( "Blue to Gray to Red" );


```

### [Surface Color Theme2](#surface-color-theme2)

**Syntax:** obj \<< Surface Color Theme2( color theme )

**Description:** Specifies the color theme of the surface for the second response. This option is available only for formula response columns that use a gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Show Surface2( "Both sides" )
);
obj << Surface Gradient Type2( "Continuous Gradients" );
obj << Surface Color Method( "Solid", ":Pred Formula MODULUS" );
Wait( 1 );
obj << Surface Color Theme2( "White to Black" );


```

### [Surface Color Theme3](#surface-color-theme3)

**Syntax:** obj \<< Surface Color Theme3( color theme )

**Description:** Specifies the color theme of the surface for the third response. This option is available only for formula response columns that use a gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Show Surface3( "Both Sides" )
);
obj << Surface Gradient Type3( "Continuous Gradients" );
obj << Surface Color Method( "Solid", "Solid", ":Pred Formula ELONG" );
Wait( 1 );
obj << Surface Color Theme3( "Spectral" );


```

### [Surface Color Theme4](#surface-color-theme4)

**Syntax:** obj \<< Surface Color Theme4( color theme )

**Description:** Specifies the color theme of the surface for the fourth response. This option is available only for formula response columns that use a gradient.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface4( "Both Sides" )
);
obj << Surface Gradient Type4( "Continuous Gradients" );
obj << Surface Color Method( "Solid", "Solid", "Solid", ":Pred Formula HARDNESS" );
Wait( 1 );
obj << Surface Color Theme4( "Jet" );


```

### [Surface Color1](#surface-color1)

**Syntax:** obj \<< Surface Color( color ); obj \<< Surface Color1( color )

**Description:** Specifies the color of the surface for the first response when the fill type is solid.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ), Show Surface( "Both Sides" ) );
Wait( 1 );
obj << Surface Color( {0, 0, 255} );


```

### [Surface Color2](#surface-color2)

**Syntax:** obj \<< Surface Color2( color )

**Description:** Specifies the color of the surface for the second response when the fill type is solid.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Show Surface2( "Both Sides" )
);
obj << Surface Color2( {255, 128, 0} );


```

### [Surface Color3](#surface-color3)

**Syntax:** obj \<< Surface Color3( color )

**Description:** Specifies the color of the surface for the third response when the fill type is solid.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Show Surface3( "Both Sides" )
);
obj << Surface Color3( {255, 0, 0} );


```

### [Surface Color4](#surface-color4)

**Syntax:** obj \<< Surface Color4( color )

**Description:** Specifies the color of the surface for the fourth response when the fill type is solid.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface4( "Both Sides" )
);
obj << Surface Color4( {100, 0, 200} );


```

### [Surface Gradient Type](#surface-gradient-type)

**Syntax:** obj \<< Surface Gradient Type( "Solid"|"Continuous Gradients"|"Discrete Gradients" ); obj \<< Surface Gradient Type1( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies the fill type of the surface for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << Surface Gradient Type( "Continuous Gradients" );
obj << Surface Color Method( ":Pred Formula ABRASION" );


```

### [Surface Gradient Type1](#surface-gradient-type1)

**Syntax:** obj \<< Surface Gradient Type( "Solid"|"Continuous Gradients"|"Discrete Gradients" ); obj \<< Surface Gradient Type1( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies the fill type of the surface for the first response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << Surface Gradient Type( "Continuous Gradients" );
obj << Surface Color Method( ":Pred Formula ABRASION" );


```

### [Surface Gradient Type2](#surface-gradient-type2)

**Syntax:** obj \<< Surface Gradient Type2( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies the fill type of the surface for the second response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Show Surface2( "Both sides" )
);
Wait( 1 );
obj << Surface Gradient Type2( "Discrete Gradients" );
obj << Surface Color Method( "Solid", ":Pred Formula MODULUS" );


```

### [Surface Gradient Type3](#surface-gradient-type3)

**Syntax:** obj \<< Surface Gradient Type3( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies the fill type of the surface for the third response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Show Surface3( "Both Sides" )
);
Wait( 1 );
obj << Surface Gradient Type3( "Solid" );
obj << Surface Color Method( "Solid", "Solid", ":Pred Formula ELONG" );


```

### [Surface Gradient Type4](#surface-gradient-type4)

**Syntax:** obj \<< Surface Gradient Type4( "Solid"|"Continuous Gradients"|"Discrete Gradients" )

**Description:** Specifies the fill type of the surface for the fourth response.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface4( "Both Sides" )
);
Wait( 1 );
obj << Surface Gradient Type4( "Discrete Gradients" );
obj << Surface Color Method( "Solid", "Solid", "Solid", ":Pred Formula HARDNESS" );


```

### [Surface Gradients](#surface-gradients)

**Syntax:** obj \<< Surface Gradients( number ); obj \<< Surface Gradients1( number )

**Description:** Specifies the number of gradient lines on the surface of the first response. This option is available only if discrete gradients are used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Surface Color Method( ":Pred Formula ABRASION" )
);
obj << Surface Gradient Type( "Discrete Gradients" );
Wait( 1 );
obj << Surface Gradients( 9 );


```

### [Surface Gradients1](#surface-gradients1)

**Syntax:** obj \<< Surface Gradients( number ); obj \<< Surface Gradients1( number )

**Description:** Specifies the number of gradient lines on the surface of the first response. This option is available only if discrete gradients are used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION ),
    Surface Color Method( ":Pred Formula ABRASION" )
);
obj << Surface Gradient Type( "Discrete Gradients" );
Wait( 1 );
obj << Surface Gradients( 9 );


```

### [Surface Gradients2](#surface-gradients2)

**Syntax:** obj \<< Surface Gradients2( number )

**Description:** Specifies the number of gradient lines on the surface of the second response. This option is available only if discrete gradients are used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ),
    Show Surface2( "Both sides" ),
    Surface Color Method( "Solid", ":Pred Formula MODULUS" )
);
obj << Surface Gradient Type2( "Discrete Gradients" );
Wait( 1 );
obj << Surface Gradients2( 8 );


```

### [Surface Gradients3](#surface-gradients3)

**Syntax:** obj \<< Surface Gradients3( number )

**Description:** Specifies the number of gradient lines on the surface of the third response. This option is available only if discrete gradients are used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns( :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG ),
    Show Surface3( "Both sides" ),
    Surface Color Method( "Solid", "Solid", ":Pred Formula ELONG" )
);
obj << Surface Gradient Type3( "Discrete Gradients" );
Wait( 1 );
obj << Surface Gradients3( 10 );


```

### [Surface Gradients4](#surface-gradients4)

**Syntax:** obj \<< Surface Gradients4( number )

**Description:** Specifies the number of gradient lines on the surface of the fourth response. This option is available only if discrete gradients are used.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface4( "Both sides" ),
    Surface Color Method( "Solid", "Solid", "Solid", ":Pred Formula HARDNESS" )
);
obj << Surface Gradient Type4( "Discrete Gradients" );
Wait( 1 );
obj << Surface Gradients4( 9 );


```

### [Surface Lighting](#surface-lighting)

**Syntax:** obj \<< Surface Lighting( "None"|"Low Reflection"|"Normal" ); obj \<< Surface Lighting1( "None"|"Low Reflection"|"Normal" )

**Description:** Specifies the surface lighting on the surface for the first response. This option is available only with continuous and discrete gradients.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Surface Lighting( "Low Reflection" );


```

### [Surface Lighting1](#surface-lighting1)

**Syntax:** obj \<< Surface Lighting( "None"|"Low Reflection"|"Normal" ); obj \<< Surface Lighting1( "None"|"Low Reflection"|"Normal" )

**Description:** Specifies the surface lighting on the surface for the first response. This option is available only with continuous and discrete gradients.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Surface Color Method( ":Pred Formula ABRASION" );
Wait( 1 );
obj << Surface Lighting( "Low Reflection" );


```

### [Surface Lighting2](#surface-lighting2)

**Syntax:** obj \<< Surface Lighting2( "None"|"Low Reflection"|"Normal" )

**Description:** Specifies the surface lighting on the surface for the second response. This option is available only with continuous and discrete gradients.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION, :Pred Formula MODULUS ) );
obj << Show Surface2( "Both Sides" );
obj << Surface Color Method( "Solid", ":Pred Formula MODULUS" );
Wait( 1 );
obj << Surface Lighting2( "Normal" );


```

### [Surface Lighting3](#surface-lighting3)

**Syntax:** obj \<< Surface Lighting3( "None"|"Low Reflection"|"Normal" )

**Description:** Specifies the surface lighting on the surface for the third response. This option is available only with continuous and discrete gradients.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Surface3( "Both Sides" );
obj << Surface Color Method( "Solid", "Solid", ":Pred Formula ELONG" );
Wait( 1 );
obj << Surface Lighting3( "Low Reflection" );


```

### [Surface Lighting4](#surface-lighting4)

**Syntax:** obj \<< Surface Lighting4( "None"|"Low Reflection"|"Normal" )

**Description:** Specifies the surface lighting on the surface for the fourth response. This option is available only with continuous and discrete gradients.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Show Surface4( "Both Sides" );
obj << Surface Color Method( "Solid", "Solid", "Solid", ":Pred Formula HARDNESS" );
Wait( 1 );
obj << Surface Lighting4( "Normal" );


```

### [Surface Selector](#surface-selector)

**Syntax:** obj \<< Surface Selector( state=0|1 )

**Description:** Shows or hides the surface options in the Dependent Variables controls. On by default.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
Wait( 1 );
obj << Surface Selector( 0 );


```

### [X Grid](#x-grid)

**Syntax:** obj \<< X Grid( state=0|1 )

**Description:** Shows or hides a grid that is perpendicular to the X axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << X Grid( 1 );


```

### [X Resolution](#x-resolution)

**Syntax:** obj \<< Resolution( number ) obj \<< X Resolution( number ) obj \<< Y Resolution( number )

**Description:** Changes the resolution that is used to draw the surface plot.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Mode( "Isosurface" );
Wait( 1 );
obj << Resolution( 4 );
Wait( 1 );
obj << Resolution( 12 );


```

### [XRotate](#xrotate)

**Syntax:** obj \<< XRotate( degrees )

**Description:** Rotates the surface plot on the X axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << XRotate( 30 );


```

### [Y Grid](#y-grid)

**Syntax:** obj \<< Y Grid( state=0|1 )

**Description:** Shows or hides a grid that is perpendicular to the Y axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Y Grid( 1 );


```

### [Y Resolution](#y-resolution)

**Syntax:** obj \<< Resolution( number ) obj \<< X Resolution( number ) obj \<< Y Resolution( number )

**Description:** Changes the resolution that is used to draw the surface plot.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Mode( "Isosurface" );
Wait( 1 );
obj << Resolution( 4 );
Wait( 1 );
obj << Resolution( 12 );


```

### [YRotate](#yrotate)

**Syntax:** obj \<< YRotate( degrees )

**Description:** Rotates the surface plot on the Y axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << YRotate( 20 );


```

### [Z Grid](#z-grid)

**Syntax:** obj \<< Z Grid( state=0|1 )

**Description:** Shows or hides a grid that is perpendicular to the Z axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Z Grid( 1 );


```

### [Z Grid Position](#z-grid-position)

**Syntax:** obj \<< Z Grid Position( fraction )

**Description:** Moves the Z grid to the percent specified.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
obj << Z Grid( 1 );
Wait( 1 );
obj << Z Grid Position( 0.733 );


```

### [ZRotate](#zrotate)

**Syntax:** obj \<< ZRotate( degrees )

**Description:** Rotates the surface plot on the Z axis.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot( Columns( :Pred Formula ABRASION ) );
Wait( 1 );
obj << ZRotate( 45 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = dt << Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Surface Plot(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Surface Frame3D](#surface-frame3d)

### [Associated Constructors](#associated-constructors_1)

#### [Surface Frame3D](#surface-frame3d_1)

**Syntax:** Surface Frame3D( <commands passed to Frame3D> )

**Description:** Sends display commands to the 3D plot.

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);


```

### [Item Messages](#item-messages_1)

#### [Add Ellipsoid](#add-ellipsoid)

**Syntax:** obj \<< Add Ellipsoid( 4x4 matrix ) obj \<< Add Ellipsoid(3x3 cov,3x1 means) obj \<< Add Ellipsoid(3x3 corr,3x1 means,3x1 std dev)

**Description:** Draws an ellipsoid on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D(
    Add Ellipsoid(
        [1 0.42632 0.85183, 0.42632 1 0.34418, 0.85183 0.34418 1],
        [6.55099 2.96919 5.5066],
        [0.57829 0.29087 0.53668]
    )
);


```

#### [Add Markers](#add-markers)

**Syntax:** obj \<< Add Markers( [ nx1 X matrix ], [ nx1 Y matrix ], [ nx1 Z matrix ] )

**Description:** Draws n markers on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Add Markers( [2 3 4], [5 6 7], [1 8 9] ) );


```

#### [Add Vector](#add-vector)

**Syntax:** obj \<< Add Vector( [ 3xn from matrix ], [ 3xn to matrix ], FromCap( CutOff|Sphere|Point|Feather ), ToCap( CutOff|Sphere|Point|Feather ), Facets( Triangle|Square|Round ), Shaft Color( color ), Shaft Thickness( number ), From Thickness( number ), To Thickness( number ), From Color( number ), To Color( number ) ) )

**Description:** Draws a vector or arrow on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Add Vector( [4.5 2 1], [7.5 4 6], FromCap( "Feather" ), ToCap( "Point" ) ) );


```

#### [Get Axes](#get-axes)

**Syntax:** obj \<< Get Axes

**Description:** Returns the state of displaying the axes on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Axes );
Show( s );


```

#### [Get Box](#get-box)

**Syntax:** obj \<< Get Box

**Description:** Returns the state of displaying the box frame on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Box );
Show( s );


```

#### [Get Grab Handles](#get-grab-handles)

**Syntax:** obj \<< Get Grab Handles

**Description:** Returns the state of displaying the grab handles on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Box );
Show( s );


```

#### [Get Graph Size](#get-graph-size)

**Syntax:** obj \<< Get Graph Size

**Description:** Returns the size of the graph.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Graph Size );
Show( s );


```

#### [Get Grids](#get-grids)

**Syntax:** obj \<< Get Grids

**Description:** Returns the state of displaying the grids on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Grids );
Show( s );


```

#### [Get Hide Lights Border](#get-hide-lights-border)

**Syntax:** obj \<< Get Hide Lights Border

**Description:** Returns the state of the lights border around the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
state = obj << Frame3D( Get Hide Lights Border );
Show( state );


```

#### [Get Line Scale](#get-line-scale)

**Syntax:** obj \<< Get Line Scale

**Description:** Returns the line width for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
w = obj << Frame3D( Get Line Scale );
Show( w );


```

#### [Get Marker Quality](#get-marker-quality)

**Syntax:** obj \<< Get Marker Quality

**Description:** Returns the marker characteristics such as shape and shade for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
q = obj << Frame3D( Get Marker Quality );
Show( q );


```

#### [Get Marker Scale](#get-marker-scale)

**Syntax:** obj \<< Get Marker Scale

**Description:** Returns the marker size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Marker Scale );
Show( s );


```

#### [Get Marker Transparency](#get-marker-transparency)

**Syntax:** obj \<< Get Marker Transparency

**Description:** Returns the marker transparency for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
t = obj << Frame3D( Get Marker Transparency );
Show( t );


```

#### [Get Rotation](#get-rotation)

**Syntax:** obj \<< Get Rotation

**Description:** Returns the current rotation for the frame.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
r = obj << Frame3D( Get Rotation() );
Show( r );


```

#### [Get Text Scale](#get-text-scale)

**Syntax:** obj \<< Get Text Scale

**Description:** Returns the text size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Text Scale );
Show( s );


```

#### [Get View Ortho](#get-view-ortho)

**Syntax:** obj \<< Get View Ortho

**Description:** Returns the state of the orthographic view for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
o = obj << Frame3D( Get View Ortho );
Show( o );


```

#### [Get View Perspective](#get-view-perspective)

**Syntax:** obj \<< Get View Perspective

**Description:** Returns the view perspective for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
p = obj << Frame3D( Get View Perspective );
Show( p );


```

#### [Get View Zoom](#get-view-zoom)

**Syntax:** obj \<< Get View Zoom

**Description:** Returns the current zoom for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
z = obj << Frame3D( Get View Zoom );
Show( z );


```

#### [Get Wall Color](#get-wall-color)

**Syntax:** obj \<< Get Wall Color

**Description:** Returns the wall color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
c = obj << Frame3D( Get Wall Color );
Show( c );


```

#### [Get Walls](#get-walls)

**Syntax:** obj \<< Get Walls

**Description:** Returns the state of displaying the walls on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
s = obj << Frame3D( Get Walls );
Show( s );


```

#### [Get X Axis Color](#get-x-axis-color)

**Syntax:** obj \<< Get X Axis Color

**Description:** Returns the x axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
c = obj << Frame3D( Get X Axis Color );
Show( c );


```

#### [Get X Axis Label](#get-x-axis-label)

**Syntax:** obj \<< Get X Axis Label

**Description:** Returns the label for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
label = obj << Frame3D( Get X Axis Label );
Show( label );


```

#### [Get Y Axis Color](#get-y-axis-color)

**Syntax:** obj \<< Get Y Axis Color

**Description:** Returns the y axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
c = obj << Frame3D( Get Y Axis Color );
Show( c );


```

#### [Get Y Axis Label](#get-y-axis-label)

**Syntax:** obj \<< Get Y Axis Label

**Description:** Returns the label for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
label = obj << Frame3D( Get Y Axis Label );
Show( label );


```

#### [Get Z Axis Color](#get-z-axis-color)

**Syntax:** obj \<< Get Z Axis Color

**Description:** Returns the z axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
c = obj << Frame3D( Get Z Axis Color );
Show( c );


```

#### [Get Z Axis Label](#get-z-axis-label)

**Syntax:** obj \<< Get Z Axis Label

**Description:** Returns the label for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
label = obj << Frame3D( Get Z Axis Label );
Show( label );


```

#### [Legend](#legend)

**Syntax:** obj \<< Legend( state=0|1 )

**Description:** Displays or hides the legend on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    ),
    Show Surface2( Both Sides )
);
obj << Frame3D( Legend( 0 ) );
Wait( 2 );
obj << Frame3D( Legend( 1 ) );


```

#### [Set Axes](#set-axes)

**Syntax:** obj \<< Set Axes( state=0|1 )

**Description:** Shows or hides the x, y, and z axes on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Axes( 1 ) );


```

#### [Set Box](#set-box)

**Syntax:** obj \<< Set Box( state=0|1 )

**Description:** Shows or hides the box frame on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Box( 1 ) );


```

#### [Set Graph Size](#set-graph-size)

**Syntax:** obj \<< Set Graph Size( x, y )

**Description:** Sets the size of the graph.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Graph Size( 700, 800 ) );


```

#### [Set Grids](#set-grids)

**Syntax:** obj \<< Set Grids( state=0|1 )

**Description:** Shows or hides the grids on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Grids( 1 ) );


```

#### [Set Hide Lights Border](#set-hide-lights-border)

**Syntax:** obj \<< Set Hide Lights Border( state=0|1 )

**Description:** Hides or displays the lights border around the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Hide Lights Border( 0 ) );


```

#### [Set Line Scale](#set-line-scale)

**Syntax:** obj \<< Set Line Scale( number )

**Description:** Sets the line width for the grid on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Line Scale( 6.5 ) );


```

#### [Set Marker Quality](#set-marker-quality)

**Syntax:** obj \<< Set Marker Quality( number )

**Description:** Sets the marker characteristics such as shape and shade for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Marker Scale( 3 ), Set Marker Quality( 0.2625 ) );


```

#### [Set Marker Scale](#set-marker-scale)

**Syntax:** obj \<< Set Marker Scale( number )

**Description:** Sets the marker size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Marker Scale( 3.5 ) );


```

#### [Set Marker Transparency](#set-marker-transparency)

**Syntax:** obj \<< Set Marker Transparency( fraction )

**Description:** Sets the marker transparency for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Marker Transparency( 0.4125 ) );


```

#### [Set Oscillation](#set-oscillation)

**Syntax:** obj \<< Set Oscillation( X, Y, Z, duration )

**Description:** Sets oscillation rate on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Rotation( -60, -3, 35 ), Set Oscillation( -54, 0, 38, 100 ) );


```

#### [Set Rotation](#set-rotation)

**Syntax:** obj \<< Set Rotation( X, Y, Z )

**Description:** Rotates the frame to the specified coordinates.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Rotation( -60, -3, 35 ) );


```

#### [Set Spin](#set-spin)

**Syntax:** obj \<< Set Spin( dx, dy, sx, sy )

**Description:** Spins the graph on a specified axis. The values dx and dy are a delta motion of the mouse from the point, (sx, sy).

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Spin( .01, .01, 0, 0 ) );


```

#### [Set Text Scale](#set-text-scale)

**Syntax:** obj \<< Set Text Scale( number )

**Description:** Sets the text size for the axis text on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Text Scale( 1.4 ) );


```

#### [Set View Ortho](#set-view-ortho)

**Syntax:** obj \<< Set View Ortho( state=0|1 )

**Description:** Displays the plot orthographically or linearly.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set View Ortho( 1 ) );


```

#### [Set View Perspective](#set-view-perspective)

**Syntax:** obj \<< Set View Perspective( fraction )

**Description:** Sets the view perspective on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set View Perspective( 0.275 ) );


```

#### [Set View Zoom](#set-view-zoom)

**Syntax:** obj \<< Set View Zoom( number )

**Description:** Sets the zoom on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set View Zoom( 0.5 ) );
Wait( 2 );
obj << Frame3D( Set View Zoom( 2 ) );


```

#### [Set Wall Color](#set-wall-color)

**Syntax:** obj \<< Set Wall Color( number )

**Description:** Sets the wall color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Wall Color( -16775543 ) );


```

#### [Set Walls](#set-walls)

**Syntax:** obj \<< Set Walls( state=0|1 )

**Description:** Shows or hides the walls on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Walls( 1 ) );


```

#### [Set X Axis Color](#set-x-axis-color)

**Syntax:** obj \<< Set X Axis Color( color )

**Description:** Sets the x axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set X Axis Color( 5 ) );


```

#### [Set X Axis Label](#set-x-axis-label)

**Syntax:** obj \<< Set X Axis Label( string )

**Description:** Sets the label for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set X Axis Label( "Iris Sepal Length" ) );


```

#### [Set Y Axis Color](#set-y-axis-color)

**Syntax:** obj \<< Set Y Axis Color( color )

**Description:** Sets the y axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Y Axis Color( 11 ) );


```

#### [Set Y Axis Label](#set-y-axis-label)

**Syntax:** obj \<< Set Y Axis Label( string )

**Description:** Sets the label for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Y Axis Label( "Iris Petal Length" ) );


```

#### [Set Z Axis Color](#set-z-axis-color)

**Syntax:** obj \<< Set Z Axis Color( color )

**Description:** Sets the z axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Z Axis Color( "Green" ) );


```

#### [Set Z Axis Label](#set-z-axis-label)

**Syntax:** obj \<< Set Z Axis Label( string )

**Description:** Sets the label for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Z Axis Label( "Iris Sepal Width" ) );


```

#### [XAxis](#xaxis)

**Syntax:** obj \<< XAxis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( XAxis( Min( 3 ), Max( 10 ) ) );


```

#### [YAxis](#yaxis)

**Syntax:** obj \<< YAxis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( YAxis( Min( 1 ), Max( 10 ), Inc( 0.5 ) ) );


```

#### [Z Axis](#z-axis)

**Syntax:** obj \<< Z Axis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( ZAxis( Min( 1 ), Max( 5 ), Inc( 0.25 ) ) );


```

#### [get light active](#get-light-active)

**Syntax:** obj \<< get light active( light number )

**Description:** Returns the specified light activation shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
p = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Active( 2 ) );
Show( p );


```

#### [get light color](#get-light-color)

**Syntax:** obj \<< get light color( light number )

**Description:** Returns the specified light color shining on the plot as a list {red, green, blue}.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
c = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Color( 1 ) );
Show( c );


```

#### [get light position](#get-light-position)

**Syntax:** obj \<< get light position( light number )

**Description:** Returns the specified light position shining on the plot as a list {x, y, z}.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
p = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Position( 2 ) );
Show( p );


```

#### [set light active](#set-light-active)

**Syntax:** obj \<< set light active( light number, state=0|1 )

**Description:** Turns on the specified light shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Active( 4, 1 ) );


```

#### [set light color](#set-light-color)

**Syntax:** obj \<< set light color( light number, red value, green value, blue value )

**Description:** Sets the color of the light shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Color( 2, 240, 50, 70 ) );


```

#### [set light position](#set-light-position)

**Syntax:** obj \<< set light position( light number, X, Y, Z )

**Description:** Sets the light position shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Tiretread.jmp" );
obj = Surface Plot(
    Columns(
        :Pred Formula ABRASION, :Pred Formula MODULUS, :Pred Formula ELONG,
        :Pred Formula HARDNESS
    )
);
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Position( 2, -1.5833, 10, 0 ) );


```

# [Survival](#survival)

## [Associated Constructors](#associated-constructors)

### [Survival](#survival_1)

**Syntax:** Survival( Y( columns ), Censor( column ), \<Grouping( column )> )

**Description:** Calculates estimates of survival functions using the product-limit (Kaplan-Meier) method for one or more groups.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ), Freq( :_freqcol ) );


```

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column )

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );


```

### [Time to Event](#time-to-event)

**Syntax:** obj \<< Time to Event( column(s) )

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );


```

## [Item Messages](#item-messages)

### [Censor Code](#censor-code)

**Syntax:** obj = Survival(...Censor Code( value=1 )...)

**Description:** Identifies the value in the Censor column that designates right-censored observations. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
obj = dt << Survival( Y( :Time ), Censor( :Censor ), Censor Code( 0 ) );


```

### [Competing Causes](#competing-causes)

**Syntax:** obj \<< Competing Causes( column )

**Description:** Performs an estimation of the Weibull model using the specified causes to indicate a failure event and other causes to indicate censored observations. The fitted distribution appears as a dashed line in the Survival Plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Competing Causes( :Failure Cause );


```

### [Connect Quantile Points](#connect-quantile-points)

**Syntax:** obj \<< Connect Quantile Points( state=0|1 )

**Description:** Shows or hides the lines in the Exponential Plot, the Weibull Plot, and the LogNormal Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Plot( 1 );
Wait( 1 );
obj << Connect Quantile Points( 0 );


```

### [Estimate Survival Probability](#estimate-survival-probability)

**Syntax:** obj \<< Estimate Survival Probability( [time1, time2, ...], Alpha( level ) )

**Description:** Estimates survival probabilities and confidence intervals for the specified time values using the fitted distributions.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Fit( 1 );
obj << Estimate Survival Probability( [100, 200, 300], Alpha( 0.001 ) );


```

### [Estimate Time Quantile](#estimate-time-quantile)

**Syntax:** obj \<< Estimate Time Quantile( [p1, p2, ...], Alpha( level ) )

**Description:** Estimates a time quantile and confidence intervals for each specified survival probability using the fitted distributions.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Fit( 1 );
obj << Estimate Time Quantile( [0.5, 0.9, 0.95], Alpha( 0.01 ) );


```

### [Exponential Fit](#exponential-fit)

**Syntax:** obj \<< Exponential Fit( state=0|1 )

**Description:** Shows or hides the Exponential Parameter Estimates table. This option also adds a linear fit to the exponential cumulative distribution function in the Exponential Plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Exponential Plot( 1 );
Wait( 1 );
obj << Exponential Fit( 1 );


```

### [Exponential Plot](#exponential-plot)

**Syntax:** obj \<< Exponential Plot( state=0|1 )

**Description:** Shows or hides the Exponential Plot, which shows the cumulative exponential failure probability by time for each group. Lines that are approximately linear empirically indicate the appropriateness of using an exponential model for further analysis.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Exponential Plot( 1 );


```

### [Failure Plot](#failure-plot)

**Syntax:** obj \<< Failure Plot( state=0|1 )

**Description:** Shows or hides the failure plot, which contains overlaid failure curves (proportion failing over time) for each group. A failure plot reverses the vertical axis to show the number of failures rather than the number of survivors. This is useful in reliability analysis.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Failure Plot( 1 );


```

### [Fitted Distribution Plots](#fitted-distribution-plots)

**Syntax:** obj \<< Fitted Distribution Plots( state=0|1 )

**Description:** Shows or hides a set of plots for each fitted distribution. The set of plots includes the fitted survival function, the fitted density function, and the fitted hazard function. If you have not performed a fit, no plot appears.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Fit( 1 );
obj << Fitted Distribution Plots( 1 );


```

### [Fitted Failure CI](#fitted-failure-ci)

**Syntax:** obj \<< Fitted Failure CI( state=0|1 )

**Description:** Shows or hides confidence intervals for each group in the Failure Plot. A set of intervals is plotted for each of the fitted distributions.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ), Failure Plot( 1 ) );
obj << Weibull Fit( 1 );
obj << Fitted Failure CI( 1 );


```

### [Fitted Quantile](#fitted-quantile)

**Syntax:** obj \<< Fitted Quantile( state=0|1 )

**Description:** Shows or hides straight-line fits for each group in the Exponential Plot, the Weibull Plot, and the LogNormal Plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Exponential Plot( 1 );
obj << Exponential Fit( 1 );
Wait( 1 );
obj << Fitted Quantile( 0 );


```

### [Fitted Quantile CI Lines](#fitted-quantile-ci-lines)

**Syntax:** obj \<< Fitted Quantile CI Lines( state=0|1 )

**Description:** Shows or hides the 95% confidence bands for each group in the Exponential Plot, the Weibull Plot, and the LogNormal Plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Lognormal Plot( 1 );
obj << Lognormal Fit( 1 );
obj << Fitted Quantile CI Lines( 1 );


```

### [Fitted Quantile CI Shaded](#fitted-quantile-ci-shaded)

**Syntax:** obj \<< Fitted Quantile CI Shaded( state=0|1 )

**Description:** Shows or hides shaded regions for the 95% confidence bands for each group in the Exponential Plot, the Weibull Plot, and the LogNormal Plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Plot( 1 );
obj << Weibull Fit( 1 );
obj << Fitted Quantile CI Shaded( 1 );


```

### [Fitted Survival CI](#fitted-survival-ci)

**Syntax:** obj \<< Fitted Survival CI( state=0|1 )

**Description:** Shows or hides confidence intervals for each group in the Survival Plot. A set of intervals is plotted for each of the fitted distributions.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Exponential Fit( 1 );
obj << Fitted Survival CI( 1 );


```

### [LogNormal Fit](#lognormal-fit)

**Syntax:** obj \<< LogNormal Fit( state=0|1 )

**Description:** Shows or hides the LogNormal Parameter Estimates table. This option also adds a linear fit to the lognormal cumulative distribution function in the LogNormal Plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << LogNormal Plot( 1 );
Wait( 1 );
obj << LogNormal Fit( 1 );


```

### [LogNormal Plot](#lognormal-plot)

**Syntax:** obj \<< LogNormal Plot( state=0|1 )

**Description:** Shows or hides the LogNormal Plot, which shows the cumulative lognormal failure probability by log(time) for each group. Lines that are approximately linear empirically indicate the appropriateness of using a lognormal model for further analysis.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << LogNormal Plot( 1 );


```

### [Midstep Quantile Points](#midstep-quantile-points)

**Syntax:** obj \<< Midstep Quantile Points( state=0|1 )

**Description:** Specifies that the modified Kaplan-Meier plotting positions are used in the Exponential Plot, the Weibull Plot, and the LogNormal Plot. These plotting positions are equivalent to taking mid-step positions of the Kaplan-Meier curve, rather than the bottom-of-step positions. On by default.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Plot( 1 );
Wait( 1 );
obj << Midstep Quantile Points( 0 );


```

### [Plot Failure Instead of Survival](#plot-failure-instead-of-survival)

**Syntax:** obj = Survival(...Plot Failure instead of Surivival( state=0|1 )...)

**Description:** Shows a failure probability plot instead of its reverse (a survival probability plot).

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    Plot Failure instead of Survival( 1 )
);


```

### [Save Estimates](#save-estimates)

**Syntax:** obj \<< Save Estimates

**Description:** Creates a new data table that contains survival and failure estimates, confidence intervals, and other distribution statistics for each group.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Save Estimates;


```

### [Show Combined](#show-combined)

**Syntax:** obj \<< Show Combined( state=0|1 )

**Description:** Shows or hides the combined Kaplan-Meier survival functions on both the survival and failure plots.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Failure Plot( 1 );
Wait( 1 );
obj << Show Combined( 1 );


```

### [Show Confid Interval](#show-confid-interval)

**Syntax:** obj \<< Show Confid Interval( state=0|1 )

**Description:** Shows or hides the 95% pointwise confidence bands for the Kaplan-Meier survival functions in the Survival Plot and the Failure Plot. This option also shows confidence bands for the combined survival functions when the Show Combined option is selected.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Failure Plot( 1 );
Wait( 1 );
obj << Show Confid Interval( 1 );
Wait( 1 );
obj << Show Combined( 1 );


```

### [Show Kaplan Meier](#show-kaplan-meier)

**Syntax:** obj \<< Show Kaplan Meier( state=0|1 )

**Description:** Shows or hides the Kaplan-Meier survival functions for each group on both the survival and failure plots. On by default.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    Show Kaplan Meier( 0 )
);
Wait( 1 );
obj << Show Kaplan Meier( 1 );


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the points in the Survival Plot and the Failure Plot. Failures appear at the bottom of the steps, and censored observations are indicated by points above the steps.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Failure Plot( 1 );
Wait( 1 );
obj << Show Points( 1 );


```

### [Show Shaded Pointwise CI](#show-shaded-pointwise-ci)

**Syntax:** obj \<< Show Shaded Pointwise CI( state=0|1 )

**Description:** Shows or hides shaded regions for the 95% pointwise confidence bands for the Kaplan-Meier survival functions in the Survival Plot and the Failure Plot. This option also shows shaded confidence regions for the combined survival functions when the Show Combined option is selected.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Show Shaded Pointwise CI( 1 );


```

### [Show Shaded Simultaneous CI](#show-shaded-simultaneous-ci)

**Syntax:** obj \<< Show Shaded Simultaneous CI( state=0|1 )

**Description:** Shows or hides shaded regions for the 95% simultaneous confidence bands for the Kaplan-Meier survival functions in the Survival Plot and the Failure Plot. This option also shows confidence bands for the combined survival functions when the Show Combined option is selected.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Show Shaded Simultaneous CI( 1 );


```

### [Show Simultaneous CI](#show-simultaneous-ci)

**Syntax:** obj \<< Show Simultaneous CI( state=0|1 )

**Description:** Shows or hides the 95% simultaneous confidence bands for the Kaplan-Meier survival functions in the Survival Plot and the Failure Plot. This option also shows confidence bands for the combined survival functions when the Show Combined option is selected.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Show Simultaneous CI( 1 );


```

### [Survival Plot](#survival-plot)

**Syntax:** obj \<< Survival Plot( state=0|1 )

**Description:** Shows or hides the survival plot, which contains overlaid survival curves for each group. On by default.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Survival Plot( 0 );
Wait( 1 );
obj << Survival Plot( 1 );


```

### [Weibull Fit](#weibull-fit)

**Syntax:** obj \<< Weibull Fit( state=0|1 )

**Description:** Shows or hides the Extreme-Value Parameter Estimates and Weibull Parameter Estimates tables. This option also adds a linear fit to the Weibull cumulative distribution function in the Weibull Plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Plot( 1 );
Wait( 1 );
obj << Weibull Fit( 1 );


```

### [Weibull Plot](#weibull-plot)

**Syntax:** obj \<< Weibull Plot( state=0|1 )

**Description:** Shows or hides the Weibull Plot, which shows the cumulative Weibull failure probability by log(time) for each group. Lines that are approximately linear empirically indicate the appropriateness of using a Weibull model for further analysis.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Weibull Plot( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Survival(
    Y( :days ),
    Censor( :Censor ),
    Grouping( :Group ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = dt << Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Survival(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Competing Causes](#competing-causes_1)

### [Item Messages](#item-messages_1)

#### [Hazard Plot](#hazard-plot)

**Syntax:** obj \<< Hazard Plot( state=0|1 )

**Description:** Shows or hides a plot of the hazard functions for the data based on the competing causes analysis.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Competing Causes( :Failure Cause );
obj << Hazard Plot( 1 );


```

#### [Omit Causes](#omit-causes)

**Syntax:** obj \<< Omit Causes( cause1, <cause2>, ... )

**Description:** Enables you to remove specific cause values from the analysis. The survival estimates are automatically recalculated. This option can be used to illustrate the alternative where specific causes are no longer hazardous.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Competing Causes( :Failure Cause );
obj << Omit Causes( "accident" );


```

#### [Save Cause Coordinates](#save-cause-coordinates)

**Syntax:** obj \<< Save Cause Coordinates

**Description:** Saves a new column to the original data table. The new column is calculated as log(-log(Surv)). This value is often plotted against the time variable for the different values of a grouping variable, such as the code for type of failure.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Competing Causes( :Failure Cause );
obj << Save Cause Coordinates;


```

#### [Simulate](#simulate)

**Syntax:** obj \<< Simulate( number )

**Description:** Creates a new data table that contains simulated time and cause information. The fitted Weibull distribution is used to simulate the new data.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Competing Causes( :Failure Cause );
obj << Simulate( 1000 );


```

#### [Weibull Lines](#weibull-lines)

**Syntax:** obj \<< Weibull Lines( state=0|1 )

**Description:** Shows or hides Weibull lines in the survival plot.

```

dt = Open( "$SAMPLE_DATA/Rats.jmp" );
obj = Survival( Y( :days ), Censor( :Censor ), Grouping( :Group ) );
obj << Competing Causes( :Failure Cause );
obj << Weibull Lines( 1 );


```

# [Tabulate](#tabulate)

## [Associated Constructors](#associated-constructors)

### [Tabulate](#tabulate_1)

**Syntax:** Tabulate( Add Table( Column Table( Analysis Columns( column(s) )|Grouping Columns( column(s))|Statistics( )), Row Table( Analysis Columns( column(s) )|Grouping Columns( column(s))|Statistics( )) )

**Description:** Creates a custom table of summary statistics of one or more variables. The variables can be grouped by one or more classification columns. Enables you to build the summary table using drag and drop operations.

#### [Categories and stats](#categories-and-stats)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :gender, :goals ), Statistics( N, Column % ) ),
        Row Table( Grouping Columns( :Grade, :Age ) )
    )
);


```

#### [Columns by Categories](#columns-by-categories)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Columns by Categories( :Grades, :Sports, :Looks, :Money ) ) )
);


```

#### [Frequency](#frequency)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Freq( :Count ),
    Add Table( Row Table( Grouping Columns( :Causes ) ) )
);


```

#### [ID column](#id-column)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    ID( :Division ),
    Set Format( Uniform Format( 10, 2 ) ),
    Add Table(
        Column Table(
            Statistics( Sum ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name ) )
    )
);


```

#### [Multiple response grouping columns](#multiple-response-grouping-columns)

```

dt = Open( "$Sample_Data/Consumer Preferences.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :Floss Delimited ), Statistics( N, "% of Total"n ) ),
        Row Table( Grouping Columns( :Frequency of Teeth Cleaning, :Brush Delimited ) )
    )
);


```

#### [Multiple response page column](#multiple-response-page-column)

```

dt = Open( "$Sample_Data/Big Class Families.jmp" );
obj = Tabulate(
    Show Control Panel( 0 ),
    Page Column( :family cars( "Jeep" ) ),
    Add Table(
        Column Table( Analysis Columns( :height ), Statistics( N, "% of Total"n ) ),
        Row Table( Grouping Columns( :sex ) )
    )
);


```

#### [Multiple row and column tables](#multiple-row-and-column-tables)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :gender ) ),
        Column Table( Grouping Columns( :race ) ),
        Row Table( Grouping Columns( :goals ) ),
        Row Table( Grouping Columns( :"Urban/Rural"n ) )
    )
);


```

#### [Multiple row tables](#multiple-row-tables)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Row Table( Grouping Columns( :Grades ) ),
        Row Table( Grouping Columns( :Sports ) ),
        Row Table( Grouping Columns( :Looks ) ),
        Row Table( Grouping Columns( :Money ) )
    )
);


```

#### [Nested categories](#nested-categories)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);


```

#### [Packed columns](#packed-columns)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Statistics( Sum, Max ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name, :Engine ) )
    )
);


```

#### [Page column](#page-column)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Page Column( :Engine( "Gas" ) ),
    Add Table(
        Column Table( Analysis Columns( :City MPG, :Hwy MPG ), Statistics( Max ) ),
        Row Table( Grouping Columns( :Mfr Name ) )
    )
);


```

#### [Stacked grouping columns](#stacked-grouping-columns)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :marital status ),
            Add Aggregate Statistics( :marital status ),
            Analysis Columns( :age ),
            Statistics( Min, Max )
        ),
        Row Table(
            Grouping Columns( :sex, :country, :size ),
            Add Aggregate Statistics( :sex, :country, :size ),
            Stack Grouping Columns( 1 )
        )
    )
);


```

#### [Weight](#weight)

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Weight( :Weight ),
    Add Table(
        Column Table( Analysis Columns( :Horsepower ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Type ) )
    )
);


```

## [Columns](#columns)

### [Analysis Columns](#analysis-columns)

**Syntax:** Analysis Columns( Column(s) )

**Description:** Adds analysis columns to the current table. It can be used with the Add Table command or Modify Table command.

#### [Add to existing](#add-to-existing)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);
obj << Modify Table( Column Table( 1 ), Analysis Columns( :CO ) );


```

#### [Add to new](#add-to-new)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);


```

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :type )
);


```

### [Columns by Categories](#columns-by-categories_1)

**Syntax:** Columns by Categories( column1, column2, ...) )

**Description:** Adds a cross-tabulation of the column names and the categories gathered for columns with similar values to the table. When scripting, the Columns by Categories message must be within either a Column Table message or a Row Table message.

#### [Add to existing](#add-to-existing_1)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Columns by Categories( :Grades, :Sports, :Looks ) ) )
);
obj << Modify Table( Row Table( 1 ), Columns by Categories( :Money ) );


```

#### [Add to new](#add-to-new_1)

```

dt = Open( "$SAMPLE_DATA/Children's Popularity.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Columns by Categories( :Grades, :Sports, :Looks, :Money ) ) )
);


```

### [Freq](#freq)

**Syntax:** Freq( Column )

**Description:** Specify the frequency column to be used in computing for statistics

#### [Set in existing](#set-in-existing)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Grouping Columns( :Causes ) ) )
);
Wait( 1 );
obj << Freq( :Count );


```

#### [Set in new](#set-in-new)

```

dt = Open( "$SAMPLE_DATA/Quality Control/Failures.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Freq( :Count ),
    Add Table( Row Table( Grouping Columns( :Causes ) ) )
);


```

### [Grouping Columns](#grouping-columns)

**Syntax:** Grouping Columns( Column(s) )

**Description:** Adds grouping columns to the current table. It can be used with the Add Table command or Modify Table command.

#### [Add nested to existing](#add-nested-to-existing)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate( Show Control Panel( 0 ) );
obj << Add Table( Column Table( Grouping Columns( :sex ) ) );
obj << Modify Table( Column Table( 1 ), Grouping Column( :age ) );


```

#### [Add nested to new](#add-nested-to-new)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);


```

#### [Add to existing](#add-to-existing_2)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate( Show Control Panel( 0 ) );
obj << Add Table( Column Table( Grouping Columns( :sex ) ) );
obj << Modify Table( Row Table( 1 ), Grouping Column( :age ) );


```

#### [Add to new](#add-to-new_2)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Column Table( Grouping Columns( :sex ) ) )
);


```

### [ID](#id)

**Syntax:** ID( Column )

**Description:** Specifies the identifier column that is used to count unique occurrences.

#### [Set in existing](#set-in-existing_1)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Set Format( Uniform Format( 10, 2 ) ),
    Add Table(
        Column Table(
            Statistics( Sum ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name ) )
    )
);
Wait( 1 );
obj << ID( :Division );


```

#### [Set in new](#set-in-new_1)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    ID( :Division ),
    Set Format( Uniform Format( 10, 2 ) ),
    Add Table(
        Column Table(
            Statistics( Sum ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name ) )
    )
);


```

### [Page Column](#page-column_1)

**Syntax:** Page Column( Column )

**Description:** Specify the page column to be used for setting up pages of report

#### [Multiple response page column](#multiple-response-page-column_1)

```

dt = Open( "$Sample_Data/Big Class Families.jmp" );
obj = Tabulate(
    Show Control Panel( 0 ),
    Page Column( :family cars( "Jeep" ) ),
    Add Table(
        Column Table( Analysis Columns( :height ), Statistics( N, "% of Total"n ) ),
        Row Table( Grouping Columns( :sex ) )
    )
);


```

#### [Set page column and level in existing](#set-page-column-and-level-in-existing)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :height, :weight ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :age ) )
    )
);
Wait( 1 );
obj << Page Column( :sex( "F" ) );


```

#### [Set page column and level in new](#set-page-column-and-level-in-new)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Page Column( :sex( "F" ) ),
    Add Table(
        Column Table( Analysis Columns( :height, :weight ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :age ) )
    )
);


```

#### [Set page column in new](#set-page-column-in-new)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Page Column( :sex ),
    Add Table(
        Column Table( Analysis Columns( :height, :weight ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :age ) )
    )
);


```

### [Weight](#weight_1)

**Syntax:** Weight( Column )

**Description:** Specify the weight column to be used in computing for statistics

#### [Set in existing](#set-in-existing_2)

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :Horsepower ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Type ) )
    )
);
Wait( 1 );
obj << Weight( :Weight );


```

#### [Set in new](#set-in-new_2)

```

dt = Open( "$SAMPLE_DATA/Car Physical Data.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Weight( :Weight ),
    Add Table(
        Column Table( Analysis Columns( :Horsepower ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Type ) )
    )
);


```

## [Item Messages](#item-messages)

### [Add](#add)

**Syntax:** add(\<Column Table | Row Table>(table index), \<before first | \<before | after>(\<analysis column | grouping column | statistic>(\<operand name | index>))>, \<analysis column | grouping column | statistic>(operand name)),

**Description:** Used with Modify Table to add columns and statistics to an existing table. Also serves as an alias for Add Table

#### [Add analysis column before named](#add-analysis-column-before-named)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Column Table( Analysis Columns( :weight ) ) )
);
Wait( 0 );
obj << Modify Table(
    Column Table( 1 ),
    Add( Before( Analysis Columns( :weight ) ), Analysis Columns( :height ) )
);


```

#### [Add stat after named](#add-stat-after-named)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table(
    Column Table( 1 ),
    Add( After( Statistics( Max ) ), Statistics( Range ) )
);


```

#### [Add stat before first](#add-stat-before-first)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table( Column Table( 1 ), Add( Before First, Statistics( N ) ) );


```

#### [Add stat before index](#add-stat-before-index)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table(
    Column Table( 1 ),
    Add( Before( Statistics( 2 ) ), Statistics( Median ) )
);


```

### [Add Table](#add-table)

**Syntax:** Add Table( \<Column Table( )>, \<Row Table( )> )

**Description:** Adds a table to the window if there is no current table or appends a table to the existing table object.

#### [Add to empty](#add-to-empty)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate( Show Control Panel( 0 ) );
obj << Add Table( Column Table( Grouping Columns( :sex ) ) );
obj << Add Table( Row Table( Grouping Columns( :age ) ) );


```

#### [Add to existing](#add-to-existing_3)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Add Table( Column Table( Grouping Columns( :type ) ) );


```

### [Aggregate Statistics](#aggregate-statistics)

**Syntax:** Aggregate Statistics( column )

**Description:** Adds a separate column for each level of the specified column together with a summation column to the current table. When scripting, the Aggregate Statistics message must be within either a Column Table message or a Row Table message.

#### [Set when adding to existing](#set-when-adding-to-existing)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Column Table( Analysis Columns( :OZONE ), Statistics( Mean ) ) )
);
obj << Modify Table(
    Row Table( 1 ),
    Grouping Columns( :Region ),
    Aggregate Statistics( :Region )
);


```

#### [Set when adding to new](#set-when-adding-to-new)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Region ), Aggregate Statistics( :Region ) )
    )
);


```

### [Change Item Label](#change-item-label)

**Syntax:** obj \<< Change Item Label( Statistics( stat name, new string ) )

**Description:** Changes the label on a text entry field in the table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);
obj << Change Item Label( Statistics( Mean, "Average" ) );


```

### [Delete](#delete)

**Syntax:** delete( \<analysis columns | grouping columns | statistics>(operand name, operand name, ...))

**Description:** Used with Modify Table to remove columns and statistics from an existing table.

#### [Delete named analysis column](#delete-named-analysis-column)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table( Column Table( 1 ), Delete( Analysis Columns( :Assets ) ) );


```

#### [Delete stat at index](#delete-stat-at-index)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table( Column Table( 1 ), Delete( Statistics( 1 ) ) );


```

### [Display Column Width](#display-column-width)

**Syntax:** obj \<< Display Column Width( Data Column( \<Column Table(n)>, path ), <width> ); obj \<< Display Column Width( Row Label( \<Row Table(n)>, path ), <width> )

**Description:** Sets or returns the display width of a column in a Tabulate report table. Path is a sequence of quoted column headings that traces the path of the column. Width is the width of a column in pixels. Use Data Column to define columns in the main body of the table or Row Label for columns in the row labels area. If there are multiple tables in the report, use Column Table(n) or Row Table(n) to specify which table the path applies to. If width is not specified, this option returns the current width of the specified column.

#### [Get column width](#get-column-width)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :sex, :marital status ),
            Analysis Columns( :age ),
            Statistics( Sum, "% of Total" )
        ),
        Row Table( Grouping Columns( :type ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Display Column Width(
    Column( Column Table( 1 ), "sex", "Female", "Marital status", "Single", "age", "Sum" )
);


```

#### [Resize data columns to equal widths](#resize-data-columns-to-equal-widths)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Set Format( Mean( :OZONE( 6, 4 ) ) ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Min, Max, Mean, Std Dev ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);
stats = {"Min", "Max", "Mean", "Std Dev"};
ns = N Items( stats );
a = {};
For( i = 1, i <= ns, i++,
    a[i] = obj << Display Column Width( Data Column( "OZONE", stats[i] ) )
);
amax = Max( a );
For( i = 1, i <= ns, i++,
    obj << Display Column Width( Data Column( "OZONE", stats[i] ), amax )
);


```

#### [Set row label width](#set-row-label-width)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :sex, :marital status ),
            Analysis Columns( :age ),
            Statistics( Sum, "% of Total" )
        ),
        Row Table( Grouping Columns( :type ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Display Column Width( Row Label( Row Table( 2 ), "country" ), 150 );


```

### [Full Path Column Name](#full-path-column-name)

**Syntax:** obj \<< Full Path Column Name( true | false )

**Description:** If set, column name for output table should include the grouping columns name

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Full Path Column Name( 1 );
obj << Make Into Data Table;


```

### [Ignore duplicate responses](#ignore-duplicate-responses)

**Syntax:** obj \<< Ignore duplicate responses( Grouping Columns( column ), true | false )

**JMP Version Added:** 19

#### [Set in existing](#set-in-existing_3)

```

dt = Open( "$Sample_Data/Big Class Families.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :family cars ) ),
        Row Table( Grouping Columns( :sex, :age ) )
    )
);
obj << Ignore Duplicate Responses( Grouping Columns( :family cars ), 1 );


```

#### [Set in new](#set-in-new_3)

```

dt = Open( "$Sample_Data/Big Class Families.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Ignore Duplicate Responses( Grouping Columns( :family cars ), 1 ),
    Add Table(
        Column Table( Grouping Columns( :family cars ) ),
        Row Table( Grouping Columns( :sex, :age ) )
    )
);


```

### [Ignore duplicates in multiple response columns](#ignore-duplicates-in-multiple-response-columns)

**Syntax:** obj \<< Ignore duplicates in multiple response columns( state=0|1 )

**Description:** Ignores duplicate responses in multiple response columns. Each repeated response is treated as a single occurrence.

**JMP Version Added:** 19

#### [Set in existing](#set-in-existing_4)

```

dt = Open( "$Sample_Data/Big Class Families.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :family cars ) ),
        Row Table( Grouping Columns( :sex, :age ) )
    )
);
obj << Ignore Duplicates In Multiple Response Columns( 1 );


```

#### [Set in new](#set-in-new_4)

```

dt = Open( "$Sample_Data/Big Class Families.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Ignore Duplicates In Multiple Response Columns( 1 ),
    Add Table(
        Column Table( Grouping Columns( :family cars ) ),
        Row Table( Grouping Columns( :sex, :age ) )
    )
);


```

### [Include missing for grouping columns](#include-missing-for-grouping-columns)

**Syntax:** obj \<< Include missing for grouping columns( state=0|1 )

**Description:** Adds a separate column containing counts for missing values for all grouping columns in the current table.

#### [Set in existing](#set-in-existing_5)

```

dt = Open( "$SAMPLE_DATA/Cars.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Grouping Columns( :Doors ) ) )
);
obj << Include Missing For Grouping Columns( 1 );


```

#### [Set in new](#set-in-new_5)

```

dt = Open( "$SAMPLE_DATA/Cars.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Include Missing For Grouping Columns( 1 ),
    Add Table( Row Table( Grouping Columns( :Doors ) ) )
);


```

### [Make Into Data Table](#make-into-data-table)

**Syntax:** obj \<< Make Into Data Table( \<Invisible(bool) | Private(bool)>, \<Output Table( table name)>, \<Full Path Column Name(bool)> )

**Description:** Creates a new data table from the table created in Tabulate.

#### [Make into data table](#make-into-data-table_1)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Make Into Data Table;


```

#### [Make into invisible data table](#make-into-invisible-data-table)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Make into Data Table( Invisible( 1 ) );


```

#### [Use full path column names](#use-full-path-column-names)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Make into Data Table( Full Path Column Name( 1 ) );


```

### [Max scroll locked columns](#max-scroll-locked-columns)

**Syntax:** obj \<< Max scroll locked columns( number=3 )

**Description:** Set the maximum number of columns to be scroll locked. Either all or none of the row header columns will be locked. On by default.

**JMP Version Added:** 19

#### [Limit allows header count](#limit-allows-header-count)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Scroll Lock Row Headers In Data Table Export( 1 );
obj << Max Scroll Locked Columns( 2 );
obj << Make Into Data Table;


```

#### [Limit under header count](#limit-under-header-count)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Scroll Lock Row Headers In Data Table Export( 1 );
obj << Max Scroll Locked Columns( 1 );
obj << Make Into Data Table;


```

### [Missing sum is zero](#missing-sum-is-zero)

**Syntax:** obj \<< Missing sum is zero( state=0|1 )

**Description:** Specifies if missing values for the sum summary statistic should be displayed as 0 or missing.

#### [Set in existing](#set-in-existing_6)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :height ), Grouping Columns( :sex ) ),
        Row Table( Grouping Columns( :name ) )
    )
);
obj << Missing Sum Is Zero( 1 );


```

#### [Set in new](#set-in-new_6)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Missing Sum Is Zero( 1 ),
    Add Table(
        Column Table( Analysis Columns( :height ), Grouping Columns( :sex ) ),
        Row Table( Grouping Columns( :name ) )
    )
);


```

### [Modify Table](#modify-table)

**Syntax:** obj \<< Modify Table( \<Column Table | Row Table>(table index), ... )

**Description:** Modifies an existing table.

#### [Build and edit full table](#build-and-edit-full-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate( Show Control Panel( 0 ) );
obj << Add Table( Column Table( Grouping Columns( :sex ) ) );
obj << Add table( Row Table( Grouping Columns( :age ) ) );
obj << Add Table( Column Table( Analysis Columns( :height ) ) );
obj << Add Table( Column Table( Analysis Columns( :weight ) ) );
obj << Modify Table( Column Table( 2 ), Statistics( Min, Max ) );
obj << Modify Table( Column Table( 2 ), Grouping Columns( :sex ) );
obj << Modify Table( Column Table( 2 ), Analysis Columns( :weight ) );
Wait( 1 );
obj << Modify Table( Column Table( 2 ), Delete( Analysis Columns( :weight ) ) );
obj << Modify Table( Column Table( 2 ), Delete( Statistics( Sum ) ) );


```

#### [Delete analysis column](#delete-analysis-column)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table( Column Table( 1 ), Delete( Analysis Columns( :Assets ) ) );


```

### [Modify Table Option](#modify-table-option)

**Syntax:** obj \<< Modify Table Option

**Description:** Used with Modify Table to modify table options in an existing table.

#### [Change stacked group label in existing](#change-stacked-group-label-in-existing)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :height ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :age, :sex ), Stack Grouping Columns( 1 ) )
    )
);
obj << Modify Table(
    Row Table( 1 ),
    Modify Table Option( Change Stacked Group Label ),
    "new label"
);


```

#### [Stack grouping columns in existing](#stack-grouping-columns-in-existing)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :height ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :age, :sex ) )
    )
);
obj << Modify Table( Row Table( 1 ), Modify Table Option( Stack Grouping Columns( true ) ) );


```

### [Move](#move)

**Syntax:** move(\<Column Table | Row Table>(table index), \<analysis column | grouping column | statistic>(\<operand name | index>)), \<before first | \<before | after>(\<analysis column | grouping column | statistic>(\<operand name | index>)>)

**Description:** Used with Modify Table to move columns and statistics in an existing table.

**JMP Version Added:** 19

#### [Move grouping column from column to row table](#move-grouping-column-from-column-to-row-table)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table(
    Row Table( 1 ),
    Move( Column Table( 1 ), Grouping Column( :Type ) ),
    Before First
);


```

#### [Move stat after named](#move-stat-after-named)

```

dt = Open( "$SAMPLE_DATA/Companies.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :Type ),
            Analysis Columns( :"Sales ($M)"n, :Assets ),
            Statistics( Min, Mean, Max )
        )
    )
);
Wait( 0 );
obj << Modify Table(
    Column Table( 1 ),
    Move( Column Table( 1 ), Statistics( Mean ) ),
    After( Statistics( Max ) )
);


```

### [Order By Count](#order-by-count)

**Syntax:** obj \<< Order By Count( Grouping Columns( column ), true | false )

#### [Set in existing](#set-in-existing_7)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Grouping Columns( :age ) ) )
);
obj << Order By Count( Grouping Columns( :age ), 1 );


```

#### [Set in new](#set-in-new_7)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Order By Count( Grouping Columns( :age ), 1 ),
    Add Table( Row Table( Grouping Columns( :age ) ) )
);


```

### [Order by count of grouping columns](#order-by-count-of-grouping-columns)

**Syntax:** obj \<< Order by count of grouping columns( state=0|1 )

**Description:** Sorts the levels of the grouping columns by counts in the table.

#### [Set in existing](#set-in-existing_8)

```

dt = Open( "$SAMPLE_DATA/Cars.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table( Row Table( Grouping Columns( :Make ) ) )
);
obj << Order by Count of Grouping Columns( 1 );


```

#### [Set in new](#set-in-new_8)

```

dt = Open( "$SAMPLE_DATA/Cars.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Order by Count of Grouping Columns( 1 ),
    Add Table( Row Table( Grouping Columns( :Make ) ) )
);


```

### [Pack](#pack)

**Syntax:** obj \<< Pack( \<Analysis columns | Statistics>(operand name, ...), <Template> )

**Description:** Pack multiple statistics into one column in the table. The Template option specifies the formatting of the items.

#### [Pack analysis columns in existing](#pack-analysis-columns-in-existing)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Statistics( Sum ), Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ) ),
        Row Table( Grouping Columns( :Mfr Name, :Engine ) )
    )
);
obj << Modify Table(
    Column Table( 1 ),
    Pack(
        Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
        Template( "^FIRST  (^OTHERS)", "/" )
    )
);


```

#### [Pack analysis columns in new](#pack-analysis-columns-in-new)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Statistics( Sum ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack( Analysis Columns( City MPG, Hwy MPG, Comb MPG ) )
        ),
        Row Table( Grouping Columns( :Mfr Name, :Engine ) )
    )
);


```

#### [Pack analysis columns in new with template](#pack-analysis-columns-in-new-with-template)

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Statistics( Sum ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name, :Engine ) )
    )
);


```

### [Plot Scale](#plot-scale)

**Syntax:** obj \<< Plot Scale( min, max )

**Description:** Sets the scale on the bar chart.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Show Chart( 1 );
Wait( 2 );
obj << Plot Scale( 0, 25 );


```

### [Remove Column Label](#remove-column-label)

**Syntax:** obj \<< Remove Column Label( Grouping Columns( column ) )

**Description:** Removes the specified column label in the table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :Region ) ),
        Row Table( Analysis Columns( :OZONE, :CO, :NO, :SO2 ), Statistics( Mean ) )
    )
);
Wait( 2 );
obj << Remove Column Label( Grouping Columns( :Region ) );


```

### [Restore Column Label](#restore-column-label)

**Syntax:** obj \<< Restore Column Label( Grouping Columns( column ) )

**Description:** Restores the previously removed, specified column label in the table.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :Region ) ),
        Row Table( Analysis Columns( :OZONE, :CO, :NO, :SO2 ), Statistics( Mean ) )
    )
);
obj << Remove Column Label( Grouping Columns( :Region ) );
Wait( 2 );
obj << Restore Column Label( Grouping Columns( :Region ) );


```

### [Retype](#retype)

**Syntax:** Retype( \<Analysis Columns | Grouping Columns>( operand name, ... ), \<Analysis Column | Gropuing Column> )

**Description:** Used with Modify Table to convert between analysis columns and grouping columns in an existing table.

**JMP Version Added:** 19

#### [Change analysis column to grouping column](#change-analysis-column-to-grouping-column)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Statistics( N ), Analysis Columns( :age ) ),
        Row Table( Grouping Columns( :sex ) )
    )
);
obj << Modify Table( Column Table( 1 ), Retype( Analysis Column( :age ) ), Grouping Column );


```

#### [Change grouping column to analysis column](#change-grouping-column-to-analysis-column)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Statistics( N ), Grouping Columns( :age ) ),
        Row Table( Grouping Columns( :sex ) )
    )
);
obj << Modify Table( Column Table( 1 ), Retype( Grouping Column( :age ) ), Analysis Column );


```

### [Save grouping as tags in data table export](#save-grouping-as-tags-in-data-table-export)

**Syntax:** obj \<< Save grouping as tags in data table export( state=0|1 )

**Description:** Sets if the grouping levels should be included in the data table as column tags. On by default.

**JMP Version Added:** 19

#### [Don't save tags](#dont-save-tags)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Save Grouping As Tags In Data Table Export( 0 );
obj << Make Into Data Table;


```

#### [Save tags](#save-tags)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Save Grouping As Tags In Data Table Export( 1 );
obj << Make Into Data Table;


```

### [Scroll lock row headers in data table export](#scroll-lock-row-headers-in-data-table-export)

**Syntax:** obj \<< Scroll lock row headers in data table export( state=0|1 )

**Description:** Sets if the columns containing the row headers should be scroll locked. On by default.

**JMP Version Added:** 19

#### [Don't scroll lock row headers](#dont-scroll-lock-row-headers)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Scroll Lock Row Headers In Data Table Export( 0 );
obj << Make Into Data Table;


```

#### [Scroll lock row headers](#scroll-lock-row-headers)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Scroll Lock Row Headers In Data Table Export( 1 );
obj << Make Into Data Table;


```

### [Set Format](#set-format)

**Syntax:** Set Format( statistic( Column( format ) )

**Description:** Sets the format displayed for analysis columns.

#### [Format in existing](#format-in-existing)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);
obj << Set Format( Mean( :OZONE( 6, 4 ) ) );


```

#### [Format multiple stats and analysis columns](#format-multiple-stats-and-analysis-columns)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Tabulate(
    Show Control Panel( 0 ),
    Set Format(
        Mean(
            :height( 10, 1 ),
            Analysis Column(
                Transform Column( "Log[height]", Formula( Log( :height ) ) ),
                Format( 10, "Best" )
            )
        ),
        "% of Total"n(
            :height( 12, 2 ),
            Analysis Column(
                Transform Column( "Log[height]", Formula( Log( :height ) ) ),
                Format( 12, 2 )
            )
        )
    ),
    Add Table(
        Column Table(
            Analysis Columns(
                :height,
                Transform Column( "Log[height]", Formula( Log( :height ) ) )
            ),
            Statistics( Mean, "% of Total"n )
        ),
        Row Table( Grouping Columns( :sex ) )
    )
);


```

#### [Format single stat and analysis column](#format-single-stat-and-analysis-column)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Set Format( Mean( :OZONE( 6, 4 ) ) ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);


```

#### [Format stat without analysis column](#format-stat-without-analysis-column)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Set Format( Row %( Format( 9, 1, "Percent" ) ) ),
    Add Table( Column Table( Grouping Columns( :age ), Statistics( Row % ) ) )
);


```

### [Show Chart](#show-chart)

**Syntax:** obj \<< Show Chart( state=0|1 )

**Description:** Displays or hides a bar chart generated from the table created in Tabulate.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Show Chart( 1 );


```

### [Show Control Panel](#show-control-panel)

**Syntax:** obj \<< Show Control Panel( state=0|1 )

**Description:** Displays or hides the control panel used to manipulate the table created in Tabulate. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Show Control Panel( 1 );


```

### [Show Shading](#show-shading)

**Syntax:** obj \<< Show Shading( state=0|1 )

**Description:** Displays or hides alternating shaded and nonshaded lines on the table created in Tabulate. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Show Shading( 1 );


```

### [Show Table](#show-table)

**Syntax:** obj \<< Show Table( state=0|1 )

**Description:** Displays or hides the table created in Tabulate. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Show Table( 1 );


```

### [Show Test Build Panel](#show-test-build-panel)

**Syntax:** obj \<< Show Test Build Panel( state=0|1 )

**Description:** Displays or hides the panel controlling sampling for a test build of the table.

#### [Show for existing](#show-for-existing)

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 1 ),
    Add Table(
        Column Table( Statistics( Mean, Std Dev ) ),
        Row Table( Analysis Columns( :ForSc, :SideSc, :CD3, :CD8, :CD4, :MCB ) )
    )
);
obj << Show Test Build Panel( 1 );


```

#### [Show for new](#show-for-new)

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 1 ),
    Show Test Build Panel( 1 ),
    Add Table(
        Column Table( Statistics( Mean, Std Dev ) ),
        Row Table( Analysis Columns( :ForSc, :SideSc, :CD3, :CD8, :CD4, :MCB ) )
    )
);


```

### [Show Tooltip](#show-tooltip)

**Syntax:** obj \<< Show Tooltip( state=0|1 )

**Description:** Displays or hides the tooltips when hovering on drop zones and menus the Tabulate output.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Show Tool Tip( 1 );


```

### [Stack Grouping Columns](#stack-grouping-columns)

**Syntax:** Stack Grouping Columns(0 | 1)

**Description:** Stack the grouping columns into a single column, using indenting to show the nesting structure.

#### [Set in existing](#set-in-existing_9)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :marital status ),
            Add Aggregate Statistics( :marital status ),
            Analysis Columns( :age ),
            Statistics( Min, Max )
        ),
        Row Table(
            Grouping Columns( :sex, :country, :size ),
            Add Aggregate Statistics( :sex, :country, :size )
        )
    )
);
obj << Modify Table( Row Table( 1 ), Modify Table Option( Stack Grouping Columns( 1 ) ) );


```

#### [Set in new](#set-in-new_9)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Grouping Columns( :marital status ),
            Add Aggregate Statistics( :marital status ),
            Analysis Columns( :age ),
            Statistics( Min, Max )
        ),
        Row Table(
            Grouping Columns( :sex, :country, :size ),
            Add Aggregate Statistics( :sex, :country, :size ),
            Stack Grouping Columns( 1 )
        )
    )
);


```

### [Statistics](#statistics)

**Syntax:** Statistics( N|Mean|Std Dev|Min|Max|Range|% of Total|N Missing|N Categories|Sum|Sum Wgt|Variance|Std Err|CV|Median|Interquartile Range|Quantiles|Column %|Row %|All )

**Description:** Adds statistics to a column or row in the table. When scripting, the Statistics() message resides next to the identifying Analysis Columns( column ) message, and both are nested within either a Row Table() or Column Table() command.

#### [Add to existing](#add-to-existing_4)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean, Max ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);
obj << Modify Table( Column Table( 1 ), Statistics( Min ) );


```

#### [Add to new](#add-to-new_3)

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Analysis Columns( :OZONE ), Statistics( Mean, Max ) ),
        Row Table( Grouping Columns( :Region ) )
    )
);


```

### [Test Build](#test-build)

**Syntax:** obj \<< Test Build( Sample Size( number ) )

**Description:** Displays the table using a test build sample of the data of size number.

#### [Set in existing](#set-in-existing_10)

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Statistics( Mean, Std Dev ) ),
        Row Table( Analysis Columns( :ForSc, :SideSc, :CD3, :CD8, :CD4, :MCB ) )
    )
);
obj << Test Build( Sample Size( 100 ) );


```

#### [Set in new](#set-in-new_10)

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Test Build( Sample Size( 100 ) ),
    Add Table(
        Column Table( Statistics( Mean, Std Dev ) ),
        Row Table( Analysis Columns( :ForSc, :SideSc, :CD3, :CD8, :CD4, :MCB ) )
    )
);


```

### [Test Data View](#test-data-view)

**Syntax:** obj \<< Test Data View

**Description:** Displays the data table used as a sample to build the test table.

```

dt = Open( "$SAMPLE_DATA/Cytometry.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Statistics( Mean, Std Dev ) ),
        Row Table( Analysis Columns( :ForSc, :SideSc, :CD3, :CD8, :CD4, :MCB ) )
    )
);
obj << Test Build( Sample Size( 100 ) );
obj << Test Data View;


```

### [Undo](#undo)

**Syntax:** obj \<< Undo

**Description:** Removes the effect of the last operation issued to the current table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Add Table( Column Table( Grouping Columns( :type ) ) );
Wait( 2 );
obj << Undo;


```

### [Uniform plot scale](#uniform-plot-scale)

**Syntax:** obj \<< Uniform plot scale( state=0|1 )

**Description:** Sets the scales for all subcategories to be the same on the bar chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Show Chart( 1 );
Wait( 2 );
obj << Uniform Plot Scale( 1 );


```

### [Unpack](#unpack)

**Syntax:** obj \<< Unpack( \<Analysis columns | Statistics>(operand name, ...) )

**Description:** Unpacks a packed set of columns.

```

dt = Open( "$SAMPLE_DATA/Hybrid Fuel Economy.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Statistics( Sum ),
            Analysis Columns( :City MPG, :Hwy MPG, :Comb MPG ),
            Pack(
                Analysis Columns( City MPG, Hwy MPG, Comb MPG ),
                Template( "^FIRST  (^OTHERS)", "/" )
            )
        ),
        Row Table( Grouping Columns( :Mfr Name, :Engine ) )
    )
);
obj << Modify Table( Column Table( 1 ), Unpack( Analysis Columns( :City MPG ) ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table( Grouping Columns( :sex, :marital status ) ),
        Row Table( Grouping Columns( :country, :size ) )
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Tabulate(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Ternary Plot](#ternary-plot)

## [Associated Constructors](#associated-constructors)

### [Ternary Plot](#ternary-plot_1)

**Syntax:** Ternary Plot( Y( columns ) )

**Description:** Produces a two-dimensional plot of three mixture components that sum to a constant.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Ternary Plot(...\<By( column(s) )>...)

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Contour Formula](#contour-formula)

**Syntax:** obj = Ternary Plot(...Contour Formula( formula column )...)

**Description:** A formula column to create contours of the response surface.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ), Contour Formula( :Pred Formula Y ) );


```

### [Plotting](#plotting)

**Syntax:** obj = Ternary Plot(...Plotting( column(s) )...)

**Description:** Three or more columns representing mixture proportions.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );


```

### [X](#x)

**Syntax:** obj = Ternary Plot(...X( column(s) )...)

**Description:** Three or more columns representing mixture proportions.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );


```

## [Item Messages](#item-messages)

### [3D Graph](#3d-graph)

**Syntax:** obj \<< 3D Graph( state=0|1 )

**Description:** Displays a 3 dimensional graph using 4 or more X variables.

```

dt = Open( "$SAMPLE_DATA/Five Factor Mixture.jmp" );
obj = dt << Ternary Plot( Y( :x1, :x2, :x3, :x4, :x5 ) );
obj << "3D Graph"n( 1 );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

**Description:** Sets the color theme used for gradients.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ), Contour Formula( :Pred Formula Y ) );
obj << Contour Fill( Fill Above );
obj << Color Theme( "Spectral" );


```

### [Contour Fill](#contour-fill)

**Syntax:** obj \<< Contour Fill( "Lines only"|"Fill Above"|"Fill Below" )

**Description:** Fills the defined contour in the Ternary Plot.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ), Contour Formula( :Pred Formula Y ) );
obj << Contour Fill( Fill Above );


```

### [Contour Value](#contour-value)

**Syntax:** obj \<< Contour Value( [c1, c2, c3, c4, c5] )

**Description:** Changes the contours on the Ternary Plot.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ), Contour Formula( :Pred Formula Y ) );
obj << Contour Value( [9, 13, 15, 17, 19] );


```

### [Fit to Window](#fit-to-window)

**Syntax:** obj \<< Fit to Window( "Auto"|"On"|"Off" )

**Description:** Sets the auto stretching behavior of the report.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Fit to Window( "Off" );


```

### [Show Constraints](#show-constraints)

**Syntax:** obj \<< Show Constraints( state=0|1 )

**Description:** Show the shaded component constraints. On by default.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
Wait( 2 );
obj << Show Constraints( 0 );


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides the points on the Ternary Plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Show Points( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Ternary Plot(
    Y( :p1, :p2, :p3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Plasticizer.jmp" );
obj = dt << Ternary Plot( Y( :p1, :p2, :p3 ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Ternary Plot(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Text Explorer](#text-explorer)

## [Associated Constructors](#associated-constructors)

### [Text Explorer](#text-explorer_1)

**Syntax:** Text Explorer( Text Columns( columns ) )

**Description:** Parses words from text in a column, counts them, associates them with other columns, saves indicators, and graphs relationships.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Produce multiple reports, one for each level of the variable(s).

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [ID](#id)

**Syntax:** obj \<< ID( column )

**Description:** A column used to identify separate respondents in the Save Stacked DTM for Association output data table, as well as the Latent Class Analysis report.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    ID( :School Age Children )
);
obj << Save Stacked DTM For Association;


```

### [Text Columns](#text-columns)

**Syntax:** obj \<< Text Columns( column(s) )

**Description:** A text column that contains the documents to be processed. Each row value is treated as one document.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

**Description:** A numeric column containing two or three distinct values. If there are two values, the smaller value defines the training set and the larger value defines the validation set. If there are three values, these values define the training, validation, and test sets in order of increasing size. If there are more than three values, all but the smallest three are ignored.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    Validation( :School Age Children )
);
obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);


```

## [Item Messages](#item-messages)

### [Add Delimiters](#add-delimiters)

**Syntax:** obj \<< Add Delimiters( "string" )

**Description:** Adds user-supplied delimiter characters, in a single string, to the default list of delimiter characters for splitting words.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Tokenizing( "Basic Words" );
obj << Show Delimiters( 1 );
Wait( 1 );
obj << Add Delimiters( "{}" );


```

### [Add Phrase Exceptions](#add-phrase-exceptions)

**Syntax:** obj \<< Add Phrase Exceptions( list )

**Description:** Adds a list of phrases to remove from the term list.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Add Phrases( {"twice a day", "every time", "time consuming"} );
Wait( 1 );
obj << Add Phrase Exceptions( {"every time"} );


```

### [Add Phrases](#add-phrases)

**Syntax:** obj \<< Add Phrases( list )

**Description:** Adds a list of phrases to the term list to be analyzed like single terms. The term counts are updated accordingly.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Add Phrases( {"twice a day", "every time"} );


```

### [Add Recode Exceptions](#add-recode-exceptions)

**Syntax:** obj \<< Add Recode Exceptions( { {pair1}, {pair2}, ...} )

**Description:** Adds a list of recoded text strings to remove.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Add Recodes( {{"everytime", "every time"}, {"neglagent", "negligent"}} );
obj << Show Recodes( 1 );
Wait( 1 );
obj << Add Recode Exceptions( {"neglagent", "negligent"} );


```

### [Add Recodes](#add-recodes)

**Syntax:** obj \<< Add Recodes( { {pair1}, {pair2}, ...} )

**Description:** Adds a list of pairs of words to recode.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Add Recodes( {{"everytime", "every time"}, {"neglagent", "negligent"}} );
obj << Show Recodes( 1 );


```

### [Add Stem Exceptions](#add-stem-exceptions)

**Syntax:** obj \<< Add Stem Exceptions( list )

**Description:** Adds a list of words that are excluded from stemming.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Stemming( "Stem All Terms" );
obj << Show Stem Report( 1 );
Wait( 1 );
obj << Add Stem Exceptions( {"care", "brush", "like"} );


```

### [Add Stem Overrides](#add-stem-overrides)

**Syntax:** obj \<< Add Stem Overrides( list )

**Description:** Adds a list of words that are always allowed to be stemmed.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Stemming( "Stem All Terms" );
obj << Show Stem Report( 1 );
Wait( 1 );
obj << Add Stem Overrides( {"care"} );
obj << Add Stem Exceptions( {"care", "brush", "like"} );


```

### [Add Stop Word Exceptions](#add-stop-word-exceptions)

**Syntax:** obj \<< Add Stop Word Exceptions( list )

**Description:** Adds a list of words to be removed as stop words and added to the term list.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Show Stop Words( 1 );
Wait( 1 );
obj << Add Stop Word Exceptions( {"again", "are"} );


```

### [Add Stop Words](#add-stop-words)

**Syntax:** obj \<< Add Stop Words( list )

**Description:** Adds a list of words to remove from the term list and ignore in the analysis.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Show Stop Words( 1 );
Wait( 1 );
obj << Add Stop Words( {"use", "feel", "like"} );


```

### [Cloud Width](#cloud-width)

**Syntax:** obj \<< Cloud Width( number )

**Description:** Sets the width of the word cloud to the specified number of pixels.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Show Word Cloud( 1 );
obj << Cloud Width( 150 );


```

### [Coloring](#coloring)

**Syntax:** obj \<< Coloring( "None"|"Uniform Color"|"Arbitrary Grays"|"Arbitrary Colors"|"By column values..." )

**Description:** Specifies the coloring of the terms in the word cloud.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Show Word Cloud( 1 );
obj << Coloring( "Arbitrary Colors" );


```

### [Custom Stemmer](#custom-stemmer)

**Syntax:** obj \<< Custom Stemmer( Function( {string, dot}, ... ) )

**Description:** Performs stemming according to your specifications. Specify a function that takes the 'string' argument (a term from a document), tests it to determine what pattern it contains, and replaces characters if necessary with the 'dot' argument. This function replaces the standard stemming algorithm. Any words that are changed should include the stemming dot on the end. If stemming is enabled for the platform, this function is called for each unique term found in the corpus.

**JMP Version Added:** 15

```

//This custom stemmer looks only for words ending in 'ing' and replaces the end with the stemming dot.
dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Stemming( "Stem All Terms" );
obj << Show Stem Report( 1 );
obj << Custom Stemmer(
    Function( {string, dot},
        If( Ends With( string, "ing" ),
            Substr( string, 1, Length( string ) - 3 ) || dot,
            string
        )
    )
);


```

### [Customize Regex](#customize-regex)

**Syntax:** obj = Text Explorer(...Customize Regex( state=0|1 )...)

**Description:** Opens the Text Explorer Regular Expression Editor to modify the regular expression settings. This option is available only with the Regex Tokenizing method.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Tokenizing( "Regex" );
obj << Customize Regex();


```

### [Discriminant Analysis](#discriminant-analysis)

**Syntax:** obj \<< Discriminant Analysis( Maximum Number of Terms( number ), Minimum Number of Terms( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number oc Singular Vectors( number ), Column( :column name ) )

**Description:** Predicts a classification of each document into a category of a specified response column using linear discriminant analysis of the document term matrix.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Discriminant Analysis(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Column( :Gender )
);


```

### [Font](#font)

**Syntax:** obj \<< Font( font )

**Description:** Specifies the font, style, and size of the terms in the word cloud.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Show Word Cloud( 1 );
obj << Font( "Arial Narrow", 11, "Plain" );


```

### [Include Builtin Phrases](#include-builtin-phrases)

**Syntax:** obj \<< Include Builtin Phrases( state=0|1 )

**Description:** Specifies that the built-in phrases are included in the phrases that are used in the tokenizing process. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Include Builtin Phrases( 0 );


```

### [Include Builtin Stop Words](#include-builtin-stop-words)

**Syntax:** obj \<< Include Builtin Stop Words( state=0|1 )

**Description:** Specifies that the built-in stop words are included in the stop words that are used in the tokenizing process. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Include Builtin Stop Words( 0 );


```

### [Language](#language)

**Syntax:** obj = Text Explorer(...Language( "Display Language"|"English"|"German"|"Spanish"|"French"|"Italian"|"Japanese"|"Chinese (Simplified)"|"Chinese (Traditional)"|"Korean" )...)

**Description:** Specifies the language used for text processing. This affects stemming and the built-in lists of stop words, recodes, and phrases.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( TextColumns( :Reasons Not to Floss ), Language( "German" ) );


```

### [Latent Class Analysis](#latent-class-analysis)

**Syntax:** obj \<< Latent Class Analysis( Number of Clusters( number ), Maximum Number of Terms( number ), Minimum Term Frequency( number ) )

**Description:** Groups documents into clusters of similar documents using a latent class analysis on the binary weighted document term matrix.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);


```

### [Latent Semantic Analysis](#latent-semantic-analysis)

**Syntax:** obj \<< Latent Semantic Analysis( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) ); obj \<< SVD( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) )

**Description:** Performs a sparse singular value decomposition of the document term matrix.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Latent Semantic Analysis(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << SVD(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);


```

### [Layout](#layout)

**Syntax:** obj \<< Layout( "Ordered"|"Alphabetical"|"Centered" )

**Description:** Specifies the arrangement of the terms in the word cloud.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Show Word Cloud( 1 );
obj << Layout( "Alphabetical" );


```

### [Maximum Characters per Word](#maximum-characters-per-word)

**Syntax:** obj = Text Explorer(...Maximum Characters per Word( number=50 )...)

**Description:** Specifies the largest number of characters that a word can contain to be included as a term in the analysis. "50" by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Maximum Characters per Word( 15 )
);


```

### [Maximum Number of Phrases](#maximum-number-of-phrases)

**Syntax:** obj = Text Explorer(...Maximum Number of Phrases( number=5000 )...)

**Description:** Specifies the maximum number of phrases that appear in the phrase list. "5000" by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Maximum Number of Phrases( 50 )
);


```

### [Maximum Words per Phrase](#maximum-words-per-phrase)

**Syntax:** obj = Text Explorer(...Maximum Words per Phrase( number=4 )...)

**Description:** Specifies a maximum number of words that a phrase can contain to be included as a phrase in the analysis. "4" by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Maximum Words per Phrase( 2 )
);


```

### [Minimum Characters per Word](#minimum-characters-per-word)

**Syntax:** obj = Text Explorer(...Minimum Characters per Word( number=1 )...)

**Description:** Specifies the number of characters that a word must contain to be included as a term in the analysis. "1" by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Minimum Characters per Word( 3 )
);


```

### [Minimum Frequency for Phrase](#minimum-frequency-for-phrase)

**Syntax:** obj \<< Minimum Frequency for Phrase( number )

**Description:** Specifies the number of occurrences of a phrase for that phrase to be included in the phrase list. There is no minimum by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Minimum Frequency for Phrase( 5 );


```

### [Phrases Alphabetical](#phrases-alphabetical)

**Syntax:** obj \<< Phrases Alphabetical( state=0|1 )

**Description:** Sorts the phrase list alphabetically. The default is to sort by decreasing count.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Phrases Alphabetical( 1 );


```

### [Rotated SVD](#rotated-svd)

**Syntax:** obj \<< Topic Analysis( Number of Topics ( number ) ) obj \<< Rotated SVD( Number of Topics( number ) )

**Description:** Performs a varimax-rotated singular value decomposition of the document term matrix to produce groups of terms called topics.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Latent Semantic Analysis(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);
obj << Show Term List( 0 );
obj << Show Phrase List( 0 );
obj << Show Summary Counts( 0 );

obj << Topic Analysis( Number of Topics( 5 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Latent Semantic Analysis(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);
obj << Show Term List( 0 );
obj << Show Phrase List( 0 );
obj << Show Summary Counts( 0 );

obj << Rotated SVD( Number of Topics( 5 ) );


```

### [SVD](#svd)

**Syntax:** obj \<< Latent Semantic Analysis( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) ); obj \<< SVD( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) )

**Description:** Performs a sparse singular value decomposition of the document term matrix.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Latent Semantic Analysis(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << SVD(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);


```

### [Save DTM Formula](#save-dtm-formula)

**Syntax:** obj \<< Save DTM Formula( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weight( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ) )

**Description:** Saves a vector-valued formula column to the data table using the Text Score JSL function. The length of the vector depends on user-specified options for the maximum number of terms, the minimum term frequency, and the weighting.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Save DTM Formula(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" )
);


```

### [Save Document Term Matrix](#save-document-term-matrix)

**Syntax:** obj \<< Save Document Term Matrix( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weight( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ) )

**Description:** Saves columns to the data table for each column of the document term matrix. The number of columns depends on user-specified options for the maximum number of terms, the minimum term frequency, and the weighting.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Save Document Term Matrix(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" )
);


```

### [Save Stacked DTM for Association](#save-stacked-dtm-for-association)

**Syntax:** obj \<< Save Stacked DTM for Association

**Description:** Saves a stacked version of the document-term matrix into a new data table. If an ID variable is specified in the Text Explorer launch window, the ID variable is used to identify the rows that each term came from in the original text data table.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Save Stacked DTM For Association;


```

### [Save Term Table](#save-term-table)

**Syntax:** obj \<< Save Term Table

**Description:** Creates a JMP data table that contains each term from the Term List, the number of occurrences, and the number of documents that contain each term.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Save Term Table;


```

### [SaveRegexColumn](#saveregexcolumn)

**Syntax:** obj \<< SaveRegexColumn( text )

**Description:** Saves the specified custom regular expressions to a new column in the data table.

```


dt = New Table( "WordTable",
    New Column( "Original Words",
        Character,
        "Nominal",
        Set Values( {"Quick brown", "foxes jumped", "over the", "lazy dog."} )
    )
);
dt << Text Explorer(
    Text Columns( :Original Words ), 
// the regex: [a-z]*? means 0 or more letters, reluctantly. [aeiou] means one vowel.    
    // {2} means repeat twice. 
    // [a-z]* means 0 or more letters, greedily. (the rest of the word)
    Set Regex(
        Custom(
            Title( "Two Vowels" ),
            Regex( "(([a-z]*?[aeiou]){2}[a-z]*)" ),
            Result( "\[\1]\" ),

        )
    ),
    Include Builtin Stop Words( 0 ), // "over" is a stop word, but we want to see it
    SaveRegexColumn( "Poly Vowel Words" )
);


```

### [Score Terms by Column](#score-terms-by-column)

**Syntax:** obj \<< Score Terms by Column( column )

**Description:** Saves scores based on values in a specified column to the data table created by the Save Term Table option. The scores for each term are the mean value of the specified column weighted by the number of occurrences of the term in each row.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Score Terms By Column( :Salary );


```

### [Sentiment Analysis](#sentiment-analysis)

**Syntax:** obj \<< Sentiment Analysis( state=0|1 )

**Description:** Identifies sentiment terms in documents using lexical analysis and scores documents for positive, negative, and overall sentiment.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );


```

### [Set Delimiters](#set-delimiters)

**Syntax:** obj \<< Set Delimiters( "string" )

**Description:** Replaces the default list of delimiter characters for splitting words with user-supplied characters in a single string.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Tokenizing( "Basic Words" );
obj << Show Delimiters( 1 );
obj << Set Delimiters( " " );


```

### [Set Regex](#set-regex)

**Syntax:** obj \<< Set Regex( ... )

**Description:** Replaces the default regular expressions used in the Regex tokenizing method.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Set Regex( Library( "Words" ) );


```

### [Show Delimiters](#show-delimiters)

**Syntax:** obj \<< Show Delimiters( state=0|1 )

**Description:** Shows or hides the delimiters that are used for tokenizing. This option is available only when the Tokenizing method is Basic Words.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Tokenizing( "Basic Words" );
Wait( 1 );
obj << Show Delimiters( 1 );


```

### [Show Filters for all Tables](#show-filters-for-all-tables)

**Syntax:** obj \<< Show Filters for all Tables( state=0|1 )

**Description:** Shows or hides filters that can be used for searching tables in the report. This option applies to the following tables: Stop Words, Specified Phrases, Stem Exceptions, Term List, Phrase List, and the Stem Report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Filters for All Tables( 1 );


```

### [Show Legend](#show-legend)

**Syntax:** obj \<< Show Legend( state=0|1 )

**Description:** Shows or hides the legend for the word cloud. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Show Word Cloud( 1 );
obj << Coloring( "Arbitrary Colors" );
Wait( 1 );
obj << Show Legend( 0 );


```

### [Show Phrase List](#show-phrase-list)

**Syntax:** obj \<< Show Phrase List( state=0|1 )

**Description:** Shows or hides the Phrase List report. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Phrase List( 0 );


```

### [Show Recodes](#show-recodes)

**Syntax:** obj \<< Show Recodes( state=0|1 )

**Description:** Shows or hides a list of the recoded terms.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Add Recodes( {{"flossing", "floss"}} );
Wait( 1 );
obj << Show Recodes( 1 );


```

### [Show Selected Rows](#show-selected-rows)

**Syntax:** obj \<< Show Selected Rows

**Description:** Opens a window that contains the text of the documents that are in the currently selected rows.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
Current Data Table() << Select Rows( [1 2 3 4] );
obj << Show Selected Rows( 1 );


```

### [Show Specified Phrases](#show-specified-phrases)

**Syntax:** obj \<< Show Specified Phrases( state=0|1 )

**Description:** Shows or hides a list of the phrases that have been specified by the user to be treated as terms.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Specified Phrases( 1 );
Report( obj )["Specified Phrases"] << Close( 0 );


```

### [Show Stem Exceptions](#show-stem-exceptions)

**Syntax:** obj \<< Show Stem Exceptions( state=0|1 )

**Description:** Shows or hides the terms that are excluded from stemming.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Stem Exceptions( 1 );


```

### [Show Stem Report](#show-stem-report)

**Syntax:** obj \<< Show Stem Report( state=0|1 )

**Description:** Shows or hides the Stemming report that contains two tables of stemming results.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Stemming( "Stem for Combining" );
obj << Show Stem Report( 1 );


```

### [Show Stop Words](#show-stop-words)

**Syntax:** obj \<< Show Stop Words( state=0|1 )

**Description:** Shows or hides a list of stop words that are used in the analysis.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Stop Words( 1 );


```

### [Show Summary Counts](#show-summary-counts)

**Syntax:** obj \<< Show Summary Counts( state=0|1 )

**Description:** Shows or hides a table of summary counts. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Summary Counts( 0 );


```

### [Show Term List](#show-term-list)

**Syntax:** obj \<< Show Term List( state=0|1 )

**Description:** Shows or hides the Term List report. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Term List( 0 );


```

### [Show Term and Phrase Options](#show-term-and-phrase-options)

**Syntax:** obj \<< Show Term and Phrase Options( state=0|1 )

**Description:** Shows or hides buttons in the Term and Phrase Lists report that correspond to the options available in the pop-up menus for each list.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Term and Phrase Options( 1 );


```

### [Show Word Cloud](#show-word-cloud)

**Syntax:** obj \<< Show Word Cloud( state=0|1 )

**Description:** Shows or hides the word cloud.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Show Word Cloud( 1 );


```

### [Stemming](#stemming)

**Syntax:** obj = Text Explorer(...Stemming( "No Stemming"|"Stem for Combining"|"Stem All Terms" )...)

**Description:** Specifies a method for combining terms with similar beginning characters but different endings.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Stemming( "Stem All Terms" );


```

### [Term Selection](#term-selection)

**Syntax:** obj \<< Term Selection( Models( Model( Response Column( <column> ), <other models> )), Model Choice( <index> ))

**Description:** Analyzes which terms best explain different responses. Term selection is also useful for sentiment analysis when the responses are ratings.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);


```

### [Terms Alphabetical](#terms-alphabetical)

**Syntax:** obj \<< Terms Alphabetical( state=0|1 )

**Description:** Sorts the term list alphabetically. The default is to sort by decreasing count.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Terms Alphabetical( 1 );


```

### [Tokenizing](#tokenizing)

**Syntax:** obj = Text Explorer(...Tokenizing( "Regex"|"Basic Words" )...)

**Description:** Specifies a method for parsing the text into terms or tokens. The methods available are Regex and Basic Words.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Tokenizing( "Basic Words" );


```

### [Topic Analysis](#topic-analysis)

**Syntax:** obj \<< Topic Analysis( Number of Topics ( number ) ) obj \<< Rotated SVD( Number of Topics( number ) )

**Description:** Performs a varimax-rotated singular value decomposition of the document term matrix to produce groups of terms called topics.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Latent Semantic Analysis(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);
obj << Show Term List( 0 );
obj << Show Phrase List( 0 );
obj << Show Summary Counts( 0 );

obj << Topic Analysis( Number of Topics( 5 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Latent Semantic Analysis(
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 10 ),
    Centering and Scaling( "Centered" )
);
obj << Show Term List( 0 );
obj << Show Phrase List( 0 );
obj << Show Summary Counts( 0 );

obj << Rotated SVD( Number of Topics( 5 ) );


```

### [Treat Numbers as Words](#treat-numbers-as-words)

**Syntax:** obj = Text Explorer(...Treat Numbers as Words( state=0|1 )...)

**Description:** Considers words composed entirely of digits as tokens. Available only with the Basic Words tokenizing method.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
Wait( 1 );
obj << Tokenizing( "Basic Words" );
obj << Treat Numbers as Words( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Text Explorer(
    Text Columns( :Reasons Not to Floss ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Text Explorer(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Discriminant Analysis](#discriminant-analysis_1)

### [Associated Constructors](#associated-constructors_1)

#### [Discriminant Analysis](#discriminant-analysis_2)

**Syntax:** obj \<< Discriminant Analysis( Maximum Number of Terms( number ), Minimum Number of Terms( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number oc Singular Vectors( number ), Column( :column name ) )

**Description:** Predicts a classification of each document into a category of a specified response column using linear discriminant analysis of the document term matrix.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Discriminant Analysis(
    Maximum Number of Terms( 20 ),
    Minimum Term Frequency( 3 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 15 ),
    Column( :Floss )
);


```

### [Item Messages](#item-messages_1)

#### [Canonical Plot](#canonical-plot)

**Syntax:** obj \<< Canonical Plot( state=0|1, N Canon( number ) )

**Description:** Shows or hides a plot of the documents and group means in canonical space. Canonical space is the space that most separates the groups.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Discriminant Analysis(
    Maximum Number of Terms( 20 ),
    Minimum Term Frequency( 3 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 15 ),
    Column( :Floss )
);
obj2 << Canonical Plot( 1, N Canon( 3 ) );


```

#### [Remove](#remove)

**Syntax:** obj \<< Remove

**Description:** Removes the Discriminant Analysis report from the Text Explorer report window.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Discriminant Analysis(
    Maximum Number of Terms( 20 ),
    Minimum Term Frequency( 3 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 15 ),
    Column( :Floss )
);
Wait( 1 );
obj2 << Remove;


```

#### [Save Canonical Scores](#save-canonical-scores)

**Syntax:** obj \<< Save Canonical Scores( N Canon( number ) )

**Description:** Saves columns to the data table that contain the scores from canonical space for each observation. Canonical space is the space that most separates the groups.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Discriminant Analysis(
    Maximum Number of Terms( 20 ),
    Minimum Term Frequency( 3 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 15 ),
    Column( :Floss )
);
obj2 << Save Canonical Scores( N Canon( 3 ) );


```

#### [Save Probabilities](#save-probabilities)

**Syntax:** obj \<< Save Probabilities

**Description:** Saves a probability column to the data table for each response level as well as a column that contains the most likely response.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Discriminant Analysis(
    Maximum Number of Terms( 20 ),
    Minimum Term Frequency( 3 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 15 ),
    Column( :Floss )
);
obj2 << Save Probabilities;


```

#### [Save Probability Formulas](#save-probability-formulas)

**Syntax:** obj \<< Save Probability Formulas

**Description:** Saves formula columns to the data table for the prediction of the most likely response. These columns use the Text Score function to calculate the probability for each response level.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Discriminant Analysis(
    Maximum Number of Terms( 20 ),
    Minimum Term Frequency( 3 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 15 ),
    Column( :Floss )
);
obj2 << Save Probability Formulas;


```

## [LCA Analysis](#lca-analysis)

### [Associated Constructors](#associated-constructors_2)

#### [Latent Class Analysis](#latent-class-analysis_1)

**Syntax:** obj \<< Latent Class Analysis( Number of Clusters( number ), Maximum Number of Terms( number ), Minimum Term Frequency( number ) )

**Description:** Groups documents into clusters of similar documents using a latent class analysis on the binary weighted document term matrix.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);


```

### [Item Messages](#item-messages_2)

#### [Cluster Mixture Probabilities](#cluster-mixture-probabilities)

**Syntax:** obj \<< Cluster Mixture Probabilities( state=0|1 )

**Description:** Shows or hides a table of probabilities of an observation belonging to each cluster. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
Wait( 1 );
obj2 << Cluster Mixture Probabilities( 0 );


```

#### [Cluster Probabilities by Row](#cluster-probabilities-by-row)

**Syntax:** obj \<< Cluster Probabilities by Row( state=0|1 )

**Description:** Shows or hides the Mixture Probabilities table, which contains probabilities of cluster membership for each row. The Most Likely Cluster column indicates the cluster with the highest probability of membership for each row. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
Wait( 1 );
obj2 << Cluster Probabilities by row( 0 );


```

#### [Color by Cluster](#color-by-cluster)

**Syntax:** obj \<< Color by Cluster

**Description:** Colors each row in the data table according to its most likely cluster.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
obj2 << Color by Cluster;


```

#### [MDS Plot](#mds-plot)

**Syntax:** obj \<< MDS Plot( state=0|1 )

**Description:** Shows or hides a multidimensional scaling plot, which is a two-dimensional representation of the proximity of the clusters. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
Wait( 1 );
obj2 << MDS Plot( 0 );


```

#### [Remove](#remove_1)

**Syntax:** obj \<< Remove

**Description:** Removes the Latent Class Analysis report from the Text Explorer report.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
Wait( 1 );
obj2 << Remove;


```

#### [Rename Clusters](#rename-clusters)

**Syntax:** obj \<< Rename Clusters( "name1", "name2", ... )

**Description:** Enables you to add descriptive names for one or more of the clusters.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
Wait( 1 );
obj2 << Rename Clusters( "First", "Second", "Third", "Fourth", "Fifth" );


```

#### [Save Probabilities](#save-probabilities_1)

**Syntax:** obj \<< Save Probabilities

**Description:** Saves the probability of membership for a document to each cluster as a separate column in the data table.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
obj2 << Save Probabilities;


```

#### [Save Probability Formulas](#save-probability-formulas_1)

**Syntax:** obj \<< Save Probability Formulas

**Description:** Saves a formula column to the data table for each cluster as well as a formula column for the most likely cluster.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
obj2 << Save Probability Formulas;


```

#### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Latent Class Analysis( Set Random Seed( number ) )

**Description:** Sets a random seed for the analysis.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 ),
    Set Random Seed( 1234 )
);


```

#### [Term Probabilities by Cluster](#term-probabilities-by-cluster)

**Syntax:** obj \<< Term Probabilities by Cluster( state=0|1 )

**Description:** Shows or hides a table of terms with an estimate for each cluster. The estimate is the conditional probability that a document contains the term, given that the document belongs to a particular cluster. On by default.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
Wait( 1 );
obj2 << Term Probabilities by Cluster( 0 );


```

#### [Top Terms by Cluster](#top-terms-by-cluster)

**Syntax:** obj \<< Top Terms by Cluster( state=0|1 )

**Description:** Shows or hides a table of the ten terms with the highest scores in each cluster. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
Wait( 1 );
obj2 << Top Terms by Cluster( 0 );


```

#### [Word Clouds by Cluster](#word-clouds-by-cluster)

**Syntax:** obj \<< Word Clouds by Cluster( state=0|1 )

**Description:** Shows or hides a matrix of word clouds, one for each cluster.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Class Analysis(
    Number of Clusters( 5 ),
    Maximum Number of Terms( 10 ),
    Minimum Term Frequency( 2 )
);
obj2 << Word Clouds by Cluster( 1 );


```

## [SVD Analysis > Topic Analysis](#svd-analysis-topic-analysis)

### [Associated Constructors](#associated-constructors_3)

#### [Rotated SVD](#rotated-svd_1)

**Syntax:** obj \<< Topic Analysis( Number of Topics ( number ) ) obj \<< Rotated SVD( Number of Topics( number ) )

**Description:** Performs a varimax-rotated singular value decomposition of the document term matrix to produce groups of terms called topics.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );


```

#### [Topic Analysis](#topic-analysis_1)

**Syntax:** obj \<< Topic Analysis( Number of Topics ( number ) ) obj \<< Rotated SVD( Number of Topics( number ) )

**Description:** Performs a varimax-rotated singular value decomposition of the document term matrix to produce groups of terms called topics.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );


```

### [Item Messages](#item-messages_3)

#### [Remove](#remove_2)

**Syntax:** obj \<< Remove

**Description:** Removes the Topic Analysis report from the SVD report.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Wait( 1 );
obj3 << Remove;


```

#### [Rename Topics](#rename-topics)

**Syntax:** obj \<< Rename Topics

**Description:** Enables you to add descriptive names for one or more of the topics.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Wait( 1 );
obj3 << Rename Topics( "Too Busy", "Less Often", "Difficult", "Bed", "Week" );


```

#### [Rotation Matrix](#rotation-matrix)

**Syntax:** obj \<< Rotation Matrix( state=0|1 )

**Description:** Shows or hides a rotation matrix for the varimax rotation.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
obj3 << Rotation Matrix( 1 );
Report( obj )["Rotation Matrix"] << Close( 0 );


```

#### [Save Document Topic Vectors](#save-document-topic-vectors)

**Syntax:** obj \<< Save Document Topic Vectors

**Description:** Saves the singular vectors from the topic analysis to new columns in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
obj3 << Save Document Topic Vectors;


```

#### [Save Item Topic Vectors](#save-item-topic-vectors)

**Syntax:** obj \<< Save Item Topic Vectors

**Description:** Saves the topic vectors to a new Item Topic Scores data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
obj3 << Save Item Topic Vectors;


```

#### [Save Term Topic Vectors](#save-term-topic-vectors)

**Syntax:** obj \<< Save Term Topic Vectors

**Description:** Saves the topic vectors from the topic analysis as columns in a new data table. If a Term Table is already open, then the columns are saved to that data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
obj << Save Term Table;
obj3 << Save Term Topic Vectors;


```

#### [Save Topic Vector Formula](#save-topic-vector-formula)

**Syntax:** obj \<< Save Topic Vector Formula

**Description:** Saves a formula with the Vector modeling type that contains the rotated singular value decomposition to the data table. The resulting column uses the Text Score function.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
obj3 << Save Topic Vector Formula;


```

#### [Save Transaction Topic Vectors](#save-transaction-topic-vectors)

**Syntax:** obj \<< Save Transaction Topic Vectors

**Description:** Saves a user-specified number of singular vectors from the rotated singular value decomposition (topic vectors) to new columns in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
obj3 << Save Transaction Topic Vectors;


```

#### [Top Loadings by Topic](#top-loadings-by-topic)

**Syntax:** obj \<< Top Loadings by Topic( state=0|1 )

**Description:** Shows or hides the Top Loadings by Topic report, which contains a table of terms for each topic. The terms in each table are the ones that have the largest loadings in absolute value for each topic. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Wait( 1 );
obj3 << Top Loadings by Topic( 0 );


```

#### [Topic Loadings](#topic-loadings)

**Syntax:** obj \<< Topic Loadings( state=0|1 )

**Description:** Shows or hides the Topic Loadings table, which contains a matrix of the loadings across topics for each term. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Report( obj )["Topic Loadings"] << Close( 0 );
Wait( 1 );
obj3 << Topic Loadings( 0 );


```

#### [Topic Scatterplot Matrix](#topic-scatterplot-matrix)

**Syntax:** obj \<< Topic Scatterplot Matrix( state=0|1 )

**Description:** Shows or hides a scatterplot matrix of the rotated singular value decomposition vectors.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Wait( 1 );
obj3 << Topic Scatterplot Matrix( 1 );


```

#### [Topic Scores](#topic-scores)

**Syntax:** obj \<< Topic Scores( state=0|1 )

**Description:** Shows or hides a matrix of scores across topics for each document. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Report( obj )["Topic Scores"] << Close( 0 );
Wait( 1 );
obj3 << Topic Scores( 0 );


```

#### [Topic Scores Plots](#topic-scores-plots)

**Syntax:** obj \<< Topic Scores Plots( state=0|1 )

**Description:** Shows or hides a report that contains a plot of topic scores for each document. On by default.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Report( obj )["Topic Scores Plots"] << Close( 0 );
Wait( 1 );
obj3 << Topic Scores Plots( 0 );


```

#### [Variance Explained by Each Topic](#variance-explained-by-each-topic)

**Syntax:** obj \<< Variance Explained by Each Topic( state=0|1 )

**Description:** Shows or hides a table that contains the variance that is explained by each topic. The table also includes columns of the percent and cumulative percent of the variation that is explained by each topic.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Wait( 1 );
obj3 << Variance Explained by Each Topic( 1 );
Report( obj )["Variance Explained by Each Topic"] << Close( 0 );


```

#### [Word Clouds by Topic](#word-clouds-by-topic)

**Syntax:** obj \<< Word Clouds by Topic( state=0|1 )

**Description:** Shows or hides a matrix of word clouds, one for each topic.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer(
    TextColumns( :Reasons Not to Floss ),
    Show Term List( 0 ),
    Show Phrase List( 0 ),
    Show Summary Counts( 0 )
);
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj3 = obj2 << Topic Analysis( Number of Topics( 5 ) );
Wait( 1 );
obj3 << Word Clouds by Topic( 1 );
Report( obj )["Word Clouds by Topic"] << Close( 0 );


```

## [SVD Analysis](#svd-analysis)

### [Associated Constructors](#associated-constructors_4)

#### [Latent Semantic Analysis](#latent-semantic-analysis_1)

**Syntax:** obj \<< Latent Semantic Analysis( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) ); obj \<< SVD( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) )

**Description:** Performs a sparse singular value decomposition of the document term matrix.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);


```

#### [SVD](#svd_1)

**Syntax:** obj \<< Latent Semantic Analysis( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) ); obj \<< SVD( Maximum Number of Terms( number ), Minimum Term Frequency( number ), Weighting( "Binary"|"Ternary"|"Frequency"|"Log Freq"|"TF IDF" ), Number of Singular Vectors( number ), Centering and Scaling( "Centered and Scaled",|"Centered"|"Uncentered" ) )

**Description:** Performs a sparse singular value decomposition of the document term matrix.

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);


```

### [Item Messages](#item-messages_4)

#### [Cluster Documents](#cluster-documents)

**Syntax:** obj \<< Cluster Documents( state=0|1 )

**Description:** Shows or hides a hierarchical clustering analysis of the documents in the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Cluster Documents( 1 );


```

#### [Cluster Items](#cluster-items)

**Syntax:** obj \<< Cluster Items( state=0|1 )

**Description:** Shows or hides a hierarchical clustering analysis of the terms in the data.

**JMP Version Added:** 14

```


dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj2 = obj << SVD( Number of Singular Vectors( 20 ) );
obj2 << Cluster Items( 1 );


```

#### [Cluster Terms](#cluster-terms)

**Syntax:** obj \<< Cluster Terms( state=0|1 )

**Description:** Shows or hides a hierarchical clustering analysis of the terms in the data.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << obj << Cluster Terms( 1 );


```

#### [Cluster Transactions](#cluster-transactions)

**Syntax:** obj \<< Cluster Transactions( state=0|1 )

**Description:** Shows or hides a hierarchical clustering analysis of the documents in the data.

**JMP Version Added:** 14

```


dt = Open( "$SAMPLE_DATA\Grocery Purchases.jmp" );
obj = dt << Association Analysis( Item( :Product ), ID( :Customer ID ) );
obj2 = obj << SVD( Number of Singular Vectors( 20 ) );
obj2 << Cluster Transactions( 1 );


```

#### [Remove](#remove_3)

**Syntax:** obj \<< Remove

**Description:** Removes the SVD report from the Text Explorer report window.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
Wait( 1 );
obj2 << Remove;


```

#### [Rotated SVD](#rotated-svd_2)

**Syntax:** obj \<< Topic Analysis( Number of Topics ( number ) ) obj \<< Rotated SVD( Number of Topics( number ) )

**Description:** Performs a varimax-rotated singular value decomposition of the document term matrix to produce groups of terms called topics.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj << Show Term List( 0 );
obj << Show Phrase List( 0 );
obj << Show Summary Counts( 0 );
obj2 << Topic Analysis( Number of Topics( 5 ) );


```

#### [SVD Scatterplot Matrix](#svd-scatterplot-matrix)

**Syntax:** obj \<< SVD Scatterplot Matrix( state=0|1, Number of Vectors( number ) )

**Description:** Shows or hides a scatterplot matrix of the term and document singular value decomposition vectors for each SVD Plot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << SVD Scatterplot Matrix( 1, Number of Vectors( 8 ) );


```

#### [Save Document Singular Vectors](#save-document-singular-vectors)

**Syntax:** obj \<< Save Document Singular Vectors(number)

**Description:** Saves the specified number of singular vectors from the document singular value decomposition to new columns in the data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Save Document Singular Vectors( 5 );


```

#### [Save Item SVD](#save-item-svd)

**Syntax:** obj \<< Save Item SVD

**Description:** Creates a data table that contains a number of singular vectors that you specify for each item. These are the right singular values in the transaction item matrix.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Save Item SVD( 5 );


```

#### [Save Item Singular Vectors](#save-item-singular-vectors)

**Syntax:** obj \<< Save Item Singular Vectors

**Description:** Creates a data table that contains a number of singular vectors that you specify for each item. These are the right singular values in the transaction item matrix.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Save Item Singular Vectors( 5 );


```

#### [Save Singular Vector Formula](#save-singular-vector-formula)

**Syntax:** obj \<< Save Singular Vector Formula

**Description:** Saves a vector-valued formula column that contains the document singular value decomposition to the data table. The formula column uses the Text Score function.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Save Singular Vector Formula;


```

#### [Save Term Singular Vectors](#save-term-singular-vectors)

**Syntax:** obj \<< Save Term Singular Vectors( number )

**Description:** Saves the specified number of singular vectors from the terms singular value decomposition as columns in a new data table. Each row corresponds to a term. If a Term Table is already open, then the columns are saved to that data table.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Save Term Singular Vectors( 5 );


```

#### [Save Transaction SVD](#save-transaction-svd)

**Syntax:** obj \<< Save Transaction SVD

**Description:** Creates a data table that contains a number of singular vectors that you specify for each transaction. These are the left singular values in the transaction item matrix.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Save Transaction SVD( 5 );


```

#### [Save Transaction Singular Vectors](#save-transaction-singular-vectors)

**Syntax:** obj \<< Save Transaction Singular Vectors

**Description:** Creates a data table that contains a number of singular vectors that you specify for each transaction. These are the left singular values in the transaction item matrix.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj2 << Save Transaction Singular Vectors( 5 );


```

#### [Select Near Neighbors](#select-near-neighbors)

**Syntax:** obj \<< Select Near Neighbors( number=10 )

**Description:** Finds and selects the k nearest neighbors of the selected points in the document SVD plot. "10" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
dt << Select Rows( [102, 237] );
obj2 << Select Near Neighbors( 8 );


```

#### [Topic Analysis](#topic-analysis_2)

**Syntax:** obj \<< Topic Analysis( Number of Topics ( number ) ) obj \<< Rotated SVD( Number of Topics( number ) )

**Description:** Performs a varimax-rotated singular value decomposition of the document term matrix to produce groups of terms called topics.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = Text Explorer( TextColumns( :Reasons Not to Floss ) );
obj2 = obj << Latent Semantic Analysis(
    Maximum Number of Terms( 100 ),
    Minimum Term Frequency( 4 ),
    Weighting( "TF IDF" ),
    Number of Singular Vectors( 50 ),
    Centering and Scaling( "Centered" )
);
obj << Show Term List( 0 );
obj << Show Phrase List( 0 );
obj << Show Summary Counts( 0 );
obj2 << Topic Analysis( Number of Topics( 5 ) );


```

## [Sentiment Analysis](#sentiment-analysis_1)

### [Associated Constructors](#associated-constructors_5)

#### [Sentiment Analysis](#sentiment-analysis_2)

**Syntax:** Sentiment Analysis( state=0|1 )

**Description:** Identifies sentiment terms in documents using lexical analysis and scores documents for positive, negative, and overall sentiment.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );


```

### [Item Messages](#item-messages_5)

#### [Add Feature Words](#add-feature-words)

**Syntax:** obj \<< Add Feature Words( list )

**Description:** Adds a list of words to be scored as features.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
sent << Add Feature Words( {"floss"} );


```

#### [Add Intensifier Exception Words](#add-intensifier-exception-words)

**Syntax:** obj \<< Add Intensifier Exception Words( list )

**Description:** Adds a list of intensifier terms to remove from the analysis.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Add Intensifier Exception Words( {"almost"} );


```

#### [Add Intensifier Words](#add-intensifier-words)

**Syntax:** obj \<< Add Intensifier Words( {{\<word, multiplier>}, {<word>, <multiplier>}, ... } )

**Description:** Adds a list of words to use as intensifier terms in the analysis. Multipliers are floating point numbers usually in the range [-2, 2].

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Add Intensifier Words( {{"extreme", 1.8}, {"extremely", 1.8}} );


```

#### [Add Negation Exception Words](#add-negation-exception-words)

**Syntax:** obj \<< Add Negation Exception Words( list )

**Description:** Adds a list of negation terms to remove from the analysis.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Add Negation Exception Words( {"without"} );


```

#### [Add Negation Words](#add-negation-words)

**Syntax:** obj \<< Add Negation Words( list )

**Description:** Adds a list of words to use as negation terms in the analysis.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Add Negation Words( {"dont"} );


```

#### [Add Sentiment Exception Words](#add-sentiment-exception-words)

**Syntax:** obj \<< Add Sentiment Exception Words( list )

**Description:** Adds a list of sentiment terms to remove from the analysis.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Add Sentiment Exception Words( {"easy"} );


```

#### [Add Sentiment Words](#add-sentiment-words)

**Syntax:** obj \<< Add Sentiment Words( {{<word>, <score>}, {<word>, <score>}, ... } )

**Description:** Adds a list of words to use as sentiment terms in the analysis. Scores are integers in the range [-100, 100].

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Add Sentiment Words( {{"difficult", -70}, {"necessary", -20}} );


```

#### [Include Builtin Intensifier Terms](#include-builtin-intensifier-terms)

**Syntax:** obj \<< Include Builtin Intensifier Terms( state=0|1 )

**Description:** Specifies that the built-in intensifier terms are included in the intensifier terms that are used in the sentiment analysis. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Include Builtin Intensifier Terms( 0 );


```

#### [Include Builtin Negation Terms](#include-builtin-negation-terms)

**Syntax:** obj \<< Include Builtin Negation Terms( state=0|1 )

**Description:** Specifies that the built-in negation terms are included in the negation terms that are used for the sentiment analysis. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Include Builtin Negation Terms( 0 );


```

#### [Include Builtin Sentiment Terms](#include-builtin-sentiment-terms)

**Syntax:** obj \<< Include Builtin Sentiment Terms( state=0|1 )

**Description:** Specifies that the built-in sentiment terms are included in the sentiment terms that are used in the sentiment analysis. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Include Builtin Sentiment Terms( 0 );


```

#### [Parse Documents](#parse-documents)

**Syntax:** obj \<< Parse Documents( state=0|1 )

**Description:** Specifies that natural language processing (NLP) is used to parse the documents. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Parse Documents( 0 );


```

#### [Save Count of Sentiment Scores by Document](#save-count-of-sentiment-scores-by-document)

**Syntax:** obj \<< Save Count of Sentiment Scores by Document

**Description:** Saves a column to the data table for each sentiment term. Each column contains counts of the occurrences of each sentiment term in each document.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
sent << Save Count of Sentiment Scores by Document;


```

#### [Save Document Scores](#save-document-scores)

**Syntax:** obj \<< Save Document Scores

**Description:** Saves the document scores to new columns in the data table.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
sent << Save Document Scores;


```

#### [Score Column](#score-column)

**Syntax:** obj \<< Score Column( column )

**Description:** Specifies a column that contains known information to compare with the calculated sentiment.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
sent << Score Column( :Gender );


```

#### [Scoring](#scoring)

**Syntax:** obj \<< Scoring( "Scaled"|"Min Max" )

**Description:** Sets the scoring style to calculate the overall score for documents. The Scaled option sums the scores of positive and negative phrases and then divides the sum by the number of phrases. The Min Max option is calculated as the sum of the maximum positive score and the minimum negative score.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Wait( 1 );
sent << Scoring( "Min Max" );


```

#### [Show Feature Finder](#show-feature-finder)

**Syntax:** obj \<< Show Feature Finder( state=0|1 )

**Description:** Shows or hides a report that enables you to slice sentiment by selected features. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Report( obj )["Features"] << Close( 0 );
Wait( 2 );
sent << Show Feature Finder( 0 );


```

#### [Show Intensifier Terms](#show-intensifier-terms)

**Syntax:** obj \<< Show Intensifier Terms( state=0|1 )

**Description:** Shows or hides the table of intensifier terms. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Report( obj )["Intensifier Terms"] << Close( 0 );
Wait( 2 );
sent << Show Intensifier Terms( 0 );


```

#### [Show Negation Terms](#show-negation-terms)

**Syntax:** obj \<< Show Negation Terms( state=0|1 )

**Description:** Shows or hides the table of negation terms. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Report( obj )["Negation Terms"] << Close( 0 );
Wait( 2 );
sent << Show Negation Terms( 0 );


```

#### [Show Sentiment Cloud](#show-sentiment-cloud)

**Syntax:** obj \<< Show Sentiment Cloud( state=0|1 )

**Description:** Shows or hides the word cloud of sentiment phrases.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
sent << Show Sentiment Cloud( 1 );


```

#### [Show Sentiment Terms](#show-sentiment-terms)

**Syntax:** obj \<< Show Sentiment Terms( state=0|1 )

**Description:** Shows or hides the table of sentiment terms. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
sent = obj << Sentiment Analysis( 1 );
Report( obj )["Sentiment Terms"] << Close( 0 );
Wait( 2 );
sent << Show Sentiment Terms( 0 );


```

## [Term Selection](#term-selection_1)

### [Associated Constructors](#associated-constructors_6)

#### [Term Selection](#term-selection_2)

**Syntax:** obj \<< Term Selection( Models( Model( Response Column( <column> ), <other models> )), Model Choice( <index> ))

**Description:** Analyzes which terms best explain different responses. Term selection is also useful for sentiment analysis when the responses are ratings.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);


```

### [Item Messages](#item-messages_6)

#### [Model Choice](#model-choice)

**Syntax:** obj \<< Term Selection( Model Choice(<index>) )

**Description:** Specifies which model is the current model for the summary area.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);


```

#### [Models](#models)

**Syntax:** obj \<< Term Selection( Models( Model( Response Column( <column> ), <other models> )))

**Description:** Specifies information that is necessary to generate a model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);


```

#### [Remove](#remove_4)

**Syntax:** obj \<< Remove

**Description:** Removes the Term Selection report from the Text Explorer report window.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);
Wait( 1 );
term << Remove;


```

#### [Save Document Scores](#save-document-scores_1)

**Syntax:** obj \<< Save Document Scores

**Description:** Saves the document scores to new columns in the data table.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);
term << Save Document Scores;


```

#### [Save Prediction Formulas](#save-prediction-formulas)

**Syntax:** obj \<< Save Prediction Formulas

**Description:** Saves columns to the data table that contain the prediction formulas for the currently selected analysis.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);
term << Save Prediction Formulas;


```

#### [Save Term Score DTM](#save-term-score-dtm)

**Syntax:** obj \<< Save Term Score DTM

**Description:** Saves columns to the data table for each relevant term in the currently selected analysis.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);
term << Save Term Score DTM;


```

#### [Show Term Cloud](#show-term-cloud)

**Syntax:** obj \<< Show Term Cloud( state=0|1 )

**Description:** Shows or hides a word cloud of the coefficient terms.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
obj = dt << Text Explorer( Text Columns( :Reasons Not to Floss ), Language( "English" ) );
term = obj << Term Selection(
    Models(
        Model(
            Response Column( :Gender ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Elastic Net ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Model(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) ),
            Fits(
                First Fit(
                    Fit(
                        Estimation Method( Lasso ),
                        Validation Method( AICc ),
                        Early Stopping,
                        Model Summary( 0 ),
                        Parameter Estimates for Original Predictors( 0 ),
                        Effect Tests( 0 )
                    )
                )
            )
        ),
        Current Model Settings(
            Response Column( :Single Status ),
            Target Levels( Target Number( 1 ), Target String( "1" ) ),
            Fit Settings( Estimation Method( Lasso ) )
        )
    ),
    Model Choice( 2 )
);
term << Show Term Cloud;


```

# [Time Series Forecast](#time-series-forecast)

## [Associated Constructors](#associated-constructors)

### [Time Series Forecast](#time-series-forecast_1)

**Syntax:** Time Series Forecast( Y( column ) )

**Description:** Fits and forecasts multiple time series using specified methods.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );


```

## [Columns](#columns)

### [Grouping](#grouping)

**Syntax:** obj \<< Grouping( column(s) )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );


```

### [Time](#time)

**Syntax:** obj \<< Time( column )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );


```

## [Item Messages](#item-messages)

### [Save Results](#save-results)

**Syntax:** obj \<< Save Results

**Description:** Save Results.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast(
    Y( :Y ),
    Grouping( :Series ),
    Time( :Time ),
    Fit Model(
        NAhead( 4 ),
        Period( 4 ),
        Other Options(
            Preserve Model Selection Criterion( 0 ),
            Forecast Interval Level( 0.95 ),
            Imputation for Applicable Models( "None" )
        )
    ),
    Save Results(
        Save Forecast Intervals( 1 ),
        "Save One-Step-Ahead Predictions"n( 1 ),
        Save Original Series( 1 ),
        Save Forecast Results to Original Table( 0 ),
        Forecast Interval Level( .90 ),
        NAhead( 100 )
    )
);


```

### [Set Forecast Interval Level](#set-forecast-interval-level)

**Syntax:** obj \<< Set Forecast Interval Level

**Description:** Set Forecast Interval Level.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast(
    Y( :Y ),
    Grouping( :Series ),
    Time( :Time ),
    Fit Model(
        NAhead( 4 ),
        Period( 4 ),
        Other Options(
            Preserve Model Selection Criterion( 0 ),
            Forecast Interval Level( 0.95 ),
            Imputation for Applicable Models( "None" )
        )
    ),
    Set Forecast Interval Level( .9 )
);


```

### [Set NAhead](#set-nahead)

**Syntax:** obj \<< Set NAhead

**Description:** Set NAhead.

**JMP Version Added:** 15

```


dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast(
    Y( :Y ),
    Grouping( :Series ),
    Time( :Time ),
    Fit Model(
        NAhead( 4 ),
        Period( 4 ),
        Other Options(
            Preserve Model Selection Criterion( 0 ),
            Forecast Interval Level( 0.95 ),
            Imputation for Applicable Models( "None" )
        )
    ),
    Set NAhead( 10 )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Report View( "Summary" );


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series Forecast(
    Y( :Y ),
    Grouping( :Series ),
    Time( :Time ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series Forecast(
    Y( :Y ),
    Grouping( :Series ),
    Time( :Time ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Time Series/M3C Quarterly.jmp" );
obj = dt << Time Series Forecast( Y( :Y ), Grouping( :Series ), Time( :Time ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

# [Time Series](#time-series)

## [ARIMA](#arima)

### [Item Messages](#item-messages)

#### [Actual](#actual)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

## [Associated Constructors](#associated-constructors)

### [Time Series](#time-series_1)

**Syntax:** Time Series( Y( column ) )

**Description:** Models a series of observations over equally spaced time points. Includes a time series plot, autocorrelations, variogram, spectral density, ARIMA, seasonal ARIMA, smoothing models, and forecasts.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Input List](#input-list)

**Syntax:** obj \<< Input List( column(s) )

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );


```

### [Time ID](#time-id)

**Syntax:** obj \<< Time ID( column )

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );


```

### [X](#x)

**Syntax:** obj \<< X( column )

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );


```

## [Item Messages](#item-messages_1)

### [AR Coefficients](#ar-coefficients)

**Syntax:** obj \<< AR Coefficients( state=0|1 )

**Description:** Displays or hides the autocorrelation coefficient plot.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << AR Coefficients( 1 );


```

### [ARIMA](#arima_1)

**Syntax:** obj \<< ARIMA( p, d, q, \<No Intercept( 0|1 )>, \<No Constrain( 0|1 )>, \<Confidence Intervals( level )> )

**Description:** Fits an ARIMA model. Set order p,d, and q for an ARIMA(p,d,q) model. Set level for values other than 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
obj << arima( 1, 0, 0, No Intercept( 1 ), No Constrain( 1 ), Confidence Intervals( 0.99 ) );


```

### [ARIMA Model Group](#arima-model-group)

**Syntax:** obj \<< ARIMA Model Group( AR(p0,p1),Diff(d0,d1),MA(q0,q1),Seasonal AR(P0,P1),Seasonal Diff(D0,D1),Seasonal MA(Q0,Q1),Seasonal Period(S0,S1),Confidence Intervals(C),Intercept(1),Constrain fit(1) )

**Description:** Fit a set of ARIMA models whose orders are in specified ranges.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << ARIMA Model Group( AR( 0, 2 ), MA( 0, 2 ) );


```

### [Autocorrelation](#autocorrelation)

**Syntax:** obj \<< Autocorrelation( state=0|1 )

**Description:** Displays or hides the autocorrelation plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Autocorrelation( 1 );


```

### [Autocorrelation Lags](#autocorrelation-lags)

**Syntax:** obj = Time Series(...Autocorrelation Lags( number=25 )...)

**Description:** Set launch option for the maximum number of periods between points used in computing autocorrelations. "25" by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ), Autocorrelation Lags( 10 ) );


```

### [Combine and Save Forecasts from Models](#combine-and-save-forecasts-from-models)

**Syntax:** obj \<< Combine and Save Forecasts from Models

**Description:** Creates a new data table with the combined results from all model fits in the report.

**JMP Version Added:** 16

### [Connecting Lines](#connecting-lines)

**Syntax:** obj \<< Connecting Lines( state=0|1 )

**Description:** Displays or hides connected lines in the basic time series plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Connecting Lines( 1 );


```

### [Cross Correlation](#cross-correlation)

**Syntax:** obj \<< Cross Correlation( state=0|1 )

**Description:** Displays or hides the cross correlation plot.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = dt << Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Cross Correlation( 1 );


```

### [Damped-Trend Linear Exponential Smoothing](#damped-trend-linear-exponential-smoothing)

**Syntax:** obj \<< Damped-Trend Linear Exponential Smoothing( Zero to One|Unconstrained|Stable Invertible|Custom( (Damping|Level)( Unconstrained| Bounded( lower, upper )| Fixed( value ) )), \<Confidence Intervals(level)> )

**Description:** Fits a damped trend smoothing model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
Time Series(
    Y( :Steel Shipments ),
    "Damped-Trend Linear Exponential Smoothing"n( Zero to One )
);


```

### [Difference](#difference)

**Syntax:** obj \<< Difference( d, <D>, <S> )

**Description:** Computes the differenced series and produces graphs of the autocorrelations and partial autocorrelations of the differenced series. The differenced series is given by (1-B)^d * (1-B^S)^D * y_t , where y_t is the time series, B is the backshift operator defined by B * y_t = y\_(t-1), d is the nonseasonal differencing order, D is the seasonal differencing order, and S is the number of observations per period.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Difference( 1 );
obj << Difference( 1, 1, 12 );


```

### [Double Exponential Smoothing](#double-exponential-smoothing)

**Syntax:** obj \<< Double Exponential Smoothing( Zero to One|Unconstrained|Stable Invertible|Custom( Level( Unconstrained| Bounded( lower, upper )| Fixed( value ) )), \<Confidence Intervals(level)> )

**Description:** Invoke fitting a double exponential smoothing model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
Time Series(
    Y( :Steel Shipments ),
    Double Exponential Smoothing( Zero to One ),
    Double Exponential Smoothing( Unconstrained ),
    Double Exponential Smoothing( Stable Invertible ),
    Double Exponential Smoothing( Custom( Level( Bounded( 0.8, 1 ) ) ) ),
    Double Exponential Smoothing( Custom( Level( Fixed( 0 ) ) ) ),
    Double Exponential Smoothing( Custom( Level( Unconstrained ) ) )
);


```

### [Fit Recommended ETS](#fit-recommended-ets)

**Syntax:** obj \<< Fit Recommended ETS( Period( m ),Constrained( "Yes"|"No" ) )

**Description:** Fits all recommended state space smoothing models.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Time Series/Seriesg.jmp" );
obj = dt << Time Series( Y( :Passengers ) );
obj << Fit Recommended ETS( Period( 12 ), Constrained( "Yes" ) );


```

### [Forecast Periods](#forecast-periods)

**Syntax:** obj = Time Series(...Forecast Periods( number=25 )...)

**Description:** Set launch option for the number of steps ahead in forecasting report. "25" by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ), Forecast Periods( 10 ) );
obj << ARIMA( 1, 0, 0 );


```

### [Forecast on Holdback](#forecast-on-holdback)

**Syntax:** obj = Time Series(...Forecast on Holdback( state=0|1 )...)

**Description:** Determines whether the forecasts are made on future observations or on the holdback observations. If this option is selected, the forecasts are made on the holdback set that is determined by the number specified in the Forecast Periods option.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ), Forecast on Holdback( 1 ) );
obj << arima( 1, 0, 0 );
obj << Number of Forecast Periods( 100 );


```

### [Generate Simulation](#generate-simulation)

**Syntax:** obj \<< Generate Simulation( id, seed, length, n )

**Description:** Generates a data table of multiple future trajectories of a fitted model. Returns the table reference.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
dt = obj << Generate Simulation( 1, 11111, 100, 5 );


```

### [Get Model Specs](#get-model-specs)

**Syntax:** obj \<< Get Model Specs

**Description:** Returns a named list of model results, each of which is named by model specification. Included in the output are estimates and standard errors. Available for ARIMA, Seasonal ARIMA, all smoothing models and Transfer Function Models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Seriesg.jmp" );
obj = dt << Time Series( Y( :Log Passengers ) );
obj << Seasonal ARIMA( 0, 1, 1, 0, 1, 1, 12, No Intercept( 1 ) );
l = obj << Get Model Specs;
Show( l );


```

### [Get Models](#get-models)

**Syntax:** obj \<< Get Models

**Description:** Returns a named list of model results, each of which is named by model descriptions. Included in the output are estimates and standard errors. Available for ARIMA, Seasonal ARIMA, all smoothing models and Transfer Function Models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Seriesg.jmp" );
obj = dt << Time Series( Y( :Log Passengers ) );
obj << Seasonal ARIMA( 0, 1, 1, 0, 1, 1, 12, No Intercept( 1 ) );
l = obj << Get Models;
Show( l );


```

### [Hide All Reports](#hide-all-reports)

**Syntax:** obj \<< Hide All Reports

**Description:** Hides all of the models that are listed in the Model Comparison table from the report window.

```

dt = Open( "$SAMPLE_DATA/Time Series/Seriesg.jmp" );
obj = dt << Time Series( Y( :Passengers ) );
obj << Fit Recommended ETS( Period( 12 ), Constrained( "Yes" ) );
obj << Hide All Model Reports;


```

### [Input Series](#input-series)

**Syntax:** obj \<< Input Series( Column, \<ARIMA( )>| \<Prewhitening( )> ... )

**Description:** Groups messages sent to the input series. Note: requires an Input List variable be specified.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = dt << Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Input Series( :Input Gas Rate, ARIMA( 1, 0, 0 ) );


```

### [Keep Best Models](#keep-best-models)

**Syntax:** obj \<< Keep Best Models( "AIC"|"SBC" )

**Description:** Retains the best models among individual model classes and removes the remaining models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Seriesg.jmp" );
obj = dt << Time Series( Y( :Passengers ) );
obj << Fit Recommended ETS( Period( 12 ), Constrained( "Yes" ) );
Wait( 1 );
obj << Keep Best Models( "AIC" );


```

### [Lambda for Box-Cox](#lambda-for-box-cox)

**Syntax:** obj = Time Series(...Lambda for Box-Cox( number=0 )...)

**Description:** Specifies the lambda parameter used for the Box-Cox transformation of the original data. "0" by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series(
    Y( :Steel Shipments ),
    Name( "Use Box-Cox Transformation" )(1),
    Name( "Lambda for Box-Cox" )(0)
);
obj << arima( 1, 0, 0 );
obj << Number of Forecast Periods( 100 );


```

### [Linear Exponential Smoothing](#linear-exponential-smoothing)

**Syntax:** obj \<< Linear Exponential Smoothing( Zero to One|Unconstrained|Stable Invertible|Custom( (Trend|Level)( Unconstrained| Bounded( lower, upper )| Fixed( value ) )), \<Confidence Intervals(level)> )

**Description:** Fits a linear exponential smoothing model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
Time Series(
    Y( :Steel Shipments ),
    Linear Exponential Smoothing( Zero to One ),
    Linear Exponential Smoothing( Unconstrained ),
    Linear Exponential Smoothing( Stable Invertible ),
    Linear Exponential Smoothing(
        Custom( Level( Bounded( 0.8, 1 ) ), Trend( Bounded( 0.7, 0.9 ) ) )
    ),
    Linear Exponential Smoothing( Custom( Level( Fixed( 0 ) ), Trend( Fixed( .3 ) ) ) ),
    Linear Exponential Smoothing( Custom( Level( Unconstrained ), Trend( Fixed( .4 ) ) ) )
);


```

### [Maximum Iterations](#maximum-iterations)

**Syntax:** obj \<< Maximum Iterations( maxIter=250 )

**Description:** Reset the maximum number of iterations for future optimizations used in ARIMA model fitting. "250" by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Maximum Iterations( 2 );
obj << ARIMA( 1, 0, 0 );


```

### [Mean Line](#mean-line)

**Syntax:** obj \<< Mean Line( state=0|1 )

**Description:** Displays or hides the mean line in the basic time series plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Mean Line( 1 );


```

### [Model Comparison Report](#model-comparison-report)

**Syntax:** obj \<< Model Comparison Report

**Description:** Configures the Model Comparison report settings.

### [Number of Forecast Periods](#number-of-forecast-periods)

**Syntax:** obj \<< Number of Forecast Periods( number )

**Description:** Resets the number of forecast periods and updates the forecasting report.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
obj << Number of Forecast Periods( 100 );


```

### [Partial Autocorrelation](#partial-autocorrelation)

**Syntax:** obj \<< Partial Autocorrelation( state=0|1 )

**Description:** Displays or hides the partial autocorrelation plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Partial Autocorrelation( 1 );


```

### [Prewhitening](#prewhitening)

**Syntax:** obj \<< Prewhitening( Order(p, d, q), Seasonal(P, D, Q, S) )

**Description:** Sets the prewhitening order.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = dt << Time Series(
    Y( :Output CO2 ),
    Input List( :Input Gas Rate ),
    Input Series(
        :Input Gas Rate,
        Prewhitening( Order( 1, 0, 0 ), Seasonal( 0, 0, 0, 12 ) )
    )
);


```

### [Remove All Simulation](#remove-all-simulation)

**Syntax:** obj \<< Remove All Simulation

**Description:** Removes all simulated future trajectories.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
obj << arima( 2, 0, 0 );
obj << Simulate More( 1, 2 );
obj << Simulate More( 2, 3 );
obj << Remove All Simulation;


```

### [Remove Cycle](#remove-cycle)

**Syntax:** obj \<< Remove Cycle( Units per Cycle( number ), Has Constant( 0|1 ) )

**Description:** Estimates the cyclic component using a cosine function and then removes it from the data.

```

dt = Open( "$SAMPLE_DATA/Time Series/Monthly Sales.jmp" );
obj = dt << Time Series( Y( :Sales ) );
obj << Remove Cycle( Units per Cycle( 12 ), Has Constant( 1 ) );


```

### [Remove Fit](#remove-fit_1)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

### [Remove Linear Trend](#remove-linear-trend)

**Syntax:** obj \<< Remove Linear Trend

**Description:** Estimates the linear trend and then removes it from the data.

```

dt = Open( "$SAMPLE_DATA/Time Series/Monthly Sales.jmp" );
obj = dt << Time Series( Y( :Sales ) );
obj << Remove Linear Trend;


```

### [Remove Model Simulation](#remove-model-simulation)

**Syntax:** obj \<< Remove Model Simulation( id )

**Description:** Removes simulated future trajectories of a fitted model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
obj << arima( 2, 0, 0 );
obj << Simulate More( 1, 2 );
obj << Simulate More( 2, 3 );
obj << Remove Model Simulation( 1 );


```

### [Save Spectral Density](#save-spectral-density)

**Syntax:** obj \<< Save Spectral Density

**Description:** Save spectral density to a table.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Save Spectral Density;


```

### [Seasonal ARIMA](#seasonal-arima)

**Syntax:** obj \<< Seasonal ARIMA( p, d, q, P, D, Q, S, \<No Intercept( 0|1 )>, \<No Constrain( 0|1 )>, \<Confidence Intervals( level )> )

**Description:** Fits a seasonal ARIMA model. Set order p,d,q,P,D,Q,and S for an ARIMA(p,d,q)(P,D,Q)S model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << seasonal arima( 1, 0, 0, 1, 0, 0, 12 );
obj << seasonal arima(
    1,
    0,
    0,
    1,
    0,
    0,
    12,
    No Intercept( 1 ),
    No Constrain( 1 ),
    Confidence Intervals( 0.99 )
);


```

### [Seasonal Exponential Smoothing](#seasonal-exponential-smoothing)

**Syntax:** obj \<< Seasonal Exponential Smoothing( Zero to One|Unconstrained|Custom( (Level| Seasonal)( Unconstrained| Bounded( lower, upper )| Fixed( value ) )), \<Confidence Intervals(level)> )

**Description:** Fits a seasonal exponential smoothing model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
Time Series(
    Y( :Steel Shipments ),
    Seasonal Exponential Smoothing(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Seasonal( Bounded( 0, 1 ) ) )
    )
);


```

### [Set Seed](#set-seed)

**Syntax:** obj \<< Set Seed( seed )

**Description:** Sets random seed.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
obj << Set Seed( 1111 );
obj << Simulate Once( 1 );
obj << Set Seed( 1111 );
obj << Simulate Once( 1 );


```

### [Show Box-Cox Transformation Plot](#show-box-cox-transformation-plot)

**Syntax:** obj \<< Show Box-Cox Transformation Plot( state=0|1 )

**JMP Version Added:** 16

### [Show Lag Plot](#show-lag-plot)

**Syntax:** obj \<< Show Lag Plot( state=0|1 )

### [Show Points](#show-points_1)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Displays or hides points in the basic time series plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Show Points( 1 );


```

### [Simple Exponential Smoothing](#simple-exponential-smoothing)

**Syntax:** obj \<< Simple Exponential Smoothing( Zero to One|Unconstrained|Stable Invertible|Custom( Level( Unconstrained| Bounded( lower, upper )| Fixed( value ) )), \<Confidence Intervals(level)> )

**Description:** Fits a simple exponential smoothing model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
Time Series(
    Y( :Steel Shipments ),
    Simple Exponential Smoothing( Zero to One ),
    Simple Exponential Smoothing( Unconstrained ),
    Simple Exponential Smoothing( Stable Invertible ),
    Simple Exponential Smoothing( Custom( Level( Bounded( 0.8, 1 ) ) ) ),
    Simple Exponential Smoothing( Custom( Level( Fixed( 0 ) ) ) ),
    Simple Exponential Smoothing( Custom( Level( Unconstrained ) ) )
);


```

### [Simple Moving Average](#simple-moving-average)

**Syntax:** obj \<< Simple Moving Average

**Description:** Invoke a simple moving average specification dialog and fit a model, if there are no additional arguments. Pass arguments to the simple moving average model scriptable. Return value is the simple moving average model scriptable handle. See Simple Moving Average scriptable for arguments details.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
obj = dt << Time Series( Y( :Close ) );
sma = obj << Simple Moving Average;
sma << Add Model( 10 );


```

### [Simple Moving Average Centering Method](#simple-moving-average-centering-method)

**Syntax:** obj \<< Simple Moving Average Centering Method( "No Centering"|"Centered"|"Centered and Double Smoothed for Even Number of Terms" )

### [Simulate More](#simulate-more)

**Syntax:** obj \<< Simulate More( id, n )

**Description:** Simulates multiple future trajectories of a fitted model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
obj << arima( 2, 0, 0 );
obj << Simulate More( 1, 2 );
obj << Simulate More( 2, 3 );


```

### [Simulate Once](#simulate-once)

**Syntax:** obj \<< Simulate Once( id )

**Description:** Simulates one future trajectory of a fitted model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << arima( 1, 0, 0 );
obj << arima( 2, 0, 0 );
obj << Simulate Once( 1 );
obj << Simulate Once( 2 );


```

### [Spectral Density](#spectral-density)

**Syntax:** obj \<< Spectral Density( state=0|1 )

**Description:** Displays or hides the spectral density graphs.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Spectral Density( 1 );


```

### [State Space Smoothing](#state-space-smoothing)

**Syntax:** obj \<< State Space Smoothing( Error Type( "Additive"|"Multiplicative" ),Trend Type( "None"|"Additive"|"Multiplicative" ),Seasonal Type( "None"|"Additive"|"Multiplicative" ),Damped( "Yes"|"No" ),Period( m ),Constrained( "Yes"|"No" ) )

**Description:** Fits a state space smoothing model.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Time Series/Seriesg.jmp" );
obj = dt << Time Series( Y( :Passengers ) );
obj << State Space Smoothing(
    Error Type( "Multiplicative" ),
    Trend Type( "Additive" ),
    Seasonal Type( "Multiplicative" ),
    Damped( "No" ),
    Period( 12 ),
    Constrained( "Yes" )
);


```

### [Time Series Graph](#time-series-graph)

**Syntax:** obj \<< Time Series Graph( state=0|1 )

**Description:** Turn on or off the basic time series plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Time Series Graph( 1 );


```

### [Transfer Function](#transfer-function)

**Syntax:** obj \<< Transfer Function( Order(p, d, q), Seasonal(P, D, Q, S), input1(Order(p, d, q), Seasonal(P, D, Q, S), Lag(lag)), \<input2(Order(p, d, q), Seasonal(P, D, Q, S), Lag(lag))>, ..., \<No Intercept(flag1)>, \<No Constrain(flag2)>, \<Alternative Parameterization( flag3 )>, \<Confidence Intervals( level )>, \<Number of Forecast Periods( nAhead )> )

**Description:** Fits a Transfer Function model.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = dt << Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) )
);
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    No Intercept( 1 ),
    Alternative Parameterization( 1 ),
    Confidence Intervals( 0.99 ),
    Number of Forecast Periods( 10 )
);


```

### [Use Box-Cox Transformation](#use-box-cox-transformation)

**Syntax:** obj = Time Series(...Use Box-Cox Transformation( state=0|1 )...)

**Description:** Transforms the original data using a Box-Cox transformation with the lambda that is specified in the Lambda for Box-Cox option. If this option is selected, all analyses in the Time Series report are performed on the transformed data.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ), Name( "Use Box-Cox Transformation" )(1) );
obj << arima( 1, 0, 0 );
obj << Number of Forecast Periods( 100 );


```

### [Variogram](#variogram_1)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the variogram plot in the Time Series Basic Diagnostics report.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :Steel Shipments ) );
obj << Variogram( 1 );


```

### [Winters Method](#winters-method)

**Syntax:** obj \<< Winters Method( Zero to One|Unconstrained|Custom( (Level|Seasonal|Trend)( Unconstrained| Seasonal| Bounded( lower, upper )| Fixed( value ) )), \<Confidence Intervals(level)> )

**Description:** Fits a smoothing model using Winter's method.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom(
            Level( Bounded( 0, 1 ) ),
            Trend( Bounded( 0, 1 ) ),
            Seasonal( Bounded( 0, 1 ) )
        )
    )
);


```

### [X11](#x11)

**Syntax:** obj \<< X11( Additive|Multiplicative )

**Description:** Removes trend and seasonal effects using the X-11 method developed by the US Bureau of the Census.

```

dt = Open( "$SAMPLE_DATA/Time Series/Monthly Sales.jmp" );
obj = dt << Time Series( X( :Date ), Y( :Sales ) );
obj << X11( Additive );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Time Series(
    Y( :steel shipments ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = dt << Time Series( Y( :steel shipments ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Time Series(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Damped-Trend Linear Exponential Smoothing](#damped-trend-linear-exponential-smoothing_1)

### [Item Messages](#item-messages_2)

#### [Actual](#actual_1)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations_1)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals_1)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job_1)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations_1)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit_1)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain_1)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept_1)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations_1)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot_1)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted_1)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval_1)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit_2)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals_1)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns_1)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula_1)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval_1)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points_2)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval_1)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted_1)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time_1)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit_1)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram_2)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

## [Difference](#difference_1)

### [Item Messages](#item-messages_3)

#### [Autocorrelation](#autocorrelation_1)

**Syntax:** obj \<< Autocorrelation( state=0|1 )

**Description:** Displays or hides the Autocorrelation in the Difference report. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Autocorrelation( 1 ) );


```

#### [Connecting Lines](#connecting-lines_1)

**Syntax:** obj \<< Connecting Lines( state=0|1 )

**Description:** Displays or hides the lines connecting the points on the Difference Graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Connecting Lines( 1 ) );


```

#### [Difference Graph](#difference-graph)

**Syntax:** obj \<< Difference Graph( state=0|1 )

**Description:** Displays or hides the Difference Graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Difference Graph( 1 ) );


```

#### [Mean Line](#mean-line_1)

**Syntax:** obj \<< Mean Line( state=0|1 )

**Description:** Displays or hides the mean line on the Difference Graph.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Mean Line( 1 ) );


```

#### [Partial Autocorrelation](#partial-autocorrelation_1)

**Syntax:** obj \<< Partial Autocorrelation( state=0|1 )

**Description:** Displays or hides the Partial Autocorrelation in the Difference report. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Partial Autocorrelation( 1 ) );


```

#### [Remove Fit](#remove-fit_3)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Save](#save)

**Syntax:** obj \<< Save

**Description:** Saves the Difference values in a new column in the data table.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Save );


```

#### [Show Points](#show-points_3)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Displays or hides the points on the Difference Graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Show Points( 1 ) );


```

#### [Variogram](#variogram_3)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram in the Difference report.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Difference( 1, 0, 0, Variogram( 1 ) );


```

## [Double (Brown) Exponential Smoothing](#double-brown-exponential-smoothing)

### [Item Messages](#item-messages_4)

#### [Actual](#actual_2)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations_2)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals_2)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job_2)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations_2)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit_2)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain_2)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept_2)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations_2)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot_2)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted_2)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval_2)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit_4)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals_2)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns_2)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula_2)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval_2)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points_4)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval_2)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted_2)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time_2)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit_2)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram_4)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

## [Linear (Holt) Exponential Smoothing](#linear-holt-exponential-smoothing)

### [Item Messages](#item-messages_5)

#### [Actual](#actual_3)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations_3)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals_3)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job_3)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations_3)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit_3)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain_3)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept_3)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations_3)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot_3)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted_3)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval_3)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit_5)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals_3)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns_3)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula_3)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval_3)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points_5)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval_3)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted_3)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time_3)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit_3)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram_5)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

## [Seasonal ARIMA](#seasonal-arima_1)

### [Item Messages](#item-messages_6)

#### [Actual](#actual_4)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations_4)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals_4)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job_4)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations_4)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit_4)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain_4)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept_4)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations_4)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot_4)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted_4)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval_4)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit_6)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals_4)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns_4)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula_4)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval_4)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points_6)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval_4)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted_4)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time_4)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit_4)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram_6)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

## [Seasonal Exponential Smoothing](#seasonal-exponential-smoothing_1)

### [Item Messages](#item-messages_7)

#### [Actual](#actual_5)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations_5)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals_5)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job_5)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations_5)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit_5)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain_5)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept_5)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations_5)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot_5)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted_5)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval_5)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit_7)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals_5)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns_5)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula_5)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval_5)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points_7)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval_5)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted_5)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time_5)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit_5)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram_7)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

## [Simple Exponential Smoothing](#simple-exponential-smoothing_1)

### [Item Messages](#item-messages_8)

#### [Actual](#actual_6)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations_6)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals_6)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job_6)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations_6)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit_6)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain_6)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept_6)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations_6)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot_6)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted_6)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval_6)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit_8)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals_6)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns_6)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula_6)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval_6)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points_8)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval_6)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted_6)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time_6)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit_6)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram_8)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

## [Simple Moving Average](#simple-moving-average_1)

### [Item Messages](#item-messages_9)

#### [Add Model](#add-model)

**Syntax:** obj \<< Add Model( Window Width, <Centered> )

**Description:** Add a simple moving average model. Model is identified by moving window width. The optional argument indicates whether the average is centered.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
obj = Time Series( Y( :Close ), Simple Moving Average( Add Model( 5 ) ) );
sma = obj << Simple Moving Average( Add Model( 10 ) );
sma << Add Model( 15, Centered );


```

#### [Connecting Lines](#connecting-lines_2)

**Syntax:** obj \<< Connecting Lines( \<1|0> )

**Description:** Graph option for displaying connected lines.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
obj = Time Series( Y( :Close ), Simple Moving Average( Add Model( 5 ) ) );
sma = obj << Simple Moving Average( Connecting Lines );


```

#### [Get Results](#get-results)

**Syntax:** obj \<< Get Results

**Description:** Return all simple moving average models as a JSL object.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
obj = Time Series( Y( :Close ), Simple Moving Average( Add Model( 5 ) ) );
resultobj = obj << Simple Moving Average( Get Result );


```

#### [Remove Model](#remove-model)

**Syntax:** obj \<< Remove Model( Window Width, <Centered> )

**Description:** Remove a simple moving average model. Model is identified by moving window width.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
obj = Time Series( Y( :Close ), Simple Moving Average( Add Model( 5 ) ) );
obj << Simple Moving Average( Remove Model( 5 ) );


```

#### [Remove Report](#remove-report)

**Syntax:** obj \<< Remove Report

**JMP Version Added:** 16

#### [Save to Data Table](#save-to-data-table)

**Syntax:** obj \<< Save to Data Table

**Description:** Save all simple moving average models to a data table, and return the data table handle

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
obj = Time Series( Y( :Close ), Simple Moving Average( Add Model( 5 ) ) );
resultdt = obj << Simple Moving Average( Save to Data Table );


```

#### [Show Points](#show-points_9)

**Syntax:** obj \<< Show Points( \<1|0> )

**Description:** Graph option for displaying points.

```

dt = Open( "$SAMPLE_DATA/Stock Prices.jmp" );
obj = Time Series( Y( :Close ), Simple Moving Average( Add Model( 5 ) ) );
sma = obj << Simple Moving Average( Show Points( 0 ) );


```

## [Transfer Function Model](#transfer-function-model)

### [Item Messages](#item-messages_10)

#### [Alternative Parameterization](#alternative-parameterization)

**Syntax:** obj \<< Alternative Parameterization( state=0|1 )

**Description:** Specifies whether the general regression coefficient is factored out of the numerator polynomials.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) )
);
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Alternative Parameterization( 1 )
);


```

#### [Autocorrelations](#autocorrelations_7)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Autocorrelations( 1 )
);
(obj << report)["Residuals"] << Close( 0 );


```

#### [Compute Objective](#compute-objective)

**Syntax:** obj \<< Compute Objective

#### [Create SAS Job](#create-sas-job_7)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Create SAS Job
);


```

#### [Import New Inputs](#import-new-inputs)

**Syntax:** obj \<< Import New Inputs

**JMP Version Added:** 16

#### [Maximum Iterations](#maximum-iterations_1)

**Syntax:** obj \<< Maximum Iterations( number )

**Description:** Specifies the maximum number of iterations.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) )
);
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Maximum Iterations( 10 )
);


```

#### [No Constrain](#no-constrain_7)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Removes the constraints on the AR and MA coefficients.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) )
);
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    No Constrain( 1 )
);


```

#### [No Intercept](#no-intercept_7)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the Intercept to zero.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) )
);
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    No Intercept( 1 )
);


```

#### [Number of Forecast Periods](#number-of-forecast-periods_1)

**Syntax:** obj \<< Number of Forecast Periods( number )

**Description:** Specifies the number of periods for forecasting.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) )
);
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Number of Forecast Periods( 10 )
);


```

#### [Partial Autocorrelations](#partial-autocorrelations_7)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Partial Autocorrelations( 1 )
);
(obj << report)["Residuals"] << Close( 0 );


```

#### [Plot](#plot_7)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Plot( 1 )
);
(obj << report)["Residuals"] << Close( 0 );


```

#### [Prediction Interval](#prediction-interval_7)

**Syntax:** obj \<< Prediction Interval( number )

**Description:** Sets the level of the confidence intervals displayed.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) )
);
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    :Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Confidence Intervals( 0.99 )
);


```

#### [Remove Fit](#remove-fit_9)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Save Columns](#save-columns_7)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Save Columns
);


```

#### [Variogram](#variogram_9)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/SeriesJ.jmp" );
obj = Time Series( Y( :Output CO2 ), Input List( :Input Gas Rate ) );
obj << Transfer Function(
    Order( 2, 0, 0 ),
    Seasonal( 0, 0, 0, 0 ),
    Input Gas Rate( Order( 2, 0, 2 ), Seasonal( 0, 0, 0, 0 ), Lag( 3 ) ),
    Variogram( 1 )
);
(obj << report)["Residuals"] << Close( 0 );


```

## [Winters Method (Additive)](#winters-method-additive)

### [Item Messages](#item-messages_11)

#### [Actual](#actual_7)

**Syntax:** obj \<< Actual( state=0|1 )

**Description:** Selects the Actual data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Actual( 1 ), Save Columns );


```

#### [Autocorrelations](#autocorrelations_8)

**Syntax:** obj \<< Autocorrelations( state=0|1 )

**Description:** Displays or hides the autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Confidence Intervals](#confidence-intervals_7)

**Syntax:** obj \<< Confidence Intervals( number )

#### [Create SAS Job](#create-sas-job_8)

**Syntax:** obj \<< Create SAS Job

**Description:** Creates a SAS Job to launch SAS and run the analysis in PROC ARIMA.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Create SAS Job;


```

#### [Innovations](#innovations_7)

**Syntax:** obj \<< Innovations( state=0|1 )

**Description:** On by default.

**JMP Version Added:** 16

#### [Lower Confidence Limit](#lower-confidence-limit_7)

**Syntax:** obj \<< Lower Confidence Limit( state=0|1 )

**Description:** Selects the Lower 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Lower Confidence Limit( 1 ), Save Columns );


```

#### [No Constrain](#no-constrain_8)

**Syntax:** obj \<< No Constrain( state=0|1 )

**Description:** Lifts the constraint on the autoregressive parameters to always remain within the stable region and the moving average parameters within the invertible region when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Constrain( 1 ) );


```

#### [No Intercept](#no-intercept_8)

**Syntax:** obj \<< No Intercept( state=0|1 )

**Description:** Sets the intercept to zero when launching an ARIMA model.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, No Intercept( 1 ) );


```

#### [Partial Autocorrelations](#partial-autocorrelations_8)

**Syntax:** obj \<< Partial Autocorrelations( state=0|1 )

**Description:** Displays or hides the partial autocorrelations plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Partial Autocorrelations( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Plot](#plot_8)

**Syntax:** obj \<< Plot( state=0|1 )

**Description:** Displays or hides the residual statistics plot. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Plot( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Predicted](#predicted_7)

**Syntax:** obj \<< Predicted( state=0|1 )

**Description:** Selects the Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Predicted( 1 ), Save Columns );


```

#### [Prediction Interval](#prediction-interval_8)

**Syntax:** obj \<< Prediction Interval( level )

**Description:** Sets the size of the confidence interval about the prediction for the ARIMA model. The default size is 0.95.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 1, 0, Forecasting Interval( 0.99 ) );


```

#### [Remove Fit](#remove-fit_10)

**Syntax:** obj \<< Remove Fit

**JMP Version Added:** 16

#### [Residuals](#residuals_7)

**Syntax:** obj \<< Residuals( state=0|1 )

**Description:** Selects the Residuals values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Residuals( 1 ), Save Columns );


```

#### [Save Columns](#save-columns_8)

**Syntax:** obj \<< Save Columns

**Description:** Creates a new data table containing the actual and predicted values together with standard errors, residuals and 95% prediction intervals about the response. This option is available for all ARIMA, Smoothing, and Transfer Function models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Columns;


```

#### [Save Prediction Formula](#save-prediction-formula_7)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the Prediction Formula to a new column in the data table. This option is available for all ARIMA and Smoothing models.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Arima( 1, 0, 0 );
obj2 << Save Prediction Formula;


```

#### [Show Confidence Interval](#show-confidence-interval_7)

**Syntax:** obj \<< Show Confidence Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Confidence Interval( 0 );


```

#### [Show Points](#show-points_10)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows or hides points on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Show Points( 1 ) );

(obj << report)["Model Comparison"] << Close( 1 );


```

#### [Show Prediction Interval](#show-prediction-interval_7)

**Syntax:** obj \<< Show Prediction Interval( state=0|1 )

**Description:** Shows or hides prediction intervals on the Time Series Forecast Plot. This option is available for all ARIMA and Smoothing models. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj2 = obj << Simple Exponential Smoothing( Zero to One );
obj2 << Show Prediction Interval( 0 );


```

#### [Std Error of Predicted](#std-error-of-predicted_7)

**Syntax:** obj \<< Std Error of Predicted( state=0|1 )

**Description:** Selects the Standard Error of Predicted values data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Std Error of Predicted( 1 ), Save Columns );


```

#### [Time](#time_7)

**Syntax:** obj \<< Time( state=0|1 )

**Description:** Selects the Time data column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ), Time ID( :Date ) );
obj << Arima( 1, 0, 0, Time( 0 ), Save Columns );


```

#### [Upper Confidence Limit](#upper-confidence-limit_7)

**Syntax:** obj \<< Upper Confidence Limit( state=0|1 )

**Description:** Selects the Upper 95% Confidence Limit values column for saving with the Save Columns command. On by default.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series( Y( :Steel Shipments ) );
obj << Arima( 1, 0, 0, Upper Confidence Limit( 1 ), Save Columns );


```

#### [Variogram](#variogram_10)

**Syntax:** obj \<< Variogram( state=0|1 )

**Description:** Displays or hides the Variogram.

```

dt = Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
obj = Time Series(
    Y( :Steel Shipments ),
    Winters Method(
        12,
        Custom( Level( Bounded( 0, 1 ) ), Trend( Bounded( 0, 1 ) ) ),
        Variogram( 1 )
    )
);
(obj << report)["Residuals"] << Close( 0 );
(obj << report)["Model Comparison"] << Close( 1 );


```

# [Titled List Box](#titled-list-box)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Torch Deep Learning](#torch-deep-learning)

## [Associated Constructors](#associated-constructors)

### [Torch Deep Learning](#torch-deep-learning_1)

**Syntax:** Torch Deep Learning(Y( columns ), X( columns ))

**Description:** Interface to predictive modeling via the Torch Deep Learning add-in

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

## [Columns](#columns)

### [Censor](#censor)

**Syntax:** obj \<< Censor( column )

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Inputs](#inputs)

**Syntax:** obj \<< Inputs( column(s) )

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Responses](#responses)

**Syntax:** obj \<< Responses( column(s) )

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Subject](#subject)

**Syntax:** obj \<< Subject( column )

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column(s) )

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

## [Item Messages](#item-messages)

### [Change Variables](#change-variables)

**Syntax:** obj \<< Change Variables

**Description:** Changes X, Y, and other variables for subsequent models.

**JMP Version Added:** 18

### [Compare](#compare)

**Syntax:** obj \<< Compare

**Description:** Updates the Torch Deep Learning comparison metrics.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Compare( AUC( 1 ) );


```

### [Fit](#fit)

**Syntax:** obj \<< Fit

**Description:** Fits a Torch Deep Learning model. You can specify parameters and fitting specifications within this command.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**JMP Version Added:** 18

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Return to the launcher for this analysis.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Relaunch Analysis;


```

### [Set](#set)

**Syntax:** obj \<< Set

**Description:** Specifies parameters for a Torch Deep Learning model.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Set( Epochs( 5 ) ) );


```

### [Show Details](#show-details)

**Syntax:** obj \<< Show Details( state=0|1 )

**Description:** Shows more details.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Show Details( 1 ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Copy Script;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
obj = Torch Deep Learning( Y( :sex ), X( :picture ), Fit );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [Torch Deep Learning Compare](#torch-deep-learning-compare)

### [Associated Constructors](#associated-constructors_1)

#### [Torch Deep Learning Compare](#torch-deep-learning-compare_1)

**Syntax:** Torch Deep Learning Compare

### [Item Messages](#item-messages_1)

#### [AUC](#auc)

**Syntax:** obj \<< AUC( state=0|1 )

**Description:** Shows or hides the AUROC, which is the area under the receiver operating characteristic curve. On by default.

**JMP Version Added:** 18

#### [Accuracy](#accuracy)

**Syntax:** obj \<< Accuracy( state=0|1 )

**Description:** Shows or hides the accuracy, which is the proportion of correct classifications. On by default.

**JMP Version Added:** 18

#### [Censor](#censor_1)

**Syntax:** obj \<< Censor( state=0|1 )

**Description:** Shows or hides the Censor command On by default.

**JMP Version Added:** 18

#### [Concordance](#concordance)

**Syntax:** obj \<< Concordance( state=0|1 )

**Description:** Shows or hides the concordance, which is the Harrell C-Index and measures strength of sorting efficiency On by default.

**JMP Version Added:** 18

#### [Correlation](#correlation)

**Syntax:** obj \<< Correlation( state=0|1 )

**Description:** Shows or hides the Pearson correlation, which is a measure of the strength of the linear relationship. On by default.

**JMP Version Added:** 18

#### [F1](#f1)

**Syntax:** obj \<< F1( state=0|1 )

**Description:** Shows or hides the F1 Score, which is the harmonic average of precision and recall. On by default.

**JMP Version Added:** 18

#### [Freq](#freq_1)

**Syntax:** obj \<< Freq( state=0|1 )

**Description:** Shows or hides the Freq column. On by default.

**JMP Version Added:** 18

#### [H Measure](#h-measure)

**Syntax:** obj \<< H Measure( state=0|1 )

**Description:** Shows or hides the H Measure, which measures proportion improvement over baseline. On by default.

**JMP Version Added:** 18

#### [Hide All Models](#hide-all-models)

**Syntax:** obj \<< Hide All Models

**Description:** Hides all models.

**JMP Version Added:** 18

#### [LogLoss](#logloss)

**Syntax:** obj \<< LogLoss( state=0|1 )

**Description:** Shows or hides the logarithm of the likelihood-based loss function. On by default.

**JMP Version Added:** 18

#### [MAE](#mae)

**Syntax:** obj \<< MAE( state=0|1 )

**Description:** Shows or hides the MAE, which is the mean absolute error. On by default.

**JMP Version Added:** 18

#### [MCC](#mcc)

**Syntax:** obj \<< MCC( state=0|1 )

**Description:** Shows or hides the Matthews correlation coefficient, which is the Pearson correlation for binary variables. On by default.

**JMP Version Added:** 18

#### [Misclass](#misclass)

**Syntax:** obj \<< Misclass( state=0|1 )

**Description:** Shows or hides the misclassification rate, which is the proportion of incorrect classifications. On by default.

**JMP Version Added:** 18

#### [Precision Recall AUC](#precision-recall-auc)

**Syntax:** obj \<< Precision Recall AUC( state=0|1 )

**Description:** Shows or hides the Precision Recall AUC, which is the area under the precision-recall curve. On by default.

**JMP Version Added:** 18

#### [Predictors](#predictors)

**Syntax:** obj \<< Predictors( state=0|1 )

**Description:** Shows or hides the Predictors column. On by default.

**JMP Version Added:** 18

#### [Profit](#profit)

**Syntax:** obj \<< Profit( state=0|1 )

**Description:** Shows or hides the expected profit. On by default.

**JMP Version Added:** 18

#### [RMSE](#rmse)

**Syntax:** obj \<< RMSE( state=0|1 )

**Description:** Shows or hides the RMSE, which is the root mean square error. On by default.

**JMP Version Added:** 18

#### [RSquare](#rsquare)

**Syntax:** obj \<< RSquare( state=0|1 )

**Description:** Shows or hides RSquare value, which is the proportion of variability explained. On by default.

**JMP Version Added:** 18

#### [Remove Hidden Models](#remove-hidden-models)

**Syntax:** obj \<< Remove Hidden Models

**Description:** Removes all models for which the Show box is not checked.

**JMP Version Added:** 18

#### [Remove Shown Models](#remove-shown-models)

**Syntax:** obj \<< Remove Shown Models

**Description:** Removes all models for which the Show check box is checked and shows the remaining models.

**JMP Version Added:** 18

#### [Response](#response)

**Syntax:** obj \<< Response( state=0|1 )

**Description:** Shows or hides the Response column. On by default.

**JMP Version Added:** 18

#### [Show All Models](#show-all-models)

**Syntax:** obj \<< Show All Models

**Description:** Shows all models.

**JMP Version Added:** 18

#### [Subject](#subject_1)

**Syntax:** obj \<< Subject( state=0|1 )

**Description:** Shows or hides the Subject column On by default.

**JMP Version Added:** 18

#### [Training Metrics](#training-metrics)

**Syntax:** obj \<< Training Metrics( state=0|1 )

**Description:** Shows or hides all training metrics. On by default.

**JMP Version Added:** 18

#### [Validation](#validation_1)

**Syntax:** obj \<< Validation( state=0|1 )

**Description:** Shows or hides the Validation column. On by default.

**JMP Version Added:** 18

#### [Validation Metrics](#validation-metrics)

**Syntax:** obj \<< Validation Metrics( state=0|1 )

**Description:** Shows or hides all validation metrics. On by default.

**JMP Version Added:** 18

#### [Weight](#weight_1)

**Syntax:** obj \<< Weight( state=0|1 )

**Description:** Shows or hides the Weight column. On by default.

**JMP Version Added:** 18

## [Torch Deep Learning Fit > Post](#torch-deep-learning-fit-post)

### [Item Messages](#item-messages_2)

#### [Actual by Predicted Plots](#actual-by-predicted-plots)

**Syntax:** obj \<< Actual by Predicted Plots( state=0|1 )

**Description:** Shows or hides a plot using the training data with the predicted values on the X axis and actual values on the Y axis. On by default.

**JMP Version Added:** 18

#### [Confusion Matrices](#confusion-matrices)

**Syntax:** obj \<< ( fit[number] \<< Confusion Matrices( state=0|1 ) )

**Description:** Shows or hides a crosstabulation matrix of actual and predicted levels. On by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Torch Deep Learning(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit
);
obj << (fit[1] << Confusion Matrices( 1 ));


```

#### [Contour Profiler.](#contour-profiler)

**Syntax:** obj \<< Contour Profiler.

**Description:** Shows or hides interactive graphs of cross-sections of the prediction function.

**JMP Version Added:** 18

#### [Decision Thresholds](#decision-thresholds)

**Syntax:** obj \<< Decision Thresholds( state=0|1 )

**Description:** Shows or hides decision threshold graphs and tables. On by default.

**JMP Version Added:** 18

#### [Fit Details](#fit-details)

**Syntax:** obj \<< Fit Details( state=0|1 )

**Description:** Shows or hides the statistics for the fitted model. On by default.

**JMP Version Added:** 18

#### [Lift Curves](#lift-curves)

**Syntax:** obj \<< Lift Curves( state=0|1 )

**Description:** Plots how much more saturated the top x-percent of predicted values are compared to the whole population.

**JMP Version Added:** 18

#### [Model Details](#model-details)

**Syntax:** obj \<< Model Details( state=0|1 )

**Description:** Shows or hides model details On by default.

**JMP Version Added:** 18

#### [Precision Recall Curves](#precision-recall-curves)

**Syntax:** obj \<< Precision Recall Curves( state=0|1 )

**Description:** Plots the trade-off between precision and recall for different classification thresholds. It is preferred in scenarios where class imbalances exist.

**JMP Version Added:** 18

#### [Profiler](#profiler)

**Syntax:** obj \<< Profiler

**Description:** Shows or hides the Prediction Profiler.

**JMP Version Added:** 18

#### [ROC Curves](#roc-curves)

**Syntax:** obj \<< ROC Curves( state=0|1 )

**Description:** Plots the response-category sorting efficiency of the model predictions.

**JMP Version Added:** 18

#### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler

**Description:** Shows or hides interactive graphs of cross-sections of the prediction function.

**JMP Version Added:** 18

## [Torch Deep Learning Fit](#torch-deep-learning-fit)

### [Associated Constructors](#associated-constructors_2)

#### [Post](#post)

**Syntax:** Post

#### [Torch Deep Learning Fit](#torch-deep-learning-fit_1)

**Syntax:** Torch Deep Learning Fit

### [Item Messages](#item-messages_3)

#### [Activation](#activation)

**Syntax:** obj \<< Activation( "CELU"|"ELU"|"GELU"|"Hardshrink"|"Hardtanh"|"LeakyReLU"|"LogSigmoid"|"Mish"|"PReLU"|"ReLU"|"ReLU6"|"RReLU"|"SELU"|"Sigmoid"|"SiLU"|"Softplus"|"Softshrink"|"Softsign"|"Tanh"|"Tanhshrink"|"None"="ReLU" )

**Description:** Specifies the activation function to use after each layer. "ReLU" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Activation( "ReLU" ) ) );


```

#### [Activations](#activations)

**Syntax:** obj \<< Activations( text )

**Description:** Specifies a space-delimited list of activation functions to use in sequential layers. This parameter overrides Activation when it is specified, and the last value carries forward.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Activations( "ReLU" ) ) );


```

#### [Anchor Scale](#anchor-scale)

**Syntax:** obj \<< Anchor Scale( number=16 )

**Description:** Specifies a multiplier applied to an internal range of anchor sizes. Larger values tend to work better for larger boxes. "16" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Anchor Scale( "16" ) ) );


```

#### [Aspect Sigma](#aspect-sigma)

**Syntax:** obj \<< Aspect Sigma( number=0 )

**Description:** Standard deviation of Gaussian aspect ratio deformation "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Aspect Sigma( 0.0 ) ) );


```

#### [Attention Heads](#attention-heads)

**Syntax:** obj \<< Attention Heads( text=4 )

**Description:** For transformer models, specifies the number of attention heads as a space delimited list of positive integers, each of which must evenly divide its corresponding layer size. Last value carries forward if necessary. "4" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Attention Heads( 1 ) ) );


```

#### [Base Activation](#base-activation)

**Syntax:** obj \<< Base Activation( "CELU"|"ELU"|"GELU"|"Hardshrink"|"Hardtanh"|"LeakyReLU"|"LogSigmoid"|"Mish"|"PReLU"|"ReLU"|"ReLU6"|"RReLU"|"SELU"|"Sigmoid"|"SiLU"|"Softplus"|"Softshrink"|"Softsign"|"Tanh"|"Tanhshrink"|"None"="GELU" )

**Description:** Specifies the base activation function for Kolmogorov Arnold B Splines. "GELU" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Base Activation( "GELU" ) ) );


```

#### [Basis Function](#basis-function)

**Syntax:** obj \<< Basis Function( "Gaussian"|"Linear"|"Quadradic"|"InverseQuadradic"|"MultiQuadric"|"InverseMultiQuadric"|"Spline"|"Poisson1"|"Poisson2"|"Matern32"|"Matern52"="Gaussian" )

**Description:** For Radial Basis Machine models, specify the basis function. "Gaussian" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning(
    Y( :sex ),
    X( :height, :weight ),
    Fit( Tabular Model( "RadialBasisMachine" ), Basis Function( "Gaussian" ) )
);


```

#### [Batch Size](#batch-size)

**Syntax:** obj \<< Batch Size( number=128 )

**Description:** Specifies the number of rows to randomly sample for each training batch and optimization update. Decrease it to save memory and update gradients more frequently; increase it to pass through the data faster and regularize the model more. "128" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Batch Size( 128 ) ) );


```

#### [Binary Loss](#binary-loss)

**Syntax:** obj \<< Binary Loss( "BCE"|"SM"="BCE" )

**Description:** Specifies the loss function for binary responses. Choose from Binary Cross Entropy (BCE) or Soft Margin (SM). "BCE" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Binary Loss( "BCE" ) ) );


```

#### [Blur Max Sigma](#blur-max-sigma)

**Syntax:** obj \<< Blur Max Sigma( number=0 )

**Description:** Maximum standard deviation of Gaussian blur "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Blur Max Sigma( 1 ) ) );


```

#### [Class Loss Weight](#class-loss-weight)

**Syntax:** obj \<< Class Loss Weight( number=4.0 )

**Description:** Specifies the multiplier for class loss. "4.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Class Loss Weight( 4.0 ) ) );


```

#### [Confidence Threshold](#confidence-threshold)

**Syntax:** obj \<< Confidence Threshold( number=0.05 )

**Description:** Specifies the confidence score threshold for predicted boxes. Boxes with probability score less than this threshold are dropped. "0.05" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Confidence Threshold( 0.05 ) ) );


```

#### [Continuous Loss](#continuous-loss)

**Syntax:** obj \<< Continuous Loss( "MSE"|"L1"|"SmoothL1"|"Huber"|"Poisson"|"Quantile"|"CoxPH"="MSE" )

**Description:** Specifies the loss function for continuous responses. Choose from Mean Squared Error (MSE), Mean Absolute Error (L1), Smoothed L1 (with margin), Huber (with margin), or Poisson (for count responses). "MSE" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :weight ), X( :picture ), Fit( Continuous Loss( "MSE" ) ) );


```

#### [Copy Parameters to Launch](#copy-parameters-to-launch)

**Syntax:** obj \<< Copy Parameters to Launch

**Description:** Copies the parameter values from this model to the model launch section.

**JMP Version Added:** 18

#### [Covariance Structure](#covariance-structure)

**Syntax:** obj \<< Covariance Structure( "DotProduct"|"Gaussian"="DotProduct" )

**Description:** For mixed models, specify the covariance structure. "DotProduct" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning(
    Y( :sex ),
    X( :height, :weight ),
    Fit( Tabular Model( "MixedModel" ), Covariance Structure( "DotProduct" ) )
);


```

#### [Data Threads](#data-threads)

**Syntax:** obj \<< Data Threads( number=4 )

**Description:** Specifies the number of threads to use to load data into memory. A number near half the number of actual cores is usually near optimal. "4" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Data Threads( 0 ) ) );


```

#### [Device](#device)

**Syntax:** obj \<< Device( "auto"|"cpu"|"cuda:0"|"cuda:1"|"cuda:2"|"cuda:3"="auto" )

**Description:** Specifies the computational device that Torch uses. "auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Device( "cpu" ) ) );


```

#### [Dilations](#dilations)

**Syntax:** obj \<< Dilations( text=1 )

**Description:** For custom convolutional models, specifies the dilations as a space-delimited list of positive integers. Last value carries forward if necessary. "1" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Dilations( "1" ) ) );


```

#### [Dropout Probs](#dropout-probs)

**Syntax:** obj \<< Dropout Probs( text=0.0 )

**Description:** Specifies the probabilities of dropout to use after each layer as a space-delimited list of decimals between 0 and 1. Last value carries forward if necessary. "0.0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Dropout Probs( "0.1" ) ) );


```

#### [Epochs](#epochs)

**Syntax:** obj \<< Epochs( number=20 )

**Description:** Specifies the number of iterations through the training data to optimize the loss function for each batch and train the model. "20" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Epochs( 100 ) ) );


```

#### [Factorization Machine Layers](#factorization-machine-layers)

**Syntax:** obj \<< Factorization Machine Layers( text=0 )

**Description:** Specify a space-separated list of 0s and 1s indicating if factorization machine interactions should be added to each linear layer. Last value carries forward. "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning(
    Y( :sex ),
    X( :height, :weight ),
    Fit( Factorization Machine Layers( "1" ) )
);


```

#### [Fit Ys Separately](#fit-ys-separately)

**Syntax:** obj \<< Fit Ys Separately( state=0 )

**Description:** Check to fit a distinct model for each Y variable, and uncheck to model them jointly. "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex, :height ), X( :picture ), Fit( Model Ys Separately( 1 ) ) );


```

#### [Fixed Effects](#fixed-effects)

**Syntax:** obj \<< Fixed Effects( number=0 )

**Description:** Specify the number of fixed effects, all of which must be at the beginning of the X variable list "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Fixed Effects( 0 ) ) );


```

#### [Folder](#folder)

**Syntax:** obj \<< Folder( text )

**Description:** Select a folder in which to save modeling results. A subfolder for each model is created in this folder.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Folder( "" ) ) );


```

#### [Frozen Epochs](#frozen-epochs)

**Syntax:** obj \<< Frozen Epochs( number=0 )

**Description:** Specifies the number of epochs for which pretrained model bodies remain frozen. After this number there is full training gradients for all parameters. "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Frozen Epochs( 3 ) ) );


```

#### [Generate Python Code](#generate-python-code)

**Syntax:** obj \<< Generate Python Code

**Description:** Creates Python code for model deployment.

**JMP Version Added:** 18

#### [Grid Size](#grid-size)

**Syntax:** obj \<< Grid Size( number=5 )

**Description:** For Kolmogorov Arnold B Spline networks, specifies the number of points in the grid for the spline interpolation. "5" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Grid Size( 5 ) ) );


```

#### [HFlip Prob](#hflip-prob)

**Syntax:** obj \<< HFlip Prob( number=0 )

**Description:** Probability of horizontal flip "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( HFlip Prob( 0.3 ) ) );


```

#### [Highway Layers](#highway-layers)

**Syntax:** obj \<< Highway Layers( text=0 )

**Description:** Specify a space-separated list of nonnegative integers specifying the number of highway layers to insert in the network. Last value carries forward. "0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Highway Layers( "1" ) ) );


```

#### [Image Model](#image-model)

**Syntax:** obj \<< Image Model( ="LeNet5" )

**Description:** Specifies the image network architecture to use. Models are ordered by size. Smaller models train faster but may not perform as well as larger models. "LeNet5" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Image Model( "LeNet5" ) ) );


```

#### [Image Size](#image-size)

**Syntax:** obj \<< Image Size( number=28 )

**Description:** Specifies the size of image to use while training. Input images are transformed to this size square; larger images have higher resolution but slower training times. "28" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Image Size( 28 ) ) );


```

#### [Kernel Sizes](#kernel-sizes)

**Syntax:** obj \<< Kernel Sizes( text=3 )

**Description:** For custom convolutional models, specifies the kernel sizes as a space-delimited list of positive integers. Last value carries forward if necessary. "3" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Kernel Sizes( "3" ) ) );


```

#### [L1 Penalty](#l1-penalty)

**Syntax:** obj \<< L1 Penalty( number=0.0 )

**Description:** Specifies a multiplier for the sum of absolute values of weight parameters to be added to the loss and induce sparsity. "0.0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( L1 Penalty( 0.0001 ) ) );


```

#### [Layer Sizes](#layer-sizes)

**Syntax:** obj \<< Layer Sizes( text=16 )

**Description:** Specifies output sizes of hidden layers as a space-delimited list of integers (actual sizes) or decimals (multipliers of the previous layer size). The final value is the embedding size. "16" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Layer Sizes( "16" ) ) );


```

#### [Learning Rate](#learning-rate)

**Syntax:** obj \<< Learning Rate( number=0.001 )

**Description:** Specifies the learning rate. Smaller learning rates tend to fit better but require more iterations to converge, whereas larger learning rates fit faster. "0.001" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Learning Rate( 0.001 ) ) );


```

#### [Margin](#margin)

**Syntax:** obj \<< Margin( number=1.0 )

**Description:** Specifies the margin used in margin-based loss functions. Larger values should produce larger embedding distances between nominal responses with different levels, but may adversely affect training. "1.0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Margin( 1.0 ) ) );


```

#### [Max Boxes](#max-boxes)

**Syntax:** obj \<< Max Boxes( number=5 )

**Description:** Specifies the maximum number of predicted boxes per image. "5" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Max Boxes( 5 ) ) );


```

#### [Max Seq Length](#max-seq-length)

**Syntax:** obj \<< Max Seq Length( number=512 )

**Description:** For text models, specifies the maximum number of tokens to create for each text item. "512" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Chips.jmp" );
Torch Deep Learning(
    Y( :Buy again? ),
    X( :Potato Chip Product Review ),
    Fit( Max Seq Length( 512 ) )
);


```

#### [Mixup Portion](#mixup-portion)

**Syntax:** obj \<< Mixup Portion( number=0.0 )

**Description:** Specifies portion of mixup samples to add to each training batch. For example, if Batch Size is 128 and Mixup Portion is 0.5, then 64 mixup samples are added. "0.0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Mixup Portion( 0.5 ) ) );


```

#### [NMS Threshold](#nms-threshold)

**Syntax:** obj \<< NMS Threshold( number=0.5 )

**Description:** Specifies the non-maximum suppression threshold for predicted boxes. Overlapping boxes with IOU values above this threshold are dropped. "0.5" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( NMS Threshold( 0.5 ) ) );


```

#### [Noise Max Sigma](#noise-max-sigma)

**Syntax:** obj \<< Noise Max Sigma( number=0 )

**Description:** Maximum standard deviation of additive Gaussian noise "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Noise Max Sigma( 1 ) ) );


```

#### [Nominal Image Threshold](#nominal-image-threshold)

**Syntax:** obj \<< Nominal Image Threshold( number=10 )

**Description:** Specifies the cutoff for determining if images in a column are nominal or continuous. If the number of unique pixel levels is \<= this number, then the images are considered to be nominal. "10" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Nominal Image Threshold( 10 ) ) );


```

#### [Nominal Loss](#nominal-loss)

**Syntax:** obj \<< Nominal Loss( "NLL"="NLL" )

**Description:** Specifies the loss function for nominal responses. Choose from Negative Loglikelihood (NLL). "NLL" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Nominal Loss( "NLL" ) ) );


```

#### [Norm](#norm)

**Syntax:** obj \<< Norm( "None"|"Batch"|"Group"|"Instance"="Batch" )

**Description:** Specifies the type of normalization to apply to each MLP layer. "Batch" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Norm( "Batch" ) ) );


```

#### [Norm First](#norm-first)

**Syntax:** obj \<< Norm First( "None"|"Batch"="Batch" )

**Description:** Specifies the type of normalization to apply to the input data to the tabular model. Batch norm effectively centers and scales each input. "Batch" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Norm First( "Batch" ) ) );


```

#### [Num Linear](#num-linear)

**Syntax:** obj \<< Num Linear( number=1 )

**Description:** For custom convolutional and message passing models, specifies the number of linear layers at the end of Layer Sizes. "1" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Num Linear( 1 ) ) );


```

#### [Optimizer](#optimizer)

**Syntax:** obj \<< Optimizer( "Adam"|"AdamW"|"SGD"|"SGDAGC"="AdamW" )

**Description:** Specifies the optimization method. Choose between Adaptive moment estimation (Adam), Adam weight decay (AdamW), Stochastic Gradient Descent (SGD), or SGD with Adaptive Gradient Clipping (SGDAGC). "AdamW" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Optimizer( "AdamW" ) ) );


```

#### [Pitch Sigma](#pitch-sigma)

**Syntax:** obj \<< Pitch Sigma( number=0 )

**Description:** Standard deviation of Gaussian pitch "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Pitch Sigma( 5 ) ) );


```

#### [Pooling Layers](#pooling-layers)

**Syntax:** obj \<< Pooling Layers( text=Max )

**Description:** Specifies pooling layers as a space-delimited list of one of four keywords: Max, Avg, Cat, or None. Last value carries forward if necessary. "Max" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Pooling Layers( "Max" ) ) );


```

#### [Pretrained Tabular](#pretrained-tabular)

**Syntax:** obj \<< Pretrained Tabular( ="None" )

**Description:** Specify a pretrained tabular model that is prepended to the Tabular Model. "None" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Pretrained Tabular( "None" ) ) );


```

#### [Quantiles](#quantiles)

**Syntax:** obj \<< Quantiles( text=0.9 )

**Description:** Specify a space-delimited list of quantiles to use for Quantile loss. "0.9" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Quantiles( "0.9" ) ) );


```

#### [RPN NMS Threshold](#rpn-nms-threshold)

**Syntax:** obj \<< RPN NMS Threshold( number=0.7 )

**Description:** Specifies the non-maximum suppression threshold for region proposals. Overlapping boxes with IOU values above this threshold are dropped. "0.7" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( RPN NMS Threshold( 0.7 ) ) );


```

#### [Remove All But This Fit](#remove-all-but-this-fit)

**Syntax:** obj \<< ( fit[number] \<< Remove All But This Fit )

**Description:** Removes the reports and plots for all models except this one.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Torch Deep Learning(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit
);
Wait( 2 );
obj << (Fit[1] << Remove All But This Fit);


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< ( fit[number] \<< Remove Fit )

**Description:** Removes the entire model report.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << Torch Deep Learning(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit
);
Wait( 2 );
obj << (Fit[1] << Remove Fit);


```

#### [Restore From](#restore-from)

**Syntax:** obj \<< Restore From( " "=" " )

**Description:** Select a subfolder containing saved files from a previously fit model. Training for a new model will begin where this model finished. Model architectures and validation variables should match. Leave this field blank to train from scratch. " " by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Restore From( "" ) ) );


```

#### [Roll Sigma](#roll-sigma)

**Syntax:** obj \<< Roll Sigma( number=0 )

**Description:** Standard deviation of Gaussian roll "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Roll Sigma( 5 ) ) );


```

#### [Save CAMs](#save-cams)

**Syntax:** obj \<< Save CAMs

**Description:** Save gradient-based class activation maps (CAMs) as a new column.

**JMP Version Added:** 18

#### [Save Embeddings](#save-embeddings)

**Syntax:** obj \<< Save Embeddings

**Description:** Saves model embeddings (from final hidden layer) as new columns in the data table

**JMP Version Added:** 18

#### [Save Model](#save-model)

**Syntax:** obj \<< Save Model

**Description:** Saves serialized modeling components to disk in a folder that you name. You can then specify this folder in Restore From to begin training with this model.

**JMP Version Added:** 18

#### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds

**Description:** Saves the predicted values in a new column in the data table.

**JMP Version Added:** 18

#### [Screening Method](#screening-method)

**Syntax:** obj \<< Screening Method( "ResponseScreening"|"BootstrapForest"="ResponseScreening" )

**Description:** Choose a method by which to screen Tabular Model predictors prior to fitting the model within each fold. ResponseScreening is fast and BootstrapForest is more thorough. "ResponseScreening" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning(
    Y( :sex ),
    X( :picture ),
    Fit( Screening Method( "ResponseScreening" ) )
);


```

#### [Screening Threshold](#screening-threshold)

**Syntax:** obj \<< Screening Threshold( number=0 )

**Description:** If >= 1, the number of Tabular Model predictors to select by screening. If < 1, the predictors with cumulative portion less than the threshold. "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Screening Threshold( 1 ) ) );


```

#### [Seed](#seed)

**Syntax:** obj \<< Seed( number=0 )

**Description:** Specifies the seed for the random number generator. Note results may not be fully reproducible with the same seed due to the stochastic nature of certain Torch calculations. "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Seed( 0 ) ) );


```

#### [Segmentation Model](#segmentation-model)

**Syntax:** obj \<< Segmentation Model( "UNet"|"FPN"|"LinkNet"|"DeepLabV3"|"DeepLabV3Plus"|"PAN"|"PSPNet"="UNet" )

**Description:** Specifies the image segmentation model. "UNet" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/segmentation.jmp" );
Torch Deep Learning( Y( :Mask ), X( :Picture ), Sett( Segmentation Model( "VGG11_BN" ) ) );


```

#### [Spline Order](#spline-order)

**Syntax:** obj \<< Spline Order( number=3 )

**Description:** For Kolmogorov Arnold B Spline networks, specifies the order of the spline used for interpolation. "3" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Spline Order( 3 ) ) );


```

#### [Strides](#strides)

**Syntax:** obj \<< Strides( text=1 )

**Description:** For custom convolutional models, specifies the strides as a space-delimited list of positive integers. Last value carries forward if necessary. "1" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :height, :weight ), Fit( Strides( "1" ) ) );


```

#### [Tabular Model](#tabular-model)

**Syntax:** obj \<< Tabular Model( "MultiLayerPerceptron"|"FTTransformer"|"KolmogorovArnoldBSpline"|"CustomConv1d"|"LSTM"|"RadialBasisMachine"|"MixedModel"="MultiLayerPerceptron" )

**Description:** Specifies the tabular network architecture to use. Choose from Multilayer Perceptron (MLP), Feature Tokenized Transformer (FTTransformer), Kolmogorov Arnold Network (KolmogorovArnoldBSpline), or other options "MultiLayerPerceptron" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning(
    Y( :sex ),
    X( :picture ),
    Fit( Tabular Model( "MultiLayerPerceptron" ) )
);


```

#### [Text Model](#text-model)

**Syntax:** obj \<< Text Model( ="BertTiny" )

**Description:** Specifies the text network architecture to use. Models are ordered by size. Smaller models train faster but may not perform as well as larger models. "BertTiny" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Chips.jmp" );
Torch Deep Learning(
    Y( :Buy again? ),
    X( :Potato Chip Product Review ),
    Fit( Text Model( "BERT" ) )
);


```

#### [Triplet Loss Weight](#triplet-loss-weight)

**Syntax:** obj \<< Triplet Loss Weight( number=0.0 )

**Description:** Specifies the multiplier alpha to use in the following compound loss function: alpha * triplet_loss + (1 - alpha) * loss_function. Must be between 0 and 1. "0.0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Triplet Loss Weight( 0.5 ) ) );


```

#### [Use Data As Knots](#use-data-as-knots)

**Syntax:** obj \<< Use Data As Knots( state=0 )

**Description:** For Radial Basis Machine models, check to use the training data as knots to form an interpolation-style model. "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning(
    Y( :sex, :height ),
    X( :picture ),
    Fit( Tabular Model( "Radial Basis Machine" ), Use Data As Knots( 1 ) )
);


```

#### [VFlip Prob](#vflip-prob)

**Syntax:** obj \<< VFlip Prob( number=0 )

**Description:** Probability of vertical flip "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( VFlip Prob( 0.2 ) ) );


```

#### [Weight Decay](#weight-decay)

**Syntax:** obj \<< Weight Decay( number=0.0 )

**Description:** Specifies a penalty term multiplier of the L2 norm of the trainable parameters, which regularizes them in a way similar to ridge regression. "0.0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Weight Decay( 0.0001 ) ) );


```

#### [Worker Count](#worker-count)

**Syntax:** obj \<< Worker Count( number=4 )

**Description:** Specifies the number of workers to use to load batches of data during training. A number near half the number of actual cores is usually near optimal. "4" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Worker Count( 0 ) ) );


```

#### [X Slide Sigma](#x-slide-sigma)

**Syntax:** obj \<< X Slide Sigma( number=0 )

**Description:** Standard deviation of Gaussian random shift along the X axis "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( X Slide Sigma( 5 ) ) );


```

#### [Y Slide Sigma](#y-slide-sigma)

**Syntax:** obj \<< Y Slide Sigma( number=0 )

**Description:** Standard deviation of Gaussian random shift along the Y axis "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Y Slide Sigma( 5 ) ) );


```

#### [Yaw Sigma](#yaw-sigma)

**Syntax:** obj \<< Yaw Sigma( number=0 )

**Description:** Standard deviation of Gaussian yaw "0" by default.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Torch Deep Learning( Y( :sex ), X( :picture ), Fit( Yaw Sigma( 5 ) ) );


```

# [Tree Node](#tree-node)

## [Associated Constructors](#associated-constructors)

### [Tree Node](#tree-node_1)

**Syntax:** node = Tree Node( <label> )

**Description:** Create a node for display in a Tree Box display.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );


```

## [Item Messages](#item-messages)

### [Append](#append)

**Syntax:** obj \<< Append

**Description:** Append a tree node to this node's children.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

c7 = Tree Node( "New Child" );
root1 << Append( c7 );


```

### [First Child](#first-child)

**Syntax:** node = obj \<< First Child

**Description:** Returns the first child node or Empty if the node has no children.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Print( (root1 << Firs tChild) << GetLabel );


```

### [Get Child](#get-child)

**Syntax:** obj \<< Get Child( index )

**Description:** Get the child node at the specified index.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Print( (root2 << Get Child( 2 )) << Get Label );


```

### [Get Child Count](#get-child-count)

**Syntax:** obj \<< Get Child Count

**Description:** Get the number of child nodes.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root2 << Get Child Count;


```

### [Get Data](#get-data)

**Syntax:** data = obj \<< Get Data

**Description:** Get the user data associated with this node. Retrieves the value or object set with Set Data. See Set Data for more information.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

c1 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c2 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c3 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c4 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c5 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c6 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
tree << SetNodeSelectScript(
    Function( {this},
        {},
        Print( Eval( (this << getselected) << GetData ) )
    )
);


```

### [Get Dimmed](#get-dimmed)

**Syntax:** dimmed = obj \<< Get Dimmed

**Description:** Get the option to dim the text for this node.

**JMP Version Added:** 15

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root3 << Get Dimmed;


```

### [Get Expanded Icon](#get-expanded-icon)

**Syntax:** obj \<< Get Expanded Icon

**Description:** Gets the tree node expanded icon. Empty is returned if no icon is specified.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root1 << Set Icon( "Distrib" );
root1 << Set Expanded Icon( "$SAMPLE_IMAGES/pi.gif" );
root1 << Get Expanded Icon;


```

### [Get Font Style](#get-font-style)

**Syntax:** style = obj \<< Get Font Style

**Description:** Get the font style for this node.

**JMP Version Added:** 15

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root3 << Get Font Style;


```

### [Get Icon](#get-icon)

**Syntax:** obj \<< Get Icon

**Description:** Gets the tree node icon. Empty is returned if no icon is specified.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root1 << Set Icon( "Distrib" );
root1 << Get Icon;


```

### [Get Label](#get-label)

**Syntax:** label = obj \<< Get Label

**Description:** Get the label text shown for this node

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root3 << Get Label;


```

### [Get Tip](#get-tip)

**Syntax:** tip = obj \<< Get Tip

**Description:** Get the tooltip text shown for this node.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
c6 << Set Tip( "This is the tool tip for the last child" );
c6 << Get Tip;


```

### [Index Of](#index-of)

**Syntax:** index = obj \<< Index Of( node )

**Description:** Get the index of the specified child node. Returns 0 if not found.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root2 << Index Of( root3 );


```

### [Insert](#insert)

**Syntax:** obj \<< Insert( node, index )

**Description:** Insert node at the specified index.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

c7 = Tree Node( "New Child" );
root3 << Insert( c7, 2 );


```

### [Is Leaf](#is-leaf)

**Syntax:** isLeaf = obj \<< Is Leaf

**Description:** Is this node a leaf node in the tree?

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root3 << Is Leaf;


```

### [Last Child](#last-child)

**Syntax:** node = obj \<< Last Child

**Description:** Returns the last child node or Empty if the node has no children.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Print( (root1 << Last Child) << GetLabel );


```

### [Parent](#parent)

**Syntax:** node = obj \<< Parent

**Description:** Returns the parent node or Empty if this node has no parent.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Print( (c4 << Parent) << GetLabel );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( node )

**Description:** Prepend a tree node to this node's children.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

c7 = Tree Node( "New Child" );
root1 << Prepend( c7 );


```

### [Prev Sib](#prev-sib)

**Syntax:** node = obj \<< Prev Sib

**Description:** Returns the previous sibling of this node in the parent's children or Empty if this is the first child

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Print( (c4 << Prev Sib) << Get Label );


```

### [Remove](#remove)

**Syntax:** obj \<< Remove

**Description:** Remove this node an all children from the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
root3 << Remove;


```

### [Remove All Children](#remove-all-children)

**Syntax:** obj \<< Remove All Children

**Description:** Remove all child nodes.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
root2 << Remove All Children;


```

### [Remove Child](#remove-child)

**Syntax:** obj \<< Remove Child( node )

**Description:** Removes the specified child node.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
root3 << Remove Child( c6 );


```

### [Set Data](#set-data)

**Syntax:** obj \<< Set Data( data )

**Description:** Set the user data for this node. Assign any value or object that you might wish to retrieve from the node later. A common use is in a tree box double-click callback.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

c1 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c2 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c3 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c4 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c5 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
c6 << SetData( Function( {}, {}, MDYHMS( Today() ) ) );
tree << SetNodeSelectScript(
    Function( {this},
        {},
        Print( Eval( (this << getselected) << GetData ) )
    )
);


```

### [Set Dimmed](#set-dimmed)

**Syntax:** obj \<< Set Dimmed( state=0|1 )

**Description:** Set the option to dim the text for this node.

**JMP Version Added:** 15

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
c6 << Set Dimmed( 1 );


```

### [Set Expanded Icon](#set-expanded-icon)

**Syntax:** obj \<< Set Expanded Icon( icon | path, <boolean> )

**Description:** Set the icon name to use if this node is expanded. Optional parameter indicates whether to load the icon associated with the path (Windows Only).

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root1 << Set Icon( "Distrib" );
root1 << Set Expanded Icon( "$SAMPLE_IMAGES/pi.gif" );
root2 << Set Icon( "Oneway" );
root2 << Set Expanded Icon( "$SAMPLE_IMAGES/pi.gif", true );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( "Plain" | "Bold" )

**Description:** Set the font style for this node.

**JMP Version Added:** 15

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
c6 << Set Font Style( "Bold" );


```

### [Set Icon](#set-icon)

**Syntax:** obj \<< Set Icon( icon | path, <boolean> )

**Description:** Set nodes icon. Optional parameter indicates whether to load the icon associated with the path (Windows Only).

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

root1 << Set Icon( "Distrib" );
root2 << Set Icon( "$SAMPLE_IMAGES/pi.gif" );
root3 << Set Icon( "$SAMPLE_IMAGES/pi.gif", true );


```

### [Set Label](#set-label)

**Syntax:** obj \<< Set Label( label )

**Description:** Set the label text shown for this node

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
c6 << Set Label( "Last Child" );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Set the tooltip text shown for this node.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Wait( 1 );
c6 << Set Tip( "This is the tool tip for the last child" );


```

### [Sib](#sib)

**Syntax:** node = obj \<< Sib

**Description:** Returns the next sibling of this node in the parent's children or Empty if this is the last child.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Print( (c4 << Sib) << Get Label );


```

### [Top Parent](#top-parent)

**Syntax:** node = obj \<< Top Parent

**Description:** Returns the root of the tree containing this node or Empty if this node has no parent.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
root3 = Tree Node( "Parent 3" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
c5 = Tree Node( "Child 5" );
c6 = Tree Node( "Child 6" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
root2 << Append( root3 );
root3 << Append( c5 );
root3 << Append( c6 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Expand( root1 );
tree << Expand( root2 );
tree << Expand( root3 );

Print( (c6 << Top Parent) << GetLabel );


```

# [Treemap](#treemap)

## [Associated Constructors](#associated-constructors)

### [Treemap](#treemap_1)

**Syntax:** Treemap( Categories( column ), \<Sizes( column )>, \<Coloring( column )> )

**Description:** Graph Builder alternative to creating a rectangular tiling for a nominal or ordinal variable. The tile categories are proportional in size to the counts of categories within a selected variable.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Categories](#categories)

**Syntax:** obj \<< Categories( column(s) )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);


```

### [Coloring](#coloring)

**Syntax:** obj \<< Coloring( column )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);


```

### [Ordering](#ordering)

**Syntax:** obj \<< Ordering( column(s) )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);


```

### [Sizes](#sizes)

**Syntax:** obj \<< Sizes( column )

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);


```

## [Item Messages](#item-messages)

### [Auto Stretching](#auto-stretching)

**Syntax:** obj \<< Auto Stretching( state=0|1 )

**Description:** On by default.

### [Change Color Column](#change-color-column)

**Syntax:** obj \<< Change Color Column( column )

**Description:** Changes the column used for coloring the categories.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Treemap( Categories( :city ), Coloring( :POP ) );
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    gbb = Report( obj )[Graph Builder Box( 1 )];
    gbb << Remove Variable( {:POP, Role( "color" ), Position( 1 )} );
    gbb << Add Variable( {:CO, Role( "color" ), Position( 1 )} );
,
    obj << Change Color Column( :CO )
);


```

### [Color Range](#color-range)

**Syntax:** obj \<< Color Range( low, high )

**Description:** Sets the range for the color gradient. Default is low=min and high=max of the coloring column.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Treemap( Categories( :city ), Sizes( :POP ), Coloring( :CO ) );
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    report = obj << report;
    report << Dispatch( {}, "400", ScaleBox,
        {Legend Model(
            1,
            Properties( 0, {gradient( {Scale Values( [1 20] )} )}, Item ID( "CO", 1 ) )
        )}
    );
,
    obj << Color Range( 1, 20 )
);


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

**Description:** Sets the color theme used for the treemap.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Treemap( Categories( :city ), Coloring( :POP ) );
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    report = obj << report;
    report << Dispatch( {}, "400", ScaleBox,
        {Legend Model(
            1,
            Properties(
                0,
                {gradient(
                    {Color Theme(
                        {"Custom", 4099, {HLS Color( 30 / 360, .5, 1 ),
                        HLS Color( 15 / 360, 1, 1 ), HLS Color( 0 / 360, .5, 1 ),
                        Missing( "Black" )}}
                    )}
                )},
                Item ID( "POP", 1 )
            )
        )}
    );
,
    obj << Color Theme(
        {"Custom", 4099, {HLS Color( 30 / 360, .5, 1 ), HLS Color( 15 / 360, 1, 1 ),
        HLS Color( 0 / 360, .5, 1 )}}
    )
);


```

### [Layout](#layout)

**Syntax:** obj = Treemap(...Layout( "Split"|"Squarify"|"Mixed" )...)

### [Legend](#legend)

**Syntax:** obj \<< Legend( state=0|1 )

**Description:** Shows or hides a legend showing the values of the color column mapped to actual colors.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
obj = dt << Treemap( Categories( :city ), Coloring( :POP ) );
obj << Legend( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :Population ),
    Ordering( :X, :Y )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Treemap(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Triangulation](#triangulation)

## [Associated Constructors](#associated-constructors)

### [Triangulation](#triangulation_1)

**Syntax:** triangulation = Triangulation( X(Column1, Column2), < Y(Column) > )

**Description:** Returns an object containing the Delaunay triangulation of the given point set. The optional Y will be averaged for duplicate points, and all points in the output will be unique.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );


```

**Example 2**

```

tri = Triangulation( X( [0 0 1 1], [0 1 0 1] ), Y( [0 1 2 3] ) );


```

## [Item Messages](#item-messages)

### [Get Edges](#get-edges)

**Syntax:** edges = obj \<< Get Edges

**Description:** Returns the indices of the edges in the form an Nx2 matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get Edges;


```

### [Get Hull Edges](#get-hull-edges)

**Syntax:** ind = obj \<< Get Hull Edges

**Description:** Returns the indices of the edges on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get Hull Edges;


```

### [Get Hull Path](#get-hull-path)

**Syntax:** ind = obj \<< Get Hull Path

**Description:** Returns the boundary of the triangulation as a path.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get Hull Path;


```

### [Get Hull Points](#get-hull-points)

**Syntax:** ind = obj \<< Get Hull Points

**Description:** Returns the indices of the points on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get Hull Points;


```

### [Get N Edges](#get-n-edges)

**Syntax:** nedge = obj \<< Get N Edges

**Description:** Returns the number of edges in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get NEdges;


```

### [Get N Hull Edges](#get-n-hull-edges)

**Syntax:** nhull = obj \<< Get N Hull Edges

**Description:** Returns the number of edges on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get N Hull Edges;


```

### [Get N Hull Points](#get-n-hull-points)

**Syntax:** nhull = obj \<< Get N Hull Points

**Description:** Returns the number of points on the boundary of the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get N Hull Points;


```

### [Get N Points](#get-n-points)

**Syntax:** npt = obj \<< Get N Points

**Description:** Returns the number of unique points in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get N Points;


```

### [Get N Triangles](#get-n-triangles)

**Syntax:** ntri = obj \<< Get N Triangles

**Description:** Returns the number of triangles.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get N Triangles;


```

### [Get Points](#get-points)

**Syntax:** {x1,x2} = obj \<< Get Points

**Description:** Returns the coordinates of the unique points in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get Points;


```

### [Get Triangles](#get-triangles)

**Syntax:** m = obj \<< Get Triangles

**Description:** Returns the indices of the triangles in the form of an Nx3 matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get Triangles;


```

### [Get Y](#get-y)

**Syntax:** y = obj \<< Get Y

**Description:** Returns the Y values of the unique points in the triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Get Y;


```

### [Peel](#peel)

**Syntax:** tri = obj \<< Peel

**Description:** Peel the boundary layer of a triangulation, returning a new triangulation.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
Show( tri << Get N Triangles );
tri2 = tri << Peel;
Show( tri2 << Get N Triangles );


```

### [Subset](#subset)

**Syntax:** tri = obj \<< Subset( {indices} )

**Description:** Returns a triangulation resulting from the given subset of points.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
Show( tri << Get N Triangles );
tri2 = tri << Subset( tri << Get Hull Points );
Show( tri2 << Get N Triangles );


```

### [Transform](#transform)

**Syntax:** obj \<< Transform( "None"|"Range Normalized" )

**Description:** Set the transform for the triangulation computation. Transformation will not affect the coordinates of the output, but the triangulation will be computed in the transformed space. This might result in a different triangulation depending on the aspect ratio of the coordinate space and transformed space.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
tri << Transform( "Range Normalized" );


```

# [Type 1 Gauge](#type-1-gauge)

## [Associated Constructors](#associated-constructors)

### [Type 1 Gauge](#type-1-gauge_1)

**Syntax:** Type 1 Gauge( Y( column ) )

**Description:** Analyzes measurement systems using the Type 1 Gauge method to evaluate the repeatability and bias of a measurement process on one reference part.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Type 1 Gauge(...\<By( column(s) )>...)

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    set values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) )
    ),
    By( _bycol )
);


```

### [Freq](#freq)

**Syntax:** obj = Type 1 Gauge(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Formula( Random Integer( 1, 5 ) ) );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) )
    ),
    Freq( _freqcol )
);


```

### [Measurement](#measurement)

**Syntax:** obj = Type 1 Gauge(...Measurement( column(s) )...)

**Description:** Specifies the continuous column(s) of measurements.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Measurement( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);


```

### [Y](#y)

**Syntax:** obj = Type 1 Gauge(...Y( column(s) )...)

**Description:** Specifies the continuous column(s) of measurements.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Measurement( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);


```

## [Item Messages](#item-messages)

### [Percent of Tolerance](#percent-of-tolerance)

**Syntax:** obj = Type 1 Gauge(...Percent of Tolerance( number=20 )...)

**Description:** Changes the percent of part tolerance used to compare against the measurement variation. "20" by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    Percent of Tolerance( 10 )
);


```

### [Save Type 1 Gauge Metadata as Column Properties](#save-type-1-gauge-metadata-as-column-properties)

**Syntax:** obj \<< Save Type 1 Gauge Metadata as Column Properties

**Description:** For each column of measurement data, saves the Type 1 Gauge metadata as an MSA Metadata column property within the column of the original data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2.5 ), Reference( 50.014 ), Resolution( .01 ) ),
        :Y2( Tolerance Range( 10 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 3 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Save Type 1 Gauge Metadata as Column Properties;


```

### [Save Type 1 Gauge Metadata to Table](#save-type-1-gauge-metadata-to-table)

**Syntax:** obj \<< Save Type 1 Gauge Metadata to Table

**Description:** Creates a new data table that contains the Type 1 Gauge metadata for each column of measurement data. The table is in a tall format and contains a row for each measurement variable.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Save Type 1 Gauge Metadata to Table;


```

### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj = Type 1 Gauge(...Set Alpha Level( number=.05 )...)

**Description:** Specifies the alpha level that is used in the Bias Test. ".05" by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    Type 1 Gauge Analysis( "Y1", Bias Test( 1 ) ),
    Type 1 Gauge Analysis( "Y2", Bias Test( 1 ) ),
    Type 1 Gauge Analysis( "Y3", Bias Test( 1 ) ),
    Set Alpha Level( .01 )
);


```

### [Sigma Multiplier](#sigma-multiplier)

**Syntax:** obj = Type 1 Gauge(...Sigma Multiplier( number=6 )...)

**Description:** Specifies a constant value that is multiplied by sigma. "6" by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    Sigma Multiplier( 4 )
);


```

### [Type 1 Gauge Analysis](#type-1-gauge-analysis)

**Syntax:** obj \<< Type 1 Gauge Analysis

**Description:** Specifies the Type 1 Gauge Analysis report options for each measurement response.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    Type 1 Gauge Analysis( "Y1", Histogram( 1 ) ),
    Type 1 Gauge Analysis( "Y2", Run Chart( 1, Show Mean( 1 ) ) ),
    Type 1 Gauge Analysis( "Y3", Histogram( 1, Show Count Axis( 1 ) ) )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Type 1 Gauge(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Type 1 Gauge Analysis > Type 1 Gauge Summary Statistics](#type-1-gauge-analysis-type-1-gauge-summary-statistics)

### [Item Messages](#item-messages_1)

#### [Customize Summary and Capability Statistics](#customize-summary-and-capability-statistics)

**Syntax:** obj \<< Customize Summary and Capability Statistics(statistic1( state=0|1 ), statistic2( state=0|1 ), ..., statisticN( state=0|1 )

**Description:** Customizes the summary statistics that are displayed in the Summary and Capability Statistics report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    )
);
obj << (Type 1 Gauge Analysis[1] <<
Summary and Capability Statistics(
    1,
    Customize Summary and Capability Statistics( Std Dev( 0 ), Bias( 0 ) )
));


```

## [Type 1 Gauge Analysis](#type-1-gauge-analysis_1)

### [Item Messages](#item-messages_2)

#### [Apply Preset](#apply-preset_1)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << (Type 1 Gauge Analysis[1] << Bias Test( 1 ));
Report( obj )["Type 1 Gauge Analysis for Y1", "Summary and Capability Statistics"] <<
Close( 1 );
preset = obj << (Type 1 Gauge Analysis[1] << New Preset);
Wait( 1 );
obj << (Type 1 Gauge Analysis[2] << Apply Preset( preset ));


```

#### [Bias Test](#bias-test)

**Syntax:** obj \<< (Type 1 Gauge Analysis[number] \<< Bias Test( state=0|1 ))

**Description:** Shows or hides a bias test of the mean of the observed measurements and the reference standard value in the Type 1 Gauge Analysis report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    )
);
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Bias Test( 1 ));


```

#### [Histogram](#histogram)

**Syntax:** obj \<< (Type 1 Gauge Analysis[number] \<< Histogram( state=0|1 ))

**Description:** Shows or hides a histogram of the measurement data in the Type 1 Gauge Analysis report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    )
);
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Histogram( 1 ));


```

#### [New Preset](#new-preset_1)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1, :Y2, :Y3 ),
    Type 1 Gauge Metadata(
        :Y1( Tolerance Range( 2 ), Reference( 50.014 ), Resolution( .001 ) ),
        :Y2( Tolerance Range( 6 ), Reference( 24.9 ), Resolution( .01 ) ),
        :Y3( Tolerance Range( 5 ), Reference( 10 ), Resolution( .0005 ) )
    )
);
obj << (Type 1 Gauge Analysis[1] << Bias Test( 1 ));
Report( obj )["Type 1 Gauge Analysis for Y1", "Summary and Capability Statistics"] <<
Close( 1 );
preset = obj << (Type 1 Gauge Analysis[1] << New Preset);


```

#### [Run Chart](#run-chart)

**Syntax:** obj \<< (Type 1 Gauge Analysis[number] \<< Run Chart( state=0|1 ))

**Description:** Shows or hides the run chart of the measurement data in the Type 1 Gauge Analysis report. This chart shows the variation of the measurements with respect to the reference value and percent of tolerance range. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    )
);
(obj << report)["Run Chart"] << Select;
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Run Chart( 0 ));
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Run Chart( 1 ));
Wait( 1 );
(obj << report)["Run Chart"] << Deselect;


```

#### [Summary and Capability Statistics](#summary-and-capability-statistics)

**Syntax:** obj \<< ( Type 1 Gauge Analysis[number] \<< Summary and Capability Statistics( state=0|1 ))

**Description:** Shows or hides the Type 1 Gauge Summary and Capability Statistics table. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    )
);
(obj << report)["Summary and Capability Statistics"] << Select;
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Summary and Capability Statistics( 0 ));
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Summary and Capability Statistics( 1 ));
Wait( 1 );
(obj << report)["Summary and Capability Statistics"] << Deselect;


```

## [Type 1 Gauge Histogram](#type-1-gauge-histogram)

### [Item Messages](#item-messages_3)

#### [Show Count Axis](#show-count-axis)

**Syntax:** obj \<< (Type 1 Gauge Analysis[number] \<< Histogram(1, Show Count Axis( state=0|1 )))

**Description:** Shows or hides a count axis to the right of the histogram frame in the Type 1 Gauge Analysis report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    ),
    Type 1 Gauge Analysis( "Y1", Histogram( 1 ) )
);
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Histogram( 1, Show Count Axis( 1 ) ));


```

#### [Show Reference](#show-reference)

**Syntax:** obj \<< (Type 1 Gauge Analysis[number] \<< Histogram(1, Show Reference( state=0|1 )))

**Description:** Shows or hides the reference line on the histogram in the Type 1 Gauge Analysis report. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    ),
    Type 1 Gauge Analysis( "Y1", Histogram( 1 ) )
);
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Histogram( 1, Show Reference( 0 ) ));
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Histogram( 1, Show Reference( 1 ) ));
Wait( 1 );


```

## [Type 1 Gauge Run Chart](#type-1-gauge-run-chart)

### [Item Messages](#item-messages_4)

#### [Show Mean](#show-mean)

**Syntax:** obj \<< ( Type 1 Gauge Analysis[number] \<< Run Chart( 1, Show Mean( state=0|1 )))

**Description:** Shows or hides the mean line on the run chart in the Type 1 Gauge Analysis report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y2 ),
    Type 1 Gauge Metadata(
        :Y2(
            Lower Tolerance( 21.90 ),
            Upper Tolerance( 27.90 ),
            Reference( 24.90 ),
            Resolution( .01 )
        )
    )
);
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Run Chart( 1, Show Mean( 1 ) ));


```

#### [Show Portion of Tolerance](#show-portion-of-tolerance)

**Syntax:** obj \<< ( Type 1 Gauge Analysis[number] \<< Run Chart( 1, Show Portion of Tolerance( state=0|1 )))

**Description:** Shows or hides the portion of tolerance lines on the run chart in the Type 1 Gauge Analysis report. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    )
);
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Run Chart( 1, Show Portion of Tolerance( 0 ) ));
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Run Chart( 1, Show Portion of Tolerance( 1 ) ));


```

#### [Show Reference](#show-reference_1)

**Syntax:** obj \<< ( Type 1 Gauge Analysis[number] \<< Run Chart( 1, Show Reference( state=0|1 )))

**Description:** Shows or hides the reference line on the run chart in the Type 1 Gauge Analysis report. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/Type 1 Gauge MSA.jmp" );
obj = dt << Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( .001 )
        )
    )
);
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Run Chart( 1, Show Reference( 0 ) ));
Wait( 1 );
obj << (Type 1 Gauge Analysis[1] << Run Chart( 1, Show Reference( 1 ) ));


```

# [Uplift](#uplift)

## [Associated Constructors](#associated-constructors)

### [Uplift](#uplift_1)

**Syntax:** Uplift( Y( column ), X( columns ), Treatment( column ) )

**Description:** Fits a recursive partition tree that selects splits to maximize treatment differences. The models identify groups of individuals who are most likely to respond to a treatment.

**Example 1**

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

**Example 2**

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 3 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj \<< By( column(s) )

**Description:** Performs a separate analysis for each level of the specified column.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);


```

### [Factor](#factor)

**Syntax:** obj \<< Factor( column(s) )

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

### [Freq](#freq)

**Syntax:** obj \<< Freq( column )

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    Freq( :_freqcol )
);


```

### [Response](#response)

**Syntax:** obj \<< Response( column(s) )

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

### [Treatment](#treatment)

**Syntax:** obj \<< Treatment( column )

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

### [Validation](#validation)

**Syntax:** obj \<< Validation( column )

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

### [Weight](#weight)

**Syntax:** obj \<< Weight( column )

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    Weight( :_weightcol )
);


```

### [X](#x)

**Syntax:** obj \<< X( column(s) )

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

### [Y](#y)

**Syntax:** obj \<< Y( column(s) )

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);


```

## [Item Messages](#item-messages)

### [Color Points](#color-points)

**Syntax:** obj \<< Color Points

**Description:** Colors the points according to their classification.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Color Points;


```

### [Column Contributions](#column-contributions)

**Syntax:** obj \<< Column Contributions( state=0|1 )

**Description:** Shows or hides a report with each input column and its corresponding contribution to the fit.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Column Contributions( 1 );


```

### [Get Average Absolute Error Test](#get-average-absolute-error-test)

**Syntax:** obj \<< Get Average Absolute Error Test

**Description:** Returns the Mean Abs Dev statistic for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Test;
Show( aabs );


```

### [Get Average Absolute Error Training](#get-average-absolute-error-training)

**Syntax:** obj \<< Get Average Absolute Error Training

**Description:** Returns the Mean Abs Dev statistic for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Training;
Show( aabs );


```

### [Get Average Absolute Error Validation](#get-average-absolute-error-validation)

**Syntax:** obj \<< Get Average Absolute Error Validation

**Description:** Returns the Mean Abs Dev statistic for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
aabs = obj << Get Average Absolute Error Validation;
Show( aabs );


```

### [Get Average Log Error Test](#get-average-log-error-test)

**Syntax:** obj \<< Get Average Log Error Test

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Test;
Show( avg );


```

### [Get Average Log Error Training](#get-average-log-error-training)

**Syntax:** obj \<< Get Average Log Error Training

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Training;
Show( avg );


```

### [Get Average Log Error Validation](#get-average-log-error-validation)

**Syntax:** obj \<< Get Average Log Error Validation

**Description:** Returns the average of -log(p), where p equals the probability of response attributed by the model that the response actually occurred, for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
avg = obj << Get Average Log Error Validation;
Show( avg );


```

### [Get Confusion Matrix Test](#get-confusion-matrix-test)

**Syntax:** obj \<< Get Confusion Matrix Test

**Description:** Returns the confusion matrix for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Test;
Show( cm );


```

### [Get Confusion Matrix Training](#get-confusion-matrix-training)

**Syntax:** obj \<< Get Confusion Matrix Training

**Description:** Returns the confusion matrix for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Training;
Show( cm );


```

### [Get Confusion Matrix Validation](#get-confusion-matrix-validation)

**Syntax:** obj \<< Get Confusion Matrix Validation

**Description:** Returns the confusion matrix for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cm = obj << Get Confusion Matrix Validation;
Show( cm );


```

### [Get Confusion Rates Test](#get-confusion-rates-test)

**Syntax:** obj \<< Get Confusion Rates Test

**Description:** Returns the confusion rates for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Test;
Show( cr );


```

### [Get Confusion Rates Training](#get-confusion-rates-training)

**Syntax:** obj \<< Get Confusion Rates Training

**Description:** Returns the confusion rates for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Training;
Show( cr );


```

### [Get Confusion Rates Validation](#get-confusion-rates-validation)

**Syntax:** obj \<< Get Confusion Rates Validation

**Description:** Returns the confusion rates for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
cr = obj << Get Confusion Rates Validation;
Show( cr );


```

### [Get Difference Formula](#get-difference-formula)

**Syntax:** obj \<< Get Difference Formula

**Description:** Constructs a script to create a difference formula and returns it.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Get Difference Formula;


```

### [Get Gen RSquare Test](#get-gen-rsquare-test)

**Syntax:** obj \<< Get Gen RSquare Test

**Description:** Returns the generalized RSquare for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Test;
Show( r );


```

### [Get Gen RSquare Training](#get-gen-rsquare-training)

**Syntax:** obj \<< Get Gen RSquare Training

**Description:** Returns the generalized RSquare for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Training;
Show( r );


```

### [Get Gen RSquare Validation](#get-gen-rsquare-validation)

**Syntax:** obj \<< Get Gen RSquare Validation

**Description:** Returns the generalized RSquare for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :sex ),
    X( :marital status, :age, :country, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Go
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
r = obj << Get Gen RSquare Validation;
Show( r );


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**Description:** Returns summary measures of fit from the model.

**JMP Version Added:** 16

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Get Measures;


```

### [Get Microseconds](#get-microseconds)

**Syntax:** obj \<< Get Microseconds

**Description:** Returns the number of microseconds used to complete the analysis.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
time = obj << Get Microseconds;
Show( time );


```

### [Get Misclassification Rate Test](#get-misclassification-rate-test)

**Syntax:** obj \<< Get Misclassification Rate Test

**Description:** Returns the misclassification rate for the test set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt << Make Validation Column(
    Training Set( .6 ),
    Validation Set( .2 ),
    Test Set( .2 ),
    New Column Name( "Valid1" ),
    Go
);
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Valid1 ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Test;
Show( rate );


```

### [Get Misclassification Rate Training](#get-misclassification-rate-training)

**Syntax:** obj \<< Get Misclassification Rate Training

**Description:** Returns the misclassification rate for the training set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Method( "Decision Tree" )
);
obj << Split Best( 2 );
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Training;
Show( rate );


```

### [Get Misclassification Rate Validation](#get-misclassification-rate-validation)

**Syntax:** obj \<< Get Misclassification Rate Validation

**Description:** Returns the misclassification rate for the validation set. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << New Column( "Holdback1", formula( Random Integer( 1, 3 ) ) );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    validation( :Holdback1 ),
    Method( "Decision Tree" ),
    Go
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation( :Validation ),
    Split Best( 2 )
);
rate = obj << Get Misclassification Rate Validation;
Show( rate );


```

### [Get Precision Recall Area Test](#get-precision-recall-area-test)

**Syntax:** obj \<< Get Precision Recall Area Test

**Description:** Returns the area under the precision-recall curve for the test set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Test;
Show( area );


```

### [Get Precision Recall Area Training](#get-precision-recall-area-training)

**Syntax:** obj \<< Get Precision Recall Area Training

**Description:** Returns the area under the precision-recall curve for the training set. The precision-recall curve must be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Training;
Show( area );


```

### [Get Precision Recall Area Validation](#get-precision-recall-area-validation)

**Syntax:** obj \<< Get Precision Recall Area Validation

**Description:** Returns the area under the precision-recall curve for the validation set. The precision-recall curve must be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << Precision Recall Curve;
area = obj << Get Precision Recall Area Validation;
Show( area );


```

### [Get Prediction Formula](#get-prediction-formula)

**Syntax:** obj \<< Get Prediction Formula

**Description:** Constructs a script to create a prediction formula column and returns it.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Get Prediction Formula;


```

### [Get RMS Error Test](#get-rms-error-test)

**Syntax:** obj \<< Get RMS Error Test

**Description:** Returns the square root of the mean square of the test errors. Available only when using a validation set.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
rms = obj << Get RMS Error Test;
Show( rms );


```

### [Get RMS Error Training](#get-rms-error-training)

**Syntax:** obj \<< Get RMS Error Training

**Description:** Returns the square root of the mean square of the training errors.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
rms = obj << Get RMS Error Training;
Show( rms );


```

### [Get RMS Error Validation](#get-rms-error-validation)

**Syntax:** obj \<< Get RMS Error Validation

**Description:** Returns the square root of the mean square of the validation errors. Available only when using a validation set.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
rms = obj << Get RMS Error Validation;
Show( rms );


```

### [Get ROC Area Test](#get-roc-area-test)

**Syntax:** obj \<< Get ROC Area Test

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the test data. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
dt << Make Validation Column( Training Set( .6 ), Validation Set( .2 ), Test Set( .2 ), Go );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation( :Validation 2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Test;
Show( area );


```

### [Get ROC Area Training](#get-roc-area-training)

**Syntax:** obj \<< Get ROC Area Training

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the training data set. The ROC curve needs to be displayed before the area is computed.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Go
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 2 )
);
obj << Show Tree( 0 );
obj << ROC Curve;
area = obj << Get ROC Area Training;
Show( area );


```

### [Get ROC Area Validation](#get-roc-area-validation)

**Syntax:** obj \<< Get ROC Area Validation

**Description:** Returns the area under the Receiver Operator Characteristic (ROC) curve for the validation data set. The ROC curve needs to be displayed before the area is computed. Available only when using a validation set.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Validation Portion( 0.2 ),
    Method( "Decision Tree" ),
    Go
);
obj << ROC Curve;
area = obj << Get ROC Area Validation;
Show( area );


```

### [Get RSquare Test](#get-rsquare-test)

**Syntax:** obj \<< Get RSquare Test

**Description:** Returns the RSquare for the test set. Available only when using a validation set.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
r = obj << Get RSquare Test;
Show( r );


```

### [Get RSquare Training](#get-rsquare-training)

**Syntax:** obj \<< Get RSquare Training

**Description:** Returns the RSquare for the training set.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
r = obj << Get RSquare Training;
Show( r );


```

### [Get RSquare Validation](#get-rsquare-validation)

**Syntax:** obj \<< Get RSquare Validation

**Description:** Returns the RSquare for the validation set. Available only when using a validation set.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
r = obj << Get RSquare Validation;
Show( r );


```

### [Get Seconds](#get-seconds)

**Syntax:** obj \<< Get Seconds

**Description:** Returns the number of seconds used to complete the analysis.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
time = obj << Get Seconds;
Show( time );


```

### [Get Tolerant Prediction Formula](#get-tolerant-prediction-formula)

**Syntax:** obj \<< Get Tolerant Prediction Formula

**Description:** Constructs a script to create a tolerant prediction formula column and returns it to the Log window.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Get Tolerant Prediction Formula;


```

### [Go](#go)

**Syntax:** obj \<< Go

**Description:** Begins iterating after K Fold Crossvalidation has been selected. If using JMP Pro, Go begins iterating after Validation column is specified.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << K Fold Crossvalidation( 5 );
obj << Go;


```

### [Informative Missing](#informative-missing)

**Syntax:** obj = Uplift(...Informative Missing( state=0|1 )...)

**Description:** For categorical variables, treats missing as a category. For continuous variables, treats missing as either low or high, whichever fits better. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Boosted Tree( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Informative Missing( 0 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:age[3] = .;
obj = dt << Partition( Y( :height ), X( :age ), Informative Missing( 0 ) );
obj << Split Best( 1 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
dt:Age[3] = .;
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Informative Missing( 0 ),
    Split Best( 3 )
);


```

### [Leaf Report](#leaf-report)

**Syntax:** obj \<< Leaf Report( state=0|1 )

**Description:** Shows or hides a report with the mean and count (continuous response) or the response rate and count (categorical response) of the leaf nodes.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Show Tree( 0 );
obj << Leaf Report( 1 );


```

### [Lock Columns](#lock-columns)

**Syntax:** obj \<< Lock Columns( state=0|1, columns )

**Description:** Locks out specified columns from being used for splits.

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Lock Columns( 1, :age, :size );
(obj << report)[CheckboxBox( 1 )] << Select;
Wait( .5 );
obj << Lock Columns( 0 );
Wait( .5 );
obj << Lock Columns( 1 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion )
);
obj << Lock Columns( 1, :Age, :Hair Color );
(obj << report)[CheckboxBox( 1 )] << Select;
Wait( .5 );
obj << Lock Columns( 0 );
Wait( .5 );
obj << Lock Columns( 1 );


```

### [Minimum Size Split](#minimum-size-split)

**Syntax:** obj \<< Minimum Size Split( number )

**Description:** Sets the minimum group size when deciding whether to split a group.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Minimum Size Split( 15 );
obj << Split Best( 4 );


```

### [Multithreading](#multithreading)

**Syntax:** Multithreading( state=0|1 )

**Description:** Divides up the calculations among the available threads on the machine. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Multithreading( 1 ),
    Split Best( 2 )
);


```

### [Ordinal Restricts Order](#ordinal-restricts-order)

**Syntax:** obj = Uplift(...Ordinal Restricts Order( state=0|1 )...)

**Description:** For ordinal columns, considers only splits that preserve order. On by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Boosted Tree( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bootstrap Forest( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ), Go );


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Partition( Y( :height ), X( :age ), Ordinal Restricts Order( 1 ) );
obj << Split Best( 3 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Ordinal Restricts Order( 1 ),
    Split Best( 2 )
);


```

### [Plot Actual by Predicted](#plot-actual-by-predicted)

**Syntax:** obj \<< Plot Actual by Predicted( state=0|1 )

**Description:** Shows or hides a plot using the training data with the predicted values on the X axis and actual values on the Y axis.

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Split Best( 3 )
);
obj << Plot Actual By Predicted;


```

### [Profiler](#profiler)

**Syntax:** obj \<< Profiler( state=0|1 )

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Profiler( 1 );


```

### [Prune Worst](#prune-worst)

**Syntax:** obj \<< Prune Worst

**Description:** Removes the terminal split that has the least discrimination ability.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Prune Worst;
Wait( .5 );
obj << Prune Worst;


```

### [Publish Difference Formula](#publish-difference-formula)

**Syntax:** obj \<< Publish Difference Formula

**Description:** Builds a difference formula and publishes it as a formula column script in Formula Depot.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Publish Difference Formula;


```

### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Publish Prediction Formula;


```

### [Publish Tolerant Prediction Formula](#publish-tolerant-prediction-formula)

**Syntax:** obj \<< Publish Tolerant Prediction Formula

**Description:** Builds a prediction formula that predicts even when there are missing values and publishes it as a formula column script in Formula Depot.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Publish Tolerant Prediction Formula;


```

### [Save Difference](#save-difference)

**Syntax:** obj \<< Save Difference

**Description:** Saves the predicted treatment difference.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Difference;


```

### [Save Difference Formula](#save-difference-formula)

**Syntax:** obj \<< Save Difference Formula

**Description:** Saves a formula column with the predicted treatment difference.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Difference Formula;


```

### [Save Leaf Label Formula](#save-leaf-label-formula)

**Syntax:** obj \<< Save Leaf Label Formula

**Description:** Saves the leaf label formula in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Leaf Label Formula;


```

### [Save Leaf Labels](#save-leaf-labels)

**Syntax:** obj \<< Save Leaf Labels

**Description:** Saves the leaf labels in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Leaf Labels;


```

### [Save Leaf Number Formula](#save-leaf-number-formula)

**Syntax:** obj \<< Save Leaf Number Formula

**Description:** Saves the leaf number formula in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Leaf Number Formula;


```

### [Save Leaf Numbers](#save-leaf-numbers)

**Syntax:** obj \<< Save Leaf Numbers

**Description:** Saves the leaf numbers in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Leaf Numbers;


```

### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds

**Description:** Saves the predicted values in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Predicteds;


```

### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the prediction formula in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Prediction Formula;


```

### [Save Residuals](#save-residuals)

**Syntax:** obj \<< Save Residuals

**Description:** Saves the residuals in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Residuals;


```

### [Save Tolerant Prediction Formula](#save-tolerant-prediction-formula)

**Syntax:** obj \<< Save Tolerant Prediction Formula

**Description:** Save a formula that predicts even when there are missing values in a new column in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Tolerant Prediction Formula;


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number )

**Description:** Specifies a random seed to reproduce the results for future launches of the platform.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Boosted Tree(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Bootstrap Forest(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
obj = dt << Partition(
    Y( :Y Binary ),
    X( :Age, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Set Random Seed( 1234 ),
    Split Best( 2 )
);


```

### [Show Fit Details](#show-fit-details)

**Syntax:** obj \<< Show Fit Details( state=0|1 )

**Description:** Shows or hides a report with the definition of all the measures, the misclassification rates, and the confusion matrices.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Show Tree( 0 );
obj << Show Fit Details( 1 );


```

### [Show Graph](#show-graph)

**Syntax:** obj \<< Show Graph( state=0|1 )

**Description:** Shows or hides the partition graph. On by default.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << ShowGraph( 0 );
Wait( .5 );
obj << ShowGraph( 1 );


```

### [Show Points](#show-points)

**Syntax:** obj \<< Show Points( state=0|1 )

**Description:** Shows the points (1 or on) or shows color panels (0 or off) in the partition graph. On by default.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << ShowPoints( 0 );
Wait( .5 );
obj << ShowPoints( 1 );


```

### [Show Split Candidates](#show-split-candidates)

**Syntax:** obj \<< Show Split Candidates( state=0|1 )

**Description:** Shows or hides the Candidates report in the terminal splits. On by default.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Show Split Candidates( 1 );
(obj << Report)["Candidates"] << Close( 0 ) << select;


```

### [Show Split Stats](#show-split-stats)

**Syntax:** obj \<< Show Split Stats( state=0|1 )

**Description:** Shows or hides the count and the split statistics. The statistics shown include the G² or the mean and standard deviation. On by default.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Show Split Stats( 0 );
Wait( .5 );
obj << Show Split Stats( 1 );


```

### [Show Tree](#show-tree)

**Syntax:** obj \<< Show Tree( state=0|1 )

**Description:** Shows or hides the tree structure with the partition information. On by default.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << ShowTree( 1 );


```

### [Small Tree View](#small-tree-view)

**Syntax:** obj \<< Small Tree View( state=0|1 )

**Description:** Shows or hides a smaller version of the partition tree to the right of the Partition Graph.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Small Tree View( 1 );


```

### [Sort Split Candidates](#sort-split-candidates)

**Syntax:** obj \<< Sort Split Candidates( state=0|1 )

**Description:** Sorts the candidates by significance.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
(obj << Report)["Candidates"] << Close( 0 ) << select;
Wait( 1 );
obj << Sort Split Candidates;


```

### [Split Best](#split-best)

**Syntax:** obj \<< Split Best( <number of splits> )

**Description:** Splits the tree at the optimal split point.

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best;
Wait( .5 );
obj << Split Best( 2 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion )
);
obj << Split Best;
Wait( 1 );
obj << Split Best( 2 );


```

### [Split History](#split-history)

**Syntax:** obj \<< Split History( state=0|1 )

**Description:** Shows or hides a graph showing each split on the X axis and the corresponding R² value for the model on the Y axis.

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition( Y( :country ), X( :sex, :marital status, :age, :type, :size ) );
obj << Split Best( 5 );
obj << Show Tree( 0 );
obj << Split History;


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion )
);
obj << Split Best( 2 );
obj << Show Tree( 0 );
obj << Split History;


```

### [Uplift Graph](#uplift-graph)

**Syntax:** obj \<< Uplift Graph( state=0|1 )

**Description:** Shows uplift across sorted terminal leaves.

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion )
);
obj << Split Best( 2 );
obj << Uplift Graph;


```

### [Use Excluded Rows for Validation](#use-excluded-rows-for-validation)

**Syntax:** obj = Uplift(...Use Excluded Rows for Validation( state=0|1 )...)

**Description:** Uses the excluded rows in the data table to create a validation set. This option appears in the launch window only if you are using standard JMP and there are excluded rows.

**JMP Version Added:** 15

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Boosted Tree(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Bootstrap Forest(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Diabetes.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Partition(
    Y( :Y ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose ),
    Use Excluded Rows for Validation( 1 )
);
obj << Split Best( 5 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
For Each( {i}, 10 :: 200 :: 10, Row State( i ) = Excluded State( 1 ) );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Use Excluded Rows for Validation( 1 ),
    Split Best( 2 )
);


```

### [Validation Portion](#validation-portion)

**Syntax:** obj = Uplift(...Validation Portion( fraction=0 )...)

**Description:** Forms a validation set by randomly selecting rows with each row having probability p (fraction) of being selected. "0" by default.

**Boosted Tree Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Boosted Tree(
    Y( :marital status ),
    X( :sex, :country, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Bootstrap Forest Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Bootstrap Forest(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 ),
    Go
);


```

**Partition Example**

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Partition(
    Y( :country ),
    X( :sex, :marital status, :age, :type, :size ),
    Validation Portion( 0.2 )
);
obj << Split Best( 2 );


```

**Uplift Example**

```

dt = Open( "$SAMPLE_DATA/Hair Care Product.jmp" );
obj = dt << Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Validation Portion( 0.2 ),
    Go
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$Sample_Data/Hair Care Product.jmp" );
obj = Uplift(
    Y( :Purchase ),
    X( :Gender, :Age, :Hair Color, :U.S. Region, :Residence ),
    Treatment( :Promotion ),
    Split Best( 3 )
);
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Uplift(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

# [Variability Chart](#variability-chart)

## [Associated Constructors](#associated-constructors)

### [Variability Chart](#variability-chart_1)

**Syntax:** Variability Chart( Y( column ), X( columns ) )

**Description:** Analyzes continuous measurements to determine how your measurement system is performing. You can also perform a gauge study to see measures of variation in your data.

#### [Crossed Effects Model](#crossed-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    Model( "Crossed" ),
    X( :Operator, :part# ),
    Variance Components( 1 )
);


```

#### [Crossed then Nested Effects Model](#crossed-then-nested-effects-model)

```

dt = New Table( "3 Factors Crossed then Nested",
    Add Rows( 81 ),
    New Column( "Operator",
        Character( 7 ),
        "Nominal",
        Set Values(
            {"Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara", "Clara",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo",
            "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Eduardo", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane", "Jane",
            "Jane", "Jane", "Jane", "Jane", "Jane"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Instrument",
        Character( 1 ),
        "Nominal",
        Set Values(
            {"A", "A", "A", "A", "A", "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B",
            "B", "B", "C", "C", "C", "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A",
            "A", "A", "A", "A", "B", "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C",
            "C", "C", "C", "C", "C", "C", "A", "A", "A", "A", "A", "A", "A", "A", "A", "B",
            "B", "B", "B", "B", "B", "B", "B", "B", "C", "C", "C", "C", "C", "C", "C", "C",
            "C"}
        ),
        Set Display Width( 0 )
    ),
    New Column( "Part",
        Numeric,
        "Nominal",
        Format( "Best", 8 ),
        Set Values(
            [1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4, 5, 5, 5, 6, 6, 6, 7, 7, 7, 8, 8, 8, 9, 9, 9,
            10, 10, 10, 11, 11, 11, 12, 12, 12, 13, 13, 13, 14, 14, 14, 15, 15, 15, 16, 16,
            16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20, 20, 20, 21, 21, 21, 22, 22, 22, 23,
            23, 23, 24, 24, 24, 25, 25, 25, 26, 26, 26, 27, 27, 27]
        ),
        Set Display Width( 0 )
    ),
    New Column( "Y",
        Numeric,
        "Continuous",
        Format( "Best", 8 ),
        Set Values(
            [0.5, 0.6, 0.2, 0.8, 0.6, 0.6, 1.6, 1.1, 1, 0.4, 0.2, 0.1, 0.1, 0.5, 0, 0.3, 0.6,
            0.8, 0.1, 0.1, 0.2, 0.4, 0.9, 1.8, 0.1, 0.3, 0.4, 0.1, 0.3, 0.1, 0.9, 0.4, 0, 0.6,
            0.7, 0.7, 0.3, 0.1, 0.2, 0.3, 0.6, 0.2, 0.2, 0.4, 0.4, 0.8, 0.3, 0.3, 2.6, 0.4,
            1.6, 0.5, 0.3, 2.9, 0, 0, 0.5, 0.1, 0, 0.3, 0.5, 0, 0, 0.4, 0, 0.4, 0.3, 0.2, 0,
            0, 0.5, 0.1, 0.1, 0.2, 0.3, 1.1, 0.2, 0.1, 0.6, 0.3, 0.6]
        ),
        Set Display Width( 68 )
    )
);
obj = dt << Variability Chart(
    Y( :Y ),
    X( :Operator, :Instrument, :Part ),
    Model( "Crossed then Nested" ),
    Variance Components( 1 )
);


```

#### [Decide Later on Model](#decide-later-on-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );


```

#### [Main Effects Model](#main-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/Wafer.jmp" );
obj = dt << Variability Chart(
    Y( :Y ),
    Model( "Main Effect" ),
    X( :Operator, :Wafer ),
    Variance Components( 1 )
);


```

#### [Nested Effects Model](#nested-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Nested.jmp" );
obj = dt << Variability Chart(
    Y( :Y ),
    Model( "Nested" ),
    X( :Operator, :Part ),
    Variance Components( 1 )
);


```

#### [Nested then Crossed Effects Model](#nested-then-crossed-effects-model)

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Nested & Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Y ),
    Model( "Nested then Crossed" ),
    X( :Operator, :Instrument, :Part ),
    Variance Components( 1 )
);


```

## [Columns](#columns)

### [By](#by)

**Syntax:** obj = Variability Chart(...\<By( column(s) )>...)

**Description:** Produce multiple reports, one for each level of the variable(s).

```

dt = Open( "$SAMPLE_DATA/Variability Data/3 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :new Y ),
    X( :Operator, :part ),
    Model( "Crossed" ),
    By( :Instrument )
);


```

### [Freq](#freq)

**Syntax:** obj = Variability Chart(...\<Freq( column )>...)

**Description:** A column whose values assign a frequency to each row for the analysis.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ), Freq( :_freqcol ) );


```

### [Grouping](#grouping)

**Syntax:** obj = Variability Chart(...\<Grouping( column(s) )>...)

**Description:** Specifies categorical column(s) as grouping variables. The last column in the list should be the part or unit being measured.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), Grouping( :Operator, :part# ) );


```

### [Response](#response)

**Syntax:** obj = Variability Chart(...Response( column(s) )...)

**Description:** Specifies the continuous column(s) of measurements.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Response( :Measurement ), X( :Operator, :part# ) );


```

### [Standard](#standard)

**Syntax:** obj = Variability Chart(...\<Standard( column )>...)

**Description:** Specifies a standard or reference column that contains the known values for the measured part.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << Variability Chart(
    Y( :Response ),
    X( :Part ),
    Standard( :Standard ),
    Variability Analysis( :Response, Std Dev Chart( 0 ), Linearity Study( 1 ) )
);


```

### [X](#x)

**Syntax:** obj = Variability Chart(...\<X( column(s) )>...)

**Description:** Specifies categorical column(s) as grouping variables. The last column in the list should be the part or unit being measured.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), Grouping( :Operator, :part# ) );


```

### [Y](#y)

**Syntax:** obj = Variability Chart(...Y( column(s) )...)

**Description:** Specifies the continuous column(s) of measurements.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Response( :Measurement ), X( :Operator, :part# ) );


```

## [Item Messages](#item-messages)

### [Analysis Type](#analysis-type)

**Syntax:** obj = Variability Chart(...Analysis Type( "Choose best analysis (EMS REML Bayesian)"|"Choose best analysis (EMS REML)"|"Use REML analysis"|"Use Bayesian analysis" )...)

**Description:** Identifies the method used for computing variance components.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Use REML analysis" )
);
obj << (Variability Analysis[1] << Variance Components( 1 ));


```

### [Conv Limit](#conv-limit)

**Syntax:** obj = Variability Chart(...Conv Limit( number )...)

**Description:** Sets the convergence limit that is used for computing variance components. This option affects only REML analyses.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Use REML analysis" ),
    Conv Limit( 0.0000001 )
);
obj << (Variability Analysis[1] << Variance Components( 1 ));


```

### [Edit MSA Metadata](#edit-msa-metadata)

**Syntax:** obj \<< Edit MSA Metadata( :column( Lower Tolerance( number ), Upper Tolerance( number ), \<Historical Mean( number ), Historical Process Sigma( number )> ) )

**Description:** Opens a window that enables you to add or edit the tolerance range, tolerance limits, historical mean, and historical process sigma for all analyses. The reports are automatically updated.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    MSA Metadata( :Measurement( Lower Tolerance( .2 ), Upper Tolerance( 1.3 ) ) ),
    Variability Analysis( "Measurement", Misclassification Probabilities( 1 ) )
);
Wait( 1 );
obj << Edit MSA Metadata( :Measurement( Lower Tolerance( .1 ), Upper Tolerance( 1.4 ) ) );


```

### [Max Iter](#max-iter)

**Syntax:** obj = Variability Chart(...Max Iter( number )...)

**Description:** Sets the maximum number of iterations that are used for computing variance components. This option affects only REML analyses.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Use REML analysis" ),
    Max Iter( 50 )
);
obj << (Variability Analysis[1] << Variance Components( 1 ));


```

### [Number Function Evals](#number-function-evals)

**Syntax:** obj = Variability Chart(...Number Function Evals( number )...)

**Description:** Sets the maximum number of function evaluations that are used for computing variance components. This option affects only Bayesian analyses.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Use Bayesian analysis" ),
    Number Function Evals( 10000 )
);
obj << (Variability Analysis[1] << Variance Components( 1 ));


```

### [Number Integration Abscissas](#number-integration-abscissas)

**Syntax:** obj = Variability Chart(...Number Integration Abscissas( number )...)

**Description:** Sets the number of integration abscissas that are used for computing variance components. This option affects only Bayesian analyses.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Use Bayesian analysis" ),
    Number Integration Abscissas( 90 )
);
obj << (Variability Analysis[1] << Variance Components( 1 ));


```

### [Save All Metadata to Table](#save-all-metadata-to-table)

**Syntax:** obj \<< Save All Metadata to Table( < MSA( state=0|1 ) >, < Measurement Sigma( state=0|1 ) >, < Tolerance as Specs( state=0|1 ) > )

**Description:** Creates a new data table that contains the MSA metadata and Measurement Sigma for each column of measurement data. The table is in a tall format and contains a row for each measurement variable. There is an option to save the lower and upper tolerance values as additional columns in the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    MSA Metadata(
        :Measurement(
            Lower Tolerance( 0.2 ),
            Upper Tolerance( 1.3 ),
            Historical Process Sigma( 0.2 )
        )
    ),
    Model( "Crossed" ),
    Variability Analysis( "Measurement", "Gauge R&R Report"n( 1 ) )
);
obj << Save All Metadata to Table;


```

### [Save Metadata as Column Properties](#save-metadata-as-column-properties)

**Syntax:** obj \<< Save Metadata as Column Properties( < MSA( 0|1 ) >, < Measurement Sigma( 0|1 ) >, < Tolerance as Specs( 0|1 ) > )

**Description:** For each column of measurement data, saves the MSA metadata and Measurement Sigma as column properties within the column of the original data table. There is an option to save the lower and upper tolerance values as Spec Limits column properties.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    MSA Metadata(
        :Measurement(
            Lower Tolerance( 0.2 ),
            Upper Tolerance( 1.3 ),
            Historical Process Sigma( 0.2 )
        )
    ),
    Model( "Crossed" ),
    Variability Analysis( "Measurement", "Gauge R&R Report"n( 1 ) )
);
obj << Save Metadata as Column Properties;


```

### [Set Alpha Level](#set-alpha-level)

**Syntax:** obj = Variability Chart(...Set Alpha Level( number )...)

**Description:** Changes the alpha level that is used for confidence intervals and mean diamonds. This option corresponds to the Specify Alpha Level option in the Variability Chart launch window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Set Alpha Level( .1 )
);
obj << (Variability Analysis[1] << Mean Diamonds( 1 ));


```

### [Set Random Seed](#set-random-seed)

**Syntax:** obj = Variability Chart(...Set Random Seed( number )...)

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Set Random Seed( 1234 )
);
obj << (Variability Analysis[1] << Heterogeneity of Variance Tests( 1 ));


```

### [Sigma Multiplier](#sigma-multiplier)

**Syntax:** obj = Variability Chart(...Sigma Multiplier( number=6 )...)

**Description:** Specifies a constant value that is multiplied by sigma. "6" by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Sigma Multiplier( 5.15 ),
    Variability Analysis( "Measurement", "Gauge R&R Report"n( 1 ) )
);


```

### [Variability Analysis](#variability-analysis)

**Syntax:** obj \<< Variability Analysis

**Description:** Specifies the Variability Analysis report options for each measurement response.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Variability Analysis( "Measurement", Variance Components( 1 ), "Gauge R&R Report"n( 1 ) )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Automatic Recalc](#automatic-recalc)

**Syntax:** obj \<< Automatic Recalc( state=0|1 )

**Description:** Redoes the analysis automatically for exclude and data changes. If the Automatic Recalc option is turned on, you should consider using Wait(0) commands to ensure that the exclude and data changes take effect before the recalculation.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Automatic Recalc( 1 );
dt << Select Rows( 5 ) << Exclude( 1 );


```

### [Broadcast](#broadcast)

**Syntax:** obj \<< Broadcast(message)

**Description:** Broadcasts a message to a platform. If return results from individual objects are tables, they are concatenated if possible, and the final format is identical to either the result from the Save Combined Table option in a Table Box or the result from the Concatenate option using a Source column. Other than those, results are stored in a list and returned.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Quality Control/Diameter.jmp" );
objs = Control Chart Builder(
    Variables( Subgroup( :DAY ), Y( :DIAMETER ) ),
    By( :OPERATOR )
);
objs[1] << Broadcast( Save Summaries );


```

### [Column Switcher](#column-switcher)

**Syntax:** obj \<< Column Switcher(column reference, {column reference, ...}, < Title(title) >, < Close Outline(0|1) >, < Retain Axis Settings(0|1) >, < Layout(0|1) >)

**Description:** Adds a control panel for changing the platform's variables

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Copy Script;


```

### [Data Table Window](#data-table-window)

**Syntax:** obj \<< Data Table Window

**Description:** Move the data table window for this analysis to the front.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Data Table Window;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Group Platform](#get-group-platform)

**Syntax:** obj \<< Get Group Platform

**Description:** Return the Group Platform object if this platform is part of a Group. Otherwise, returns Empty().

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), By( :sex ) );
group = biv[1] << Get Group Platform;
Wait( 1 );
group << Layout( "Arrange in Tabs" );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Local Data Filter](#local-data-filter)

**Syntax:** obj \<< Local Data Filter

**Description:** To filter data to specific groups or ranges, but local to this platform

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Paste Local Data Filter](#paste-local-data-filter)

**Syntax:** obj \<< Paste Local Data Filter

**Description:** Apply the local data filter from the clipboard to the current report.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
filter = dist << Local Data Filter(
    Add Filter( columns( :Region ), Where( :Region == "MW" ) )
);
filter << Copy Local Data Filter;
dist2 = Distribution( Continuous Distribution( Column( :Lead ) ) );
Wait( 1 );
dist2 << Paste Local Data Filter;


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Relaunch Analysis;


```

### [Remove Column Switcher](#remove-column-switcher)

**Syntax:** obj \<< Remove Column Switcher

**Description:** Removes the most recent Column Switcher that has been added to the platform.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
obj = dt << Contingency( Y( :size ), X( :marital status ) );
ColumnSwitcherObject = obj << Column Switcher(
    :marital status,
    {:sex, :country, :marital status}
);
Wait( 2 );
obj << Remove Column Switcher;


```

### [Remove Local Data Filter](#remove-local-data-filter)

**Syntax:** obj \<< Remove Local Data Filter

**Description:** If a local data filter has been created, this removes it and restores the platform to use all the data in the data table directly

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
dist = dt << Distribution(
    Nominal Distribution( Column( :country ) ),
    Local Data Filter(
        Add Filter( columns( :sex ), Where( :sex == "Female" ) ),
        Mode( Show( 1 ), Include( 1 ) )
    )
);
Wait( 2 );
dist << remove local data filter;


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Report View](#report-view)

**Syntax:** obj \<< Report View( "Full"|"Summary" )

**Description:** The report view determines the level of detail visible in a platform report. Full shows all of the detail, while Summary shows only select content, dependent on the platform. For customized behavior, display boxes support a \<<Set Summary Behavior message.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Report View( "Summary" );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    By( :_bycol ),
    Group Options( Return Group( 1 ) )
);
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Sync to Data Table Changes](#sync-to-data-table-changes)

**Syntax:** obj \<< Sync to Data Table Changes

**Description:** Sync with the exclude and data changes that have been made.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
dist = Distribution( Continuous Distribution( Column( :POP ) ) );
Wait( 1 );
dt << Delete Rows( dt << Get Rows Where( :Region == "W" ) );
dist << Sync To Data Table Changes;


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Transform Column](#transform-column)

**Syntax:** obj = <Platform>(... Transform Column(<name>, Formula(<expression>), \[Random Seed(<n>)\], [Numeric|Character|Expression], [Continuous|Nominal|Ordinal|Unstructured Text], [column properties]) ...)

**Description:** Create a transform column in the local context of an object, usually a platform. The transform column is active only for the lifetime of the platform.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Transform Column( "age^2", Format( "Fixed Dec", 5, 0 ), Formula( :age * :age ) ),
    Continuous Distribution( Column( :"age^2"n ) )
);


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

### [Window View](#window-view)

**Syntax:** obj = Variability Chart(...Window View( "Visible"|"Invisible"|"Private" )...)

**Description:** Set the type of the window to be created for the report. By default a Visible report window will be created. An Invisible window will not appear on screen, but is discoverable by functions such as Window(). A Private window responds to most window messages but is not discoverable and must be addressed through the report object

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Window View( "Private" ), Y( :weight ), X( :height ), Fit Line );
eqn = Report( biv )["Linear Fit", Text Edit Box( 1 )] << Get Text;
biv << Close Window;
New Window( "Bivariate Equation",
    Outline Box( "Big Class Linear Fit", Text Box( eqn, <<Set Base Font( "Title" ) ) )
);


```

## [Variability Analysis > Bias Report](#variability-analysis-bias-report)

### [Item Messages](#item-messages_1)

#### [Confidence Intervals](#confidence-intervals)

**Syntax:** obj \<< (Variability Analysis[number] \<< Bias Report(Confidence Intervals( state=0|1 )))

**Description:** Shows or hides confidence intervals on the graph in the Measurement Bias Report by Standard section. This option is available only when a standard variable is specified in the launch window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << Variability Chart(
    Y( :Response ),
    X( :Part ),
    Standard( :Standard ),
    Std Dev Chart( 0 )
);
obj << (Variability Analysis[1] << Bias Report( Confidence Intervals( 1 ) ));


```

#### [Measurement Error Graphs](#measurement-error-graphs)

**Syntax:** obj \<< (Variability Analysis[number] \<< Bias Report(Measurement Error Graphs( state=0|1 )))

**Description:** Shows or hides measurement error charts of the bias by part. This option is available only when a standard variable is specified in the launch window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << Variability Chart(
    Y( :Response ),
    X( :Part ),
    Standard( :Standard ),
    Std Dev Chart( 0 )
);
obj << (Variability Analysis[1] << Bias Report( Measurement Error Graphs( 1 ) ));


```

## [Variability Analysis > Heterogeneity of Variance Test](#variability-analysis-heterogeneity-of-variance-test)

### [Item Messages](#item-messages_2)

#### [Point Options](#point-options)

**Syntax:** obj \<< (Variability Analysis[number] \<< Heterogeneity of Variance Tests(1, Point Options("Show Needles" | "Show Connected Points" | "Show Only Points")))

**Description:** Specifies the drawing style of the points in the chart. You can choose between vertical needles, connected points, and points only. By default, the chart is drawn with needles that connect the points to the horizontal line that is drawn at the average.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = Variability Chart( Y( :Measurement ), X( :Operator, :part# ), Model( "Crossed" ) );
obj << (Variability Analysis[1] <<
Heterogeneity of Variance Tests( 1, Point Options( Show Only Points ) ));


```

#### [Set Alpha Level](#set-alpha-level_1)

**Syntax:** obj \<< (Variability Analysis[number] \<< Heterogeneity of Variance Tests(1, Set Alpha Level( number )))

**Description:** Changes the alpha level used to compute the decision limits.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = Variability Chart( Y( :Measurement ), X( :Operator, :part# ), Model( "Crossed" ) );
obj << (Variability Analysis[1] <<
Heterogeneity of Variance Tests( 1, Set Alpha Level( 0.1 ) ));


```

#### [Show Center Line](#show-center-line)

**Syntax:** obj \<< (Variability Analysis[number] \<< Heterogeneity of Variance Tests(1, Show Center Line(state=0|1)))

**Description:** Shows or hides the center line (overall mean ADM). On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = Variability Chart( Y( :Measurement ), X( :Operator, :part# ), Model( "Crossed" ) );
obj << (Variability Analysis[1] <<
Heterogeneity of Variance Tests( 1, Show Center Line( 0 ) ));


```

#### [Show Decision Limit Shading](#show-decision-limit-shading)

**Syntax:** obj \<< (Variability Analysis[number] \<< Heterogeneity of Variance Tests(1, Show Decision Limit Shading(state=0|1)))

**Description:** Shows or hides the decision limit shading for the ANOMV-Levene (ADM) chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = Variability Chart( Y( :Measurement ), X( :Operator, :part# ), Model( "Crossed" ) );
obj << (Variability Analysis[1] <<
Heterogeneity of Variance Tests( 1, Show Decision Limit Shading( 0 ) ));


```

#### [Show Decision Limits](#show-decision-limits)

**Syntax:** obj \<< (Variability Analysis[number] \<< Heterogeneity of Variance Tests(1, Show Decision Limits(state=0|1)))

**Description:** Shows or hides the decision limit lines for the ANOMV-Levene (ADM) chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = Variability Chart( Y( :Measurement ), X( :Operator, :part# ), Model( "Crossed" ) );
obj << (Variability Analysis[1] <<
Heterogeneity of Variance Tests( 1, Show Decision Limits( 0 ) ));


```

#### [Show Summary Report](#show-summary-report)

**Syntax:** obj \<< (Variability Analysis[number] \<< Heterogeneity of Variance Tests(1, Show Summary Report(state=0|1)))

**Description:** Shows or hides a report that contains the group standard deviations and corresponding decision limits.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = Variability Chart( Y( :Measurement ), X( :Operator, :part# ), Model( "Crossed" ) );
obj << (Variability Analysis[1] <<
Heterogeneity of Variance Tests( 1, Show Summary Report( 1 ) ));


```

## [Variability Analysis > Linearity Study](#variability-analysis-linearity-study)

### [Item Messages](#item-messages_3)

#### [Linearity by Groups](#linearity-by-groups)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study(1, Linearity By Groups( state=0|1 )))

**Description:** Shows or hides individual linearity graphs for each factor in the model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    MSA Metadata( :Response( Historical Process Sigma( .6 ) ) ),
    Standard( :Standard ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Linearity Study( 1, Linearity By Groups( 1 ) ));


```

#### [Set Alpha Level](#set-alpha-level_2)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study(1, Set Alpha Level( number )))

**Description:** Specifies the alpha level that is used to compute the bias confidence limits. "0.05" by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << Variability Chart(
    Y( :Response ),
    X( :Part ),
    MSA Metadata( :Response( Historical Process Sigma( .6 ) ) ),
    Standard( :Standard )
);
obj << (Variability Analysis[1] << Linearity Study( 1, Set Alpha Level( .01 ) ));


```

#### [Show Avg Bias Points](#show-avg-bias-points)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study(1, Show Avg Bias Points( state=0|1 )))

**Description:** Shows or hides the average bias points on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    MSA Metadata( :Response( Historical Process Sigma( .6 ) ) ),
    Standard( :Standard ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Linearity Study( 1, Show Avg Bias Points( 1 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Avg Bias Points( 0 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Avg Bias Points( 1 ) ));


```

#### [Show Bias Points](#show-bias-points)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study(1, Show Bias Points( state=0|1 )))

**Description:** Shows or hides the bias points on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Metadata( :Response( Historical Process Sigma( .6 ) ) ),
    Standard( :Standard ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Linearity Study( 1, Show Bias Points( 1 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Bias Points( 0 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Bias Points( 1 ) ));


```

#### [Show Fit Confidence Curves](#show-fit-confidence-curves)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study(1, Show Fit Confidence Curves( state=0|1 )))

**Description:** Shows or hides the line of fit confidence curves on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Metadata( :Response( Historical Process Sigma( .6 ) ) ),
    Standard( :Standard ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Linearity Study( 1, Show Fit Confidence Curves( 1 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Fit Confidence Curves( 0 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Fit Confidence Curves( 1 ) ));


```

#### [Show Line of Fit](#show-line-of-fit)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study(1, Show Line of Fit( state=0|1 )))

**Description:** Shows or hides the line of fit on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Metadata( :Response( Historical Process Sigma( .6 ) ) ),
    Standard( :Standard ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Linearity Study( 1, Show Line of Fit( 1 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Line of Fit( 0 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Line of Fit( 1 ) ));


```

#### [Show Overall Avg Bias Line](#show-overall-avg-bias-line)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study(1, Show Overall Avg Bias Line( state=0|1 )))

**Description:** Shows or hides the overall average bias line on the graph. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Metadata( :Response( Historical Process Sigma( .6 ) ) ),
    Standard( :Standard ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Linearity Study( 1, Show Overall Avg Bias Line( 1 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Overall Avg Bias Line( 0 ) ));
Wait( 1 );
obj << (Variability Analysis[1] << Linearity Study( 1, Show Overall Avg Bias Line( 1 ) ));


```

## [Variability Analysis](#variability-analysis_1)

### [Item Messages](#item-messages_4)

#### [AIAG Labels](#aiag-labels)

**Syntax:** obj \<< (Variability Analysis[number] \<< AIAG Labels( state=0|1 ))

**Description:** Shows or hides the labels in the Gauge R&R output. The labels are defined by the Automotive Industry Action Group (AIAG). On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Choose best analysis(EMS REML)" ),
    Variability Analysis( "Measurement", "Gauge R&R Report"n( 1 ) ),

);
Wait( 1 );
obj << (Variability Analysis[1] << AIAG Labels( 0 ));
Wait( 1 );
obj << (Variability Analysis[1] << AIAG Labels( 1 ));


```

#### [Bias Report](#bias-report)

**Syntax:** obj \<< (Variability Analysis[number] \<< Bias Report( state=0|1 ))

**Description:** Shows or hides a report that contains the average difference between the observed values and the standard. This option is available only when a standard variable is specified.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << Variability Chart(
    Y( :Response ),
    X( :Part ),
    Standard( :Standard ),
    Std Dev Chart( 0 )
);
obj << (Variability Analysis[1] << Bias Report( 1 ));


```

#### [Connect Cell Means](#connect-cell-means)

**Syntax:** obj \<< (Variability Analysis[number] \<< Connect Cell Means( state=0|1 ))

**Description:** Shows or hides a line that connects the cell means within a group of cells on the variability chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Connect Cell Means( 1 ));


```

#### [Discrimination Ratio](#discrimination-ratio)

**Syntax:** obj \<< (Variability Analysis[number] \<< Discrimination Ratio( state=0|1 ))

**Description:** Shows or hides the discrimination ratio for the given model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Choose best analysis(EMS REML)" )
);
obj << (Variability Analysis[1] << Discrimination Ratio( 1 ));


```

#### [Edit MSA Metadata](#edit-msa-metadata_1)

**Syntax:** obj \<< (Variability Analysis[number] \<< Edit MSA Metadata(Lower Tolerance(number), Upper Tolerance(number), Tolerance Range(number), Historical Mean(number), Historical Process Sigma(number)))

**Description:** Opens a window that enables you to add or edit the tolerance range, tolerance limits, historical mean, and historical process sigma for all analyses. The reports are automatically updated.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    MSA Metadata( :Measurement( Lower Tolerance( .2 ), Upper Tolerance( 1.3 ) ) ),
    Model( "Crossed" ),
    Variability Analysis( "Measurement", Misclassification Probabilities( 1 ) )
);
Wait( 1 );
obj << (Variability Analysis[1] << Edit MSA Metadata(
    Lower Tolerance( .1 ),
    Upper Tolerance( 1.2 )
));


```

#### [Gauge R&R Report](#gauge-rr-report)

**Syntax:** obj \<< (Variability Analysis[number] \<< "Gauge R & R Report"n( state=0|1 ))

**Description:** Computes and displays a Gauge R&R (reproducibility and repeatability) summary report.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    MSA Metadata( :Measurement( Lower Tolerance( 0.2 ), Upper Tolerance( 1.3 ) ) ),
    Model( "Crossed" ),
    Analysis Type( "Choose best analysis(EMS REML)" ),

);
obj << (Variability Analysis[1] << "Gauge R&R Report"n( 1 ));


```

#### [Group Means of Std Dev](#group-means-of-std-dev)

**Syntax:** obj \<< (Variability Analysis[number] \<< Group Means of Std Dev( state=0|1 ))

**Description:** Shows or hides the mean lines for groups of cell standard deviations on the standard deviation chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Group Means of Std Dev( 1 ));


```

#### [Heterogeneity of Variance Tests](#heterogeneity-of-variance-tests)

**Syntax:** obj \<< (Variability Analysis[number] \<< Heterogeneity of Variance Tests( state=0|1 ))

**Description:** Shows or hides a report that compares variances across groups. The report includes graphs that show the heterogeneity of variance test for each factor in the model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Heterogeneity of Variance Tests( 1 ));


```

#### [Linearity Study](#linearity-study)

**Syntax:** obj \<< (Variability Analysis[number] \<< Linearity Study( state=0|1 ))

**Description:** Performs a regression that uses the standard values as the X variable and the bias as the Y variable.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << Variability Chart(
    Y( :Response ),
    X( :Part ),
    MSA Metadata( :Response( Historical Process Sigma( 1.1 ) ) ),
    Standard( :Standard ),
    Std Dev Chart( 0 )
);
obj << (Variability Analysis[1] << Linearity Study( 1 ));


```

#### [Mean Diamonds](#mean-diamonds)

**Syntax:** obj \<< (Variability Analysis[number] \<< Mean Diamonds( state=0|1 ))

**Description:** Shows or hides mean diamonds on the variability chart. The confidence intervals use the within-group standard deviation for each cell.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Mean Diamonds( 1 ));


```

#### [Mean Plots](#mean-plots)

**Syntax:** obj \<< (Variability Analysis[number] \<< Mean Plots( state=0|1 ))

**Description:** Shows or hides a plot of the factor level means for each factor in the model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Mean Plots( 1 ));


```

#### [Mean of Std Dev](#mean-of-std-dev)

**Syntax:** obj \<< (Variability Analysis[number] \<< Mean of Std Dev( state=0|1 ))

**Description:** Shows or hides a gray dashed line at the mean standard deviation on the standard deviation chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Mean of Std Dev( 1 ));


```

#### [Misclassification Probabilities](#misclassification-probabilities)

**Syntax:** obj \<< (Variability Analysis[number] \<< Misclassification Probabilities( state=0|1 ))

**Description:** Shows or hides a report containing the probabilities of misclassification for the given model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    MSA Metadata( :Measurement( Lower Tolerance( 0.2 ), Upper Tolerance( 1.3 ) ) ),
    Model( "Crossed" ),
    Analysis Type( "Choose best analysis(EMS REML)" )
);
obj << (Variability Analysis[1] << Misclassification Probabilities( 1 ));


```

#### [Points Jittered](#points-jittered)

**Syntax:** obj \<< (Variability Analysis[number] \<< Points Jittered( state=0|1 ))

**Description:** Adds random horizontal jitter to the points in the variability chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Points Jittered( 1 ));


```

#### [S Control Limits](#s-control-limits)

**Syntax:** obj \<< (Variability Analysis[number] \<< S Control Limits( state=0|1 ))

**Description:** Shows or hides red lines at the lower control limit (LCL) and upper control limit (UCL) on the standard deviation chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << S Control Limits( 1 ));


```

#### [Show Box Plots](#show-box-plots)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Box Plots( state=0|1 ))

**Description:** Shows or hides box plots for each cell on the variability chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Show Box Plots( 1 ));


```

#### [Show Cell Means](#show-cell-means)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Cell Means( state=0|1 ))

**Description:** Shows or hides the mean mark for each cell on the variability chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
Wait( 1 );
obj << (Variability Analysis[1] << Show Cell Means( 0 ));
Wait( 1 );
obj << (Variability Analysis[1] << Show Cell Means( 1 ));


```

#### [Show Grand Mean](#show-grand-mean)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Grand Mean( state=0|1 ))

**Description:** Shows or hides the overall mean, which is represented by a gray dotted line across the entire graph.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Show Grand Mean( 1 ));


```

#### [Show Grand Median](#show-grand-median)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Grand Median( state=0|1 ))

**Description:** Shows or hides the overall median, which is represented by a blue dotted line across the entire graph.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Show Grand Median( 1 ));


```

#### [Show Group Means](#show-group-means)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Group Means( state=0|1 ))

**Description:** Shows or hides the mean for groups of cells, which is represented by a horizontal solid line.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Show Group Means( 1 ));


```

#### [Show Points](#show-points)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Points( state=0|1 ))

**Description:** Shows or hides the points on the variability chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
Wait( 1 );
obj << (Variability Analysis[1] << Show Points( 0 ));
Wait( 1 );
obj << (Variability Analysis[1] << Show Points( 1 ));


```

#### [Show Range Bars](#show-range-bars)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Range Bars( state=0|1 ))

**Description:** Shows or hides the bars that indicate the minimum and the maximum value of each cell. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
Wait( 1 );
obj << (Variability Analysis[1] << Show Range Bars( 0 ));
Wait( 1 );
obj << (Variability Analysis[1] << Show Range Bars( 1 ));


```

#### [Show Separators](#show-separators)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Separators( state=0|1 ))

**Description:** Shows or hides the separator lines between levels of the grouping variables on the variability chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
Wait( 1 );
obj << (Variability Analysis[1] << Show Separators( 0 ));
Wait( 1 );
obj << (Variability Analysis[1] << Show Separators( 1 ));


```

#### [Show Standard Mean](#show-standard-mean)

**Syntax:** obj \<< (Variability Analysis[number] \<< Show Standard Mean( state=0|1 ))

**Description:** Shows or hides a line at the mean of the standard values. This option is available only if a standard variable is specified in the launch window.

```

dt = Open( "$SAMPLE_DATA/Variability Data/MSALinearity.jmp" );
obj = dt << Variability Chart( Y( :Response ), X( :Part ), Standard( :Standard ) );
Wait( 1 );
obj << (Variability Analysis[1] << Show Standard Mean( 1 ));


```

#### [Std Dev Chart](#std-dev-chart)

**Syntax:** obj \<< (Variability Analysis[number] \<< Std Dev Chart( state=0|1 ))

**Description:** Shows or hides a chart that plots the standard deviation of each cell. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
Wait( 1 );
obj << (Variability Analysis[1] << Std Dev Chart( 0 ));
Wait( 1 );
obj << (Variability Analysis[1] << Std Dev Chart( 1 ));


```

#### [Std Dev Plots](#std-dev-plots)

**Syntax:** obj \<< (Variability Analysis[number] \<< Std Dev Plots( state=0|1 ))

**Description:** Shows or hides plots of the standard deviations grouped by each factor level. A plot is shown for each factor in the model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" )
);
obj << (Variability Analysis[1] << Std Dev Plots( 1 ));


```

#### [Variability Chart](#variability-chart_2)

**Syntax:** obj \<< (Variability Analysis[number] \<< Variability Chart( state=0|1 ))

**Description:** Shows or hides the variability chart. On by default.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
Wait( 1 );
obj << (Variability Analysis[1] << Variability Chart( 0 ));
Wait( 1 );
obj << (Variability Analysis[1] << Variability Chart( 1 ));


```

#### [Variability Summary Report](#variability-summary-report)

**Syntax:** obj \<< (Variability Analysis[number] \<< Variability Summary Report( state=0|1 ))

**Description:** Shows or hides a report that shows the mean, standard deviation, coefficient of variation (CV), standard error of the mean, the lower and upper confidence intervals. The minimum, maximum, range, median, and number of observations are also shown.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Variability Summary Report( 1 ));


```

#### [Variance Components](#variance-components)

**Syntax:** obj \<< (Variability Analysis[number] \<< Variance Components( state=0|1 ))

**Description:** Shows or hides the variance components for a specific model.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Model( "Crossed" ),
    Analysis Type( "Use REML analysis" )
);
obj << (Variability Analysis[1] << Variance Components( 1 ));


```

#### [Vertical Charts](#vertical-charts)

**Syntax:** obj \<< (Variability Analysis[number] \<< Vertical Charts( state=0|1 ))

**Description:** Rotates the variability chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << Vertical Charts( 1 ));


```

#### [XBar Control Limits](#xbar-control-limits)

**Syntax:** obj \<< (Variability Analysis[number] \<< XBar Control Limits( state=0|1 ))

**Description:** Shows or hides lines at the lower control limit (LCL) and upper control limit (UCL) on the variability chart.

```

dt = Open( "$SAMPLE_DATA/Variability Data/2 Factors Crossed.jmp" );
obj = dt << Variability Chart( Y( :Measurement ), X( :Operator, :part# ) );
obj << (Variability Analysis[1] << XBar Control Limits( 1 ));


```

# [WebReport](#webreport)

## [Item Messages](#item-messages)

### [Add Image](#add-image)

**Syntax:** obj \<< Add Image("path to image" | File("path to image"), \<Title(...)>,\<Description(...)>)

**Description:** Adds an image to publish in the web report. Optional arguments include title and description.

**JMP Version Added:** 14

```


webreport = New Web Report();
webreport << Add Image(
    File( "$SAMPLE_IMAGES/black rhino footprint.jpg" ),
    Title( "Black Rhino Footprint" )
);


```

### [Add Report](#add-report)

**Syntax:** obj \<< Add Report( jmpreport, \<Title(...)>, \<Description(...)>, \<Publish Data(0|1)>, \<Enable Warnings(0|1)>, \<Optimization("Interactivity" | "Performance")> )

**Description:** Adds a report to publish in the web report. Optional arguments include title and description.

**JMP Version Added:** 14

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
jmpreport = Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
webreport = New Web Report();
webreport << Add Report( jmpreport );


```

### [Add Reports](#add-reports)

**Syntax:** obj \<< Add Reports( reports )

**Description:** Adds a list of JMP reports to a web report using default options.

**JMP Version Added:** 14

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
Bivariate(
    Y( :weight ),
    X( :height ),
    Automatic Recalc( 1 ),
    Fit Line( {Line Color( {213, 72, 87} )} ),
    Local Data Filter( Add Filter( columns( :sex ) ) )
);
windows = Find All( Reports );
If( N Items( windows ) > 0,
    webreport = New Web Report();
    webreport << Title( "Big Class Reports" );
    webreport << Description( "Multiple reports found in Big Class." );
    webreport << Add Reports( windows );
);


```

### [Description](#description)

**Syntax:** obj \<< Description(...)

**Description:** Sets the description of the web report.

**JMP Version Added:** 15

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
jmpreport_1 = Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
jmpreport_2 = Bivariate(
    Y( :weight ),
    X( :height ),
    Automatic Recalc( 1 ),
    Fit Line( {Line Color( {213, 72, 87} )} ),
    Local Data Filter( Add Filter( columns( :sex ) ) )
);
webreport = New Web Report();
webreport << Add Report( jmpreport_1 );
webreport << Add Report( jmpreport_2 );
webreport << Title( "Publish Test" );
webreport << Description( "This is a multiple report publish" );
file = webreport << Save( "$TEMP" );
If( !Is Empty( file ),
    Web( file )
);


```

### [Index](#index)

**Syntax:** obj \<< Index( Title(...), \<Description(...)>, \<Timestamp(1 | 0)>, \<Font(name, style)>, \<Logo(image path)>, \<CSS(css path)>, \<Theme(Default | Orange | Blue | Red | Green | Black)>, \<Style(LargeList | SmallList | Grid | Custom)> )

**Description:** Adds a custom index page to the web report.

**JMP Version Added:** 14

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
jmpreport1 = dt << Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
jmpreport2 = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
webreport = New Web Report();
webreport << Add Report( jmpreport1 );
webreport << Add Report(
    jmpreport2,
    Title( "Oneway Analysis" ),
    Description( "shows height by sex" )
);
webreport << Index(
    Title( "Publish Test" ),
    Description( "This is a multiple report publish with a custom index page" ),
    Timestamp( 1 ),
    Font( "Arial Narrow", "Bold Italic" ),
    Logo( "$SAMPLE_IMAGES/pi.gif" ),
    Theme( "Orange" ),
    Style( "Grid" )
);
file = webreport << Save( "$TEMP" );
If( !Is Empty( file ),
    Web( file )
);


```

### [Reset](#reset)

**Syntax:** obj \<< Reset()

**Description:** Resets the web report to new values. This clears any public designation, file locations, and other cached information.

**JMP Version Added:** 14

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
jmpreport = Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
Bivariate(
    Y( :weight ),
    X( :height ),
    Automatic Recalc( 1 ),
    Fit Line( {Line Color( {213, 72, 87} )} ),
    Local Data Filter( Add Filter( columns( :sex ) ) )
);
windows = Find All( Reports );
If( N Items( windows ) > 0,
    webreport = New Web Report();
    webreport << Add Reports( windows );
);
webreport << Reset();
webreport << Add Report( jmpreport );


```

### [Save](#save)

**Syntax:** obj \<< Save ("directory path", \<Replace(\<0>|\<1>)>, \<Publish Data(\<0>|\<1>)>)

**Description:** Saves the web report to the specified directory. On success, the file name of the published report location is returned. A web report saved locally can contain embedded user data. Setting the Publish Data value to false creates reports using static images rather than embedding user data. The default is true.

**JMP Version Added:** 14

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
jmpreport = Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
webreport = New Web Report();
webreport << Add Report( jmpreport );
file = webreport << Save( "$TEMP" );
If( !Is Empty( file ),
    Web( file )
);


```

### [Title](#title)

**Syntax:** obj \<< Title(...)

**Description:** Sets the title of the web report.

**JMP Version Added:** 15

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
jmpreport_1 = Distribution(
    Continuous Distribution( Column( :weight ) ),
    Nominal Distribution( Column( :age ) )
);
jmpreport_2 = Bivariate(
    Y( :weight ),
    X( :height ),
    Automatic Recalc( 1 ),
    Fit Line( {Line Color( {213, 72, 87} )} ),
    Local Data Filter( Add Filter( columns( :sex ) ) )
);
webreport = New Web Report();
webreport << Add Report( jmpreport_1 );
webreport << Add Report( jmpreport_2 );
webreport << Title( "Publish Test" );
file = webreport << Save( "$TEMP" );
If( !Is Empty( file ),
    Web( file )
);


```

# [Window Object](#window-object)

## [Item Messages](#item-messages)

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title

**Description:** Sets the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Title( "New Title" );


```

## [Shared Item Messages](#shared-item-messages)

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Workflow](#workflow)

## [Item Messages](#item-messages)

### [Close](#close)

**Syntax:** workflow \<< Close()

**Description:** Close the workflow.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Close();


```

### [Execute Next](#execute-next)

**Syntax:** workflow \<< Execute Next()

**Description:** Execute the current step in the workflow, and move the execution pointer to the following step.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Execute Next();


```

### [Get Execution Info](#get-execution-info)

**Syntax:** workflow \<< Get Execution Info(<index>)

**Description:** Return a structure containing information about the steps of the workflow that have been executed.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Resume;
wf << Get Execution Info( 1 );


```

### [Get Step Count](#get-step-count)

**Syntax:** workflow \<< Get Step Count

**Description:** Return the number of steps in the workflow.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Get Step Count;


```

### [Get Step JSL](#get-step-jsl)

**Syntax:** workflow \<< Get Step JSL(<index>)

**Description:** Return the JSL code of the given step in the workflow.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Get Step JSL( 1 );


```

### [Get Step Name](#get-step-name)

**Syntax:** workflow \<< Get Step Name(<index>)

**Description:** Return the name of the given step in the workflow.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Get Step Name( 1 );


```

### [Log Executed Steps](#log-executed-steps)

**Syntax:** obj \<< Log Executed Steps( state=0|1 )

**Description:** Log the JSL script for each step that is executed.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Log Executed Steps( 1 );
wf << Resume();


```

### [Presentation Mode](#presentation-mode)

**Syntax:** obj \<< Presentation Mode( state=0|1 )

**Description:** Presentation mode removes editing options and unnecessary support interfaces.

**JMP Version Added:** 17

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Presentation Mode( 1 );


```

### [Resume](#resume)

**Syntax:** workflow \<< Resume()

**Description:** Execute or resume execution of the workflow.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Resume();


```

### [Set Execution Callback](#set-execution-callback)

**Syntax:** workflow \<< Set Execution Callback(<callback>)

**Description:** Set a callback on the workflow that will be notified each time a step finishes executing with associated information.

**JMP Version Added:** 18

```

//The callback function receives two arguments; the Workflow scriptable and a structure containing information about what step has just been executed and the reason if stopped.
wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Set Execution Callback( Function( {wfb, data}, Show( data ) ) );
wf << Resume;


```

### [Set Next Step To Execute](#set-next-step-to-execute)

**Syntax:** workflow \<< Set Next Step To Execute(<index>)

**Description:** Move the execution cursor to a step in the workflow.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Set Next Step To Execute( 2 );


```

### [Start Over](#start-over)

**Syntax:** workflow \<< Start Over()

**Description:** Reset the workflow back to the beginning, closing all tables and other windows opened by the workflow.

**JMP Version Added:** 18

```

wf = Open( "$SAMPLE_WORKFLOWS/WorkflowBuilder.jmpflow" );
wf << Start Over();


```

# [XGBoost](#xgboost)

## [Associated Constructors](#associated-constructors)

### [XGBoost](#xgboost_1)

**Syntax:** XGBoost(Y( columns ), X( columns ))

**Description:** Predictive modeling interface to eXtreme Gradient Boosted trees.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

## [Columns](#columns)

### [Censor](#censor)

**Syntax:** obj = XGBoost(...\<Censor( column )>...)

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [Factor](#factor)

**Syntax:** obj = XGBoost(...Factor( column(s) )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [Freq](#freq)

**Syntax:** obj = XGBoost(...\<Freq( column )>...)

**Description:** Specifies a column whose values assign a frequency to each row for the analysis.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_freqcol", Numeric, Continuous, Set Each Value( Random Integer( 1, 5 ) ) );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [Response](#response)

**Syntax:** obj = XGBoost(...Response( column(s) )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [Validation](#validation)

**Syntax:** obj = XGBoost(...\<Validation( column(s) )>...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [Weight](#weight)

**Syntax:** obj = XGBoost(...\<Weight( column )>...)

**Description:** Specifies a column whose values assign a weight to each row for the analysis.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_weightcol", Numeric, Continuous, Set Each Value( Random Beta( 1, 1 ) ) );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [X](#x)

**Syntax:** obj = XGBoost(...X( column(s) )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [Y](#y)

**Syntax:** obj = XGBoost(...Y( column(s) )...)

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

## [Item Messages](#item-messages)

### [Change Variables](#change-variables)

**Syntax:** obj \<< Change Variables

**Description:** Changes X, Y, and other variables for subsequent models.

**JMP Version Added:** 16

### [Compare](#compare)

**Syntax:** obj \<< Compare

**Description:** Updates the XGBoost comparison metrics.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit( Objective( 0 ) ) );
obj << Compare( Correlation( 1 ) );


```

### [Fit](#fit)

**Syntax:** obj \<< Fit

**Description:** Fits an XGBoost model. You can specify XGBoost parameters and fitting specifications within this.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );


```

### [Get Measures](#get-measures)

**Syntax:** obj \<< Get Measures

**JMP Version Added:** 16

### [Method](#method)

**Syntax:** obj \<< Method( "xgboost"|"lightgbm"="xgboost" )

**Description:** Select either XGBoost or LightGBM as a method for gradient boosting fitting. "xgboost" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost(
    Y( :Weight ),
    X( :Height ),
    Fit( Method( "lightgbm" ), objective( "regression" ) )
);


```

### [Redo Analysis](#redo-analysis)

**Syntax:** obj \<< Redo Analysis

**Description:** Rerun this same analysis in a new window. The analysis will be different if the data has changed.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Redo Analysis;


```

### [Relaunch Analysis](#relaunch-analysis)

**Syntax:** obj \<< Relaunch Analysis

**Description:** Opens the platform launch window and recalls the settings that were used to create the report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Relaunch Analysis;


```

### [Show Details](#show-details)

**Syntax:** obj \<< Show Details( state=0|1 )

**Description:** Shows more details.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Show Details( 1 ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Action](#action)

**Syntax:** obj \<< Action

**Description:** All-purpose trapdoor within a platform to insert expressions to evaluate. Temporarily sets the DisplayBox and DataTable contexts to the Platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [Apply Preset](#apply-preset)

**Syntax:** Apply Preset( preset ); Apply Preset( source, label, \<Folder( folder {, folder2, ...} )> )

**Description:** Apply a previously created preset to the object, updating the options and customizations to match the saved settings.

**JMP Version Added:** 18

#### [Anonymous preset](#anonymous-preset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();
dt2 = Open( "$SAMPLE_DATA/Dogs.jmp" );
obj2 = dt2 << Oneway( Y( :LogHist0 ), X( :drug ) );
Wait( 1 );
obj2 << Apply Preset( preset );


```

#### [Search by name](#search-by-name)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "Compare Distributions" );


```

#### [Search within folder(s)](#search-within-folders)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ) );
Wait( 1 );
obj << Apply Preset( "Sample Presets", "t-Tests", Folder( "Compare Means" ) );


```

### [Copy ByGroup Script](#copy-bygroup-script)

**Syntax:** obj \<< Copy ByGroup Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj[1] << Copy ByGroup Script;


```

### [Copy Script](#copy-script)

**Syntax:** obj \<< Copy Script

**Description:** Create a JSL script to produce this analysis, and put it on the clipboard.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Copy Script;


```

### [Get By Levels](#get-by-levels)

**Syntax:** obj \<< Get By Levels

**Description:** Returns an associative array mapping the by group columns to their values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv << Get By Levels;


```

### [Get ByGroup Script](#get-bygroup-script)

**Syntax:** obj \<< Get ByGroup Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
t = obj[1] << Get ByGroup Script;
Show( t );


```

### [Get Container](#get-container)

**Syntax:** obj \<< Get Container

**Description:** Returns a reference to the container box that holds the content for the object.

#### [General](#general)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
t = obj << Get Container;
Show( (t << XPath( "//OutlineBox" )) << Get Title );


```

#### [Platform with Filter](#platform-with-filter)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) ),
    Local Data Filter(
        Add Filter(
            columns( :age, :sex, :height ),
            Where( :age == {12, 13, 14} ),
            Where( :sex == "F" ),
            Where( :height >= 55 ),
            Display( :age, N Items( 6 ) )
        )
    )
);
New Window( "platform boxes",
    H List Box(
        Outline Box( "Report(platform)", Report( gb ) << Get Picture ),
        Outline Box( "platform << Get Container", (gb << Get Container) << Get Picture )
    )
);


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** Returns a reference to the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
t = obj << Get Datatable;
Show( N Rows( t ) );


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Creates a script (JSL) to produce this analysis and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
t = obj << Get Script;
Show( t );


```

### [Get Script With Data Table](#get-script-with-data-table)

**Syntax:** obj \<< Get Script With Data Table

**Description:** Creates a script(JSL) to produce this analysis specifically referencing this data table and returns it as an expression.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
t = obj << Get Script With Data Table;
Show( t );


```

### [Get Timing](#get-timing)

**Syntax:** obj \<< Get Timing

**Description:** Times the platform launch.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
t = obj << Get Timing;
Show( t );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Where Expr](#get-where-expr)

**Syntax:** obj \<< Get Where Expr

**Description:** Returns the Where expression for the data subset, if the platform was launched with By() or Where(). Otherwise, returns Empty()

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( X( :height ), Y( :weight ), By( :sex ) );
biv2 = dt << Bivariate( X( :height ), Y( :weight ), Where( :age < 14 & :height > 60 ) );
Show( biv[1] << Get Where Expr, biv2 << Get Where Expr );


```

### [Ignore Platform Preferences](#ignore-platform-preferences)

**Syntax:** Ignore Platform Preferences( state=0|1 )

**Description:** Ignores the current settings of the platform's preferences. The message is ignored when sent to the platform after creation.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Ignore Platform Preferences( 1 ),
    Y( :height ),
    X( :weight ),
    Action( Distribution( Y( :height, :weight ), Histograms Only ) )
);


```

### [New Preset](#new-preset)

**Syntax:** obj = New Preset()

**Description:** Create an anonymous preset representing the options and customizations applied to the object. This object can be passed to Apply Preset to copy the settings to another object of the same type.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), t Test( 1 ) );
preset = obj << New Preset();


```

### [Report](#report)

**Syntax:** obj \<< Report; Report( obj )

**Description:** Returns a reference to the report object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
r = obj << Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [Save ByGroup Script to Data Table](#save-bygroup-script-to-data-table)

**Syntax:** Save ByGroup Script to Data Table( <name>, < \<<Append Suffix(0|1)>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Creates a JSL script to produce this analysis, and save it as a table property in the data table. You can specify a name for the script. The Append Suffix option appends a numeric suffix to the script name, which differentiates the script from an existing script with the same name. The Prompt option prompts the user to specify a script name. The Replace option replaces an existing script with the same name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj[1] << Save ByGroup Script to Data Table;


```

### [Save ByGroup Script to Journal](#save-bygroup-script-to-journal)

**Syntax:** obj \<< Save ByGroup Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj[1] << Save ByGroup Script to Journal;


```

### [Save ByGroup Script to Script Window](#save-bygroup-script-to-script-window)

**Syntax:** obj \<< Save ByGroup Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj[1] << Save ByGroup Script to Script Window;


```

### [Save Script for All Objects](#save-script-for-all-objects)

**Syntax:** obj \<< Save Script for All Objects

**Description:** Creates a script for all report objects in the window and appends it to the current Script window. This option is useful when you have multiple reports in the window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Save Script for All Objects;


```

### [Save Script for All Objects To Data Table](#save-script-for-all-objects-to-data-table)

**Syntax:** obj \<< Save Script for All Objects To Data Table( <name> )

**Description:** Saves a script for all report objects to the current data table. This option is useful when you have multiple reports in the window. The script is named after the first platform unless you specify the script name in quotes.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj[1] << Save Script for All Objects To Data Table;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "_bycol",
    Character,
    Nominal,
    Set Values( Repeat( {"A", "B"}, N Rows( dt ) )[1 :: N Rows( dt )] )
);
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj[1] << Save Script for All Objects To Data Table( "My Script" );


```

### [Save Script to Data Table](#save-script-to-data-table)

**Syntax:** Save Script to Data Table( <name>, < \<<Prompt(0|1)>, < \<<Replace(0|1)> );

**Description:** Create a JSL script to produce this analysis, and save it as a table property in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Save Script to Data Table( "My Analysis", <<Prompt( 0 ), <<Replace( 0 ) );


```

### [Save Script to Journal](#save-script-to-journal)

**Syntax:** obj \<< Save Script to Journal

**Description:** Create a JSL script to produce this analysis, and add a Button to the journal containing this script.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Save Script to Journal;


```

### [Save Script to Report](#save-script-to-report)

**Syntax:** obj \<< Save Script to Report

**Description:** Create a JSL script to produce this analysis, and show it in the report itself. Useful to preserve a printed record of what was done.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Save Script to Report;


```

### [Save Script to Script Window](#save-script-to-script-window)

**Syntax:** obj \<< Save Script to Script Window

**Description:** Create a JSL script to produce this analysis, and append it to the current Script text window.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Save Script to Script Window;


```

### [SendToByGroup](#sendtobygroup)

**Syntax:** SendToByGroup( {":Column == level"}, command );

**Description:** Sends platform commands or display customization commands to each level of a by-group.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    By( :Sex ),
    SendToByGroup(
        {:sex == "F"},
        Continuous Distribution( Column( :weight ), Normal Quantile Plot( 1 ) )
    ),
    SendToByGroup( {:sex == "M"}, Continuous Distribution( Column( :weight ) ) )
);


```

### [SendToEmbeddedScriptable](#sendtoembeddedscriptable)

**Syntax:** SendToEmbeddedScriptable( Dispatch( "Outline name", "Element name", command );

**Description:** SendToEmbeddedScriptable restores settings of embedded scriptable objects.

```


dt = Open( "$SAMPLE_DATA/Reliability/Fan.jmp" );
dt << Life Distribution(
    Y( :Time ),
    Censor( :Censor ),
    Censor Code( 1 ),
    <<Fit Weibull,
    SendToEmbeddedScriptable(
        Dispatch(
            {"Statistics", "Parametric Estimate - Weibull", "Profilers", "Density Profiler"},
            {1, Confidence Intervals( 0 ), Term Value( Time( 6000, Lock( 0 ), Show( 1 ) ) )}
        )
    )
);


```

### [SendToReport](#sendtoreport)

**Syntax:** SendToReport( Dispatch( "Outline name", "Element name", Element type, command );

**Description:** Send To Report is used in tandem with the Dispatch command to customize the appearance of a report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Distribution(
    Nominal Distribution( Column( :age ) ),
    Continuous Distribution( Column( :weight ) ),
    SendToReport( Dispatch( "age", "Distrib Nom Hist", FrameBox, {Frame Size( 178, 318 )} ) )
);


```

### [Title](#title)

**Syntax:** obj \<< Title( "new title" )

**Description:** Sets the title of the platform.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
obj << Title( "My Platform" );


```

### [Top Report](#top-report)

**Syntax:** obj \<< Top Report

**Description:** Returns a reference to the root node in the report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << XGBoost( Y( :Weight ), X( :Height ), Fit );
r = obj << Top Report;
t = r[Outline Box( 1 )] << Get Title;
Show( t );


```

### [View Web XML](#view-web-xml)

**Syntax:** obj \<< View Web XML

**Description:** Returns the XML code that is used to create the interactive HTML report.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Bivariate( Y( :Weight ), X( :Height ) );
xml = obj << View Web XML;


```

## [XGBoost Compare](#xgboost-compare)

### [Associated Constructors](#associated-constructors_1)

#### [XGBoost Compare](#xgboost-compare_1)

**Syntax:** XGBoost Compare

### [Item Messages](#item-messages_1)

#### [AUC](#auc)

**Syntax:** obj \<< AUC( state=0|1 )

**Description:** Shows or hides the AUROC, which is the area under the receiver operating characteristic curve. On by default.

**JMP Version Added:** 16

#### [AUPRC](#auprc)

**Syntax:** obj \<< AUPRC( state=0|1 )

**Description:** Area under the Precision Recall Curve On by default.

**JMP Version Added:** 17

#### [Accuracy](#accuracy)

**Syntax:** obj \<< Accuracy( state=0|1 )

**Description:** Shows or hides the accuracy, which is the proportion of correct classifications. On by default.

**JMP Version Added:** 15

#### [Censor](#censor_1)

**Syntax:** obj \<< Censor( state=0|1 )

**Description:** Shows or hides the Censor command On by default.

**JMP Version Added:** 17

#### [Concordance](#concordance)

**Syntax:** obj \<< Concordance( state=0|1 )

**Description:** Shows or hides the concordance, which is the Harrell C-Index and measures strength of sorting efficiency On by default.

**JMP Version Added:** 17

#### [Correlation](#correlation)

**Syntax:** obj \<< Correlation( state=0|1 )

**Description:** Shows or hides the Pearson correlation, which is a measure of the strength of the linear relationship. On by default.

**JMP Version Added:** 15

#### [F1](#f1)

**Syntax:** obj \<< F1( state=0|1 )

**Description:** Shows or hides the F1 Score, which is the harmonic average of precision and recall. On by default.

**JMP Version Added:** 15

#### [Features](#features)

**Syntax:** obj \<< Features( state=0|1 )

**Description:** Shows or hides the Features column. On by default.

**JMP Version Added:** 16

#### [Freq](#freq_1)

**Syntax:** obj \<< Freq( state=0|1 )

**Description:** Shows or hides the Freq column. On by default.

**JMP Version Added:** 16

#### [H Measure](#h-measure)

**Syntax:** obj \<< H Measure( state=0|1 )

**Description:** Shows or hides the H Measure, which measures proportion improvement over baseline. On by default.

**JMP Version Added:** 17

#### [Hide All Models](#hide-all-models)

**Syntax:** obj \<< Hide All Models

**Description:** Hides all models.

**JMP Version Added:** 16

#### [LogLoss](#logloss)

**Syntax:** obj \<< LogLoss( state=0|1 )

**Description:** Shows or hides the logarithm of the likelihood-based loss function. On by default.

**JMP Version Added:** 15

#### [MAE](#mae)

**Syntax:** obj \<< MAE( state=0|1 )

**Description:** Shows or hides the MAE, which is the mean absolute error. On by default.

**JMP Version Added:** 15

#### [MCC](#mcc)

**Syntax:** obj \<< MCC( state=0|1 )

**Description:** Shows or hides the Matthews correlation coefficient, which is the Pearson correlation for binary variables. On by default.

**JMP Version Added:** 15

#### [Misclass](#misclass)

**Syntax:** obj \<< Misclass( state=0|1 )

**Description:** Shows or hides the misclassification rate, which is the proportion of incorrect classifications. On by default.

**JMP Version Added:** 15

#### [Predictors](#predictors)

**Syntax:** obj \<< Predictors( state=0|1 )

**Description:** Shows or hides the Predictors column. On by default.

**JMP Version Added:** 16

#### [Profit](#profit)

**Syntax:** obj \<< Profit( state=0|1 )

**Description:** Shows or hides the expected profit. On by default.

**JMP Version Added:** 16

#### [RMSE](#rmse)

**Syntax:** obj \<< RMSE( state=0|1 )

**Description:** Shows or hides the RMSE, which is the root mean square error. On by default.

**JMP Version Added:** 15

#### [RSquare](#rsquare)

**Syntax:** obj \<< RSquare( state=0|1 )

**Description:** Shows or hides RSquare value, which is the proportion of variability explained. On by default.

**JMP Version Added:** 15

#### [Remove Hidden Models](#remove-hidden-models)

**Syntax:** obj \<< Remove Hidden Models

**Description:** Removes all models for which the Show box is not checked.

**JMP Version Added:** 16

#### [Remove Shown Models](#remove-shown-models)

**Syntax:** obj \<< Remove Shown Models

**Description:** Removes all models for which the Show check box is checked and shows the remaining models.

**JMP Version Added:** 15

#### [Response](#response_1)

**Syntax:** obj \<< Response( state=0|1 )

**Description:** Shows or hides the Response column. On by default.

**JMP Version Added:** 16

#### [Show All Models](#show-all-models)

**Syntax:** obj \<< Show All Models

**Description:** Shows all models.

**JMP Version Added:** 16

#### [Training Metrics](#training-metrics)

**Syntax:** obj \<< Training Metrics( state=0|1 )

**Description:** Shows or hides all training metrics. On by default.

**JMP Version Added:** 15

#### [Validation](#validation_1)

**Syntax:** obj \<< Validation( state=0|1 )

**Description:** Shows or hides the Validation column. On by default.

**JMP Version Added:** 16

#### [Validation Metrics](#validation-metrics)

**Syntax:** obj \<< Validation Metrics( state=0|1 )

**Description:** Shows or hides all validation metrics. On by default.

**JMP Version Added:** 15

#### [Weight](#weight_1)

**Syntax:** obj \<< Weight( state=0|1 )

**Description:** Shows or hides the Weight column. On by default.

**JMP Version Added:** 16

## [XGBoost Fit](#xgboost-fit)

### [Associated Constructors](#associated-constructors_2)

#### [XGBoost Fit](#xgboost-fit_1)

**Syntax:** XGBoost Fit

### [Item Messages](#item-messages_2)

#### [Actual by Predicted Plots](#actual-by-predicted-plots)

**Syntax:** obj \<< Actual by Predicted Plots( state=0|1 )

**Description:** Shows or hides a plot using the training data with the predicted values on the X axis and actual values on the Y axis. On by default.

**JMP Version Added:** 15

#### [Autotune](#autotune)

**Syntax:** obj \<< Autotune( state=0 )

**Description:** Creates a fast flexible filling design within min and max parameter settings to fit n models, where n is Number of Runs. "0" by default.

**JMP Version Added:** 17

#### [Confusion Matrices](#confusion-matrices)

**Syntax:** obj \<< ( fit[number] \<< Confusion Matrices( state=0|1 ) )

**Description:** Shows or hides a crosstabulation matrix of actual and predicted levels. On by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << XGBoost(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit
);
obj << (fit[1] << Confusion Matrices( 1 ));


```

#### [Contour Profiler](#contour-profiler)

**Syntax:** obj \<< Contour Profiler

**Description:** Shows or hides interactive graphs of cross-sections of the prediction function.

**JMP Version Added:** 15

#### [Copy Parameters to Launch](#copy-parameters-to-launch)

**Syntax:** obj \<< Copy Parameters to Launch

**Description:** Copies the parameters from this model to the model launch section.

**JMP Version Added:** 16

#### [Decision Thresholds](#decision-thresholds)

**Syntax:** obj \<< Decision Thresholds( state=0|1 )

**Description:** Shows or hides decision threshold graphs and tables. On by default.

**JMP Version Added:** 16

#### [Fit Details](#fit-details)

**Syntax:** obj \<< Fit Details( state=0|1 )

**Description:** Shows or hides the statistics for the fitted model. On by default.

**JMP Version Added:** 15

#### [Generate Python Code](#generate-python-code)

**Syntax:** obj \<< Generate Python Code

**Description:** Creates Python code for training and scoring.

**JMP Version Added:** 16

#### [Importances](#importances)

**Syntax:** obj \<< Importances( state=0|1 )

**Description:** Shows or hides the importance statistics for each predictor. On by default.

**JMP Version Added:** 15

#### [Lift Curves](#lift-curves)

**Syntax:** obj \<< Lift Curves( state=0|1 )

**Description:** Shows or hides the Lift Curve plot. A lift curve plots the lift versus the portion of the observations and provides another view of the predictive ability of a model.

**JMP Version Added:** 15

#### [Number of Design Points](#number-of-design-points)

**Syntax:** obj \<< Number of Design Points( number=10 )

**Description:** Specifies the number of tuning design runs to perform. If you have a large problem, keep this value relatively small. "10" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( Number of Design Points( 10 ) ) );


```

#### [Number of Inner Folds](#number-of-inner-folds)

**Syntax:** obj \<< Number of Inner Folds( number=2 )

**Description:** Specifies the number of nested inner folds used during the autotune process. "2" by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( Number of Inner Folds( 2 ) ) );


```

#### [Precision Recall Curves](#precision-recall-curves)

**Syntax:** obj \<< Precision Recall Curves( state=0|1 )

**Description:** Plots the trade-off between precision and recall for different classification thresholds. It is preferred in scenarios where class imbalances exist.

**JMP Version Added:** 15

#### [Profiler](#profiler)

**Syntax:** obj \<< Profiler

**Description:** Shows or hides the prediction profiler, which is used to graphically explore the prediction equation by slicing it one factor at a time. The prediction profiler contains features for optimization.

**JMP Version Added:** 15

#### [Publish Prediction Formula](#publish-prediction-formula)

**Syntax:** obj \<< Publish Prediction Formula

**Description:** Creates prediction formulas and saves them as formula column scripts in the Formula Depot platform.

**JMP Version Added:** 15

#### [ROC Curves](#roc-curves)

**Syntax:** obj \<< ROC Curves( state=0|1 )

**Description:** Shows or hides the Receiver Operating Characteristic (ROC) curve for each level of the response variable. The ROC curve is a plot of sensitivity versus (1 - specificity).

**JMP Version Added:** 15

#### [Remove All But This Fit](#remove-all-but-this-fit)

**Syntax:** obj \<< ( fit[number] \<< Remove All But This Fit )

**Description:** Removes the reports and plots for all models except this one.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << XGBoost(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit
);
Wait( 2 );
obj << (Fit[1] << Remove All But This Fit);


```

#### [Remove Fit](#remove-fit)

**Syntax:** obj \<< ( fit[number] \<< Remove Fit )

**Description:** Removes the entire model report.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = dt << XGBoost(
    Y( :Species ),
    X( :Sepal length, :Sepal width, :Petal length, :Petal width ),
    Fit
);
Wait( 2 );
obj << (Fit[1] << Remove Fit);


```

#### [Save Predicteds](#save-predicteds)

**Syntax:** obj \<< Save Predicteds

**Description:** Saves the predicted values in a new column in the data table.

**JMP Version Added:** 15

#### [Save Prediction Formula](#save-prediction-formula)

**Syntax:** obj \<< Save Prediction Formula

**Description:** Saves the prediction formula in a new column in the data table. Calculations can be slow for large models.

**JMP Version Added:** 15

#### [Save SHAPs](#save-shaps)

**Syntax:** obj \<< Save SHAPs

**Description:** Saves Shapley values to the data table. These values break down predictions into components for each predictor.

**JMP Version Added:** 17

#### [Set Random Seed](#set-random-seed)

**Syntax:** obj \<< Set Random Seed( number=0 )

**Description:** Sets the random seed to a specific value assuring that all subsequent runs using the same seed are reproducible. "0" by default.

**JMP Version Added:** 19

#### [Surface Profiler](#surface-profiler)

**Syntax:** obj \<< Surface Profiler

**Description:** Shows or hides interactive graphs of cross-sections of the prediction function.

**JMP Version Added:** 15

#### [Tree Details](#tree-details)

**Syntax:** obj \<< Tree Details( state=0|1 )

**Description:** Shows or hides the breakdown of each tree split.

**JMP Version Added:** 15

#### [Tuning Design Table](#tuning-design-table)

**Syntax:** Tuning Design Table( "table name" )

**Description:** Specifies the name of an open JMP data table of parameter settings used to fit a series of models. The columns of this table must exactly match parameter names, and each row must contain values of these parameters to use for that model fit. Parameters that are not specified are set to their values from this dialog.

**JMP Version Added:** 15

#### [alpha](#alpha)

**Syntax:** obj \<< alpha( number=0.0 )

**Description:** Specifies the L1 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( alpha( 0.0 ) ) );


```

#### [alpha_max](#alpha_max)

**Syntax:** obj \<< alpha_max( number=0.5 )

**Description:** Specifies the maximum L1 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0.5" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( alpha_max( 2.0 ) ) );


```

#### [alpha_min](#alpha_min)

**Syntax:** obj \<< alpha_min( number=0.0 )

**Description:** Specifies the minimum L1 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( alpha_min( 0.0 ) ) );


```

#### [bagging_by_query](#bagging_by_query)

**Syntax:** obj \<< bagging_by_query( state=0 )

**Description:** Specifies whether to force rowwise histogram building. Enabling this option reduces memory cost, especially for data that have many samples and are associated with small bagging fraction or GOSS sample strategy. This option cannot be used together with force columnwise. "0" by default.

**JMP Version Added:** 19

#### [bagging_fraction](#bagging_fraction)

**Syntax:** obj \<< bagging_fraction( number=1 )

**Description:** Specifies the proportion of rows to sample during each iteration. This value must be between 0 and 1. This is a type of bagging. "1" by default.

**JMP Version Added:** 19

#### [bagging_fraction_max](#bagging_fraction_max)

**Syntax:** obj \<< bagging_fraction_max( number=1.0 )

**Description:** Specifies the maximum proportion of rows to sample during each iteration. This value must be between 0 and 1. This is a type of bagging. "1.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( bagging_fraction_max( 1.0 ) ) );


```

#### [bagging_fraction_min](#bagging_fraction_min)

**Syntax:** obj \<< bagging_fraction_min( number=0.3 )

**Description:** Specifies the minimum proportion of rows to sample during each iteration. This value must be between 0 and 1. This is a type of bagging. "0.3" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( bagging_fraction_min( 0.3 ) ) );


```

#### [bagging_freq](#bagging_freq)

**Syntax:** obj \<< bagging_freq( number=0 )

**Description:** Specifies the frequency of bagging. This value determines the number of iterations at which a new random sample of training data is drawn to train the model. "0" by default.

**JMP Version Added:** 19

#### [bagging_seed](#bagging_seed)

**Syntax:** obj \<< bagging_seed( number=3 )

**Description:** Specifies the seed that is used for the bagging random number generator. "3" by default.

**JMP Version Added:** 19

#### [base_score](#base_score)

**Syntax:** obj \<< base_score( number=0.5 )

**Description:** Specifies the initial prediction score of all instances, which is the global bias. The mean of y is typically a good choice. "0.5" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( base_score( 0.5 ) ) );


```

#### [bin_construct_sample_cnt](#bin_construct_sample_cnt)

**Syntax:** obj \<< bin_construct_sample_cnt( number=200000 )

**Description:** Specifies the number of observations that are sampled to construct feature discrete bins. If this option is set to small values, you might encounter unexpected errors and poor accuracy. "200000" by default.

**JMP Version Added:** 19

#### [boost_from_average](#boost_from_average)

**Syntax:** obj \<< boost_from_average( state=1 )

**Description:** Specifies whether the initial prediction is set to the average of the response variable or to a constant zero. This option is used only in regression, binary, multiclass, and cross-entropy objectives. On by default.

**JMP Version Added:** 19

#### [booster](#booster)

**Syntax:** obj \<< booster( "gbtree"|"gblinear"|"dart"="gbtree" )

**Description:** Specifies which booster to use. "gbtree" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( booster( "gbtree" ) ) );


```

#### [boosting](#boosting)

**Syntax:** obj \<< boosting( "gbdt"|"rf"|"dart"="gbdt" )

**Description:** Specifies the boosting strategy that is used during model training. "gbdt" by default.

**JMP Version Added:** 19

#### [cat_l2](#cat_l2)

**Syntax:** obj \<< cat_l2( number=10 )

**Description:** Specifies the L2 regularization value for categorical features. "10" by default.

**JMP Version Added:** 19

#### [cat_l2_max](#cat_l2_max)

**Syntax:** obj \<< cat_l2_max( number=15 )

**Description:** Specifies the maximum L2 regularization value for categorical features. "15" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( cat_l2_max( 2.0 ) ) );


```

#### [cat_l2_min](#cat_l2_min)

**Syntax:** obj \<< cat_l2_min( number=5 )

**Description:** Specifies the minimum L2 regularization value for categorical features. "5" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( cat_l2_min( 0.0 ) ) );


```

#### [cat_smooth](#cat_smooth)

**Syntax:** obj \<< cat_smooth( number=10 )

**Description:** Specifies the regularization value that is used to reduce the impact of noise in categorical features, especially for those categories with few observations. "10" by default.

**JMP Version Added:** 19

#### [cegb_penalty_split](#cegb_penalty_split)

**Syntax:** obj \<< cegb_penalty_split( number=0 )

**Description:** "0" by default.

**JMP Version Added:** 19

#### [cegb_tradeoff](#cegb_tradeoff)

**Syntax:** obj \<< cegb_tradeoff( number=1 )

**Description:** "1" by default.

**JMP Version Added:** 19

#### [colsample_bylevel](#colsample_bylevel)

**Syntax:** obj \<< colsample_bylevel( number=1.0 )

**Description:** Specifies the proportion of columns to sample for each level. Sampling occurs once for every new depth level reached in a tree. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( colsample_bylevel( 1.0 ) ) );


```

#### [colsample_bynode](#colsample_bynode)

**Syntax:** obj \<< colsample_bynode( number=1.0 )

**Description:** Specifies the proportion of columns to sample for each node (split). Sampling occurs once every time a new split is evaluated. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( colsample_bynode( 1.0 ) ) );


```

#### [colsample_bytree](#colsample_bytree)

**Syntax:** obj \<< colsample_bytree( number=1.0 )

**Description:** Specifies the proportion of columns to sample when constructing each tree. Sampling occurs once for each tree. This value must be between 0 and 1. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( colsample_bytree( 1.0 ) ) );


```

#### [colsample_bytree_max](#colsample_bytree_max)

**Syntax:** obj \<< colsample_bytree_max( number=1.0 )

**Description:** Specifies the maximum proportion of columns to sample when constructing each tree. Sampling occurs once for each tree. This value must be between 0 and 1. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( colsample_bytree_max( 1.0 ) ) );


```

#### [colsample_bytree_min](#colsample_bytree_min)

**Syntax:** obj \<< colsample_bytree_min( number=0.5 )

**Description:** Specifies the minimum proportion of columns to sample when constructing each tree. Sampling occurs once for each tree. This value must be between 0 and 1. "0.5" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( colsample_bytree_min( 0.3 ) ) );


```

#### [data_random_seed](#data_random_seed)

**Syntax:** obj \<< data_random_seed( number=1 )

**Description:** Specifies the seed that is used for the random number generator when sampling data to construct histogram bins. "1" by default.

**JMP Version Added:** 19

#### [data_sample_strategy](#data_sample_strategy)

**Syntax:** obj \<< data_sample_strategy( "bagging"|"goss"="bagging" )

**Description:** Specifies the strategy for drawing samples for usage on each boosting iteration. "bagging" by default.

**JMP Version Added:** 19

#### [deterministic](#deterministic)

**Syntax:** obj \<< deterministic( state=0 )

**Description:** Specifies that results can be reproduced. Setting this option to true ensures stable results when using different numbers of threads for the same data samples and parameters. This option is useful for reproducibility. "0" by default.

**JMP Version Added:** 19

#### [device_type](#device_type)

**Syntax:** obj \<< device_type( "cpu"|"gpu"="cpu" )

**Description:** Specifies whether to use the CPU or GPU device. "cpu" by default.

**JMP Version Added:** 19

#### [drop_rate](#drop_rate)

**Syntax:** obj \<< drop_rate( number=0.1 )

**Description:** Specifies the fraction of previous trees to drop during the dropout for DART boosting. "0.1" by default.

**JMP Version Added:** 19

#### [drop_seed](#drop_seed)

**Syntax:** obj \<< drop_seed( number=4 )

**Description:** Specifies the seed that is used for the dropout procedure in DART boosting. "4" by default.

**JMP Version Added:** 19

#### [early_stopping_min_delta](#early_stopping_min_delta)

**Syntax:** obj \<< early_stopping_min_delta( number=0 )

**Description:** Specifies the minimum value by which the training metric must improve on each iteration. Otherwise, the training process stops when using an early stopping round. "0" by default.

**JMP Version Added:** 19

#### [early_stopping_round](#early_stopping_round)

**Syntax:** obj \<< early_stopping_round( number=0 )

**Description:** Specifies the maximum number of iterations for which to continue training while the training metric does not improve. A value of zero means no early stopping. "0" by default.

**JMP Version Added:** 19

#### [enable_bundle](#enable_bundle)

**Syntax:** obj \<< enable_bundle( state=1 )

**Description:** Specifies whether to use exclusive feature bundling. If this option is set to false, the training speed might be slow for sparse data sets. On by default.

**JMP Version Added:** 19

#### [eval_at](#eval_at)

**Syntax:** obj \<< eval_at( text=1,2,3,4,5 )

**Description:** Specifies the cutoff points when ranking models with either of the NDGG or MAP metrics. "1,2,3,4,5" by default.

**JMP Version Added:** 19

#### [eval_metric](#eval_metric)

**Syntax:** obj \<< eval_metric( text )

**Description:** Specifies the metric shown in the iteration history plot but does not affect the actual model fit. Leave this value blank for the default metric corresponding to the objective function, or specify one of the following: rmse, rmsle, mae, logloss, error, error@t, merror, auc, aucpr, ndcg, map, ndcg@n, map@n, ndcg-, map-, ndcg@n-, map@n-, poisson-nloglik, gamma-nloglik, cox-nloglik, gamma-deviance, tweedie-nloglik.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( eval_metric( rmse ) ) );


```

#### [extra_seed](#extra_seed)

**Syntax:** obj \<< extra_seed( number=6 )

**Description:** Specifies the seed that is used for selecting thresholds when the extra trees option is specified. "6" by default.

**JMP Version Added:** 19

#### [extra_trees](#extra_trees)

**Syntax:** obj \<< extra_trees( state=0 )

**Description:** Specifies whether to use extremely randomized trees. Instead of evaluating all possible split points for each feature to find the optimal split, this option randomly selects a subset of features at each node. For each selected feature, this option randomly chooses one threshold to evaluate for the splitting node. "0" by default.

**JMP Version Added:** 19

#### [fair_c](#fair_c)

**Syntax:** obj \<< fair_c( number=1 )

**Description:** Specifies the parameter that controls the smoothness of the fair objective loss. "1" by default.

**JMP Version Added:** 19

#### [feature_fraction](#feature_fraction)

**Syntax:** obj \<< feature_fraction( number=1 )

**Description:** Specifies the proportion of columns to sample when constructing each tree. Sampling occurs once for each tree. This value must be between 0 and 1. "1" by default.

**JMP Version Added:** 19

#### [feature_fraction_bynode](#feature_fraction_bynode)

**Syntax:** obj \<< feature_fraction_bynode( number=1 )

**Description:** Specifies the fraction of features that are randomly selected during training. A value of 0.75 means 75% of features are randomly selected for training. "1" by default.

**JMP Version Added:** 19

#### [feature_fraction_max](#feature_fraction_max)

**Syntax:** obj \<< feature_fraction_max( number=1.0 )

**Description:** Specifies the maximum proportion of columns to sample when constructing each tree. Sampling occurs once for each tree. This value must be between 0 and 1. "1.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( feature_fraction_max( 1.0 ) ) );


```

#### [feature_fraction_min](#feature_fraction_min)

**Syntax:** obj \<< feature_fraction_min( number=0.2 )

**Description:** Specifies the minimum proportion of columns to sample when constructing each tree. Sampling occurs once for each tree. This value must be between 0 and 1. "0.2" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( feature_fraction_min( 0.2 ) ) );


```

#### [feature_fraction_seed](#feature_fraction_seed)

**Syntax:** obj \<< feature_fraction_seed( number=2 )

**Description:** Specifies the seed that is used for the feature fraction random number generator. "2" by default.

**JMP Version Added:** 19

#### [feature_pre_filter](#feature_pre_filter)

**Syntax:** obj \<< feature_pre_filter( state=1 )

**Description:** Specifies whether to ignore features that are not splittable based on the specified value for minimum observations in each leaf. If this option is set to false, the training speed might be slow. On by default.

**JMP Version Added:** 19

#### [feature_selector](#feature_selector)

**Syntax:** obj \<< feature_selector( "cyclic"|"shuffle"|"greedy"|"thrifty"="cyclic" )

**Description:** Specifies the feature selection and ordering method for the linear booster. "cyclic" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost(
    Y( :Weight ),
    X( :Height ),
    Booster( "gblinear" ),
    Fit( feature_selector( "cyclic" ) )
);


```

#### [force_col_wise](#force_col_wise)

**Syntax:** obj \<< force_col_wise( state=0 )

**Description:** Specifies whether to force columnwise histogram building. Enabling this option reduces memory cost, especially for data that have many features. This option cannot be used together with force rowwise. "0" by default.

**JMP Version Added:** 19

#### [force_row_wise](#force_row_wise)

**Syntax:** obj \<< force_row_wise( state=0 )

**Description:** "0" by default.

**JMP Version Added:** 19

#### [gamma](#gamma)

**Syntax:** obj \<< gamma( number=0.0 )

**Description:** Specifies the minimum loss reduction required to make a further partition on a leaf node of the tree. "0.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( Gamma( 0.0 ) ) );


```

#### [gpu_device_id](#gpu_device_id)

**Syntax:** obj \<< gpu_device_id( number=-1 )

**Description:** Specifies the device number when using the GPU. "-1" by default.

**JMP Version Added:** 19

#### [gpu_platform_id](#gpu_platform_id)

**Syntax:** obj \<< gpu_platform_id( number=-1 )

**Description:** Specifies the platform number when using the GPU. "-1" by default.

**JMP Version Added:** 19

#### [gpu_use_dp](#gpu_use_dp)

**Syntax:** obj \<< gpu_use_dp( state=0 )

**Description:** Specifies whether to use double precision math on the GPU. "0" by default.

**JMP Version Added:** 19

#### [grow_policy](#grow_policy)

**Syntax:** obj \<< grow_policy( "depthwise"|"lossguide"="depthwise" )

**Description:** Specifies the method used to add new nodes to trees. Currently, this option applies only when tree_method=hist. "depthwise" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( grow_policy( "depthwise" ) ) );


```

#### [histogram_pool_size](#histogram_pool_size)

**Syntax:** obj \<< histogram_pool_size( number=-1 )

**Description:** Specifies the maximum memory size in megabytes for the historical histogram. "-1" by default.

**JMP Version Added:** 19

#### [interaction_constraints](#interaction_constraints)

**Syntax:** obj \<< interaction_constraints( text )

**Description:** Specifies feature interaction constraints as a nested list of feature indices using brackets. Features grouped together can interact only with each other.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Set Modeling Type( "Continuous" );
dt << XGBoost(
    Y( :Weight ),
    X( :Age, :Height ),
    Fit( interaction_constraints( "[[0,1]]" ) )
);


```

#### [is_enable_sparse](#is_enable_sparse)

**Syntax:** obj \<< is_enable_sparse( state=1 )

**Description:** Specifies whether to enable sparse optimization. On by default.

**JMP Version Added:** 19

#### [is_unbalance](#is_unbalance)

**Syntax:** obj \<< is_unbalance( state=0 )

**Description:** Specifies whether the training data set is unbalanced in binary and multiclass regression. "0" by default.

**JMP Version Added:** 19

#### [iterations](#iterations)

**Syntax:** obj \<< iterations( number=30 )

**Description:** Specifies the number of boosting iterations. "30" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( iterations( 100 ) ) );


```

#### [iterations_max](#iterations_max)

**Syntax:** obj \<< iterations_max( number=100 )

**Description:** Specifies the maximum number of boosting iterations. "100" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( iterations_max( 300 ) ) );


```

#### [iterations_min](#iterations_min)

**Syntax:** obj \<< iterations_min( number=20 )

**Description:** Specifies the minimum number of boosting iterations. "20" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( iterations_min( 20 ) ) );


```

#### [lambda](#lambda)

**Syntax:** obj \<< lambda( number=1.0 )

**Description:** Specifies the L2 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( lambda( 1.0 ) ) );


```

#### [lambda_l1](#lambda_l1)

**Syntax:** obj \<< lambda_l1( number=0 )

**Description:** Specifies the L1 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0" by default.

**JMP Version Added:** 19

#### [lambda_l1_max](#lambda_l1_max)

**Syntax:** obj \<< lambda_l1_max( number=2.0 )

**Description:** Specifies the maximum L1 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "2.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( lambda_l1_max( 2.0 ) ) );


```

#### [lambda_l1_min](#lambda_l1_min)

**Syntax:** obj \<< lambda_l1_min( number=0.0 )

**Description:** Specifies the minimum L1 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( lambda_l1_min( 0.0 ) ) );


```

#### [lambda_l2](#lambda_l2)

**Syntax:** obj \<< lambda_l2( number=0 )

**Description:** Specifies the L2 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0" by default.

**JMP Version Added:** 19

#### [lambda_l2_max](#lambda_l2_max)

**Syntax:** obj \<< lambda_l2_max( number=2.0 )

**Description:** Specifies the maximum L2 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "2.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( lambda_l2_max( 2.0 ) ) );


```

#### [lambda_l2_min](#lambda_l2_min)

**Syntax:** obj \<< lambda_l2_min( number=0.0 )

**Description:** Specifies the minimum L2 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( lambda_l2_min( 0.0 ) ) );


```

#### [lambda_max](#lambda_max)

**Syntax:** obj \<< lambda_max( number=2.0 )

**Description:** Specifies the maximum L2 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "2.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( lambda_max( 2.0 ) ) );


```

#### [lambda_min](#lambda_min)

**Syntax:** obj \<< lambda_min( number=0.0 )

**Description:** Specifies the minimum L2 regularization term on weights. Increasing this value makes the model more conservative. This value must be nonnegative. "0.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( lambda_min( 0.0 ) ) );


```

#### [lambdarank_norm](#lambdarank_norm)

**Syntax:** obj \<< lambdarank_norm( state=1 )

**Description:** Specifies whether to normalize the lambdas for different queries and improve performance in unbalanced data. On by default.

**JMP Version Added:** 19

#### [lambdarank_position_bias_regularization](#lambdarank_position_bias_regularization)

**Syntax:** obj \<< lambdarank_position_bias_regularization( number=0 )

**Description:** Specifies the value that controls position information bias for the LambdaRank objective. Larger values reduce inferred position biased factors. "0" by default.

**JMP Version Added:** 19

#### [lambdarank_truncation_level](#lambdarank_truncation_level)

**Syntax:** obj \<< lambdarank_truncation_level( number=30 )

**Description:** Specifies the parameter that controls the number of top results on which the model should focus during training for the LambdaRank objective. "30" by default.

**JMP Version Added:** 19

#### [learning_rate](#learning_rate)

**Syntax:** obj \<< learning_rate( number=0.3 )

**Description:** Specifies the learning rate. Smaller learning rates tend to fit better but require more iterations to converge, whereas larger learning rates fit faster. "0.3" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( learning_rate( 0.3 ) ) );


```

#### [learning_rate_max](#learning_rate_max)

**Syntax:** obj \<< learning_rate_max( number=0.4 )

**Description:** Specifies the maximum learning rate. Smaller learning rates tend to fit better but require more iterations to converge, whereas larger learning rates fit faster. "0.4" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( learning_rate_max( 0.4 ) ) );


```

#### [learning_rate_min](#learning_rate_min)

**Syntax:** obj \<< learning_rate_min( number=0.05 )

**Description:** Specifies the minimum learning rate. Smaller learning rates tend to fit better but require more iterations to converge, whereas larger learning rates fit faster. "0.05" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( learning_rate_min( 0.05 ) ) );


```

#### [linear_lambda](#linear_lambda)

**Syntax:** obj \<< linear_lambda( number=0.0 )

**Description:** Specifies the regularization parameter for linear trees. "0.0" by default.

**JMP Version Added:** 19

#### [linear_tree](#linear_tree)

**Syntax:** obj \<< linear_tree( state=0 )

**Description:** Specifies whether to fit piecewise linear gradient boosting tree. The splits are chosen in the usual manner, but the model is linear at each leaf instead of constant. "0" by default.

**JMP Version Added:** 19

#### [max_bin](#max_bin)

**Syntax:** obj \<< max_bin( number=256 )

**Description:** Specifies the maximum number of discrete bins into which to bucket continuous features. This option applies only for tree_method=hist. "256" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( max_bin( 256 ) ) );


```

#### [max_bin_by_feature](#max_bin_by_feature)

**Syntax:** obj \<< max_bin_by_feature( text )

**Description:** Specifies the maximum number of bins for each feature.

**JMP Version Added:** 19

#### [max_cat_threshold](#max_cat_threshold)

**Syntax:** obj \<< max_cat_threshold( number=32 )

**Description:** Specifies the threshold for maximum number of unique categories to consider when splitting categorical features. Larger values result in a more exhaustive search for optimal categorical splits at the expense of longer training time. "32" by default.

**JMP Version Added:** 19

#### [max_cat_to_onehot](#max_cat_to_onehot)

**Syntax:** obj \<< max_cat_to_onehot( number=4 )

**Description:** Specifies the maximum number of categories that a categorical feature can have to use the one-vs-other split algorithm. Categorical features with more than the maximum number of categories are handled by a different algorithm. "4" by default.

**JMP Version Added:** 19

#### [max_delta_step](#max_delta_step)

**Syntax:** obj \<< max_delta_step( number=0.0 )

**Description:** Specifies the maximum delta step that each leaf output can take. "0.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( max_delta_step( 0.0 ) ) );


```

#### [max_depth](#max_depth)

**Syntax:** obj \<< max_depth( number=6 )

**Description:** Specifies the maximum depth of the tree. This value must be an integer. Complexity increases as depth increases. Models with larger max_depth have a higher risk of overfitting. "6" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( max_depth( 6 ) ) );


```

#### [max_depth_max](#max_depth_max)

**Syntax:** obj \<< max_depth_max( number=8 )

**Description:** Specifies the maximum depth of tree maximum. This value must be an integer. Complexity increases as depth increases. Models with depths of 2^depth and larger have higher risk of overfitting. "8" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( max_depth_max( 9 ) ) );


```

#### [max_depth_min](#max_depth_min)

**Syntax:** obj \<< max_depth_min( number=1 )

**Description:** Specifies the maximum depth of tree minimum. This value must be an integer. Complexity increases as depth increases. Models with depths of 2^depth and larger have higher risk of overfitting. "1" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( max_depth_min( 3 ) ) );


```

#### [max_drop](#max_drop)

**Syntax:** obj \<< max_drop( number=50 )

**Description:** Specifies the maximum number of dropped trees on each DART boosting iteration. "50" by default.

**JMP Version Added:** 19

#### [max_leaves](#max_leaves)

**Syntax:** obj \<< max_leaves( number=0 )

**Description:** Specifies the maximum number of nodes to be added. This option applies only for grow_policy=lossguide. "0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( max_leaves( 0 ) ) );


```

#### [metric](#metric)

**Syntax:** obj \<< metric( "default"|"l1"|"l2"|"rmse"|"quantile"|"mape"|"huber"|"fair"|"poisson"|"gamma"|"gamma_deviance"|"tweedie"|"ndcg"|"map"|"auc"|"average_precision"|"binary_logloss"|"binary_error"|"auc_mu"|"multi_logloss"|"multi_error"|"cross_entropy"|"cross_entropy_lambda"|"kulback_leibler"="default" )

**Description:** Specifies the metric that is evaluated in both training and validation sets. "default" by default.

**JMP Version Added:** 19

#### [min_child_weight](#min_child_weight)

**Syntax:** obj \<< min_child_weight( number=1.0 )

**Description:** Specifies the minimum sum of instance weight (Hessian) needed in a child. This value is the minimum size of each leaf. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( min_child_weight( 1.0 ) ) );


```

#### [min_child_weight_max](#min_child_weight_max)

**Syntax:** obj \<< min_child_weight_max( number=3.0 )

**Description:** Specifies the maximum sum of instance weight (Hessian) needed in a child. This value is the maximum size of each leaf. "3.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( min_child_weight_max( 10.0 ) ) );


```

#### [min_child_weight_min](#min_child_weight_min)

**Syntax:** obj \<< min_child_weight_min( number=1.0 )

**Description:** Specifies the minimum sum of instance weight (Hessian) needed in a child. This value is the minimum size of each leaf. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( min_child_weight_min( 1.0 ) ) );


```

#### [min_data_in_bin](#min_data_in_bin)

**Syntax:** obj \<< min_data_in_bin( number=3 )

**Description:** Specifies the minimum number of observations that are included in each bin. "3" by default.

**JMP Version Added:** 19

#### [min_data_in_leaf](#min_data_in_leaf)

**Syntax:** obj \<< min_data_in_leaf( number=20 )

**Description:** Specifies the minimum number of observations in each leaf. "20" by default.

**JMP Version Added:** 19

#### [min_data_per_group](#min_data_per_group)

**Syntax:** obj \<< min_data_per_group( number=100 )

**Description:** Specifies the minimum number of observations per categorical group on categorical features. "100" by default.

**JMP Version Added:** 19

#### [min_gain_to_split](#min_gain_to_split)

**Syntax:** obj \<< min_gain_to_split( number=0 )

**Description:** Specifies the maximum depth of the tree. This value must be an integer. Complexity increases as depth increases. Models with larger max_depth have a higher risk of overfitting. "0" by default.

**JMP Version Added:** 19

#### [min_sum_hessian_in_leaf](#min_sum_hessian_in_leaf)

**Syntax:** obj \<< min_sum_hessian_in_leaf( number=0.001 )

**Description:** Specifies the minimum sum of instance weight (Hessian) needed in a child. This value is the minimum size of each leaf. "0.001" by default.

**JMP Version Added:** 19

#### [min_sum_hessian_in_leaf_max](#min_sum_hessian_in_leaf_max)

**Syntax:** obj \<< min_sum_hessian_in_leaf_max( number=10.0 )

**Description:** Specifies the maximum sum of instance weight (Hessian) needed in a child. This value is the maximum size of each leaf. "10.0" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( min_sum_hessian_in_leaf_max( 10.0 ) ) );


```

#### [min_sum_hessian_in_leaf_min](#min_sum_hessian_in_leaf_min)

**Syntax:** obj \<< min_sum_hessian_in_leaf_min( number=0.5 )

**Description:** Specifies the minimum sum of instance weight (Hessian) needed in a child. This value is the minimum size of each leaf. "0.5" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( min_sum_hessian_in_leaf_min( 0.5 ) ) );


```

#### [monotone_constraints](#monotone_constraints)

**Syntax:** obj \<< monotone_constraints( text=None )

**Description:** Specifies monotonicity constraints for each feature. The constraints must be specified using a comma-separated list of values within parentheses, where -1 indicates negative, 1 indicates positive, and 0 indicates no constraint. "None" by default.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
:Age << Set Modeling Type( "Continuous" );
dt << XGBoost( Y( :Weight ), X( :Age, :Height ), Fit( monotone_constraints( "(1,1)" ) ) );


```

#### [monotone_constraints_method](#monotone_constraints_method)

**Syntax:** obj \<< monotone_constraints_method( "basic"|"intermediate"|"advanced"="basic" )

**Description:** Specifies the method for the monotone constraint when a constraint is set to be enforced. "basic" by default.

**JMP Version Added:** 19

#### [monotone_penalty](#monotone_penalty)

**Syntax:** obj \<< monotone_penalty( number=0 )

**Description:** Specifies the strictness of the monotone constraint when a constraint is set to be enforced. A specified value of K forbids any monotone splits on the first K levels of the tree. Larger values result in more penalization in the early tree building process. "0" by default.

**JMP Version Added:** 19

#### [multi_error_top_k](#multi_error_top_k)

**Syntax:** obj \<< multi_error_top_k( number=1 )

**Description:** Specifies the threshold for the top-k multierror metric in multiclass classification. "1" by default.

**JMP Version Added:** 19

#### [neg_bagging_fraction](#neg_bagging_fraction)

**Syntax:** obj \<< neg_bagging_fraction( number=1 )

**Description:** Specifies the value by which to adjust the process of drawing negative samples in unbalanced binary regression. "1" by default.

**JMP Version Added:** 19

#### [normalize_type](#normalize_type)

**Syntax:** obj \<< normalize_type( "tree"|"forest"="tree" )

**Description:** Specifies the type of normalization algorithm for the DART booster. "tree" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost(
    Y( :Weight ),
    X( :Height ),
    Booster( "dart" ),
    Fit( normalize_type( "tree" ) )
);


```

#### [nthread](#nthread)

**Syntax:** obj \<< nthread( number=0 )

**Description:** Specifies the number of parallel threads used to run XGBoost. By default, all available threads are used. "0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( nthread( 8 ) ) );


```

#### [num_grad_quant_bins](#num_grad_quant_bins)

**Syntax:** obj \<< num_grad_quant_bins( number=4 )

**Description:** Specifies the number of bins for the quantization gradients and Hessian matrices when using the quantized gradient. Larger values produce quantized training that is closer to full precision training. "4" by default.

**JMP Version Added:** 19

#### [num_iteration_predict](#num_iteration_predict)

**Syntax:** obj \<< num_iteration_predict( number=-1 )

**Description:** Specifies the number of iterations for which to make predictions. "-1" by default.

**JMP Version Added:** 19

#### [num_iterations](#num_iterations)

**Syntax:** obj \<< num_iterations( number=100 )

**Description:** Specifies the number of boosting iterations. "100" by default.

**JMP Version Added:** 19

#### [num_iterations_max](#num_iterations_max)

**Syntax:** obj \<< num_iterations_max( number=100 )

**Description:** Specifies the maximum number of boosting iterations. "100" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( num_iterations_max( 100 ) ) );


```

#### [num_iterations_min](#num_iterations_min)

**Syntax:** obj \<< num_iterations_min( number=20 )

**Description:** Specifies the minimum number of boosting iterations. "20" by default.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( num_iterations_min( 20 ) ) );


```

#### [num_leaves](#num_leaves)

**Syntax:** obj \<< num_leaves( number=31 )

**Description:** Specifies the maximum number of leaves on each tree. "31" by default.

**JMP Version Added:** 19

#### [num_parallel_tree](#num_parallel_tree)

**Syntax:** obj \<< num_parallel_tree( number=1 )

**Description:** Specifies the number of boosted trees to grow in parallel. Then the results are averaged. "1" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( num_parallel_tree( 1 ) ) );


```

#### [num_threads](#num_threads)

**Syntax:** obj \<< num_threads( number=0 )

**Description:** Specifies the number of threads. For the best speed, set this to the number of core CPUs. "0" by default.

**JMP Version Added:** 19

#### [objective](#objective)

**Syntax:** obj \<< objective( "reg:squarederror"|"binary:logistic"|"binary:hinge"|"count:poisson"|"multi:softprob"|"rank:pairwise"|"rank:ndcg"|"rank:map"|"reg:gamma"|"reg:logistic"|"reg:pseudohubererror"|"reg:squaredlogerror"|"reg:tweedie"|"survival:cox"="reg:squarederror" )

**Description:** Specifies the function to be optimized for model fitting. The function must be consistent with the modeling type of the response. "reg:squarederror" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), objective( "reg:squarederror" ) );


```

#### [objective_seed](#objective_seed)

**Syntax:** obj \<< objective_seed( number=5 )

**Description:** Specifies the seed that is used in the random number generator for the objective parameter. "5" by default.

**JMP Version Added:** 19

#### [one_drop](#one_drop)

**Syntax:** obj \<< one_drop( number=0 )

**Description:** When this flag is enabled in the DART booster, at least one tree is always dropped during the dropout. "0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( booster( "dart" ), one_drop( 0 ) ) );


```

#### [other_rate](#other_rate)

**Syntax:** obj \<< other_rate( number=0.1 )

**Description:** Specifies the retain ratio of small gradient data for the GOSS data sampling strategy. "0.1" by default.

**JMP Version Added:** 19

#### [path_smooth](#path_smooth)

**Syntax:** obj \<< path_smooth( number=0 )

**Description:** "0" by default.

**JMP Version Added:** 19

#### [poisson_max_delta_step](#poisson_max_delta_step)

**Syntax:** obj \<< poisson_max_delta_step( number=0.7 )

**Description:** Specifies a value that serves to limit the maximum prediction contribution of leaves for the Poisson model. "0.7" by default.

**JMP Version Added:** 19

#### [pos_bagging_fraction](#pos_bagging_fraction)

**Syntax:** obj \<< pos_bagging_fraction( number=1 )

**Description:** Specifies the value by which to adjust the process of drawing positive samples in unbalanced binary regression. "1" by default.

**JMP Version Added:** 19

#### [pred_early_stop](#pred_early_stop)

**Syntax:** obj \<< pred_early_stop( state=0 )

**Description:** Specifies whether to enforce prediction early stopping in classification and ranking applications. If this option is set to true, prediction can be faster, but accuracy might be affected. "0" by default.

**JMP Version Added:** 19

#### [pred_early_stop_freq](#pred_early_stop_freq)

**Syntax:** obj \<< pred_early_stop_freq( number=10 )

**Description:** Specifies the frequency of checking prediction early stopping when prediction early stopping is specified. "10" by default.

**JMP Version Added:** 19

#### [pred_early_stop_margin](#pred_early_stop_margin)

**Syntax:** obj \<< pred_early_stop_margin( number=10 )

**Description:** Specifies the threshold margin in prediction early stopping when prediction early stopping is specified. This parameter enables the prediction process to stop early if the margin is far enough from the threshold. "10" by default.

**JMP Version Added:** 19

#### [predict_disable_shape_check](#predict_disable_shape_check)

**Syntax:** obj \<< predict_disable_shape_check( state=0 )

**Description:** Specifies whether to raise the error when predicting on data that have different numbers of features than the training data. "0" by default.

**JMP Version Added:** 19

#### [predictor](#predictor)

**Syntax:** obj \<< predictor( "auto"|"cpu_predictor"|"gpu_predictor"="auto" )

**Description:** Specifies the type of predictor algorithm. "auto" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( predictor( "cpu_predictor" ) ) );


```

#### [process_type](#process_type)

**Syntax:** obj \<< process_type( "default"|"update"="default" )

**Description:** Specifies the type of boosting process to run. "default" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( process_type( "default" ) ) );


```

#### [quant_train_renew_leaf](#quant_train_renew_leaf)

**Syntax:** obj \<< quant_train_renew_leaf( state=0 )

**Description:** Specifies whether to renew the leaf values with original gradients when quantized training is in effect. This option can improve the accuracy of the ranking objectives in quantized training. "0" by default.

**JMP Version Added:** 19

#### [rate_drop](#rate_drop)

**Syntax:** obj \<< rate_drop( number=0.0 )

**Description:** Specifies the dropout rate for the DART booster. "0.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( booster( "dart" ), rate_drop( 0.0 ) ) );


```

#### [refresh_leaf](#refresh_leaf)

**Syntax:** obj \<< refresh_leaf( number=1 )

**Description:** Specifies the parameter of the refresh updater. If set to 1, leaves and nodes updated. If set to 0, only nodes are updated. "1" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( refresh_leaf( 1 ) ) );


```

#### [reg_sqrt](#reg_sqrt)

**Syntax:** obj \<< reg_sqrt( state=0 )

**Description:** Specifies whether to fit the square root of the response variable rather than the original values for regression models. "0" by default.

**JMP Version Added:** 19

#### [sample_type](#sample_type)

**Syntax:** obj \<< sample_type( "uniform"|"weighted"="uniform" )

**Description:** Specifies the type of sampling algorithm for the DART booster. "uniform" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost(
    Y( :Weight ),
    X( :Height ),
    Booster( "dart" ),
    Fit( sample_type( "uniform" ) )
);


```

#### [scale_pos_weight](#scale_pos_weight)

**Syntax:** obj \<< scale_pos_weight( number=1.0 )

**Description:** Specifies the balance of positive and negative weights, which are useful for unbalanced classes. A typical value to consider is sum(negative instances) / sum(positive instances). "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( scale_posweight( 1.0 ) ) );


```

#### [seed](#seed)

**Syntax:** obj \<< seed( number=0 )

**Description:** Specifies the seed for the random number generator. Set this value for reproducibility of the results. "0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( seed( 0 ) ) );


```

#### [sigmoid](#sigmoid)

**Syntax:** obj \<< sigmoid( number=1 )

**Description:** Specifies the parameter for the sigmoid function in binary and multiclass models. "1" by default.

**JMP Version Added:** 19

#### [sketch_eps](#sketch_eps)

**Syntax:** obj \<< sketch_eps( number=0.03 )

**Description:** Used only for tree_method=approx, this value approximately translates into (1 / sketch_eps) = number of bins. "0.03" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( sketch_eps( 0.03 ) ) );


```

#### [skip_drop](#skip_drop)

**Syntax:** obj \<< skip_drop( number=0.0 )

**Description:** Specifies the probability of skipping the dropout procedure during a DART boosting iteration. "0.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( booster( "dart" ), skip_drop( 0.0 ) ) );


```

#### [start_iteration_predict](#start_iteration_predict)

**Syntax:** obj \<< start_iteration_predict( number=0 )

**Description:** Specifies the starting iteration for which to make predictions. "0" by default.

**JMP Version Added:** 19

#### [stochastic_rounding](#stochastic_rounding)

**Syntax:** obj \<< stochastic_rounding( state=1 )

**Description:** Specifies whether to use stochastic rounding in gradient quantization. On by default.

**JMP Version Added:** 19

#### [subsample](#subsample)

**Syntax:** obj \<< subsample( number=1.0 )

**Description:** Specifies the proportion of rows to sample during each iteration. This value must be between 0 and 1. This is a type of bagging. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( subsample( 1.0 ) ) );


```

#### [subsample_max](#subsample_max)

**Syntax:** obj \<< subsample_max( number=1.0 )

**Description:** Specifies the maximum proportion of rows to sample during each iteration. This value must be between 0 and 1. This is a type of bagging. "1.0" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( subsample_max( 1.0 ) ) );


```

#### [subsample_min](#subsample_min)

**Syntax:** obj \<< subsample_min( number=0.5 )

**Description:** Specifies the minimum proportion of rows to sample during each iteration. This value must be between 0 and 1. This is a type of bagging. "0.5" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( subsample_min( 0.3 ) ) );


```

#### [top_k](#top_k)

**Syntax:** obj \<< top_k( number=256 )

**Description:** Specifies the number of top features to select in greedy and thrifty feature selector. This option applies only for the gblinear booster. "256" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( booster( "gblinear" ), top_k( 0 ) ) );


```

#### [top_rate](#top_rate)

**Syntax:** obj \<< top_rate( number=0.2 )

**Description:** Specifies the retain ratio of large gradient data for the GOSS data sampling strategy. "0.2" by default.

**JMP Version Added:** 19

#### [tree_method](#tree_method)

**Syntax:** obj \<< tree_method( "auto"|"exact"|"approx"|"hist"|"gpu_exact"|"gpu_hist"="auto" )

**Description:** Specifies the tree construction algorithm used in XGBoost. "auto" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( tree_method( "auto" ) ) );


```

#### [tweedie_variance_power](#tweedie_variance_power)

**Syntax:** obj \<< tweedie_variance_power( number=1.5 )

**Description:** Specifies the power of the Tweedie distribution. This value must be between 1 and 2. This option applies only for objective=reg:tweedie. "1.5" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost(
    Y( :Weight ),
    X( :Height ),
    Fit( objective( "reg:tweedie" ), tweedie_variance_power( 1.5 ) )
);


```

#### [uniform_drop](#uniform_drop)

**Syntax:** obj \<< uniform_drop( state=0 )

**Description:** Specifies whether to select trees for dropping in DART boosting using uniform probability. "0" by default.

**JMP Version Added:** 19

#### [updater](#updater)

**Syntax:** obj \<< updater( text )

**Description:** Specifies the tree updater to run for the gbtree booster. Specify one of the following: grow_colmaker, distcol, grow_histmaker, grow_local_histmaker, grow_skmaker, sync, refresh, prune. For the gblinear booster, specify either shotgun or coord_descent.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << XGBoost( Y( :Weight ), X( :Height ), Fit( updater( "grow_colmaker" ) ) );


```

#### [use_missing](#use_missing)

**Syntax:** obj \<< use_missing( state=1 )

**Description:** Specifies whether to enforce special handling of missing values. On by default.

**JMP Version Added:** 19

#### [use_quantized_grad](#use_quantized_grad)

**Syntax:** obj \<< use_quantized_grad( state=0 )

**Description:** Specifies whether to use gradient quantization when training. Enabling this option discretizes the gradients and Hessian matrices into bins, which can accelerate training with little loss in accuracy in most cases. "0" by default.

**JMP Version Added:** 19

#### [xgboost_dart_mode](#xgboost_dart_mode)

**Syntax:** obj \<< xgboost_dart_mode( state=0 )

**Description:** Specifies whether to use XGBoost DART mode. "0" by default.

**JMP Version Added:** 19

#### [zero_as_missing](#zero_as_missing)

**Syntax:** obj \<< zero_as_missing( state=0 )

**Description:** Specifies whether to treat all zero values as missing values. "0" by default.

**JMP Version Added:** 19

# [ZipArchive](#ziparchive)

## [Associated Constructors](#associated-constructors)

### [Open](#open)

**Syntax:** Open( filePath, \<data table options | Excel import options | text import options | SAS import options | HTML import options | esriShapeFile import options | PDF import options | other file options > )

**Description:** Returns a reference to a data table or other JMP file or object created from a file. If no path is specified, the Open dialog appears. If a folder path is specified, the system file browser is opened and no object is returned. Refer to the Syntax Reference for a complete description of available options.

```

/* Data tables, other JMP files, external files:
   Open( filePath,
     <Invisible | Private>,
     <Select Columns( "col", ... )>,
     <Ignore Columns( "col", ... )>,
     <Add to Recent Files(bool)>,
     <Quarantine Action("Allow Scripts"|"Block Scripts"|"Do Not Open"|"Show Dialog")>
     <Force Refresh>,
     <Enable Filter Views(bool)>,
     <"file type">
   )
*/
//Basic data table open
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
//Data table open with some options
dt2 = Open( "$SAMPLE_DATA/Fitness.jmp", Select Columns( "Name", "Sex", "Age", "Weight" ) );


```

## [Item Messages](#item-messages)

### [Dir](#dir)

**Syntax:** memlist = obj \<< Dir

**Description:** Returns the list of member files in a zip archive.

```

za = Open( "$TEMP\deleteMe.zip", zip );
za << Write( "ralph", "this is ralph's data" );
za << Write( "fred", "this is fred's data" );
dirlist = za << dir;
text = za << read( dirlist[1] );
dirlist[1] || ": " || text;


```

### [Read](#read)

**Syntax:** memdata = obj \<< Read( memname, \<Format(blob|string)>, \<Encoding(charset)> )

**Description:** Reads a zip archive member file into a string or blob.

```

za = Open( "$TEMP\deleteMe.zip", zip );
za << Write( "ralph", "this is ralph's data" );
za << Write( "fred", "this is fred's data" );
dirlist = za << dir;
text = za << read( dirlist[1] );
dirlist[1] || ": " || text;


```

### [Write](#write)

**Syntax:** actual name = obj \<< Write( memname, memdata, < "replace" > )

**Description:** Writes a text or blob to a zip archive member file. If the optional "replace" parameter is specified and there is an existing file with this name, the member file is replaced. Otherwise, this member name is changed to prevent overwriting an existing member; the name actually used is returned.

```

za = Open( "$TEMP\deleteMe.zip", zip );
za << Write( "ralph", "this is ralph's data" );
za << Write( "fred", "this is fred's data" );
dirlist = za << dir;
text = za << read( dirlist[1] );
dirlist[1] || ": " || text;


```
# JSL Functions Usage Documentation

# [All Functions](#all-functions)

### \[[...]\](#\_1)

**Syntax:** y = [string]\\

**Description:** Passages requiring many escape characters can use the delimiter [...].

**JMP Version Added:** Before version 14

```


jslPhrase =
"The JSL to do this is :\[
a = "hello";
b = a|| " world.";
show(b);
]\ and you use the Submit command to run it.";
Show( jslPhrase );


```

### [Abbrev Date](#abbrev-date)

**Syntax:** s = Abbrev Date( datetime, <format> )

**Description:** Returns an abbreviated locale-specific representation of a date-time value.

**JMP Version Added:** Before version 14

```

Abbrev Date( Today() );


```

### [Abs](#abs)

**Syntax:** y = Abs( x )

**Description:** Returns the absolute value of x. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Abs( -5 );


```

### [Add](#add)

**Syntax:** y = x0 + x1; y = Add( x0, x1, ... )

**Description:** Adds all arguments, which can be numbers, matrices, or lists of numbers.

**JMP Version Added:** Before version 14

```

Pi() + 10;


```

### [Add Color Theme](#add-color-theme)

**Description:** Creates a new custom color theme and registers it with the theme picker.

**JMP Version Added:** Before version 14

**Example 1**

```

Add Color Theme( {"Yellow To Blue", 0, {{255, 255, 0}, {0, 0, 255}}, {0.0, 1.0}} );


```

**Example 2**

```

Add Color Theme(
    {"Black To Red To White", {"Continuous", "Categorical", "Diverging"}, {{0, 0, 0}, {255, 0,
    0}, {255, 255, 255}, Missing( "Green" )}, {"Full Color", "Tritanopia", "Tritanomaly"}}
);


```

### [Add Custom Functions](#add-custom-functions)

**Syntax:** Add Custom Functions({f1, f2, ...} | f)

**Description:** Defines a list of custom functions for use in scripting and the Formula Editor. The command also adds the list to the environment.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y}, x + y - 1 ) );
mySub = New Custom Function( "custom", "Sub", Function( {x, y}, x - y + 1 ) );
Add Custom Functions( {myAdd, mySub} );


```

### [Add To](#add-to)

**Syntax:** y += x; Add To( y, x )

**Description:** Adds a value to a variable or to a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex += 2;
ex;


```

### [Add Vectors BLAS](#add-vectors-blas)

**Syntax:** z = Add Vectors BLAS( x, y, alpha )

**JMP Version Added:** 17

```

x = [1, 2, 3, 4];
y = [5, 6, 7, 8];
alpha = 0.5;
z = Add Vectors BLAS( x, y, alpha );


```

### [Alignment Cell Box](#alignment-cell-box)

**Syntax:** y = Alignment Cell Box( row, col, nRow, nCol, \<Sides(left+2*top+4*right+8\*bottom=15)> \<RowSpan(nRow matrix)> \<ColSpan(nCol matrix)>, matrix or list of strings )

**Description:** Returns a reference to a display box that contains the row (or column) contents that are contained inside of an Alignment Grid Box.

**JMP Version Added:** 19

```


New Window( "Crosstab",
    Alignment Grid Box(
        Alignment Cell Box( 0, 1, 1, 1, ColSpan( [3] ), {"sex"} ),
        Alignment Cell Box( 1, 1, 1, 3, {"F", "M", "Total"} ),
        Alignment Cell Box( 3, 0, 1, 1, Sides( 0 ), ColSpan( [4] ), {"age"} ),
        Alignment Cell Box( 4, 0, 6, 1, {"  12", "  13", "  14", "  15", "  16", "  17"} ),
        Alignment Cell Box(
            4,
            1,
            6,
            3,
            {"5 (28%)", "3 (14%)", "8 (20%)", "3 (17%)", "4 (18%)", "7 (18%)", "5 (28%)",
            "7 (32%)", "12 (30%)", "2 (11%)", "5 (23%)", "7 (18%)", "2 (11%)", "1 (5%)",
            "3 (8%)", "1 (6%)", "2 (9%)", "3 (8%)"}
        )
    )
);


```

### [Alignment Grid Box](#alignment-grid-box)

**Syntax:** y = Alignment Grid Box( alignment cell boxes )

**Description:** Returns a reference to a display box that can contain alignment cell boxes.

**JMP Version Added:** 19

```


New Window( "Crosstab",
    Alignment Grid Box(
        Alignment Cell Box( 0, 1, 1, 1, ColSpan( [3] ), {"sex"} ),
        Alignment Cell Box( 1, 1, 1, 3, {"F", "M", "Total"} ),
        Alignment Cell Box( 3, 0, 1, 1, Sides( 0 ), ColSpan( [4] ), {"age"} ),
        Alignment Cell Box( 4, 0, 6, 1, {"  12", "  13", "  14", "  15", "  16", "  17"} ),
        Alignment Cell Box(
            4,
            1,
            6,
            3,
            {"5 (28%)", "3 (14%)", "8 (20%)", "3 (17%)", "4 (18%)", "7 (18%)", "5 (28%)",
            "7 (32%)", "12 (30%)", "2 (11%)", "5 (23%)", "7 (18%)", "2 (11%)", "1 (5%)",
            "3 (8%)", "1 (6%)", "2 (9%)", "3 (8%)"}
        )
    )
);


```

### [Alignment Multi Box](#alignment-multi-box)

**Syntax:** y = Alignment Multi Box( row, col, nRow, nCol, nElements, list-of-nElements-matrices or empty values, list-of-nElements-lists of strings or empty values )

**Description:** Returns a reference to a display box that contains multiple elements inside each cell that is contained inside of an Alignment Grid Box.

**JMP Version Added:** 19

```


New Window( "Alignment MultiBox",
    Border Box( Top( 15 ), Left( 15 ), Right( 15 ), Bottom( 15 ),
        Alignment Grid Box(
            Alignment Multi Box( 0, 1, 1, 1, 2, {}, {{"Freq"}, {"Share"}} ),
            Alignment Cell Box( 0, 2, 1, 1, ColSpan( [2] ), {"sex"} ),
            Alignment Cell Box( 1, 2, 1, 2, ColSpan( [1, 1] ), {"F", "M"} ),
            Alignment Cell Box( 2, 0, 1, 1, RowSpan( [7] ), {"age"} ),
            Alignment Cell Box(
                2,
                1,
                7,
                1,
                {"12", "13", "14", "15", "16", "17", "Total Responses"}
            ),
            Alignment Multi Box(
                2,
                2,
                6,
                2,
                2,
                {[5 3, 5 2, 2 1, 3 4, 7 5, 1 2], [0.277 0.167, 0.278 0.111, 0.111 0.055,
                0.136 0.181, 0.318 0.227, 0.045 0.090]},
                {Empty(), Empty()}
            ),
            Alignment Cell Box( 8, 2, 1, 2, [18 22] )
        )
    )
);


```

### [All](#all)

**Syntax:** y = All( x, ... )

**Description:** Returns 1 if all elements are nonzero, zero otherwise.

**JMP Version Added:** Before version 14

```

All( [1 2 3] );


```

### [Alpha Shape](#alpha-shape)

**Syntax:** ashape = Alpha Shape(Triangulation)

**Description:** Returns the alpha shape for the given triangulation.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = Alpha Shape( triang );


```

### [And](#and)

**Syntax:** y = x1 & x2; y = And( x1, x2, ... )

**Description:** Returns the logical AND of all arguments: 1 if all arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

1 < 2 & 3 < 4;


```

### [AndMZ](#andmz)

**Syntax:** y = AndMZ( x1, x2, ... )

**Description:** Returns the logical AND of all arguments with missing values treated as zeros: 1 if all arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

AndMZ( 1 < 2, 3 < 4 );


```

### [Any](#any)

**Syntax:** y = Any( x, ... )

**Description:** Returns 1 if any element is nonzero, zero otherwise.

**JMP Version Added:** Before version 14

```

Any( [1 0 2] );


```

### [Arc](#arc)

**Syntax:** Arc( left, top, right, bottom, startAngle, endAngle )

**Description:** Draws an arc of an oval. The angles are in degrees, specified with 0 degrees at 12:00 and 90 degrees at 3:00. To line them up with the radian values used by sin() and cos() you must reverse the rotation and add the 90 degree phase shift. For example, radians = 2 * pi() * (90 - degrees) / 360. Arcs sweep clockwise from start to end.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        Arc( 10, 80, 70, 30, 0, 90 );
    )
);


```

### [Arc Finder](#arc-finder)

**Syntax:** Arc Finder( Group( lot, wafer ), X( col ), Y( col ), <optional arguments> )

**Description:** Finds the arcs in the point data and creates a new column identifying the arcs.

**JMP Version Added:** 14

```


dt = Open( "$SAMPLE_DATA/Wafer Stacked.jmp" );
Arc Finder(
    Group( :Lot, :Wafer ),
    X( :X_Die ),
    Y( :Y_Die ),
    Min Distance( 12 ), // minimum distance among 3 points to seed an arc
    Min Radius( 15 ), // minimum radius of the acceptable arc
    Max Radius( 2000 ), // maximum radius of acceptable arc
    Max Radius Error( 2 ), // how close a point needs to be added
    Min Arc Points( 5 ), // how many points to define an arc
    Number of Searches( 500 ), // how many random probes of data
    Max Number Arcs( 3 ) // number of arcs searched for
);
dt << Color or Mark by Column( :Arc Number );
dt << Graph Builder(
    Size( 1539, 921 ),
    Variables( X( :X_Die ), Y( :Y_Die ), Wrap( :Lot_Wafer Label ), Color( :Arc Number ) ),
    Elements( Points( X, Y, Legend( 6 ) ) )
);


```

### [ArcCosH](#arccosh)

**Syntax:** y = ArcCosH( x )

**Description:** Returns the inverse hyperbolic cosine of x.

**JMP Version Added:** Before version 14

```

ArcCosH( 1 );


```

### [ArcCosine](#arccosine)

**Syntax:** y = ArcCosine( x )

**Description:** Returns the inverse trigonometric cosine of x, where x is in the range [-1, 1] and the result is in the range [0, Pi()].

**JMP Version Added:** Before version 14

```

ArcCosine( 0.5 );


```

### [ArCos](#arcos)

**Syntax:** y = ArcCosine( x )

**Description:** Returns the inverse trigonometric cosine of x, where x is in the range [-1, 1] and the result is in the range [0, Pi()].

**JMP Version Added:** Before version 14

```

ArcCosine( 0.5 );


```

### [ArcSine](#arcsine)

**Syntax:** y = ArcSine( x )

**Description:** Returns the inverse trigonometric sine of x, where x is in the range [-1, 1] and the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

ArcSine( 0.5 );


```

### [ArcSinH](#arcsinh)

**Syntax:** y = ArcSinH( x )

**Description:** Returns the inverse hyperbolic sine of x.

**JMP Version Added:** Before version 14

```

ArcSinH( 1 );


```

### [ArcTan](#arctan)

**Syntax:** y = ArcTangent( x1, \<x2=1> )

**Description:** Returns the inverse trigonometric tangent of x1/x2, where the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

4 * ArcTangent( 1 );


```

### [ArcTangent](#arctangent)

**Syntax:** y = ArcTangent( x1, \<x2=1> )

**Description:** Returns the inverse trigonometric tangent of x1/x2, where the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

4 * ArcTangent( 1 );


```

### [ArcTanH](#arctanh)

**Syntax:** y = ArcTanH( x )

**Description:** Returns the inverse hyperbolic tangent of x.

**JMP Version Added:** Before version 14

```

ArcTanH( 0.5 );


```

### [Arg](#arg)

**Syntax:** y = Arg( x, i )

**Description:** Returns the ith argument of the evaluated expression or Empty() if there is no ith argument.

**JMP Version Added:** Before version 14

```

Arg( Expr( Sum( a, b, c ) ), 2 );


```

### [Arg Expr](#arg-expr)

**Syntax:** y = Arg Expr( expr, i )

**Description:** Returns the ith argument of the expression or Empty() if there is no ith argument. This function is deprecated. Please use Arg() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Arg Expr() equivalent
Arg( Expr( Sum( a, b, c ) ), 2 );


```

**Example 2**

```

// Deprecated
Arg Expr( Sum( a, b, c ), 2 );


```

### [ARIMA Forecast](#arima-forecast)

**Syntax:** x = ARIMA Forecast( dtcol, length, model, estimates, from, to )

**Description:** Returns a vector of forecasted values for the dtcol column in the range determined by the from and to arguments. The length argument specifies a portion of the column for the function to use. The model argument matches messages that are sent to the Time Series platform to fit a model. The estimates argument matches the child of a Get Models message result of a single model. Typically, the from value is between 1 and the to value, inclusive. However, if from\<=0 and from\<=to, part of the results are filtered predictions.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
ARIMA Forecast(
    :Steel Shipments,
    96,
    ARIMA( 1, 0, 1 ),
    {AR Coefficients( {0.900397691783565} ), MA Coefficients( {0.483316746530245} ),
    Intercept( 6466.03264802329 )},
    1,
    2
);


```

### [Arrhenius](#arrhenius)

**Syntax:** y = Arrhenius( tempC )

**Description:** Returns the non-specific component of the Arrhenius relationship that is then multiplied by the activation energy in the Arrhenius equation. Returns 11604.5181215503 / (tempC + 273.15).

**JMP Version Added:** Before version 14

```

Arrhenius( 100 );


```

### [Arrhenius Inv](#arrhenius-inv)

**Syntax:** tempC = Arrhenius Inv( y )

**Description:** Returns the inverse of the Arrhenius function, which is (11604.5181215503 / y) - 273.15.

**JMP Version Added:** Before version 14

```

Arrhenius Inv( 100 );


```

### [Arrow](#arrow)

**Syntax:** Arrow( {x1, y1}, {x2, y2}, ... ); Arrow( xMatrix, yMatrix )

**Description:** Draws a line with an arrow or a sequence of such lines.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 4 );
        Arrow( [10 30 90], [88 22 44] );
    )
);


```

### [ArSin](#arsin)

**Syntax:** y = ArcSine( x )

**Description:** Returns the inverse trigonometric sine of x, where x is in the range [-1, 1] and the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

ArcSine( 0.5 );


```

### [As Boolean](#as-boolean)

**Syntax:** b = As Boolean( x )

**Description:** Evaluates an expression and returns a Boolean value.

**JMP Version Added:** 14

```

x = 45;
b = As Boolean( x > 2 );
Show( b );


```

### [As C Expr](#as-c-expr)

**Syntax:** y = As C Expr( x )

**Description:** Returns an equivalent expression in the C programming language.

**JMP Version Added:** Before version 14

```

As C Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As Column](#as-column)

**Syntax:** y = :name; y = dataTable:name; y = As Column( name ); y = As Column( dataTable, name )

**Description:** Accesses the specified column in the specified or current data table. An error is thrown if no such column or data table is found.

**JMP Version Added:** Before version 14

```

exdt = Open( "$SAMPLE_DATA/Big Class.jmp" );
exdt:height[1] + :height[2] + As Column( "height" )[3];


```

### [As Constant](#as-constant)

**Syntax:** y = As Constant( x )

**Description:** Evaluates an expression to create a constant value that does not change after it has been computed

**JMP Version Added:** Before version 14

**Example 1**

```

New Table( "As Constant Demo Table 1",
    Add Rows( 10 ),
    New Column( "Non-Constant", Formula( Random Uniform() ) ),
    New Column( "Constant", Formula( As Constant( Random Uniform() ) ) )
);


```

**Example 2**

```

New Table( "As Constant Demo Table 2",
    Add Rows( 1000 ),
    New Column( "What's on Your Desktop?",
        "character",
        Formula(
            As Constant( xFiles = Files In Directory( "$Desktop" ) );
            iR = Row();
            If( iR <= N Items( xFiles ),
                xFiles[iR],
                "---"
            );
        )
    )
);


```

**Example 3**

```

For( i = 1, i <= 10, i++,
    x = 2;
    y = 100;
    z = As Constant( x + y );
    x *= i;
    y /= i;
    Show( i, x + y, z );
);


```

### [As Date](#as-date)

**Syntax:** dt = As Date( datetime )

**Description:** Returns a date-time value marked internally as a date for output purposes.

**JMP Version Added:** Before version 14

```

As Date( Today() );


```

### [As Global](#as-global)

**Syntax:** y = ::name; y = As Global( name )

**Description:** Accesses the specified global variable or throws an error if no such global variable exists.

**JMP Version Added:** Before version 14

```

::ex = 23;
Local( {ex = 12}, Eval List( {ex, ::ex, As Global( "ex" )} ) );


```

### [As JavaScript Expr](#as-javascript-expr)

**Syntax:** y = As JavaScript Expr( x )

**Description:** Returns an equivalent expression in the JavaScript programming language.

**JMP Version Added:** Before version 14

```

As JavaScript Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As JSON Expr](#as-json-expr)

**Syntax:** y = As JSON Expr( x )

**Description:** Returns a JSON (JavaScript Object Notation) representation of the expression.

**JMP Version Added:** Before version 14

```

As JSON Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As List](#as-list)

**Syntax:** y = As List( matrix )

**Description:** Returns a list representation of a matrix. Multi-column matrices are converted to a list of lists, one per row, as would be expected by the Matrix operator.

**JMP Version Added:** Before version 14

```

As List( [11 22 33, 44 55 66] );


```

### [As Name](#as-name)

**Syntax:** y = As Name( s )

**Description:** Converts a string into a name or a list of strings into a list of names.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:(As Name( "height" ))[3];


```

### [As Namespace](#as-namespace)

**Syntax:** asns = As Namespace( ns )

**Description:** Accesses the specified Namespace or throws an error if no such namespace exists.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex"
);
As Namespace( ns );


```

### [As Python Expr](#as-python-expr)

**Syntax:** y = As Python Expr( x )

**Description:** Returns an equivalent expression in the Python programming language.

**JMP Version Added:** Before version 14

```

As Python Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As Root](#as-root)

**Syntax:** y = :::name; y = As Root( name )

**Description:** Accesses the specified root-scoped variable or throws an error if no such root-scoped variable exists.

**JMP Version Added:** 15

```

::: ex = 23;
Local( {ex = 12}, Eval List( {ex, ::: ex, As Global( "ex" )} ) );


```

### [As Row State](#as-row-state)

**Syntax:** rs = As Row State( x )

**Description:** Converts a number into a row state value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row(
    Row State() = As Row State(
        (:sex == "F") * 2 + (:sex == "M") * 4 + ((:sex == "F") * 2 + (:sex == "M") * 6) * 16
         + (:age - 11) * 256
    )
);


```

### [As SAS Expr](#as-sas-expr)

**Syntax:** y = As SAS Expr( x )

**Description:** Returns a version of the expression more suitable for a SAS DATA step. The code must be wrapped in a PROC DS2 call.

**JMP Version Added:** Before version 14

```

As SAS Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As Scoped](#as-scoped)

**Syntax:** y = namespace:variable; y = As Scoped( namespace, variable )

**Description:** Accesses the specified scoped variable or throws an error if no such scoped variable exists.

**JMP Version Added:** Before version 14

```

Here:z = 23.5;
As Scoped( Here, z );


```

### [As SQL Expr](#as-sql-expr)

**Syntax:** y = As SQL Expr( x, <style> )

**Description:** Returns a string that contains the expression converted to valid SQL syntax for use in an SQL Select statement.

**JMP Version Added:** Before version 14

```

As SQL Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ), "MySQL" );


```

### [As Table](#as-table)

**Syntax:** dt = As Table( matrix, \<matrix2,...> < \<<invisible/private>, < \<<Column Names(name list) > )

**Description:** Converts a matrix into a data table. The invisible option can be used to avoid displaying the table.

**JMP Version Added:** Before version 14

```

As Table( [1 2 3, 4 5 6] );


```

### [Assign](#assign)

**Syntax:** y = x; Assign( y, x )

**Description:** Assigns a value to a variable or a list of variables.

**JMP Version Added:** Before version 14

```

{ex1, ex2} = {Pi(), 1};
ex1 + ex1;


```

### [Associative Array](#associative-array)

**Syntax:** y = Associative Array( {{key1, value1}, ...} ); y = Associative Array( keys, values )

**Description:** Creates an associative array, which is also known as a dictionary or a hash map. In the two-argument form, keys and values can be a list, matrix, or data table column.

**JMP Version Added:** Before version 14

```

ex = Associative Array( {"red", "blue"}, {1, 2} );
ex["green"] = 3;
ex << get contents;


```

### [ATan](#atan)

**Syntax:** y = ArcTangent( x1, \<x2=1> )

**Description:** Returns the inverse trigonometric tangent of x1/x2, where the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

4 * ArcTangent( 1 );


```

### [B Spline Coef](#b-spline-coef)

**Syntax:** coef = B Spline Coef( x, Internal Knot Grid, \<degree = 3>, \<KnotEndPoints = min(x) || max(x)> )

**Description:** Returns the matrix of B-Spline coefficients. Internal Knot Grid is either the number of desired knot points based on percentiles of x or a vector specifying the internal knot points. Optional parameter degree specifies the degree of the B-splines with a default of 3. Optional parameter KnotEndPoints takes a 2x1 matrix containing [lower, upper] locations for the knots on the boundary. The knot end points default to the min and max of x. The second example demonstrates how B-spline coefficients can be used as the design matrix in a linear model.

**JMP Version Added:** 14

**Example 1**

```

B Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 2 );
B Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], [3, 7] );


```

**Example 2**

```

xx = (0 :: 10)`;
yy = [0, 1, 0, -1, 0, 1, 0, -1, 0, 1, 0];
designMat = B Spline Coef( xx, 2 );
Linear Regression( yy, designMat, <<nointercept );


```

### [Back Color](#back-color)

**Syntax:** Back Color( \<name|index|rgbList> )

**Description:** Sets the background color for the erase mode in the Text() function.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Back Color( "red" );
        Text( Erased, {50, 20}, "Hello" );
    )
);


```

### [Beep](#beep)

**Syntax:** Beep()

**Description:** Makes an alert sound.

**JMP Version Added:** Before version 14

```

Beep();


```

### [Best Partition](#best-partition)

**Syntax:** {c1, c2, g2} = Best Partition( xIndices, yIndices, \<<Ordered, \<<ContinuousY, \<<ContinuousX )

**Description:** Determines the optimal grouping (experimental function).

**JMP Version Added:** Before version 14

```

/*Example for Continuous X and Continuous Y*/Best Partition(
    [1.2, 2.2, 3.5, 4.4, 5.6, 7.8],
    [11.2, 11.5, 11.8, 100.5, 100.7, 100.8],
    <<ContinuousX,
    <<ContinuousY
);


```

### [Beta](#beta)

**Syntax:** z = Beta( x, y )

**Description:** Returns Beta function of x and y, defined as Gamma( x ) * Gamma( y ) / Gamma( x + y ).

**JMP Version Added:** Before version 14

```

Beta( 5, 4 );


```

### [Beta Binomial Distribution](#beta-binomial-distribution)

**Syntax:** cumprob = Beta Binomial Distribution( k, p, n, delta )

**Description:** Returns the probability that a Beta Binomial distributed random variable is less than or equal to k.

**JMP Version Added:** Before version 14

```

p = 0.5;
n = 25;
delta = 0;
New Window( "Example: BetaBinomial Distribution",
    y = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, n + 1 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= n, k++,
            H Line( k, k + 1, Beta Binomial Distribution( k, p, n, delta ) );
            V Line(
                k + 1,
                Beta Binomial Distribution( k, p, n, delta ),
                Beta Binomial Distribution( k + 1, p, n, delta )
            );
        );
        Text( {15, 0.1}, "n=", Round( n ), " p=", Round( p, 2 ) );
        Text( {15, 0.04}, "Dispersion=", Round( delta, 2 ) );
    ),
    H List Box( Slider Box( 0.01, 0.99, p, y << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( -0.01, 0.99, delta, y << reshow ), Text Box( " Dispersion" ) )
);


```

### [Beta Binomial Probability](#beta-binomial-probability)

**Syntax:** prob = Beta Binomial Probability( k, p, n, delta )

**Description:** Returns the probability that a Beta Binomial distributed random variable is equal to k.

**JMP Version Added:** Before version 14

```

n = 25;
p = 0.5;
delta = 0;
New Window( "Binomial and BetaBinomial Probabilities",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, n + 1 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( x = 0, x <= n, x++,
            Pen Color( "red" );
            V Line( x, 0, Binomial Probability( p, n, x ) );
            Pen Color( "blue" );
            V Line( x + 0.35, 0, Beta Binomial Probability( x, p, n, delta ) );
        );
        Text( {1, 0.25}, "p=", Round( p, 8 ), " Dispersion=", Round( delta, 8 ) );
        Text( {0, 0.28}, "Red = Binomial, Blue = BetaBinomial" );
    ),
    H List Box( Slider Box( 0.2, 0.8, p, clty << reshow ), Text Box( " p" ) ),
    H List Box(
        Slider Box( -0.05, 0.999, delta, clty << reshow ),
        Text Box( " Dispersion" )
    )
);


```

### [Beta Binomial Quantile](#beta-binomial-quantile)

**Syntax:** q = Beta Binomial Quantile( p, n, delta, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Beta Binomial( p, n, delta ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qbinexp = 0.3;
qbinexn = 20;
qbinexq = 0.5;
delta = 0;
New Window( "Example: BetaBinomial Quantile",
    qbinexy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qbinexk = 0, qbinexk < Round( qbinexn ), qbinexk++,
            H Line(
                qbinexk,
                qbinexk + 1,
                Beta Binomial Distribution( qbinexk, qbinexp, Round( qbinexn ), delta )
            );
            V Line(
                qbinexk + 1,
                Beta Binomial Distribution( qbinexk, qbinexp, Round( qbinexn ), delta ),
                Beta Binomial Distribution( qbinexk + 1, qbinexp, Round( qbinexn ), delta )
            );
        );
        Pen Color( "blue" );
        V Line( Beta Binomial Quantile( qbinexp, Round( qbinexn ), delta, qbinexq ), 0, 1 );
        Text(
            {6, 0.17},
            "n=",
            Round( qbinexn ),
            " p=",
            Round( qbinexp, 2 ),
            " Disp.=",
            Round( Delta, 2 ),
            " q=",
            Round( qbinexq, 2 )
        );
        Text(
            {6, 0.1},
            "quantile=",
            Round( Beta Binomial Quantile( qbinexp, Round( qbinexn ), delta, qbinexq ) )
        );
    ),
    H List Box( Slider Box( 0, 0.99, qbinexp, qbinexy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 40, qbinexn, qbinexy << reshow ), Text Box( " n" ) ),
    H List Box(
        Slider Box( -0.01, 0.99, delta, qbinexy << reshow ),
        Text Box( " Dispersion" )
    ),
    H List Box( Slider Box( 0, 1, qbinexq, qbinexy << reshow ), Text Box( " q" ) )
);


```

### [Beta Density](#beta-density)

**Syntax:** y = Beta Density( q, alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns the density at q for a beta distribution, where q is in the interval theta to theta + sigma, alpha and beta are shape parameters, and theta and sigma are threshold and range parameters, respectively.

**JMP Version Added:** Before version 14

```

alpha = 0.5;
beta = 0.5;
New Window( "Example: Beta Density",
    y = Graph Box(
        Y Scale( 0, 2.5 ),
        X Scale( 0, 1 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Beta Density( q, alpha, beta ), q );
        Text( {0.55, 2.2}, "\!U03B1=", Round( alpha, 2 ), " \!U03B2=", Round( beta, 2 ) );
    ),
    H List Box( Slider Box( 0, 10, alpha, y << reshow ), Text Box( " \!U03B1" ) ),
    H List Box( Slider Box( 0, 10, beta, y << reshow ), Text Box( " \!U03B2" ) )
);


```

### [Beta Distribution](#beta-distribution)

**Syntax:** p = Beta Distribution( q, alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns the probability that a beta distributed random variable is less than q, where alpha and beta are shape parameters and theta and sigma are threshold and range parameters, respectively.

**JMP Version Added:** Before version 14

```

alpha = 0.5;
beta = 0.5;
New Window( "Example: Beta Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 1 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Beta Distribution( q, alpha, beta ), q );
        Text( {0.1, 0.9}, "\!U03B1=", Round( alpha, 2 ), " \!U03B2=", Round( beta, 2 ) );
    ),
    H List Box( Slider Box( 0, 10, alpha, y << reshow ), Text Box( " \!U03B1" ) ),
    H List Box( Slider Box( 0, 10, beta, y << reshow ), Text Box( " \!U03B2" ) )
);


```

### [Beta Quantile](#beta-quantile)

**Syntax:** q = Beta Quantile( p, alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns the quantile from a Beta distribution, the value for which the probability is p that a random value would be lower, where alpha and beta are shape parameters and theta and sigma are threshold and range parameters, respectively.

**JMP Version Added:** Before version 14

```

Beta Quantile( 0.95, 2, 5 );


```

### [Binomial Distribution](#binomial-distribution)

**Syntax:** cumprob = Binomial Distribution( p, n, k )

**Description:** Returns the probability that a Binomially distributed random variable is less than or equal to k.

**JMP Version Added:** Before version 14

```

p = 0.5;
n = 30;
New Window( "Example: Binomial Distribution",
    y = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 31 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= n, k++,
            H Line( k, k + 1, Binomial Distribution( p, n, k ) );
            V Line(
                k + 1,
                Binomial Distribution( p, n, k ),
                Binomial Distribution( p, n, k + 1 )
            );
        );
        Text( {20, 0.1}, "n=", Round( n ), " p=", Round( p, 2 ) );
    ),
    H List Box( Slider Box( 0, 1, p, y << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 30, n, y << reshow ), Text Box( " n" ) )
);


```

### [Binomial Probability](#binomial-probability)

**Syntax:** prob = Binomial Probability( p, n, k )

**Description:** Returns the probability that a Binomially distributed random variable is equal to k.

**JMP Version Added:** Before version 14

```

cltp = 0.03;
cltn = 30;
New Window( "Example: Binomial Probability and Central Limit Theorem",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 60 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( cltk = 0, cltk <= cltn, cltk++,
            V Line( cltk, 0, Binomial Probability( cltp, cltn, cltk ) )
        );
        Text( {15, 0.09}, "n=", Round( cltn ), " p=", Round( cltp, 2 ) );
    ),
    H List Box( Slider Box( 0.01, 0.99, cltp, clty << reshow ), Text Box( " p" ) ),
    H List Box(
        Slider Box( 0, 2000, cltn, clty << reshow ),
        Text Box( " n ( Drag me and see Central Limit Theorem )" )
    )
);


```

### [Binomial Quantile](#binomial-quantile)

**Syntax:** q = Binomial Quantile( p, n, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Binomial( p, n ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qbinexp = 0.3;
qbinexn = 20;
qbinexq = 0.5;
New Window( "Example: Binomial Quantile",
    qbinexy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qbinexk = 0, qbinexk < Round( qbinexn ), qbinexk++,
            H Line(
                qbinexk,
                qbinexk + 1,
                Binomial Distribution( qbinexp, Round( qbinexn ), qbinexk )
            );
            V Line(
                qbinexk + 1,
                Binomial Distribution( qbinexp, Round( qbinexn ), qbinexk ),
                Binomial Distribution( qbinexp, Round( qbinexn ), qbinexk + 1 )
            );
        );
        Pen Color( "blue" );
        V Line( Binomial Quantile( qbinexp, Round( qbinexn ), qbinexq ), 0, 1.0 );
        Text(
            {6, 0.17},
            "n=",
            Round( qbinexn ),
            " p=",
            Round( qbinexp, 2 ),
            " q=",
            Round( qbinexq, 2 ),
            " quantile=",
            Round( Binomial Quantile( qbinexp, Round( qbinexn ), qbinexq ) )
        );
    ),
    H List Box( Slider Box( 0, 1, qbinexp, qbinexy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 40, qbinexn, qbinexy << reshow ), Text Box( " n" ) ),
    H List Box( Slider Box( 0, 1, qbinexq, qbinexy << reshow ), Text Box( " q" ) )
);


```

### [Blend Colors](#blend-colors)

**Syntax:** color = Blend Colors( color1, color2, <percent2>, <colorSpace>, <hueDirection> )

**Description:** Blends two colors with a configurable percentage and color space.

**JMP Version Added:** 18

**Example 1**

```

Blend Colors( "black", "white", 0.25 );


```

**Example 2**

```

Blend Colors( "red", "blue", "sRGB" );


```

**Example 3**

```

Blend Colors( "red", "blue", "lRGB" );


```

**Example 4**

```

Blend Colors( "red", "blue", 0.5, "LUV" );


```

**Example 5**

```

Blend Colors( "red", "blue", 0.75, "HLS" );


```

**Example 6**

```

c1 = "red";
c2 = "blue";
steps = 20;
New Window( "HLS Radial Color Blending",
    Graph(
        frameSize( 290, 110 ),
        X Scale( 0, 150 ),
        Y Scale( 0, 55 ),
        Suppress Axes,
        Text( {2, 47}, "Short" ),
        Text( {2, 32}, "Long" ),
        Text( {2, 17}, "Positive" ),
        Text( {2, 2}, "Negative" ),
        For( i = 0, i < steps, i += 1,
            x = i * 6 + 30;
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Short" ) );
            Rect( x, 45, x + 5, 55, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Long" ) );
            Rect( x, 30, x + 5, 40, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Positive" ) );
            Rect( x, 15, x + 5, 25, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Negative" ) );
            Rect( x, 0, x + 5, 10, 1 );
        )
    )
);


```

**Example 7**

```

c1 = "blue";
c2 = "red";
steps = 20;
New Window( "HCLuv Radial Color Blending",
    Graph(
        frameSize( 290, 110 ),
        X Scale( 0, 150 ),
        Y Scale( 0, 55 ),
        Suppress Axes,
        Text( {2, 47}, "Short" ),
        Text( {2, 32}, "Long" ),
        Text( {2, 17}, "Positive" ),
        Text( {2, 2}, "Negative" ),
        For( i = 0, i < steps, i += 1,
            x = i * 6 + 30;
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Short" ) );
            Rect( x, 45, x + 5, 55, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Long" ) );
            Rect( x, 30, x + 5, 40, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Positive" ) );
            Rect( x, 15, x + 5, 25, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Negative" ) );
            Rect( x, 0, x + 5, 10, 1 );
        )
    )
);


```

### [Blob MD5](#blob-md5)

**Syntax:** blobResult = Blob MD5( blob )

**Description:** Makes a 16-byte result BLOB from a source BLOB (Binary Large OBject). The 16 byte BLOB is the MD5 checksum (or the hash) of the source BLOB.

**JMP Version Added:** Before version 14

```

Hex(/* make it printable */ Blob MD5(/* get the hash */
        Load Text File(/* a file from the samples */ "$SAMPLE_IMPORT_DATA/animals.txt",
            BLOB/* the result is a BLOB, not a string */
        )
    )
) == "763D3C9F5F3E92951B3A3DC965084DAC" /* benchmark hash value */ /* the result is 1 if the benchmark matches */
;


```

### [Blob Peek](#blob-peek)

**Syntax:** blobResult = Blob Peek( blob, offset, <length> )

**Description:** Makes a new blob from a subrange of bytes of the given blob. The offset argument is zero-based, so the first byte is at offset zero.

**JMP Version Added:** Before version 14

```

Blob Peek( Char To Blob( "Quick Bob, eat your lunch!" ), 6 /*Zero based!*/, 3 );


```

### [Blob To Char](#blob-to-char)

**Syntax:** s = Blob To Char( blob, \<encoding="utf-8"> )

**Description:** Makes a character string from a BLOB (Binary Large Object), using the specified encoding. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, shift_jis, euc-jp, and ascii~hex.

**JMP Version Added:** Before version 14

```

Blob To Char( Hex To Blob( "436166C3A9" ) ) || Blob To Char(
    Hex To Blob( "436166C3A9" ),
    "ascii~hex"
);


```

### [Blob To Matrix](#blob-to-matrix)

**Syntax:** m = Blob To Matrix( blob, type, bytesEach, endian, \<nCols=1> )

**Description:** Makes a matrix by converting bytes in the blob to numbers. type is either "int", "uint" or "float". bytesEach is either 1, 2, 4, or 8. endian indicates whether the first byte is the most significant ("big") or the least significant ("little"); "native" indicates the machine's native format.

**JMP Version Added:** Before version 14

```

Blob To Matrix( Hex To Blob( "00010002FFFFFFFE" ), "int", 2, "big", 2 );


```

### [Border Box](#border-box)

**Syntax:** y = Border Box( \<Left( pix )>, \<Right( pix )>, \<Top( pix )>, \<Bottom( pix )>, \<Sides( 0 )>, displayBoxArg )

**Description:** Returns a display box to add space around the argument display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 1 ), spacing( 10 ),
        Text Box( "Quadratic Formula" ),
        Border Box( Left( 10 ), Right( 10 ), bottom( 10 ), top( 10 ), sides( 15 ),
            Expr As Picture( Expr( (-b + Sqrt( b ^ 2 - 4 * a * c )) / (2 * a) ) )
        )
    )
);


```

### [Box Cox Inverse Transform](#box-cox-inverse-transform)

**Syntax:** x = Box Cox Inverse Transform( y, lambda )

**Description:** Returns the inverse Box-Cox transformation of the argument.

**JMP Version Added:** 19

```

Box Cox Inverse Transform( 3, 2 );


```

### [Box Cox Transform](#box-cox-transform)

**Syntax:** y = Box Cox Transform( x, lambda )

**Description:** Returns the Box-Cox transformation of the argument.

**JMP Version Added:** 19

```

Box Cox Transform( 3, 2 );


```

### [Box Plot Seg](#box-plot-seg)

**Syntax:** b = Box Plot Seg(<data>, <frequency>, <weight>, \<vertical=0|1>)

**Description:** Returns a display seg representing a box plot based on the passed in x and y values.

**JMP Version Added:** Before version 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box( Frame Size( 40, 180 ), Y Scale( 0, 5 ), Box Plot Seg( [1, 2, 3, 4] ) )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));


```

### [Break](#break)

**Syntax:** Break()

**Description:** Causes a break in flow of control within a For or While loop.

**JMP Version Added:** Before version 14

```

For( i = 1, i <= 10, i++,
    If( i == 5, Break() );
    Print( "i=" || Char( i ) );
);


```

### [Build Information](#build-information)

**Syntax:** y = Build Information()

**Description:** Returns the build date and time, release or debug build, and product name.

**JMP Version Added:** Before version 14

```

Build Information();


```

### [Busy Light](#busy-light)

**Syntax:** y = Busy Light( < \<<Automatic(0|1)>, \<Size(x, y)>, < \<<Disable> )

**Description:** Creates a rotating image to indicate a busy process.

**JMP Version Added:** Before version 14

```

New Window( "Example", Busy Light( <<automatic ) );


```

### [Button Box](#button-box)

**Syntax:** y = Button Box( title, script )

**Description:** Returns a display box to show a titled button. The script argument is run when the button is clicked.

**JMP Version Added:** Before version 14

```

New Window( "Example", Button Box( "Press Me", Print( "Pressed." ) ) );


```

### [Calendar Box](#calendar-box)

**Syntax:** y = Calendar Box()

**Description:** Returns a display box containing a calendar control. The calendar supports single-selection of a date and optional time.

**JMP Version Added:** Before version 14

```

New Window( "Calendar Box Example", Calendar Box() );


```

### [Caption](#caption)

**Syntax:** y = Caption( \<{h, v}>, text | remove, \<Delayed( seconds )>, \<Font(font)>, \<Font Size(size)>, \<Text Color(color)>, \<Back Color(color)>, \<Spoken(bool)> )

**Description:** Shows a caption window at the location specified by {h, v} and containing the text specified by the text argument. The Delayed( seconds ) argument sets the waiting time in seconds before each caption.

**JMP Version Added:** Before version 14

**Formatted Caption**

```

Caption(
    {100, 200},
    "explanation",
    Font( "Arial Black" ),
    Font Size( 16 ),
    Text Color( "blue" ),
    Back Color( "yellow" ),
    Spoken( 1 )
);


```

**Remove Caption**

```

Caption( "explanation" );
Wait( 2 );
Caption( remove );


```

### [CAS Connect](#cas-connect)

**Syntax:** CAS Connect(\<URL(...)>, \<Username(...)>, \<Password(...)>, \<Prompt(Never | Always | IfNeeded)>, \<Session("session id")>, \<Proxy Server("http://my_proxy:80")>, \<Proxy User("proxy_username")>, \<Bypass Proxy("http://localhost:80")>, \<Certificates(...)>, \<Verify Certificates(1 | 0)>, \<No Verify Certificates(1 | 0)>, \<Timeout(seconds)>, \<Authorization Method("Basic" | "Bearer")>)

**Description:** Connects to a new CAS server. CAS Connect uses URL, User name, Password arguments and optionally Prompt and Session. Prompt can be IfNeeded, Always, or Never. URL, user name, password can be omitted if the Prompt argument is IfNeeded or Always. The default value for Prompt is Never. Session can be used to reconnect to an existing CAS session. The session must be valid for the URL, user name, and password used in the connection. The optional Certificates argument is useful for supplying trusted certificates for https connections to CAS. The optional Verify Certificates or No Verify Certificates argument is useful to temporarily accept self-signed certificates. The optional Proxy Server argument is useful for supplying a proxy host in a proxy environment. The optional Proxy User argument is useful for supplying user and password information for a proxy environment. The optional Bypass Proxy argument is use for bypassing the proxy for certain hosts. The optional Timeout argument sets a timeout value for the CAS connection operations. The optional Authorization Method argument specifies how JMP connects to CAS. This is dependent on the CAS deployment.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = CAS Connect(
    URL( url ),
    Username( "myCas_user" ),
    Prompt( Always ),
    Certificates( "c:\mycerts.crt" )
);


```

### [CAS Delete Table](#cas-delete-table)

**Syntax:** CAS Delete Table(tablename, <remove>)

**Description:** This action deletes the filesystem table. The in memory table is not affected. Specifying Quiet will suppress errors for a non-existent table. Specifying remACs will remove access controls for a table. Specifying Remove will also remove the table from memory.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
CAS Delete Table( "Casuser", "Big Class" );


```

### [CAS Disconnect](#cas-disconnect)

**Syntax:** CAS Disconnect()

**Description:** Disconnects from a CAS server and optionally terminates the session. By default, the session is terminated when disconnected.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = CAS Connect( URL( url ), Username( "myCas_user" ), Prompt( Always ) );
CAS Disconnect();


```

### [CAS Export Data](#cas-export-data)

**Syntax:** y = CAS Export Data(jmp_data_table, cas_libref, cas_dataset, \<named_arguments>)

**Description:** Exports a table to a CAS server. jmp_data_table is the JMP data table to export while cas_libref and cas_dataset are the target locations on the CAS server. The optional named argument is Save(1|0). When a table is exported to CAS, it is not persisted to CAS filesystem unless the Save option is used. Most CAS actions occur in memory.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "CASUSER", "Big Class" );


```

### [CAS Get Data Sets](#cas-get-data-sets)

**Syntax:** y = CAS Get Data Sets(\<"caslib">)

**Description:** Gets a list of available CAS data sets. These data sets are found on the CAS filesystem. The optional argument limits the list of data sets to the CAS library. If no argument is used, then the data set list contains the fully qualified data set name (library.dataset). If the argument is used, then the data set list is a list of data set names.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class", Save( 1 ) );
datasets = CAS Get Data Sets( "casuser" );
Show( datasets );
cas << Delete Table( "Casuser", "Big Class" );
datasets = CAS Get Data Sets( "casuser" );
Show( datasets );


```

### [CAS Get Libraries](#cas-get-libraries)

**Syntax:** y = CAS Get Libraries()

**Description:** Gets a list of available CAS libraries.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
libraries = CAS Get Libraries();
Show( libraries );


```

### [CAS Import Data](#cas-import-data)

**Syntax:** dt = CAS Import Data(libref, dataset, \<named_arguments>)

**Description:** Imports a table from a CAS server. Optional named arguments are Invisible(0|1), Private(0|1) and UseLabelsForVarNames(0|1).

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
CAS Import Data( "Casuser.Big Class" );


```

### [CAS Is Connected](#cas-is-connected)

**Syntax:** CAS Is Connected

**Description:** Returns 1 if there is an active CAS server connection. Otherwise, returns 0.

**JMP Version Added:** 15

```


connected = CAS Is Connected();
Show( connected );


```

### [CAS Remove Table](#cas-remove-table)

**Syntax:** CAS Remove Table(tablename, <delete>)

**Description:** This action drops the in-memory table. The file that was created with the save action is not affected. Specifying delete will also delete the table from the file system.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
CAS Remove Table( "Casuser", "Big Class" );


```

### [CAS Table To Data Table](#cas-table-to-data-table)

**Syntax:** dt = CAS Table To Data Table(jsonstring, \<Invisible(1|0) | Private(1|0) | Use Labels for Var Names(1|0)>)

**Description:** Converts a SAS CAS Table JSON text to a JMP data table.

**JMP Version Added:** 15

```


json =
"\[
{
  "_ctb": true,
  "label": "Selected Rows from Table BIG CLASS",
  "name": "Fetch",
  "title": "Selected Rows from Table BIG CLASS",
  "schema": [
    {
      "format": "",
      "label": "",
      "name": "_Index_",
      "type": "int",
      "width": 4
    },
    {
      "format": "",
      "label": "",
      "name": "name",
      "type": "string",
      "width": 9
    },
    {
      "format": "",
      "label": "",
      "name": "age",
      "type": "double",
      "width": 8
    },
    {
      "format": "",
      "label": "",
      "name": "sex",
      "type": "string",
      "width": 1
    },
    {
      "format": "",
      "label": "",
      "name": "height",
      "type": "double",
      "width": 8
    },
    {
      "format": "",
      "label": "",
      "name": "weight",
      "type": "double",
      "width": 8
    }
  ],
  "rows": [
    [
      1,
      "KATIE",
      12,
      "F",
      59,
      95
    ],
    [
      2,
      "LOUISE",
      12,
      "F",
      61,
      123
    ],
    [
      3,
      "JANE",
      12,
      "F",
      55,
      74
    ],
    [
      4,
      "JACLYN",
      12,
      "F",
      66,
      145
    ],
    [
      5,
      "LILLIE",
      12,
      "F",
      52,
      64
    ],
    [
      6,
      "TIM",
      12,
      "M",
      60,
      84
    ],
    [
      7,
      "JAMES",
      12,
      "M",
      61,
      128
    ],
    [
      8,
      "ROBERT",
      12,
      "M",
      51,
      79
    ],
    [
      9,
      "BARBARA",
      13,
      "F",
      60,
      112
    ],
    [
      10,
      "ALICE",
      13,
      "F",
      61,
      107
    ],
    [
      11,
      "SUSAN",
      13,
      "F",
      56,
      67
    ],
    [
      12,
      "JOHN",
      13,
      "M",
      65,
      98
    ],
    [
      13,
      "JOE",
      13,
      "M",
      63,
      105
    ],
    [
      14,
      "MICHAEL",
      13,
      "M",
      58,
      95
    ],
    [
      15,
      "DAVID",
      13,
      "M",
      59,
      79
    ],
    [
      16,
      "JUDY",
      14,
      "F",
      61,
      81
    ],
    [
      17,
      "ELIZABETH",
      14,
      "F",
      62,
      91
    ],
    [
      18,
      "LESLIE",
      14,
      "F",
      65,
      142
    ],
    [
      19,
      "CAROL",
      14,
      "F",
      63,
      84
    ],
    [
      20,
      "PATTY",
      14,
      "F",
      62,
      85
    ]
  ]
}
]\";
dt = CAS Table To Data Table( json );


```

### [CAS Terminate Sessions](#cas-terminate-sessions)

**Syntax:** CAS Terminate Sessions

**Description:** Terminates all CAS sessions owned by the current user.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Terminate Sessions();


```

### [Cauchy Density](#cauchy-density)

**Syntax:** y = Cauchy Density( q, <center>, <scale> )

**Description:** Returns the density at q of a Cauchy distribution with center mu and scale sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Cauchy Density",
    y = Graph Box(
        Y Scale( 0, .4 ),
        X Scale( -6, 6 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Cauchy Density( q ), q );
    )
);


```

### [Cauchy Distribution](#cauchy-distribution)

**Syntax:** p = Cauchy Distribution( q, <center>, <scale> )

**Description:** Returns the probability that a Cauchy distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

New Window( "Example: Cauchy Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -6, 6 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Cauchy Distribution( q ), q );
    )
);


```

### [Cauchy Quantile](#cauchy-quantile)

**Syntax:** q = Cauchy Quantile( p, <center>, <scale> )

**Description:** Returns the quantile from a Cauchy distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

New Window( "Example: Cauchy Quantile",
    Graph Box(
        Y Scale( -6, 6 ),
        X Scale( 0, 1 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Cauchy Quantile( p ), p );
    )
);


```

### [CDF](#cdf)

**Syntax:** {QuantVec, CumProbVec} = CDF( Y )

**Description:** Returns values of the empirical cumulative probability distribution function for vector or list Y. Cumulative probability is the proportion of data values less than or equal to the corresponding entry in vector QuantVec

**JMP Version Added:** Before version 14

```

/* Generate random values, Normal(0,1) */
Y = J( 150, 1, Random Normal() );

/* CDF function */
{Quant, CumProb} = CDF( Y ); 

/* Draw empirical and theorical CDF */
New Window( "Empirical CDF",
    Graph Box(
        X Scale( -3, 3 ),
        Y Scale( 0, 1 ),
        Pen Color( "red" );
        For( i = 2, i <= N Row( Quant ), i++,
            H Line( Quant[i - 1], Quant[i], CumProb[i] );
            V Line( Quant[i - 1], CumProb[i - 1], CumProb[i] );
        );
        i = N Row( Quant );
        V Line( Quant[i], CumProb[i], 1 );
        Pen Color( "blue" );
        Y Function( Normal Distribution( q ), q );
    )
);


```

### [Ceiling](#ceiling)

**Syntax:** y = Ceiling( x )

**Description:** Returns the smallest integer greater than or equal to x. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Ceiling( 1.2 );


```

### [Char](#char)

**Syntax:** s = Char( x, <w>, <d>, < \<<Use Locale( Boolean ) >, < \<<Full Precision( Boolean ) > )

**Description:** Returns a representation of x as a character string, using the maximum width w and decimal places d if the x argument is numeric. \<<FullPrecision writes numeric values using all available precision.

**JMP Version Added:** Before version 14

**Full Precision**

```

Show( Char( 88.54 ), Char( 88.54, <<Full Precision( 1 ) ) );


```

**Simple**

```

Char( Pi(), 10, 4 );


```

**Use Locale**

```

Char( 2.1, <<Use Locale( 1 ) );


```

### [Char To Blob](#char-to-blob)

**Syntax:** blob = Char To Blob( string, \<encoding="utf-8"> )

**Description:** Makes a BLOB (Binary Large Object) from a string of characters, using the specified encoding. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, shift_jis, euc-jp, and ascii~hex.

**JMP Version Added:** Before version 14

```

Char To Blob( "Café", "utf-16be" );


```

### [Char To Hex](#char-to-hex)

**Syntax:** h = Char To Hex( value, \<"integer">|\<encoding="utf-8"> )

**Description:** Returns the hexadecimal text corresponding to the given value and encoding, which can be a number, a string, or a blob. If the value is a number, IEEE 754 64-bit encoding is used unless the optional argument, "integer", is provided. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, ascii~hex, shift_jis, and euc-jp.

**JMP Version Added:** Before version 14

```

Hex( 1024, "integer" ) || " " || Hex( "Café", "utf-16be" );


```

### [Char To Path](#char-to-path)

**Syntax:** m = Char To Path( pathText )

**Description:** Converts a path specification from character form to matrix form.

**JMP Version Added:** Before version 14

```

Show( Char To Path( "M10 10 L50 10 L30 50 Z M20 20 L40 20 L30 40 Z" ) );


```

### [Check Box](#check-box)

**Syntax:** y = Check Box( {item, ...}, <script> )

**Description:** Returns a display box to show one or more check boxes.

**JMP Version Added:** Before version 14

```

New Window( "Example", cb = Check Box( {"Good"}, Show( cb << Get() ) ) );


```

### [Check MATLAB Dependencies](#check-matlab-dependencies)

**Syntax:** Check MATLAB Dependencies()

**Description:** Checks if MATLAB dependencies are installed.

**JMP Version Added:** Before version 14

```


If( !Check MATLAB Dependencies(),
    Install MATLAB Dependencies();
    Print( "Dependencies are installed" );
,
    Print( "Dependencies are installed" )
);


```

### [ChiSquare Density](#chisquare-density)

**Syntax:** p = ChiSquare Density( q, df, \<nonCentrality=0> )

**Description:** Returns the density at q of a Chi-square distribution with df degrees of freedom.

**JMP Version Added:** Before version 14

```

cdedf = 2;
New Window( "Example: ChiSquare Density",
    cdey = Graph Box(
        Y Scale( 0, 0.4 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Density( cdeq, cdedf ), cdeq );
        Text( {7, 0.35}, "df=", Round( cdedf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, cdedf, cdey << reshow ) )
);


```

### [ChiSquare Distribution](#chisquare-distribution)

**Syntax:** p = ChiSquare Distribution( q, df, \<nonCentrality=0> )

**Description:** Returns the probability that a Chi-square distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

cdidf = 2;
New Window( "Example: ChiSquare Distribution",
    cdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Distribution( cdiq, cdidf ), cdiq );
        Text( {1, 0.9}, "df=", Round( cdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, cdidf, cdiy << reshow ) )
);


```

### [ChiSquare Log CDistribution](#chisquare-log-cdistribution)

**Syntax:** y = ChiSquare Log CDistribution( x, df, \<nonCentrality=0> )

**Description:** Returns the log of 1 - Chi-square distribution.

**JMP Version Added:** Before version 14

```

clcdidf = 2;
New Window( "Example: ChiSquare Log CDistribution",
    clcdiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Log CDistribution( clcdiq, clcdidf ), clcdiq );
        Text( {1, -0.9}, "df=", Round( clcdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, clcdidf, clcdiy << reshow ) )
);


```

### [ChiSquare Log Density](#chisquare-log-density)

**Syntax:** y = ChiSquare Log Density( x, df, \<nonCentrality=0> )

**Description:** Returns the log of the Chi-square probability density.

**JMP Version Added:** Before version 14

```

cldedf = 1;
New Window( "Example: ChiSquare Log Density",
    cldey = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Log Density( cldeq, cldedf ), cldeq );
        Text( {7, -0.35}, "df=", Round( cldedf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, cldedf, cldey << reshow ) )
);


```

### [ChiSquare Log Distribution](#chisquare-log-distribution)

**Syntax:** y = ChiSquare Log Distribution( x, df, \<nonCentrality=0> )

**Description:** Returns the log of the Chi-square distribution.

**JMP Version Added:** Before version 14

```

cldidf = 2;
New Window( "Example: ChiSquare Log Distribution",
    cldiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Log Distribution( cldiq, cldidf ), cldiq );
        Text( {1, -0.9}, "df=", Round( cldidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, cldidf, cldiy << reshow ) )
);


```

### [ChiSquare Noncentrality](#chisquare-noncentrality)

**Syntax:** nc = ChiSquare Noncentrality( x, df, prob )

**Description:** Returns the noncentrality parameter nc such that prob is equal to the probability that a Chi-square distributed random variable with df degrees of freedom is less than x.

**JMP Version Added:** Before version 14

```

New Window( "Example: ChiSquare Noncentrality",
    chincgr = Graph Box(
        Y Scale( 0.01, 0.99 ),
        X Scale( 0.01, 0.99 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Noncentrality( 3, 2, ChiSquare Distribution( 3, 2, q ) ), q );
    )
);
ChiSquare Noncentrality( 3, 2, ChiSquare Distribution( 3, 2, 0.5 ) );


```

### [ChiSquare Quantile](#chisquare-quantile)

**Syntax:** q = ChiSquare Quantile( p, df, \<nonCentrality=0> )

**Description:** Returns the quantile from a Chi-Square distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

ChiSquare Quantile( 0.15, 5 );


```

### [Chol Update](#chol-update)

**Syntax:** L2 = Chol Update( L, V, C )

**Description:** Returns an updated Cholesky root of A+V*C*V' where C is an m by m symmetric matrix and V is an n by m matrix. The argument L must be the Cholesky root of an n by n matrix A.

**JMP Version Added:** Before version 14

```

/* The inner product of a design matrix */
exS = [16 1 0 11 -1 12,
1 11 -1 1 -1 1,
0 -1 12 -1 1 0,
11 1 -1 11 -1 9,
-1 -1 1 -1 9 -1,
12 1 0 9 -1 12];
/* Conduct the Cholesky decomposition */
exAchol = Cholesky( exS );

/* Two column vectors to be applied to change the design matrix */
exV = [1 1, 0 0, 0 1, 0 0, 0 0, 0 1];

/* The first column vector is added to one of the rows in the design matrix */
/* The second column vector is subtracted from one of the rows in the design matrix */
exC = [1 0, 0 -1];

/* Update the Cholesky decomposition manually */
exAnew = exS + exV * exC * exV`;
exAcholnew = Cholesky( exAnew );

/* Update the Cholesky decomposition more efficiently */
exAcholnew_test = Chol Update( exAchol, exV, exC );

/* Results are the same */
Show( exAcholnew_test );
Show( exAcholnew );


```

### [Cholesky](#cholesky)

**Syntax:** L = Cholesky( A )

**Description:** Returns the Cholesky decomposition of a positive semi-definite matrix. L is a lower triangular matrix such that L\*L\` = A.

**JMP Version Added:** Before version 14

```

Cholesky( [1 2, 2 13] );


```

### [Choose](#choose)

**Syntax:** y = Choose( i, expr1, expr2, ..., exprElse )

**Description:** Evaluates and returns the ith expr argument or the exprElse argument if there is no ith expr argument.

**JMP Version Added:** Before version 14

```

Choose( Random Integer( 1, 5 ), "red", "blue", "other" );


```

### [Choose Closest](#choose-closest)

**Syntax:** Choose Closest(source string, {canonical strings...}, \<Ignore Case(ignore=1|0)>, \<Ignore Nonprintable(ignore=1|0)>, \<Ignore Whitespace(ignore=1|0)>, \<Max Edit Count(count)>, \<Max Edit Ratio([0..1])>, \<Min String Length(\<count=3>)>, \<Replace Unmatched(replace=0|1)>, \<Unmatched Value(\<value="">)>)

**Description:** Pick the closest string within the given rules and return it.

By default character case is ignored; use Ignore Case to specify.

By default non-printable characters are ignored; Use Ignore Nonprintable to specify.

By default, whitespace is ignored; use Ignore Whitespace to specify.

By default, character changes are not allowed to find a match.

```
Use Max Edit Count to control how many edits may be made.

Use Max Edit Ratio to control the percent change (in terms of characters in the original string) that is allowed.

Both of these settings are applied if specified.

```

By default, strings shorter than 3 characters will not be matched; use Min String Length to specify a different length.

Unmatched strings

```
By default, if no canonical string matches within the given rules, the source string is returned.

Use Replace Unmatched to specify whether the source string will be returned.

Use Unmatched to specify the value to be returned.

```

**JMP Version Added:** 15

**Allow edits**

```

Choose Closest( "MARTA", {"MARTHA"}, Max Edit Count( 2 ) );


```

**Choose among strings, no edits**

```

Choose Closest( "MARTHA_", {"Martha", "MARY"} );


```

**Keep punctuation**

```

Choose Closest( "MARTHA_", {"MARTHA"}, Ignore Punctuation( 0 ) );


```

**Unmatched**

```

Choose Closest( "MARTHA", {"Martha"}, Ignore Case( 0 ), Unmatched() );


```

### [Circle](#circle)

**Syntax:** Circle( {x, y}, radius|PixelRadius( px ), ..., \<"FILL"> )

**Description:** Draws a circle centered at {x, y}. The radius can be specified as an integer based on the vertical axis or as a number of pixels. A pixel-based radius creates a circle that does not vary in size when the vertical axis changes. Arguments can be repeated in any order to draw multiple circles. "FILL", if used, must be last, and fills the circles with the fill color rather than drawing them with the pen color.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        Circle( {20, 20}, 4, 7, 10/* no fill for concentric circles */ );
        Fill Color( "blue" );
        Transparency( .25 );/* transparent fill for concentric circles */
        Circle( {60, 20}, 4, 7, 10, "FILL" );
        Fill Color( "green" );
        Transparency( 1 );/* solid fill */Circle(
            PixelRadius( 18 ),
            {40, 20},
            {40, 50},
            {40, 80},
            "FILL"
        );
    )
);


```

### [Class Exists](#class-exists)

**Syntax:** nsexists = Class Exists( class name )

**Description:** Returns 1 if the class specified by the name argument exists. Otherwise, a 0 is returned.

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
clexists = Class Exists( cl );
Show( clexists );
cl << Delete;
Delete Classes( "complex" );


```

### [Clear Global Window Handler](#clear-global-window-handler)

**Syntax:** Clear Global Window Handler()

**Description:** Clears a window handler previously set by Set Global Window Handler.

**JMP Version Added:** 17

```

Set Global Window Handler(
    Function( {window},
        Print( window << get window title() );
        window << close window();
    )
);
New Window( "My Window" );
Clear Global Window Handler();


```

### [Clear Globals](#clear-globals)

**Syntax:** Clear Globals( < varname, ... > )

**Description:** Clears the values of all currently defined global symbols.

**JMP Version Added:** Before version 14

```

Clear Globals();


```

### [Clear Log](#clear-log)

**Syntax:** Clear Log()

**Description:** Makes the log empty.

**JMP Version Added:** Before version 14

```

Clear Log();


```

### [Clear Symbols](#clear-symbols)

**Syntax:** Clear Symbols( < varname, ... > )

**Description:** Clears the values of all currently defined symbols.

**JMP Version Added:** Before version 14

```

Clear Symbols();


```

### [Close](#close)

**Syntax:** Close( \<dataTableRef|name>, \<NoSave|Save( "path" )> )

**Description:** Closes the data table referenced by the first argument, which defaults to the current data table in the current project (or no project if not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

The second argument is used to save the data table. Use an appropriate file extension in the path to save the data table as a non-JMP format. Specifying NoSave bypasses the prompt to save or disregard changes.

**JMP Version Added:** Before version 14

```

exdt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 3 );
Close( exdt, NoSave );


```

### [Close All](#close-all)

**Syntax:** Close All( \<Project(title|index|box|window)>, Data Tables | Reports | Journals, \<invisible | private>, \<NoSave|Save> )

**Description:** Closes all open resources of a specific type: data tables, journals, or reports.

Only windows in the current project (or no project if not running the script in a project) will be closed. To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

exdt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
exdt2 = Open( "$SAMPLE_DATA/Animals.jmp" );
Wait( 3 );
Close All( Data Tables, NoSave );


```

### [Close Database Connection](#close-database-connection)

**Syntax:** Close Database Connection(databaseConnectionHandle)

**Description:** Closes a database connection returned from Create Database Connection

**JMP Version Added:** Before version 14

```

Close Database Connection( databaseConnectionHandle );


```

### [Close Log](#close-log)

**Syntax:** Close Log()

**Description:** Close the log window

**JMP Version Added:** Before version 14

```

Close Log();
Show( Is Log Open() );


```

### [Col At](#col-at)

**Syntax:** y = Col At( col, index, \<byVar, ...>, < \<<relative(bool)>, < \<<skip missing(expr)> )

**Description:** Returns the value of col at row position index within its byVar group. Rows where the skip missing expression evaluates to a missing value are not included in the indexing.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Lag Height by Sex", Formula( Col At( :height, -1, :sex, <<relative( 1 ) ) ) );
New Column( "Relative to First Height", Formula( :height / Col At( :height, 1, :sex ) ) );
New Column( "Relative to Last Height", Formula( :height / Col At( :height, -1, :sex ) ) );


```

### [Col Box](#col-box)

**Syntax:** y = Col Box( title, boxes )

**Description:** Returns a column box made up of the given display boxes.

**JMP Version Added:** Before version 14

```

dt = New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);


```

### [Col Cumulative Sum](#col-cumulative-sum)

**Syntax:** y = Col Cumulative Sum( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the cumulative sum for the current row. By variables do not need to be presorted.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 40;
Col Cumulative Sum( :height, :sex );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Cumulative Sum for each Sex",
    Formula( Col Cumulative Sum( :height, :sex ) )
);
dt << New Column( "Col Cumulative Sum for each Sex grouped by Excluded",
    Formula( Col Cumulative Sum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Interpolate](#col-interpolate)

**Syntax:** y = Col Interpolate( v, xCol, yCol, \<byVar, ...>, < \<<method(linear|nearest|previous|next)>, < \<<extrapolate(bool)> )

**Description:** Returns an interpolated value within yCol, corresponding to the position of v with xCol. Values outside the range of xCol will be missing unless extrapolate is on, in which case the nearest yCol value will be returned.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Time Series/GNP.jmp" );
dt << New Column( "date30", Formula( :date + 30 ) );
dt << New Column( "gnp30",
    Formula( Col Interpolate( :date30, :date, :"gross national product ($billions)"n ) )
);


```

### [Col List Box](#col-list-box)

**Syntax:** y = Col List Box( \<Data Table( name )>, <all>|\<character|numeric>, \<width( pix )>, <grouped>, \<maxSelected( n )>, \<nlines( n )>, \<MaxItems( n )>, \<MinItems( n )>, \<onChange( expr )>, < \<<Modeling Type({"Any","Continuous","Nominal","Ordinal","Multiple Response","Unstructured Text","Vector","None","Row State"}) >, < \<< Set Data Type(Any|Numeric|Character)>, <script> )

**Description:** Returns a display box to show list box to select data table columns. Use the \<<Modeling Type message to allow specialty modeling types or to restrict the types allowed. The default value of "Any" will allow any column with a classic modeling type ("Continuous", "Nominal", "Ordinal").

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 1", Col List Box( all, width( 250 ), maxSelected( 1 ) ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 2",
    Col List Box( all, <<Set Data Type( "numeric" ), width( 250 ), maxSelected( 1 ) )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 3",
    H List Box(
        ll1 = Col List Box( all ),
        Button Box( "Add", ll2 << append( ll1 << get selected ) ),
        ll2 = Col List Box( "numeric", MaxItems( 1 ), nlines( 1 ) ),
        Button Box( "Remove", ll2 << remove selected )
    )
);


```

### [Col Max](#col-max)

**Syntax:** y = Col Maximum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the maximum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Maximum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Maximum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Maximum Value for Each Age and Sex Group",
    Formula( Col Maximum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Max for each Sex", Formula( Col Maximum( :height, :sex ) ) );
dt << New Column( "Col Max for each Sex grouped by Excluded",
    Formula( Col Maximum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Maximum](#col-maximum)

**Syntax:** y = Col Maximum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the maximum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Maximum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Maximum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Maximum Value for Each Age and Sex Group",
    Formula( Col Maximum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Max for each Sex", Formula( Col Maximum( :height, :sex ) ) );
dt << New Column( "Col Max for each Sex grouped by Excluded",
    Formula( Col Maximum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Mean](#col-mean)

**Syntax:** y = Col Mean( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sample mean across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Mean( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Mean( :height, <<Freq( :weight ) );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Mean( :height, :age ) ) );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Mean for Each Age and Sex Group",
    Formula( Col Mean( :height, :age, :sex ) )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Mean for each Sex", Formula( Col Mean( :height, :sex ) ) );
dt << New Column( "Col Mean for each Sex grouped by Excluded",
    Formula( Col Mean( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Median](#col-median)

**Syntax:** y = Col Median( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the specified median across rows in a column. The ordering is cached internally so that multiple evaluations will be efficient.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Col Median Height",
    numeric,
    continuous,
    formula( Col Median( :height ) )
);
dt << New Column( "Col Median Height by Age",
    numeric,
    continuous,
    formula( Col Median( :height, :age ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 1;
Show( Col Median( :height ) );
Row() = 1;
Show( Col Median( :height, :age ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Median for each Sex", Formula( Col Median( :height, :sex ) ) );
dt << New Column( "Col Median for each Sex grouped by Excluded",
    Formula( Col Median( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Min](#col-min)

**Syntax:** y = Col Minimum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the minimum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Minimum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Minimum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Minimum Value for Each Age and Sex Group",
    Formula( Col Minimum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Min for each Sex", Formula( Col Minimum( :height, :sex ) ) );
dt << New Column( "Col Min for each Sex grouped by Excluded",
    Formula( Col Minimum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Minimum](#col-minimum)

**Syntax:** y = Col Minimum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the minimum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Minimum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Minimum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Minimum Value for Each Age and Sex Group",
    Formula( Col Minimum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Min for each Sex", Formula( Col Minimum( :height, :sex ) ) );
dt << New Column( "Col Min for each Sex grouped by Excluded",
    Formula( Col Minimum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Mode](#col-mode)

**Syntax:** y = Col Mode( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sample mode across rows in a column, selecting the smallest in the case of multiple modes. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** 17

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Mode( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Mode( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Mode for Each Age and Sex Group",
    Formula( Col Mode( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Mode for each Sex", Formula( Col Mode( :height, :sex ) ) );
dt << New Column( "Col Mode for each Sex grouped by Excluded",
    Formula( Col Mode( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Moving Average](#col-moving-average)

**Syntax:** y = Col Moving Average( xCol, \<weighting=0.25>, \<before=-1>, \<after=0>, <partial window is missing=1>, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the moving average over a given interval based at the current row. For the weight multiplier, 1 means equal weighting, 0 means linear weighting, and other values act as an exponential weighting multiplier. By variables do not need to be presorted.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 40;
Col Moving Average( :height, 1, 5, 0, :sex );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Moving Average for each Sex",
    Formula( Col Moving Average( :height, :sex ) )
);
dt << New Column( "Col Moving Average for each Sex grouped by Excluded",
    Formula( Col Moving Average( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col N Missing](#col-n-missing)

**Syntax:** y = Col N Missing( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the number of missing values across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col N Missing( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col N Missing( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Number of Missing Values for Each Age and Sex Group",
    Formula( Col N Missing( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:height[10] = .;
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col N Missing for each Sex", Formula( Col N Missing( :height, :sex ) ) );
dt << New Column( "Col N Missing for each Sex grouped by Excluded",
    Formula( Col N Missing( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col N Unique](#col-n-unique)

**Syntax:** y = Col N Unique( xCol, \<byVar, ...>, < \<<score missing(bool)> )

**Description:** Returns the number of unique values in a column. If missing values are requested, all missing value codes are counted as a single value.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "N unique age by sex", Formula( Col N Unique( :age, :sex ) ) );
New Column( "N unique height by age", Formula( Col N Unique( :height, :age ) ) );


```

### [Col Number](#col-number)

**Syntax:** y = Col Number( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the number of nonmissing values across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Number( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Number( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Number of Nonmissing Values for Each Age and Sex Group",
    Formula( Col Number( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:height[10] = .;
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Number for each Sex", Formula( Col Number( :height, :sex ) ) );
dt << New Column( "Col Number for each Sex grouped by Excluded",
    Formula( Col Number( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Quantile](#col-quantile)

**Syntax:** y = Col Quantile( xCol, p, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the specified quantile across rows in a column. The ordering is cached internally so that multiple evaluations will be efficient.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Col Quantile Height",
    numeric,
    continuous,
    formula( Col Quantile( :height, 0.5 ) )
);
dt << New Column( "Col Quantile Height by Age",
    numeric,
    continuous,
    formula( Col Quantile( :height, 0.5, :age ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 1;
Show( Col Quantile( :height, 0.5 ) );
Row() = 1;
Show( Col Quantile( :height, 0.5, :age ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Quantile for each Sex",
    Formula( Col Quantile( :height, 0.5, :sex ) )
);
dt << New Column( "Col Quantile for each Sex grouped by Excluded",
    Formula( Col Quantile( :height, 0.5, :sex, Excluded( Row State() ) ) )
);


```

### [Col Rank](#col-rank)

**Syntax:** y = Col Rank( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<<tie("average"|"row"|"minimum"|"maximum"|"arbitrary")> )

**Description:** Returns the rank, ranging from 1 as the lowest, with row-order tie-breaking unless specified by the \<<Tie argument. "average" produces the average for tied ranks, and "minimum" produces the lowest of tied ranks. For "row" and "arbitrary" each row has a unique rank.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Rank Height", Formula( Col Rank( :height, <<tie( "average" ) ) ) );
New Column( "Rank Height by age", Formula( Col Rank( :height, :age ) ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Rank for each Sex", Formula( Col Rank( :height, :sex ) ) );
dt << New Column( "Col Rank for each Sex grouped by Excluded",
    Formula( Col Rank( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Score](#col-score)

**Syntax:** y = Col Score( xCol, \<byVar, ...>, < \<<score missing(bool)> )

**Description:** Returns an integer score for each unique value, ordering according to any relevant column properties.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Score Height", Formula( Col Score( :height ) ) );
New Column( "Score Height by age", Formula( Col Score( :height, :age ) ) );


```

### [Col Sequence](#col-sequence)

**Syntax:** y = Col Sequence( \<byVar, ...>, < \<<skip missing(expr)>, < \<<sequence(start=1, end=unbounded, incr=1, repeat=1)>)

**Description:** Returns the position of this row within its byVar group, adjusted by skip missing and any sequence parameters.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Row within sex", Formula( Col Sequence( :sex ) ) );
New Column( "Alternate within sex", Formula( Col Sequence( :sex, <<Sequence( 1, 2 ) ) ) );
New Column( "Row within sex, 60+",
    Formula( Col Sequence( :sex, <<skip missing( Sqrt( :height - 60 ) ) ) )
);


```

### [Col Shuffle](#col-shuffle)

**Syntax:** y = Col Shuffle(\<byVar, \<Excluded( Row State() )>, ...>)

**Description:** Returns a random integer between 1 and the number of rows of the current data table. When used in a column formula, Col Shuffle() creates a random ordering of row numbers with each row number appearing only once. The ordering is cached internally so that multiple evaluations are efficient.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Shuffle 1", Numeric, Continuous, Set Formula( Col Shuffle() ) );
dt << New Column( "Shuffle 2", Numeric, Continuous, Set Formula( Col Shuffle() ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Shuffle", Numeric, Continuous, Set Formula( Col Shuffle( :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Shuffle for each Sex", Formula( Col Shuffle( :height, :sex ) ) );
dt << New Column( "Col Shuffle for each Sex grouped by Excluded",
    Formula( Col Shuffle( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Simple Exponential Smoothing](#col-simple-exponential-smoothing)

**Syntax:** y = Col Simple Exponential Smoothing( xCol, alpha, \<byVar, ...> )

**Description:** Returns the simple exponential smoothing prediction for the current row, using smoothing weight alpha. By variables do not need to be presorted. Formula is Predicted Value[t]=alpha * Observed Value[t-1] + (1-alpha) * Predicted Value[t-1], with Predicted Value[1] = Observed Value[1].

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Time Series/Seriesa.jmp" );
Row() = 40;
Col Simple Exponential Smoothing( :Column1, .7 );


```

### [Col Span Box](#col-span-box)

**Syntax:** y = Col Span Box( title, children )

**Description:** Returns a column that has a header that spans child columns

**JMP Version Added:** Before version 14

```

New Window( "test",
    Table Box(
        Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);


```

### [Col Standardize](#col-standardize)

**Syntax:** y = Col Standardize( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the value minus the column mean divided by the column standard deviation across rows in a column. If by-group columns are specified, the value is standardized against the mean and standard deviation of the by-group.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 1;
Col Standardize( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Standardize( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Standardize for each Sex",
    Formula( Col Standardize( :height, :sex ) )
);
dt << New Column( "Col Standardize for each Sex grouped by Excluded",
    Formula( Col Standardize( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Std Dev](#col-std-dev)

**Syntax:** y = Col Std Dev( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sample standard deviation across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Std Dev( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Std Dev( :height, :age ) ) );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Std Dev( :height, :age, <<Freq( :weight ) ) ) );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Standard Deviation for Each Age and Sex Group",
    Formula( Col Std Dev( :height, :age, :sex ) )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Standard Deviation for each Sex",
    Formula( Col Std Dev( :height, :sex ) )
);
dt << New Column( "Col Standard Deviation for each Sex grouped by Excluded",
    Formula( Col Std Dev( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Stored Value](#col-stored-value)

**Syntax:** y = Col Stored Value( <dt>, xCol, \<row=Row()> )

**Description:** Returns column value that has not had column properties applied to it. If row option is not specified, then the current row is assumed.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Equity.jmp" );
:JOB << Set Property( "Missing Value Codes", {"Other"} );
y1 = Col Stored Value( :JOB, 10 );
y2 = Col Stored Value( :JOB, 11 );
y3 = Col Stored Value( :JOB, 14 );
y4 = Col Stored Value( :JOB, 15 );
Show( y1, y2, y3, y4 );


```

### [Col Sum](#col-sum)

**Syntax:** y = Col Sum( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sum across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Sum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Sum( :height, <<Freq( :weight ) );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Sum( :height, :age ) ) );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Sum for Each Age and Sex Group",
    Formula( Col Sum( :height, :age, :sex ) )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Sum for each Sex", Formula( Col Sum( :height, :sex ) ) );
dt << New Column( "Col Sum for each Sex grouped by Excluded",
    Formula( Col Sum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Collapse Whitespace](#collapse-whitespace)

**Syntax:** scw = Collapse Whitespace( s )

**Description:** Trims leading and trailing whitespace and removes duplicate interior white spaces

**JMP Version Added:** Before version 14

```

Collapse Whitespace( "  The  dog    crossed    the  road  " );


```

### [Color Difference](#color-difference)

**Syntax:** color = Color Difference( color1, color2, <difference metric>)

**Description:** Returns the difference between two colors under a specified color difference metric.

**JMP Version Added:** 18

**Example 1**

```

Color Difference( "red", "blue" );


```

**Example 2**

```

Color Difference( "red", "blue", "sRGB" );


```

**Example 3**

```

Color Difference( "red", "blue", "redmean" );


```

**Example 4**

```

Color Difference( "red", "blue", "CIE76" );


```

**Example 5**

```

Color Difference( "red", "blue", "CIE94" );


```

**Example 6**

```

Color Difference( "red", "blue", "CIEDE2000" );


```

**Example 7**

```

Color Difference( "red", "blue", "dEok" );


```

### [Color Of](#color-of)

**Syntax:** y = Color Of( <rs> ); Color Of( \<Row State( <r> )> ) = y

**Description:** Returns the color component of the specified row state value, either a positive JMP color palette index or a negative RGB-encoded value. If Color Of is used as an L-value, it changes the color of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" ) << Color By Column( :height );
Color To RGB( Color Of( Row State( 3 ) ) );
Row() = 3;
Color To RGB( Color Of() );


```

### [Color State](#color-state)

**Syntax:** rs = Color State( color )

**Description:** Returns a row state value with the color component set to the specified value. The color argument can be any valid JSL color.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Color State( {1, 0.5, 1} );
Color To RGB( Color Of( Row State( 3 ) ) );


```

### [Color To HLS](#color-to-hls)

**Syntax:** {h, l, s} = Color To HLS( color )

**Description:** Returns a list of the hue, lightness, and saturation components. The color argument can be any valid JSL color, or a matrix of color numbers.

**JMP Version Added:** Before version 14

```

Color To HLS( RGB Color( 1.0, 0.5, 0.5 ) );


```

### [Color To RGB](#color-to-rgb)

**Syntax:** {r, g, b} = Color To RGB( color )

**Description:** Returns a list of the red, green, and blue components, between 0 and 1. The color argument can be any valid JSL color, or a matrix of color numbers.

**JMP Version Added:** Before version 14

```

Color To RGB( HLS Color( 30 / 360, 0.5, 1 ) );


```

### [Column](#column)

**Syntax:** y = Column( name|number ); y = Column( dataTable, name|number, \<"formatted"> )

**Description:** Returns a reference to the specified data table column. The keyword "formatted" allows accessing formatted data, like the value label.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
col4 = Column( 4 );
ht = Column( "height" );
col4[1] + ht[2];


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << run script( "Set Sex Value Labels" );
col = Column( dt, "sex", "formatted" );
Write( "\!n", col[5] );
Write( "\!nData value returned is the formatted value of row 5." );


```

### [Column Dialog](#column-dialog)

**Syntax:** y = Column Dialog( \<var = ColList("Label", \<Min Col(min)>, \<Max Col(max)>, \<Width(w)>, \<Data Type("Numeric"|"Character"|"Any")>, \<Modeling Type({\<"Continuous">, \<"Nominal">, \<"Ordinal">, \<"None">, \<"Multiple Response">, \<"Unstructured Text">, \<"Vector">})> )>, \<var=EditText("string")>, \<var=EditNumber(num)>, \<var=Check Box( "Text", 0|1)>, \<var=RadioButtons( "a", "b" )>, \<var=Combo Box("choice1", ...)>, \<HList(box, ...)>, \<VList(box, ...)>, \<LineUp(ncol, box, ...)>, \<Text Box("string")>, \<Window Title("title")>, \<Window Icon("icon string")>, \<Dialog Description("description")>, \<Recall(script)>, \<Help Script(script)>)

**Description:** Prompts the user with a modal window with fields to select columns of a data table. The specification can include several types of input boxes as well as container boxes to organize the window.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Column Dialog(
    ex y = ColList( "Y", Min Col( 1 ), Max Col( 2 ), Data Type( "Numeric" ) ),
    ex x = ColList( "X", Max Col( 1 ), Modeling Type( {"Continuous", "Multiple Response"} ) ),
    Line Up( 2,
        Text Box( "Alpha" ), ex = EditNumber( .05 ),
        Text Box( "Beta" ), ey = EditText( "xyz" )
    ),
    HList( cb = Check Box( "check", 1 ) ),
    HList( combo = Combo Box( "option1", "option2" ) ),
    HList( rb = RadioButtons( "a", "b" ) ),
    Window Title( "Custom Launch Dialog" ),
    Window Icon( "RowState" ), //icon string can be a full path file name of an image file.
    Dialog Description( "The dialog before a groundbreaking discovery!" ),
    Recall Script(
        Function( {dlgBox},
            dlgBox[list box box( 2 )] << remove all;
            dlgBox[list box box( 1 )] << clear selection;
            dlgBox[list box box( 1 )] << set selected( 3 );
            dlgBox[Button Box( 2 )] << click;
        )
    ),
    Help Script( Web( "http://www.jmp.com/" ) )
);


```

### [Column Name](#column-name)

**Syntax:** name = Column Name( n )

**Description:** Returns the name of the nth column of the current data table.

**JMP Version Added:** Before version 14

```

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


```

### [Combine States](#combine-states)

**Syntax:** rs = Combine States( rs1, ... )

**Description:** Combines several row state values into one.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Combine States( Hue State( 5 ), Shade State( 1 ) );


```

### [Combo Box](#combo-box)

**Syntax:** y = Combo Box( {item \<( tipstr )>, ...}, <script> )

**Description:** Returns a display box to show a combo box with a popup menu. Each item in the combo box can have an optional tooltip that is specified as a string inside of parentheses following the item text string.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    cb = Combo Box( {"single", "double", "triple"("tool tip")}, Show( cb << Get() ) )
);


```

### [Concat](#concat)

**Syntax:** s = s1 || s2 ...; m = m1 || m2 ...; s = Concat( s1, s2, ... )

**Description:** Concatenates strings into a longer string or matrices into a wider matrix.

**JMP Version Added:** Before version 14

```

[1 2] || [3 4] || [5 6];


```

### [Concat Items](#concat-items)

**Syntax:** string = Concat Items( {list of strings}, <separatorString> )

**Description:** Joins a list of strings into one long string, separating each from next with the separator, a blank if unspecified.

**JMP Version Added:** Before version 14

```

Concat Items( {"www", "jmp", "com"}, "." );


```

### [Concat To](#concat-to)

**Syntax:** string1 ||= string2; matrix1 ||= matrix2; Concat To( a, b )

**Description:** Concatenates in place. a ||= b is equivalent to a = a || b. This is an assignment operator.

**JMP Version Added:** Before version 14

```

ex = "hello ";
ex ||= "world";


```

### [Constrained Maximize](#constrained-maximize)

**Syntax:** Constrained Maximize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<LessThanEQ({mat_A, vec_b}), \<<GreaterThanEQ({mat_A, vec_b}), \<<EqualTo({mat_A, vec_b}), \<<MaxIter( 250 ), \<<tolerance( .00001 ), \<<ShowDetails(True), \<<StartingValues([x1, x2, ... ])), \<<SetVariableLimit({lowerLimitVector,upperLimitVector})

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that maximize the expr expression with optional linear constraints. The variables, x1, x2, and so on, can be scalars or vectors. Lower and upper bounds must be specified for each variable in parentheses following the variable's name or with the optional parameter \<<SetVariableLimits(). Optional arguments for the Constrained Maximize function enable you to specify the following: linear constraints, maximum number of iterations, desired tolerance, output details, starting values, and limits for the optimization variables. (See example 2.) Linear constraints are specified using the mat_A coefficient matrix and the vec_b right hand side vector.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple Example*/
f = Expr(
    -2 * x1 ^ 2 - 2 * x2 ^ 2 + 2 * x1 * x2 + 4 * x1 + 6 * x2
);
A = [1 1, 1 5];
b = [2, 5];
minFun = Constrained Maximize(
    f,
    {x1( 0, 5 ), x2( 0, 5 )},
    <<lessthanEQ( {A, b} )/*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    <<StartingValues( [1, .5] )
);
Eval List( {x1, x2, minFun} );


```

**Example 2**

```

/*Simple Example with optional parameters included*/ 
x = [., .];
f = Expr(
    -2 * x[1] ^ 2 - 2 * x[2] ^ 2 + 2 * x[1] * x[2] + 4 * x[1] + 6 * x[2]
);
A = [1 1, 1 5];
b = [2, 5];
{objVal, iters, gradient, hessian} = Constrained Maximize(
    f,
    {x},
    <<lessthanEQ( {A, b} )/*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    MaxIter( 250 ),
    <<tolerance( 1e-5 ),
    <<showDetails( True ),
    <<StartingValues( [1, .5] ),
    <<setVariableLimit( {[0, 0], [5, 5]} )
);
Show( x, objVal, iters, gradient, hessian );


```

### [Constrained Minimize](#constrained-minimize)

**Syntax:** Constrained Minimize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<LessThanEQ({mat_A, vec_b}), \<<GreaterThanEQ({mat_A, vec_b}), \<<EqualTo({mat_A, vec_b}), \<<MaxIter( 250 ), \<<tolerance( .00001 ), \<<ShowDetails(True), \<<StartingValues([x1, x2, ... ])), \<<SetVariableLimit({low,high})

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that minimize the expr expression with optional linear constraints. The variables, x1, x2, and so on, can be scalars or vectors. Lower and upper bounds must be specified for each variable in parentheses following the variable's name or with the optional parameter \<<SetVariableLimits(). Optional arguments for the Constrained Minimize function enable you to specify the following: linear constraints, maximum number of iterations, desired tolerance, output details, starting values, and limits for the optimization variables. (See example 2.) Linear constraints are specified using the mat_A coefficient matrix and the vec_b right hand side vector.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple Example*/
f = Expr(
    2 * x1 ^ 2 + 2 * x2 ^ 2 - 2 * x1 * x2 - 4 * x1 - 6 * x2
);
A = [1 1, 1 5];
b = [2, 5];
minFun = Constrained Minimize(
    f,
    {x1( 0, 5 ), x2( 0, 5 )},
    <<lessthanEQ( {A, b} )/*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    <<StartingValues( [1, .5] )
);
Eval List( {x1, x2, minFun} );


```

**Example 2**

```

/*Simple Example with optional parameters included*/ 
x = [., .];
f = Expr(
    2 * x[1] ^ 2 + 2 * x[2] ^ 2 - 2 * x[1] * x[2] - 4 * x[1] - 6 * x[2]
);
A = [1 1, 1 5];
b = [2, 5];
{objVal, iters, gradient, hessian} = Constrained Minimize(
    f,
    {x},
    <<lessthanEQ( {A, b} ) /*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    MaxIter( 250 ),
    <<tolerance( 1e-5 ),
    <<showDetails( True ),
    <<StartingValues( [1, .5] ),
    <<setVariableLimit( {[0, 0], [5, 5]} )
);
Show( x, objVal, iters, gradient, hessian );


```

### [Contains](#contains)

**Syntax:** pos = Contains( x, item, \<start=1> )

**Description:** Returns the position of item within x, starting at position start if provided. If start is negative, the search starts backward from length( x ) - start. The argument x can be a string or a list.

**JMP Version Added:** Before version 14

```

Show( Contains( "redreed", "re", -1 ) );
Show( Contains( {"A", 2, "C", [1 5], "C"}, "C", 4 ) );


```

### [Contains Item](#contains-item)

**Syntax:** b = Contains Item( x, item | list | Pat Regex(), <delimiter> )

**Description:** Returns a Boolean indicating whether the word [item], one of a list of words [list], or pattern [pattern] matches one of the words in the text represented by [x]. Words are delimited by the characters in the optional delimiter [delimiter] string. A comma, ",", character is the default delimiter. Blanks are trimmed from the ends of each extracted word from the input text string [x].

**JMP Version Added:** Before version 14

**Example 1**

```

Show( Contains Item( "A, 2, C, D, C", "C", ", " ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Food Journal.jmp" );
dt << New Column( "Cheese",
    numeric,
    continuous,
    Formula( Contains Item( dt:Item Name, "Cheese", ", " ) )
);
dt << Distribution( Column( :Cheese ) );


```

**Example 3**

```

//find repeated character c in cdcef
Contains Item( "abcde,bcdef,cdcef", Pat Regex( "(.).*?\1" ), "," );


```

### [Context Box](#context-box)

**Syntax:** y = Context Box( displayBox, ... )

**Description:** Returns a display box that establishes a scoped evaluation context. Allows different parts of a display window to be executed independently of each other.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Context Box(
        Outline Box( "Picker",
            V List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
        )
    )
);


```

### [Continue](#continue)

**Syntax:** Continue()

**Description:** Causes a continuation of next iteration of flow of control within a For or While loop.

**JMP Version Added:** Before version 14

```

For( i = 1, i <= 10, i++,
    If( i < 2, Continue() );
    Print( "i=" || Char( i ) );
);


```

### [Contour](#contour)

**Syntax:** Contour( xVector, yVector, zGridMatrix, zContours, < \<<zColor( color, option )>, < \<<Fill|Fill Between|Fill Below|Fill Above>, < \<<Transparency(vector)> )

**Description:** Draws contours given a grid of values. If there are fewer colors specified than there are contours, options of "Interpolate Colors" or "Cycle Colors" determines how the colors will be applied.

**JMP Version Added:** Before version 14

```


New Window( "Example",
    H List Box(
        Outline Box( "Line",
            Graph Box(
                Contour( 1 :: 100, 1 :: 100, (1 :: 100)` * (1 :: 100), 7 ^ (0 :: 4) )
            )
        ),
        Outline Box( "Line Colors",
            Graph Box(
                Contour(
                    1 :: 100,
                    1 :: 100,
                    (1 :: 100)` * (1 :: 100),
                    7 ^ (0 :: 4),
                    <<zColor( {"Blue", "Red"} )
                )
            )
        )
    ),
    H List Box(
        Outline Box( "Fill Cycle",
            Graph Box(
                Contour(
                    1 :: 100,
                    1 :: 100,
                    (1 :: 100)` * (1 :: 100),
                    7 ^ (0 :: 4),
                    <<zColor(
                        {RGB Color( 218, 218, 255 ), RGB Color( 255, 218, 218 )},
                        "Cycle Colors"
                    ),
                    fill
                )
            )
        ),
        Outline Box( "Fill Interpolate",
            Graph Box(
                Contour(
                    1 :: 100,
                    1 :: 100,
                    (1 :: 100)` * (1 :: 100),
                    7 ^ (0 :: 4),
                    <<zColor( {"Blue", "Red"}, "Interpolate Colors" ),
                    fill
                )
            )
        )
    )
);


```

### [Contour Function](#contour-function)

**Syntax:** Contour Function( zExpr, xName, yName, z|zMatrix, < \<<XGrid( min, max, incr )>, < \<<YGrid( min, max, incr )>, < \<<ZColor( color, option )>, < \<<ZLabeled>, < \<<Filled>, < \<<FillBetween>, < \<<Ternary>, < \<<Transparency( t )> )

**Description:** Evaluates the expression on a grid of xName and yName values and draws the contour lines. The color can be specified as a number, a matrix, a list of RGB values, a list of color names, or a Color Theme. The transparency t can be specified as a number or as a matrix. If the Ternary option is specified, the contours are clipped to a ternary coordinate system.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    Graph Box(
        Contour Function(
            Log( a * a + b * b ),
            a,
            b,
            1 :: 10,
            <<ZColor( {"blue", "green", "red"}, "Cycle Colors" ),
            Transparency( 0.9 )
        )
    )
);


```

**Example 2**

```

New Window( "Example",
    Graph Box(
        Contour Function(
            Log( a * a + b * b ),
            a,
            b,
            1 :: 10,
            <<Filled,
            <<ZColor( {{1, 0.1, 0.1}, {0.1, 1, 0.1}, {0.1, 0.1, 1}}, "Interpolate Colors" )
        )
    )
);


```

### [Contour Seg](#contour-seg)

**Syntax:** me = Contour Seg( Triangulation, [ levels ], < zColor([colors], \<Cycle Colors|Interpolate Colors>) >, < Transparency([] | t) >

**Description:** Returns a display seg representing contours of a Triangulation. Optional colors can be specified for each level as a matrix or list. The transparency can be specified as a number or matrix.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        )
    )
);


```

### [Convert File Path](#convert-file-path)

**Syntax:** path = Convert File Path( path, \<absolute|relative>, \<posix|windows>, \<base( path )>, <search> )

**Description:** Returns the converted path.

**JMP Version Added:** Before version 14

```

For Each( {pv},
    {"HOME", "DOCUMENTS", "SAMPLE_DATA", "SAMPLE_IMPORT_DATA", "SAMPLE_SCRIPTS",
    "SAMPLE_IMAGES", "USER_APPDATA", "USER_JMPDATA", "MAPS", "USER_JMPDATA_ALL", "TEMP"},
    Write(
        pv || Repeat( " ", 20 - Length( pv ) ) || " => " || Convert File Path( "$" || pv )
         || "\!N"
    )
);


```

### [Copy Directory](#copy-directory)

**Syntax:** rc = Copy Directory( from, to, \<recursive(0|1)> )

**Description:** Copies files from one directory to another, optionally copying subdirectories. The directory name will be created at the to-path and should not be part of the to-path. Returns 1 if the directory was copied or 0 if the directory was unable to be copied. Throws an error if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Copy Directory( "$SAMPLE_DATA/Loss Function Templates", "$TEMP" );/* creates $TEMP/Loss Function Templates */ 
rc1 = File Exists( "$TEMP/Loss Function Templates/Normal.jmp" );
rc2 = Delete File( "$TEMP/Loss Function Templates/Normal.jmp" );
rc3 = File Exists( "$TEMP/Loss Function Templates/Normal.jmp" );
rc4 = Delete Directory( "$TEMP/Loss Function Templates" );
rc5 = Directory Exists( "$TEMP/Loss Function Templates" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 1 0 1 0 */


```

### [Copy File](#copy-file)

**Syntax:** rc = Copy File( from, to )

**Description:** Copies a file from the original file to a new file with the same or a different name. Specify a complete path and file name for the destination. Returns 1 if the file was copied or 0 if the file was unable to be copied. Throws an error if the path is invalid or does not exist. A file cannot be copied when either the from or to path is invalid, or if the to file already exists.

**JMP Version Added:** Before version 14

```

rc0 = File Exists( "$TEMP/x.jmp" );
rc1 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc2 = File Exists( "$TEMP/x.jmp" );
rc3 = Delete File( "$TEMP/x.jmp" );
rc4 = File Exists( "$TEMP/x.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 );/* 0 1 1 1 0 */


```

### [Correlation](#correlation)

**Syntax:** y = Correlation( x , < \<<"Pairwise" >, < \<<"Shrink" >, < \<<Freq(vector) >, < \<<Weight(vector) > )

**Description:** Returns the correlation matrix of the matrix argument x. The "Pairwise" argument handles missing values in pairwise rather than rowwise fashion. The "Shrink" argument reduces the off-diagonal elements by a factor that is determined using the method described in Schafer and Strimmer, 2005. The Freq and Weight arguments specify vectors of frequency or weight values, respectively.

**JMP Version Added:** Before version 14

```

Correlation( [1 3 5, 3 2 6, 5 6 1] );


```

### [Cos](#cos)

**Syntax:** y = Cosine( x )

**Description:** Returns the trigonometric cosine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Cosine( Pi() / 2 );


```

### [CosH](#cosh)

**Syntax:** y = CosH( x )

**Description:** Returns the hyperbolic cosine of x.

**JMP Version Added:** Before version 14

```

CosH( 1 );


```

### [Cosine](#cosine)

**Syntax:** y = Cosine( x )

**Description:** Returns the trigonometric cosine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Cosine( Pi() / 2 );


```

### [Count](#count)

**Syntax:** y = Count( start, end, s, \<n=1> )

**Description:** Returns the ith value in the sequence of numbers from start to end taking s steps and repeating each number n times, where i is determined by the value of the Row() function. Being dependent on the Row() function, the Count() function is generally used in column formulas.

**JMP Version Added:** Before version 14

```

New Table( "Count Example",
    Add Rows( 12 ),
    New Column( "Count1" ),
    New Column( "Count2" ),
    New Column( "Count3", Set Formula( Count( 0, 6, 4, 1 ) ) )
);
For Each Row(
    :Count1[Row()] = Count( 0, 6, 4, 1 );
    :Count2[Row()] = Count( 0, 6, 3, 2 );
);


```

### [Covariance](#covariance)

**Syntax:** y = Covariance( x , < \<<"Pairwise" >, < \<<"Shrink" >, < \<<Freq(vector) >, < \<<Weight(vector) > )

**Description:** Returns the covariance matrix of the matrix argument x. The "Pairwise" argument handles missing values in pairwise rather than rowwise fashion. The "Shrink" argument reduces the off-diagonal elements by a factor that is determined using the method described in Schafer and Strimmer, 2005. The Freq and Weight arguments specify vectors of frequency or weight values, respectively.

**JMP Version Added:** Before version 14

```

Covariance( [1 3 5, 3 2 6, 5 6 1] );


```

### [Create Database Connection](#create-database-connection)

**Syntax:** dbc = Create Database Connection( dataSourceName|"Connect Dialog", \<DriverPrompt(true|false)> )

**Description:** Creates a database connection and returns a handle to the connection. If DriverPrompt is true, the user will be prompted using the ODBC driver's prompt to supply credentials if necessary.

**JMP Version Added:** Before version 14

```

dbc = Create Database Connection(
    "DSN=dBASE Files;DBQ=C:/Program Files/JMP/JMPPRO/19/Samples/Import Data/;"
);


```

### [Create Directory](#create-directory)

**Syntax:** rc = Create Directory( path )

**Description:** Creates a directory. Returns 1 if directory was created. Returns 0 if the directory already exists or if JMP was unable to create the directory.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/sub1" );
rc0 = Create Directory( "$TEMP/sub1/sub2/sub3" );
Save Text File( "$TEMP/sub1/sub2/sub3/temp.txt", "example text" );
date = Last Modification Date( "$TEMP/sub1/sub2/sub3/temp.txt" );
rc1 = Delete Directory( "$TEMP/sub1" );
rc2 = File Exists( "$TEMP/sub1/sub2/sub3/temp.txt" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " ||
Format( date, "ddmonyyyy:h:m:s" );/* 1 1 0 date:time */


```

### [Create Excel Workbook](#create-excel-workbook)

**Syntax:** Create Excel Workbook(<Workbook Name>, \<{List of open tables}>, <Optional list of worksheet names> )

**Description:** Generate an Excel Workbook from open JMP Data Tables

**JMP Version Added:** Before version 14

**Example 1**

```

dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt2 = Open( "$SAMPLE_DATA/Abrasion.jmp" );
Create Excel Workbook( "$TEMP/MyWorkbook.xlsx", {dt1, dt2}, {"Big", "Abrasive"} );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Abrasion.jmp" );
Create Excel Workbook(
    "$TEMP/MyWorkbook.xlsx",
    {"Big Class", "Abrasion"},
    {"Big", "Abrasive"}
);


```

### [Creation Date](#creation-date)

**Syntax:** date = Creation Date( path )

**Description:** Returns the creation date of a file or directory. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Format( Creation Date( "$SAMPLE_DATA/Big Class.jmp" ), "ddmonyyyy:h:m:s" );


```

### [Cumulative Sum](#cumulative-sum)

**Syntax:** y = Cumulative Sum( x )

**Description:** Returns a matrix of partial sums for the input matrix.

**JMP Version Added:** Before version 14

```

Cumulative Sum( [1 1 1 1 . 10 20] );


```

### [Current CAS Connection](#current-cas-connection)

**Syntax:** Current CAS Connection()

**Description:** Obtains the connection to the current CAS Server.

**JMP Version Added:** 15

```


connection = Current CAS Connection();
Show( connection );


```

### [Current Data Table](#current-data-table)

**Syntax:** dt = Current Data Table( \<Project(title|index|box|window)> ); Current Data Table( dt )

**Description:** Returns the current data table or makes the specified data table current if there is one specified.

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Current Data Table() << Get Column Names;


```

### [Current Journal](#current-journal)

**Syntax:** y = Current Journal( \<Project(title|index|box|window)> )

**Description:** Returns a reference to the current journal in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

If no current journal exists in the given project, one will be created automatically.

**JMP Version Added:** Before version 14

```

Current Journal();


```

### [Current Report](#current-report)

**Syntax:** y = Current Report( \<Project(title|index|box|window)> )

**Description:** Returns a display box reference to the current report in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

Current Report();


```

### [Current Window](#current-window)

**Syntax:** y = Current Window( \<Project(title|index|box|window)> )

**Description:** Returns a reference to the current window in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Example Outline",
        Text Box( "Example Text" ),
        Button Box( "Close", Current Window() << Close Window )
    )
);


```

### [Cytometry Logicle](#cytometry-logicle)

**Syntax:** y = Cytometry Logicle( x, T, W, M, A )

**Description:** Compute cytometry logicle transformation.

**JMP Version Added:** Before version 14

```

Cytometry Logicle( 100, 10000, .15, .45, 0 );


```

### [Cytometry Logicle Inverse](#cytometry-logicle-inverse)

**Syntax:** x = Cytometry Logicle Inverse( y, T, W, M, A )

**Description:** Compute inverse cytometry logicle transformation.

**JMP Version Added:** Before version 14

```

Cytometry Logicle Inverse( 100, 10000, .15, .45, 0 );


```

### [Data Connector Registry](#data-connector-registry)

**Syntax:** Data Connector Registry()

**Description:** The collection of data connectors for JMP.

**JMP Version Added:** 18

```


dc = Data Connector Registry() << Get( "com.jmp.sql_server" );


```

### [Data Filter Context Box](#data-filter-context-box)

**Syntax:** y = Data Filter Context Box( displayBox )

**Description:** Returns a display box that defines the extent of the local data filters contained in a display tree. Data filters and Data Filter Context Boxes can be arranged in a hierarchy and will be shared among platforms or boxes contained within the Data Filter Context Boxes.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Shared Local Filter",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter( Local, Add Filter( columns( :sex ), Where( :sex == "F" ) ) ),
            dt << Bubble Plot(
                X( :weight ),
                Y( :height ),
                Fit To Window( "On" ),
                Sizes( :age ),
                Title Position( 0, 0 )
            ),
            dt << Graph Builder(
                Size( 525, 456 ),
                Show Control Panel( 0 ),
                Fit To Window( "On" ),
                Variables( X( :weight ), Y( :age ) ),
                Elements( Box Plot( X, Y, Legend( 4 ) ) ),

            )
        )
    )
);


```

### [Data Filter Source Box](#data-filter-source-box)

**Syntax:** y = Data Filter Source Box( displayBox )

**Description:** Returns a display box that defines the source of a selection filter. Selected rows in reports contained by the Data Filter Source Box will be included for analysis in the other reports contained within a common Data Filter Context Box.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Selection Filter",
    Data Filter Context Box(
        H List Box(
            Data Filter Source Box(
                Graph Builder(
                    Size( 208, 207 ),
                    Show Control Panel( 0 ),
                    Show Legend( 0 ),
                    Variables( X( :age ) ),
                    Elements( Bar( X, Legend( 3 ) ) ),
                    SendToReport(
                        Dispatch( {}, "Graph Builder", OutlineBox, {Set Title( "Filter" )} )
                    )
                )
            ),
            Platform(
                Current Data Table(),
                Bubble Plot(
                    X( :weight ),
                    Y( :height ),
                    Sizes( :age ),
                    Title Position( 0, 0 )
                )
            )
        )
    )
);


```

### [Data Grid Box](#data-grid-box)

**Syntax:** y = Data Grid Box( )

**Description:** Returns a display box that can hold a data table.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example", x = Data Grid Box() );
x << Set Data Table( dt );


```

### [Data Table](#data-table)

**Syntax:** dt = Data Table( name|number )

**Description:** Returns a reference to the specified data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Data Table( 1 );


```

### [Data Table Box](#data-table-box)

**Syntax:** y = Data Table Box( datatable )

**Description:** Returns a table box representing the given data table.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example", Data Table Box( dt ) );


```

### [Data Table Col Box](#data-table-col-box)

**Syntax:** y = Data Table Col Box( col )

**Description:** Returns a column box corresponding to the given data table column.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    Table Box( Data Table Col Box( :name ), Data Table Col Box( :height ) )
);


```

### [Data Table Plot Col Box](#data-table-plot-col-box)

**Syntax:** y = Data Table Plot Col Box( col )

**Description:** Returns a Plot Col Box corresponding to the given data table column and optionally uses the second and third data table columns to create control limits.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    Table Box( Data Table Plot Col Box( :weight ), Data Table Plot Col Box( :height ) )
);


```

### [Datafeed](#datafeed)

**Syntax:** y = Open Datafeed( ... )

**Description:** Creates an object and window you can send messages to manage real-time data feeds.

**JMP Version Added:** Before version 14

```

exfeed = Open Datafeed(/*Connect( Port( "com3" ), Baud( 4800 ), DataBits( 8 ) ),*/
    Set Script(
        ex = exfeed << getLine;
        Show( ex );
    )
);
For( exi = 0, exi < 5, exi++, /* this is just a way to test a feed when the real data source is not available...*/
    exfeed << Queue Line( Char( exi ) );
    Wait( .5 );
);


```

### [Date Difference](#date-difference)

**Syntax:** delta = Date Difference( dt1, dt2, intervalName, \<alignment="start"> )

**Description:** Returns the difference in intervals of two date/time values. Supported values of intervalName are "Year", "Quarter", "Month", "Week", "Day", "Hour", "Minute", "Second", and "Numeric". An alignment of "Start" includes full or partial intervals, while "Actual" only includes full intervals. An alignment of "Fractional" returns fractional differences, using averages for the duration of "Year", "Quarter", and "Month" intervals.

**JMP Version Added:** Before version 14

**Example 1**

```

Date Difference( Date DMY( 31, 1, 2015 ), Date DMY( 1, 3, 2015 ), "Month", "start" );


```

**Example 2**

```

Date Difference( Date DMY( 31, 1, 2015 ), Date DMY( 1, 3, 2015 ), "Month", "actual" );


```

**Example 3**

```

Date Difference( Date DMY( 31, 1, 2015 ), Date DMY( 1, 3, 2015 ), "Month", "fractional" );


```

### [Date DMY](#date-dmy)

**Syntax:** z = Date DMY( d, m, y )

**Description:** Converts day, month, and year into a JMP date-time value, which is the number of seconds since 01Jan1904.

**JMP Version Added:** Before version 14

```

As Date( Date DMY( 15, 7, 2000 ) );


```

### [Date Increment](#date-increment)

**Syntax:** d = Date Increment( datetime, intervalName, \<incr=1>, \<alignment="start"> )

**Description:** Returns a new date-time value by adding incr number of intervals. Supported values of intervalName are "Year", "Quarter", "Month", "Week", "Day", "Hour", "Minute", "Second", and "Numeric". An alignment of "Start" truncates to the nearest interval prior to adding the increment, while "Actual" retains the full input date/time. An alignment of "Fractional" allows fractional incr values, using averages for the duration of "Year", "Quarter", and "Month" intervals.

**JMP Version Added:** Before version 14

**Example 1**

```

Date Increment( Today(), "Month", 100, "start" );


```

**Example 2**

```

Date Increment( Today(), "Month", 100, "actual" );


```

**Example 3**

```

Date Increment( Today(), "Month", 100, "fractional" );


```

### [Date MDY](#date-mdy)

**Syntax:** z = Date MDY( m, d, y )

**Description:** Converts month, day, and year into a JMP date value, which is the number of seconds since 01Jan1904.

**JMP Version Added:** Before version 14

```

As Date( Date MDY( 7, 15, 2000 ) );


```

### [Day](#day)

**Syntax:** d = Day( datetime )

**Description:** Returns the day of month part of a date-time value, 1 - 31.

**JMP Version Added:** Before version 14

```

Day( Today() );


```

### [Day Of Week](#day-of-week)

**Syntax:** d = Day Of Week( datetime )

**Description:** Returns the day of the week of a date-time value. Sunday = 1, ..., Saturday = 7.

**JMP Version Added:** Before version 14

```

Day Of Week( Today() );


```

### [Day Of Year](#day-of-year)

**Syntax:** d = Day Of Year( datetime )

**Description:** Returns the day of the year of a date-time value. January 1 is 1.

**JMP Version Added:** Before version 14

```

Day Of Year( Today() );


```

### [Days In Month](#days-in-month)

**Syntax:** v = Days In Month(year, month)

**Description:** Return the number of days in a given month.

**JMP Version Added:** 15

```

v = Days In Month( 2016, 2 );


```

### [Debug Break](#debug-break)

**Syntax:** Debug Break()

**Description:** When this expression is evaluated within the JSL Debugger, the Debugger stops executing the script.

**JMP Version Added:** Before version 14

```

// Right-click and select Debug.
// In the JSL Debugger, click Run.
x = 5;
y = 8;
Debug Break();
z = x + yy;
Show( z );


```

### [Decode URI](#decode-uri)

**Syntax:** Decode URI( value )

**Description:** Encode the string using URI encoding

**JMP Version Added:** 14

```


Decode URI( "Foo%20Bar" );


```

### [Decode64 Blob](#decode64-blob)

**Syntax:** y = Decode64 Blob( base64String )

**Description:** Decodes a printable string of base 64 text into a blob.

**JMP Version Added:** 14

```

Decode64 Blob( "dGhlIHF1aWNrIGJyb3duIGZveA==" );


```

### [Decode64 Double](#decode64-double)

**Syntax:** y = Decode64 Double( base64String )

**Description:** Returns the double-precision floating point number from the Base64 encoded string.

**JMP Version Added:** Before version 14

```

Decode64 Double( "P/lUWYIBG9Q=" );


```

### [Define Class](#define-class)

**Syntax:** Define Class("class name", \<Base Class{ "base class name", ... }>, \<Show( All( boolean ) | ( Members( boolean ) | Methods( boolean ) | Functions( boolean ) )+ )>, { method *| member* | function\* } )

**Description:** Define a New Class

**JMP Version Added:** 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
cl << Delete;
Delete Classes( complex );


```

### [Delete Classes](#delete-classes)

**Syntax:** Delete Classes( \<Force( boolean )>, \<class reference, ...> )

**Description:** Deletes all class definitions or one or more specific class definitions.

**JMP Version Added:** Before version 14

```

Define Class(
    "aa",
    {_init_ = Method( {} ), x = 1, m1 = Method( {a, b}, a * b )}
);
Define Class(
    "bb",
    {_init_ = Method( {} ), y = 1, m2 = Method( {a, b}, a / b )}
);
lcaa = New Object( aa() );
lcbb = New Object( bb() );
lcl = Get Classes();
Show( lcl );
Show Classes();
Clear Symbols( lcl );
lcaa << Delete;
lcbb << Delete;
Delete Classes( "aa", "bb" );
Show Classes();


```

### [Delete Directory](#delete-directory)

**Syntax:** rc = Delete Directory( path, \<Allow Undo( boolean )> )

**Description:** Deletes a directory and its files and subdirectories. Returns 1 if the directory was deleted. Returns 0 if directory was unable to be deleted or the path is invalid.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/sub1" );
rc0 = Create Directory( "$TEMP/sub1/sub2/sub3" );
Save Text File( "$TEMP/sub1/sub2/sub3/temp.txt", "example text" );
date = Last Modification Date( "$TEMP/sub1/sub2/sub3/temp.txt" );
rc1 = Delete Directory( "$TEMP/sub1" );
rc2 = File Exists( "$TEMP/sub1/sub2/sub3/temp.txt" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " ||
Format( date, "ddmonyyyy:h:m:s" );/* 1 1 0 date:time */


```

### [Delete File](#delete-file)

**Syntax:** rc = Delete File( path, \<Allow Undo( boolean )> )

**Description:** Deletes a file. Returns 1 if the file was deleted. Returns 0 if file was unable to be deleted. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc1 = File Exists( "$TEMP/x.jmp" );
rc2 = Delete File( "$TEMP/x.jmp" );
rc3 = File Exists( "$TEMP/x.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) /* 1 1 1 0 */;


```

### [Delete Globals](#delete-globals)

**Syntax:** Delete Globals( < varname, ... > )

**Description:** Deletes all the currently defined global symbols and their values.

**JMP Version Added:** Before version 14

```

Delete Globals();


```

### [Delete Namespaces](#delete-namespaces)

**Syntax:** Delete Namespaces( \<Force( boolean )>, \<namespace reference, ...> )

**Description:** Deletes all namespaces or one or more specific namespaces.

**JMP Version Added:** Before version 14

```


nsaa = New Namespace(
    "aa",
    {
        x = 1
    }
);
nsbb = New Namespace(
    "bb",
    {
        y = 1
    }
);
Show Namespaces();
Delete Namespaces( nsaa, nsbb );
Show Namespaces();


```

### [Delete Symbols](#delete-symbols)

**Syntax:** Delete Symbols( < varname, ... > )

**Description:** Deletes all the currently defined symbols and their values.

**JMP Version Added:** Before version 14

```

Delete Symbols();


```

### [Derivative](#derivative)

**Syntax:** y = Derivative( expr, name )

**Description:** Returns the symbolic derivative for the given expression with respect to the specified variable name.

**JMP Version Added:** Before version 14

```

Derivative( Sin( x ), x );


```

### [Design](#design)

**Syntax:** y = Design( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for each unique value of the argument. Use the levelsList argument to specify a list of the levels for the design matrix. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design( exLevels ) );
/* Also see DesignNom, DesignOrd */

/* example that Design(...) takes two arguments */
Show( Design( 3, {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design( exLevels, {1, 2, 3} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

/* example that Design(...) takes three arguments */
Show( Design( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Design Last](#design-last)

**Syntax:** y = Design Last( v, < levelsList, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for all but the last of the unique values of the argument. The last level is coded as a row of 0s. If the levelsList argument is specified, the last level is the last level in levelsList. Otherwise, the last level is defined as the largest value in v. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design Last(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design Last( exLevels ) );
/* see what is different from Design(...) */
Show( Design( exLevels ) );

/* Also see Design, DesignOrd */

/* example that Design Last(...) takes two arguments */
Show( Design Last( 3, {1, 2, 3} ) );
Show( Design( 3, {1, 2, 3} ) );
Show( Design Last( [1 2], {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design Last( exLevels, {1, 2, 3} ) );
Show( Design( exLevels, {1, 2, 3} ) );
Show( Design Last( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

/* example that Design Last(...) takes three arguments */
Show( Design Last( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design Last( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Design Nom](#design-nom)

**Syntax:** y = Design Nom( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for all but the last of the unique values of the argument. The last level is coded as a row of -1s. If the levelsList argument is specified, the last level is the last level in levelsList. Otherwise, the last level is defined as the largest value in v. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design Nom(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design Nom( exLevels ) );
/* see what is different from Design(...) */
Show( Design( exLevels ) );

/* Also see Design, DesignOrd */

/* example that Design Nom(...) takes two arguments */
Show( Design Nom( 3, {1, 2, 3} ) );
Show( Design( 3, {1, 2, 3} ) );
Show( Design Nom( [1 2], {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design Nom( exLevels, {1, 2, 3} ) );
Show( Design( exLevels, {1, 2, 3} ) );
Show( Design Nom( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

 /* example that Design Nom(...) takes three arguments */
Show( Design Nom( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design Nom( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Design Ord](#design-ord)

**Syntax:** y = Design Ord( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column for all but the last of the unique values of the argument. The first level is coded as a row of 0s. Each subsequent (nth) level in the levelsList argument is coded as a row of (n-1) 1s and the rest 0s. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design Ord(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design Ord( exLevels ) );
/* see what is different from Design Nom(...) */
Show( Design Nom( exLevels ) );

/* Also see Design, Design Nom */

/* example that Design Ord(...) takes two arguments */
Show( Design Ord( 3, {1, 2, 3} ) );
Show( Design Nom( 3, {1, 2, 3} ) );
Show( Design Ord( [1 2], {1, 2, 3} ) );
Show( Design Nom( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design Ord( exLevels, {1, 2, 3} ) );
Show( Design Nom( exLevels, {1, 2, 3} ) );
Show( Design Ord( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design Nom( {"a", "b"}, {"a", "b", "c"} ) );

/* example that Design Ord(...) takes three arguments */
Show( Design Ord( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design Ord( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [DesignF](#designf)

**Syntax:** y = DesignF( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for all but the last of the unique values of the argument. The last level is coded as a row of -1s. If the levelsList argument is specified, the last level is the last level in levelsList. Otherwise, the last level is defined as the largest value in v. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that DesignF(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( DesignF( exLevels ) );
/* see what is different from Design(...) */
Show( Design( exLevels ) );

/* Also see Design, DesignOrd */

/* example that DesignF(...) takes two arguments */
Show( DesignF( 3, {1, 2, 3} ) );
Show( Design( 3, {1, 2, 3} ) );
Show( DesignF( [1 2], {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( DesignF( exLevels, {1, 2, 3} ) );
Show( Design( exLevels, {1, 2, 3} ) );
Show( DesignF( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

/* example that DesignF(...) takes three arguments */
Show( DesignF( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( DesignF( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Desirability](#desirability)

**Syntax:** des = Desirability( yVector, dVector, y )

**Description:** Returns a desirability curve, where yVector is a vector of 3 input values, dVector is the corresponding 3 desirability values, and y is the argument of which to calculate the desirability.

**JMP Version Added:** Before version 14

```

dvec = [0.1 0.9 0.1];
yvec = [1 5 10];
New Window( "Desirability",
    Graph Box(
        X Scale( 0, 12 ),
        Y Scale( 0, 1 ),
        Frame Size( 500, 400 ),
        Drag Marker( yvec, dvec );
        Y Function( Desirability( yvec, dvec, x ), x );
    )
);


```

### [Det](#det)

**Syntax:** y = Det( x )

**Description:** Returns the determinant of a square matrix.

**JMP Version Added:** Before version 14

```

Det( [11 22, 33 44] );


```

### [Diag](#diag)

**Syntax:** y = Diag( matrix ); y = Diag( vector ); y = Diag( matrix1, matrix )

**Description:** Constructs a diagonal matrix from either a matrix or a vector. If two arguments are specified, the function returns the concatenation of the matrices diagonally.

**JMP Version Added:** Before version 14

```

Diag( [11 22] );


```

### [Dialog](#dialog)

**Syntax:** y = Dialog( specification )

**Description:** Prompts the user with a modal window. This function is deprecated. Please use the New Window function with the \<<Modal argument.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Dialog equivalent
If(
    ex = New Window( "Dialog() example",
        <<Modal,
        <<Return Result,
        V List Box(
            H List Box( "Set this value", variable = Number Edit Box( 42 ) ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    );
    ex["button"] == 1;
,
    ex["variable"],
    "CANCEL"
);


```

**Example 2**

```

// Deprecated
If(
    ex = Dialog(
        Title( " Dialog() example" ),
        vlist(
            hlist( "Set this value", variable = EditNumber( 42 ) ),
            hlist( Button( "OK" ), Button( "Cancel" ) )
        )
    );
    ex["button"] == 1;
,
    ex["variable"],
    "CANCEL"
);


```

### [Dif](#dif)

**Syntax:** y = Dif( x, \<n=1> )

**Description:** Returns x - Lag( x, n ), also known as the "first difference". Being dependent on Row(), Dif() is mainly useful in column formulas.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 3;
Dif( :height, 2 );


```

### [Digamma](#digamma)

**Syntax:** y = Digamma( x )

**Description:** Returns the digamma function evaluated at x, where the digamma function is the derivative of the logarithm of the gamma function.

**JMP Version Added:** Before version 14

```

Digamma( 5 );


```

### [Dim](#dim)

**Syntax:** y = Dim(); y = Dim( dt ); y = Dim( matrix )

**Description:** Returns a row vector with the dimensions of the current data table, a specified data table, or a matrix. The dimensions are the number of rows and the number of columns and are listed in that order.

**JMP Version Added:** 14

```

Dim( [11 22, 33 44, 55 66] );


```

### [Direct Product](#direct-product)

**Syntax:** y = Direct Product( A, B )

**Description:** Returns the direct or Kronecker product. Result has A[i,j]\*B, expanding to all possible products.

**JMP Version Added:** Before version 14

```

exA = [1 2, 3 4];
exB = [1 1 1, 2 2 2, 3 3 3];
exProd = Direct Product( exA, exB );
Show( exProd );

/* verify results */
Show( exProd[1 :: 3, 1 :: 3] == exB );
Show( exProd[4 :: 6, 1 :: 3] == (exB * 3) );
Show( exProd[1 :: 3, 4 :: 6] == (exB * 2) );
Show( exProd[4 :: 6, 4 :: 6] == (exB * 4) );

/* Also see H Direct Product */


```

### [Directory Exists](#directory-exists)

**Syntax:** rc = Directory Exists( path )

**Description:** Determine whether the directory exists. Returns 1 if the path exists. Returns 0 if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

If( Directory Exists( "$SAMPLE_DATA/Loss Function Templates" ),
    "ok",
    "missing!"
);


```

### [Disable JMP Live URL](#disable-jmp-live-url)

**Syntax:** Disable JMP Live URL(url)

**Description:** Disables a JMP Live URL. This method is available only during jmpStartAdmin.jsl. An asterisk * can be used a wildcard to specify URLs as * (any URL), *.jmp.com (a URL ending in .jmp.com), http://public.* (a URL starting with http://public.), or *public* (a URL that contains public).

**JMP Version Added:** 15

```


Disable JMP Live URL( "*public.jmp.com" );


```

### [Disable Proxy Settings](#disable-proxy-settings)

**Syntax:** Disable Proxy Settings( 1|0 )

**Description:** Disables or enables proxy settings during jmpStartAdmin.jsl execution. Proxy settings are enabled by default.

**JMP Version Added:** 15

```


Disable Proxy Settings( 1 );


```

### [Distance](#distance)

**Syntax:** y = Distance( x1, x2, <scales>, <powers> )

**Description:** Produces a matrix of distances between rows of x1 and rows of x2. To customize the scaling and powers for each column, specify the extra arguments scale and powers. For Kriging, Exp(-distance(x1,x2)) is used.

**JMP Version Added:** Before version 14

```

/*1-D example*/
exX1 = [1, 2, 3, 4];
exX2 = [2, 4, 6, 8]; 
/*Compute squared Euclidean distance*/
exD = Distance( exX1, exX2 ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum( (exX1[exi, 0] - exX2[exj, 0]) ^ 2 )
    )
);
Show( exDm == exD ); 

/*2-D example*/
exX1 = [1 1, 2 2, 3 3, 4 4];
exX2 = [2 1, 4 2, 6 0, 8 7]; 
/*Compute squared Euclidean distance*/
exD = Distance( exX1, exX2 ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum( (exX1[exi, 0] - exX2[exj, 0]) ^ 2 )
    )
);
Show( exDm == exD ); 

/*2-D example*/
exX1 = [1 1, 2 2, 3 3, 4 4];
exX2 = [2 1, 4 2, 6 0, 8 7]; 
/*Compute squared Euclidean distance, with a scaler [0.5 2.0]*/
exD = Distance( exX1, exX2, [0.5 2.0] ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum( [0.5 2.0] :* (Abs( exX1[exi, 0] - exX2[exj, 0] ) ^ 2) )
    )
);
Show( exDm == exD ); 

/*2-D example*/
exX1 = [1 1, 2 2, 3 3, 4 4];
exX2 = [2 1, 4 2, 6 0, 8 7]; 
/*Compute squared Euclidean distance, with scalers [0.5 2.0] and powers [1.5 2.0]*/
exD = Distance( exX1, exX2, [0.5 2.0], [1.5 2.0] ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum(
            [0.5 2.0] :* (Abs( exX1[exi, 0] - exX2[exj, 0] ) :^ [1.5 2.0])
        )
    )
);
Show( exDm == exD );


```

### [Divide](#divide)

**Syntax:** y = x0 / x1; y = Divide( x0, <x1>, ... )

**Description:** Divides all subsequent arguments from the first argument. Arguments can be numbers, matrices, or lists of numbers. When called with only one argument, the result will be the reciprocal.

**JMP Version Added:** Before version 14

**Reciprocal**

```

x = Divide( 5 );
y = 1 / 5;
Show( x, y );


```

**Simple**

```

6 / 3 / 2;


```

### [Divide To](#divide-to)

**Syntax:** y /= x; Divide To( y, x )

**Description:** Divides a value into a variable or into a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex /= 2;
ex;


```

### [Double Declining Balance](#double-declining-balance)

**Syntax:** x = Double Declining Balance( cost, salvage, life, period, \<factor=2> )

**Description:** Returns the depreciation of an asset for a specified period using the double-declining balance method or some other depreciation factor. Equivalent to the DDB function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Double Declining Balance( 10000, 100, 3, 2 );


```

### [Drag Line](#drag-line)

**Syntax:** Drag Line( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws a polyline at the indicated points. Unlike Line though, the points can be dragged across the screen, updating the values in the (LValue) matrix arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Line( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Marker](#drag-marker)

**Syntax:** Drag Marker( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws movable markers at the indicated points. The matrix values are updated as the markers are moved.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Marker( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Polygon](#drag-polygon)

**Syntax:** Drag Polygon( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws a filled polygon at the indicated points. The points can be dragged across the screen, updating the values in the (LValue) matrix arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Polygon( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Rect](#drag-rect)

**Syntax:** Drag Rect( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws a rectangle at the indicated points. Unlike Rect though, these corners can be dragged across the screen, updating the values in the (LValue) matrix arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33];
    exy = [88 22];,
    Graph Box(
        Drag Rect( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Text](#drag-text)

**Syntax:** Drag Text( xMatrixName, yMatrixName, text, <dragScript>, <MouseUpScript> )

**Description:** Draws the text at the indicated points. Unlike the Text() function, however, the points can be dragged across the screen, updating the values in the xMatrixName and yMatrixName matrix arguments. The text argument can be a string argument or a list of strings.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Text( exx, exy, "hello" );
        Line( exx, exy );
    )
);


```

### [Dunnett P value](#dunnett-p-value)

**Syntax:** p = Dunnett P value( q, nTrt, dfe, \<lambdaVec = .> )

**Description:** Returns the p-value from Dunnett's multiple comparisons test, where q is the test statistic, nTrt is the number of treatments being compared to the control group, dfe is the error degrees of freedom (based on the total study sample), and the optional lambdaVec is a vector of parameters, which by default are set to 1/sqrt(2).

**JMP Version Added:** Before version 14

```

Dunnett P value( 1.67623, 3, 11 );


```

### [Dunnett Quantile](#dunnett-quantile)

**Syntax:** q = Dunnett Quantile( 1-alpha, nTrt, dfe, \<lambdaVec = .> )

**Description:** Returns the quantile needed in Dunnett's multiple comparisons test, where 1-alpha is the confidence level, nTrt is the number of treatments being compared to the control group, dfe is the error degrees of freedom (based on the total study sample), and the optional lambdaVec is a vector of parameters, which by default are set to 1/sqrt(2).

**JMP Version Added:** Before version 14

```

Dunnett Quantile( 0.95, 3, 11 );


```

### [e](#e)

**Syntax:** y = e()

**Description:** Returns the mathematical constant e, accurate to approximately 15 decimal digits: 2.7182818....

**JMP Version Added:** Before version 14

```

Round( e(), 10 );


```

### [E Div](#e-div)

**Syntax:** y = A :/ B; y = E Div( A, B )

**Description:** Returns an element-wise division of matrices.

**JMP Version Added:** Before version 14

```

[11 22 33] :/ [1 2 3];


```

### [E Max](#e-max)

**Syntax:** y = E Max( A, B )

**Description:** Returns a matrix that is the maximum of corresponding elements of its arguments.

**JMP Version Added:** 16

```

E Max( [1 22 33], [11 2 3] );


```

### [E Min](#e-min)

**Syntax:** y = E Min( A, B )

**Description:** Returns a matrix that is the minimum of corresponding elements of its arguments.

**JMP Version Added:** 16

```

E Min( [1 22 33], [11 2 3] );


```

### [E Mult](#e-mult)

**Syntax:** y = A :\* B; y = E Mult( A, B )

**Description:** Returns an element-wise multiplication of matrices.

**JMP Version Added:** Before version 14

```

[1 2 3] :* [11 22 33];


```

### [Eigen](#eigen)

**Syntax:** {M, E} = Eigen( X )

**Description:** Performs eigenvalue decomposition of symmetric matrix X. Returns list {M, E} such that E\*Diag(M)\*E\` = X.

**JMP Version Added:** Before version 14

```

X = [11 22, 22 33];
{M, E} = Eigen( X );
E * Diag( M ) * E`;


```

### [Eigen BLAS](#eigen-blas)

**Syntax:** z = Eigen BLAS( X, \<nvec = ncol> )

**JMP Version Added:** 17

```

X = [5 4 1 1, 4 5 1 1, 1 1 4 2, 1 1 2 4];
{M1, E1} = Eigen BLAS( X );


```

### [Empty](#empty)

**Syntax:** y = Empty()

**Description:** Returns an empty value. Used in formula editor for unspecified arguments.

**JMP Version Added:** Before version 14

```

Empty();


```

### [Enable JMP Live URL](#enable-jmp-live-url)

**Syntax:** Enable JMP Live URL(url)

**Description:** Enables a JMP Live URL. This method is available only during jmpStartAdmin.jsl. An asterisk * can be used a wildcard to specify URLs as * (any URL), *.jmp.com (a URL ending in .jmp.com), http://public.* (a URL starting with http://public.), or *public* (a URL that contains public).

**JMP Version Added:** 15

```


Enable JMP Live URL( "https://public.jmp.com" );


```

### [Enable Proxy Settings](#enable-proxy-settings)

**Syntax:** Enable Proxy Settings( 1|0 )

**Description:** Enables or disables proxy settings during jmpStartAdmin.jsl execution. Proxy settings are enabled by default.

**JMP Version Added:** 15

```


Enable Proxy Settings( 0 );


```

### [Encode URI](#encode-uri)

**Syntax:** Encode URI( value )

**Description:** Encode the string using URI encoding

**JMP Version Added:** 14

```


Encode URI( "Foo Bar" );


```

### [Encode64 Blob](#encode64-blob)

**Syntax:** s = Encode64 Blob( x )

**Description:** Encodes a blob into a printable string of base 64 text.

**JMP Version Added:** 14

```

Encode64 Blob( Char To Blob( "the quick brown fox" ) );


```

### [Encode64 Double](#encode64-double)

**Syntax:** s = Encode64 Double( x )

**Description:** Returns a Base64 string encoding of the floating point number.

**JMP Version Added:** Before version 14

```

Encode64 Double( -1.5831 );


```

### [Ends With](#ends-with)

**Syntax:** b = Ends With( s, sub )

**Description:** Returns 1 if s ends with sub, otherwise returns 0. The s and sub arguments can be both strings or both lists. Equivalent to Right( s, Length( sub )) == sub.

**JMP Version Added:** Before version 14

```

Ends With( "http://www.jmp.com", ".com" );


```

### [Equal](#equal)

**Syntax:** z = x == y == ...; z = Equal( x, y, ... )

**Description:** Returns 1 if each argument is equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 == 1;


```

### [Estimate Bartlett Factor Score](#estimate-bartlett-factor-score)

**Syntax:** {factorScores} = Estimate Bartlett Factor Score( dataRow , mvMeanVec, lvMeanVec, modSRAM, modARAM )

**Description:** Estimates factor scores, using Bartlett's method, from a structural equation model (SEM). The input arguments are a row vector of data, the model-implied means for the manifest variables, the model-implied means for the latent variables, the S RAM matrix from an SEM, and the A RAM matrix from an SEM. It returns a row vector with estimated factor scores based on the SEM.

**JMP Version Added:** 16

```

Estimate Bartlett Factor Score(
    [2 2 0],
    [2.085 2.76 1.56],
    [0],
    [1 0 0 0 0,
    0 0.684181992749 0 0 0,
    0 0 1.19686444665695 0 0,
    0 0 0 0.875198112795068 0,
    0 0 0 0 0.953592961124492],
    [0 0 0 0 0,
    2.085 0 0 0 1,
    2.76 0 0 0 0.61913203807175,
    1.56 0 0 0 0.710365935511608,
    0 0 0 0 0]
);


```

### [Estimate Factor Score](#estimate-factor-score)

**Syntax:** {factorScores} = Estimate Factor Score( dataRow , modImpVarCov, mvMeanVec, lvMeanVec )

**Description:** Estimates factor scores, using the regression method, from a structural equation model (SEM). The input arguments are a row vector of data, a model-implied variance-covariance matrix, a vector of model-implied manifest variable means, and a vector of model-implied latent variable means. It returns a row vector with estimated factor scores based on the SEM.

**JMP Version Added:** 15

```

Estimate Factor Score(
    [7 10 5 2 2 0],
    [1.66 0.45 0.58 -0.58 -0.44 -0.5 0.59 -0.58,
    0.45 1.22 0.44 -0.44 -0.33 -0.38 0.45 -0.44,
    0.58 0.44 1.88 -0.57 -0.43 -0.49 0.58 -0.57,
    -0.58 -0.44 -0.57 1.64 0.57 0.65 -0.58 0.76,
    -0.44 -0.33 -0.43 0.57 1.56 0.49 -0.44 0.57,
    -0.5 -0.38 -0.49 0.65 0.49 1.36 -0.5 0.65,
    0.59 0.45 0.58 -0.58 -0.44 -0.5 0.59 -0.58,
    -0.58 -0.44 -0.57 0.76 0.57 0.65 -0.58 0.76],
    [6.59, 8.81, 2.92, 2.09, 2.76, 1.56],
    [0, 0]
);


```

### [Eval](#eval)

**Syntax:** y = Eval( x )

**Description:** Evaluates the argument and returns the result.

**JMP Version Added:** Before version 14

```

Eval( Expr( 1 + 2 ) );


```

### [Eval Expr](#eval-expr)

**Syntax:** y = Eval Expr( x )

**Description:** Returns a copy of expression x with each Expr() clause within x replaced with its evaluated value.

**JMP Version Added:** Before version 14

```

Eval Expr( Length( Expr( "X" || Char( 12 ) ) ) );


```

### [Eval Insert](#eval-insert)

**Syntax:** y = Eval Insert( string, \<startChar="^">, \<endChar=startChar> )

**Description:** Looks for substrings enclosed by the startChar/endChar pair and replaces them with the evaluated expression within.

**JMP Version Added:** Before version 14

```

Eval Insert( "Today is ^As Date( Today())^" );


```

### [Eval Insert Into](#eval-insert-into)

**Syntax:** Eval Insert Into( l_string, \<startChar="^">, \<endChar=startChar> )

**Description:** Looks for substrings enclosed by the startChar/endChar pair and replaces them with the evaluated expression within, replacing l_string.

**JMP Version Added:** Before version 14

```

ex = "Today is ^As Date( Today())^";
Eval Insert Into( ex );
ex;


```

### [Eval List](#eval-list)

**Syntax:** y = Eval List( list )

**Description:** Returns a list where every item in the list has been evaluated.

**JMP Version Added:** Before version 14

**Example 1**

```

Eval List( {1 + 2, 3 + 4} );


```

**Example 2**

```

x = 5;
y = 10;
Eval List( {x, y} );


```

### [Excerpt Box](#excerpt-box)

**Syntax:** y = Excerpt Box( rptnum, lstSubscripts )

**Description:** Returns a display box containing the excerpt designated by the report held at number rptnum and the list of display subscripts lstSubscripts. The subscripts reflect the current state of the report, after previous excerpts have been removed.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [Excluded](#excluded)

**Syntax:** y = Excluded( <rs> ); Excluded( \<Row State( <r> )> ) = y

**Description:** Returns the excluded component of the specified row state value, 0 or 1. If the Excluded() function is used as an L-value, it changes the excluded state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Excluded State( 1 );
Excluded( Row State( 3 ) );
Row() = 3;
Excluded();


```

### [Excluded State](#excluded-state)

**Syntax:** rs = Excluded State( x )

**Description:** Returns a row state value with the excluded component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Excluded State( 1 );
Excluded( Row State( 3 ) );


```

### [Execute SQL](#execute-sql)

**Syntax:** dt = Execute SQL(databaseConnectionHandle|dataConnector, "SELECT ..."|"SQLFILE=..."|tableName, \<invisible(0|1)>, <outputTableName>, \<Batch Submit(0|1)> )

**Description:** Executes SQL against a database connection returned from Create Database Connection or a Data Connector. Enabling Batch Submit allows for receiving multiple results from multiple SQL statements, returning a list with the results (supporting drivers only).

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Execute SQL(
    databaseConnectionHandle,
    "SELECT HEIGHT, WEIGHT FROM Bigclass",
    "NewTable"
);


```

**Example 2**

```

dc = Data Connector Registry() << Get( "com.jmp.sql_server" );
dt = Execute SQL( dc, "SELECT HEIGHT, WEIGHT FROM Bigclass" );


```

**Example 3**

```

dc = Data Connector Registry() << Get( "com.jmp.sql_server" );
resultList = Execute SQL(
    dc,
    "SELECT HEIGHT, WEIGHT FROM Bigclass; SELECT AGE, WEIGHT FROM BigClass;",
    Batch Submit( 1 )
);


```

### [ExGaussian Density](#exgaussian-density)

**Syntax:** y = ExGaussian Density( x, location, scale, shape )

**Description:** Returns the density at x of an ExGaussian distribution.

**JMP Version Added:** 18

```

New Window( "Example: ExGaussian Density",
    y = Graph Box(
        Y Scale( 0, .2 ),
        X Scale( -2, 15 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( ExGaussian Density( x, 0, .5, .25 ), x );
    )
);


```

### [ExGaussian Distribution](#exgaussian-distribution)

**Syntax:** y = ExGaussian Distribution( x, location, scale, shape )

**Description:** Returns the probability that an ExGaussian distributed random variable is less than x.

**JMP Version Added:** 18

```

New Window( "Example: ExGaussian Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -2, 15 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( ExGaussian Distribution( x, 0, .5, .25 ), x );
    )
);


```

### [ExGaussian Quantile](#exgaussian-quantile)

**Syntax:** q = ExGaussian Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from an ExGaussian distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** 18

```

New Window( "Example: ExGaussian Quantile",
    Graph Box(
        Y Scale( -2, 15 ),
        X Scale( 0, 1 ),
        XName( "p" ),
        Pen Color( "red" );
        Y Function( ExGaussian Quantile( p, 0, .5, .25 ), p );
    )
);


```

### [Exit](#exit)

**Syntax:** Quit(\<"No Save">); Exit(\<"No Save">)

**Description:** Exits JMP.

**JMP Version Added:** Before version 14

```

If(
    New Window( "Exit() example",
        <<Type( "Modal" ),
        Text Box( "Shut down JMP?" ),
        H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
    )["Button"] == 1, /*OK==1*/Exit(), /*cancel==-1*/"Good choice."
);


```

### [Exp](#exp)

**Syntax:** y = Exp( \<x=1> )

**Description:** Returns e raised to the x power. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Round( Exp( 1 ), 5 );


```

### [Exp Density](#exp-density)

**Syntax:** y = Exp Density( x, \<theta=1> )

**Description:** Returns the density at x of an exponential distribution with parameter theta.

**JMP Version Added:** 14

```

New Window( "Example: Exp Density",
    y = Graph Box(
        Y Scale( 0, 0.45 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exp Density( x, 2 ), x );
    )
);


```

### [Exp Distribution](#exp-distribution)

**Syntax:** p = Exp Distribution( x, \<theta=1> )

**Description:** Returns the probability that an exponentially distributed random variable is less than x.

**JMP Version Added:** 14

```

New Window( "Example: Exp Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exp Distribution( x, 2 ), x );
    )
);


```

### [Exp Quantile](#exp-quantile)

**Syntax:** q = Exp Quantile( p, \<theta=1> )

**Description:** Returns the quantile from an exponential distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** 14

```

New Window( "Example: Exp Quantile",
    y = Graph Box(
        Y Scale( 0, 4 ),
        X Scale( 0, 1 ),
        Pen Color( "red" );
        Y Function( Exp Quantile( qq, 2 ), qq );
    )
);


```

### [ExpM1](#expm1)

**Syntax:** y = ExpM1( x )

**Description:** Returns a more accurate calculation of Exp(x)-1 when x is very small.

**JMP Version Added:** Before version 14

```

Show( ExpM1( 1.1e-18 ), Exp( 1.1e-18 ) - 1 );


```

### [Exponential Density](#exponential-density)

**Syntax:** y = Exponential Density( x, \<theta=1> )

**Description:** Returns the density at x of an exponential distribution with parameter theta.

**JMP Version Added:** 17

```

New Window( "Example: Exponential Density",
    y = Graph Box(
        Y Scale( 0, 0.45 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exponential Density( x, 2 ), x );
    )
);


```

### [Exponential Distribution](#exponential-distribution)

**Syntax:** p = Exponential Distribution( x, \<theta=1> )

**Description:** Returns the probability that an exponentially distributed random variable is less than x.

**JMP Version Added:** 17

```

New Window( "Example: Exponential Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exponential Distribution( x, 2 ), x );
    )
);


```

### [Exponential Quantile](#exponential-quantile)

**Syntax:** q = Exponential Quantile( p, \<theta=1> )

**Description:** Returns the quantile from an exponential distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** 17

```

New Window( "Example: Exponential Quantile",
    y = Graph Box(
        Y Scale( 0, 4 ),
        X Scale( 0, 1 ),
        Pen Color( "red" );
        Y Function( Exponential Quantile( qq, 2 ), qq );
    )
);


```

### [Expr](#expr)

**Syntax:** y = Expr( x )

**Description:** Returns its argument unevaluated. Used to quote expressions.

**JMP Version Added:** Before version 14

```

Expr( x + y );


```

### [Expr As Picture](#expr-as-picture)

**Syntax:** y = Expr As Picture( expr( ... ), <width in pixels>, \<Max Matrix Size( dim )> )

**Description:** Returns an image containing the specified expression as a formula picture. The default width is 600 pixels and the default max matrix size is 100.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 1 ), spacing( 10 ),
        Text Box( "Quadratic Formula" ),
        Border Box( Left( 10 ), Right( 10 ), bottom( 10 ), top( 10 ), sides( 15 ),
            Expr As Picture( Expr( (-b + Sqrt( b ^ 2 - 4 * a * c )) / (2 * a) ) )
        )
    )
);


```

### [Extract Expr](#extract-expr)

**Syntax:** y = Extract Expr( expr, pattern )

**Description:** Returns a subexpression matching the specified pattern.

**JMP Version Added:** Before version 14

```

Extract Expr( a + b * c, Wild() * Wild() );


```

### [F Density](#f-density)

**Syntax:** y = F Density( q, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the density at q of an F distribution with dfn and dfd degrees of freedom.

**JMP Version Added:** Before version 14

```

fdedfn = 2;
fdedfd = 2;
New Window( "Example: F Density",
    fdey = Graph Box(
        Y Scale( 0, 0.8 ),
        X Scale( 0, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Density( fdeq, fdedfn, fdedfd ), fdeq );
        Text( {2.5, 0.7}, "dfn=", Round( fdedfn, 2 ), " dfd=", Round( fdedfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, fdedfn, fdey << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 10, fdedfd, fdey << reshow ) )
);


```

### [F Distribution](#f-distribution)

**Syntax:** y = F Distribution( q, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the probability that an F distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

fdidfn = 5;
fdidfd = 5;
New Window( "Example: F Distribution",
    fdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Distribution( fdiq, fdidfn, fdidfd ), fdiq );
        Text( {0.5, 0.9}, "dfn=", Round( fdidfn, 2 ), " dfd=", Round( fdidfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 0.5, 10, fdidfn, fdiy << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 0.5, 10, fdidfd, fdiy << reshow ) )
);


```

### [F Log CDistribution](#f-log-cdistribution)

**Syntax:** y = F Log CDistribution( x, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the log of 1 - F Distribution.

**JMP Version Added:** Before version 14

```

flcddfn = 5;
flcddfd = 5;
New Window( "Example: F Log CDistribution",
    flcdy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Log CDistribution( flcdq, flcddfn, flcddfd ), flcdq );
        Text( {0.5, -0.9}, "dfn=", Round( flcddfn, 2 ), " dfd=", Round( flcddfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, flcddfn, flcdy << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 30, flcddfd, flcdy << reshow ) )
);


```

### [F Log Density](#f-log-density)

**Syntax:** y = F Log Density( x, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the log of the F probability density.

**JMP Version Added:** Before version 14

```

fldedfn = 1;
fldedfd = 1;
New Window( "Example: F Log Density",
    fldey = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Log Density( fldeq, fldedfn, fldedfd ), fldeq );
        Text( {2.5, -0.7}, "dfn=", Round( fldedfn, 2 ), " dfd=", Round( fldedfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, fldedfn, fldey << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 10, fldedfd, fldey << reshow ) )
);


```

### [F Log Distribution](#f-log-distribution)

**Syntax:** y = F Log Distribution( x, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the log of the F distribution.

**JMP Version Added:** Before version 14

```

flddfn = 5;
flddfd = 5;
New Window( "Example: F Log Distribution",
    fldy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Log Distribution( fldq, flddfn, flddfd ), fldq );
        Text( {0.5, -0.9}, "dfn=", Round( flddfn, 2 ), " dfd=", Round( flddfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, flddfn, fldy << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 30, flddfd, fldy << reshow ) )
);


```

### [F Noncentrality](#f-noncentrality)

**Syntax:** nc = F Noncentrality( x, dfnum, dfden, prob )

**Description:** Solves for the noncentrality parameter nc such that prob = F Distribution( x, ndf, ddf, nc ).

**JMP Version Added:** Before version 14

```

New Window( "Example: F Noncentrality",
    fncgr = Graph Box(
        Y Scale( 0.01, 0.99 ),
        X Scale( 0.01, 0.99 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Noncentrality( 3, 2, 5, F Distribution( 3, 2, 5, q ) ), q );
    )
);
F Noncentrality( 3, 2, 5, F Distribution( 3, 2, 5, 0.4 ) );


```

### [F Power](#f-power)

**Syntax:** p = F Power( alpha, dfh, dfm, d, n )

**Description:** Calculates the power of an F Test, where alpha is the significance level, dfh is the hypothesis degrees of freedom, dfm is the degrees of freedom in the whole model, d is the squared effect size, SSH/(n\*sigma^2) where SSH is the sum of squares for the hypothesis, and n is the total number of observations. Note that for the ANOVA model, d = Sum(a[i]^2)/(k * sigma^2) where a[i] are effects and k is the number of means.

**JMP Version Added:** Before version 14

```

alpha = 0.05;
obs = 25;
dfh = 5;
dfm = 5;
d = 1;
New Window( "Example: F Power (alpha=.05,dfh=5,dfm=5)",
    fpdigr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( 0, 1 ),
        YName( "Power" ),
        XName( "d" ),
        Pen Color( "red" );
        Y Function( F Power( alpha, dfh, dfm, d, obs ), d );
        Text( {0.75, 0.1}, "obs=", Round( obs ) );
    ),
    H List Box( Text Box( "obs" ), Slider Box( 10, 100, obs, fpdigr << reshow ) )
);


```

### [F Quantile](#f-quantile)

**Syntax:** q = F Quantile( p, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the quantile from an F distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

F Quantile( 0.7, 5, 3 );


```

### [F Sample Size](#f-sample-size)

**Syntax:** n = F Sample Size( alpha, dfh, dfm, d, power )

**Description:** Calculates the sample size, where alpha is the significance level, dfh is the hypothesis degrees of freedom, dfm is the degrees of freedom in the whole model, d is the squared effect size, SSH/(n\*sigma^2) where SSH is the sum of squares for the hypothesis, and power is the power desired. Note that for the ANOVA model, d = Sum(a[i]^2)/(k * sigma^2) where a[i] are effects and k is the number of means.

**JMP Version Added:** Before version 14

```

alpha = 0.05;
pow = 0.6;
dfh = 5;
dfm = 5;
d = 1;
New Window( "Example: F Sample Size (alpha=.05,dfh=5,dfm=5)",
    fpdigr = Graph Box(
        Y Scale( 0, 50 ),
        X Scale( 0.5, 5 ),
        YName( "Sample Size" ),
        XName( "d" ),
        Pen Color( "red" );
        Y Function( F Sample Size( alpha, dfh, dfm, d, pow ), d );
        Text( {0.75, 0.2}, "power=", Round( pow, 2 ) );
    ),
    H List Box( Text Box( "power" ), Slider Box( 0.2, 0.95, pow, fpdigr << reshow ) )
);


```

### [Factorial](#factorial)

**Syntax:** y = Factorial( x )

**Description:** Returns the factorial of x, which is the same as Gamma( x + 1 ). If x is an integer, the result is the product 1 * 2 * ... * x.

**JMP Version Added:** Before version 14

```

Factorial( 5 );


```

### [Faure Quasi Random Sequence](#faure-quasi-random-sequence)

**Syntax:** points = Faure Quasi Random Sequence(nDim, nRow)

**Description:** Generate a sequence of space filling quasi-random numbers using the Faure sequence.

**JMP Version Added:** Before version 14

```

A = Faure Quasi Random Sequence( 3, 100 );
As Table( A );
Scatterplot 3D( Y( :Col1, :Col2, :Col3 ) );


```

### [FDR Adjust](#fdr-adjust)

**Syntax:** y = FDR Adjust( matrix )

**Description:** Returns the false discovery rate adjustment for the specified p-values using the Benjamini-Hochberg method.

**JMP Version Added:** 19

```

FDR Adjust( [0.5, 0.2, 0.05, 0.01] );


```

### [FFT](#fft)

**Syntax:** ret = FFT( L, \<<inverse( 0 ), \<<multivariate( 0 ), \<<scale( 1.0 ) )

**Description:** Conducts Fast Fourier Transformation (FFT) on argument L, a required list consisting of real and imaginary parts of the data in matrix forms. If L consists of only one matrix, the matrix is considered to be the real part. If L consists of two matrices, the first is the real part, and the second is the imaginary part. The two matrices must have the same dimensions and must have more than one row. There are three optional arguments. The inverse argument determines whether to conduct inverse FFT. The multivariate argument determines whether to conduct spatial or multivariate FFT. The scale argument determines the constant by which the return values should be multiplied. Return value is a list of two matrices with the same dimensions as the first input argument.

**JMP Version Added:** Before version 14

```

FFT( {[1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3]} );
A = [1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3];
res = FFT( {A} );
res = FFT( {A}, <<Inverse( 1 ) );
res = FFT( {A}, <<multivariate( 1 ) );
res = FFT( FFT( {A} ), <<Inverse( 1 ), <<scale( 1 / 20 ) );
B = FFT( {A} );
FFT( B, <<Inverse( 1 ), <<scale( 1 / 20 ) );
Afun = Function( {},
    [1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3]
);
FFT( FFT( {Afun()} ), <<Inverse( 1 ), <<scale( 1 / 20 ) );
Afun = Function( {},
    {[1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3]}
);
FFT( FFT( Afun() ), <<Inverse( 1 ), <<scale( 1 / 20 ) );
A = [1 3, 2 4, 3 1, 4 3, 4 5, 5 2, 5 7, 6 9, 7 5, 7 3, 2 7, 3 4, 6 7, 6 4, 2 7, 2 4, 2 6, 3 5,
3 6, 3 1];
res = FFT( {A} );
res = FFT( {A}, <<multivariate( 1 ) );
res = FFT( FFT( {A} ), <<Inverse( 1 ), <<scale( 1 / 40 ) );
res = FFT(
    FFT( {A}, <<multivariate( 1 ) ),
    <<multivariate( 1 ),
    <<Inverse( 1 ),
    <<scale( 1 / 20 )
);
A = [1 3 1,
2 4 3,
3 1 2,
4 3 3,
4 5 9,
5 2 8,
5 7 6,
6 9 5,
7 5 3,
7 3 2,
2 7 1,
3 4 3,
6 7 3,
6 4 2,
2 7 4,
2 4 1,
2 6 5,
3 5 1,
3 6 2,
3 1 9];
res = FFT( {A} );
res = FFT( {A}, <<multivariate( 1 ) );
FFT( FFT( {A} ), <<Inverse( 1 ), <<scale( 1 / 60 ) );
fin = FFT(
    FFT( {A}, <<multivariate( 1 ) ),
    <<Inverse( 1 ),
    <<multivariate( 1 ),
    <<scale( 1 / 20 )
);
Show( fin );


```

### [File Exists](#file-exists)

**Syntax:** rc = File Exists( path )

**Description:** Determine whether the file exists. Returns 1 if the file path exists. Returns 0 if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

If( File Exists( "$SAMPLE_DATA/Big Class.jmp" ),
    "ok",
    "missing!"
);


```

### [File Size](#file-size)

**Syntax:** size = File Size( path )

**Description:** Returns the size of the file at the given path. Returns missing when file path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

File Size( "$SAMPLE_DATA/Big Class.jmp" );


```

### [Files In Directory](#files-in-directory)

**Syntax:** y = Files In Directory( "path", \<recursive(0|1)>, \<include hidden(0|1)> )

**Description:** Returns the list of file names in a directory that is specified by path. If the Recursive argument is not specified, directory names are included in the list.

**JMP Version Added:** Before version 14

**Example 1**

```

Files In Directory( "$HOME" );


```

**Example 2**

```

Filter Each( {fn}, Files In Directory( "$SAMPLE_DATA", recursive( 1 ) ),
    Contains( Lowercase( fn ), "stacked" )
);


```

### [Fill Color](#fill-color)

**Syntax:** Fill Color( \<name|index|rgbList> )

**Description:** Sets the color for drawing filled areas.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( {1, 1, .5} );
        Polygon( [10 30 90], [88 22 44] );
    )
);


```

### [Fill Pattern](#fill-pattern)

**Syntax:** Fill Pattern( name|mask|image )

**Description:** Sets the pattern for drawing filled areas. A mask is a matrix of values between 0 and 1 to be applied to the current fill color.

**JMP Version Added:** Before version 14

**Image**

```


image = New Image( "$SAMPLE_IMAGES/pi.gif" );
New Window( "Example",
    Graph Box(
        Fill Pattern( image );
        Polygon( [10 30 90], [88 22 44] );
    )
);


```

**Mask**

```

New Window( "Example",
    Graph Box(
        Fill Pattern( [1 0.5 0 0, 0.5 0 0 1, 0 0 1 0.5, 0 1 0.5 0] );
        Polygon( [10 30 90], [88 22 44] );
    )
);


```

### [Filter Col Selector](#filter-col-selector)

**Syntax:** y = Filter Col Selector(\<Data Table(name)>, \<width(pixels)>, \<nlines(n)>, <script>, \<onchange(expr)>)

**Description:** Returns a display box that contains a list of items. Control allows column filtering.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example", fontobj = lb = Filter Col Selector( width( 250 ) ) );


```

### [Filter Each](#filter-each)

**Syntax:** list = Filter Each({<value>, <index>} | {<element>, \<index | {row, col}>} | {\<key | {key, value}>, <index>} | {\<values | {value1, ..., valueN}>, <index>}, list | matrix | associative array | expression | Across( container1, ..., <containerN>, \<Count( "Longest" | "Shortest" | "Enforce Equal" | n )> ), <locals list>, body)

**Description:** Does everything that the For Each function does, but also returns a list of filtered values from the original container based on a boolean value result. The type of the result will match the type of the input container. For Matrix input, a row vector matrix will be returned, since the size of the matrix cannot be known.

**JMP Version Added:** 16

**Associative Array**

```

values = Filter Each( {{key, value}}, ["A" => 8, "B" => 6, "C" => 10], value > 6 );
Show( values );


```

**Expression**

```

values = Filter Each( {value}, Expr( MyExpr( 1, 2, 3, 4 ) ), Mod( value, 2 ) == 0 );
Show( values );


```

**List**

```

values = Filter Each( {x}, {0, -5, 2, -10, 4}, x > 0 );
Show( values );


```

**Matrix**

```

values = Filter Each( {x, i}, 100 :: 120, i > 10 );
Show( values );


```

### [Find All](#find-all)

**Syntax:** Find All( \<Project(title|index|box|window)>, Data Tables | Reports | Journals, \<invisible | private> )

**Description:** Finds all open resources of a specific type: data tables, journals, or reports.

Only windows in the current project (or no project if not running the script in a project) will be included. To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** 14

```


exdt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
exdt2 = Open( "$SAMPLE_DATA/Animals.jmp" );
windows = Find All( Data Tables );
For( i = 1, i <= N Items( windows ), i++,
    Write( Char( windows[i] << Get Window Title ) || "\!N" )
);


```

### [First](#first)

**Syntax:** y = First( x1, x2, ... )

**Description:** Evaluates each argument and returns the value of the first argument.

**JMP Version Added:** Before version 14

```

First( 11, 22 );


```

### [Fit Censored](#fit-censored)

**Syntax:** result = FitCensored( Distribution(name), YLow(vector) | Y(vector), \<YHigh(vector)>, \<Weight(vector)>, \<X(matrix)>, \<Z(matrix)>, \<HoldParm(vector)>, \<Use random sample to compute initial values(percent)>, \<Use first N observations to compute initial values(nobs)> )

**Description:** Fits a distribution using censored data. The required arguments are Distribution and either YLow or Y. The function returns a list that contains parameter estimates, covariance matrix, log-likelihood, AICc, BIC, and a convergence message. The X and Z arguments specify regression design matrices for location and scale, respectively. When the data vector is large, two optional arguments can be used to specify a sample to compute the initial values. You can specify a percent of the observations or the first nobs observations, but the total sample size must be greater than 100.

**JMP Version Added:** Before version 14

```

result = Fit Censored(
    Distribution( "Weibull" ),
    Y( [142, 156, 163, 198, 204, 205, 232, 239, 240, 261, 280, 296, 323, 344] )
);
Show( result );


```

### [Fit Circle](#fit-circle)

**Syntax:** {xCenter, yCenter, radius, sse} = Fit Circle( Xvec, Yvec )

**Description:** Fits the circle that best goes through three or more points that are defined by two vectors of coordinates. The result is a list that contains the X and Y coordinates of the center point of the circle, the length of the radius, and the sum of squared errors.

**JMP Version Added:** 14

```

x = [68, 77, 85, 88, 93, 93, 95, 98];
y = [1, 9, 18, 94, 35, 82, 40, 59];
result = Fit Circle( x, y );
New Window( "Fit Circle",
    Graph Box(
        X Scale( -50, 100 ),
        Y Scale( -20, 130 ),
        FrameSize( 300, 300 ),
        Marker( x, y );
        Circle( {result[1], result[2]}, result[3] );
    )
);


```

### [Fit Transform To Normal](#fit-transform-to-normal)

**Syntax:** result = Fit Transform To Normal( Distribution(name), Y(vector), \<Freq(vector)> )

**Description:** Fits a transformation to normality for a vector of data. This includes the Johnson Sl, Johnson Sb, Johnson Su, and GLog distributions. The function returns a list containing parameter estimates, covariance matrix, log-likelihood, AICc, a convergence message, and transformed values.

**JMP Version Added:** Before version 14

```

datavec = [-3.7975076, 0.48221038, -1.3082712, -1.860647, -6.9470789, -17.237024, -19.470857,
-6.1855986, 2.16525629, -30.990061];
freqvec = [1, 1, 1, 1, 1, 2, 2, 2, 2, 2];
As Table( datavec || freqvec );
Column( 1 ) << set name( "x" );
Column( 2 ) << set name( "freq vec" );
Distribution(
    Freq( :freq vec ),
    Continuous Distribution( Column( :x ), Fit Distribution( GLog ) )
);
results = Fit Transform To Normal( Distribution( "glog" ), Y( datavec ), freq( freqvec ) );
Show( results );


```

### [Floor](#floor)

**Syntax:** y = Floor( x )

**Description:** Returns the largest integer less than or equal to x. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Floor( 1.2 );


```

### [For](#for)

**Syntax:** For( initExpr, whileExpr, nextExpr, bodyExpr )

**Description:** Evaluates initExpr once and repeatedly evaluates whileExpr, bodyExpr, and nextExpr as long as whileExpr evaluates to a nonzero value.

**JMP Version Added:** Before version 14

```

s = "";
For( i = 1, i < 10, i++,
    s ||= " " || Char( i )
);
Trim( s );


```

### [For Each](#for-each)

**Syntax:** For Each({<value>, <index>} | {<element>, \<index | {row, col}>} | {\<key | {key, value}>, <index>} | {\<values | {value1, ..., valueN}>, <index>}, list | matrix | associative array | expression | Across( container1, ..., <containerN>, \<Count( "Longest" | "Shortest" | "Enforce Equal" | n )> ), <locals list>, body)

**Description:** Iterates over a container, either a list, matrix, associative array, or expression, providing the value, element, or key at each iteration. The index number is also available at each iteration. For Associative Array containers, the key and value can be accessed using a two-item list. For Matrix containers, a linear index is provided by default, but a two item list can be used to access the row and column indices. These symbols are provided within the body of the loop only, with a built-in Local block. A locals list can also be provided, which are initialized after the first iteration symbols are set.

**JMP Version Added:** 16

**Across**

```


// Across multiple containers
x = {1, 3};
y = {2, 4};
For Each( {{a, b}, index}, Across( x, y ), Show( a, b, index ) );

// Across list of containers
xy = {{1, 3}, {2, 4}};
For Each( {{a, b}, index}, Across( xy ), Show( a, b, index ) );


```

**Across - Count**

```


list1 = {1, 3, 5, 7, 9};
list2 = {2, 4}; 

Write( "\!N===Longest [default]===" );
For Each( {{l1, l2}}, Across( list1, list2, Count( "Longest" ) ), Show( l1, l2 ) );

Write( "\!N===Shortest===" );
For Each( {{s1, s2}}, Across( list1, list2, Count( "Shortest" ) ), Show( s1, s2 ) );

Write( "\!N===N===" );
For Each( {{n1, n2}}, Across( list1, list2, Count( 7 ) ), Show( n1, n2 ) );

Write( "\!N===Enforce Equal===" );
Try(
    For Each( {values}, Across( list1, list2, Count( "Enforce Equal" ) ), Show( values ) ),
    Print( "Error occurred" )
);


```

**Associative Array**

```

For Each( {{key, value}, index}, ["A" => 8, "B" => 6, "C" => 10], Show( key, value, index ) );


```

**Expression**

```

For Each( {value, index}, Expr( MyExpr( 10, 20, 30 ) ), Show( value ) );


```

**List**

```

For Each( {value, index}, {10, 20, 30}, Show( value, index ) );


```

**Matrix**

```

For Each( {element, {row, col}}, 10 :: 15, Show( element, row, col ) );


```

**Matrix - Linear Index**

```

For Each( {element, index}, 10 :: 15, Show( element, index ) );


```

### [For Each Row](#for-each-row)

**Syntax:** y = For Each Row( <dt>, body )

**Description:** Evaluates the body expression iteratively for each row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( :height = -:height );


```

### [Format](#format)

**Syntax:** s = Format( x, formatString, <options> ) s = Format( x, "Format Pattern", pattern, <options> )

**Description:** Returns the number in the specified format. Formats include items in the Column Info dialog, such as "Best" and "h:m:s". See Topic Help for other options, including p-value, currency, date and time, and geographic formats.

**JMP Version Added:** Before version 14

**Date Time**

```

Print( Format( Today(), "yyyyQq" ), Format( Today(), "m/d/y h:m" ) );


```

**Format Pattern**

```

Print( Format( Today(), "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm><:><ss>" ) );


```

**Full Precision**

```

Show( Format( 88.54, "Best" ), Format( 88.54, "Best", "Full Precision" ) );


```

**Percent, Currency**

```

pct = Format( 0.123, "Percent", 2 );
amt = Format( 123.4567, "Currency", "EUR", 2 );
result = "Revenue increase: " || amt || " or " || pct || ".";


```

### [Format Date](#format-date)

**Syntax:** s = Format( x, formatString, <options> ) s = Format( x, "Format Pattern", pattern, <options> )

**Description:** Returns the number in the specified format. Formats include items in the Column Info dialog, such as "Best" and "h:m:s". See Topic Help for other options, including p-value, currency, date and time, and geographic formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Print( Format( Today(), "yyyyQq" ), Format( Today(), "m/d/y h:m" ) );


```

**Example 2**

```

Print( Format( Today(), "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm><:><ss>" ) );


```

**Example 3**

```

pct = Format( 0.123, "Percent", 2 );
amt = Format( 123.4567, "Currency", "EUR", 2 );
result = "Revenue increase: " || amt || " or " || pct || ".";


```

### [Format Pattern](#format-pattern)

**Syntax:** s = Format( x, "Format Pattern", pattern, <width>, <dec>) x = In Format( s, "Format Pattern", pattern, < \<<Use Locale(b=1)> ) obj = Format("Format Pattern", pattern, <width>, <dec>)

**Description:** Format Patterns are strings that define a date-time format, such as " \<:>\<:>". The parts of the pattern in angle brackets are called field descriptors. The field descriptors represent a value (such as "", which is a four-digit year) or other date-time text (such as "", which is a locale-specific date separator). A format pattern enables you to build formats that aren't provided in JMP. These formats can be used for both formatting and inputting data.

**JMP Version Added:** 16

```

s = Format( Today(), "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm>" );
x = Informat( "2020/02/10 14:54", "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm>" );
Show( s, x );
                                                /*
Field Descriptors

Dates
(cannot be used with Duration field descriptors)
================================================================================
<YYYY>        Four-digit year. (Accepts 1-4 digits on input.)
<YY>          Two-digit year
<yyyy>        Four digit ISO year; corresponds to ISO weeks. (Accepts 1-4 digits
              on input.)
<yy>          Two digit ISO year; corresponds to ISO weeks.
<YYYY.>       Year with fractional year. Completely describes the date and time.
<M>           Month number (1..12)
<MM>          Month number, zero-padded (01..12)
<Month>       Long month name
<Mmm>         Abbreviated month name
<MMM>         "In-line" month name. Always three letters.
<WW1>         Two digit week number, zero-padded. Week 2 begins on first Sunday
              of year. Week 1 is partial week before first Sunday. (01..54)
<WW2>         Two digit week number, zero-padded. Week 1 begins on first Sunday
              of year. Week 0 is partial week before first Sunday. (00..53)
<ww>          Two digit ISO week number, zero-padded. Weeks begin on Monday.
              Week 1 is first week in that year with 4 or more days. There are
              no partial weeks, instead the first or last week can extend into
              the previous or next year, respectively. (01..53)
<D>           Day of the month (1..31)
<DD>          Day of the month, zero-padded (01..31)
<Q>           Quarter of the year (1..4)
<Q#>          "Q" followed by quarter of the year (1..4)
<DayOfWeek>   Name of the day of the week
<DW>          Day of week as a number. 1 = Sunday, 7 = Saturday
<dw>          Day of week as a number. 1 = Monday, 7 = Sunday
</>           The locale date separator. (Accepts most common separators on
              input.)
<->           The ISO date separator '-'. (Accepts most common separators on
              input.)
</?>          Optional date separator on the date input. The separator is never
              written on output.
<'T'>         The 'T' in ISO dates

Times
(some can be used with Duration field descriptors)
================================================================================
<hh>          Hour formatted according to the current locale. If a <ampm>
              descriptor is present, will use a 12 or 24 hour clock depending on
              locale. If a <AMPM> descriptor is present, will use a 12 hour
              clock. Otherwise, will use a 24 hour clock. (Cannot be used with
              duration field descriptors.)
<zhh>         Hour formatted according to the current locale and zero-padded. If
              a <ampm> descriptor is present, will use a 12 or 24 hour clock
              depending on locale. If a <AMPM> descriptor is present, will use a
              12 hour clock. Otherwise, will use a 24 hour clock. (Cannot be
              used with duration field descriptors.)
<hh24>        Hour in 24-hour format and zero-padded (00..23)
<mm>          Minute, zero-padded (00..59)
<ss>          Second, zero-padded (00..59)
<ampm>        AM/PM symbol for the current locale. (Cannot be used with duration
              field descriptors.)
<AMPM>        Locale-independent AM/PM symbol "AM" or "PM". (Cannot be used with
              duration field descriptors.)
<:>           The locale time separator.
<::>          The ISO time separator ':'. (Also accepts locale time separator on
              input.)
<:?>          Optional time separator on the date input. The separator is never
              written on output.

Durations
(cannot be used with Date field descriptors)
================================================================================
<Day>         Day count. Used as most significant field in durations. Cannot be
              used with any other "count".
<Hour>        Hour count. Used as most significant field in durations. Cannot be
              used with any other "count".
<Minute>      Minute count. Used as most significant field in durations. Cannot
              be used with any other "count".

Other
================================================================================
<<>           Replaced with a "<"
*/


```

### [Fourier Basis Coef](#fourier-basis-coef)

**Syntax:** coef = Fourier Basis Coef( x, Number Pairs, \<Period = max(x)-min(x)+1> )

**Description:** Returns the matrix of Fourier Basis coefficients. Number Pairs is the number of sin() and cos() pairs for the basis. Optional parameter Period specifies the period for the trigonometric functions and defaults to max(x) - min(x) + 1.

**JMP Version Added:** 14

```

Fourier Basis Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] / 10, 2 );
Fourier Basis Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] / 10, 2, 2 );


```

### [Frechet Density](#frechet-density)

**Syntax:** y = Frechet Density( x, mu, sigma )

**Description:** Returns the density at x of a Fréchet distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .5;
New Window( "Example: Frechet Density",
    y = Graph Box(
        Y Scale( 0, .06 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Frechet Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Frechet Distribution](#frechet-distribution)

**Syntax:** p = Frechet Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a Fréchet distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .5;
New Window( "Example: Frechet Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Frechet Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Frechet Quantile](#frechet-quantile)

**Syntax:** q = Frechet Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a Fréchet distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .5;
qq = .5;
New Window( "Example: Frechet Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Frechet Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Frechet Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Function](#function)

**Syntax:** y = Function( {arg1=val1, ...}, \<{local1=val1, ...}>, expr )

**Description:** Defines a function with the specified arguments, default values, and optional local variables. Arguments with default values are optional on invocation of the function. If Return() is used within the function's script, the expression within is returned.

**JMP Version Added:** Before version 14

**Example 1**

```

exsqr = Function( {x}, x * x );
exsqr( 5 );


```

**Example 2**

```

// y is an optional argument
exmul = Function( {x, y = 3}, x * y );
a = exmul( 5 );
b = exmul( 5, 10 );
Show( a, b );


```

**Example 3**

```

posorneg = Function( {x},
    {},
    If(
        x > 0, Return( "positive" ),
        x == 0, Return( "zero" ),
        Return( "negative" )
    )
);
posorneg( -5.5 );


```

### [Future Value](#future-value)

**Syntax:** x = Future Value( rate, nper, pmt, \<pv=0>, \<type=0> )

**Description:** Returns the future value of an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the FV function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Future Value( .03, 12, 100, 0, 1 );


```

### [G Inverse](#g-inverse)

**Syntax:** g = G Inverse( A )

**Description:** Returns the generalized (Moore-Penrose) matrix inverse.

**JMP Version Added:** Before version 14

```

Round( G Inverse( [11 22, 33 44] ), 2 );


```

### [Gamma](#gamma)

**Syntax:** y = Gamma( x, <limit> )

**Description:** Returns Gamma function of x, defined as the integral of z^(x-1)\*exp(-z) dz from 0 to ∞. If limit is present, an incomplete Gamma is computed using that limit of integration.

**JMP Version Added:** Before version 14

```

Gamma( 5 );


```

### [Gamma Density](#gamma-density)

**Syntax:** y = Gamma Density( q, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the density at q of a Gamma probability distribution, where the alpha shape parameter argument must be positive.

**JMP Version Added:** Before version 14

```

gdealpha = Log( 1.5 );
New Window( "Example: Gamma Density",
    gdey = Graph Box(
        Y Scale( 0, 0.5 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Density( gdeq, Exp( gdealpha ) ), gdeq );
        Text( {9, 0.45}, "\!U03B1=", Round( Exp( gdealpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gdealpha, gdey << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Distribution](#gamma-distribution)

**Syntax:** p = Gamma Distribution( q, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the probability that a Gamma distributed random variable is less than q, where the alpha shape parameter argument must be positive. IGamma() is an alias name to Gamma Distribution(). The Gamma Distribution() function is equivalent to Gamma(alpha,q)/Gamma(alpha).

**JMP Version Added:** Before version 14

```

gdialpha = Log( 1.5 );
New Window( "Example: Gamma Distribution",
    gdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Distribution( gdiq, Exp( gdialpha ) ), gdiq );
        Text( {1, 0.9}, "\!U03B1=", Round( Exp( gdialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gdialpha, gdiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Log CDistribution](#gamma-log-cdistribution)

**Syntax:** p = Gamma Log CDistribution( x, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the log of 1 - Gamma distribution.

**JMP Version Added:** Before version 14

```

glcdialpha = Log( 1.5 );
New Window( "Example: Gamma Log CDistribution",
    glcdiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Log CDistribution( glcdiq, Exp( glcdialpha ) ), glcdiq );
        Text( {1, -0.9}, "\!U03B1=", Round( Exp( glcdialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), glcdialpha, glcdiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Log Density](#gamma-log-density)

**Syntax:** y = Gamma Log Density( x, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the log of the Gamma probability density.

**JMP Version Added:** Before version 14

```

gldealpha = Log( 1.5 );
New Window( "Example: Gamma Log Density",
    gldey = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Log Density( gldeq, Exp( gldealpha ) ), gldeq );
        Text( {9, -0.45}, "\!U03B1=", Round( Exp( gldealpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gldealpha, gldey << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Log Distribution](#gamma-log-distribution)

**Syntax:** p = Gamma Log Distribution( x, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the log of the Gamma distribution.

**JMP Version Added:** Before version 14

```

gldialpha = Log( 1.5 );
New Window( "Example: Gamma Log Distribution",
    gldiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Log Distribution( gldiq, Exp( gldialpha ) ), gldiq );
        Text( {1, -0.9}, "\!U03B1=", Round( Exp( gldialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gldialpha, gldiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Poisson Distribution](#gamma-poisson-distribution)

**Syntax:** cumprob = Gamma Poisson Distribution( k, lambda, sigma )

**Description:** Returns the probability that a gamma Poisson distributed random variable is less than or equal to k, where lambda is the mean parameter, sigma is the overdispersion parameter, and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 20;
sigma = 2;
New Window( "Example: Gamma Poisson Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, Gamma Poisson Distribution( k, lambda, sigma ) );
            V Line(
                k + 1,
                Gamma Poisson Distribution( k, lambda, sigma ),
                Gamma Poisson Distribution( k + 1, lambda, sigma )
            );
        );
        Text( {2, 0.95}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {2, 0.87}, "\!U03C3=", Round( sigma, 2 ) );
    ),
    H List Box( Slider Box( 3, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 1, 5, sigma, ppy << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Gamma Poisson Probability](#gamma-poisson-probability)

**Syntax:** prob = Gamma Poisson Probability( k, lambda, sigma )

**Description:** Returns the probability that a gamma Poisson distributed random variable is equal to k, where lambda is the mean parameter, sigma is the overdispersion parameter, and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 5;
sigma = 2;
New Window( "Poisson and Gamma Poisson",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 20.5 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( x = 0, x <= 20, x++,
            Pen Color( "red" );
            V Line( x, 0, Poisson Probability( lambda, x ) );
            Pen Color( "blue" );
            V Line( x + 0.35, 0, Gamma Poisson Probability( x, lambda, sigma ) );
        );
        Text( {1, 0.25}, "\!U03BB=", Round( lambda, 8 ), " \!U03C3=", Round( sigma, 8 ) );
        Text( {0, 0.28}, "Red = Poisson, Blue = Gamma Poisson" );
    ),
    H List Box( Slider Box( 3, 10, lambda, clty << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 1, 5, sigma, clty << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Gamma Poisson Quantile](#gamma-poisson-quantile)

**Syntax:** q = Gamma Poisson Quantile( lambda, sigma, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Gamma Poisson( lambda, sigma ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qexpl = 20;
qexps = 2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: Gamma Poisson Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, Gamma Poisson Distribution( qexpk, qexpl, qexps ) );
            V Line(
                qexpk + 1,
                Gamma Poisson Distribution( qexpk, qexpl, qexps ),
                Gamma Poisson Distribution( qexpk + 1, qexpl, qexps )
            );
        );
        Pen Color( "blue" );
        V Line( Gamma Poisson Quantile( qexpl, qexps, qexpq ), 0, 1 );
        Text( {1, 0.9}, " \!U03BB=", Round( qexpl, 2 ), " \!U03C3=", Round( qexps, 2 ) );
        Text(
            {1, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( Gamma Poisson Quantile( qexpl, qexps, qexpq ) )
        );
    ),
    H List Box( Slider Box( 3, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 1, 5, qexps, qexpy << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [Gamma Quantile](#gamma-quantile)

**Syntax:** q = Gamma Quantile( p, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the quantile from a Gamma distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

Gamma Quantile( 0.75, 4 );


```

### [GenGamma Density](#gengamma-density)

**Syntax:** y = GenGamma Density( x, mu, sigma, lambda )

**Description:** Returns the density at x of an extended generalized gamma probability distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: GenGamma Density",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -5, 10 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GenGamma Density( y, mu, sigma, lambda ), y );
        Text( {-4, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-4, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [GenGamma Distribution](#gengamma-distribution)

**Syntax:** p = GenGamma Distribution( x, mu, sigma, lambda )

**Description:** Returns the probability that an extended generalized gamma distributed random variable (with parameters mu, sigma, and lambda) is less than x.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: GenGamma Distribution",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GenGamma Distribution( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [GenGamma Quantile](#gengamma-quantile)

**Syntax:** q = GenGamma Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from an extended generalized gamma distribution (with parameters mu, sigma, and lambda), the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
p = 0.4;
New Window( "Example: GenGamma Quantile",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GenGamma Distribution( x, mu, sigma, lambda ), x );
        Pen Color( "Blue" );
        V Line( GenGamma Quantile( p, mu, sigma, lambda ), 0, 1 );
        Text(
            {-9, 0.9},
            "\!U03BC=",
            Round( mu, 4 ),
            " \!U03C3=",
            Round( sigma, 4 ),
            " \!U03BB=",
            Round( lambda, 4 )
        );
        Text( {-9, 0.8}, "p=", Round( p, 3 ) );
        Text(
            {-9, 0.7},
            "quantile= ",
            Round( GenGamma Quantile( p, mu, sigma, lambda ), 2 )
        );
    ),
    H List Box( Slider Box( -2, 2, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) ),
    H List Box( Slider Box( 0.01, 0.99, p, gdey << reshow ), Text Box( " p" ) )
);


```

### [Get Addin](#get-addin)

**Syntax:** Get Addin( ID )

**Description:** Retrieves a registered add-in specified by its ID.

**JMP Version Added:** Before version 14

```

addin = Get Addin( "com.mycompany.myaddin" );


```

### [Get Addins](#get-addins)

**Syntax:** Get Addins( )

**Description:** Returns a list of all registered add-ins.

**JMP Version Added:** Before version 14

```

addins = Get Addins();
addin ids = Get Addins() << id;
Show( addins, addin ids );


```

### [Get Addr Info](#get-addr-info)

**Syntax:** Get Addr Info( string )

**Description:** Looks up the numeric address for a name. In most cases the name should be used for future IPV6 compatibility.

**JMP Version Added:** Before version 14

```

Get Addr Info( "www.jmp.com" )[3][4];


```

### [Get Class Names](#get-class-names)

**Syntax:** Get Class Names( < <class reference>, ... > )

**Description:** Returns a list of names of all currently defined classes.

**JMP Version Added:** 14

```

Define Class(
    "aa",
    {_init_ = Method( {} ), x = 1, m1 = Method( {a, b}, a * b )}
);
Define Class(
    "bb",
    {_init_ = Method( {} ), y = 1, m2 = Method( {a, b}, a / b )}
);
lcaa = New Object( aa() );
lcbb = New Object( bb() );
lcl = Get Class Names();
Show( lcl );
lcaa << Delete;
lcbb << Delete;
Delete Classes( "aa", "bb" );


```

### [Get Classes](#get-classes)

**Syntax:** Get Classes( < <class reference>, ... > )

**Description:** Returns a list of references to all currently defined classes

**JMP Version Added:** Before version 14

```

Define Class(
    "aa",
    {_init_ = Method( {} ), x = 1, m1 = Method( {a, b}, a * b )}
);
Define Class(
    "bb",
    {_init_ = Method( {} ), y = 1, m2 = Method( {a, b}, a / b )}
);
lcaa = New Object( aa() );
lcbb = New Object( bb() );
lcl = Get Classes();
Show( lcl );
Clear Symbols( lcl );
lcaa << Delete;
lcbb << Delete;
Delete Classes( "aa", "bb" );


```

### [Get Clipboard](#get-clipboard)

**Syntax:** Get Clipboard()

**Description:** Get the current contents of the clipboard

**JMP Version Added:** Before version 14

```

Get Clipboard();


```

### [Get Color Theme Detail](#get-color-theme-detail)

**Syntax:** script = Get Color Theme Detail(name)

**Description:** Returns the script for a given color theme name

**JMP Version Added:** Before version 14

```

Get Color Theme Detail( "JMP Default" );


```

### [Get Color Theme Names](#get-color-theme-names)

**Syntax:** {list of names} = Get Color Theme Names(<kind>)

**Description:** Returns a list of color theme strings which match the optional parameter kind. kind is one of the following: "continuous", "categorical", "sequential", "diverging", "qualitative", or "chromatic".

**JMP Version Added:** Before version 14

**Example 1**

```

Get Color Theme Names();


```

**Example 2**

```

Get Color Theme Names( "sequential" );


```

### [Get Custom Functions](#get-custom-functions)

**Syntax:** Get Custom Functions(\<{function 1 full name, function 2 full name, ...} | function full name>)

**Description:** Get a list of custom functions

**JMP Version Added:** 14

**Example 1**

```

Get Custom Functions();


```

**Example 2**

```

Get Custom Functions( {"custom:Add", "custom:Sub"} );


```

### [Get Data Table](#get-data-table)

**Syntax:** dt = Get Data Table( \<Project(title|index|box|window)>, name|index )

**Description:** Returns a reference to the specified data table.

The search is limited to tables in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Get Data Table( 1 );


```

### [Get Data Table List](#get-data-table-list)

**Syntax:** tableList = Get Data Table List( \<Project(title|index|box|window)> )

**Description:** Returns a list of all open data tables.

The list is limited to tables in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Get Data Table List();


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );
Get Data Table List( Project( project ) );


```

### [Get Default Directory](#get-default-directory)

**Syntax:** y = Get Default Directory()

**Description:** Returns the JMP default directory, which is used as a base for subsequent relative paths. This path is the directory containing the currently executing script if the script is saved.

**JMP Version Added:** Before version 14

```

Show( Get Default Directory() );
Set Default Directory( "$SAMPLE_DATA" );
Show( Get Default Directory() );


```

### [Get Environment Variable](#get-environment-variable)

**Syntax:** value = Get Environment Variable( string )

**Description:** Returns the value of the specified environment variable from the operating system.

NOTE: On the Macintosh operating system, the variable name is case-sensitive.

**JMP Version Added:** Before version 14

```

Get Environment Variable( "PATH" );


```

### [Get Excel Worksheets](#get-excel-worksheets)

**Syntax:** list = Get Excel Worksheets("filepath")

**Description:** Returns a list of worksheets within an Excel Workbook

**JMP Version Added:** Before version 14

```

sheetList = Get Excel Worksheets( "$SAMPLE_IMPORT_DATA\Team Results.xlsx" );
Show( sheetList );


```

### [Get File Search Path](#get-file-search-path)

**Syntax:** y = Get File Search Path()

**Description:** Returns the current list of directories to search for opening files.

**JMP Version Added:** Before version 14

```

Get File Search Path();


```

### [Get Locale Setting](#get-locale-setting)

**Syntax:** value = Get Locale Setting( settingName )

**Description:** Retrieves a locale setting such as decimal separator

**JMP Version Added:** 16

```

Get Locale Setting( "Decimal Separator" );


```

### [Get Log](#get-log)

**Syntax:** list = Get Log( <N> )

**Description:** Returns a list of lines from the log. If no argument is specified, all the lines from the log are returned. If the numeric argument N is positive, the first N lines from the log are returned. If N is negative, the last N lines from the log are returned. If N is zero, no lines are returned.

**JMP Version Added:** Before version 14

```

all contents = Get Log();
headcontents = Get Log( 10 );
tailcontents = Get Log( -5 );


```

### [Get Name Info](#get-name-info)

**Syntax:** Get Name Info( string )

**Description:** Looks up the name for a numeric address. In most cases the name should be used for future IPV6 compatibility.

**JMP Version Added:** Before version 14

```

Get Name Info( "149.173.5.120" )[3][4];


```

### [Get Namespace Names](#get-namespace-names)

**Syntax:** Get Namespace Names( < <namespace reference>, ... > )

**Description:** Returns a list of names of all currently defined namespaces.

**JMP Version Added:** 14

```

nsaa = New Namespace(
    "aa",
    {
        x = 1
    }
);
nsbb = New Namespace(
    "bb",
    {
        y = 1
    }
);
lns = Get Namespace Names();
Show( lns );
nsaa << Delete;
nsbb << Delete;


```

### [Get Namespaces](#get-namespaces)

**Syntax:** Get Namespaces( < <namespace reference>, ... > )

**Description:** Returns a list of references to all currently defined namespaces

**JMP Version Added:** Before version 14

```

nsaa = New Namespace(
    "aa",
    {
        x = 1
    }
);
nsbb = New Namespace(
    "bb",
    {
        y = 1
    }
);
lns = Get Namespaces();
Show( lns );
Clear Symbols( lns );
nsaa << Delete;
nsbb << Delete;


```

### [Get Notebook List](#get-notebook-list)

**Syntax:** notebookList = Get Notebook List()

**Description:** Returns a list of all open notebooks.

**JMP Version Added:** 19

### [Get OAuth2 Grant Types](#get-oauth2-grant-types)

**Syntax:** Get OAuth2 Grant Types

**Description:** Gets the supported JMP OAuth2 grant types.

**JMP Version Added:** 15

```


/*
https://oauth.net/2/grant-types/
*/
grant_types = Get OAuth2 Grant Types();
Show( grant_types );


```

### [Get OpenID Connect Discovery](#get-openid-connect-discovery)

**JMP Version Added:** 15

```


url = "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration";
aa = Get OpenID Connect Discovery( url );
Show( aa );


```

### [Get OpenIDC Discovery](#get-openidc-discovery)

**JMP Version Added:** 15

### [Get Path Variable](#get-path-variable)

**Syntax:** value = Get Path Variable( name )

**Description:** Returns the value of a path variable, which is a name like SAMPLE_DATA that is substituted for when found in pathnames.

**JMP Version Added:** Before version 14

**Example 1**

```

Get Path Variable( "SAMPLE_DATA" );
/* try: SAMPLE_DATA, SAMPLE_IMPORT_DATA, SAMPLE_SCRIPTS
See full listing of Path Variables in the other example
See also Convert File Path() and Set Path Variable() */


```

**Listing**

```

// Run for a Path Variable listing
path vars = {"SAMPLE_DATA", "DESKTOP", "DOCUMENTS", "DOWNLOADS", "TEMP", "HOME",
"USER_APPDATA", "ALL_HOME", "BUILTIN_SCRIPTS", "SAMPLE_APPS", "SAMPLE_DASHBOARDS",
"SAMPLE_IMAGES", "SAMPLE_IMPORT_DATA", "SAMPLE_PROJECTS", "SAMPLE_SCRIPTS"};
path vars ||= Transform Each( {id}, Get Addins() << ID, Eval Insert( "ADDIN_HOME(^id^)" ) );
path vars = Filter Each( {var}, path vars, Directory Exists( Get Path Variable( var ) ) );

New Window( "Path Variables",
    <<Type( "Dialog" ),
    Outline Box( "Path Variables",
        H List Box(
            Button Box( "Open Paths",
                For Each( {row}, tbl << Get Selected Rows, {path},
                    path = tbl[String Col Box( 2 )] << Get( row );
                    Open( path );
                )
            ),
            Button Box( "Copy Paths",
                If( N Items( tbl << Get Selected Rows ),
                    Set Clipboard(
                        Concat Items(
                            Transform Each( {row}, tbl << Get Selected Rows, Output( "List" ),
                                tbl[String Col Box( 2 )] << Get( row )
                            ),
                            "\!N"
                        )
                    )
                )
            )
        ),
        window:tbl = Table Box(
            String Col Box( "Variable", path vars ),
            String Col Box( "Path",
                Transform Each( {var}, path vars, Get Path Variable( var ) )
            ),
            <<Set Selectable Rows
        )
    )
);


```

### [Get Platform Preference](#get-platform-preference)

**Syntax:** Get Platform Preferences( < platformName < ( optionName, ... ) > ... > )

**Description:** Gets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Get Platform Preferences( Bivariate( Fit Line ), DOE );


```

### [Get Platform Preferences](#get-platform-preferences)

**Syntax:** Get Platform Preferences( < platformName < ( optionName, ... ) > ... > )

**Description:** Gets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Get Platform Preferences( Bivariate( Fit Line ), DOE );


```

### [Get Policies](#get-policies)

**Syntax:** Get Policies( \<Machine|User|Both> )

**Description:** Returns an associative array containing the current policy names and values.

**JMP Version Added:** 18

```

Get Policies();


```

### [Get Preference](#get-preference)

**Syntax:** Get Preferences( pref1, ... )

**Description:** Gets preferences as specified.

**JMP Version Added:** Before version 14

```

Get Preferences( Graph marker size );


```

### [Get Preferences](#get-preferences)

**Syntax:** Get Preferences( pref1, ... )

**Description:** Gets preferences as specified.

**JMP Version Added:** Before version 14

```

Get Preferences( Graph marker size );


```

### [Get Project](#get-project)

**Syntax:** project = Get Project( title|index|box|window )

**Description:** Returns a reference to a specific open project by title, index, or box.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );

Print( Get Project( 2 ) << Get Window Title() );


```

**Example 2**

```

Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );

project = Get Project( "Big Class" );


```

### [Get Project List](#get-project-list)

**Syntax:** projectList = Get Project List()

**Description:** Returns a list of all open projects.

**JMP Version Added:** Before version 14

```

New Project();
Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );

Print( Get Project List() << Get Window Title() );


```

### [Get Punctuation Characters](#get-punctuation-characters)

**Syntax:** Get Punctuation Characters(\<Exclude Chars(chars) | Include Chars(chars)>)

**Description:** Returns a string containing the punctuation characters that are typically used for delimiting words. These include ,:;.?!/#@&~()[]\<>"\*\`%$+=^|{} and some common Unicode punctuation.

**JMP Version Added:** 15

**Example 1**

```

Get Punctuation Characters();


```

**Example 2**

```

Get Punctuation Characters( Include Chars( "_" ) );


```

**Example 3**

```

Get Punctuation Characters( Exclude Chars( "$[]" ) );


```

**Example 4**

```

Collapse Whitespace(
    Substitute( "This...string..has..dots", Items( Get Punctuation Characters(), "" ), " " )
);


```

### [Get Session Script](#get-session-script)

**Syntax:** Get Session Script( win1, ... )

**Description:** Returns the session script for the specified windows. The session script is a JSL expression that will recreate the given windows, including data tables, script windows, journals, and reports. Reports created via JSL scripts have limited support, and will only attempt to recreate the display layout.

**JMP Version Added:** 17

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << RunScript( "Bivariate" );
Get Session Script( Report( biv ) );


```

### [Get Whitespace Characters](#get-whitespace-characters)

**Syntax:** Get Whitespace Characters()

**Description:** Returns a string containing all of the whitespace characters that are typically used.

**JMP Version Added:** Before version 14

```

Get Whitespace Characters();


```

### [Get Window](#get-window)

**Syntax:** window = Get Window( \<Project(title|index|box|window)>, \<Type(string)>, title|index|box )

**Description:** Returns a reference to a specific open window by title, index, or box.

The search is limited to windows in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

Use the optional Type() argument with one of "Data Tables", "Journals", "Reports", or "Dialogs" to limit the search to windows of a particular type.

**JMP Version Added:** 14

**Example 1**

```

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

window = Get Window( "Big Class" );


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS\Big Class.jmpprj" );

window = Get Window( Project( project ), "Big Class" );


```

### [Get Window List](#get-window-list)

**Syntax:** windowList = Get Window List( \<Project(title|index|box|window)>, \<Type(string)> )

**Description:** Returns a list of all open windows.

The list is limited to windows in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

Use the optional Type() argument with one of "Data Tables", "Journals", "Reports", or "Dialogs" to limit the list to windows of a particular type.

**JMP Version Added:** 14

**Example 1**

```

Print( Get Window List() << Get Window Title() );


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS\Big Class.jmpprj" );

Print( Get Window List( Project( project ) ) << Get Window Title() );


```

**Example 3**

```

project = Open( "$SAMPLE_PROJECTS\Big Class.jmpprj" );

Print( Get Window List( Project( project ), Type( "Data Tables" ) ) << Get Window Title() );


```

### [Global Box](#global-box)

**Syntax:** box = Global Box( name )

**Description:** Creates a display box showing the value of a global variable.

**JMP Version Added:** Before version 14

```

ex = .6;
New Window( "Example", Global Box( ex ) );


```

### [GLog Density](#glog-density)

**Syntax:** y = GLog Density( q, mu, sigma, lambda )

**Description:** Returns the density at q of a generalized logarithm distribution with location mu, scale sigma, and shape lambda.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: GLog Density",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GLog Density( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( " \!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( " \!U03BB" ) )
);


```

### [GLog Distribution](#glog-distribution)

**Syntax:** p = GLog Distribution( q, mu, sigma, lambda )

**Description:** Returns the probability that a generalized logarithm distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: Glog Distribution",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GLog Distribution( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( " \!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( " \!U03BB" ) )
);


```

### [GLog Quantile](#glog-quantile)

**Syntax:** q = GLog Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from a generalized logarithm distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
p = 0.4;
New Window( "Example: GLog Quantile",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GLog Distribution( x, mu, sigma, lambda ), x );
        Pen Color( "Blue" );
        V Line( GLog Quantile( p, mu, sigma, lambda ), 0, 1 );
        Text(
            {-9, 0.9},
            "\!U03BC=",
            Round( mu, 4 ),
            " \!U03C3=",
            Round( sigma, 4 ),
            " \!U03BB=",
            Round( lambda, 4 )
        );
        Text( {-9, 0.8}, "p=", Round( p, 3 ) );
        Text( {-9, 0.7}, "quantile= ", Round( GLog Quantile( p, mu, sigma, lambda ), 2 ) );
    ),
    H List Box( Slider Box( -2, 2, mu, gdey << reshow ), Text Box( " \!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0.01, 0.99, p, gdey << reshow ), Text Box( " p" ) )
);


```

### [Glue](#glue)

**Syntax:** y = ( expr1; expr2; ... ); y = Glue( expr1, expr2, ... )

**Description:** Evaluates each argument and returns the last result.

**JMP Version Added:** Before version 14

```

ex1 = 1;
ex2 = 2;


```

### [Google Sheet Export](#google-sheet-export)

**Syntax:** Google Sheet Export(dt, Email(address), Spreadsheet(url|id) | New Spreadsheet(name), Sheet Name(name))

**Description:** Exports a Data Table to a new Google Spreadsheet or a new Sheet within an existing Google Spreadsheet.

**JMP Version Added:** 15

```

email = "youremail@gmail.com"; //Replace this with your email
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Google Sheet Export(
    dt,
    Email( email ),
    New Spreadsheet( "JSL Example" ),
    Sheet Name( "Example 1" )
);


```

### [Google Sheet Import](#google-sheet-import)

**Syntax:** Google Sheet Import(Email(address), Spreadsheet(url|id), \<Sheets("sheetName1", ... "sheetNameN")>, \<Sheet Settings( Has Column Headers(Boolean), Data Starts on Row(n), Cell Range(range), Import Cell Colors(Boolean), Supress Empty Columns(Boolean))>)

**Description:** Opens a Google Sheet file.

**JMP Version Added:** 15

```

email = "youremail@gmail.com"; //Replace this with your email
spreadsheet =
"https://docs.google.com/spreadsheets/d/1AqV2ZkzzMtFrk-devlFdQW2Sb09ipOQaCQ1p0iho-iE/"; 

Google Sheet Import(
    Email( email ),
    Spreadsheet( spreadsheet ),
    Sheets( "Sheet1", "Sheet2" ),
    Sheet Settings(
        Has Column Headers( 0 ),
        Data Starts on Row( 1 ),
        Cell Range( "A1:C2" ),
        Import Cell Colors( 0 ),
        Suppress Empty Columns( 1 )
    )
);


```

### [Gradient Function](#gradient-function)

**Syntax:** Gradient Function( zExpr, xName, yName, zLimits, zColor( color list or matrix ), < \<<XGrid( min, max, incr )>, < \<<YGrid( min, max, incr )>, < \<<Transparency( t )> )

**Description:** Fills the graph with a gradient between two colors. The zExpr argument is a function in terms of the variables specified by xName and yName. The vector zLimits specifies the range of values for zExpr. The zColor argument is a vector or list that defines the two colors that are blended together to create the gradient. The Transparency is a single value applied to the entire grid.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Gradient Function(
            Log( a * a + b * b ),
            a,
            b,
            [2 10],
            Z Color( {"Green", "Orange"} )
        )
    )
);


```

### [Graph](#graph)

**Syntax:** y = Graph Box( props, script )

**Description:** Returns a display box containing a graph with axes. Named property arguments can be title("title"), XScale(low,high), YScale(low,high), FrameSize(h,v), XName("x"), yName("y"), DoubleBuffer, and SuppressAxes.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( "Blue" );
        Line( [10 30 70], [88 22 44] );
    )
);


```

### [Graph 3D Box](#graph-3d-box)

**Syntax:** y = Graph 3D Box()

**Description:** (Experimental) Returns a display box with 3D content that can be used with other display boxes to create custom reports.

**JMP Version Added:** Before version 14

```

x3d = Graph 3D Box(
    framesize( 300, 300 ),
    Xname( "X Axis" ),
    Yname( "Y Axis" ),
    Zname( "Z Axis" )
);
New Window( "Graph3DBox Example", x3d );
x3d << addmarkers( /*x*/[20 20 20 20], /*y*/[20 20 20 20], /*z*/[10 20 30 40] );
x3d << AddVector(
    [60 60 60]/*from*/,
    [90 60 60, 60 90 60, 60 60 90]/*to*/,
    ShaftThickness( [.1] ),
    FromThickness( [.2] ),
    ToThickness( [.3] ),
    ShaftColor( [-255] ),
    FromColor( [-16711680] ),
    ToColor( [-65280] ),
    Facets( Round ),
    FromCap( Sphere ),
    toCap( Point )
);


```

### [Graph Box](#graph-box)

**Syntax:** y = Graph Box( props, script )

**Description:** Returns a display box containing a graph with axes. Named property arguments can be title("title"), XScale(low,high), YScale(low,high), FrameSize(h,v), XName("x"), yName("y"), DoubleBuffer, and SuppressAxes.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( "Blue" );
        Line( [10 30 70], [88 22 44] );
    )
);


```

### [Greater](#greater)

**Syntax:** z = x > y > ... ; z = Greater( x, y, ... )

**Description:** Returns 1 if each argument is greater than the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

3 > 2 > 1;


```

### [Greater or Equal](#greater-or-equal)

**Syntax:** z = x >= y >= ... ; z = Greater or Equal( x, y, ... )

**Description:** Returns 1 if each argument is greater than or equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

3 >= 2 >= 2;


```

### [Gzip Compress](#gzip-compress)

**Syntax:** blob = Gzip Compress( blob )

**Description:** Compresses a blob of data into a gzip blob.

**JMP Version Added:** 14

```

Gzip Compress(
    Char To Blob( "random data does not usually compress well and may get larger" )
);


```

### [Gzip Uncompress](#gzip-uncompress)

**Syntax:** blob = Gzip Uncompress( blob )

**Description:** Uncompresses a blob of gzip data into a blob.

**JMP Version Added:** 14

```

Gzip Uncompress(/*typically this data might come from GzipCompress() but might also come from a .gz file using loadTextFile with the blob option*/
    Char To Blob(
        "~1F~8B~08~00~00~00~00~00~00~0A~0D~CA~C1~0D~00~21~08~04~C0V~B6~B5~CDA~FC~80~5C~00c~EC^~E7=~C9)~E1~106~21~A1~85~19~8DU~8Bf~07_~F8~9FZ~85~ADfx~13~CE~83~A1~0Dc~0E~CD~0B~94*~16~1E=~00~00~00",
        "ascii~hex"
    )
);


```

### [H Center Box](#h-center-box)

**Syntax:** y = H Center Box( <childbox> )

**Description:** Returns a display box with the childbox display box argument centered in the horizontal space defined by the maximum size of that child and all the other siblings of the center box.

**JMP Version Added:** Before version 14

```

New Window( "test",
    H List Box(
        V Center Box( Text Box( "V+V" ) ),
        V List Box(
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            H Center Box( Text Box( "H+H" ) ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" )
        )
    )
);


```

### [H Direct Product](#h-direct-product)

**Syntax:** y = H Direct Product( A, B )

**Description:** Returns the horizontal direct product, which is the direct product of each row of matrices A and B.

**JMP Version Added:** Before version 14

```

exA = [1 2, 3 4];
exB = [1 1 1, 2 2 2];
exProd = H Direct Product( exA, exB );
Show( exProd );

/* verify result */
Show( exProd[1, 1 :: 6] == Direct Product( exA[1, 1 :: 2], exB[1, 1 :: 3] ) );
Show( exProd[2, 1 :: 6] == Direct Product( exA[2, 1 :: 2], exB[2, 1 :: 3] ) );


```

### [H Line](#h-line)

**Syntax:** H Line( y ); H Line( x1, x2, y )

**Description:** Draws a horizontal line at y from x1 to x2 or through the entire frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 2 );
        H Line( 10, 50, 20 );
    )
);


```

### [H List Box](#h-list-box)

**Syntax:** y = H List Box( \<Align( center|bottom )>, displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for bottom or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker", H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ) )
);


```

### [H Scroll Box](#h-scroll-box)

**Syntax:** y = H Scroll Box( \<Size( x )>, displayBox )

**Description:** Returns a display box that positions a larger child box using a horizontal scroll bar.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        H Scroll Box(
            Size( 200 ),
            H List Box(
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
            ),
            <<Set Stretch( "Window", "Window" )
        )
    )
);


```

### [H Sheet Box](#h-sheet-box)

**Syntax:** y = H Sheet Box( \<<Hold( rpt ), displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for right or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [H Size](#h-size)

**Syntax:** h = H Size()

**Description:** Returns the horizontal size of the graphics frame in pixels.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( H Size() / 20 );
        Line( [10 30 90], [88 22 44] );
    )
);


```

### [H Splitter Box](#h-splitter-box)

**Syntax:** y = H Splitter Box( \<Size(x,y)>, displayBox, ... )

**Description:** Returns a display box that arranges other display boxes horizontally, with interactive control of sizes. Child sizes are specified as a proportion of the width or height of the Splitter Box. The optional Size argument is only used for the top-most Splitter Box; lower level boxes are sized like any other child box.

**JMP Version Added:** Before version 14

```

New Window( "Splitter",
    V Splitter Box(
        Size( 800, 600 ),
        H Splitter Box( graph = Graph Box(), Script Box(), <<Sizes( {0.6, 0.4} ) ),
        H Splitter Box(
            pict = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ),
            spacer = Spacer Box(),
            <<Sizes( {0.4, 0.6} )
        )
    )
);
graph[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
pict << Set Min Size( 100, 100 );
pict << Set Max Size( 500, 500 );
pict << Set Stretch( "Window", "Window" );
spacer << Set Fill( 1 );
spacer << Color( "Red" );
spacer << Set Stretch( "Window", "Window" );


```

### [Hadamard](#hadamard)

**Syntax:** y = Hadamard( n, \<normalize = 0> )

**Description:** Creates a Hadamard matrix of order n.

**JMP Version Added:** 15

```

Show( Hadamard( 12 ), Hadamard( 12, 1 ) );


```

### [Handle](#handle)

**Syntax:** Handle( xPos, yPos, dragScript, <mouseUpScript> )

**Description:** Draws a square marker at the coordinates specified by xPos and yPos and repeatedly evaluates the dragScript expression when the mouse is pressed over the marker. Before running the script, the globals x and y are set to the mouse value and are restored to their original values afterward. The mouseUpScript expression is run after the mouse button is released.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = 20;
    exy = 50;,
    Graph Box(
        Frame Size( 200, 200 ),
        Handle(
            exx,
            exy,
            exx = x;
            exy = y;
        );
        Circle( {0, 0}, Sqrt( exx * exx + exy * exy ) );
    )
);


```

### [Head](#head)

**Syntax:** y = Head( x )

**Description:** Returns the head of the evaluated expression, without its arguments.

**JMP Version Added:** Before version 14

```

Head( Expr( Sum( a, b, c ) ) );


```

### [Head Expr](#head-expr)

**Syntax:** y = Head Expr( expr )

**Description:** Returns the head of the expression, without its arguments. This function is deprecated. Please use Head() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Head Expr() equivalent
Head( Expr( Sum( a, b, c ) ) );


```

**Example 2**

```

// Deprecated
Head Expr( Sum( a, b, c ) );


```

### [Head Name](#head-name)

**Syntax:** y = Head Name( x )

**Description:** Returns the head of the evaluated expression as a string, without its arguments.

**JMP Version Added:** Before version 14

```

Head Name( Expr( Sum( a, b, c ) ) );


```

### [Head Name Expr](#head-name-expr)

**Syntax:** y = Head Name Expr( expr )

**Description:** Returns the head of the expression as a string, without its arguments. This function is deprecated. Please use Head Name() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Head Name Expr() equivalent
Head Name( Expr( Sum( a, b, c ) ) );


```

**Example 2**

```

// Deprecated
Head Name Expr( Sum( a, b, c ) );


```

### [Heat Color](#heat-color)

**Syntax:** y = Heat Color( x ); y = Heat Color( x, < \<<theme> )

**Description:** Returns a color corresponding to a value between 0 and 1. Default theme is "Blue to Gray to Red". Any theme supported by Cell Plot is supported here. Matrix arguments supported.

**JMP Version Added:** Before version 14

```

New Window( "Color Bar",
    Graph(
        For( z = 0, z < 1, z += .1,
            x = 10 + 80 * z;
            Fill Color( Heat Color( z, <<"Green to Black to Red" ) );
            Rect( x - 5, 45, x + 5, 55, 1 );
        )
    )
);


```

### [Hex](#hex)

**Syntax:** h = Hex( value, \<"integer">|\<encoding="utf-8">|\<Base(number)>,\<Pad To(number)> )

**Description:** Returns the hexadecimal (or other base number system) text corresponding to the given value and encoding, which can be a number a string or a blob. If the value is a number, IEEE 754 64-bit encoding is used unless one of the optional arguments, integer or Base, is provided. If Base is specified, the function returns the text corresponding to the specified number in that base number system instead of hexadecimal. The base must be an integer value between 2 and 36 inclusive. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, ascii~hex, shift_jis and euc-jp.

**JMP Version Added:** Before version 14

```

Hex( 1024, "integer" ) || " " || Hex( "Café", "utf-16be" ) || " " ||
Hex( 11, Base( 2 ), Pad To( 8 ) );


```

### [Hex To Blob](#hex-to-blob)

**Syntax:** blob = Hex To Blob( hex string )

**Description:** Makes a BLOB (Binary Large OBject) from the given string of hexadecimal codes, which can also include spaces, commas, carriage returns, and line feeds.

**JMP Version Added:** Before version 14

```

Hex To Blob( "FF78CE" );


```

### [Hex To Char](#hex-to-char)

**Syntax:** s = Hex To Char( hextext, \<encoding="utf-8"> )

**Description:** Returns the text corresponding to the hexadecimal text, using the specified encoding. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, ascii~hex, shift_jis, and euc-jp.

**JMP Version Added:** Before version 14

```

Hex To Char( "436166C3A9" ) || Hex To Char( "00430061006600E9", "utf-16be" );


```

### [Hex To Number](#hex-to-number)

**Syntax:** x = Hex To Number( hextext, \<Base(number)> )

**Description:** Returns the number corresponding to the hexadecimal (or other base number system) text. 16 hex digits are converted as IEEE 754 64-bit floating point numbers; otherwise the input is treated as a hex integer. If Base is specified, the text is treated as a string representing the number in that base. Base must be an integer between 2 and 36 inclusive.

**JMP Version Added:** Before version 14

```

Hex To Number( "11110000", Base( 2 ) );


```

### [Hidden](#hidden)

**Syntax:** y = Hidden( <rs> ); Hidden( \<Row State( <r> )> ) = y

**Description:** Returns the hidden component of the specified row state value, 0 or 1. If Hidden is used as an L-value, it changes the hidden state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Hidden State( 1 );
Hidden( Row State( 3 ) );
Row() = 3;
Hidden();


```

### [Hidden State](#hidden-state)

**Syntax:** rs = Hidden State( x )

**Description:** Returns a row state value with the hidden component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Hidden State( 1 );
Hidden( Row State( 3 ) );


```

### [Hier Box](#hier-box)

**Syntax:** y = Hier Box( text, Hier Box( ... ), Hier Box( ... ), ... )

**Description:** Returns a display box for hierarchy trees. The text argument is the node's name and can be a Text Edit Box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Hier Box(
        Text Edit Box( "Cause 1" ),
        Hier Box( Text Edit Box( "Subcause 1.1" ), <<direction( 1 ) ),
        Hier Box( Text Box( "Subcause 1.2" ) ),
        <<Change Type( Fishbone ),
        <<direction( 1 )
    )
);


```

### [Hier Clust](#hier-clust)

**Syntax:** {c1, c2, c3, c4, c5} = Hier Clust( x )

**Description:** Returns the clustering history for a hierarchical clustering using Ward's method (without standardizing data), where x is a data matrix.

**JMP Version Added:** Before version 14

```

exdt = Open( "$SAMPLE_DATA/Body Measurements.jmp" );
ex = exdt << get as matrix();
exhc = Hierarchical Cluster(
    Y( Eval( exdt << Get Column Names ) ),
    Method( Ward ),
    Standardize( 0 ),
    Dendrogram Scale( Even Spacing ),
    Number of Clusters( 3 )
);
Report( exhc )["Dendrogram"] << Close( 1 );
Report( exhc )["Clustering History"] << Close( 0 );
exhistory = Hier Clust( ex );
exhistory[3, 1];


```

### [Hist Seg](#hist-seg)

**Syntax:** b = Hist Seg([data], \<[freq data]>,\<[weight data]>, \<vertical=0|1>, \<Row States()>)

**Description:** Returns a hist seg

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, .2 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);


```

### [HLS Color](#hls-color)

**Syntax:** y = HLS Color( h, l, s ); y = HLS Color( {h, l, s} )

**Description:** Returns a color number from the hue, lightness, and saturation components, all between 0 and 1.

**JMP Version Added:** Before version 14

```

New Window( "Color Wheel",
    Graph(
        frameSize( 200, 200 ),
        For( hue = 0, hue < 360, hue += 30,
            y = 50 - 40 * Cos( hue * 2 * Pi() / 360 );
            x = 50 + 40 * Sin( hue * 2 * Pi() / 360 );
            Fill Color( HLS Color( hue / 360, 0.5, 1 ) );
            Oval( x - 10, y - 10, x + 10, y + 10, 1 );
        )
    )
);


```

### [Host is](#host-is)

**Syntax:** y = Host is( "Mac"|"Windows"|"Bits32"|"Bits64"|"x86_64"|"arm64" )

**Description:** Returns 1 if the JMP application matches the argument; returns 0 otherwise. The arguments Windows or Mac test for the specified operating system, and the arguments Bits32 or Bits64 test for the specified 32-bit or 64-bit JMP application. Only one argument can be tested at a time.

**JMP Version Added:** Before version 14

```

If( Host is( "Mac" ),
    Show( "On Mac" ),
    Show( "Not on Mac" )
);
If( Host is( "Bits64" ),
    Show( "64 bit" )
);
If(
    Host is( "x86_64" ), Show( "On x86_64" ),
    Host is( "arm64" ), Show( "On arm64" )
);


```

### [Hough Line Transform](#hough-line-transform)

**Syntax:** accum = Hough Line Transform( matrix, \<NAngle(number)> \<NRadius(number)> )

**Description:** Returns the Hough transform for detecting lines in image data

**JMP Version Added:** Before version 14

**Example 1**

```

xx = .4;
yy = .4;
angleDegrees = (1 :: 180)`;
angle = Pi() * angleDegrees / (180);
New Window( "Hough Transform Demo 1",
    Border Box( Left( 20 ), Top( 20 ), Right( 15 ), Bottom( 15 ),
        V List Box(
            Text Box( "Click and drag the circle in a straight line." ),
            Graph Box(
                X Scale( -1, 1 ),
                Y Scale( -1, 1 ),
                Circle( {xx, yy}, .05 );
                Text( {xx + .1, yy + .1}, Char( xx, 4 ) || " " || Char( yy, 4 ) );
                Mousetrap(
                    xx = x;
                    yy = y;
                    gb << reshow;
                );
            ),
            Text Box( "For angle 1 to 180 , x*Cos(angle)+y*Sin(angle)" ),
            Text Box( "What position stays constant as you move?" ),
            gb = Graph Box(
                X Scale( 0, 180 ),
                XName( "Angle" ),
                Y Scale( -1.5, 1.5 ),
                YName( "Distance to Line" ),
                Line( angleDegrees, xx * Cos( angle ) + yy * Sin( angle ) )
            )
        )
    )
);


```

**Example 2**

```

nRow = 35;
nCol = 35;

// Make a wafer template missing outside a radius
waferTemplate = J( nRow, nCol, 0 );
If( 0,
    For( i = 1, i <= nRow, i++,
        For( j = 1, j <= nCol, j++,
            If( (i - nrow / 2) ^ 2 + (j - nCol / 2) ^ 2 > ((nRow + nCol) / 4) ^ 2,
                waferTemplate[i, j] = .
            )
        )
    )
);
wafer = waferTemplate;
wafer[5, 22] = 1;
lightGray = RGB Color( .9, .9, .9 );
showWafer = Expr(
    For( i = 1, i <= nRow, i++,
        For( j = 1, j <= nCol, j++,
            z = wafer[i, j];
            If( Is Missing( z ),
                Continue()
            );
            Fill Color( If( z == 0, lightGray, 3 ) );
            Rect( i - nrow / 2, j - nCol / 2, i - nrow / 2 - 1, j - nCol / 2 + 1, 1 );
        )
    )
);
showHough = Expr(
    accum = Hough Line Transform( wafer );
    maxAccum = Max( Max( accum ), 1 );
    accumHeat = Heat Color( accum / maxAccum );
    nr = N Row( accum );
    nc = N Col( accum );
    For( i = 1, i <= nr, i++,
        For( j = 1, j <= nc, j++,
            z = accumHeat[i, j];
            Fill Color( z );
            Rect( j - 1, nr - i, j, nr - i + 1, 1 );
        )
    );
    //Marginals
    radiusDensity = V Max( accum` );
    radiusScale = 3 * Max( radiusDensity ) / Mean( radiusDensity );
    radiusColor = Heat Color( radiusDensity / radiusScale );
    If( 1,
        angleDensity = V Max( accum );
        angleScale = 3 * Max( angleDensity ) / Mean( angleDensity );
        angleColor = Heat Color( angleDensity / angleScale );
    ,
        angle1 = angleDensity - Mean( angleDensity );
        angle1 = angle1 :* (angle1 > 0);
        angleColor = Heat Color( angle1 / Max( angle1 ) );
    );
    For( j = 1, j <= nc, j++,
        Fill Color( angleColor[j] );
        Rect( j - 1, -5, j, -8, 1 );
    );
    For( i = 1, i <= nr, i++,
        Fill Color( radiusColor[i] );
        Rect( 185, nr - i, 190, nr - i + 1, 1 );
    );
);
mouseAction = Expr(
    i = Floor( x + nrow / 2 + .5 );
    j = Floor( y + ncol / 2 + .5 );
    If( i > 0 & i <= nRow & j > 0 & j <= nCol,
        wafer[i, j]
        ++);
    bothBox << reshow;
);
New Window( "Hough Transform Demo 2",
    Border Box( Left( 15 ), Top( 15 ), Right( 10 ), Bottom( 10 ),
        bothBox = V List Box(
            Text Box( "Click to add points in the top frame along a slanted line." ),
            Text Box( "The Hough transform is shown below with marginal densities." ),
            Text Box( "" ),
            H List Box(
                Button Box( "Clear",
                    wafer = waferTemplate;
                    bothBox << Reshow;
                ),
                Button Box( "Add Random",
                    wafer = wafer | J( nRow, nCol, Random Uniform() < .05 );
                    bothBox << Reshow;
                )
            ),
            waferBox = Graph Box(
                X Scale( -18, 18 ),
                Y Scale( -18, 18 ),
                FrameSize( 300, 300 ),
                XName( "Angle" ),
                YName( "Radius" ),
                Mousetrap( mouseAction ),
                showWafer
            ),
            houghBox = Graph Box(
                X Scale( 0, 190 ),
                Y Scale( -10, 50 ),
                FrameSize( 500, 200 ),
                showHough
            )
        )
    )
);


```

### [Hour](#hour)

**Syntax:** hr = Hour( datetime, \<12> )

**Description:** Returns the hours part of a date-time value, in 12-hour mode (12, 1 - 11) or 24-hour mode (0 - 23).

**JMP Version Added:** Before version 14

```

Hour( Today() );


```

### [HP Time](#hp-time)

**Syntax:** t = HP Time()

**Description:** Returns a High Precision time value in microseconds. Only useful relative to another HP Time() value. The time value represents the number of microseconds since the start of the JMP session.

**JMP Version Added:** Before version 14

```

bt = HP Time();
Open( "$SAMPLE_DATA/Big Class.jmp" );
et = HP Time();
it = et - bt;
Show( it );


```

### [Hue State](#hue-state)

**Syntax:** rs = Hue State( x )

**Description:** Returns a row state value with the color hue component set to the specified value. Needs to be combined with a Shade State() value to produce a valid color.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Combine States( Hue State( 5 ), Shade State( 1 ) );


```

### [Hypergeometric Distribution](#hypergeometric-distribution)

**Syntax:** cumprob = Hypergeometric Distribution( N, K, n, x, <r> )

**Description:** Returns the probability that a hypergeometrically distributed random variable is less than or equal to x, where N is the population size, K is the number of items in the category of interest, n is the sample size, x is the count of interest, and r is the optional odds ratio.

**JMP Version Added:** Before version 14

```

exhdK = 10;
exhdn = 10;
New Window( "Example: Hypergeometric Distribution",
    exy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 21 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exhdx = 0, exhdx < Round( exhdn ), exhdx++,
            H Line(
                exhdx,
                exhdx + 1,
                Hypergeometric Distribution( 20, Round( exhdK ), Round( exhdn ), exhdx )
            );
            V Line(
                exhdx + 1,
                Hypergeometric Distribution( 20, Round( exhdK ), Round( exhdn ), exhdx ),
                Hypergeometric Distribution( 20, Round( exhdK ), Round( exhdn ), exhdx + 1 )
            );
        );
        Text( {10, 0.17}, "N=", 20, " K=", Round( exhdK ), " n=", Round( exhdn ) );
    ),
    H List Box( Slider Box( 0, 20, exhdK, exy << reshow ), Text Box( " K" ) ),
    H List Box( Slider Box( 0, 20, exhdn, exy << reshow ), Text Box( " n" ) )
);


```

### [Hypergeometric Probability](#hypergeometric-probability)

**Syntax:** prob = Hypergeometric Probability( N, K, n, x, <r> )

**Description:** Returns the probability that a hypergeometrically distributed random variable is equal to x, where N is the population size, K is the number of items in the category of interest, n is the sample size, x is the count of interest, and r is the optional odds ratio.

**JMP Version Added:** Before version 14

```

exhdK = 10;
exhdn = 10;
New Window( "Example: Hypergeometric Probability",
    exhdy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 21 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exhdx = 0, exhdx <= Round( exhdn ), exhdx++,
            V Line(
                exhdx,
                0,
                Hypergeometric Probability( 20, Round( exhdK ), Round( exhdn ), exhdx )
            )
        );
        Text( {10, 0.17}, "N=", 20, " K=", Round( exhdK ), " n=", Round( exhdn ) );
    ),
    H List Box( Slider Box( 0, 20, exhdK, exhdy << reshow ), Text Box( " K" ) ),
    H List Box( Slider Box( 0, 20, exhdn, exhdy << reshow ), Text Box( " n" ) )
);


```

### [Icon Box](#icon-box)

**Syntax:** Box = Icon Box( "Name" )

**Description:** Constructs a display box containing an icon, where the name argument can be a JMP icon name or a path to a an image.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    ex1 = Icon Box( "Popup" ),
    ex2 = Icon Box( "Locked" ),
    ex3 = Icon Box( "Labeled" ),
    ex4 = Icon Box( "Sub" ),
    ex5 = Icon Box( "Excluded" ),
    ex6 = Icon Box( "Hidden" ),
    ex7 = Icon Box( "Continuous" ),
    ex8 = Icon Box( "Nominal" ),
    ex9 = Icon Box( "Ordinal" )
);


```

**Example 2**

```

New Window( "Example with Path", ex = Icon Box( "$SAMPLE_IMAGES/pi.gif" ) );


```

### [Identity](#identity)

**Syntax:** y = Identity( n )

**Description:** Creates an n-by-n identity matrix, with ones on diagonal, zeros elsewhere.

**JMP Version Added:** Before version 14

```

Identity( 2 );


```

### [If](#if)

**Syntax:** y = If( condition1, result1, \<condition2, result2>, ..., <elseResult> )

**Description:** Evaluates the first of each pair of arguments and returns the evaluation of the result expression associated with the first condition argument that evaluates to a nonzero result. The condition arguments are evaluated in order. If all of the condition arguments evaluate to zero, the optional elseResult is evaluated and the result is returned. If no elseResult is specified, and none of the conditions are true, a missing value is returned. If all of the condition arguments evaluate to missing, a missing value is returned.

**JMP Version Added:** Before version 14

```

If( Random Uniform() < 0.5,
    "heads",
    "tails"
);


```

### [If Box](#if-box)

**Syntax:** box = If Box( 0|1, displayBoxArgs )

**Description:** Returns a display box that conditionally displays the specified display box arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    H List Box(
        englishBox = If Box( 1, Text Box( "Good day" ) ),
        frenchBox = If Box( 0, Text Box( "Bon Jour" ) )
    )
);
Wait( 5 );
englishBox << Set( 0 );
frenchBox << Set( 1 );


```

### [If Seg](#if-seg)

**Syntax:** seg = If Seg(\<state=0|1>)

**Description:** Returns a display seg that shows or hides display seg children.

**JMP Version Added:** Before version 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);


```

### [IfMax](#ifmax)

**Syntax:** y = IfMax( expr1, result1, expr2, result2, ..., <allMissingResult> )

**Description:** Evaluates the first of each pair of arguments, and returns the evaluation of the result expression associated with the maximum of the expressions. If there are ties, it returns the first maximum. If all expressions are missing, it returns Empty if an even number of arguments, or the last argument if odd. The test expressions must evaluate to numeric, but the result expressions can be anything.

**JMP Version Added:** Before version 14

```

TomScore = 45;
JonScore = 47;
TimScore = 46;
highestScorer = IfMax( TomScore, "Tom", JonScore, "Jon", TimScore, "Tim", "Noone" );


```

### [IfMin](#ifmin)

**Syntax:** y = IfMin( expr1, result1, expr2, result2, ..., <allMissingResult> )

**Description:** Evaluates the first of each pair of arguments, and returns the evaluation of the result expression associated with the minimum of the expressions. If there are ties, it returns the first minimum. If all expressions are missing, it returns Empty if an even number of arguments, or the last argument if odd. The test expressions must evaluate to numeric, but the result expressions can be anything.

**JMP Version Added:** Before version 14

```

TomScore = 45;
JonScore = 47;
TimScore = 46;
lowestScorer = IfMin( TomScore, "Tom", JonScore, "Jon", TimScore, "Tim", "Noone" );


```

### [IfMZ](#ifmz)

**Syntax:** y = IfMZ( condition1, result1, \<condition2, result2>, ..., <elseResult> )

**Description:** Evaluates the first of each pair of arguments and returns the evaluation of the result expression associated with the first condition argument that evaluates to a nonzero result. The condition arguments are evaluated in order. If all condition arguments evaluate to zero or missing, the optional elseResult is evaluated and the result is returned. If no elseResult is specified, and none of the conditions are true, a missing value is returned. (IfMZ() is equivalent to If() where missing values for evaluated condition arguments are treated as zero.)

**JMP Version Added:** Before version 14

```

x = 1;
Show( IfMZ( x == 1, 10, x == 2, 20, 30 ) );
x = .;
Show( IfMZ( x == 1, 10, x == 2, 20, 30 ) );
x = .;
Show( If( x == 1, 10, x == 2, 20, 30 ) );


```

### [IGamma](#igamma)

**Syntax:** p = Gamma Distribution( q, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the probability that a Gamma distributed random variable is less than q, where the alpha shape parameter argument must be positive. IGamma() is an alias name to Gamma Distribution(). The Gamma Distribution() function is equivalent to Gamma(alpha,q)/Gamma(alpha).

**JMP Version Added:** Before version 14

```

gdialpha = Log( 1.5 );
New Window( "Example: Gamma Distribution",
    gdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Distribution( gdiq, Exp( gdialpha ) ), gdiq );
        Text( {1, 0.9}, "\!U03B1=", Round( Exp( gdialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gdialpha, gdiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [In Days](#in-days)

**Syntax:** y = In Days( \<x=1> )

**Description:** Converts x from a number of days to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Days( 1.5 );


```

### [In Hours](#in-hours)

**Syntax:** y = In Hours( \<x=1> )

**Description:** Converts x from a number of hours to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Hours( 0.5 );


```

### [In Minutes](#in-minutes)

**Syntax:** y = In Minutes( \<x=1> )

**Description:** Converts x from a number of minutes to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Minutes( 1 );


```

### [In Path](#in-path)

**Syntax:** b = In Path( x, y, pathMatrix|pathText )

**Description:** Returns 1 if the point (x,y) is in the given path, otherwise returns 0.

**JMP Version Added:** Before version 14

```


New Window( "Example",
    window:p = "M10 10 L52 10 L37 52 Z M20 16 L40 20 L35 40 Z";
    Graph Box(
        Fill Color( "light blue" );
        Path( window:p, 1 );
        For Each( {x}, 5 :: 55 :: 5,
            For Each( {y}, 5 :: 55 :: 5,
                Marker(
                    Marker State( If( In Path( x, y, window:p ), "x", "circle" ) ),
                    {x, y}
                )
            )
        );
    );
);


```

### [In Polygon](#in-polygon)

**Syntax:** b = In Polygon( x, y, xMatrix, <yMatrix> )

**Description:** Returns 1 if the point (x,y) is in the polygon defined by the vector arguments, otherwise returns 0.

**JMP Version Added:** Before version 14

```

In Polygon( 11, 22, [10 20 30], [10 30 20] );


```

### [In Weeks](#in-weeks)

**Syntax:** y = In Weeks( \<x=1> )

**Description:** Converts x from a number of weeks to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Weeks( 1 );


```

### [In Years](#in-years)

**Syntax:** y = In Years( \<x=1> )

**Description:** Converts x from a number of years to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Years( 1 );


```

### [Include](#include)

**Syntax:** y = Include( filepath, < \<<Parse Only>, < \<<New Context>, < \<<Names Default to Here> )

**Description:** Executes the JSL in the specified file. If Parse Only is specified, the script is parsed rather than executed. If New Context is specified, the included JSL is executed in its own unique namespace. If both the parent and included scripts use the global namespace, then specify both New Context and Names Default to Here to avoid name collisions.

**JMP Version Added:** Before version 14

```

Include( "$SAMPLE_SCRIPTS/chaosGame.jsl" );


```

### [Include File List](#include-file-list)

**Syntax:** y = Include File List()

**Description:** Returns a list of included files at the point of execution.

**JMP Version Added:** Before version 14

```

y = Include File List();


```

### [Index](#index)

**Syntax:** ii = n1::n2; ii = n1::n2::n3; ii = Index( n1, n2, \<n3=1>)

**Description:** Returns a row matrix that contains the sequence of values from n1 to n2 by increments of n3.

**JMP Version Added:** Before version 14

```

1 :: 10;


```

### [Informat](#informat)

**Syntax:** dt = In Format( s, formatString, < \<<Use Locale(b=1)>, < \<<Restrict > ) dt = In Format( s, "Format Pattern", pattern, < \<<Use Locale(b=1)> )

**Description:** Parses a string of a given format. If the format is a date-time format, the value is expressed as if surrounded by As Date(), returning the date in ddMonyyyy format. The optional \<<Restrict used with the "Best" formatString only allows conversion using integer, decimal, and scientific formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Informat( "07152000", "MMDDYYYY" );


```

**Example 2**

```

Informat( "07.15.2000", "Format Pattern", "<MM>.<DD>.<YYYY>" );


```

**Example 3**

```

Informat( "86.8287° W", "Longitude DDD" );


```

**Example 4**

```

Informat( "123.45%", "Percent" );


```

**Example 5**

```

Show(
    Informat( "1.23e4", "Best" ),
    Informat( "1.23e4", "Best", <<Restrict ),
    Informat( "1989-10-04", "Best" ),
    Informat( "1989-10-04", "Best", <<Restrict )
);


```

### [Inner Product BLAS](#inner-product-blas)

**Syntax:** y = Inner Product BLAS( A, B, ... )

**JMP Version Added:** 17

```

a = [1, 2, 3, -2, 0, -1, 0, 1, 1];
b = [4, 5, 6, -2, 0, -1, 0, 7, 2];
y = Inner Product BLAS( a, b );


```

### [Insert](#insert)

**Syntax:** z = Insert( x, y, <i> )

**Description:** Returns a copy of list x with y inserted at the ith position or appended to the end if the optional i argument is not specified.

**JMP Version Added:** Before version 14

```

z = {11, 22, 33};
z = Insert( z, 99, 2 );


```

### [Insert Into](#insert-into)

**Syntax:** Insert Into( x, y, <i> )

**Description:** Modifies list, associative array, or display box x with y inserted into the collection. Lists and display boxes support an optional i to specify the position, or the items will be appended if the position is not specified. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33};
Insert Into( ex, 99 );
ex;


```

**Example 2**

```

ex = ["a" => 10, "b" => 3, => 0];
Insert Into( ex, "c", 12 );
ex;


```

**Example 3**

```

New Window( "boxes", hlist = H List Box( Button Box( "a" ), Button Box( "b" ) ) );
Wait( 1 );
Insert Into( hlist, Button Box( "c" ) );


```

### [Install MATLAB Dependencies](#install-matlab-dependencies)

**Syntax:** Install MATLAB Dependencies(\<Patch(0|1)>)

**Description:** Installs the required MATLAB dependencies.

**JMP Version Added:** Before version 14

```


If( !Check MATLAB Dependencies(),
    Install MATLAB Dependencies(),
    Print( "Dependencies are installed" )
);


```

### [Integrate](#integrate)

**Syntax:** y = Integrate( expr, varname, lowLimit, upLimit, \<<Tolerance(1e-10), \<<StoreInfo(list), \<<StartingValue(val) )

**Description:** Integrates an expression with respect to a scalar value, using adaptive quadrature method from Gander and Gautschi (2000). If the variable specified with varname has a value assigned to it or the \<<StartingValue() optional argument specifies a starting value, that value is used as a typical value to improve the accuracy of the integral. To specify infinite ranges of integration, set lowLimit, upLimit, or both to missing. If \<<StoreInfo() is specified, the argument of \<<StoreInfo() will contain diagnostics of the numerical integration routine. If \<<Tolerance() is specified, the argument of \<<Tolerance() is used as the tolerance level in the autointegration function used to evaluate the integral. Smaller values result in longer run time but more precise results.

**JMP Version Added:** Before version 14

**Example 1**

```

Integrate( Exp( -x ), x, 0, . );


```

**Example 2**

```

x = 100;
Integrate( Normal Density( x - 100 ), x, ., . );


```

### [Interest Payment](#interest-payment)

**Syntax:** x = Interest Payment( rate, per, nper, pv, \<fv=0>, \<type=0> )

**Description:** Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the IPMT function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Payment( .05 / 12, 30 * 12, 100000 ) - Interest Payment( .05 / 12, 13, 30 * 12, 100000 )
-Principal Payment( .05 / 12, 13, 30 * 12, 100000 );


```

### [Interest Rate](#interest-rate)

**Syntax:** x = Interest Rate( nper, pmt, pv, \<fv=0>, \<type=0>, \<guess=0.1> )

**Description:** Returns the interest rate per period of an annuity. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the RATE function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Interest Rate( 30 * 12, Payment( .05 / 12, 30 * 12, 100000 ), 100000 );


```

### [Internal Rate of Return](#internal-rate-of-return)

**Syntax:** x = Internal Rate of Return( values, \<guess=0.1> ); x = Internal Rate of Return( guess, value1, value2, \<value3, ...> )

**Description:** Returns the internal rate of return for a series of cash flows represented by the numbers in the values argument. Equivalent to the IRR function in Microsoft Excel. The second prototype of the function accepts all scalar arguments.

**JMP Version Added:** Before version 14

```

Internal Rate of Return( [-10000, 1000, 900, 950] );
Internal Rate of Return( .01, -10000, 1000, 900, 950 );


```

### [Interpolate](#interpolate)

**Syntax:** y = Interpolate(x|xmatrix|xlist, x1, y1, x2, y2); y = Interpolate(x | xmatrix | xlist, xmatrix, ymatrix); z = Interpolate({ x, y }, xvector, yvector, zmatrix)

**Description:** Finds the xi arguments that x is between and linearly interpolates the corresponding yi arguments. Note that the xi arguments must be specified in order.

**JMP Version Added:** Before version 14

**Example 1**

```


New Window( "Interpolate",
    window:x = (2 :: 9) * 10;
    window:y = 50 + Sin( (2 :: 9) ) * 40;
    Graph Box(
        Pen Color( "blue" );
        Marker( window:x, window:y );
        Y Function( Interpolate( a, window:x, window:y ), a );
    );
)
;


```

**Example 2**

```

Interpolate( 2.5, [1 2 3], [15, 20, 30] );


```

**Example 3**

```

Interpolate( {.5, .8}, [0 1], [0 1], [10 20, 12 18] );


```

**Example 4**

```


xd = Transpose( Index( 1, 6 * Pi(), 0.3 ) );
yd = Sin( xd );

xd2 = xd + 0.15;
yd2 = Interpolate( xd2, xd, yd );

New Window( "Interpolated values are blue",
    Graph Box(
        X Scale( 1, 6 * Pi() ),
        Y Scale( -1, 1 ),
        For( i = 0, i < N Rows( xd ), i++,
            Pen Color( "red" );
            Circle( {xd[i], yd[i]}, 0.01 );
            Pen Color( "blue" );
            Circle( {xd2[i], yd2[i]}, 0.01 );
        )
    )
);


```

### [Inv](#inv)

**Syntax:** y = Inverse( x ); y = Inv( x )

**Description:** Returns the inverse of the x argument, which must be a square non-singular matrix.

**JMP Version Added:** Before version 14

```

Round( Inverse( [11 22, 33 44] ), 2 );


```

### [Inv Update](#inv-update)

**Syntax:** y = Inv Update( S, X, \<w=1> )

**Description:** Returns an updated inverse matrix, where the first argument S is a symmetric positive definite matrix with the same number of columns as X, the second argument X is a matrix that contains the rows to add or delete, and the third argument w determines whether to add or delete rows (use 1 to add rows and -1 to delete rows). This function evaluates as S-w*S*X`*Inv(I+w*X*S*X`)*X*S, where I is an identity matrix and Inv(A) means an inverse matrix of A.

**JMP Version Added:** Before version 14

```

/* Generate a design matrix */
exX = [1 0 4 2,
1 0 5 1,
1 0 2 4,
5 4 4 5,
0 1 4 3,
0 1 9 1,
0 1 2 4,
0 1 1 9,
0 1 5 2,
0 1 2 1,
0 1 4 5];
S = Inverse( exX` * exX );
Show( "----------Adding Rows (w=1) --------" );
X = [5 4 3 3, 4 3 2 1, 9 1 2 5];
w = 1;
y = Inv Update( S, X, w );
Show( "Result of Inv Update" );
Show( y );
Show( "Result of updating formula" );
Show( S - w * S * X` * Inv( Identity( N Row( X ) ) + w * X * S * X` ) * X * S );
Show( "Result of direct calculation" );
Show( Inverse( (exX |/ X)` * (exX |/ X) ) );
Show( "----------Deleting Rows (w=-1) --------" );
X = [0 1 5 2, 0 1 2 1, 0 1 4 5];
w = -1;
y = Inv Update( S, X, w );
Show( "Result of Inv Update" );
Show( y );
Show( "Result of updating formula" );
Show( S - w * S * X` * Inv( Identity( N Row( X ) ) + w * X * S * X` ) * X * S );
Show( "Result of direct calculation" );
p = N Row( exX ) - 3;
Show( Inverse( exX[Index( 1, p ), 0]` * exX[Index( 1, p ), 0] ) );


```

### [Inverse](#inverse)

**Syntax:** y = Inverse( x ); y = Inv( x )

**Description:** Returns the inverse of the x argument, which must be a square non-singular matrix.

**JMP Version Added:** Before version 14

```

Round( Inverse( [11 22, 33 44] ), 2 );


```

### [Invert Expr](#invert-expr)

**Syntax:** y = Invert Expr( expr, xname, yname )

**Description:** Inverts the expr expression argument, unfolding around the single occurrence of xname.

**JMP Version Added:** Before version 14

```

Invert Expr( Sqrt( Log( x ) ), x, y );


```

### [IRT Ability](#irt-ability)

**Syntax:** y = IRT Ability( Q1, ..., Qn, parmMatrix )

**Description:** Produces scores for the latent variable in an item response theory model with n binary items and a matrix of known parameters, specified by parmMatrix. The parameter matrix should contain as many rows as there are parameters in the model and as many columns as there are items in the analysis.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = dt << Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5 ), Model( "Logistic 2PL" ) );
obj << Save Ability Formula;
Column( dt, N Cols( dt ) ) << Get Formula;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
mth = (dt << get as matrix)[0, Index( 2, 6 )];
mthlst = {};
i = Floor( Random Uniform( 1, N Rows( mth ) ) );
mthlst[1] = mth[i, 1] |/ mth[i, 2] |/ mth[i, 3] |/ mth[i, 4] |/ mth[i, 5];
mthlst[2] = IRT Ability(
    mth[i, 1],
    mth[i, 2],
    mth[i, 3],
    mth[i, 4],
    mth[i, 5],
    [0.28 1.93 1.9 1.67 1, -0.06 -0.55 0.5 -1.89 0.04]
);
mthlst;


```

### [Is Alt Key](#is-alt-key)

**Syntax:** y = Is Alt Key()

**Description:** Returns 1 if the Alt key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts. On the Mac, Alt means Option key.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Control Key(),
            Text( {60, 50}, "Control Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Associative Array](#is-associative-array)

**Syntax:** y = Is Associative Array( x )

**Description:** Returns 1 is the x argument is an associative array, otherwise returns 0.

**JMP Version Added:** Before version 14

```

Is Associative Array( [1 => 2] );


```

### [Is Class](#is-class)

**Syntax:** isns = Is Class( class reference )

**Description:** Returns 1 if the class argument is a class. Otherwise, a 0 is returned.

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
iscl = Is Class( cl );
Show( iscl );
cl << Delete;
Delete Classes( "complex" );


```

### [Is Command Key](#is-command-key)

**Syntax:** y = Is Command Key()

**Description:** Returns 1 if the Command key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Command Key(),
            Text( {60, 50}, "Command Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Context Key](#is-context-key)

**Syntax:** y = Is Context Key()

**Description:** Returns 1 if the Context key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Context Key(),
            Text( {60, 50}, "Context Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Control Key](#is-control-key)

**Syntax:** y = Is Control Key()

**Description:** Returns 1 if the Control key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts. On the Mac, Control means Command key.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Control Key(),
            Text( {60, 50}, "Control Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Directory](#is-directory)

**Syntax:** rc = Is Directory( path )

**Description:** Determine if the given path is a directory. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Is Directory( "$SAMPLE_DATA" );
rc1 = Is Directory( "$SAMPLE_DATA/Big Class.jmp" );
Char( rc0 ) || " " || Char( rc1 );/* 1 0 */


```

### [Is Directory Writable](#is-directory-writable)

**Syntax:** rc = Is Directory Writable( path )

**Description:** Determine if the given directory path is writable. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Is Directory Writable( "$SAMPLE_DATA" );


```

### [Is Empty](#is-empty)

**Syntax:** y = Is Empty( name )

**Description:** Returns 1 if the variable is undefined or holds the Empty() value.

**JMP Version Added:** Before version 14

**Example 1**

```

Is Empty( x );


```

**Example 2**

```

x = Empty();
Is Empty( x );


```

**Example 3**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
If( Is Empty( dt ),
    Print( "There is no open data table." ),
    Print( "This data table is open: " || (dt << Get Name()) )
);
Wait( 1 );
Close( DT, "nosave" );
Wait( 1 );
If( Is Empty( dt ),
    Print( "There is no open data table." ),
    Print( "This data table is open: " || (dt << Get Name()) )
);


```

### [Is Expr](#is-expr)

**Syntax:** y = Is Expr( x )

**Description:** Returns 1 if the x argument is an expression, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Expr( Expr( x ) );


```

### [Is File](#is-file)

**Syntax:** rc = Is File( path )

**Description:** Determine if the given path is a file. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Is File( "$SAMPLE_DATA" );
rc1 = Is File( "$SAMPLE_DATA/Big Class.jmp" );
Char( rc0 ) || " " || Char( rc1 );/* 0 1 */


```

### [Is File Writable](#is-file-writable)

**Syntax:** rc = Is File Writable( path )

**Description:** Determine if the given file path is writable. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Is File Writable( "$SAMPLE_DATA/Big Class.jmp" );


```

### [Is JMP Live URL Enabled](#is-jmp-live-url-enabled)

**Syntax:** Is JMP Live URL Enabled(url)

**Description:** Determines if the specified URL can be used in this JMP session. URLs can be enabled and/or disabled using the jmpStartAdmin.jsl script. This does not determine if it is a valid URL, nor if the user is able to login. It only determines if the URL is blocked by JMP.

**JMP Version Added:** 15

```


url = "http://public.jmp.com";
Show( Is JMP Live URL Enabled( url ) );


```

### [Is Leap Year](#is-leap-year)

**Syntax:** v = Is Leap Year(year)

**Description:** Return whether a given year is a leap year.

**JMP Version Added:** 15

```

v = Is Leap Year( 2016 );


```

### [Is List](#is-list)

**Syntax:** y = Is List( x )

**Description:** Returns 1 if the x argument is a list, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is List( {1, 2, 3} );


```

### [Is Log Open](#is-log-open)

**Syntax:** Is Log Open()

**Description:** Return result to indicate whether the log window is open

**JMP Version Added:** Before version 14

**Example 1**

```

If( Is Log Open(),
    Close Log()
);


```

**Example 2**

```

If( !Is Log Open(),
    Open Log()
);


```

### [Is Matrix](#is-matrix)

**Syntax:** y = Is Matrix( x )

**Description:** Returns 1 if the argument is a matrix, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Matrix( [11 22 33] );


```

### [Is Missing](#is-missing)

**Syntax:** y = Is Missing( x )

**Description:** Returns 1 if the x argument is a missing value; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Missing( . );


```

### [Is Name](#is-name)

**Syntax:** y = Is Name( x )

**Description:** Returns 1 if the x argument is a name, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Name( Name Expr( n ) );


```

### [Is Namespace](#is-namespace)

**Syntax:** isns = Is Namespace( namespace reference )

**Description:** Returns 1 if the namespace argument is a namespace; otherwise a 0 is returned.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
isns = Is Namespace( ns );
Show( isns );
ns << Delete;


```

### [Is Number](#is-number)

**Syntax:** y = Is Number( x )

**Description:** Returns 1 if the x argument is a number, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Number( 213 );


```

### [Is Option Key](#is-option-key)

**Syntax:** y = Is Option Key()

**Description:** Returns 1 if the Option key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Option Key(),
            Text( {60, 50}, "Option Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Same Color](#is-same-color)

**Syntax:** x = Is Same Color( color1, color2, ... )

**Description:** Compares colors for equality.

**JMP Version Added:** 18

**Example 1**

```

Is Same Color( "black", 0 );


```

**Example 2**

```

Is Same Color( "red", "green", "blue" );


```

**Example 3**

```

Is Same Color( "red", To Color Space( "hls", "red" ) );


```

**Example 4**

```

Is Same Color( To Color Space( "LUV", "red" ), "red" );


```

### [Is Scriptable](#is-scriptable)

**Syntax:** tf = Is Scriptable( x )

**Description:** Returns 1 if the x argument is a scriptable object, 0 otherwise.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Is Scriptable( Bivariate( Y( :weight ), X( :height ) ) );


```

### [Is Shift Key](#is-shift-key)

**Syntax:** y = Is Shift Key()

**Description:** Returns 1 if the Shift key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Control Key(),
            Text( {60, 50}, "Control Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is String](#is-string)

**Syntax:** y = Is String( x )

**Description:** Returns 1 if the x argument is a string, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is String( "abc" );


```

### [ISO Year](#iso-year)

**Syntax:** yr = ISO Year( datetime )

**Description:** Returns the ISO Year of a date-time value. ISO Years correspond to ISO Weeks; they begin on the Monday of the first week containing at least four days.

**JMP Version Added:** 16

```

ISO Year( Today() );


```

### [Item](#item)

**Syntax:** w = Item( n|[first last], s, <delim>, \<Unmatched(result string)>, \<Include Boundary Delimiters(0|1)>)

**Description:** Returns the nth item of the s argument, where items are the (possibly empty) sub-strings separated by exactly one of any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate item.

**JMP Version Added:** Before version 14

**Example 1**

```

Item( 5, "http://www.jmp.com", ":/." );


```

**Example 2**

```

Item( [2 -1], "This is a sentence" );


```

**Example 3**

```

Item( 4, "Apple+Banana Tree,,Pear,,Peach,,Grape", Get Punctuation Characters() );


```

**Example 4**

```

Item( 5, "a b c d", Unmatched( "None" ) );


```

**Example 5**

```

Item( 2, "abcd", "" );


```

**Example 6**

```

Item( 2, ",abcd", ",", Include Boundary Delimiters );


```

### [Items](#items)

**Syntax:** wl = Items(\<[first last]>, s, <delim>, \<Include Boundary Delimiters(0|1)>)

**Description:** Returns a list of (possibly empty) sub-strings separated by exactly one of any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate item.

**JMP Version Added:** 15

**Example 1**

```

Eval List( {Items( "http://www.jmp.com", ":/." ), Items( "hello", "" )} );


```

**Example 2**

```

Items( ",Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

**Example 3**

```

Items(
    ",Apple,Banana Tree,Peach",
    Get Punctuation Characters(),
    Include Boundary Delimiters
);


```

**Example 4**

```

Items( [1 2], ",Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

### [J](#j)

**Syntax:** y = J( nr, <nc>, <v> ); y = J( nr, nc ); y = J( n )

**Description:** Creates a matrix (nr by nc) of values that are determined by the third argument. The default value of the second argument equals the first argument. The default value of the third argument is 1. But the third argument can be a number, a variable name of a number, or JSL code. If the third argument is code, the code is evaluated and assigned the return value to every element in the matrix, element by element, row by row.

**JMP Version Added:** Before version 14

```


// Produce a 2x3 matrix, filled with 15.
m = J( 2, 3, 15 );
// Produce a default 4x4 matrix, filled with 1.
m = J( 4 );
// Produce a 2x3 matrix, filled with a number determined by a variable.
a = 3.14;
m = J( 2, 3, a );
// Produce a vector of random numbers from the Uniform distribution.
m = J( 1, 100, Random Uniform() );
// Produce a 2x3 matrix, filled with a sequence of integers.
a = 0;
m = J( 2, 3, a = a + 1 );
// This is a fun example to illustrate what is possible for the third argument.
i = 1;
J(
    10,
    1,
    Print(
        Eval Insert(
            "For the ^i^^if(i < 4, words(\!"st,nd,rd\!",\!",\!")[i], \!"th\!")^ time, I'm not a loop!"
        )
    );
    Round( 1 / Sqrt( 5 ) * ((1 + Sqrt( 5 )) / 2) ^ i++ );
);


```

### [JMP Product Name](#jmp-product-name)

**Syntax:** y = JMP Product Name()

**Description:** Returns "Standard" or "Pro" based on the version of the product that has been licensed.

**JMP Version Added:** Before version 14

```

JMP Product Name();


```

### [JMP Version](#jmp-version)

**Syntax:** y = JMP Version()

**Description:** Returns the JMP version (release.revision{.fix}); not available before 6.0.

**JMP Version Added:** Before version 14

```

JMP Version();


```

### [Johnson Sb Density](#johnson-sb-density)

**Syntax:** y = Johnson Sb Density( q, gamma, delta, theta, sigma )

**Description:** Returns the density at q of a Johnson Sb distribution, where q is in the interval theta to theta + sigma, delta>0 and gamma between -∞ and +∞ are shape parameters, sigma>0 is a scale parameter, and theta between -∞ and +∞ is a threshold parameter. Note: theta is the lower endpoint of the distribution and sigma is the range of the support of the distribution.

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 0.5;
theta = 0.5;
sigma = 1;
New Window( "Example: Johnson Sb Density",
    jsbp = Graph Box(
        Y Scale( 0, 5.5 ),
        X Scale( 0.2, 1.8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sb Density( q, gamma, delta, theta, sigma ), q );
        Text(
            {0.5, 4.5},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsbp << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, jsbp << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( -2, 2, theta, jsbp << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 10, sigma, jsbp << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Sb Distribution](#johnson-sb-distribution)

**Syntax:** p = Johnson Sb Distribution( q, gamma, delta, theta, sigma )

**Description:** Returns the probability that a Johnson Sb distributed random variable is less than q. (Note: see the Johnson Sb Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 0.5;
theta = 0.5;
sigma = 3;
New Window( "Example: Johnson Sb Distribution",
    jsbc = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0.2, 3.8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sb Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {0.3, 0.8},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsbc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 1, delta, jsbc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 1, theta, jsbc << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 4, sigma, jsbc << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Sb Quantile](#johnson-sb-quantile)

**Syntax:** q = Johnson Sb Quantile( p, gamma, delta, theta, sigma )

**Description:** Returns the quantile from a Johnson Sb distribution, the value for which the probability is p that a random value would be lower. (Note: p is the first parameter. See the Johnson Sb Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

Johnson Sb Quantile( 0.5, 0.5, 1, 1, 1 );


```

### [Johnson Sl Density](#johnson-sl-density)

**Syntax:** y = Johnson Sl Density( q, gamma, delta, theta, \<sigma=1> )

**Description:** Returns the density at q of a Johnson Sl distribution, where q is in the interval theta to +∞, delta>0 and gamma between -∞ and +∞ are shape parameters, sigma equal to +1 or -1 is a scale parameter, and theta between -∞ and +∞ is a threshold parameter. Note: When sigma = 1, theta is the lower bound on the distribution, and when sigma=-1, theta is the upper bound. Also, positive sigma implies positive skew, and negative sigma implies negative skew.

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 0;
sigma = 1;
New Window( "Example: Johnson Sl Density",
    jslp = Graph Box(
        Y Scale( 0, 1.5 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sl Density( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 1.1},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 )
        );
    ),
    jslpcb = Check Box(
        {"\!U03C3 = +1 (Note: When unchecked \!U03C3 = -1)"},
        <<set( 1 ),
        sigma = [-1, 1][((jslpcb << get()) + 1)];
        jslp << reshow;
    ),
    H List Box( Slider Box( -15, 15, gamma, jslp << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 10, delta, jslp << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( -5, 5, theta, jslp << reshow ), Text Box( " \!U03B8" ) )
);


```

### [Johnson Sl Distribution](#johnson-sl-distribution)

**Syntax:** p = Johnson Sl Distribution( q, gamma, delta, theta, \<sigma=1> )

**Description:** Returns the probability that a Johnson Sl distributed random variable is less than q. (Note: see the Johnson Sl Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 0;
sigma = 1;
New Window( "Example: Johnson Sl Distribution",
    jslc = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sl Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 0.9},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 )
        );
    ),
    jslccb = Check Box(
        {"\!U03C3 = +1 (Note: When unchecked \!U03C3 = -1)"},
        <<set( 1 ),
        sigma = [-1, 1][((jslccb << get()) + 1)];
        jslc << reshow;
    ),
    H List Box( Slider Box( -15, 15, gamma, jslc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 10, delta, jslc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( -5, 5, theta, jslc << reshow ), Text Box( " \!U03B8" ) )
);


```

### [Johnson Sl Quantile](#johnson-sl-quantile)

**Syntax:** q = Johnson Sl Quantile( p, gamma, delta, theta, \<sigma=1> )

**Description:** Returns the quantile from a Johnson Sl distribution, the value for which the probability is p that a random value would be lower. (Note: p is the first parameter. See the Johnson Sl Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

Johnson Sl Quantile( 0.5, 0.5, 1, 1, 1 );


```

### [Johnson Su Density](#johnson-su-density)

**Syntax:** y = Johnson Su Density( q, gamma, delta, theta, sigma )

**Description:** Returns the density at q of a Johnson Su distribution, where q is between -∞ and +∞, delta>0 and gamma between -∞ and +∞ are shape parameters, sigma>0 is a scale parameter, and theta between -∞ and +∞ is a threshold parameter.

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 1;
sigma = 1;
New Window( "Example: Johnson Su Density",
    y = Graph Box(
        Y Scale( 0, 1.5 ),
        X Scale( -2, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Su Density( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 1.3},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, y << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, y << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 2, theta, y << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 2, sigma, y << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Su Distribution](#johnson-su-distribution)

**Syntax:** p = Johnson Su Distribution( q, gamma, delta, theta, sigma )

**Description:** Returns the probability that a Johnson Su distributed random variable is less than q. (Note: see the Johnson Su Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 1;
sigma = 1;
New Window( "Example: Johnson Su Distribution",
    jsuc = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -2, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Su Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 0.9},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsuc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, jsuc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 2, theta, jsuc << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 2, sigma, jsuc << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Su Quantile](#johnson-su-quantile)

**Syntax:** q = Johnson Su Quantile( p, gamma, delta, theta, sigma )

**Description:** Returns the quantile from a Johnson Su distribution, the value for which the probability is p that a random value would be lower. (Note: p is the first parameter. See the Johnson Su Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

Johnson Su Quantile( 0.5, 0.5, 1, 1, 1 );


```

### [Journal Box](#journal-box)

**Syntax:** y = Journal Box( journalText )

**Description:** Constructs a display box from instructions that would be stored in a journal.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
sample = Distribution( Y( :height ) );
sampjourn = sample << Get Journal;
New Window( "Distribution of Height",
    Text Box( "Here is the result of the distribution platform for Height." ),
    Journal Box( sampjourn )
);


```

### [JSL Encrypted](#jsl-encrypted)

**Syntax:** y = JSL Encrypted(script)

**Description:** Embeds an encrypted script within another script. Create an encrypted script by selecting Edit > Encrypt Script from the main menu of a script editor. Enter your passwords and the encrypted text will appear in a new window. Copy this text into a JSL Encrypted("") command to embed the encrypted script in another script.

**JMP Version Added:** Before version 14

```

JSL Encrypted(
    "//-e6.0.2\!NWUSXEHSB?SRAMXPSY?;KDGMNGPQFZP;?><JLEXCQZYIGWSI@<FOPBLDKJ?HEUPTOGSZDYWFDMB;NEVB;HFP=VQ@N;LCVQPWRHIXEIPFKGO=H?DWS?KFQRIPBEPSAE<AM?YG=C@VFRENPEW>@;ND=JA<?=WOZZOG>FZBZKZLMFOX?YF@LWA=B=SJXDGVW>VYLBRJT<I<MFE<Q??QCUOZM?RY>RXLBJRH=BH<EGVSEMABSS<IE=CAPID;XM;;?XIU<FA=SCE<CB;AGOCZWHZXK;*"
);


```

### [JSL Quote](#jsl-quote)

**Syntax:** y = JSL Quote(script)

**Description:** Store a JSL script in a variable, including all comments and formatting.

**JMP Version Added:** Before version 14

```


x = JSL Quote(/* Begin quote. */
    For (i = 1, i <= 5, i++,
        // Print the value of i.
        Print(i);
    );
    // End expression.
);
New Window( "editor", Script Box( x ) );


```

### [JSON Literal](#json-literal)

**Syntax:** l = JSON Literal( string )

**Description:** Returns a valid JSON Boolean or null constant value depending on the specification of the parameter.

**JMP Version Added:** 14

```


myJSON =
"{ \!"myChar\!": \!"Character Value\!", \!"myNum\!": 12345, \!"myBool\!": true, \!"myOtherChar\!": \!"Another char value\!", \!"myNull\!": null, \!"x\!": 54321, \!"myOtherBool\!": false, \!"y\!": \!"Hello\!" }";
parsed = Parse JSON( myJSON );
x = parsed["myBool"];
Show( x );
If( x == JSON Literal( true ),
    Show( "Worked" ),
    Show( "Didn't work" )
);


```

### [JSON To Data Table](#json-to-data-table)

**Syntax:** dt = JSON To Data Table( jsonstring, \<Invisible( boolean ) | Private( boolean )>, \<Guess(Stack(Boolean)|"Tall"|"Wide")>, \<JSON Settings(...)> )

**Description:** Convert JSON text to a JMP data table

**JMP Version Added:** 14

```

dt = JSON To Data Table(
    "[ { \!"name\!": \!"KATIE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 59, \!"weight\!": 95 }, { \!"name\!": \!"LOUISE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 61, \!"weight\!": 123 }, { \!"name\!": \!"JANE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 55, \!"weight\!": 74 } ]"
);


```

### [JSON To List](#json-to-list)

**Syntax:** l = JSON To List( jsonstring )

**Description:** Convert JSON text to a JSL list representing the structure specified by the JSON data.

**JMP Version Added:** Before version 14

```

l = JSON To List(
    "[ { \!"name\!": \!"KATIE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 59, \!"weight\!": 95 }, { \!"name\!": \!"LOUISE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 61, \!"weight\!": 123 }, { \!"name\!": \!"JANE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 55, \!"weight\!": 74 } ]"
);
Show( l );


```

### [KDE](#kde)

**Syntax:** {Estimates, Bins, Counts, ActualBandwidth, Error} = KDE( Vector, \<<weights, \<<bandwidth( 0 ), \<<bandwidth scale( 1 ), \<<bandwidth selection( 0 ), \<<kernel )

**Description:** Returns a kernel density estimator with automatic bandwidth selection. The optional weights argument must be a vector of the same length as the Vector argument. The optional bandwidth argument must be a nonnegative real number or zero, which forces the use of the value of the bandwidth selection argument. The optional bandwidth scale argument must be a positive real number. The optional bandwidth selection argument must be either 0, 1, 2, or 3, corresponding to Sheather and Jones, Normal Reference, Silverman rule of thumb, or Oversmoother, respectively. The optional kernel argument accepts the values 0, 1, 2, 3, or 4, corresponding to Gaussian, Epanechnikov, Biweight, Triangular, or Rectangular, respectively.

**JMP Version Added:** Before version 14

```

// generate sample dataset from a mixture of 3 normal distributions
ndata3 = 25;
Random Reset( 113 );
channel = J( 1, ndata3 * 3, 0 );
For( i = 1, i <= ndata3, i++,
    channel[1, i] = Random Normal() - 3;
    channel[1, ndata3 + i] = Random Normal() / 2;
    channel[1, ndata3 + ndata3 + i] = Random Normal() + 3;
);

// use kernel density estimator to estimate the underlying distribution
bw = .; // automatic bandwidth
bscl = 1; // bandwidth multiplier
bsel = 0; // Sheather and Jones bandwith selection

// Create data table with estimates from all smoothing KDEs and Bins
dt = New Table( "KDE Smoothing",
    New Column( "Kernel", "Character" ),
    New Column( "Bin" ),
    New Column( "Density Estimate" ),
    New Column( "Counts" )
);

kernels = {"Gaussian", "Epanechnikov", "Biweight", "Triangular", "Rectangular"};
For( kernel = 0, kernel < N Items( kernels ), kernel++,
    res = KDE(
        channel,
        <<bandwidth( bw ),
        <<bandwidth scale( bscl ),
        <<bandwidth selection( bsel ),
        <<kernel( kernel )
    );
    nbin = N Items( res["Bins"] );
    rows = (N Rows( dt ) + 1) :: (N Rows( dt ) + nbin);
    dt << Add Rows( nbin );
    dt[rows, "Kernel"] = kernels[kernel + 1];
    dt[rows, "Bin"] = res["Bins"]`;
    dt[rows, "Density Estimate"] = res["Estimates"]`;
    dt[rows, "Counts"] = res["Counts"]`;
);

dt << Graph Builder(
    Size( 1000, 376 ),
    Show Control Panel( 0 ),
    Legend Position( "Bottom" ),
    Variables(
        X( :Bin ),
        Y( :Density Estimate, Side( "Right" ) ),
        Y( :Counts, Position( 1 ) ),
        Overlay( :Kernel )
    ),
    Elements(
        Bar( X, Y( 2 ), Overlay( 0 ), Legend( 2 ), Bar Style( "Needle" ) ),
        Line( X, Y( 1 ), Legend( 3 ) )
    )
);


```

### [KDTable](#kdtable)

**Syntax:** tab = KDTable( [ 1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6 ] )

**Description:** Returns a table for efficiently looking up near neighbors. The matrix arguments are k-dimensional points. There is no built in limit on the number of dimensions or points.

**JMP Version Added:** Before version 14

```

tab = KDTable( [1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6] );
{rows, dist} = tab << K nearest rows( 2, 1 );
"2 nearest rows to row 1 are " || Char( rows );


```

### [Labeled](#labeled)

**Syntax:** y = Labeled( <rs> ); Labeled( \<Row State( <r> )> ) = y

**Description:** Returns the labeled component of the specified row state value, 0 or 1. If Labeled is used as an L-value, it changes the labeled state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Labeled State( 1 );
Labeled( Row State( 3 ) );
Row() = 3;
Labeled();


```

### [Labeled State](#labeled-state)

**Syntax:** rs = Labeled State( x )

**Description:** Returns a row state value with the labeled component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Labeled State( 1 );
Labeled( Row State( 3 ) );


```

### [Lag](#lag)

**Syntax:** y = Lag( <x>, \<n=1> )

**Description:** Returns the value of the x argument with the current row set to Row() - n. Being dependent on Row(), Lag() is mainly useful in column formulas.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 3;
Lag( :height, 2 );


```

### [Last Modification Date](#last-modification-date)

**Syntax:** date = Last Modification Date( path )

**Description:** Returns the last modification date of a file or directory. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Format( Last Modification Date( "$SAMPLE_DATA/Big Class.jmp" ), "ddmonyyyy:h:m:s" );


```

### [Least Squares Solve](#least-squares-solve)

**Syntax:** {Beta, VarBeta} = Least Squares Solve(y, X, \<<noIntercept, \<<weights(optionalWeightVector), \<<method("Sweep"|"GInv"))

**Description:** Returns a list that contains a vector of estimates, Beta = Inverse(X'X)X'y, and the estimated variance matrix of Beta. The optional \<<noIntercept argument specifies a no-intercept model. The optional \<<weights argument specifies a vector of weights to perform weighted least squares. The optional \<<method argument enables you to choose between the default Sweep method and a generalized inverse ("GInv") method for solving the normal equations.

**JMP Version Added:** Before version 14

```

/*Simple Linear Regression*/
y = [3, 5, 7, 5];
X = [1, 2, 3, 4];
{Beta, VarBeta} = Least Squares Solve( y, X );


```

### [Left](#left)

**Syntax:** sub = Left( s, n, <filler> )

**Description:** Returns a truncated or padded version of the original string or list s. The result contains the left n characters or list items, padded with any filler on the right if the length of s is less than n.

**JMP Version Added:** Before version 14

```

exurl = "http://www.jmp.com";
Left( exurl, Contains( exurl, ":" ) - 1 );


```

### [Length](#length)

**Syntax:** l = Length( x )

**Description:** Returns the length of the given string (in characters), list (in items), associative array (in number of keys), blob (in bytes), matrix (in elements), or namespace/class (in number of functions and variables).

**JMP Version Added:** Before version 14

**Example 1**

```

Length( "Café" );


```

**Example 2**

```

Length( {1, 2 + 3, [11 22]} );


```

**Example 3**

```

Length( ["a" => 10, "b" => 3, => 0] );


```

**Example 4**

```

Length( Char To Blob( "Café" ) );


```

### [LenthPSE](#lenthpse)

**Syntax:** y = LenthPSE( x )

**Description:** Returns Lenth's pseudo-standard error of the values within a single vector x.

**JMP Version Added:** Before version 14

```

Eval List( {LenthPSE( [1, 2, 3, 4, 5] ), Std Dev( [1, 2, 3, 4, 5] )} );


```

### [Less](#less)

**Syntax:** z = x < y < ... ; z = Less( x, y, ... )

**Description:** Returns 1 if each argument is less than the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

[1 1 1] < [0 1 2];


```

### [Less LessEqual](#less-lessequal)

**Syntax:** z = x < y \<= ... ; z = Less LessEqual( x, y, ... )

**Description:** Returns 1 if the first argument is less than the second argument and each argument except the first is less than or equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 < 2 <= 2;


```

### [Less or Equal](#less-or-equal)

**Syntax:** z = x \<= y \<= ... ; z = Less or Equal( x, y, ... )

**Description:** Returns 1 if each argument is less than or equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 <= 2 <= 2;


```

### [LessEqual Less](#lessequal-less)

**Syntax:** z = x \<= y < ... ; z = LessEqual Less( x, y, ... )

**Description:** Returns 1 if the first argument is less than or equal to the second argument and each argument except the first is less than the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

2 <= 2 < 3;


```

### [LEV Density](#lev-density)

**Syntax:** y = LEV Density( x, mu, sigma )

**Description:** Returns the density at x of a largest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 10;
sig = 5;
New Window( "Example: LEV Density",
    y = Graph Box(
        Y Scale( 0, .08 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( LEV Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [LEV Distribution](#lev-distribution)

**Syntax:** p = LEV Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a largest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 10;
sig = 5;
New Window( "Example: LEV Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( LEV Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [LEV Quantile](#lev-quantile)

**Syntax:** q = LEV Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a largest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 10;
sig = 5;
qq = .5;
New Window( "Example: LEV Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( LEV Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( LEV Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 80, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Level Color](#level-color)

**Syntax:** y = Level Color( i ); y = Level Color( i, n ); y = Level Color( i, n, <theme> ); y = Level Color( i, <theme> )

**Description:** Returns a category color, where i is the category level; n is the number of categories (optional); and theme are the color themes in the Column Info dialog's Value Color combo box. ("JMP Default" is the default theme.) The category index must be >= 1 and \<= the number of categories specified in the call or defined by the theme. If the second argument is a character, it is the color theme and n is unspecified.

**JMP Version Added:** Before version 14

```

New Window( "Color Bar",
    Graph(
        For( x = 1, x <= 100, x += 5,
            Fill Color( Level Color( x, 100, "Green to Black to Red" ) );
            Rect( x - 5, 45, x + 5, 55, 1 );
        )
    )
);


```

### [LGamma](#lgamma)

**Syntax:** y = LGamma( x )

**Description:** Returns the natural logarithm of the Gamma function of x. Useful when Gamma(x) is too large to use directly.

**JMP Version Added:** Before version 14

```

LGamma( 5 );


```

### [Line](#line)

**Syntax:** Line( {x1, y1}, {x2, y2}, ..., < \<<Value Space( 0|1 ) >, < \<<Smooth( tension, domain, min response, max response ) > ); Line( xMatrix, yMatrix, < \<<Value Space(0 | 1) >, < \<<Smooth( tension, domain, min response, max response ) > )

**Description:** Draws a line or connected lines. In the default case, the line is drawn linearly between the endpoints. If the Value Space option is set, the line follows the projection specified by the underlying axis scales. If the Smooth option is set, connections are smoothed, constrained by tension, domain dimension, min response, and max response.

**JMP Version Added:** Before version 14

**Constrained smoothing**

```

New Window( "Constrained smoothing",
    Graph Box(
        Pen Color( "gray" );
        H Line( 90 );
        H Line( 92 );
        H Line( 10 );
        H Line( 8 );
        Pen Color( "red" );
        Line( Index( 10, 90, 10 ), [20 10 90 90 60 70 10 10 40], <<Smooth( . ) );
        Pen Color( "blue" );
        Line( Index( 10, 90, 10 ), [20 10 90 90 60 70 10 10 40], <<Smooth( ., "X", 8, 92 ) );
    )
);


```

**Polyline**

```

New Window( "Example", Graph Box( Line( [10 30 90], [88 22 44] ) ) );


```

**Smoothing**

```

New Window( "Smoothing",
    Graph Box(
        XAxis( Min( 0 ), Max( 10 ), Inc( 2 ) ),
        YAxis( Min( -1.1 ), Max( 1.1 ), Inc( 1 ) ),
        Pen Color( "gray" );
        H Line( 1 );
        H Line( -1 );
        H Line( 0 );
        Line( 0 :: 10, Sin( 0 :: 10 ) );
        Pen Color( "red" );
        Line( 0 :: 10, Sin( 0 :: 10 ), <<Smooth( . ) );
        Pen Color( "blue" );
        Line( 0 :: 10, Sin( 0 :: 10 ), <<Smooth( 0.25 ) );
    )
);


```

**Value space interpolation**

```

New Window( "Interpolate in value space",
    Graph Box(
        XAxis( Scale( "Log" ), Min( 10 ), Max( 100 ) ),
        YAxis( Scale( "Log" ), Min( 10 ), Max( 100 ) ),
        Line( [10 30 90], [88 22 44], <<Value Space( 1 ) )
    )
);


```

### [Line Seg](#line-seg)

**Syntax:** ls = Line Seg(x values, y values, \<Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) >, < Sizes( s ) > )>)

**Description:** Returns a display seg with lines connecting all of the x and y values.

**JMP Version Added:** Before version 14

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Line Seg" ));


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y, RowStates( dt ) ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Line Seg" ));


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example",
    g = Graph Box( Line Seg( x, y, RowStates( dt, {1, 3, 5} ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Line Seg" ));


```

### [Line Style](#line-style)

**Syntax:** Line Style( x )

**Description:** Sets the current line style, which can be one of: 0 (Solid), 1 (Dotted), 2 (Dashed), 3 (DashDot), or 4 (DashDotDot).

**JMP Version Added:** Before version 14

```

New Window( "Line Style Example",
    Graph Box(
        Frame Size( 500, 400 ),
        named line styles = {"Solid", "Dotted", "Dashed", "Dash Dot", "Dash Dot Dot",
        "Dash Dash Dot", "Dash Dash Dot Dot", "Long Dash", "Long Dash Dash", "Dense Dash",
        "Sparse Dash", "Sparse Dot", "Sparse Dash Dot"};
        For Each( {istyle, i}, named line styles, {x = 5 :: 75, y = 12 * Sin( x / 12 )},
            Text( {x[N Items( x )] + 1, y[N Items( y )] + 92 - 6 * i - 1.5}, istyle );
            Line Style( istyle );
            Pen Size( 2 );
            Line( x, y + 92 - 6 * i );
        );
    )
);


```

### [Linear Regression](#linear-regression)

**Syntax:** {Estimates, Std_Error, Diagnostics} = Linear Regression(y, X, \<<noIntercept, \<<printToLog, \<<weight(WeightVector), \<<freq(FrequencyVector)

**Description:** Fits a linear regression for the assumed model y = X * beta + error. The optional \<<noIntercept argument specifies a no-intercept model. The optional \<<printToLog argument specifies that a summary of fit is printed to the log window. The optional weight argument specifies a vector of weights to perform weighted least squares, and the optional freq argument specifies a vector of frequencies. Returns a list containing a vector of the estimates, a vector of the standard errors, and a list of diagnostics. The list of diagnostics contains vectors of the t statistics and p-values for the estimates, as well as the R-Square and adjusted R-Square values for the regression fit.

**JMP Version Added:** 14

**Example 1**

```

/*Simple Linear Regression: y = intercept + beta * x + error*/
y = [3, 5, 7, 5];
X = [1, 2, 3, 4];
{Estimates, Std_Error, Diagnostics} = Linear Regression( y, X, <<printToLog ); 
/*
t_ratio = Diagnostics["t_ratio"]; 
p_value = Diagnostics["p_value"]; 
RSquare = Diagnostics["RSquare"]; 
RSquare Adj = Diagnostics["RSquare Adj"];
*/


```

**Example 2**

```

/*Model: y = beta_1*x + beta_2*x^2 + error*/
y = [3, 5, 7, 5];
X = [1 1, 2 4, 3 9, 4 16];
{Estimates, Std_Error, Diagnostics} = Linear Regression( y, X, <<noIntercept, <<printToLog );


```

**Example 3**

```

/*Categorical Variable Example*/
/*Model: y = beta_1*boy + beta_2*girl + beta_3*x + error*/
y = [3, 5, 7, 5];
x = [1, 2, 3, 4];
gender = {"boy", "girl", "girl", "boy"};
designMat = Design( gender ) || x;
{Estimates, Std_Error, Diagnostics} = Linear Regression(
    y,
    designMat,
    <<noIntercept,
    <<printToLog
);


```

### [Lines Seg](#lines-seg)

**Syntax:** ls = Lines Seg([x1 y1 x2 y2,...])

**Description:** Returns a display seg with a sequence of line segments for the passed in x and y values.

**JMP Version Added:** Before version 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Lines Seg" ));


```

### [Lineup Box](#lineup-box)

**Syntax:** y = Lineup Box( \<NCol( nc )>, \<Spacing( pixels, <vspace> )>, displayBoxArgs, ... )

**Description:** Returns a display box to show an alignment of boxes in nc columns. The optional Spacing argument specifies the horizontal and vertical space around the display boxes. If the vspace argument is used, vspace is the vertical space and pixels is the horizontal space.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 1 ), spacing( 10 ),
        Text Box( "Quadratic Formula" ),
        Border Box( Left( 10 ), Right( 10 ), bottom( 10 ), top( 10 ), sides( 15 ),
            Expr As Picture( Expr( (-b + Sqrt( b ^ 2 - 4 * a * c )) / (2 * a) ) )
        )
    )
);


```

### [Lineup Ruler Box](#lineup-ruler-box)

**Syntax:** y = Lineup Box( \<Widths( {width1, width2, ...} )>, displayBoxArgs, ... )

**Description:** Returns a display box that sets the column widths of the Lineup Boxes that it contains.

**JMP Version Added:** 16

```


New Window( "Lineup Ruler",
    lrb = Lineup Ruler Box(
        Widths( {120, 200} ),
        Outline Box( "Customer 1",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(), 

            )
        ),
        Outline Box( "Customer 2",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(), 

            )
        )
    )
);


```

### [List](#list)

**Syntax:** y = {a, b, ...}; y = List( a, b, ... )

**Description:** Creates a list of items without evaluating them.

**JMP Version Added:** Before version 14

```

{1, 2 + 3, [11 22]};


```

### [List Box](#list-box)

**Syntax:** y = List Box( {item, ...}, \<width( pixels )>, \<maxSelected( 9999 )>, \<nlines( 12 )>, <script> )

**Description:** Returns a display box to show a list box of selection items. If item itself is a two-item list containing the item name and a string specifying a modeling type or sorting order, such as "Ordinal" or "Ascending", the appropriate icon will show up next to that item in the list box.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example", b = List Box( {"single", "double", "triple"}, nlines( 10 ) ) );


```

**Example 2**

```

New Window( "Example",
    lb = List Box(
        {{"First Item", "continuous"}, {"Second Item", "ordinal"}, {"Third Item", "nominal"}},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);


```

### [Ln](#ln)

**Syntax:** y = Ln( x )

**Description:** Returns the natural logarithm of x.

**JMP Version Added:** Before version 14

```

Ln( Exp( 2 ) );


```

### [Load DLL](#load-dll)

**Syntax:** dll = Load DLL( file path | Base Name( file path without extension ), < AutoDeclare( bool | Quiet | Verbose) | Quiet | Verbose )> )

**Description:** Loads a DLL pointed to by the specified path.

**JMP Version Added:** Before version 14

**Cross platform using Base Name()**

```

dll = Load DLL( Base Name( "/path/to/dll/financial" ) );
// Loads "financial.dll" on Windows and "libfinancial.dylib" on Mac
// Declarations for "irr" and "npv" are auto-loaded
myirr = dll << irr( 0.1, -51000, 1000, 900, 950 );
mynpv = dll << npv( 0.05, -51000, 1000, 900, 9500 );
dll << UnloadDLL();


```

**Windows only**

```

If( Host is( "Windows" ),
    dll = Load DLL( "C:/Windows/System32/User32.DLL" );
    dll << CallDLL( "MessageBeep", "n", 0 );
    Wait( 1 );
    dll << CallDLL( "MessageBeep", "n", 0 );
    dll << UnloadDLL();
);


```

### [Load Text File](#load-text-file)

**Syntax:** text = Load Text File( path, \<Charset("best guess", \<force("throw" | "alert" | "silent")>)>, \<LineSeparator("!N")>, <XMLParse>|<SASODSXML>|<JSON>|\<BLOB( \<readOffsetFromBegin(0)>|\<readOffsetFromEnd(42)>, \<readLength(2147483647)>, \<base64Compressed( 1 / *0: ascii~hex* /)> )> )

**Description:** Reads a whole text file into a JSL variable. Load Text File() prompts for a file name. Load Text File( path ) returns a string. The XMLParse option converts XML into an expression tree. The SASODSXML parses as SAS ODS default XML. The [{JSON}] option converts JSON into an expression tree. The BLOB argument returns binary data in a JSL Blob variable; optional named parameters to BLOB enable reading a substring from the file.

**JMP Version Added:** Before version 14

```

ex = Load Text File(
    Get Path Variable( "sample_import_data" ) || "/animals.txt"
/*, Charset("ascii")*/
/*, LineSeparator("\!r\!n")*/
/*, BLOB*/
);
Word( 4, ex, " \!t\!n\!r" );


```

### [Loc](#loc)

**Syntax:** y = Loc( m ); y = Loc( v, x )

**Description:** Returns a matrix of the positions of the matrix m that are nonzero.If two arguments are specified, Loc(v, x) returns a matrix of the positions of the list or matrix v that are equal to the value x. Prefer Where instead where possible.

**JMP Version Added:** Before version 14

**Example 1**

```

/*more examples, above*/
Show( Loc( [1 0 1 0 1 0] ) );
Show( Loc( {"A", 2, 3, 2, 5, 2, 4, [1 5]}, 2 ) );
Show( Loc( {"A", 2, 3, 2, 5, 2, 4, [1 5]}, [1 5] ) );


```

**Example 2**

```

Loc( [0, -2, 3, 0, 5, ., -7, ., 9] ) /*missing is not zero or non-zero*/;


```

**Example 3**

```

Loc( [5, 7, 5, ., 5], 5 );


```

**Example 4**

```

Loc( [5, 7, 5, ., 5] == 5 ) /*[5,7,5, . ,5]==5   ==>   [1, 0, 1, ., 1]*/;


```

**Example 5**

```

Loc( {"a", "fred", "b", "fred"}, "fred" );


```

### [Loc Max](#loc-max)

**Syntax:** y = Loc Max( x )

**Description:** Returns the first position in x of the maximum value.

**JMP Version Added:** Before version 14

```

Loc Max( [11 22 33 22 33 11] );


```

### [Loc Min](#loc-min)

**Syntax:** y = Loc Min( x )

**Description:** Returns the first position in x of the minimum value.

**JMP Version Added:** Before version 14

```

Loc Min( [11 22 33 22 33 11] );


```

### [Loc Nonmissing](#loc-nonmissing)

**Syntax:** y = Loc Nonmissing( matrixArg,...,{listArg},... )

**Description:** Returns a vector of row numbers in argument matrix rows that have no missing values, or for lists, those that are nonmissing numbers or nonempty character.

**JMP Version Added:** Before version 14

```

Loc Nonmissing( [1 2 3, 4 . 6, 7 8 ., 8 7 6] );


```

### [Loc Sorted](#loc-sorted)

**Syntax:** idx = Loc Sorted( x, y )

**Description:** Creates a column vector of subscript positions where the values of x have values less than or equal to the values in y based on a binary search. x must be a matrix sorted in ascending order without missing values.

**JMP Version Added:** Before version 14

```

Show(
    Loc Sorted( [11 22 33 44 55], [11 33 55] ),
    Loc Sorted( [11 22 33 44 55], [1] ),
    Loc Sorted( [11 22 33 44 55], [500] )
);


```

### [Local](#local)

**Syntax:** y = Local( {name=value, ...}, expression )

**Description:** Resolves names to local variables.

**JMP Version Added:** Before version 14

```

Local( {a = 1, b},
    b = 2;
    a + b;
);


```

### [Local Here](#local-here)

**Syntax:** y = Local Here( expression )

**Description:** Executes expression with local Names Default To Here(1)

**JMP Version Added:** Before version 14

```

y = Local Here(
    a = 1;
    b = 2;
    c = a + b;
    c;
);


```

### [Lock Globals](#lock-globals)

**Syntax:** Lock Globals( name, ... )

**Description:** Locks specified global names, preventing them from being modified or being cleared by the Clear Globals function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Lock Symbols](#lock-symbols)

**Syntax:** Lock Symbols( name, ... )

**Description:** Locks specified global names, preventing them from being modified or being cleared by the Clear Symbols function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Log](#log)

**Syntax:** y = Log( x, <b> )

**Description:** Returns the base-b logarithm of x or the natural logarithm of x if b is not specified.

**JMP Version Added:** Before version 14

```

Log( 256, 2 );


```

### [Log Capture](#log-capture)

**Syntax:** string = Log Capture( expr )

**Description:** Evaluates the expr argument and captures the output that would have appeared in the JMP log window and returns it in a string instead.

**JMP Version Added:** Before version 14

```

"captured:" || Log Capture(
    For( i = 1, i <= 3, i++,
        Write( Char( i ) );
        Write( " " );
    )
);


```

### [Log10](#log10)

**Syntax:** y = Log10( x )

**Description:** Returns the base 10 logarithm of x.

**JMP Version Added:** Before version 14

```

Log10( 100 );


```

### [Log1P](#log1p)

**Syntax:** y = Log1P( x )

**Description:** Returns a more accurate calculation of Log(1 + x) when x is very small.

**JMP Version Added:** Before version 14

```

Log1P( 1e-6 );


```

### [LogGenGamma Density](#loggengamma-density)

**Syntax:** y = LogGenGamma Density( x, mu, sigma, lambda )

**Description:** Returns the density at x of a log generalized gamma probability distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: LogGenGamma Density",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( LogGenGamma Density( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [LogGenGamma Distribution](#loggengamma-distribution)

**Syntax:** p = LogGenGamma Distribution( x, mu, sigma, lambda )

**Description:** Returns the probability that a log generalized gamma distributed random variable (with parameters mu, sigma, and lambda) is less than x.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: LogGenGamma Distribution",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( LogGenGamma Distribution( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [LogGenGamma Quantile](#loggengamma-quantile)

**Syntax:** q = LogGenGamma Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from a log generalized gamma distribution (with parameters mu, sigma, and lambda), the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
p = 0.4;
New Window( "Example: LogGenGamma Quantile",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( LogGenGamma Distribution( x, mu, sigma, lambda ), x );
        Pen Color( "Blue" );
        V Line( LogGenGamma Quantile( p, mu, sigma, lambda ), 0, 1 );
        Text(
            {-19, 0.9},
            "\!U03BC=",
            Round( mu, 4 ),
            " \!U03C3=",
            Round( sigma, 4 ),
            " \!U03BB=",
            Round( lambda, 4 )
        );
        Text( {-19, 0.8}, "p=", Round( p, 3 ) );
        Text(
            {-19, 0.7},
            "quantile= ",
            Round( LogGenGamma Quantile( p, mu, sigma, lambda ), 2 )
        );
    ),
    H List Box( Slider Box( -2, 2, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) ),
    H List Box( Slider Box( 0.01, 0.99, p, gdey << reshow ), Text Box( " p" ) )
);


```

### [Logist](#logist)

**Syntax:** y = Logist( x )

**Description:** Returns 1 / (1 + Exp( -x )), which converts a number in the domain -∞...+∞ into range 0...1. The Logist() function is useful in logistic regression.

**JMP Version Added:** Before version 14

```

Logist( 2 );


```

### [Logist Percent](#logist-percent)

**Syntax:** y = Logist Percent( x )

**Description:** Logist function with result scaled 0 to 100.

**JMP Version Added:** Before version 14

```

Logist Percent( 10 );


```

### [Logistic Density](#logistic-density)

**Syntax:** y = Logistic Density( x, mu, sigma )

**Description:** Returns the density at x of a logistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Logistic Density",
    y = Graph Box(
        Y Scale( 0, 2 ),
        X Scale( -10, 10 ),
        Pen Color( "red" );
        Y Function( Logistic Density( x, mu, sig ), x );
        Text( {0, 1.8}, "mu=", Round( mu, 2 ) );
        Text( {0, 1.6}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( -4, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0.01, 2, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Logistic Distribution](#logistic-distribution)

**Syntax:** p = Logistic Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a logistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Logistic Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        Pen Color( "red" );
        Y Function( Logistic Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( -4, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0.01, 2, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Logistic Quantile](#logistic-quantile)

**Syntax:** q = Logistic Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a logistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
qq = .5;
New Window( "Example: Logistic Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        Pen Color( "red" );
        Y Function( Logistic Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Logistic Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( -4, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0.01, 2, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Logit](#logit)

**Syntax:** y = Logit( p )

**Description:** Returns the logit of p, which is defined as log(p / (1 - p)).

**JMP Version Added:** Before version 14

```

Logit( 0.95 );


```

### [Logit Percent](#logit-percent)

**Syntax:** y = Logit Percent( p )

**Description:** Logit function with argument 0 to 100, rather than 0 to 1.

**JMP Version Added:** Before version 14

```

Logit Percent( 95.0 );


```

### [Loglogistic Density](#loglogistic-density)

**Syntax:** y = Loglogistic Density( x, mu, sigma )

**Description:** Returns the density at x of a loglogistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Loglogistic Density",
    y = Graph Box(
        Y Scale( 0, .06 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Loglogistic Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Loglogistic Distribution](#loglogistic-distribution)

**Syntax:** p = Loglogistic Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a loglogistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Loglogistic Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Loglogistic Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Loglogistic Quantile](#loglogistic-quantile)

**Syntax:** q = Loglogistic Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a loglogistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
qq = .5;
New Window( "Example: Loglogistic Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Loglogistic Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Loglogistic Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Lognormal Density](#lognormal-density)

**Syntax:** y = Lognormal Density( x, mu, sigma )

**Description:** Returns the density at x of a lognormal distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = 1;
New Window( "Example: Lognormal Density",
    y = Graph Box(
        Y Scale( 0, .15 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Lognormal Density( x, mu, sig ), x );
        Text( {0, .14}, "mu=", Round( mu, 2 ) );
        Text( {0, .12}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 2, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Lognormal Distribution](#lognormal-distribution)

**Syntax:** p = Lognormal Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a lognormal distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = 1;
New Window( "Example: Lognormal Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Lognormal Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 2, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Lognormal Quantile](#lognormal-quantile)

**Syntax:** q = Lognormal Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a lognormal distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = 1;
qq = .5;
New Window( "Example: Lognormal Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Lognormal Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Lognormal Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 3, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Long Date](#long-date)

**Syntax:** s = Long Date( datetime, <format> )

**Description:** Returns a long locale-specific representation of a date-time value.

**JMP Version Added:** Before version 14

```

Long Date( Today() );


```

### [Low Rank Symmetric Update BLAS](#low-rank-symmetric-update-blas)

**Syntax:** y = Low Rank Symmetric Update BLAS( A, U, s )

**JMP Version Added:** 17

```

A = [2 0, 0 2];
U = [2 4, 3 5];
s = 2.5;
AUpdate = Low Rank Symmetric Update BLAS( A, U, s );


```

### [Lowercase](#lowercase)

**Syntax:** sl = Lowercase( s )

**Description:** Converts uppercase letters to lowercase letters in the specified string. Rules for upper and lower case are locale dependent.

**JMP Version Added:** Before version 14

```

Lowercase( "CAFÉ #23" );


```

### [LPSolve](#lpsolve)

**Syntax:** {x, z} = LPSolve( A, b, c, L, U, neq, nle, nge, \<slackVars=0> )

**Description:** Minimizes the objective function subject to the given constraints and returns a list of two items. The first list item, x, contains the decision variables (and slack variable values if slackVars=1). The second list item, z, contains optimal objective function value (if one exists). The first five arguments are matrices. The A argument is the matrix of constraint coefficients. The b argument is the column of right hand side values of the constraints. The c argument is the vector of cost coefficients of the objective function. The L and U arguments are the lower and upper bounds for the variables, respectively. The neq, nle, and nge arguments are the number of equality constraints, less than or equal constraints, and greater than or equal constraints, respectively. Note that the constraints must be listed as equality first, less than or equal next, and greater than or equal last.

**JMP Version Added:** Before version 14

```

A = [5 -2 6, 2 4 0, 3 8 -4];
b = [17, 19, 14];
c = [9 6 -4];
L = [. 0 .];
U = [0 . .];
{x, z} = LPSolve( A, b, c, L, U, 1, 1, 1, 1 );
Show( x, z );


```

### [Mail](#mail)

**Syntax:** Mail( "address", "subject", "message", \<"attachment filepath"> | { "attachment filepath", ...} )

**Description:** Creates an outgoing e-mail message as specified if the operating system allows doing so. Not all options will work on all operating system versions. See Help for details.

**JMP Version Added:** Before version 14

```

Mail( "test@example.com", "revelation", "JMP is great.", "$SAMPLE_DATA/Big Class.jmp" );


```

### [Main Menu](#main-menu)

**Syntax:** menu = Main Menu( command, <window name> )

**Description:** Executes the specified main menu command.

**JMP Version Added:** Before version 14

**Example 1**

```

Main Menu( "Sample Index" );


```

**Example 2**

```

Main Menu( "Help:Sample Index" );


```

### [Make KFold Formula](#make-kfold-formula)

**Syntax:** y = Make KFold Formula( folds, Y Columns( cols ), \<<Stratification Columns( cols ), \<<Grouping Columns( cols ) )

**Description:** Generates a validation column with folds levels when used in a column formula. This JSL function is primarily used by the Make Validation Column platform to generate formula columns.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "KFold Validation",
    "Numeric",
    "Nominal",
    Formula( Make KFold Formula( 5, <<Y Columns( :height ) ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Stratified KFold",
    "Numeric",
    "Nominal",
    Formula(
        Make KFold Formula( 4, <<Y Columns( :height ), <<Stratification Columns( :sex ) )
    )
);


```

### [Make Validation Formula](#make-validation-formula)

**Syntax:** y = Make Validation Formula( rates, \<<Stratification Columns( cols ), \<<Grouping Columns( cols ), \<<Cutpoint Column ( col ), \<<Cutpoint Batch ID( col ), \<<Determine cutpoints using( "Proportions"|"Numbers of Rows"|"Fixed Time or Date"|"Elapsed Time" ), \<<Assign Extra Rows( "To Training"|"To Validation"|"To Test" ) )

**Description:** Generates a two-level or three-level validation column when used in a column formula. The rates argument is a 3 by 1 matrix that contains the training, validation, and test rates, respectively. This JSL function is primarily used by the Make Validation Column platform to generate formula columns.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Validation",
    "Numeric",
    "Nominal",
    Formula( Make Validation Formula( [.6, .4, 0] ) ),
    Set Property( "Value Labels", {0 = "Training", 1 = "Validation"} )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Validation",
    "Numeric",
    "Nominal",
    Formula( Make Validation Formula( [.6, .2, .2], <<Stratification Columns( :age ) ) ),
    Set Property( "Value Labels", {0 = "Training", 1 = "Validation", 2 = "Test"} )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "Validation",
    "Numeric",
    "Nominal",
    Formula(
        Make Validation Formula(
            [20, 10, 4],
            <<Cutpoint Column( :Week of Year ),
            <<Cutpoint Batch ID( :ID ),
            <<Determine cutpoints using( "Numbers of Rows" )
        )
    ),
    Set Property( "Value Labels", {0 = "Training", 1 = "Validation", 2 = "Test"} )
);


```

### [Mandelbrot](#mandelbrot)

**Syntax:** v = Mandelbrot( n, radius, x, y )

**Description:** calculates the value of the Mandelbrot function at x,y, stopping after n iterations or when radius exceeded

**JMP Version Added:** Before version 14

```

grid = 50;
rmax = 0/*zero for smooth*/;
nmax = 50;// http://wikipedia.org/wiki/Mandelbrot_set 
New Window( "Mandelbrot - use magnifier to zoom in",
    g = Graph Box(
        X Scale( -3, 3 ),
        Y Scale( -2, 2 ),
        framesize( 600, 400 ),
        Gradient Function(
            Mandelbrot( nmax, rmax, a, b ), // return value: number of iterations before something interesting happened
            a, // standard GradientFunction stuff...
            b,
            Matrix( {0, nmax} ), // range to map the colors onto
            Z Color(
                {RGB Color( 0, 0, 0 ), RGB Color( 1, 0, 0 ), RGB Color( 1, 1, 0 ),
                RGB Color( 0, 1, 0 ), RGB Color( 0, 1, 1 ), RGB Color( 0, 0, 1 ),
                RGB Color( .3, .3, .4 )}
            ),
            <<xgrid(
                X Origin(), X Origin() + X Range(),
                X Range() / (Floor( grid * H Size() / V Size() ))
            ),
            <<ygrid( Y Origin(), Y Origin() + Y Range(), Y Range() / (Floor( grid )) ), 

        )
    ),
    H List Box( Slider Box( 2, 500, nmax, g << reshow ), Global Box( nmax ) ),
    H List Box( Slider Box( 0, 5, rmax, g << reshow ), Global Box( rmax ) ),
    H List Box( Slider Box( 2, 500, grid, g << reshow ), Global Box( grid ) ), 

);
g << Set X Axis(
    {Format( "Best", 15 ), Show Major Ticks( 0 ), Rotated Labels( "Parallel" )}
);
g << Set Y Axis(
    {Format( "Best", 15 ), Show Major Ticks( 0 ), Rotated Labels( "Parallel" )}
);


```

### [Map Value](#map-value)

**Syntax:** Map Value(string | number, {key1, value1...|{key1...},{value1...}}, \<Unmatched(value)>)

**Description:** Evaluate the initial value and return the mapped result or a default.

**JMP Version Added:** 15

**Example 1**

```

Map Value( "celry", {"celry", "celery"} );


```

**Example 2**

```

Map Value( "carrot", {"celry", "celery"}, Unmatched( "not found" ) );


```

**Example 3**

```

Map Value( 10, {10, "celery", 11, "banana"} );


```

**Example 4**

```

Map Value( 10, {{1, 2, 3}, {100, 200, 300}} );


```

### [Marker](#marker)

**Syntax:** Marker( <rs>, {x1, y1}, {x2, y2}, ... ); Marker( <rs>, xMatrix, yMatrix )

**Description:** Draws markers at the indicated coordinates.

**JMP Version Added:** Before version 14

```

New Window( "Example", Graph Box( Marker( Marker State( 3 ), [11 44 77], [75 25 50] ) ) );


```

### [Marker Of](#marker-of)

**Syntax:** y = Marker Of( <rs> ); Marker Of( \<Row State( <r> )> ) = y

**Description:** Returns the marker component of the specified row state value. If Marker Of is used as an L-value, it changes the marker of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Marker State( 5 );
Marker Of( Row State( 3 ) );
Row() = 3;
Marker Of();


```

### [Marker Seg](#marker-seg)

**Syntax:** me = Marker Seg( x, y, < Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) >, < Sizes( s ) > )

**Description:** Returns a display seg with markers for all of the x and y values.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
sz = Column( "age" ) << get values;
aa = [=> 0];
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ), sizes( sz ) )
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt, {3, 4, 11, 7, 13} ) )
    )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt, 11 :: 15 ) )
    )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg(
            xx,
            yy,
            Row States( dt, {{1, 2, 3}, {4, 5}, {6}, {7, 12, 15, 9}, {21, 8}} )
        )
    )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg(
            xx,
            yy,
            Row States(
                {Color State( "Blue" ), Color State( "Orange" ), Color State( "Green" ),
                Color State( "Purple" ), Color State( "Red" )}
            )
        )
    )
);


```

### [Marker Size](#marker-size)

**Syntax:** Marker Size( n )

**Description:** Sets the size markers are drawn in the graphics frame. 0 = dot, 1 = small, ....

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Marker Size( 5 );
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    )
);


```

### [Marker State](#marker-state)

**Syntax:** rs = Marker State( marker )

**Description:** Returns a row state value with the marker component set to the specified value. The marker argument specifies a marker and can be a positive integer, a character, a positive integer for Unicode character, or a hex character for Unicode character.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Marker State( 5 );
Marker Of( Row State( 3 ) );


```

### [Match](#match)

**Syntax:** y = Match( x, v1, expr1, v2, expr2, ..., exprElse )

**Description:** Evaluates and returns the exprN argument corresponding to the first vN argument that equals x or evaluates and returns the exprElse argument if no value equals x.

**JMP Version Added:** Before version 14

```

Match( Year( Today() ), 2013, "snake", 2014, "horse", 2015, "goat", "other" );


```

### [MatchMZ](#matchmz)

**Syntax:** y = MatchMZ( x, v1, expr1, v2, expr2, ..., exprElse )

**Description:** Evaluates and returns the exprN argument corresponding to the first vN argument that equals x or evaluates and returns the exprElse argument if no value equals x. (The MatchMZ() function behaves the same as the Match() function, except that missing values are treated as 0.)

**JMP Version Added:** Before version 14

```

MatchMZ( Year( Today() ), 2013, "snake", 2014, "horse", 2015, "goat", "other" );


```

### [MATLAB Connect](#matlab-connect)

**Syntax:** MATLABConnection = MATLAB Connect(\<Echo(0|1)>)

**Description:** Returns a MATLAB connection scriptable object.

**JMP Version Added:** Before version 14

```

MATLABConnection = MATLAB Connect();
x = MatlabConnection << Is Connected;
Show( x );


```

### [MATLAB Control](#matlab-control)

**Syntax:** MATLAB Control( Echo(bool) )

**Description:** Changes the control options for MATLAB.

**JMP Version Added:** Before version 14

```


MATLAB Init( Echo( true ) );
MATLAB Control( Echo( false ) );
MATLAB Submit(
    "\[
    v = [9 8 7, 6 5 4, 3 2 1];
    m = [1 2 3, 4 5 6, 7 8 9];
    rowjoin = [v ; m]
    coljoin = [v , m]
]\"
);
MATLAB Term();


```

### [MATLAB Execute](#matlab-execute)

**Syntax:** MATLAB Execute( { list of Inputs }, { list of Outputs }, statements, \<Echo(0|1)>, \<Expand(0|1)> )

**Description:** Sends a list of inputs, executes statements and returns a list of outputs.

**JMP Version Added:** Before version 14

```

MATLAB Init();
a = "abcdef";
d = 3.141;
v = [9 8 7, 6 5 4, 3 2 1];
m = [1 2 3, 4 5 6, 7 8 9];
ml = MATLAB Execute(
    {v, m, a, d},
    {x, z, a, d},
    "\[
a = v * m; % matrix product
d = v / m; % = v * inv(m) called Right division
z = m \ v; % = m * inv(v) called Left division
x = m .* v; % element-wise product
]\"
);
Show( v, m, ml, x, z, a, d );
MATLAB Term();


```

### [MATLAB Get](#matlab-get)

**Syntax:** y = MATLAB Get( name )

**Description:** Returns data from MATLAB, where the name argument can represent any of the following MATLAB data types ( numeric | string | matrix | list | data frame).

**JMP Version Added:** Before version 14

```

MATLAB Init();
x1 = [1, 2, 3];
MATLAB Send( x1 );
x2 = MATLAB Get( x1 );
Show( x1, x2 );
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
MATLAB Send( dt1 );
dt2 = MATLAB Get( dt1 );
dt2 << New Data View;
Close( dt1 );
MATLAB Term();


```

### [MATLAB Get Graphics](#matlab-get-graphics)

**Syntax:** MATLAB graphics = MATLAB Get Graphics( format )

**Description:** Returns the last graphics object written to the MATLAB graph display window in a graphics format specified by the format argument.

**JMP Version Added:** Before version 14

```

MATLAB Init();
ml = MATLAB Submit( "\[
plot(1:10)
]\" );
plot = MATLAB Get Graphics( png );
pngJMP = New Window( "Plot", Picture Box( plot ) );
pngJMP << Close Window;
MATLAB Submit( "close" );//Needed this command to close the figure generated from Matlab
MATLAB Term();


```

### [MATLAB Get Version](#matlab-get-version)

**Syntax:** version = MATLAB Get Version()

**Description:** Returns the version number of MATLAB being used with the JMP MATLAB interfaces.

**JMP Version Added:** 14

```

MATLAB Init();
version = MATLAB Get Version();
Show( version );
MATLAB Term();


```

### [MATLAB Init](#matlab-init)

**Syntax:** MATLAB Init(\<Echo(0|1)>)

**Description:** Initializes the MATLAB Interfaces.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = MATLAB Get( str );
Show( getStr );
MATLAB Term();


```

### [MATLAB Is Connected](#matlab-is-connected)

**Syntax:** connected = MATLAB Is Connected()

**Description:** Returns 1 if there is an active MATLAB connection; otherwise, returns 0.

**JMP Version Added:** Before version 14

```

MATLAB Init();
x = MATLAB Is Connected();
Show( x );
MATLAB Term();


```

### [MATLAB JMP Name to MATLAB Name](#matlab-jmp-name-to-matlab-name)

**Syntax:** MATLAB name = MATLAB JMP Name To MATLAB Name( JMP name )

**Description:** Maps a JMP variable name to a MATLAB variable name using MATLAB variable naming rules.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB name = MATLAB JMP Name to MATLAB Name( a b c );
Show( MATLAB name );
MATLAB Term();


```

### [MATLAB Load](#matlab-load)

**Syntax:** MATLAB Load( path )

**Description:** Loads variables into MATLAB from a .mat file and returns the variables to a JSL associative array.

**JMP Version Added:** 19

```

MATLAB Init();
// if .mat file contained: x = 40; y = 'hello';
vars = MATLAB Load( "path/to/.mat" );
Show( vars << Get Value( "x" ), vars << Get Value( "y" ) );
MATLAB Term();


```

### [MATLAB Send](#matlab-send)

**Syntax:** MATLAB Send( name, \<MATLAB Name( name )>, <Named Arguments> )

**Description:** Sends data to MATLAB, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table).

**JMP Version Added:** Before version 14

```

MATLAB Init();
x = [1, 2, 3];
MATLAB Send( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
MATLAB Send( dt );
Close( dt );
MATLAB Submit( "x" );
MATLAB Submit( "dt" );
MATLAB Term();


```

### [MATLAB Send File](#matlab-send-file)

**Syntax:** MATLAB Send File( filename, \<MATLAB Name( name )> )

**Description:** Sends a data file to MATLAB, where the filename argument is a string that specifies a path name to the file to be sent to MATLAB.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Send File( "$SAMPLE_DATA/Big Class.jmp" );
MATLAB Send File( "$SAMPLE_DATA/Baseball.jmp" );
MATLAB Submit( "BigClass" );
MATLAB Submit( "Baseball" );
MATLAB Term();


```

### [MATLAB Submit](#matlab-submit)

**Syntax:** MATLAB Submit( statements, \<Echo(0|1)>, \<Expand(0|1)> )

**Description:** Submit statements to MATLAB. Statements can be in the form of a string value or list of string values.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
a = 200;
]\" );
getStr = MATLAB Get( str );
getNum = MATLAB Get( a );
Show( getStr, getNum );
MATLAB Term();


```

### [MATLAB Submit File](#matlab-submit-file)

**Syntax:** MATLAB Submit File( path, \<Echo(0|1)>, \<Expand(0|1)> )

**Description:** Submits statements to MATLAB using a file specified by the path argument.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit File( "file containing MATLAB source.m" );
MATLAB Term();


```

### [MATLAB Term](#matlab-term)

**Syntax:** MATLAB Term()

**Description:** Terminates the MATLAB interfaces.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = MATLAB Get( str );
Show( getStr );
MATLAB Term();


```

### [Matrix](#matrix)

**Syntax:** y = Matrix( {{x11, ..., x1m}, {...}, {xn1, ..., xnm}} ) y = Matrix( {x1, ..., xn} ) y = Matrix( n, m )

**Description:** Constructs an n-by-m matrix. If you specify a list of n lists that each contain m row values, the matrix is formed by vertically concatenating the evaluated lists. If you specify a single list of n items, the return value is an n-by-1 column vector. If you specify two integer arguments, the return value is a matrix of zeros that contains n rows and m columns.

**JMP Version Added:** Before version 14

**Example 1**

```

Matrix( {{11, 22, 33}, {44, 55, 66}} );


```

**Example 2**

```

Matrix( {{[1 2 3], 4, 5, 6, 7, 8, 9}} );


```

**Example 3**

```

Matrix( {2, 3 + 7} );


```

**Example 4**

```

Matrix( 2, 3 );


```

### [Matrix Box](#matrix-box)

**Syntax:** y = Matrix Box( matrix, < \<<Column Names( "c1", "c2", ... )>, < \<<Row Names( "r1", "r2", ... )> )

**Description:** Returns a display box to show a matrix of numbers.

**JMP Version Added:** Before version 14

```

New Window( "Example", Matrix Box( [11 22 33, 44 55 66], <<RowNames( "First", "Second" ) ) );


```

### [Matrix Mult](#matrix-mult)

**Syntax:** y = Matrix Mult( A, B, ... ); y = A * B

**Description:** Performs matrix multiplication. The matrix arguments must be conformable: NCol(a)==NRow(b). Note that A * B also works.

**JMP Version Added:** Before version 14

```

exMatA = [1 2 3, -2 0 -1, 0 1 1];
exMatB = [1 2, 1 2, 1 2];
exMatM1 = exMatA * exMatB;
exMatM2 = Matrix Mult( exMatA, exMatB );
exMatC = [1 2, 1 2];
exMatM3 = Matrix Mult( exMatA, exMatB, exMatC );
Show( exMatM1 );
Show( exMatM2 );
Show( exMatM3 );


```

### [Matrix Mult BLAS](#matrix-mult-blas)

**Syntax:** y = Matrix Mult BLAS( A, B, ... )

**Description:** Performs matrix multiplication. The matrix arguments must be conformable: NCol(A)==NRow(B).

**JMP Version Added:** 17

```

exMatA = [1 2 3, -2 0 -1, 0 1 1];
exMatB = [1 2, 1 2, 1 2];
exMatM2 = Matrix Mult BLAS( exMatA, exMatB );


```

### [Matrix Rank](#matrix-rank)

**Syntax:** r = Matrix Rank( X )

**Description:** Returns the rank of the matrix X.

**JMP Version Added:** 14

```

Matrix Rank( [1 0 0, 0 1 0, 0 1 0] );


```

### [Matrix To Blob](#matrix-to-blob)

**Syntax:** m = Matrix To Blob( matrix, type, bytesEach, endian )

**Description:** Makes a blob from a matrix by converting the matrix elements to 1, 2, or 4 byte signed or unsigned integers or 4 or 8 byte floating point numbers.

**JMP Version Added:** Before version 14

```

Matrix To Blob( [3.14, 1.414], "float", 4, "big" );


```

### [Max](#max)

**Syntax:** y = Max( x1, ... ); y = Maximum( x1, ... )

**Description:** Returns the maximum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Max( Pi(), e() ), Max( [33 44 22] )} );


```

### [Maximize](#maximize)

**Syntax:** Maximize( expr, {x1, x2, ...} ); Maximize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<MaxIter( 250 ), \<<Tolerance( .00000001 ), \<<details(both | returnDetails | displaySteps), \<<gradient(), \<<hessian(), method(NR | SR1), \<<useNumericDeriv(True))

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that maximize the expr expression. You can specify lower and upper bounds for each argument in parentheses following the argument's name. If expr is not a concave function, Maximize might find a local maximum rather than the global maximum. If this is a concern, try multiple starting values. Also, Maximize works best for functions with a continuous second derivative. Additional arguments for the Maximize function enable you to set the maximum number of iterations, tolerance for convergence, and view more details about the optimization. Click the Topic Help button for more information about the optional arguments.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple example*/ 
x = 0;
y = 0;
maxf = Maximize( ((2 * x ^ 2 + 12 * x * y - y * 3)), {x, y} );
Eval List( {x, y, maxf} );


```

**Example 2**

```

/*Find the MLE for a Normal Distribution with a random sample of 3 observations*/
x = [3 4 5]; /* observed values*/ 
n = 3;
logDens = Expr(
    (-n / 2) * Log( 2 * Pi() * sigSq ) - Summation( i = 1, 3, ((x[i] - mu) ^ 2) ) / (2 *
    sigSq)
);
mu = 3;
sigSq = 1;/*initial values*/ 
{maxReached, iters, gradient, hessian} = Maximize(
    logDens,
    {mu, sigSq( 0, . )},
    <<details( both )
);


```

**Example 3**

```

/*Simple example with all optional arguments*/ 
x = 0;
y = 0;
{objVal, iters, gradient, hessian} = Maximize(
    ((2 * x ^ 2 + 12 * x * y - y * 3)),
    {x( -1, 1 ), y( -1, 1 )},
    <<maxIter( 200 ),
    <<tolerance( 10 ^ -6 ),
    <<details( both )
);


```

### [Maximum](#maximum)

**Syntax:** y = Max( x1, ... ); y = Maximum( x1, ... )

**Description:** Returns the maximum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Max( Pi(), e() ), Max( [33 44 22] )} );


```

### [MDYHMS](#mdyhms)

**Syntax:** s = MDYHMS( datetime, <format> )

**Description:** Returns a representation of a date-time value with the ordering: month, day, year, hour, minute, second.

**JMP Version Added:** Before version 14

```

MDYHMS( Today() );


```

### [Mean](#mean)

**Syntax:** y = Mean( x1, ... )

**Description:** Returns the arithmetic mean of the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Mean( Pi(), e() ), Mean( [33 44 22 20 30] )} );


```

### [Median](#median)

**Syntax:** y = Median( x1, ... )

**Description:** Returns the median of the combined arguments, which can be scalar, matrix or list arguments.

**JMP Version Added:** 15

```

Median( [1.2, 1.5, 10, 25, 31, 40, 50, 99, 1000, 5000, 25000, 100000] );


```

### [Method](#method)

**Syntax:** m = Method( { arg1 = val1, ... }, expression\* )

**Description:** Create a Method within a Class

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
cl << Delete;
Delete Classes( "complex" );


```

### [Min](#min)

**Syntax:** y = Min( x1, ... ); y = Minimum( x1, ... )

**Description:** Returns the minimum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Min( Pi(), e() ), Min( [33 44 22] )} );


```

### [Minimize](#minimize)

**Syntax:** Minimize( expr, {x1, x2, ...} ); Minimize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<MaxIter( 250 ), \<<Tolerance( .00000001 ), \<<details(both | returnDetails | displaySteps), \<<gradient(), \<<Hessian(), \<<method(NR | SR1), \<<useNumericDeriv(True))

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that minimize the expr expression. You can specify lower and upper bounds for each argument in parentheses following the argument's name. If expr is not a convex function, Minimize might find a local minimum rather than the global minimum. If this is a concern, try multiple starting values. Also, Minimize works best for functions with a continuous second derivative. Additional arguments for the Minimize function enable you to set the maximum number of iterations, tolerance for convergence, and view more details about the optimization. Click the Topic Help button for more information about the optional arguments.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple Example*/
x = 0;
y = 0;
minFun = Minimize( (y * 3 - 2 * x ^ 2 - 12 * x * y), {x, y} );
Eval List( {x, y, minFun} );


```

**Example 2**

```

/*Nonlinear Sums of Squares Example*/
x = [1.309, 1.471, 1.49, 1.565, 1.611, 1.68];
y = [2.138, 3.421, 3.597, 4.34, 4.882, 5.66];
sseExpr = Expr(
    Summation( i = 1, 6, (y[i] - b1 * x[i] ^ b2) ^ 2 )
);
b1 = 1;
b2 = 5;
{objVal, iters, gradient, hessian} = Minimize(
    sseExpr,
    {b1, b2},
    <<details( both ),
    <<tolerance( 10 ^ -16 )
);


```

**Example 3**

```

/*Simple example with some optional arguments*/
x = 0;
y = 0;
{objVal, iters, gradient, hessian} = Minimize(
    ((2 * x ^ 2 + 12 * x * y - y * 3)),
    {x( -1, 1 ), y( -1, 1 )},
    <<maxIter( 200 ),
    <<tolerance( 10 ^ -6 ),
    <<details( both )
);


```

**Example 4**

```

/*Example with gradient, hessian, and method(nr) options*/
xx = [1.309, 1.471, 1.49, 1.565, 1.611, 1.68];
yy = [2.138, 3.421, 3.597, 4.34, 4.882, 5.66];
tmp3 = Expr(
    Summation( i = 1, 6, (yy[i] - b1 * xx[i] ^ b2) ^ 2 )
);
b1 = 1;
b2 = 5;
Minimize(
    tmp3,
    {b1, b2},
    <<details( both ),
    <<tolerance( 10 ^ -10 ),
    <<Method( nr ),
    <<gradient(
        {Summation( i = 1, 6, -2 * xx[i] ^ b2 * (yy[i] - b1 * xx[i] ^ b2) ),
        Summation(
            i = 1,
            6,
            2 * (b1 * Ln( xx[i] ) * xx[i] ^ b2) * (b1 * xx[i] ^ b2 - yy[i])
        )}
    ),
    <<hessian(
        {{Summation( i = 1, 6, 2 * xx[i] ^ (2 * b2) ),
        Summation( i = 1, 6, 2 * Ln( xx[i] ) * xx[i] ^ b2 * (2 * b1 * xx[i] ^ b2 - yy[i]) )},
        {Summation(
            i = 1,
            6,
            2 * b1 * Ln( xx[i] ) ^ 2 * xx[i] ^ b2 * (2 * b1 * xx[i] ^ b2 - yy[i])
        )}}
    )
);


```

**Example 5**

```

/*Example with usNumericDeriv and method(sr1) options*/
xx = [1.309, 1.471, 1.49, 1.565, 1.611, 1.68];
yy = [2.138, 3.421, 3.597, 4.34, 4.882, 5.66];
tmp3 = Expr(
    Summation( i = 1, 6, (yy[i] - b1 * xx[i] ^ b2) ^ 2 )
);
b1 = 1;
b2 = 5;
{objValue, iter, gradient, hessian} = Minimize(
    tmp3,
    {b1, b2},
    <<details( both ),
    <<tolerance( 10 ^ -16 ),
    <<Method( sr1 ),
    <<useNumericDeriv( True )
);


```

### [Minimum](#minimum)

**Syntax:** y = Min( x1, ... ); y = Minimum( x1, ... )

**Description:** Returns the minimum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Min( Pi(), e() ), Min( [33 44 22] )} );


```

### [Minus](#minus)

**Syntax:** y = -x; y = Minus( x )

**Description:** Negates x, which can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

-Pi();


```

### [Minute](#minute)

**Syntax:** min = Minute( datetime )

**Description:** Returns the minutes part of a date-time value, 0 - 59.

**JMP Version Added:** Before version 14

```

Minute( Today() );


```

### [Mod](#mod)

**Syntax:** z = Modulo( x, y )

**Description:** Returns the remainder from dividing x by y. The remainder has the same sign as x.

**JMP Version Added:** Before version 14

```

Modulo( 10, 3 );


```

### [Mode](#mode)

**Syntax:** y = Mode( list or matrix )

**Description:** Picks the 'most frequent' item from a matrix or list, the lower value for ties

**JMP Version Added:** Before version 14

```

Show( Mode( [1, 2, 3, 2, 1] ), Mode( {"a", "b", "c", "b", "a", "b"} ) );


```

### [Modified Internal Rate of Return](#modified-internal-rate-of-return)

**Syntax:** x = Modified Internal Rate of Return( values, finance_rate, reinvest_rate ); x = Modified Internal Rate of Return( finance_rate, reinvest_rate, value1, value2, \<value3, ...> )

**Description:** Returns the modified internal rate of return for a series of periodic cash flows, taking into account both the cost of the investment and the interest received on reinvestment of cash. Equivalent to the MIRR function in Microsoft Excel. The second prototype of the function accepts all scalar arguments.

**JMP Version Added:** Before version 14

```

Modified Internal Rate of Return( [-10000, 1000, 900, 950], .1, -.12 );
Modified Internal Rate of Return( .1, -.12, -10000, 1000, 900, 950 );


```

### [Modulo](#modulo)

**Syntax:** z = Modulo( x, y )

**Description:** Returns the remainder from dividing x by y. The remainder has the same sign as x.

**JMP Version Added:** Before version 14

```

Modulo( 10, 3 );


```

### [Month](#month)

**Syntax:** mon = Month( datetime )

**Description:** Returns the month part of a date-time value, 1 - 12.

**JMP Version Added:** Before version 14

```

Month( Today() );


```

### [MouseBox](#mousebox)

**Syntax:** box = MouseBox( displayBoxArgs )

**Description:** Returns a box that can make JSL callbacks for mouse actions

**JMP Version Added:** Before version 14

```

New Window( "Example",
    MouseBox(/*first sibling*/Text Box( "drag from here" ),
        <<setDragText( "hello" ),
        <<setTooltip( "source" ),
        <<setDragEnable( 1 ),
        <<setDragBegin(/* decide if a drag is allowed */
            Function( {this, clickpt},
                "magic text";/* 0.0 to prevent the drag.  1.0 is the same as 'this<<getDragText' */
            )
        ),
        <<setDragEnd(/* clean up after a drag finishes or cancels */
            Function( {this, clickpt, how}, /* how=move,copy,ignore */
                If(
                    how != "ignore" & !Is Empty( this << getDestBox ) & this << getDestBox
                     == this << sib, /* the getDestBox check makes sure the destination of the drag-and-drop was my sibling and not some other program beyond our control */
                    (this << child) << setText(
                        "done!" /* 'move' suggests clearing the source */
                    )
                )
            )
        )
    ),
    MouseBox(/*second sibling*/Text Box( "drag to here" ),
        <<setTooltip( "destination" ),
        <<setDropEnable( 1 ),
        <<setDropTrack(/* decide if dropping is allowed, before the drop.  The getSourceBox check makes sure the source of the drag-and-drop is my sibling, and not some other program */
            Function( {this, clickpt},
                If( !Is Empty( this << getSourceBox ) & this == (this << getSourceBox) << sib,
                    1, /*else*/0
                )
            )
        ),
        <<setDropCommit(/* accept the drop */Function( {this, clickpt, text},
                (this << child) << setText( text )
            )
        )
    )
);


```

### [Mousetrap](#mousetrap)

**Syntax:** Mousetrap( dragScript, <mouseUpScript> )

**Description:** Evaluates the dragScript expression repeatedly while the mouse is pressed within the graph and not handled by another graph object. Before running the script, the globals x and y are set to the mouse value and are restored to their original values afterward. The mouseUpScript expression is run after the mouse button is released.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = 20;
    exy = 50;,
    Graph Box(
        Frame Size( 200, 200 ),
        Mousetrap(
            exx = x;
            exy = y;
        );
        Circle( {0, 0}, Sqrt( exx * exx + exy * exy ) );
    )
);


```

### [Move Directory](#move-directory)

**Syntax:** rc = Move Directory( from, to )

**Description:** Moves a directory from one place to another. Returns 1 if the directory was moved. Returns 0 if the directory was unable to be moved. Throws an error if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/subB" );
Delete Directory( "$TEMP/Loss Function Templates" );
rc0 = Copy Directory( "$SAMPLE_DATA/Loss Function Templates", "$TEMP" );
Create Directory( "$TEMP/subB" );
rc1 = Move Directory( "$TEMP/Loss Function Templates", "$TEMP/subB" );
rc2 = Directory Exists( "$TEMP/Loss Function Templates" );
rc3 = Directory Exists( "$TEMP/subB" );
rc4 = Delete Directory( "$TEMP/subB" );
rc5 = Directory Exists( "$TEMP/subB" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Move File](#move-file)

**Syntax:** rc = Move File( from, to )

**Description:** Moves a file from one place to another. Returns 1 if the file was moved. Returns 0 if the file was unable to be moved. Throws an error when the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

If( File Exists( "$TEMP/y.jmp" ),
    Delete File( "$TEMP/y.jmp" )
);
rc0 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc1 = Move File( "$TEMP/x.jmp", "$TEMP/y.jmp" );
rc2 = File Exists( "$TEMP/x.jmp" );
rc3 = File Exists( "$TEMP/y.jmp" );
rc4 = Delete File( "$TEMP/y.jmp" );
rc5 = File Exists( "$TEMP/y.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Move to Project](#move-to-project)

**Syntax:** Move to Project(\<Source(project)>, \<Destination(project)>, \<Windows({list of windows to move})>)

**Description:** Moves one or more windows into a project, out of a project, or between projects. Only one of Source and Destination must be specified; the other will default to the current project. (Use only Source to move windows into the current project, and only Destination to move windows out of it.) A data table window will be moved together with its dependent reports, though only one need be specified in the Windows argument. If omitted, the Windows argument defaults to all open windows in the source project.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
report = dt << Run Script( "Bivariate" );

project = New Project();

Move to Project( destination( project ), windows( {report} ) );


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );
Move to Project( Source( project ) );
project << Close Window();


```

### [Moving Average](#moving-average)

**Syntax:** y = Moving Average( x, weighting, \<before=-1>, \<after=0>, <partial window is missing=0> )

**Description:** Returns a matrix of moving averages for the input matrix. before and after determine the range ("window") of items to average, where before can be -1 to indicate all prior items. If weighting is 1, all items have equal weight. If weighting is 0, items have linearly incremental weights. Otherwise, weighting is the parameter for exponential weighting (EWMA). partial window is missing indicates whether averages are reported when not all neighbors are present, which can occur at the ends or near missing values. If partial window is missing is nonzero, missing values are reported instead for such partial windows.

**JMP Version Added:** Before version 14

```

Eval List(
    {Moving Average( [1 2 1 2 3 4 9 9 9 9 9], 1, 3 ),
    Moving Average( [1 2 1 2 3 4 9 9 9 9 9], 0, 2, 2 ),
    Moving Average( [1 2 1 2 . 4 9 9 9 9 9], 1, 1, 1, 1 ),
    Moving Average( [1 2 1 2 3 4 9 9 9 9 9], 0.5 )}
);


```

### [Multiple File Import](#multiple-file-import)

**Syntax:** mfiObj = Multiple File Import();

**Description:** Creates a Multiple File Import object; the object accepts messages to set a folder, filter files, and import. To bring up a dialog use the "Create Window" message. To immediately import use the "Import Data" message which will return a list of the tables that were created.

**JMP Version Added:** 14

**Interactive example**

```

// use the save-script-to-script-window button 
// in the MFI dialog to see more messages
// for filtering files and controlling the import
Multiple File Import(
    <<Set Folder( "$DESKTOP" ),
    <<Set Name Filter( "*.csv;" ),
    <<Set Name Enable( 1 )
) << Create Window;


```

**Scripting example**

```


mfi = Multiple File Import();
mfi << Set Folder( "$SAMPLE_IMPORT_DATA" );
mfi << Set Name Filter( "*.txt" );
mfi << Set Name Enable( 1 );
tables = mfi << Import Data();


```

### [Multiply](#multiply)

**Syntax:** y = x0 * x1; y = Multiply( x0, x1, ... )

**Description:** Multiplies all arguments, which can be numbers, matrices, or lists of numbers.

**JMP Version Added:** Before version 14

```

2 * Pi();


```

### [Multiply To](#multiply-to)

**Syntax:** y \*= x; Multiply To( y, x )

**Description:** Multiplies a value to a variable or to a list of variables.

**JMP Version Added:** Before version 14

```

ex = 3;
ex *= 2;
ex;


```

### [Multivariate Normal Impute](#multivariate-normal-impute)

**Syntax:** y = Multivariate Normal Impute( yVec, meanYvec, symCovMat, colMin, colMax )

**Description:** Returns a response vector with imputed values for the missing values in the yVec vector of responses. Imputations are based on a multivariate normal distribution with mean vector meanYvec and symmetric covariance matrix symCovMat. Optional arguments colMin and colMax are the respective vectors of column minimums and maximums. These arguments provide bounds for the imputations.

**JMP Version Added:** Before version 14

```

mat = [0.430735257211985 -0.935632420013493 . 0.424649913158299,
. -0.687720061441453 0.29665732536624 -1.94898001941576,
-0.0425472526673373 0.463229145080277 0.635619352779951 .];
cov = Covariance( mat, <<"Pairwise"/*, <<"shrink"*/ );
colMean = V Mean( mat );
colMin = V Min( mat );
colMax = V Max( mat );
For( it = 1, it <= N Row( mat ), it++,
    mat[it, 0] = Multivariate Normal Impute( mat[it, 0], colMean, cov, colMin, colMax )`
);
Print( mat );


```

### [Munger](#munger)

**Syntax:** r = Munger( s, startPos, findStringOrNChars, <replaceString> )

**Description:** Searches the s argument for a substring or position depending on combination of arguments.

**JMP Version Added:** Before version 14

```

Eval List( {Munger( "over there", 1, "t", "" ), Munger( "17 June 2000", 4, 4, "March" )} );


```

### [N Arg](#n-arg)

**Syntax:** n = N Arg( expr )

**Description:** Returns the number of arguments of the evaluated expression head.

**JMP Version Added:** Before version 14

```

N Arg( Expr( Sum( a, b, c ) ) );


```

### [N Arg Expr](#n-arg-expr)

**Syntax:** n = N Arg Expr( expr )

**Description:** Returns the number of arguments of the expression head. This function is deprecated. Please use N Arg() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated N Arg Expr() equivalent
N Arg( Expr( Sum( a, b, c ) ) );


```

**Example 2**

```

// Deprecated
N Arg Expr( Sum( a, b, c ) );


```

### [N Choose K](#n-choose-k)

**Syntax:** m = N Choose K( n, k )

**Description:** Returns n! / (k! * (n - k)!), which is the number of ways to choose k items out of n, ignoring order.

**JMP Version Added:** Before version 14

```

N Choose K( 5, 3 );


```

### [N Col](#n-col)

**Syntax:** y = N Col(); y = N Col( dataTable ); y = N Col( matrix )

**Description:** Returns the number of columns in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Col( [11 22, 33 44] );


```

### [N Cols](#n-cols)

**Syntax:** y = N Cols(); y = N Cols( dataTable ); y = N Col( matrix )

**Description:** Returns the number of columns in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Col( [11 22, 33 44] );


```

### [N Items](#n-items)

**Syntax:** y = N Items( x )

**Description:** Returns the number of items in a list, the number of elements in a matrix, the number of keys in an associative array, the number of functions and variables in a namespace, the number of methods and variables in a class object, or the number of children of a display box.

**JMP Version Added:** Before version 14

**Example 1**

```

N Items( {1, 2 + 3, [11 22]} );


```

**Example 2**

```

N Items( ["a" => 10, "b" => 3, => 0] );


```

**Example 3**

```

New Window( "boxes", hlist = H List Box( Button Box( "a" ), Button Box( "b" ) ) );
N Items( hlist );


```

### [N Missing](#n-missing)

**Syntax:** y = N Missing( x1, x2, ... )

**Description:** Returns the number of missing values among arguments.

**JMP Version Added:** Before version 14

```

N Missing( 1, 2, ., 3, [11 22 . .], 4 );


```

### [N Row](#n-row)

**Syntax:** y = N Row(); y = N Row( dt ); y = N Row( matrix )

**Description:** Returns the number of rows in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Row( [11 22, 33 44] );


```

### [N Rows](#n-rows)

**Syntax:** y = N Rows(); y = N Rows( dt ); y = N Rows( matrix )

**Description:** Returns the number of rows in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Rows( [11 22, 33 44] );


```

### [N Table](#n-table)

**Syntax:** n = N Table()

**Description:** Returns the number of currently open data tables.

**JMP Version Added:** Before version 14

**Example 1**

```

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


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Open( "$SAMPLE_DATA/Solubility.jmp" );
d = {};
For( i = 1, i <= N Table(), i++,
    d[i] = Data Table( i ) << GetName
);
d;


```

### [Name](#name)

**Syntax:** Name(string)

**Description:** A name is simply something to call an item. Names are used for both variables and functions, and can be used directly in scripts as long as certain rules are followed. If the name begins with an alphabetic character or underscore, and continues with alphanumeric characters, whitespace, Unicode mathematical symbols and certain punctuation (apostrophes (’), percent signs (%), periods (.), backslashes (), and underscores (\_)), then the name can be used directly in scripts. Names that do not follow these rules can be used by using the Name() keyword.

**JMP Version Added:** 14

```

Name( "taxable income(2011)" ) = 456000;
tax = .25;
Print( tax * Name( "taxable income(2011)" ) );


```

### [Name Expr](#name-expr)

**Syntax:** y = Name Expr( x )

**Description:** Returns the value of a symbol, without evaluating it if it is an expression.

**JMP Version Added:** Before version 14

```

ex = Expr( 1 + 2 );
Eval List( {ex, Name Expr( ex )} );


```

### [Names Default To Here](#names-default-to-here)

**Syntax:** Names Default To Here( boolean )

**Description:** Determines where unresolved names are stored, either as a global/local ( 0 ) or in the Here: namespace ( 1 ).

**JMP Version Added:** Before version 14

```

/* Variable x will be stored in the Here: namespace by default */x = 1;
Show( x );


```

### [Namespace](#namespace)

**Syntax:** ns = Namespace( namespace reference )

**Description:** Return a reference to the namespace specified by the name argument.

**JMP Version Added:** Before version 14

```

New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
ns = Namespace( "complex" );
Show( ns );
ns << Delete;


```

### [Namespace Exists](#namespace-exists)

**Syntax:** nsexists = Namespace Exists( namespace reference )

**Description:** Returns 1 if the namespace specified by the name argument exists; otherwise a 0 is returned.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
nsexists = Namespace Exists( ns );
Show( nsexists );
ns << Delete;


```

### [NChooseK Matrix](#nchoosek-matrix)

**Syntax:** m = NChooseK Matrix( n, k )

**Description:** Creates a matrix of nChooseK(n,k) rows and k columns forming all the combinations of k integers from 1 to n.

**JMP Version Added:** Before version 14

```

Print( NChooseK Matrix( 5, 3 ) );


```

### [Neg Binomial Distribution](#neg-binomial-distribution)

**Syntax:** cumprob = Neg Binomial Distribution( p, n, k )

**Description:** Returns the probability that a negative binomially distributed random variable is less than or equal to k, where the probability of success is p and the number of successes is n.

**JMP Version Added:** Before version 14

```

exnbdp = 0.5;
exnbdn = 10;
New Window( "Example: Neg Binomial Distribution",
    exnbdy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exnbdk = 0, exnbdk < 100, exnbdk++,
            H Line(
                exnbdk,
                exnbdk + 1,
                Neg Binomial Distribution( exnbdp, Round( exnbdn ), exnbdk )
            );
            V Line(
                exnbdk + 1,
                Neg Binomial Distribution( exnbdp, Round( exnbdn ), exnbdk ),
                Neg Binomial Distribution( exnbdp, Round( exnbdn ), exnbdk + 1 )
            );
        );
        Text( {30, 0.07}, "n=", Round( exnbdn ), " p=", Round( exnbdp, 2 ) );
    ),
    H List Box( Slider Box( 0, 1, exnbdp, exnbdy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 1, 20, exnbdn, exnbdy << reshow ), Text Box( " n" ) )
);


```

### [Neg Binomial Probability](#neg-binomial-probability)

**Syntax:** prob = Neg Binomial Probability( p, n, k )

**Description:** Returns the probability that a negative binomially distributed random variable is equal to k, where the probability of success is p and the number of successes is n.

**JMP Version Added:** Before version 14

```

exnbpp = 0.5;
exnbpn = 10;
New Window( "Example: Neg Binomial Probability",
    exnbpy = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exnbpk = 0, exnbpk < 100, exnbpk++,
            V Line( exnbpk, 0, Neg Binomial Probability( exnbpp, exnbpn, exnbpk ) )
        );
        Text( {30, 0.27}, "n=", Round( exnbpn ), " p=", Round( exnbpp, 2 ) );
    ),
    H List Box( Slider Box( 0, 1, exnbpp, exnbpy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 40, exnbpn, exnbpy << reshow ), Text Box( " n" ) )
);


```

### [Negative Binomial Distribution](#negative-binomial-distribution)

**Syntax:** cumprob = Negative Binomial Distribution( k, lambda, sigma )

**Description:** Returns the probability that a Negative Binomial distributed random variable is less than or equal to k, where lambda is the location parameter, sigma is the scale parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 20;
sigma = 2;
New Window( "Example: Negative Binomial Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, Negative Binomial Distribution( k, lambda, sigma ) );
            V Line(
                k + 1,
                Negative Binomial Distribution( k, lambda, sigma ),
                Negative Binomial Distribution( k + 1, lambda, sigma )
            );
        );
        Text( {2, 0.95}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {2, 0.87}, "\!U03C3=", Round( sigma, 2 ) );
    ),
    H List Box( Slider Box( 3, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( .01, 5, sigma, ppy << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Negative Binomial Probability](#negative-binomial-probability)

**Syntax:** prob = Negative Binomial Probability( k, lambda, sigma )

**Description:** Returns the probability that a Negative Binomial distributed random variable is equal to k, where lambda is the location parameter, sigma is the scale parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 5;
sigma = 2;
New Window( "Poisson and Negative Binomial",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 20.5 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( x = 0, x <= 20, x++,
            Pen Color( "red" );
            V Line( x, 0, Poisson Probability( lambda, x ) );
            Pen Color( "blue" );
            V Line( x + 0.35, 0, Negative Binomial Probability( x, lambda, sigma ) );
        );
        Text( {1, 0.25}, "\!U03BB=", Round( lambda, 8 ), " \!U03C3=", Round( sigma, 8 ) );
        Text( {0, 0.28}, "Red = Poisson, Blue = Negative Binomial" );
    ),
    H List Box( Slider Box( 3, 10, lambda, clty << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( .01, 5, sigma, clty << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Negative Binomial Quantile](#negative-binomial-quantile)

**Syntax:** q = Gamma Negative Binomial Quantile( lambda, sigma, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Negative Binomial( lambda, sigma ) distribution is larger than or equal to cumprob.

**JMP Version Added:** 19

```

qexpl = 20;
qexps = 2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: Negative Binomial Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, Negative Binomial Distribution( qexpk, qexpl, qexps ) );
            V Line(
                qexpk + 1,
                Negative Binomial Distribution( qexpk, qexpl, qexps ),
                Negative Binomial Distribution( qexpk + 1, qexpl, qexps )
            );
        );
        Pen Color( "blue" );
        V Line( Negative Binomial Quantile( qexpl, qexps, qexpq ), 0, 1 );
        Text( {1, 0.9}, " \!U03BB=", Round( qexpl, 2 ), " \!U03C3=", Round( qexps, 2 ) );
        Text(
            {1, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( Negative Binomial Quantile( qexpl, qexps, qexpq ) )
        );
    ),
    H List Box( Slider Box( 3, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( .01, 5, qexps, qexpy << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [Net Present Value](#net-present-value)

**Syntax:** x = Net Present Value( rate, values ); x = Net Present Value( rate, value1, value2, \<value3, ...> )

**Description:** Returns the net present value of an investment by using a discount rate and a series of future payments (negative values) and income (positive values). The values argument is a one dimensional matrix. Equivalent to the NPV function in Microsoft Excel. The second prototype of the function accepts all scalar arguments.

**JMP Version Added:** Before version 14

```

Net Present Value( .05, [-10000, 1000, 900, 9500] );
Net Present Value( .05, -10000, 1000, 900, 9500 );


```

### [New CAS Action](#new-cas-action)

**Syntax:** action = New CAS Action(...)

**Description:** Creates a CAS Action.

**JMP Version Added:** 15

```


echo = [=> ];
echo["a"] = 1;
echo["b"] = JSON Literal( true );
echo["c"] = 3.141559;
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );


```

### [New CAS DATA Step action](#new-cas-data-step-action)

**Syntax:** action = New CAS DATA Step Action(...)

**Description:** Creates a CAS DATA step action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";
action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );


```

### [New CAS Server](#new-cas-server)

**Syntax:** cas = New CAS Server(\<...>)

**Description:** Creates a new CAS server.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = New CAS Server( Connect( URL( url ), Prompt( IfNeeded ) ) );


```

### [New Column](#new-column)

**Syntax:** dc = New Column( name, \<"Numeric"|"Character"|"RowState"|"Expression">, \<"Continuous"|"Ordinal"|"Nominal"|"Multiple Response"|"Unstructured Text"|"Vector"|"None">, \<Width( n )|Format(format name, width, precision)>, \<Like(:other column)>, <actions> )

**Description:** Creates a new column in the current data table. The optional actions arguments are any messages that data columns support.

**JMP Version Added:** Before version 14

**Like**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "like name", Like( :name ) );


```

**Simple**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "example", "Numeric", "Continuous", Width( 5 ), <<Set Each Value( 100 ) );


```

### [New Column by Text Matching](#new-column-by-text-matching)

**Syntax:** dc = New Column by Text Matching( Column(:name), Set Regex(), \<Output Column Name("Name")>, \<Use Result(0 | 1)> )

**Description:** Creates a new column by performing a regular expression pattern match on an existing column.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Aircraft Incidents.jmp" );
New Column by Text Matching(
    Column( :Narrative Cause ),
    Set Regex( Library( "Words" ), Library( "Time" ), Library( "Units" ) ),
    Output Column Name( "Match Output" ),
    Use Result( 1 )
);


```

### [New Custom Function](#new-custom-function)

**Syntax:** f=New Custom Function(namespace, name, function definition)

**Description:** Create a new custom function object. A custom function will be colorized in the script editor and show up in the Scripting Index. The required information for a custom user function are a namespace (to prevent collisions with global functions), a name, and a function definition. Other help information can be added using messages. Use the Add Custom Functions command to publish the new function into the JMP environment.

**JMP Version Added:** 14

**Example 1**

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );


```

**Example 2**

```

/*Create a custom function that can be used as a format*/
Add Custom Functions(
    {New Custom Function(
        "custom",
        "User Defined Format Function",
        Function( {inches},
            Char( inches ) || " in"
        ),
        <<Custom Format Category( "Custom" ), 

    )}
);


```

**Example 3**

```

/*Create a custom function that can be used as a transform*/
Add Custom Functions(
    {New Custom Function(
        "custom",
        "User Defined Transform Function",
        Function( {inches},
            inches * 2.54
        ),
        <<Transform Category( "Custom" ), 

    )}
);


```

### [New Data Connector](#new-data-connector)

**Syntax:** result = New Data Connector( Type( type ) | ID( id ) | File( path ) | Spec( string ) | Base( data connector ), < Option1( value1 ) >, ..., < OptionN( valueN ) > )

**Description:** Create a data connector configuration object.

**JMP Version Added:** 18

**Example 1**

```


// Create a data connector from scratch
dc = New Data Connector( Type( "ODBC" ), Database( "foo" ), Server( "bar.example.com" ) );
Show( dc << Get( Database ) );  // Overridden database value "foo"
Show( dc << Get( Driver ) );  // Default driver value . (missing)
dc << Set( Database( "foo2" ), Driver( "SQL Server" ) );
Show( dc << Get( Database ) );  // New database value "foo2"
Show( dc << Get( Driver ) );  // New driver value "SQL Server"


```

**Example 2**

```


// Launch Query Builder from a SQL Server data source
dc = New Data Connector(
    ID( "com.jmp.sql_server" ), 
    // All these example values need to be replaced with real ones
    Server( "database.example.com" ),
    Database( "MainDatabase" ),
    User( "username" ),
    Password( "password" )
);
New SQL Query( Connection( dc ) ) << Modify;


```

### [New Heat Image](#new-heat-image)

**Syntax:** New Heat Image( Matrix, \<Color Theme / gradient ( ... )>

**Description:** Creates a heat map image based on a matrix and color theme or gradient.

**JMP Version Added:** 16

```


nx = 20; // data is this size
ny = 15;
data = J( ny, nx, Random Normal() ); // ny=rows, nx=cols
// create a magnified matrix for seeing each value
magnify = 10;
big data = J( N Rows( data ) * magnify, N Cols( data ) * magnify );
big data = Transform Each( {z, {row, col}}, big data, 
    // and filling each value with one from the small matrix
    data[Floor( (row - 1) / magnify ) + 1, Floor( (col - 1) / magnify ) + 1]
);
New Window( "small and big",
    Lineup Box( N Col( 3 ),
        New Heat Image(
            data,
            gradient(
                {Color Theme( "Blue To Gray To Orange" ), Scale Type( "Standard Deviation" )}
            )
        ),
        New Heat Image(
            big data,
            gradient(
                {Color Theme( "Blue To Gray To Orange" ), Scale Type( "Standard Deviation" )}
            )
        ),
        New Heat Image(
            Abs( big data ),
            gradient(
                {Color Theme( "White to Black" ), Scale Values( [0 2] ),
                Reverse Gradient( 1 )}
            )
        )
    )
);


```

### [New HTTP Request](#new-http-request)

**Syntax:** obj = New HTTP Request(URL(...), Method(...), \<Form(\<Fields(...)>, \<Files(...)>)> | \<File(...)> | \<Blob(...)> | \<JSON(...)>, \<QueryString(...)>, \<Headers(...)>, \<Username(...)>, \<Password(...)>)

**Description:** Creates a request to send to a web service.

**JMP Version Added:** 14

```


getSentiment = Function( {text},
    {Default Local},
    fields = Associative Array();
    fields["text"] = text;
    s = New HTTP Request(
        URL( "http://text-processing.com/api/sentiment/" ),
        Method( "POST" ),
        Form( Fields( fields ) ),
        Headers( {"Accept: application/json"} )
    ) << Send;
    sAsList = Parse JSON( s );
    retval = Associative Array();
    retval["pos"] = sAsList["probability"]["pos"];
    retval["neg"] = sAsList["probability"]["neg"];
    retval["neutral"] = sAsList["probability"]["neutral"];
    retval["label"] = sAsList["label"];
    retval;
);

addSentimentColumns = Function( {dt, colname, bLabel, bValues},
    {Default Local},
    col = Column( dt, colname );
    colLabel = "Sentiment_Label(" || colname || ")";
    colValPos = "Sentiment_Pos(" || colname || ")";
    colValNeg = "Sentiment_Neg(" || colname || ")";
    colValNeutral = "Sentiment_Neutral(" || colname || ")";
    If( bLabel,
        dt << New Column( colLabel, Character )
    );
    If( bValues,
        dt << New Column( colValPos, Numeric );
        dt << New Column( colValNeg, Numeric );
        dt << New Column( colValNeutral, Numeric );
    );
    For( i = 1, i <= N Rows( dt ), i++,
        sentiment = getSentiment( col[i] );
        If( bLabel,
            Column( dt, colLabel )[i] = sentiment["label"]
        );
        If( bValues,
            Column( dt, colValPos )[i] = sentiment["pos"];
            Column( dt, colValNeg )[i] = sentiment["neg"];
            Column( dt, colValNeutral )[i] = sentiment["neutral"];
        );
    );
);

dt2 = Open( "$SAMPLE_DATA\Cereal.jmp" );
addSentimentColumns( dt2, "Name", 1, 1 );


```

### [New Image](#new-image)

**Syntax:** img = New Image() img = New Image( width, height ) img = New Image( pathname ) img = New Image( picture ) img = New Image( matrix of JSL color pixels ) img = New Image( rgb|r|g|rgba, {i, i, i} )

**Description:** Returns a new image which can then be edited through JSL commands. If a path is specified to an existing image file, the file should be a .JPG, .PNG, .GIF, .BMP or .TIF file.

**JMP Version Added:** Before version 14

**Example 1**

```

image = New Image( "$SAMPLE_IMAGES/windmap.png" );
New Window( "new image", image );


```

**Example 2**

```

pic = Open( "$SAMPLE_IMAGES/windmap.png", png );
image2 = New Image( pic );
New Window( "new image", image2 );


```

**Example 3**

```

image3 = New Image();
mat = J( 256, 256 );
For( y = 0, y < 256, y++,
    For( x = 0, x < 256, x++,
        mat[y * 256 + x] = RGB Color( y / 255.0, 0.0, x / 255.0 )
    )
);
image3 << Set Pixels( mat );
New Window( "image", image3 );


```

### [New IP21 Client](#new-ip21-client)

**Syntax:** New IP21 Client(URL(base URL), \<Authentication Method("None"|"Basic"|"NTLM"|"Kerberos")>, \<Username(userid)>,\<Password(password)>)

**Description:** Creates a new IP21 Client instance that can be used to import data from an AspenTech IP.21 server.

**JMP Version Added:** 19

**Example 1**

```

/* Import actual (raw) data */
/* Note: URL() and Authentication Method() use example values. Please supply a working URL and authentication credentials. */  
tag set = {"TI8045", "TI8058", "TI8064"};
end time = Today();
start time = end time - In Days( 1 );
client = New IP21 Client(
    URL( "https://myserver.com/" ),
    Authentication Method( "NTLM" ),
    Username( "%_UID_%" ),
    Password( "%_PWD_%" )
);
importer = client << Importer(
    Data Source( "My-Data-Source" ),
    Tag Set( tag set ),
    Start Time( start time ),
    End Time( end time ),
    Retrieval Type( "Actual" )
);
importer << Run;


```

**Example 2**

```

/* Import interpolated data */
/* Note: URL() and Authentication Method() use example values. Please supply a working URL and authentication credentials. */  
tag set = {"TI8045", "TI8058", "TI8064"};
end time = Today();
start time = end time - In Days( 1 );
client = New IP21 Client(
    URL( "https://myserver.com/" ),
    Authentication Method( "NTLM" ),
    Username( "%_UID_%" ),
    Password( "%_PWD_%" )
);
importer = client << Importer(
    Data Source( "My-Data-Source" ),
    Tag Set( tag set ),
    Start Time( start time ),
    End Time( end time ),
    Retrieval Type( "Interpolated" ),
    Period( Minute( 30 ) ),     /* Every half hour */
);
importer << Run;


```

### [New JMP Live](#new-jmp-live)

**Syntax:** New JMP Live(Connection("Connection Name"), \<Prompt("No" | "If Needed")>)

**Description:** Start a connection to JMP Live using stored connection information. Connection is optional and defaults to the connection specified as the default in Connection Manager. If provided it looks up the connection by the name. Prompt is optional and defaults to "No". The valid values for prompt are "Yes", "No", and "If Needed". A value of "Yes" always prompts for login credentials. A value of "No" never prompts for login credentials, but could result in an authentication failure. A value of "If Needed" prompts for credentials only if the current stored credentials are not valid. Returns a JMP Live Connection object.

**JMP Version Added:** 15

**Example 1**

```

jmplive = New JMP Live();


```

**Example 2**

```

jmplive = New JMP Live( Connection( "MyJMPLive" ), Prompt( No ) );


```

**Example 3**

```

jmplive = New JMP Live( Connection( "MyJMPLive" ), Prompt( If Needed ) );


```

### [New JMP Live Content](#new-jmp-live-content)

**Syntax:** obj = New JMP Live Content(jmpreport|Image(path_to_image)|Data(jmpdatatable)|Map(jmpmap), \<Title(...)>, \<Description(...)>, \<Publish Data(0|1)>, \<Enable Warnings(0|1)>, \<Optimization("Interactivity" | "Performance")>

**Description:** Creates interactive content for publishing on JMP Live.

```
The first parameter is required and specifies the data to use for the content. That data can be a report, a data table, a map or an image.

Title and Description are used to customize any type of content that is being published. The remaining parameters are optional and used to customize report content only.

Publish Data indicates whether the data used in the report is published to JMP Live. The data for the report is published by default.

Enable Warnings indicates whether Control Chart Warnings should be enabled for the report. Control Chart Warnings are disabled by default.

Optimization is used to customize the way the report is published to JMP Live. The report is published to enable greater interactivity by default.

```

**JMP Version Added:** 17

**Example 1**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Sample Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    dist,
    Title( "Distribution Web Report" ),
    Description( "This report was created with the sample found in the Scripting Index" ),
    Publish Data( 1 ),
    Optimization( "Interactivity" )
);

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 2**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Data Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    Data( "$SAMPLE_DATA/Big Class.jmp" ),
    Title( "Big Class Sample Table" ),
    Description(
        "This data table was published with the sample found in the Scripting Index"
    )
);

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 3**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Map Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( Map( "$SAMPLE_DATA/S4-XY.jmp" ) );

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 4**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Image Content" )
);
folder = jmpliveresult << As Scriptable;

imageContent = New JMP Live Content(
    Image( "$SAMPLE_IMAGES/black rhino footprint.jpg" ),
    Title( "Rhino Footprint" ),
    Description( "An image of a rhino footprint from the Sample Data" )
);

jmpliveresult = liveconnection << Publish( imageContent, Folder( folder ) );


```

### [New Multi HTTP Request](#new-multi-http-request)

**Syntax:** multi_request = New Multi HTTP Request()

**Description:** Sends or downloads multiple HTTP requests in parallel.

**JMP Version Added:** 17

```


requests = New Multi HTTP Request();
requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso"
        )
    )
);

requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso"
        )
    )
);

data = requests << Download( "show progress", "detailed" );
http_requests = requests << Get Requests();
For( i = 1, i <= N Items( http_requests ), i++,
    Show( http_requests[i] << Get Mime Type() )
);


```

### [New Namespace](#new-namespace)

**Syntax:** ns = New Namespace( <name>, <list of expressions> )

**Description:** Create a new namespace with the name specified by the name argument or with an anonymous name if name is not specified.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
Show( ns );
ns << Delete;


```

### [New OAuth2](#new-oauth2)

**Syntax:** oauth2 = New OAuth2()

**Description:** Creates a new OAuth2 authorization.

**JMP Version Added:** 15

```


/*
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/
auth_url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
token_url = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
redirect_url = "http://localhost/myapp/";
client_id = "6731de76-14a6-49ae-97bc-6eba6914391e";
client_secret = "JqQX2PNo9bpM0uEihUPzyrh";
scope = "openid offline_access https://graph.microsoft.com/user.read";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

auth_header = oauth2 << Get Auth Header();
request = New HTTP Request(
    URL( "https://graph.microsoft.com/v1.0/me" ),
    Headers( {auth_header} ),
    Method( "GET" )
);
data = request << Send;


```

### [New OAuth2 Token](#new-oauth2-token)

**Syntax:** token = New OAuth2 Token( Account("jmpgoogldev@gmail.com"), Client ID("test"), Client Secret("test 2"), Refresh Token(""), Token URL(""))

**Description:** Creates an OAuth2 Token for securely accessing data across many different web APIs.

**JMP Version Added:** 15

```

token = New OAuth2 Token(
    Account( "jmpgoogldev@gmail.com" ),
    Client ID( "test" ),
    Client Secret( "test 2" ),
    Refresh Token( "" ),
    Token URL( "" )
);


```

### [New Object](#new-object)

**Syntax:** New Object( "class name" | class name | class reference( constructor arguments\* ) )

**Description:** Creates an instance object of a class.

**JMP Version Added:** 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
cl << Delete;
Delete Classes( "complex" );


```

### [New PI Client](#new-pi-client)

**Syntax:** New Pi Client(URL(base URL), \<Authentication Method("None"|"Basic"|"NTLM"|"Kerberos")>, \<Username(userid)>,\<Password(password)>)

**Description:** Creates a new PI Client instance that can be used to import data from a PI server.

**JMP Version Added:** 17

**Example 1**

```

/* Import raw data */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "basic" ),
    Username( "myuserid" ),
    Password( "mypassword" )
);
importer = client << Importer(
    AF Path( "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A" ), /* Asset Framework path */
    Series( "raw" ),
    Start Time( "*-1d" ), /* PI time string */
    End Time( "*" ),      /* PI time string */
    Boundary Type( "inside" ), /* choices are "inside", "outside", "interpolated" */
    UTC( 0 ), /* whether specified start/end times are based on UTC - default is zero */
    Max Count( 5000 ), /* Max. number of values to fetch - default is 5000 */
    Filter( "" ), /* Optional filter */
    Retrieve Attribute Status( 0 ) /* Whether to retrieve value attributes (i.e. "good", "questionable", "substituted", "annotated") - default is 0 */
);
importer << Run;


```

**Example 2**

```

/* Import plot data using Kerberos for authentication */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "kerberos" )
);
importer = client << Importer(
    AF Path( "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A" ),
    Series( "plot" ),
    Start Time( "*-1d" ),
    End Time( "*" ),
    UTC( 0 ),
    Intervals( 24 )
); /* No of time intervals to fetch*/
importer << Run;


```

**Example 3**

```

/* Import interpolated data from a server that does not require authentication */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "none" )
);
importer = client << Importer(
    AF Path( "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A" ),
    Series( "interpolated" ),
    Start Time( "*-1d" ),
    End Time( "*" ),
    UTC( 0 ),
    Sync Time Boundary Type( "inside" ),   /*  choices are "inside", "outside" */
    Interval( "1h" ),            /* interval period */
    Sync Time( "01JUL2021" ),    /* optional sync point - ie. intervals begin from this point */
    Filter( "" )
);
importer << Run;


```

### [New Project](#new-project)

**Syntax:** project = new Project( <project messages> )

**Description:** Creates a new empty project window. One or more project messages can be included as arguments in order to create a project in one step.

**JMP Version Added:** Before version 14

**Example 1**

```

project = New Project();


```

**Example 2**

```

project = New Project(
    Run Script(
        dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
        dt << Run Script( "Bivariate" );
    )
);


```

**Example 3**

```

project = New Project(
    Run Script(
        Open( "$SAMPLE_DATA/Big Class.jmp" );
        New Window( "Big Class - Bivariate of weight by height",
            Bivariate( Y( :weight ), X( :height ) )
        );
    )
);


```

**Example 4**

```

project = New Project(
    Set Bookmarks(
        {File( "$SAMPLE_DATA/Animals.jmp" ), File( "$SAMPLE_DATA/Big Class.jmp" )}
    ),
    Run Script(
        Open( "$SAMPLE_DATA/Big Class.jmp" );
        New Window( "Big Class - Bivariate of weight by height",
            Bivariate( Y( :weight ), X( :height ) )
        );
    )
);


```

**Example 5**

```

project = New Project(
    Run Script( Open( "$SAMPLE_SCRIPTS/demoCorr.jsl", Set Window ID( "demoCorr" ), Script ) ),
    Set Layout(
        H Splitter Box(
            <<Set Sizes( {0.15, 0.85} ),
            Tab Page Box( Title( "Window List" ), Window ID( "Windows" ) ),
            V Splitter Box(
                <<Set Sizes( {0.7, 0.3} ),
                Tab Page Box( Title( "demoCorr" ), Window ID( "demoCorr" ) ),
                Tab Page Box( Title( "Log" ), Window ID( "Log" ) )
            )
        )
    )
);


```

### [New SQL Query](#new-sql-query)

**Syntax:** obj = New SQL Query( Connection( "ODBC:my_connection_string" ), Select( Column( "mycolumn", "t1" ) ), From( Table( "my_table", Schema( "my_schema" ), Alias( "t1" ) ) ) ); obj = New SQL Query( Connection( "ODBC:my_connection_string;" ), CustomSQL( "SELECT c1, c2, c3 FROM my_table;" ) )

**Description:** Creates an SQL Query object for the connection, columns and table specified, or for the custom SQL query specified. Use Query Builder to generate scripts that create queries.

**JMP Version Added:** Before version 14

```


obj = New SQL Query(
    Connection( "ODBC:DSN=mydsn" ),
    Select(),
    From( Table( "my_table", Schema( "my_schema" ), Alias( "t1" ) ) )
);


```

### [New Table](#new-table)

**Syntax:** dt = New Table( name, \<visibility("private"|"invisible"|"visible")>, \<Enable Filter Views(bool)>, <actions> )

**Description:** Creates a new data table. "Invisible" hides the data table from view but lists it in the JMP Home Window. "Private" hides the table completely. "Visible" is the default, and creates a normal table that is visible and listed in the JMP Home Window. The optional actions arguments are any messages that data tables support.

**JMP Version Added:** Before version 14

```

New Table( "Little Class",
    Add Rows( 3 ),
    New Column( "name", Character, Nominal, Set Values( {"KATIE", "LOUISE", "JANE"} ) ),
    New Column( "age", Nominal, Set Values( [12, 13, 13] ) ),
    New Column( "weight", Continuous, Set Values( [95, 123, 74] ) )
);


```

### [New Web Report](#new-web-report)

**Syntax:** obj = New Web Report(...)

**Description:** Creates an interactive HTML report.

**JMP Version Added:** 14

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
webreport = New Web Report(
    Add Report(
        Distribution(
            Continuous Distribution( Column( :weight ) ),
            Nominal Distribution( Column( :age ) )
        ),
        Title( "Distribution Web Report" ),
        Description( "This report was created with the sample found in the Scripting Index" )
    ),
    Add Report(
        Bivariate(
            Y( :weight ),
            X( :height ),
            Automatic Recalc( 1 ),
            Fit Line( {Line Color( {213, 72, 87} )} ),
            Local Data Filter( Add Filter( columns( :sex ) ) )
        )
    )
);
webreport << Index( Title( "Big Class Report" ) );
file = webreport << Save( "$TEMP" );
If( !Is Empty( file ),
    Web( file )
);


```

### [New Window](#new-window)

**Syntax:** w = New Window( title, < \<<Type("Report" | "Dialog" | "Modal Dialog" | "Journal" | "Launcher" | "Script")>, < \<< Return Result>, < \<< On Open(expr | function | method)>, < \<< On Close(expr | function | method)>, < \<<On Validate(expr | function | method)>, < \<<Show Menu(0 | 1)>, < \<<Show Toolbars(0 | 1)>, < \<<Suppress AutoHide(0 | 1)>, < \<<Window View("Visible" | "Invisible")>, < \<<Language("C" | "JavaScript" | "JSL" | "JSON" | "Python" | "R" | "SAS" | "SQL" | "Text" | "XML")>, < \<<Size(x, y)>, displayBox | script)

**Description:** Creates a window containing the specified display box or script. A report window is created by default, unless the Type option is specified. A window of Type("Modal Dialog") halts execution until the dialog is responded to. On Open, On Validate, and Return Result are available only for modal windows. On Open() evaluates its expression, function, or class method when the window is created. If On Close() returns false, the window is prevented from closing. On Validate() runs its expression, function, or class method when the OK button is clicked. If the expression returns true, the window is closed. Otherwise, the window remains open. Return Result changes the window's return value when it closes to match that of the deprecated Dialog() function. For window types that support toolbars, use Show Toolbars to specify changes from the default behavior. The options Show Menu and Suppress AutoHide are Windows only. The Window View("Invisible") option can be used for any window other than a Modal Dialog. A window of Type("Script") creates a JSL document unless the \<<Language option is specified.

**JMP Version Added:** Before version 14

**[Win] Toolbars and Menus**

```

// Compare settings for toolbars and menus
// Suppress AutoHide is Windows only
g = Graph Box(
    Frame Size( 300, 300 ),
    Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    Pen Color( "Blue" );
    Line( [10 30 70], [88 22 44] );
);
New Window( "Default - menu and toolbars", g );
New Window( "Menu, no toolbars, suppress autohide",
    Suppress AutoHide( 1 ),
    Show Toolbars( 0 ),
    g
);
New Window( "Toolbars, no menu", Show Menu( 0 ), g );
New Window( "No menu, no toolbars", Show Menu( 0 ), Show Toolbars( 0 ), g );


```

**Dialog**

```


ex = New Window( "Dialog example",
    <<Type( "Dialog" ),
    V List Box(
        Panel Box( "Sample data dialog",
            Button Box( "Open Sample Data", Open( "$SAMPLE_DATA/Big Class.jmp" ) )
        ),
        H List Box( Button Box( "Close", Try( ex << CloseWindow ) ) )
    )
);


```

**Invisible**

```


g = Graph Box(
    Frame Size( 300, 300 ),
    Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    Pen Color( "Blue" );
    Line( [10 30 70], [88 22 44] );
);
w = New Window( "My Window's Title", <<WindowView( "Invisible" ), g );
p = w << Get Picture();
w << Close Window;
psize = p << Size;
New Window( "picture", Outline Box( "picture size: " || Char( psize ), p ) );


```

**Modal Dialog**

```


ex = New Window( "Modal Dialog example",
    <<Type( "Modal Dialog" ),
    <<Return Result,
    <<On Validate(
        num = myEditBox << Get;
        If( num >= 1 & num <= 100, // in range
            myEditBox << Background Color( "Background" ); // this field does not need attention
            1; //the number is good, validate
        , // else out of range
            myEditBox << Background Color( "Light Yellow" ); // this field needs attention
            0; // the number is bad, do not validate
        ) // the result of this if(...) is the OnValidate( ) answer, 0 or 1
        ;
    ),
    V List Box(
        Text Box( "Enter a value between [1,100]:" ),
        H List Box( myEditBox = Number Edit Box( 42 ) ),
        H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
    )
);

//  the Modal window must be closed before the following code runs

If(
    ex["button"] == 1 // not canceled
, // then show the value
    Write( ex["myEditBox"] ); // note: myEditBox is the name of the variable holding the text edit box
, // else report no selection
    Write( "CANCEL" ); // cancel button or red X was pressed
);


```

**Python script**

```

pyscript = "\[import numpy as np
a = np.arange(15).reshape(3, 5)]\";
ex = New Window( "Script example", <<Type( "Script" ), <<Language( "Python" ), pyscript );


```

**Report**

```

g = Graph Box(
    Frame Size( 300, 300 ),
    Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    Pen Color( "Blue" );
    Line( [10 30 70], [88 22 44] );
);
New Window( "My Window's Title", g );


```

**Script**

```

script = JSL Quote(Names Default To Here(1);
dt=Open("$SAMPLE_DATA/Big Class.jmp");
dt << Run Script("Bivariate");
);
ex = New Window( "Script example", <<Type( "Script" ), script );


```

### [Normal Biv Distribution](#normal-biv-distribution)

**Syntax:** y = Normal Biv Distribution( x, y, r, \<mu1=0>, \<s1=1>, \<mu2=0>, \<s2=1> )

**Description:** Computes the probability that an observation (X, Y) is less than or equal to (x, y) with correlation coefficient r where X is marginally normally distributed with mean mu1 and standard deviation s1 and Y is marginally normally distributed with mean mu2 and standard deviation s2. If mu1, s1, mu2, and s2 are not given, the function assumes the standard normal bivariate distribution with mu1=0, s1=1, mu2=0, and s2=1.

**JMP Version Added:** Before version 14

```

Normal Biv Distribution( -2, -2, .5, 1, 1.5, -1, 2 );


```

### [Normal Contour](#normal-contour)

**Syntax:** Normal Contour( prob, meanMatrix, stdMatrix, corrMatrix, <colorsMatrix>, \<fill=0> )

**Description:** Draws normal probability contour(s) for k populations and two variables. The prob argument can be either a scalar probability or a matrix of probabilities. The meanMatrix and stdsMatrix arguments are k by 2 matrices, and the corrMatrix argument is a k by 1 vector. The colorsMatrix argument specifies the color(s) for the k contour(s); colors must be specified as JSL colors (either JSL color integer values or return values of JSL color functions such as the RGB Color() or HLS Color() functions). The fill argument specifies the amount of transparency for the contour fill color.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "blue" );
        Normal Contour( 0.95, [40 40], [15 5], [0.5], Empty(), 0.1 );,
        Normal Contour(
            0.95,
            [40 40, 60 50],
            [15 5, 10 10],
            [-0.9, -0.5],
            Matrix( {RGB Color( {0.1, 0.9, 0.1} ), 3} ),
            0.2
        )
    )
);


```

### [Normal Density](#normal-density)

**Syntax:** y = Normal Density( q, \<mu=0>, \<sigma=1> )

**Description:** Returns the density at q of a Normal distribution with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Density",
    y = Graph Box(
        Y Scale( 0, 0.45 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Density( q ), q );
    )
);


```

### [Normal Distribution](#normal-distribution)

**Syntax:** p = Normal Distribution( q, \<mu=0>, \<sigma=1> )

**Description:** Returns the probability that a normally distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Distribution( q ), q );
    )
);


```

### [Normal Integrate](#normal-integrate)

**Syntax:** {mean, var} = Normal Integrate( muVector, sigmaMatrix, expr, x, NStrata, NSim )

**Description:** Returns the result of radial-spherical integration for smooth functions of multivariate normal variables. The basic idea is the same as one method in Genz and Monahan(1996). But Radau-Gauss-Laguerre type quadrature is used for the radial direction.

**JMP Version Added:** Before version 14

```

Normal Integrate(
    J( 3, 1, 0 ),
    Identity( 3 ),
    ex[1] ^ 4 * ex[2] ^ 2 * ex[3] ^ 2,
    ex,
    2,
    5000
);


```

### [Normal Log CDistribution](#normal-log-cdistribution)

**Syntax:** y = Normal Log CDistribution( x, \<mean=0>, <std dev=1> )

**Description:** Returns the log of 1 - Normal distribution at x with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Log CDistribution",
    nlcdiy = Graph Box(
        Y Scale( -10, 0.05 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Log CDistribution( q ), q );
    )
);


```

### [Normal Log Density](#normal-log-density)

**Syntax:** y = Normal Log Density( x, \<mu=0>, \<sigma=1>)

**Description:** Returns the log of the Normal probability density at x with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Log Density",
    nldey = Graph Box(
        Y Scale( -9, 0.05 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Log Density( q ), q );
    )
);


```

### [Normal Log Distribution](#normal-log-distribution)

**Syntax:** y = Normal Log Distribution( x, \<mean=0>, <std dev=1> )

**Description:** Returns the log of the Normal distribution at x with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Log Distribution",
    nldiy = Graph Box(
        Y Scale( -10, 0.05 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Log Distribution( q ), q );
    )
);


```

### [Normal Mixture Density](#normal-mixture-density)

**Syntax:** y = Normal Mixture Density(q, meanvec, sdvec, probvec)

**Description:** Returns the density at q of a normal mixture distribution with group means meanvec, group standard deviations sdvec, and group probabilities probvec. Here meanvec, sdvec, and probvec are all vectors of the same size.

**JMP Version Added:** Before version 14

```

mu1 = -2;
mu2 = 2;
sigma1 = 1;
sigma2 = 4;
p1 = .5;
t1 = mu1 |/ mu2;
t2 = sigma1 |/ sigma2;
t3 = p1 |/ (1 - p1);
New Window( "Univariate Normal Mixture Density",
    clty = Graph Box(
        Y Scale( 0, 0.4 ),
        X Scale( -8, 8 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        t1 = mu1 |/ mu2;
        t2 = sigma1 |/ sigma2;
        t3 = p1 |/ (1 - p1);
        Y Function(
            Normal Mixture Density( y, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            y
        );
        Text( {-7, .37}, "Mean1=", Round( mu1, 2 ) );
        Text( {-2, .37}, "Mean2=", Round( mu2, 2 ) );
        Text( {-7, .34}, "SD1=", Round( sigma1, 2 ) );
        Text( {-2, .34}, "SD2=", Round( sigma2, 2 ) );
        Text( {-7, .31}, "P1=", Round( p1, 2 ) );
        Text( {-2, .31}, "P2=", Round( 1 - p1, 2 ) );
    ),
    H List Box( Slider Box( -3, 3, mu1, clty << reshow ), Text Box( " Mean 1" ) ),
    H List Box( Slider Box( -3, 3, mu2, clty << reshow ), Text Box( " Mean 2" ) ),
    H List Box( Slider Box( .1, 9, sigma1, clty << reshow ), Text Box( " Std Dev 1" ) ),
    H List Box( Slider Box( .1, 9, sigma2, clty << reshow ), Text Box( " Std Dev 2" ) ),
    H List Box( Slider Box( 0, 1, p1, clty << reshow ), Text Box( " P 1" ) ), 

);


```

### [Normal Mixture Distribution](#normal-mixture-distribution)

**Syntax:** y = Normal Mixture Distribution(q, meanvec, sdvec, probvec)

**Description:** Returns the probability that a normal mixture distributed variable with group means meanvec, group standard deviations sdvec, and group probabilities probvec is less than q. Here meanvec, sdvec, and probvec are all vectors of the same size.

**JMP Version Added:** Before version 14

```

mu1 = -2;
mu2 = 2;
sigma1 = 1;
sigma2 = 4;
p1 = .5;
New Window( "Univariate Normal Mixture Distribution",
    clty = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -8, 8 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        Y Function(
            Normal Mixture Distribution( y, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            y
        );
        Text( {-7, .95}, "Mean1=", Round( mu1, 2 ) );
        Text( {-2, .95}, "Mean2=", Round( mu2, 2 ) );
        Text( {-7, .85}, "SD1=", Round( sigma1, 2 ) );
        Text( {-2, .85}, "SD2=", Round( sigma2, 2 ) );
        Text( {-7, .75}, "P1=", Round( p1, 2 ) );
        Text( {-2, .75}, "P2=", Round( 1 - p1, 2 ) );
    ),
    H List Box( Slider Box( -3, 3, mu1, clty << reshow ), Text Box( " Mean 1" ) ),
    H List Box( Slider Box( -3, 3, mu2, clty << reshow ), Text Box( " Mean 2" ) ),
    H List Box( Slider Box( .1, 9, sigma1, clty << reshow ), Text Box( " Std Dev 1" ) ),
    H List Box( Slider Box( .1, 9, sigma2, clty << reshow ), Text Box( " Std Dev 2" ) ),
    H List Box( Slider Box( 0, 1, p1, clty << reshow ), Text Box( " P 1" ) ), 

);


```

### [Normal Mixture Quantile](#normal-mixture-quantile)

**Syntax:** q = Normal Mixture Quantile(p, meanvec, sdvec, probvec)

**Description:** Returns the quantile from a normal mixture distribution, the values for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

extqdf = 1;
extqqq = 0.5;
mu1 = -1;
mu2 = 1;
sigma1 = 1;
sigma2 = 4;
p1 = .3;
New Window( "Example: Normal Mixture Quantile",
    extqgr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Pen Size( 2 );
        Y Function(
            Normal Mixture Distribution( q, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            q
        );
        Pen Color( "blue" );
        V Line(
            Normal Mixture Quantile( extqqq, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            0,
            1
        );
        Text( {-4.5, 0.9}, " quantile=", Round( extqqq, 2 ) );
    ),
    H List Box( Slider Box( 0.01, 0.99, extqqq, extqgr << reshow ), Text Box( " quantile" ) ),
    H List Box( Slider Box( -3, 3, mu1, extqgr << reshow ), Text Box( " Mean 1" ) ),
    H List Box( Slider Box( -3, 3, mu2, extqgr << reshow ), Text Box( " Mean 2" ) ),
    H List Box( Slider Box( .1, 9, sigma1, extqgr << reshow ), Text Box( " Std Dev 1" ) ),
    H List Box( Slider Box( .1, 9, sigma2, extqgr << reshow ), Text Box( " Std Dev 2" ) ),
    H List Box( Slider Box( 0, 1, p1, extqgr << reshow ), Text Box( " P 1" ) ), 

);


```

### [Normal Quantile](#normal-quantile)

**Syntax:** q = Normal Quantile( p, \<mu=0>, \<sigma=1> ); q = Probit( p )

**Description:** Returns the quantile from a Normal distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

Normal Quantile( 0.9 );


```

### [Normal Tolerance Factor](#normal-tolerance-factor)

**Syntax:** q = Normal Tolerance Factor( 1-alpha, p, n, <One Sided> )

**Description:** Computes the tolerance factor for constructing a 1-alpha confidence interval to contain proportion p of the means with sample size n from the normal distribution. There is an option to request the factor for a one-sided tolerance interval.

**JMP Version Added:** 19

```

n = 15;
New Window( "Example: Tolerance Factor()",
    tdig = Graph Box(
        Y Scale( 0, 5 ),
        X Scale( 0.05, 0.95 ),
        Yname( "Tolerance Factor" ),
        Xname( "p" ),
        Pen Color( "red" );
        Y Function( Normal Tolerance Factor( 0.95, p, n ), p );
        Text( {0.1, 4}, "n=", Round( n ) );
    ),
    H List Box( Text Box( "n" ), Slider Box( 5, 25, n, tdig << reshow ) )
);


```

### [Not](#not)

**Syntax:** y = !x; y = Not( x )

**Description:** Returns the logical NOT of x: 1 if x is zero, missing if x is missing, and 0 otherwise.

**JMP Version Added:** Before version 14

```

!(1 < 2);


```

### [Not Equal](#not-equal)

**Syntax:** z = x != y != ...; z = Not Equal( x, y, ... )

**Description:** Returns 1 if each argument is not equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 != 2 != 1;


```

### [Notebook](#notebook)

**Syntax:** nb = Notebook( name|number )

**Description:** Returns a reference to the specified notebook.

**JMP Version Added:** 19

### [Nth Day Of Week in the Month](#nth-day-of-week-in-the-month)

**Syntax:** n = Nth Day Of Week in the Month( datetime )

**Description:** Returns an integer that represents the number of instances of the day of the week of the datetime argument that have occurred in the month. For example, November 28, 2019 is the 4th Thursday of the month, so the function returns 4.

**JMP Version Added:** 16

```

Nth Day Of Week in the Month( Date MDY( 11, 28, 2019 ) );


```

### [Num](#num)

**Syntax:** y = Num( s, < \<<Use Locale( use=1 ) >, < \<<Restrict > )

**Description:** Converts s to a number using any built-in format, including date and currency formats. Returns missing if the conversion fails. The optional \<<Restrict only allows conversion using integer, decimal, and scientific formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Show( Num( "3.1e6" ), Num( "1989-10-04" ), Num( "5%" ), Num( "£23" ) );


```

**Example 2**

```

Show(
    Num( "3.1e6", <<Restrict ),
    Num( "1989-10-04", <<Restrict ),
    Num( "5%", <<Restrict ),
    Num( "£23", <<Restrict )
);


```

### [Num Deriv](#num-deriv)

**Syntax:** y = Num Deriv( f( x, ... ), <parnum>)

**Description:** Returns the numerical derivative of the f( x,... ) function with respect to one of its arguments. You can specify that argument as the second argument in the Num Deriv function. If no second argument is specified, the derivative is taken with respect to the function's first argument. The derivative is evaluated using numeric values specified in the f( x,... ) function expression.

**JMP Version Added:** Before version 14

```

f = Function( {x, y}, x ^ 2 + y );
Num Deriv( f( 2, 1 ) );
Num Deriv( f( 2, 1 ), 2 );


```

### [Num Deriv2](#num-deriv2)

**Syntax:** y = Num Deriv2( f( x, ... ) )

**Description:** Returns the numerical second derivative of the f( x,... ) function with respect to x. The derivative is evaluated using numeric values specified in the f( x,... ) function expression.

**JMP Version Added:** Before version 14

```

f = Function( {x}, x ^ 3 );
Num Deriv2( f( 2 ) );


```

### [Number](#number)

**Syntax:** y = Number( x1, ... )

**Description:** Returns the number of non-missing arguments or values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Number( 12, ., 11, 0, -42 ), Number( [33 . -42 . 0 . -30] )} );


```

### [Number Col Box](#number-col-box)

**Syntax:** y = Number Col Box( title, numbers )

**Description:** Returns a display box to show the numbers specified by the numbers argument, which can be a list or matrix.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [Number Col Edit Box](#number-col-edit-box)

**Syntax:** y = Number Col Edit Box( title, numbers )

**Description:** Returns a display box to show the numbers specified by the numbers argument, which can be a list or matrix.

**JMP Version Added:** Before version 14

```

x = y = z = 0;
New Window( "Example",
    Modal,
    <<Return Result,
    Outline Box( "Table", Table Box( neb = Number Col Edit Box( "values", {x, y, z} ) ) )
);


```

### [Number Edit Box](#number-edit-box)

**Syntax:** y = Number Edit Box( initValue, <width> )

**Description:** Returns an edit box that accepts only numeric input. Specify the optional width argument to set the width of the box in characters.

**JMP Version Added:** Before version 14

```

New Window( "Example", neb = Number Edit Box( 5 ) );
x = neb << get;


```

### [Number of Periods](#number-of-periods)

**Syntax:** x = Number of Periods( rate, pmt, pv, \<fv=0>, \<type=0> )

**Description:** Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the NPER function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Number of Periods( .05 / 12, -2000, 100000 );


```

### [Open](#open)

**Syntax:** Open( filePath, \<data table options | Excel import options | text import options | SAS import options | HTML import options | esriShapeFile import options | PDF import options | other file options > )

**Description:** Returns a reference to a data table or other JMP file or object created from a file. If no path is specified, the Open dialog appears. If a folder path is specified, the system file browser is opened and no object is returned. Refer to the Syntax Reference for a complete description of available options.

**JMP Version Added:** Before version 14

**Add-In**

```

/* Installing Add-In:
Open( Add-In to open,
    <Check For Updates( "never" | "startup" | "always")>, // "always" will check for updates at startup and while jmp is running
    <Update Prompt(0|1)>) // whether or not the add-in will silently update or prompt first */
Open( "$downloads\test.jmpaddin", Check For Updates( "always" ), Update Prompt( 1 ) );


```

**Data Table**

```

/* Data tables, other JMP files, external files:
   Open( filePath,
     <Invisible | Private>,
     <Select Columns( "col", ... )>,
     <Ignore Columns( "col", ... )>,
     <Add to Recent Files(bool)>,
     <Quarantine Action("Allow Scripts"|"Block Scripts"|"Do Not Open"|"Show Dialog")>
     <Force Refresh>,
     <Enable Filter Views(bool)>,
     <"file type">
   )
*/
//Basic data table open
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
//Data table open with some options
dt2 = Open( "$SAMPLE_DATA/Fitness.jmp", Select Columns( "Name", "Sex", "Age", "Weight" ) );


```

**Excel**

```

/* Excel files imported into a data table:
   Open( excelFilePath,
     <Worksheets( "sheet name" | {"sheet name", "sheet name", ...} | "n" )>,
     <Use for all sheets(0|1)>,
     <Concatenate Worksheets(0|1)>,
     <Create Concatenation Column(0|1)>,
     <Worksheet Settings( 0|1,
       Has Column Headers(0|1),
       Number of Rows in Headers(n),
       Headers Start on Row(n),
       Data Starts on Row(n),
       Data Starts on Column(n),
       Data Ends on Row(n),
       Data Ends on Column(n),
       Replicated Spanned Rows(0|1),
       Suppress Hidden Rows(0|1),
       Suppress Hidden Columns(0|1),
       Treat as Hierarchy(0|1)
     )>,
     <Invisible | Private>
   )
*/

/* Using the Excel Wizard dialog:
   Open("$SAMPLE_IMPORT_DATA/Bigclass.xlsx", "Excel Wizard");  
*/

dt = Open(
    "$SAMPLE_IMPORT_DATA/Team Results.xlsx",
    Worksheets( "Ungrouped Team Results" ),
    Worksheet Settings( Headers Start on Row( 3 ), Data Starts on Row( 4 ) )
);


```

**Folder**

```

/* Open of folder launches file browser */
Open( "$SAMPLE_DATA" );


```

**Other**

```

/* Other options:
   SAS File imported as a data table:
   Open( sasFilePath,
     <Invisible | Private>,
     <Use Labels for Var Names(0|1)>,
     <Password( "password" )>
   )

   SAS Transport File imported as a data table, members are separate tables within the larger file:
   Open( sasTransportFilePath,
     <Use Labels for Var Names(0|1)>,
     <Members({"Table1", "Table2"})>
   )

   HTML file imported as a data table:
   Open( htmlFilePath,
     <Invisible | Private>,
     <HTML Table(n, <ColumnNames(n)>, DataStarts(n)>)>
   )

   Get column names as a list for a JMP Data Table without opening the table:
   Open( jmpDataTableFilePath, 
     "Column Names Only"
   )

   esriShapeFile opened for use as a map shape data table:
   Open( esriShapeFilePath,
     <Invisible | Private>,
     Columns( Shape=numeric(n),
     Part=numeric(n),
     X=numeric(n),
     Y=numeric(n) ),
              Polygon Import Options(Simplification Factor(f), Geodesic(g))
   )
*/
//SAS Example:
dt1 = Open( "$SAMPLE_IMPORT_DATA/Bigclass.sas7bdat", Use Labels for Var Names( 1 ) );

// HTML Example:
dt2 = Open(
    "https://en.wikipedia.org/wiki/Black_Mountains_(North_Carolina)",
    HTML Table( 3, Column Names( 1 ), Data Starts( 2 ) )
);

// Column Names Only Example: 
colNames = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp", "Column Names Only" );

// SHP Shapefile Example with polygon simplification: 
Open(
    "$SAMPLE_IMPORT_DATA/parishes.shp",
    Polygon Import Options( Simplification Factor( 200 ), Geodesic( 1 ) )
);


```

**PDF**

```

/* PDF file imported as one or multiple data tables
open(pdfFilePath,
    PDF Tables(Table(<Name(name)>, Add Rows(Page(n | {page list}), <Header Rows(n)>, Rect(top, left, right, bottom), <RowBorders(n, ...)>, <Column Borders(n, ....)>), ...)) |
    PDF All Tables(< Combine(All | Matching Headers | None)>, <Minimum Rows(n)>, <Minimum Columns(n)>) |
    PDF Text(<Pages(n, ...)>, <sort>) |
    PDF Wizard
);*/
dt = Open( "$SAMPLE_DATA\big class.jmp" );
w = New Window( "test", Data Table Box( dt ) );
w << save picture( "$DOCUMENTS\test.pdf", pdf );
pdftable = Open( "$DOCUMENTS\test.pdf", PDF All Tables( Combine( all ) ) ); // just some of the rows
pdftable2 = Open(
    "$DOCUMENTS\test.pdf",
    PDF Tables( Table( Table Name( "test" ), Add Rows( Page( 1 ), Rect( 0, 0, 5, 3 ) ) ) )
);


```

**Picture**

```

/* Picture file imported as a picture object */
pic = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
New Window( "Picture", Outline Box( "Picture", Picture Box( pic ) ) );


```

**Text**

```

/* Text files imported into a data table:
   Open( textFilePath,
     <Invisible | Private>,
     CharSet("option") // "Best Guess", "utf-8", "utf-16", "us-ascii", "windows-1252", "x-max-roman", "x-mac-japanese", "shift-jis", "euc-jp", "utf-16be", "gb2312"
     <Number of Columns(n)>,
     <Columns(colName=colType(colWidth),... )>,// colType is Character|Numeric and colWidth is an integer specifying the width of the column
     <End Of Field (Tab|Space|Comma|Semicolon|Other|None)>,
     <EOF Other ("char")>,
     <End Of Line (CRLF|CR|LF|Semicolon|Other)>,
     <EOL Other ("char")>,
     <Strip Quotes|Strip Enclosing Quotes (0|1)>,
     <Labels|Table Contains Column Headers (0|1)>,
     <Year Rule|Two digit year rule ("decade start")>, // For example, if the earliest date is 1979, use "1970". If the earliest date is 2001, use "20xx".
     Treat Empty Columns as Numeric(0|1)
     Scan Whole File(0|1) // 1 means scan the whole file and 0 means scan for 5 seconds.
     <Column Names Start|Column Names are on line (n)>,
     <Data Starts|Data starts on line (n)>,
     <Lines to Read>, // a number
     <Use Apostrophe as Quotation Mark>,
     <CompressNumericColumns(0|1)>,
     <CompressCharacterColumns(0|1)>,
     <CompressAllowListCheck(0|1)>
   )
*/
dt = Open( "$SAMPLE_IMPORT_DATA/EOF_comma.txt", Table Contains Column Headers( 0 ) );


```

### [Open Database](#open-database)

**Syntax:** dt = Open Database( dataSourceName|"Connect Dialog", "SELECT ..."|"SQLFILE=..."|tableName, \<invisible | private>, <outputTableName> )

**Description:** Opens a database using ODBC, runs the given SQL, and puts data into a data table with the given output table name.

**JMP Version Added:** Before version 14

```

Open Database(
    "DSN=dBASE Files;DBQ=C:/Program Files/JMP/JMPPRO/19/Samples/Import Data/;",
    "SELECT HEIGHT, WEIGHT FROM Bigclass",
    "hw"
);


```

### [Open Datafeed](#open-datafeed)

**Syntax:** y = Open Datafeed( ... )

**Description:** Creates an object and window you can send messages to manage real-time data feeds.

**JMP Version Added:** Before version 14

```

exfeed = Open Datafeed(/*Connect( Port( "com3" ), Baud( 4800 ), DataBits( 8 ) ),*/
    Set Script(
        ex = exfeed << getLine;
        Show( ex );
    )
);
For( exi = 0, exi < 5, exi++, /* this is just a way to test a feed when the real data source is not available...*/
    exfeed << Queue Line( Char( exi ) );
    Wait( .5 );
);


```

### [Open Help](#open-help)

**Syntax:** w = Open Help( "Help" | "Scripting Index", ... )

**Description:** Opens the online JMP help or the Scripting Index.

**JMP Version Added:** Before version 14

**Example 1**

```

Open Help( "Help" );


```

**Example 2**

```

Open Help(
    "Scripting Index",
    Search( Term( "Open" ), Match( {"Contains Terms", "Match All Terms", "Ignore Case"} ) ),
    IndexContext( Category( "Functions" ) )
);


```

**Example 3**

```

Open Help(
    "Scripting Index",
    Search( Term( "alpha" ), Match( {"Contains Terms", "Match All Terms", "Ignore Case"} ) ),
    IndexContext(
        Category( "All Categories" ),
        Object( "Search results" ),
        Method( "Get Alpha" )
    )
);


```

### [Open Log](#open-log)

**Syntax:** Open Log( <bring window to top> )

**Description:** Open the log window

**JMP Version Added:** Before version 14

**Example 1**

```

Open Log();
Show( Is Log Open() );


```

**Example 2**

```

/* Bring Log Windows to the Top */
Open Log( 1 );
Show( Is Log Open() );


```

### [Or](#or)

**Syntax:** y = x1 | x2; y = Or( x1, x2, ... )

**Description:** Returns the logical OR of all arguments: 1 if any arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

1 < 2 | 3 < 2;


```

### [OrMZ](#ormz)

**Syntax:** y = OrMZ( x1, x2, ... )

**Description:** Returns the logical OR of all arguments with missing values treated as zeros: 1 if any arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

OrMZ( 1 < 2, 3 < 2 );


```

### [Ortho](#ortho)

**Syntax:** L = Ortho( A, \<Centered( 1 )>, \<Scaled( 1 )> )

**Description:** Orthogonalizes the columns of a matrix. Center option makes them sum to zero. Scale option makes them unit length.

**JMP Version Added:** Before version 14

```

Ortho( [1 1, 1 -1] );


```

### [Ortho Poly](#ortho-poly)

**Syntax:** L = Ortho Poly( V, order )

**Description:** Returns orthogonal polynomials of vector V up to order specified by the order argument. The V argument can be a row or column vector. Scale option makes them unit length.

**JMP Version Added:** Before version 14

```

Ortho Poly( 1 :: 10, 2 );


```

### [Outline Box](#outline-box)

**Syntax:** y = Outline Box( title, <command script pairs list>, displayBox, ... )

**Description:** Creates an outline element in the report, returning the display box reference. To include a menu in the outline node, specify the command script pairs list, a list specifying menu commands and associated scripts.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        {"Show label value", Show( teb << get text )},
        H List Box( Text Box( "Label:" ), teb = Text Edit Box( Char( 213 ) ) )
    )
);


```

### [Oval](#oval)

**Syntax:** Oval( left, top, right, bottom, \<fill=0> )

**Description:** Draws an oval within the specified rectangle, filled if fill is nonzero.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "Green" );
        Pen Size( 2 );
        Fill Color( "Red" );
        Oval( 15, 75, 65, 55, 1 );
        Oval( 10, 80, 70, 50 );
    )
);


```

### [P Spline Coef](#p-spline-coef)

**Syntax:** coef = P Spline Coef( x, Internal Knot Grid, \<degree = 3>, \<KnotEndPoints = min(x) || max(x)> )

**Description:** Returns the matrix of P-Spline coefficients. Internal Knot Grid is either the number of desired knot points based on percentiles of x or a vector specifying the internal knot points. Optional parameter degree specifies the degree of the P-splines with a default of 3.

**JMP Version Added:** 14

```

P Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 2 );
P Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], [3, 7] );


```

### [Page Break Box](#page-break-box)

**Syntax:** Page Break Box()

**Description:** Creates a display box that forces a page break.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( "Blue" );
        Line( [10 30 70], [88 22 44] );
    ),
    Page Break Box(),
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [77 44 11], [75 25 50] );
        Pen Color( "Red" );
        Line( [70 30 10], [88 22 44] );
    )
);


```

### [Panel Box](#panel-box)

**Syntax:** y = Panel Box( title, displayBoxArgs )

**Description:** Returns a display box to label and enclose the argument display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        "alpha",
        Panel Box( "panel", Text Box( "text" ) ),
        "beta",
        Popup Box( {"x", ex = 1, "y", ex = 2} )
    )
);


```

### [Parallel Assign](#parallel-assign)

**Syntax:** tf = ParallelAssign( { thread_local_var = global_var, ... }, m[ a, b ] = expression using a and b )

**Description:** Use multiple threads to assign values to the matrix. If any thread throws an exception, a message will be printed to the log and the return value will be 0. If all threads complete without error, the return value will be 1. Functions that launch platforms, create or use data tables, or access the graphics subsystem are only supported on the main thread, and will throw an exception if called from a worker thread.

**JMP Version Added:** Before version 14

```

m = J( 3, 2, -1 );
If( Parallel Assign( {/*no locals */ }, m[a/* 1,2,3 */, b/* 1,2 */ ] = a * a + b ) == 0,
    Throw( "thread failed" )
);
m;/* 1*1+1  1*1+2, 2*2+1  2*2+2, 3*3+1  3*3+2 */


```

### [Parameter](#parameter)

**Syntax:** y = Parameter( {name=value, ...}, model expression )

**Description:** Defines formula parameters for models for the Nonlinear platform.

**JMP Version Added:** Before version 14

```

Parameter( {a = 1}, a + 1 );


```

### [Parse](#parse)

**Syntax:** y = Parse( s )

**Description:** Parses the string and returns the resulting JSL expression.

**JMP Version Added:** Before version 14

```

Parse( "x+y" );


```

### [Parse Date](#parse-date)

**Syntax:** dt = In Format( s, formatString, < \<<Use Locale(b=1)>, < \<<Restrict > ) dt = In Format( s, "Format Pattern", pattern, < \<<Use Locale(b=1)> )

**Description:** Parses a string of a given format. If the format is a date-time format, the value is expressed as if surrounded by As Date(), returning the date in ddMonyyyy format. The optional \<<Restrict used with the "Best" formatString only allows conversion using integer, decimal, and scientific formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Informat( "07152000", "MMDDYYYY" );


```

**Example 2**

```

Informat( "07.15.2000", "Format Pattern", "<MM>.<DD>.<YYYY>" );


```

**Example 3**

```

Informat( "86.8287° W", "Longitude DDD" );


```

**Example 4**

```

Informat( "123.45%", "Percent" );


```

**Example 5**

```

Show(
    Informat( "1.23e4", "Best" ),
    Informat( "1.23e4", "Best", <<Restrict ),
    Informat( "1989-10-04", "Best" ),
    Informat( "1989-10-04", "Best", <<Restrict )
);


```

### [Parse JSON](#parse-json)

**Syntax:** l = Parse JSON( jsonstring )

**Description:** Convert JSON text to a JSL list or associative array representing the structure specified by the JSON data.

**JMP Version Added:** 14

```

l = Parse JSON(
    "[ { \!"name\!": \!"KATIE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 59, \!"weight\!": 95 }, { \!"name\!": \!"LOUISE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 61, \!"weight\!": 123 }, { \!"name\!": \!"JANE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 55, \!"weight\!": 74 } ]"
);
Show( l );


```

### [Parse XML](#parse-xml)

**Syntax:** Parse XML( string, OnElement( tagname, StartTag( expr ), EndTag( expr ) ), ... )

**Description:** Parses an XML expression using the OnElement expressions for specified XML tags.

**JMP Version Added:** Before version 14

**Example 1**

```

/*See example two for more details*/
ex =
"<table name='fromxml'><col name='x'>[1 2 3]</col><col name='y'>[11 22 33]</col></table>";
Parse XML( ex,
    On Element( "table", Start Tag( New Table( XML Attr( "name" ) ) ) ),
    On Element(
        "col",
        End Tag( New Column( XML Attr( "name" ), Set Values( Parse( XML Text() ) ) ) )
    )
);


```

**Example 2**

```


doc =
"
<a title='one'>
    WWWa
    <b>BB<c>ZZZ</c>B1</b>
    XXXa
    <b>BBB2</b>
    YYYa
    <c>CCC</c>
</a>";
// doc, above, has tags a, b, and c. The c tags are not handled by the parser, below,
// to show why text should be collected by Text(...) and then processed by EndTag(...)
// Text(...) captures the BB ZZZ B1 while using EndTag(...) only captures the final snippet.
docname = "undefined";
doctext = "";
recordtext = "";
records = {};
NestLevel = 0; // not really used here, but shows how to use Start/End Tag to track nesting level
Parse XML( doc,
    On Element(
        "a",
        Start Tag(
            docname = XML Attr( "title" );
            NestLevel++;
        ), 
        // decide here to trim the CRLF and blanks and use a single blank
        Text( doctext = doctext || Trim( XML Text() ) || " " ),
        End Tag( NestLevel-- )
    ),
    On Element(
        "b",
        Start Tag( NestLevel++ ), 
        // comment out the next line and...
        Text( recordtext = recordtext || Trim( XML Text() ) || " " ),
        End Tag(
            // ...uncomment the next line and observe the "B1" vs "BB ZZZ B1 " value in records
            // recordtext = XMLText();
            Insert Into( records, recordtext );
            recordtext = "";
            NestLevel--;
        )
    )
);

Show( docname, doctext, records, NestLevel );


```

### [Pat Abort](#pat-abort)

**Syntax:** Pat Abort()

**Description:** Generates a pattern value that causes the entire match to fail immediately with no further backup and retry.

**JMP Version Added:** Before version 14

```

source = "xxxxx";
n = 0;
pattern = Pat Succeed() + Pat Arb() >> xs + Expr(
    Show( xs );
    n = n + 1;
    If( n > 16,
        Pat Abort(),
        Pat Fail()
    );
);
rc = Pat Match( source, pattern, NULL, FULLSCAN );


```

### [Pat Altern](#pat-altern)

**Syntax:** Pat Altern( pat1, pat2, ... )

**Description:** Generates a pattern value that matches any one of the supplied patterns. Generally written as pat1 | pat2 | ....

**JMP Version Added:** Before version 14

```

Pat Match(
    "123456789",
    ((Pat Pos( 2 ) + "1") | (Pat Pos( 1 ) + "2") | (Pat Pos( 0 ) + "3")) >> result
);
result;


```

### [Pat Any](#pat-any)

**Syntax:** Pat Any( string )

**Description:** Generates a pattern value that will match any one character in the string.

**JMP Version Added:** Before version 14

```

operators = Pat Any( "*+-/" );
text = "abc+def";
Pat Match( text, operators >> op );
op;


```

### [Pat Arb](#pat-arb)

**Syntax:** Pat Arb( pattern )

**Description:** Generates a pattern value that matches zero or more characters.

**JMP Version Added:** Before version 14

```

Pat Match(
    "123nonnumeric456",
    Pat Span( "0123456789" ) + Pat Arb() >> result + Pat Span( "0123456789" )
);
result;


```

### [Pat Arb No](#pat-arb-no)

**Syntax:** Pat Arb No( pattern )

**Description:** Generates a pattern value that matches its argument zero or more times. Same as patRepeat(pattern,0,infinity,RELUCTANT); (\*? in regex).

**JMP Version Added:** Before version 14

```

Pat Match(
    "xyz aaaaabbbbbb@ccc no c is matched because reluctant",
    Pat Arb No( "a" ) >> a + Pat Arb No( "b" ) >> b + "@" + Pat Arb No( "c" ) >> c
);
" a=" || a || " b=" || b || " c=" || c;


```

### [Pat At](#pat-at)

**Syntax:** Pat At( variable )

**Description:** Generates a pattern value that matches zero characters and assigns the current cursor position to variable. Generally written as patpos()>>variable.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", Pat Len( 2 ) + Pat At( result ) );
result;


```

### [Pat Break](#pat-break)

**Syntax:** Pat Break( string )

**Description:** Generates a pattern value that matches zero or more characters not in the string, stopping before a (required) character in the string.

**JMP Version Added:** Before version 14

```

b = "- ";
Pat Match( "one two three-", Pat Repeat( Pat Break( b ) >> word + Pat Any( b ) ) );
word;


```

### [Pat Concat](#pat-concat)

**Syntax:** Pat Concat( pat1, pat2, ... )

**Description:** Generates a pattern value that matches each of the supplied patterns in turn. Generally written as pat1 + pat2 + ....

**JMP Version Added:** Before version 14

```

num = Pat Break( "," );
sep = ",";
Pat Match( "1.3,7.9,8.66", num + sep + num >> result + sep + num );
result;


```

### [Pat Conditional](#pat-conditional)

**Syntax:** Pat Conditional( pattern, variable )

**Description:** Generates a pattern value that matches the supplied pattern and stores the matched text in variable on success. Generally written as pattern >? variable.

**JMP Version Added:** Before version 14

```

a = "unchanged";
b = "unchanged";
Pat Match( "123456789", (Pat Len( 2 ) >? a | Pat Len( 1 ) >? b) + "2" );
" a=" || a || " b=" || b;


```

### [Pat Fail](#pat-fail)

**Syntax:** Pat Fail()

**Description:** Generates a pattern value that always fails to match going forward, forcing the matcher to retry alternatives.

**JMP Version Added:** Before version 14

```

source = "xxxxx";
n = 0;
pattern = Pat Succeed() + Pat Arb() >> xs + Expr(
    Show( xs );
    n = n + 1;
    If( n > 16,
        Pat Abort(),
        Pat Fail()
    );
);
rc = Pat Match( source, pattern, NULL, FULLSCAN );


```

### [Pat Fence](#pat-fence)

**Syntax:** Pat Fence()

**Description:** Generates a pattern value that matches zero characters going forwards and fails when backing up, causing the match to fail. Also used to trim down the pattern backup stack.

**JMP Version Added:** Before version 14

```

rc = Pat Match( "123456789", (Pat Len( 1 ) | Pat Len( 2 )) >> result + Pat Fence() + "3" );
"rc=" || Char( rc ) || " result=" || result;


```

### [Pat Immediate](#pat-immediate)

**Syntax:** Pat Immediate( pattern, variable )

**Description:** Generates a pattern value that matches the supplied pattern and immediately stores the matched text in variable. Generally written as pattern >> variable.

**JMP Version Added:** Before version 14

```

a = "unchanged";
b = "unchanged";
Pat Match( "123456789", (Pat Len( 2 ) >> a | Pat Len( 1 ) >> b) + "2" );
" a=" || a || " b=" || b;


```

### [Pat Len](#pat-len)

**Syntax:** Pat Len( n )

**Description:** Generates a pattern value that matches n characters.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", Pat Len( 2 ) + Pat Len( 3 ) >> result );
result;


```

### [Pat Look Ahead](#pat-look-ahead)

**Syntax:** Pat Look Ahead( pattern, \<0|1> )

**Description:** A zero width pattern match after the current position. The second optional argument defaults to 0. 1 designates a negative match, or a non-match.

**JMP Version Added:** Before version 14

**Example 1**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        "s" + Pat Look Ahead( "'" ),
        "z"
    ), /* find an s that IS followed by an apostrophe and replace it with z */
    Print( test )
);


```

**Example 2**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        "s" + Pat Look Ahead( "'", 1 ),
        "z"
    ), /* find an s that is NOT followed by an apostrophe and replace it with z */
    Print( test )
);


```

**Example 3**

```

Test = "a bb ccc dddd";
While( /* keep repeating the match until it won't match */
    Pat Match(
        Test,
        Pat Len( 1 ) >> xxx/* find any character */
        + Pat Look Behind( Expr( xxx ) + Expr( xxx ) ) /* back up 2 positions, which includes the character just found */
        + Pat Look Ahead( Expr( xxx ) /* and look ahead one position */ ),
        "@" /* replacement for the middle character of a triple */
    ),
    Print( test ) /* show each intermediate result */
);


```

### [Pat Look Behind](#pat-look-behind)

**Syntax:** Pat Look Behind( pattern, \<0|1> )

**Description:** A zero width pattern match before the current position. The second optional argument defaults to 0. 1 designates a negative match, or a non-match.

**JMP Version Added:** Before version 14

**Example 1**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        Pat Look Behind( "'" ) + "s",
        "z"
    ), /* find an s that IS preceded by an apostrophe and replace it with z */Print( test )
);


```

**Example 2**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        Pat Look Behind( "'", 1 ) + "s",
        "z"
    ), /* find an s that is NOT preceded by an apostrophe and replace it with a z */
    Print( test )
);


```

**Example 3**

```

Test = "a bb ccc dddd";
While( /* keep repeating the match until it won't match */
    Pat Match(
        Test,
        Pat Len( 1 ) >> xxx/* find any character */
        + Pat Look Behind( Expr( xxx ) + Expr( xxx ) ) /* back up 2 positions, which includes the character just found */
        + Pat Look Ahead( Expr( xxx ) /* and look ahead one position */ ),
        "@" /* replacement for the middle character of a triple */
    ),
    Print( test ) /* show each intermediate result */
);


```

### [Pat Match](#pat-match)

**Syntax:** Pat Match( source, pattern, <replacement> )

**Description:** Executes the pattern match in the pattern variable against the string in the source variable; optional replacement text replaces the matched text.

**JMP Version Added:** Before version 14

```

string = "John Smith";
Pat Match(
    string,
    Pat Break( " " ) >> first + Pat Span( " " ) + Pat Rem() >> last,
    last || ", " || first
);
string;


```

### [Pat Not Any](#pat-not-any)

**Syntax:** Pat Not Any( string )

**Description:** Generates a pattern value that will match any one character not in the string.

**JMP Version Added:** Before version 14

```

delimiter = ";,-";
text = "fish,dog,cat,";
Pat Match( text, Pat Repeat( Pat Not Any( delimiter ) ) >> word + Pat Any( delimiter ) );
word;


```

### [Pat Pos](#pat-pos)

**Syntax:** Pat Pos( n )

**Description:** Generates a pattern value that matches zero characters if the cursor is at position n. With no argument, the Pat Pos() function returns the cursor position for >> or >? assignment: patpos()>>variable.

**JMP Version Added:** Before version 14

```

Pat Match(
    "ab3defghi",
    Pat Pos( 2 ) + Pat Len( 1 ) >> v/*v=3*/+ Expr( Pat Len( v ) )
    +Pat Pos( /* no argument returns current position = 6 */ ) >> result
);
result;


```

### [Pat R Pos](#pat-r-pos)

**Syntax:** Pat R Pos( n )

**Description:** Generates a pattern value that matches zero characters if the cursor is n characters from the end.

**JMP Version Added:** Before version 14

```

Pat Match( "quick brown fox", Pat R Pos( 3 ) + Pat Rem() >> result );
result;


```

### [Pat R Tab](#pat-r-tab)

**Syntax:** Pat R Tab( n )

**Description:** Generates a pattern value that matches zero or more characters to move the cursor forward to n characters before the end.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", "23" + Pat R Tab( 2 ) >> result );
result;


```

### [Pat Regex](#pat-regex)

**Syntax:** Pat Regex( string )

**Description:** Generates a pattern value that matches the regular expression in the string.

**JMP Version Added:** Before version 14

```

string = "John Smith";
Regex Match( string, Pat Regex( "([^ ]+)([ ]+)([^ ]+)" ), "\3, \1" );
string;


```

### [Pat Rem](#pat-rem)

**Syntax:** Pat Rem()

**Description:** Generates a pattern value that matches the remainder of the text.

**JMP Version Added:** Before version 14

```

Pat Match( "the quick fox", Pat R Pos( 3 ) + Pat Rem() >> result );
result;


```

### [Pat Repeat](#pat-repeat)

**Syntax:** Pat Repeat( pattern, \<min=1>, \<max=infinity>, <GREEDY or RELUCTANT=GREEDY> )

**Description:** Generates a pattern value that matches the supplied pattern between min and max times.

**JMP Version Added:** Before version 14

```

Pat Match(
    "xyz aaaaabbbbbbccc 3 c is matched because greedy",
    Pat Repeat( "a" ) >> a + Pat Repeat( "b" ) >> b + Pat Repeat( "c" ) >> c
);
" a=" || a || " b=" || b || " c=" || c;


```

### [Pat Span](#pat-span)

**Syntax:** Pat Span( string )

**Description:** Generates a pattern value that matches one or more characters in the string.

**JMP Version Added:** Before version 14

```

sp = Pat Span( "0123456789.-" );
Pat Match( "junk=-33.44e33", sp >> result );
result;


```

### [Pat String](#pat-string)

**Syntax:** Pat String( string )

**Description:** Generates a pattern value that matches the string. Generally the string can be used without using the Pat String() function.

**JMP Version Added:** Before version 14

```

x = Pat String( "a" || "b" );
Pat Match(
    "acbdbababc",
    Pat Arb() >> before + Pat Repeat( x ) >> match + Pat Rem() >> after
);
"before=" || before || " match=" || match || " after=" || after;


```

### [Pat Succeed](#pat-succeed)

**Syntax:** Pat Succeed()

**Description:** Generates a pattern value that always matches zero characters, even when backing up.

**JMP Version Added:** Before version 14

```

source = "xxxxx";
n = 0;
pattern = Pat Succeed() + Pat Arb() >> xs + Expr(
    Show( xs );
    n = n + 1;
    If( n > 16,
        Pat Abort(),
        Pat Fail()
    );
);
rc = Pat Match( source, pattern, NULL, FULLSCAN );


```

### [Pat Tab](#pat-tab)

**Syntax:** Pat Tab( n )

**Description:** Generates a pattern value that matches zero or more characters to move the cursor forward to position n.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", "23" + Pat Tab( 6 ) >> result );
result;


```

### [Pat Test](#pat-test)

**Syntax:** Pat Test( expression )

**Description:** Generates a pattern value that matches zero characters if the expression is nonzero. The expression is re-evaluated during each test, as if Expr() was used.

**JMP Version Added:** Before version 14

```

nCats = 0;
whichCat = 3;
string = "catch a catnapping cat in a catsup factory";
rc = Pat Match(
    string,
    "cat" + Pat Test(
        nCats = nCats + 1;
        nCats == whichCat;
    ),
    "dog"
);
string;


```

### [Path](#path)

**Syntax:** Path( pathMatrix|pathText, \<fill=0> )

**Description:** Draws a stroke along the given path if fill is 0, or paints the interior of the given path if fill is not 0. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "blue" );
        Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3], 1 );
        Path( "M20,20 C20,60 60,60 60,20 Z", 0 );
    )
);


```

### [Path To Char](#path-to-char)

**Syntax:** s = Path To Char( pathMatrix )

**Description:** Converts a path specification from matrix form to character form.

**JMP Version Added:** Before version 14

```

Path To Char( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] );


```

### [Payment](#payment)

**Syntax:** x = Payment( rate, nper, pv, \<fv=0>, \<type=0> )

**Description:** Returns the payment for a loan based on constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the PMT function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Payment( .05 / 12, 30 * 12, 100000 ) - Interest Payment( .05 / 12, 13, 30 * 12, 100000 )
-Principal Payment( .05 / 12, 13, 30 * 12, 100000 );


```

### [Pdf Page Count](#pdf-page-count)

**Syntax:** Pdf Page Count( file name)

**Description:** Returns the number of pages in a PDF file.

**JMP Version Added:** Before version 14

```

pageCount = Pdf Page Count( "$documents\myfile.pdf" );


```

### [Pen Color](#pen-color)

**Syntax:** Pen Color( \<name|index|rgbList> )

**Description:** Sets the color for drawing lines.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( {.3, .5, .7} );
        Circle( {20, 20}, 10 );
    )
);


```

### [Pen Size](#pen-size)

**Syntax:** Pen Size( <x> )

**Description:** Sets the pen size in pixels for drawing lines.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 4 );
        Line( [10 30 90], [88 22 44] );
    )
);


```

### [Pi](#pi)

**Syntax:** y = Pi()

**Description:** Returns the mathematical constant π, accurate to approximately 15 decimal digits: 3.1415926535....

**JMP Version Added:** Before version 14

```

Char( Pi(), 5 );


```

### [Pick Color](#pick-color)

**Syntax:** color = Pick Color( <window title>, \<name|index|rgbList> )

**Description:** Returns a color that was selected with the standard color picker.

**JMP Version Added:** 14

```

pickedColor = Pick Color( "Pick a Line Color", "Red" );
New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( pickedColor );
        Line( [10 30 70], [88 22 44] );
    )
);


```

### [Pick Color Theme](#pick-color-theme)

**Syntax:** theme = Pick Color Theme( <window title>, \<Color Theme(name|specification)>, \<Type("Continuous" | "Sequential" | "Bad to Good" | "Categorical")>)

**Description:** Returns a color theme that was selected with the standard color theme picker. The initial theme can be specified explicitly or by specifying a Type to use the themes from preferences.

**JMP Version Added:** 17

**Graph Builder**

```


theme = Pick Color Theme( "Choose a color theme", Type( "Bad to Good" ) );
dt = Open( "$SAMPLE_DATA/SATByYear.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( Color( :SAT Math ), Shape( :State ) ),
    Elements( Map Shapes( Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 2, 1 );
item << Set Properties( {Gradient( {Color Theme( theme )} )} );


```

**Row Legend**

```


pickedTheme = Pick Color Theme( "Pick a Color Theme" );
biv = Open( "$SAMPLE_DATA/Big Class.jmp" ) << Run Script( "Bivariate" );
Report( biv )[FrameBox( 1 )] << Row Legend( "age", Color Theme( pickedTheme ) );


```

### [Pick Directory](#pick-directory)

**Syntax:** path = Pick Directory( <prompt>, <path>, \<Show Files( boolean )> )

**Description:** Prompts the user with an Open Directory window, returning the pathname of the chosen directory. The optional prompt string is shown at the top of the window. Show Files can be any of the three arguments, and takes a Boolean argument. 1 shows files in the Pick Directory window, 0 does not. The default value is 0. The path string specifies the directory that the Pick Directory window initially displays. If you use the path string, it must follow the prompt string, but Show Files can be between them.

**JMP Version Added:** Before version 14

**Show Files**

```

Pick Directory( "Select a directory", "$DOCUMENTS", Show Files( 1 ) );


```

**Simple**

```

Pick Directory( "Select a directory" );


```

### [Pick File](#pick-file)

**Syntax:** path = Pick File( <prompt>, <initial directory>, <filterList>, <first filter>, \<saveFlag=0|1>, <default file>, <multiple> )

**Description:** Prompts the user with an Open window, returning the pathname of the chosen file. The filterList argument is a list of strings of the form: "Label|suffix1;suffix2;...". The first filter argument specifies which filter is initially shown. The fifth argument indicates whether the window should function as a save (saveFlag = 1) or open (saveFlag = 0) window. The default file argument specifies the file that is initially selected. The multiple argument allows multiple files to be selected if saveFlag is 0.

**JMP Version Added:** Before version 14

**Example 1**

```

Pick File(
    "Select JMP File",
    "$DOCUMENTS",
    {"JMP Files|jmp;jsl;jrn", "All Files|*"},
    1,
    0,
    "newJmpFile.jmp"
);


```

**Example 2**

```

Files = Pick File(
    "Select JMP File",
    "$SAMPLE_DATA",
    {"JMP Files|jmp;jsl;jrn", "All Files|*"},
    1,
    0,
    "",
    "multiple"
);
For( i = 1, i <= N Items( Files ), i++,
    Try( Open( Files[i] ) )
);


```

**Example 3**

```

filename = Pick File(
    "Save As Text",
    "$DOCUMENTS",
    {"Text File|txt"},
    1,
    1, // Save Flag
    "export.txt"
);
If( Is Missing( filename ),
    Print( "Canceled" ),
    Save Text File( filename, "The quick brown fox" )
);


```

### [Picture Box](#picture-box)

**Syntax:** pict = Picture Box( Picture Object )

**Description:** Creates a display box that contains a graphics picture object. You can either open a picture and then reference it, or you can use the Open command with a path to the picture in place of the Picture Object argument.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    Picture Box( Open( "$SAMPLE_IMAGES/black rhino footprint.jpg", jpg ) )
);


```

**Example 2**

```

pict = Open( "$SAMPLE_IMAGES/black rhino footprint.jpg", jpg );
New Window( "Example", Picture Box( pict ) );


```

### [Pie](#pie)

**Syntax:** Pie( left, top, right, bottom, startAngle, endAngle )

**Description:** Draws a pie slice.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Pie( 10, 80, 70, 40, 0, 90 );
    )
);


```

### [Pie Seg](#pie-seg)

**Syntax:** ps = Pie Seg(\<{ xorigin, yorigin }>, <radius>, \<style("pie", "ring", "coxcomb")>, values)

**Description:** Creates a Pie Seg at the specified origin, with the specified radius, based on values specified in matrix format.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);


```

### [Pixel Line To](#pixel-line-to)

**Syntax:** Pixel Line To( h, v )

**Description:** Draws a line from the current pixel-based pen coordinate to the horizontal and vertical coordinates given.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pixel Origin( 50, 50 ); // in axis coordinates
        // others are pixels, relative to pixel origin
        Pixel Move To( 0, 0 );
        Pixel Line To( 0, 80 );
        Pixel Move To( 2, 0 );
        Pixel Line To( 2, 40 );
        Pixel Move To( 4, 0 );
        Pixel Line To( 4, 20 );
    )
);


```

### [Pixel Move To](#pixel-move-to)

**Syntax:** Pixel Move To( h, v )

**Description:** Moves the pixel-addressed pen to the horizontal and vertical coordinate relative to the origin.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pixel Origin( 50, 50 ); // in axis coordinates
        // others are pixels, relative to pixel origin
        Pixel Move To( 0, 0 );
        Pixel Line To( 0, 80 );
        Pixel Move To( 2, 0 );
        Pixel Line To( 2, 40 );
        Pixel Move To( 4, 0 );
        Pixel Line To( 4, 20 );
    )
);


```

### [Pixel Origin](#pixel-origin)

**Syntax:** Pixel Origin( x, y )

**Description:** Sets the origin that pixel drawing commands are based on.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pixel Origin( 50, 50 ); // in axis coordinates
        // others are pixels, relative to pixel origin
        Pixel Move To( 0, 0 );
        Pixel Line To( 0, 80 );
        Pixel Move To( 2, 0 );
        Pixel Line To( 2, 40 );
        Pixel Move To( 4, 0 );
        Pixel Line To( 4, 20 );
    )
);


```

### [Pixel Path](#pixel-path)

**Syntax:** PixelPath( h, v, pathMatrix|pathText, \<fill=0>, \<scale=1.0>, \<orient={0.0,1.0}> )

**Description:** Draws a stroke along the given pixel-based path if fill is 0, or paints the interior of the given path if fill is not 0. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax. The path will be scaled and translated about its origin according to the optional parameters, with the orientation specified in the axis space.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "blue" );
        angle = 45 * Pi() / 180; // 45 deg in radians
        Pixel Origin( 20, 80 );
        Pixel Path(
            0,
            0, // offset from pixel origin in pixels
            [-10 -10 1,
            10 -10 0,
            20 20 0,
            -10 20 -3],
            1, // fill
            2.0, // scale
            {Sin( angle ), Cos( angle )} // clockwise rotation
        );
        Pixel Origin( 80, 20 );
        Pixel Path(
            0,
            0,
            "M-10,-10 C10,-10 20,20 -10,20 Z",
            0,
            1.0,
            {Sin( -angle ), Cos( -angle )}
        );
    )
);


```

### [Pixel Text](#pixel-text)

**Syntax:** Pixel Text( <properties>, {h, v}, text, ... )

**Description:** Moves to the {h, v} pixel position and draws text specified by the text argument. Named property arguments include Center Justified, Right Justified, Top Align, Bottom Align, Erased, Boxed, Counterclockwise, Clockwise. The position arguments, named arguments, and strings can be mixed in any order.

**JMP Version Added:** Before version 14

```


New Window( "Example",
    Graph Box(
        Pixel Origin( 10, 80 ); // in axis coordinates
        Pixel Move To( 0, 0 );
        Pixel Line To( 160, 140 ); // in pixels from pixel origin
        Pixel Text( {0, 0}, "default" );
        Pixel Text( Erased, Boxed, Clockwise, {75, 75}, "Erased Boxed Clockwise" );
        Pixel Text(
            Center Justified,
            Bottom Align,
            {160, 140},  // in pixels from pixel origin
            "Bottom Align\!NCenter Justified"
        );
    )
);


```

### [Platform](#platform)

**Syntax:** y = Platform( dataTable, script )

**Description:** Evaluates the given script in the context of the given data table. Returns the resulting display box for embedding in a display tree.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Platform example",
    H List Box(
        Platform(
            dt,
            Bubble Plot( X( :weight ), Y( :height ), Sizes( :age ), Title Position( 0, 0 ) )
        ),
        Platform(
            dt,
            Bubble Plot( X( :weight ), Y( :age ), Sizes( :height ), Title Position( 0, 0 ) )
        )
    )
);


```

### [Platform Preference](#platform-preference)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Platform Preferences](#platform-preferences)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Plot Col Box](#plot-col-box)

**Syntax:** y = Plot Col Box( title, numbers )

**Description:** Returns a display box to graph the numbers. The numbers argument can be a list or matrix.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [Poisson Distribution](#poisson-distribution)

**Syntax:** cumprob = Poisson Distribution( lambda, k )

**Description:** Returns the probability that a Poisson distributed random variable is less than or equal to k, where lambda is the mean parameter and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 4;
New Window( "Example: Poisson Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, Poisson Distribution( lambda, k ) );
            V Line(
                k + 1,
                Poisson Distribution( lambda, k ),
                Poisson Distribution( lambda, k + 1 )
            );
        );
        Text( {2, 0.9}, "\!U03BB=", Round( lambda, 2 ) );
    ),
    H List Box( Slider Box( 0, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) )
);


```

### [Poisson Probability](#poisson-probability)

**Syntax:** prob = Poisson Probability( lambda, k )

**Description:** Returns the probability that a Poisson distributed random variable is equal to k, where lambda is the mean parameter and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 4;
New Window( "Example: Poisson Probability",
    pdy = Graph Box(
        Y Scale( 0, 0.20 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( k = 0, k <= 40, k++,
            V Line( k, 0, Poisson Probability( lambda, k ) )
        );
        Text( {30, 0.18}, "\!U03BB=", Round( lambda, 2 ) );
    ),
    H List Box( Slider Box( 0, 40, lambda, pdy << reshow ), Text Box( " \!U03BB" ) )
);


```

### [Poisson Quantile](#poisson-quantile)

**Syntax:** q = Poisson Quantile( lambda, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Poisson( lambda ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qexpl = 20;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: Poisson Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, Poisson Distribution( qexpl, qexpk ) );
            V Line(
                qexpk + 1,
                Poisson Distribution( qexpl, qexpk ),
                Poisson Distribution( qexpl, qexpk + 1 )
            );
        );
        Pen Color( "blue" );
        V Line( Poisson Quantile( qexpl, qexpq ), 0, 1.0 );
        Text(
            {6, 0.17},
            " \!U03BB=",
            Round( qexpl, 2 ),
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( Poisson Quantile( qexpl, qexpq ) )
        );
    ),
    H List Box( Slider Box( 0, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [Poly Seg](#poly-seg)

**Syntax:** ps = Poly Seg(x values, y values)

**Description:** Returns a display seg that represents a polygon with vertices based on the passed in x and y values.

**JMP Version Added:** Before version 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Poly Seg" ));


```

### [Polygon](#polygon)

**Syntax:** Polygon( {x1, y1}, {x2, y2}, ..., \<<fill(bool) ); Polygon( xMatrix, <yMatrix>, \<<fill(bool) )

**Description:** Draws the polygon specified by the points.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "gray" );
        Polygon( [10 30 90], [88 22 44] );
        Polygon( [10 10, 50 80, 80 20, 50 50], <<Fill( 0 ) );
    )
);


```

### [Polygon Area](#polygon-area)

**Syntax:** area = Polygon Area( {x1, y1}, {x2, y2}, ... ); area = Polygon Area( xMatrix, yMatrix )

**Description:** Calculates the area of the specified polygon.

**JMP Version Added:** 14

**Example 1**

```

area = Polygon Area( {0, 0}, {0, 10}, {10, 10}, {10, 0} );


```

**Example 2**

```

area = Polygon Area( [10 20 30], [10 30 20] );


```

### [Polygon Centroid](#polygon-centroid)

**Syntax:** {cx, cy} = Polygon Centroid( {x1, y1}, {x2, y2}, ... ); centroid = Polygon Centroid( xMatrix, yMatrix )

**Description:** Calculates the centroid of the specified polygon.

**JMP Version Added:** 14

**Example 1**

```

{cx, cy} = Polygon Centroid( {0, 0}, {0, 10}, {10, 10}, {10, 0} );


```

**Example 2**

```

centroid = Polygon Centroid( [10 20 30], [10 30 20] );


```

### [Polygon Simplify](#polygon-simplify)

**Syntax:** rows = Polygon Simplify( xMatrix|xyMatrix, <yMatrix>, \<<\<detail factor(f=200)>, \<<\<multiple(ids)>, \<<\<geodesic(bool)> )

**Description:** Removes points from a polygon that carry a low amount of detail and returns indices of the remaining points. detail factor is inversely proportional to the detail error tolerance. multiple(ids) indicates that many polygons should be simplified together so that common edges are treated consistently. ids is a matrix with one row per point. geodesic(1) indicates coordinates are latitude and longitude for distance measurement.

**JMP Version Added:** 19

**Example 1**

```

New Window( "Example",
    Graph Box(
        Fill Color( "cyan" );
        xx = 18 * [1 1 1 1 1 2 3 4 5 5 5 5 5 4 3 2] + J( 1, 16, Random Uniform( -5, 5 ) );
        yy = 18 * [1 2 3 4 5 5 5 5 5 4 3 2 1 1 1 1] + J( 1, 16, Random Uniform( -5, 5 ) );
        Polygon( xx, yy );
        rows = Polygon Simplify( xx, yy, <<detail factor( 10 ) );
        Polygon( xx[rows], yy[rows], <<Fill( 0 ) );
    )
);


```

**Multiple polygons**

```

dt = Open( "$SAMPLE_IMPORT_DATA/Parishes.shp" );
rows = Where( dt, 4 <= :Shape <= 7 );
polys = dt[rows, {"X", "Y"}];
ids = dt[rows, {"Shape"}] * 100 + dt[rows, {"Part"}];
Close( dt, NoSave );

simple rows = Polygon Simplify(
    polys,
    <<detail factor( 500 ),
    <<multiple( ids ),
    <<geodesic( 1 )
);
unique ids = Associative Array( ids );

minx = Min( polys[0, 1] );
maxx = Max( polys[0, 1] );
sx = maxx - minx;
miny = Min( polys[0, 2] );
maxy = Max( polys[0, 2] );
sy = maxy - miny;

New Window( "Parishes",
    Graph Box(
        Frame Size( 600, 600 ),
        X Scale( minx - sx * 0.02, maxx + sx * 0.02 ),
        Y Scale( miny - sy * 0.02, maxy + sy * 0.02 ), 

        For Each( {id}, unique ids, 

            rows = simple rows[Loc( ids[simple rows] == id )];
            Pen Color( "light red" );
            Pen Size( 4 );
            Polygon( polys[rows, 0], <<Fill( 0 ) );

            rows = Loc( ids == id );
            Pen Color( "black" );
            Pen Size( 1 );
            Polygon( polys[rows, 0], <<Fill( 0 ) );

            {cx, cy} = Polygon Centroid( polys[rows, 0] );
            Text( Center Justified, {cx, cy}, Char( id ) );
        )
    )
);


```

### [Polytope Uniform Random](#polytope-uniform-random)

**Syntax:** points = Random Linearly Constrained Uniform( numSamples, A, b, L, U, neq, nle, nge, \<nwarm=200>, \<nstride=25>, \<tol=1e-8>, <G>, <LC>, <UC> )

**Description:** Generates a random sample subject to linear constraints, variable bound constraints, and cardinality constraints on specified component subgroup variables. The numSamples argument specifies the number of random points to be generated. The A argument is the linear constraint coefficient matrix. The b argument is the vector of right hand side values of the linear constraints. The L and U arguments are vectors of the lower and upper bounds for the variables, respectively. The neq, nle, and nge arguments are the number of equality constraints, the number of less than or equal constraints, and the number of greater than or equal constraints, respectively. The nwarm argument is the number of warm-up repetitions before points are written to the output matrix. The nstride argument is the number of repetitions between each point that is written to the output matrix. The tol argument is the tolerance. The G argument is a vector of indices that assigns the variables to constrained component subgroups where missing or zero values do not belong to a constrained subgroup. The LC and UC arguments are the lower and upper cardinality constraints for the constrained component subgroups, respectively. Note that the constraints must be listed as equality first, less than or equal next, and greater than or equal last.

**JMP Version Added:** Before version 14

**Example 1**

```

A = [1 1 1, 1 2 0];
b = [1, 0.5];
L = [0, 0, 0.1];
U = [1, 1, 1];
points = Random Linearly Constrained Uniform( 2000, A, b, L, U, 1, 0, 1, 300, 50 );
dt = As Table( points );
tobj = Report( Ternary Plot( X( :Col1, :Col2, :Col3 ) ) );
tfr = tobj[scalebox( 1 )] << clone box;
New Window( "Example: Random Linearly Constrained Uniform",
    Outline Box( "Points on a Ternary Plot", tfr ),
    Outline Box( "Constraints",
        Text Box( "X1 + x2 + x3 = 1" ),
        Text Box( "X2 + 2*x2 >= 0.5" )
    ),
    Outline Box( "Variable Bounds",
        Text Box( "0 <= x1 <= 1" ),
        Text Box( "0 <= x2 <= 1" ),
        Text Box( ".1 < x3 <= 1" )
    )
);
Close( dt, no save );
Show( "see new window for example output" );


```

**Example 2**

```


A = [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1];
b = [100];
L = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
U = [100 100 95 90 100 85 100 90 60 70 75 70 75 100 95 60 80 95 100 100];
nwarm = 100;
nstride = 100;
tol = 1e-8;
// Index the constrained subgroups.  Index = 0 is not in a constrained subgroup.
G = [0 0 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 0 0];
// Lower cardinality constraints for the constrained subgroups
LC = [1 1];
// Upper cardinality constraints for the constrained subgroups
UC = [3 5];
points = Random Linearly Constrained Uniform(
    100,
    A,
    b,
    L,
    U,
    1,
    0,
    0,
    nwarm,
    nstride,
    tol,
    G,
    LC,
    UC
);
dt = As Table( points );


```

### [Popup Box](#popup-box)

**Syntax:** y = Popup Box( {label1, script1, ...} )

**Description:** Returns a display box with a popup menu defined by label/script pairs.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        "alpha",
        Popup Box( {"x", ex = 1, "y", ex = 2} ),
        "beta",
        Panel Box( "panel", Text Box( "text" ) )
    )
);


```

### [PostDecrement](#postdecrement)

**Syntax:** x--; PostDecrement( x )

**Description:** Subtracts 1 from a variable or from a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex--;
ex;


```

### [PostIncrement](#postincrement)

**Syntax:** x++; PostIncrement( x )

**Description:** Adds 1 to a variable or to a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex++;
ex;


```

### [Power](#power)

**Syntax:** z = x ^ y; z = Power( x, \<y=2> )

**Description:** Returns x raised to the y power. If x is negative, y must be an integer.

**JMP Version Added:** Before version 14

```

Power( 2, 5 );


```

### [Pref](#pref)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Preference](#preference)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Preferences](#preferences)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Prefs](#prefs)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Present Value](#present-value)

**Syntax:** x = Present Value( rate, nper, pmt, \<fv=0>, \<type=0> )

**Description:** Returns the present value of an investment. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the PV function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Present Value( .05 / 12, 30 * 12, 1000 );


```

### [Principal Payment](#principal-payment)

**Syntax:** x = Principal Payment( rate, per, nper, pv, \<fv=0>, \<type=0> )

**Description:** Returns the payment on the principal for a given period for an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the PPMT function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Payment( .05 / 12, 30 * 12, 100000 ) - Interest Payment( .05 / 12, 13, 30 * 12, 100000 )
-Principal Payment( .05 / 12, 13, 30 * 12, 100000 );


```

### [Print](#print)

**Syntax:** Print( x, ... )

**Description:** Displays values of the arguments in the log, one per line.

**JMP Version Added:** Before version 14

```

Print( 355 / 113, Pi() );


```

### [Print Matrix](#print-matrix)

**Syntax:** s = Print Matrix( M, \<<ignore locale( 0 ), \<<style( "parseable" ), \<<separate( ", " ), \<<line begin( "[ " ), \<<line end( " ]" ) )

**Description:** Prints the matrix M. The optional argument ignore locale determines whether the printing of decimal separators should respect Locale information, where zero means to respect Locale. The optional argument style determines whether to use a style and which style to use. The available styles are parseable, which is a reformatted JSL matrix expression, latex, and other. When the style argument is other, the last three optional arguments define the beginning and ending characters of printed rows and separating characters of concatenated entries.

**JMP Version Added:** Before version 14

```

A = [3.509 0.003, 874.4 0.00384, 0.03 0.093];
Print Matrix( A );
Print Matrix( A, <<ignore locale( 1 ) );
Print Matrix( A, <<style( "latex" ) );
Print Matrix(
    A,
    <<style( "other" ),
    <<line begin( "| " ),
    <<line end( " |" ),
    <<separate( " | " )
);


```

### [Probit](#probit)

**Syntax:** q = Normal Quantile( p, \<mu=0>, \<sigma=1> ); q = Probit( p )

**Description:** Returns the quantile from a Normal distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

Normal Quantile( 0.9 );


```

### [Product](#product)

**Syntax:** y = Product( assignExpr, limit, bodyExpr )

**Description:** Returns the product of evaluations of the bodyExpr arguments, each time incrementing the variable from the assignExpr argument until it is greater than or equal to the limit argument.

**JMP Version Added:** Before version 14

```

2 * Product( i = 1, 10000, 4 * i * i / (2 * i - 1) / (2 * i + 1) );


```

### [Python Connect](#python-connect)

**Syntax:** PythonConnection = Python Connect ()

**Description:** Returns a Python connection scriptable object.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
version = PythonConnection << Get Version;
Show( version );


```

### [Python Create JPIP CMD](#python-create-jpip-cmd)

**Syntax:** Python Create JPIP CMD()

**Description:** Triggers the creation of a jpip command line wrapper script for Python's pip command. A directory picker dialog will ask for the directory location to save the generated script. This script then provides the full capabilities of pip, while correctly establishing the necessary environment variables for JMP's isolated Python environment.

**JMP Version Added:** 18

**Example 1**

```

Python Create JPIP CMD();


```

**Example 2**

```


conn = Python Connect();
conn << Create JPIP CMD();


```

### [Python Execute](#python-execute)

**Syntax:** Python Execute( { list of Inputs }, { list of Outputs }, statements < , echo( 1 | 0 ) > )

**Description:** Sends a list of inputs, executes statements, and returns a list of outputs. Optional echo() parameter defaults to True. The echo parameter controls echoing the Python source to the log. Logical True (1) enables echo of source while 0 suppresses the echo to the log.

**JMP Version Added:** 14

**Example 1**

```


a = "abcdef";
d = 3.141;
x = 0;
z = 0;
v = [1 0 0, 0 1 0, 0 0 1];
// pi, e, phi, c, Plank's, Faraday, 345 triangle
m = [3.141 2.718 1.618,
2.997 6.626 9.648,
3 4 5];
ml = Python Execute(
    {v, m, a, d},
    {x, z, a, d},
    "\[
import numpy as np
a = np.multiply(v, m) # matrix product
d = np.divide(v, m) # matrix division
z = np.multiply(m, np.linalg.inv(v)) # m * inv(v) called Left division
x = np.multiply(np.linalg.inv(m), v) # inv(m) * v called right division
]\"
);
Show( v, m, ml, x, z, a, d );


```

**Example 2**

```


x1 = 1;
x2 = 2;
y1 = 1;
y2 = 2;
z1 = 1;
z2 = 2;
v = [1 0 0, 0 1 0, 0 0 1];
// pi, e, phi, c, Plank's, Faraday, 345 triangle
m = [3.141 2.718 1.618,
2.997 6.626 9.648,
3 4 5];
ml = Python Execute(
    {v, m},
    {x1, x2, y1, y2, z1, z2},
    "\[
import numpy as np
x1 = np.multiply(v, m) # matrix product
print('x1=', x1)
x2 = np.divide(v, m) # matrix division
print('x2=', x2)
y1 = np.dot(v, m) # dot product of v and m
print('y1=', y1)
y2 = np.dot(m, v) # dot product of m and v
print('y2=', y2)
z1 = np.inner(v, m) # inner product of v and m
print('z1=', z1)
z2 = np.inner(m, v) # innder product of m and v
print('z2=', z2)
]\"
);
Show( v, m, ml, x1, x2, y1, y2, z1, z2 );


```

### [Python Get](#python-get)

**Syntax:** y = Python Get( name )

**Description:** Returns data from Python, where the name argument can represent any of the following Python data types ( numeric | string | matrix | list | dict | data table | data frame | datetime | numpy.datetime64 ).

**JMP Version Added:** 14

**Datetime**

```


date1 = As Date( Today() );
Python Send( date1 );
date2 = Python Get( date1 );
Show( date1, date2 );


```

**Example 1**

```


x1 = {1, 2, 3};
Python Send( x1 );
x2 = Python Get( x1 );
Show( x1, x2 );


```

**numpy.datetime64**

```


Python Install Packages( "numpy" );
Python Submit( "import numpy as np" );
Python Submit( "datetime64 = np.datetime64('1989-10-05')" );
numpy_datetime = Python Get( datetime64 );
Show( numpy_datetime );


```

### [Python Get Version](#python-get-version)

**Syntax:** version = Python Get Version()

**Description:** Returns the version number of Python being used with the JMP Python interfaces.

**JMP Version Added:** 14

```

version = Python Get Version();
Show( version );


```

### [Python Init](#python-init)

**Syntax:** PythonConnection = Python Init( )

**Description:** Note: This function is deprecated as of JMP 18 and is equivalent to Python Connect().

**JMP Version Added:** 14

**Example 1**

```


Python Init();
Python Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = Python Get( str );
Show( getStr );


```

**Example 2**

```


PythonConnection = Python Init();
PythonConnection << Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = Python Get( str );
Show( getStr );


```

### [Python Install Packages](#python-install-packages)

**Syntax:** Python Install Packages( packages )

**Description:** This wrappers the install of Python packages into the JMP site-packages directory. For operations beyond simple package installation, see Python Create JPIP CMD() to create a command line pip wrapper script in a directory chosen with Directory Pick(). Alternatively, to run the install from a JMP Python script window look at jmputils.jpip under the Python category here in the Scripting Index.

**JMP Version Added:** 18

**Example 1**

```

// install numpy and pandas packages
Python Install Packages( "numpy pandas" );


```

**Example 2**

```

// install numpy and pandas packages
Python Install Packages( {"numpy", "pandas"} );


```

**Example 3**

```

// install numpy and pandas packages
conn = Python Connect();
conn << Install Packages( "numpy pandas" );


```

### [Python Is Connected](#python-is-connected)

**Syntax:** connected = Python Is Connected()

**Description:** Note: This function is deprecated as of JMP 18 and always returns 1.

**JMP Version Added:** 14

```

x = Python Is Connected();
Show( x );


```

### [Python JMP Name to Python Name](#python-jmp-name-to-python-name)

**Syntax:** Python name = Python JMP Name To Python Name( JMP name )

**Description:** Maps a JMP variable name to a Python variable name using Python variable naming rules.

**JMP Version Added:** 14

```

Python name = Python JMP Name to Python Name( a b c );
Show( Python name );


```

### [Python Reset](#python-reset)

**Syntax:** Python Reset()

**Description:** Resets the shared Python environment, primarily clearing all references to objects. This does not change the import cache of imported modules. This is a limitation of the Python environment itself. Modules that load shared libraries cannot be unloaded by the running process. To reload pure Python code, see the Python.org documentation on importlib reload().

**JMP Version Added:** 19

```

pi = 3.1415927;
Python Send( pi );
Python Submit( "print(pi)" );
Python Reset();
// will show error, pi not defined
Python Submit( "print(pi)" );


```

### [Python Send](#python-send)

**Syntax:** Python Send( name, \<Python Name( name )> )

**Description:** Sends data to Python, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table | data table column | date ).

**JMP Version Added:** 14

**Column**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Python Send( dt:weight );
Python Submit( "print(dt_weight)" );


```

**Data Table**

```


x = {1, 2, 3};
Python Send( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Python Send( dt );
Python Submit( "print(x)" );
Python Submit( "print(dt)" );


```

**Date**

```


date = As Date( Today() );
Python Send( date );
Python Submit( "print(date)" );


```

### [Python Send File](#python-send-file)

**Syntax:** Python Send File( filename, \<Python Name( name )> )

**Description:** Sends a data file to Python, where the filename argument is a string specifying a pathname to the file to be sent to Python.

**JMP Version Added:** 14

```


Python Send File( "$SAMPLE_DATA/Big Class.jmp" );
Python Send File( "$SAMPLE_DATA/Baseball.jmp" );
Python Submit( "print(Big_Class)" );
Python Submit( "print(Baseball)" );


```

### [Python Submit](#python-submit)

**Syntax:** Python Submit( statements < , echo( 1 | 0 ) > )

**Description:** Submits statements to Python. Statements can be in the form of a string value or list of string values. Optional echo() parameter defaults to 1. The echo parameter controls echoing the Python source to the log. Logical True (1) enables echo of source while 0 suppresses the echo to the log.

**JMP Version Added:** 14

```

Python Submit( "\[
str = 'The quick brown fox jumps over the lazy dog'
a = 200]\" );
getStr = Python Get( str );
getNum = Python Get( a );
Show( getStr, getNum );


```

### [Python Submit File](#python-submit-file)

**Syntax:** Python Submit File( path )

**Description:** Submits statements to Python using a file specified by the path argument.

**JMP Version Added:** 14

```

Python Submit File( "some_Python_source.py" );


```

### [Python Term](#python-term)

**Syntax:** Python Term()

**Description:** Note: This function is deprecated as of JMP 18 and has no effect.

**JMP Version Added:** 14

### [QR](#qr)

**Syntax:** {Q, R} = QR( X )

**Description:** Creates an m by m orthogonal matrix Q and an m by n upper triangular matrix R, such that X = Q * R. The argument X is an m by n matrix.

**JMP Version Added:** Before version 14

```

QR( [11 22, 33 44] );


```

### [QR LAPACK](#qr-lapack)

**Syntax:** {Q, R} = QR LAPACK( X )

**Description:** Creates an m by k orthogonal matrix Q and a k by n upper triangular matrix R, such that X = Q * R. The argument X is an m by n matrix, where k is min(m, n).

**JMP Version Added:** 17

```

QR LAPACK( [11 22, 33 44] );


```

### [Quadratic Form BLAS](#quadratic-form-blas)

**Syntax:** y = Quadratic Form BLAS( A, x )

**JMP Version Added:** 17

```

A = [2 0, 0 2];
x = [2, 3];
y = Quadratic Form BLAS( A, x );


```

### [Quantile](#quantile)

**Syntax:** y = Quantile( p, x1, ... )

**Description:** Returns the specified quantile p of the x arguments. The quantile argument can be a scalar or a matrix. The x values can also be specified as values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List(
    {Quantile( 0.75, 0, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000 ),
    Quantile( 0.5, [1.2, 1.5, 10, 25, 31, 40, 50, 99, 1000, 5000, 25000, 100000] )}
);


```

### [Quarter](#quarter)

**Syntax:** q = Quarter( datetime )

**Description:** Returns the quarter part of a date-time value, 1 - 4.

**JMP Version Added:** Before version 14

```

Quarter( Today() );


```

### [Query](#query)

**Syntax:** result = Query( < < dt1 | Table( dt1, alias1 ) >, ..., < dtN | Table( dtN, aliasN ) > >, \<Private|Invisible>, <Scalar>, sqlStatement )

**Description:** Perform an SQL query on JMP data tables. sqlStatement (the SQL query, most likely a SELECT statement) is required and must be the last argument. JMP data tables referenced by the SQL statement must be passed in as arguments to Query(), using Table(dt, "alias") to create an alias for the table that the SQL can use if desired. Invisible or Private can be passed in to control the visibility of the resulting data table. If the SQL statement returns a single value, pass in Scalar, which will cause the single value to be returned instead of a data table.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
Query( dt, "SELECT name, age, height FROM 'Big Class'
         WHERE age > 14; " );

        // Using aliases, performing a join
dtSAT = Open( "$SAMPLE_DATA/SATByYear.jmp", Invisible );
dtUS = Open( "$SAMPLE_DATA/US Demographics.jmp", Invisible );
Query(
    Table( dtSAT, "t1" ),
    Table( dtUS, "t2" ), 

    "\[SELECT t1.State, t1."SAT Math", t2."College Degrees",
            t2."Eighth Grade Math"
       FROM t1
       LEFT OUTER JOIN t2
           ON t1.State = t2.State
       WHERE t1.'SAT Math' > 550;
      ]\"
);

        // Query that returns a scalar value
retval = Query( Scalar, dt, "SELECT AVG(height) from 'Big Class';" );
// Query with no tables
retval = Query( Scalar, "SELECT SQRT(152399025);" );


```

### [Quit](#quit)

**Syntax:** Quit(\<"No Save">); Exit(\<"No Save">)

**Description:** Exits JMP.

**JMP Version Added:** Before version 14

```

If(
    New Window( "Quit() example",
        <<Type( "Modal" ),
        Text Box( "Shut down JMP?" ),
        H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
    )["Button"] == 1, /*OK==1*/Quit(), /*cancel==-1*/"Good choice."
);


```

### [R Connect](#r-connect)

**Syntax:** RConnection = R Connect()

**Description:** Returns an R connection scriptable object.

**JMP Version Added:** Before version 14

```

RConnection = R Connect();


```

### [R Control](#r-control)

**Syntax:** R Control( Interrupt | Async( bool ) | Echo( bool ) )

**Description:** Changes the control options for R

**JMP Version Added:** Before version 14

```

R Init( Echo( true ) );
R Control( Echo( false ) );
R Submit( "Add R code" );


```

### [R Execute](#r-execute)

**Syntax:** R Execute( { list of Inputs }, { list of Outputs }, statements )

**Description:** Sends a list of inputs, executes statements and returns a list of outputs.

**JMP Version Added:** Before version 14

```

R Init();
a = "abcdef";
d = 3.141;
x = 0;
z = 0;
v = [9 8 7, 6 5 4, 3 2 1];
m = [1 2 3, 4 5 6, 7 8 9];
rc = R Execute( {v, m, a, d}, {x, z, a, d}, "\[
x <- rnorm(5)
z <- v * m
]\" );
Show( v, m, rc, x, z, a, d );


```

### [R Get](#r-get)

**Syntax:** y = R Get( name )

**Description:** Returns data from R, where the name argument can represent any of the following R data types ( numeric | string | matrix | list | data frame).

**JMP Version Added:** Before version 14

```

R Init();
x1 = [1, 2, 3];
R Send( x1 );
x2 = R Get( x1 );
Show( x1, x2 );
dt1 = New Table( "Test", New Column( "Col", Values( [10, 20, 30] ) ) );
R Send( dt1 );
dt2 = R Get( dt1 );
Close( dt1, No Save );


```

### [R Get Graphics](#r-get-graphics)

**Syntax:** R graphics = R Get Graphics( format )

**Description:** DEPRECATED in JMP 19 and has no effect. As a replacement, set device to a file name such as png("r_plot.png"), and then open the file to retrieve the image. This option will be removed from JMP 20. Code below shows workaround.

**JMP Version Added:** Before version 14

```

R Init();
img_path = Get Path Variable( "TEMP" ) || "r_plot.png";
R Execute( {img_path}, {}, "\[
png(img_path)
plot(1:10)
dev.off()
]\" );
plot = Open( img_path );
rc = Delete File( img_path );


```

### [R Get Version](#r-get-version)

**Syntax:** version = R Get Version()

**Description:** Returns the version number of R being used with the JMP R interfaces.

**JMP Version Added:** 14

```

R Init();
version = R Get Version();
Show( version );


```

### [R Init](#r-init)

**Syntax:** R Init()

**Description:** Initializes the R Interfaces.

**JMP Version Added:** Before version 14

```

R Init();


```

### [R Is Connected](#r-is-connected)

**Syntax:** connected = R Is Connected()

**Description:** Returns 1 if there is an active R connection; otherwise, returns 0.

**JMP Version Added:** Before version 14

```

R Init();
connected = R Is Connected();


```

### [R JMP Name to R Name](#r-jmp-name-to-r-name)

**Syntax:** R name = R JMP Name To R Name( JMP name )

**Description:** Maps a JMP variable name to an R variable name using R variable naming rules.

**JMP Version Added:** Before version 14

```

R name = R JMP Name to R Name( a b c );


```

### [R Send](#r-send)

**Syntax:** R Send( name, \<R Name( as_name ) | "as_name"> )

**Description:** Sends data to R, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table | data table column).

**JMP Version Added:** Before version 14

**Column**

```

R Init();
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
R Send( dt:weight );
Close( dt );
w = R Get( "dt.weight" );


```

**Data Table**

```

R Init();
x = [1, 2, 3];
R Send( x, "x1" );
rx = R Get( "x1" );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
R Send( dt );
Close( dt );
R Submit( "dt" );


```

### [R Send File](#r-send-file)

**Syntax:** R Send File( filename, \<R Name( name )> )

**Description:** Sends a data file to R, where the filename argument is a string specifying a pathname to the file to be sent to R.

**JMP Version Added:** Before version 14

```

R Init();
R Send File( "$SAMPLE_DATA/Big Class.jmp" );
R Send File( "$SAMPLE_DATA/Baseball.jmp" );
R Submit( "Big.Class" );
R Submit( "Baseball" );


```

### [R Submit](#r-submit)

**Syntax:** R Submit( statements )

**Description:** Submit statements to R. Statements can be in the form of a string value or list of string values.

**JMP Version Added:** Before version 14

```


R Init();
img_path = Get Path Variable( "TEMP" ) || "r_plot.png";
code =
"\[
x <- rnorm(1000)
hx <- hist(x, breaks=100, plot=FALSE)
png("IMG_PATH")
plot(hx, col=ifelse(abs(hx$breaks) < 1.669, 4, 2))
dev.off()
x <- rnorm (100)
y <- x**2 + rnorm (100)
summary(y)
]\";
// substitue portable path into R code
r_code = Substitute( code, "IMG_PATH", img_path );
R Submit( r_code );
Wait( 3 );
plot = Open( img_path );
rc = Delete File( img_path );


```

### [R Submit File](#r-submit-file)

**Syntax:** R Submit File( path )

**Description:** Submits statements to R using a file specified by the path argument.

**JMP Version Added:** Before version 14

```


R Init();
file_path = Get Path Variable( "SAMPLE_SCRIPTS" ) || "R/SI_example.R";
R Submit File( file_path );


```

### [R Term](#r-term)

**Syntax:** R Term()

**Description:** Deprecated in JMP 19 and has no effect.

**JMP Version Added:** Before version 14

```

R Init();
R Term();


```

### [Radio Box](#radio-box)

**Syntax:** y = Radio Box( {item, ...}, <script> )

**Description:** Returns a display box to show a set of radio buttons.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    rb = Radio Box( {"single", "double", "triple"}, Show( rb << Get() ) )
);


```

### [Random Beta](#random-beta)

**Syntax:** y = Random Beta( alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns a random number from a beta distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Beta( 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Beta( 1, 1 ) );
//show results
Show( x, v );


```

### [Random Beta Binomial](#random-beta-binomial)

**Syntax:** y = Random Beta Binomial( n, p, \<delta=0> )

**Description:** Returns a random number from a beta binomial distribution for n trials with probability p and correlation delta.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Beta Binomial( 14, .5, .2 );
//produce a vector of random numbers
v = J( 1, 10, Random Beta Binomial( 14, .5, .2 ) );
//show results
Show( x, v );


```

### [Random Binomial](#random-binomial)

**Syntax:** y = Random Binomial( n, p )

**Description:** Returns a random number from a binomial distribution with n trials and event probability p.

**JMP Version Added:** Before version 14

```

exrbinp = 0.5;
exrbinn = 40;
exrbinlsz = Log( 1000 );
New Window( "Example: Random Binomial and Empirical Distribution",
    exrbiny = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( 0, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        exrbinsz = Round( Exp( exrbinlsz ) );
        exrbinsamp = J( Round( exrbinsz ), 1, . );
        exrbinfreq = J( Round( exrbinn + 1 ), 1, . );
        For( exrbink = 1, exrbink <= Round( exrbinsz ), exrbink++,
            exrbinsamp[exrbink] = Random Binomial( exrbinn, exrbinp )
        );
        For( exrbink = 0, exrbink <= Round( exrbinn ), exrbink++,
            exrbinfreq[exrbink + 1] = Sum( exrbinsamp <= exrbink ) / Round( exrbinsz )
        );
        For( exrbink = 0, exrbink < Round( exrbinn ), exrbink++,
            H Line(
                exrbink,
                exrbink + 1,
                Binomial Distribution( exrbinp, Round( exrbinn ), exrbink )
            );
            V Line(
                exrbink + 1,
                Binomial Distribution( exrbinp, Round( exrbinn ), exrbink ),
                Binomial Distribution( exrbinp, Round( exrbinn ), exrbink + 1 )
            );
        );
        Pen Color( "blue" );
        For( exrbink = 1, exrbink <= Round( exrbinn ), exrbink++,
            H Line( exrbink - 1, exrbink, exrbinfreq[exrbink] );
            V Line( exrbink, exrbinfreq[exrbink], exrbinfreq[exrbink + 1] );
        );
        Text(
            {0.5, 0.9},
            "n=",
            Round( exrbinn ),
            " p=",
            Round( exrbinp, 2 ),
            " size=",
            Round( exrbinsz )
        );
    ),
    H List Box(
        Slider Box( Log( 10 ), Log( 5000 ), exrbinlsz, exrbiny << reshow ),
        Text Box( " random sample size" )
    )
);


```

### [Random Category](#random-category)

**Syntax:** y = Random Category( probabilityA, resultA, probabilityB, resultB, resultElse )

**Description:** Returns a random category given pairs of probability and result expressions. A random uniform number is generated and compared to the probability arguments to determine which result argument is returned.

**JMP Version Added:** Before version 14

```

Random Category( .2, "A", .3, "B", .4, "C", "D" );


```

### [Random Cauchy](#random-cauchy)

**Syntax:** y = Random Cauchy()

**Description:** Returns a random number from a Cauchy distribution with a median of zero.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Cauchy();
//produce a vector of random numbers
v = J( 1, 10, Random Cauchy() );
//show results
Show( x, v );


```

### [Random ChiSquare](#random-chisquare)

**Syntax:** y = Random ChiSquare( df, \<nonCentrality=0> )

**Description:** Returns a random number from a Chi-Square distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random ChiSquare( 2 );
//produce a vector of random numbers
v = J( 1, 10, Random ChiSquare( 2 ) );
//show results
Show( x, v );


```

### [Random ExGaussian](#random-exgaussian)

**Syntax:** y = Random ExGaussian( location, scale, shape)

**Description:** Returns a random number from an ExGaussian distribution.

**JMP Version Added:** 18

```


//produce a single random number
x = Random ExGaussian( 0, .5, .25 );
//produce a vector of random numbers
v = J( 1, 10, Random ExGaussian( 0, .5, .25 ) );
//show results
Show( x, v );


```

### [Random Exp](#random-exp)

**Syntax:** y = Random Exp()

**Description:** Returns a random number from an exponential distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Exp();
//produce a vector of random numbers
v = J( 1, 10, Random Exp() );
//show results
Show( x, v );


```

### [Random F](#random-f)

**Syntax:** y = Random F( dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns a random number from an F distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random F( 2, 2 );
//produce a vector of random numbers
v = J( 1, 10, Random F( 2, 2 ) );
//show results
Show( x, v );


```

### [Random Frechet](#random-frechet)

**Syntax:** y = Random Frechet( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a Fréchet distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Frechet( 10, 5 );
//produce a vector of random numbers
v = J( 1, 10, Random Frechet( 10, 5 ) );
//show results
Show( x, v );


```

### [Random Gamma](#random-gamma)

**Syntax:** y = Random Gamma( alpha, \<scale=1> )

**Description:** Returns a random number from a gamma distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Gamma( 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Gamma( 1 ) );
//show results
Show( x, v );


```

### [Random Gamma Poisson](#random-gamma-poisson)

**Syntax:** y = Random Gamma Poisson( lambda, \<sigma=1> )

**Description:** Returns a random number from a gamma Poisson distribution with parameters lambda and sigma.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Gamma Poisson( 3, 2 );
//produce a vector of random numbers
v = J( 1, 10, Random Gamma Poisson( 3, 2 ) );
//show results
Show( x, v );


```

### [Random GenGamma](#random-gengamma)

**Syntax:** y = Random GenGamma( \<mu=0>, \<sigma=1>, \<lambda=0> )

**Description:** Returns a random number from an extended generalized gamma distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random GenGamma( 2, 1.25 );
//produce a vector of random numbers
v = J( 1, 10, Random GenGamma( 2, 1.25 ) );
//show results
Show( x, v );


```

### [Random Geometric](#random-geometric)

**Syntax:** y = Random Geometric( p )

**Description:** Returns a random number of non-events until an event occurs, for events with probability p.

**JMP Version Added:** Before version 14

```

exrgeop = 0.1;
exrgeolsz = Log( 300 );
New Window( "Example: Random Geometric and Empirical Distribution",
    exrgeoy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 50 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        exrgeosz = Round( Exp( exrgeolsz ) );
        exrgeosamp = J( Round( exrgeosz ), 1, . );
        exrgeofreq = J( Round( 50 + 1 ), 1, . );
        For( exrgeok = 1, exrgeok <= Round( exrgeosz ), exrgeok++,
            exrgeosamp[exrgeok] = Random Geometric( exrgeop )
        );
        For( exrgeok = 0, exrgeok <= 50, exrgeok++,
            exrgeofreq[exrgeok + 1] = Sum( exrgeosamp <= exrgeok ) / Round( exrgeosz )
        );
        exrgeotmp1 = 0;
        exrgeotmp2 = 0;
        For( exrgeok = 0, exrgeok < 50, exrgeok++,
            exrgeotmp2 = exrgeotmp2 + (1 - exrgeop) ^ exrgeok * exrgeop;
            H Line( exrgeok, exrgeok + 1, exrgeotmp2 );
            V Line( exrgeok, exrgeotmp1, exrgeotmp2 );
            exrgeotmp1 = exrgeotmp2;
        );
        Pen Color( "blue" );
        For( exrgeok = 0, exrgeok < 50, exrgeok++,
            H Line( exrgeok, exrgeok + 1, exrgeofreq[exrgeok + 1] );
            V Line( exrgeok + 1, exrgeofreq[exrgeok + 1], exrgeofreq[exrgeok + 2] );
        );
        Text( {10, 0.2}, " p=", Round( exrgeop, 2 ), " sample size=", Round( exrgeosz ) );
    ),
    H List Box(
        Slider Box( Log( 10 ), Log( 5000 ), exrgeolsz, exrgeoy << reshow ),
        Text Box( " random sample size" )
    )
);


```

### [Random GLog](#random-glog)

**Syntax:** y = Random GLog( mu, sigma, lambda )

**Description:** Returns a random number from a generalized logarithm distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random GLog( 4, 1, 0.1 );
//produce a vector of random numbers
v = J( 1, 10, Random GLog( 4, 1, 0.1 ) );
//show results
Show( x, v );


```

### [Random Index](#random-index)

**Syntax:** x = Random Index( n, k )

**Description:** Returns a k by 1 matrix of random integers between 1 and n with no duplicates.

**JMP Version Added:** Before version 14

```

Random Index( 100, 5 );


```

### [Random Integer](#random-integer)

**Syntax:** y = Random Integer( n ); Random Integer( k, n )

**Description:** Returns a random integer between 1 and n (or between k and n) inclusive.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Integer( 1, 10 );
//produce a vector of random numbers
v = J( 1, 10, Random Integer( 1, 10 ) );
//show results
Show( x, v );


```

### [Random Johnson Sb](#random-johnson-sb)

**Syntax:** y = Random Johnson Sb( gamma, delta, theta, sigma )

**Description:** Returns a random number from a Johnson Sb distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Johnson Sb( 0.5, 1, 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Johnson Sb( 0.5, 1, 1, 1 ) );
//show results
Show( x, v );


```

### [Random Johnson Sl](#random-johnson-sl)

**Syntax:** y = Random Johnson Sl( gamma, delta, theta, \<sigma=1> )

**Description:** Returns a random number from a Johnson Sl distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Johnson Sl( 0.5, 1, 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Johnson Sl( 0.5, 1, 1, 1 ) );
//show results
Show( x, v );


```

### [Random Johnson Su](#random-johnson-su)

**Syntax:** y = Random Johnson Su( gamma, delta, theta, sigma )

**Description:** Returns a random number from a Johnson Su distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Johnson Su( 0.5, 1, 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Johnson Su( 0.5, 1, 1, 1 ) );
//show results
Show( x, v );


```

### [Random LEV](#random-lev)

**Syntax:** y = Random LEV( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a LEV distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random LEV( 10, 5 );
//produce a vector of random numbers
v = J( 1, 10, Random LEV( 10, 5 ) );
//show results
Show( x, v );


```

### [Random Linearly Constrained Uniform](#random-linearly-constrained-uniform)

**Syntax:** points = Random Linearly Constrained Uniform( numSamples, A, b, L, U, neq, nle, nge, \<nwarm=200>, \<nstride=25>, \<tol=1e-8>, <G>, <LC>, <UC> )

**Description:** Generates a random sample subject to linear constraints, variable bound constraints, and cardinality constraints on specified component subgroup variables. The numSamples argument specifies the number of random points to be generated. The A argument is the linear constraint coefficient matrix. The b argument is the vector of right hand side values of the linear constraints. The L and U arguments are vectors of the lower and upper bounds for the variables, respectively. The neq, nle, and nge arguments are the number of equality constraints, the number of less than or equal constraints, and the number of greater than or equal constraints, respectively. The nwarm argument is the number of warm-up repetitions before points are written to the output matrix. The nstride argument is the number of repetitions between each point that is written to the output matrix. The tol argument is the tolerance. The G argument is a vector of indices that assigns the variables to constrained component subgroups where missing or zero values do not belong to a constrained subgroup. The LC and UC arguments are the lower and upper cardinality constraints for the constrained component subgroups, respectively. Note that the constraints must be listed as equality first, less than or equal next, and greater than or equal last.

**JMP Version Added:** 20

**Example 1**

```

A = [1 1 1, 1 2 0];
b = [1, 0.5];
L = [0, 0, 0.1];
U = [1, 1, 1];
points = Random Linearly Constrained Uniform( 2000, A, b, L, U, 1, 0, 1, 300, 50 );
dt = As Table( points );
tobj = Report( Ternary Plot( X( :Col1, :Col2, :Col3 ) ) );
tfr = tobj[scalebox( 1 )] << clone box;
New Window( "Example: Random Linearly Constrained Uniform",
    Outline Box( "Points on a Ternary Plot", tfr ),
    Outline Box( "Constraints",
        Text Box( "X1 + x2 + x3 = 1" ),
        Text Box( "X2 + 2*x2 >= 0.5" )
    ),
    Outline Box( "Variable Bounds",
        Text Box( "0 <= x1 <= 1" ),
        Text Box( "0 <= x2 <= 1" ),
        Text Box( ".1 < x3 <= 1" )
    )
);
Close( dt, no save );
Show( "see new window for example output" );


```

**Example 2**

```


A = [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1];
b = [100];
L = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
U = [100 100 95 90 100 85 100 90 60 70 75 70 75 100 95 60 80 95 100 100];
nwarm = 100;
nstride = 100;
tol = 1e-8;
// Index the constrained subgroups.  Index = 0 is not in a constrained subgroup.
G = [0 0 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 0 0];
// Lower cardinality constraints for the constrained subgroups
LC = [1 1];
// Upper cardinality constraints for the constrained subgroups
UC = [3 5];
points = Random Linearly Constrained Uniform(
    100,
    A,
    b,
    L,
    U,
    1,
    0,
    0,
    nwarm,
    nstride,
    tol,
    G,
    LC,
    UC
);
dt = As Table( points );


```

### [Random LogGenGamma](#random-loggengamma)

**Syntax:** y = Random LogGenGamma( \<mu=0>, \<sigma=1>, \<lambda=0> )

**Description:** Returns a random number from a log generalized gamma distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random LogGenGamma( 2, 1.25 );
//produce a vector of random numbers
v = J( 1, 10, Random LogGenGamma( 2, 1.25 ) );
//show results
Show( x, v );


```

### [Random Logistic](#random-logistic)

**Syntax:** y = Random Logistic( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a logistic distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Logistic( 15, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Logistic( 15, 1 ) );
//show results
Show( x, v );


```

### [Random Loglogistic](#random-loglogistic)

**Syntax:** y = Random Loglogistic( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a loglogistic distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Loglogistic( 15, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Loglogistic( 15, 1 ) );
//show results
Show( x, v );


```

### [Random Lognormal](#random-lognormal)

**Syntax:** y = Random Lognormal( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a lognormal distribution with location parameter mu and scale parameter sigma.

**JMP Version Added:** Before version 14

**Example 1**

```


//produce a single random number
x = Random Lognormal( -1, 1.5 );
//produce a vector of random numbers
v = J( 1, 10, Random Lognormal( -1, 1.5 ) );
//show results
Show( x, v );


```

**Example 2**

```

exrlnn = 30;
New Window( "Example: Random Lognormal and Empirical Distribution",
    exrlny = Graph Box(
        Y Scale( -0.05, 1.05 ),
        X Scale( -.05, 10 ),
        Pen Color( "red" );
        exranlnorm = J( Round( exrlnn ), 1, . );
        For( k = 1, k <= Round( exrlnn ), k++,
            exranlnorm[k] = Random Lognormal( -1, 1.5 )
        );
        exranlnorm = Sort Ascending( exranlnorm );
        H Line( 0, exranlnorm[1], 0 );
        For( k = 2, k <= Round( exrlnn ), k++,
            H Line( exranlnorm[k - 1], exranlnorm[k], (k - 1) / Round( exrlnn ) )
        );
        H Line( exranlnorm[Round( exrlnn )], 10, 1.0 );
        Pen Color( "blue" );
        Y Function( Normal Distribution( Log( tdeq ), -1, 1.5 ), tdeq );
        Text( {-4, 0.8}, " n=", Round( exrlnn ) );
    ),
    H List Box( Slider Box( 10, 2000, exrlnn, exrlny << reshow ), Text Box( " n" ) )
);


```

### [Random Multivariate Normal](#random-multivariate-normal)

**Syntax:** y = Random Multivariate Normal( mean, covar, \<nrows=1>)

**Description:** Returns a random nrows by p matrix from a multivariate normal distribution with mean vector mean and (positive semi-definite) covariance matrix covar, where p is defined as the number of rows of covar.

**JMP Version Added:** 15

```

meanvec = 1 :: 3;
covar = [1 .6 .6, .6 1 .6, .6 .6 1];
randmvnRow = Random Multivariate Normal( meanvec, covar );
randmvnMat = Random Multivariate Normal( meanvec, covar, 10 );


```

### [Random Negative Binomial](#random-negative-binomial)

**Syntax:** y = Random Negative Binomial( r, p )

**Description:** Returns a random number of non-events until r events occur, for events with probability p.

**JMP Version Added:** Before version 14

```

exnbpp = 0.3;
exnbpn = 20;
exnbrn = Random Negative Binomial( 20, 0.3 );
New Window( "Example: Neg Binomial Probability",
    exnbpy = Graph Box(
        Y Scale( 0, 0.04 ),
        X Scale( -1, 100 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exnbpk = 0, exnbpk < 1000, exnbpk++,
            V Line( exnbpk, 0, Neg Binomial Probability( exnbpp, exnbpn, exnbpk ) )
        );
        Pen Color( "blue" );,
        Pen Size( 4 ),
        V Line( exnbrn, 0, Neg Binomial Probability( exnbpp, exnbpn, exnbrn ) );
        Text( {1, 0.035}, "n=", Round( exnbpn ), " p=", Round( exnbpp, 2 ) );
        Text(
            {1, 0.030},
            "x=",
            Round( exnbrn, 2 ),
            " Prob=",
            Round( Neg Binomial Probability( exnbpp, exnbpn, exnbrn ), 2 )
        );
    ),
    H List Box(
        Button Box( "Generate a Random Negative Binomial Number",
            exnbrn = Random Negative Binomial( 20, 0.3 );
            exnbpy << reshow;
        )
    )
);


```

### [Random Normal](#random-normal)

**Syntax:** y = Random Normal( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a normal distribution with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

**Example 1**

```


//produce a single random number
x = Random Normal();
//produce a vector of random numbers
v = J( 1, 10, Random Normal() );
//show results
Show( x, v );


```

**Example 2**

```

exGcoordX = J( 50, 1, . );
exGcoordY = J( 50, 1, . );
For( k = 1, k <= 50, k++,
    exGcoordX[k] = Random Uniform( -5, 5 )
);
For( k = 1, k <= 50, k++,
    exGcoordY[k] = exGcoordX[k] + Random Normal()
);
New Window( "Random Normal, Linear Regression, and Outlier",
    V List Box(
        Graph Box(
            framesize( 600, 300 ),
            X Scale( -10, 10 ),
            Y Scale( 1.5 * Min( exGcoordY ), 1.5 * Max( exGcoordY ) ),
            double buffer,
            exsx = Sum( exGcoordX ),
            exsy = Sum( exGcoordY ),
            exsxx = Sum( (exGcoordX) ^ 2 );
            exsxy = Sum( exGcoordX :* exGcoordY );
            exbeta1 = (100 * exsxy - exsx * exsy) / (100 * exsxx - exsx * exsx);
            exbeta0 = (exsy - exbeta1 * exsx) / 100;
            exx1 = Min( exGcoordX );
            exy1 = exbeta0 + exbeta1 * Min( exGcoordX );
            exx2 = Max( exGcoordX );
            exy2 = exbeta0 + exbeta1 * Max( exGcoordX );
            Line( {exx1, exy1}, {exx2, exy2} );
            Marker Size( 5 );
            Drag Marker( exGcoordX, exGcoordY );
            Drag Text( [-7], [-5], "drag any marker" );
        )
    )
);


```

### [Random Normal Mixture](#random-normal-mixture)

**Syntax:** y = Random Normal Mixture( meanvec, sdvec, probvec )

**Description:** Returns a random number from a normal mixture distribution with group means meanvec, group standard deviations sdvec, and group probabilities probvec.

**JMP Version Added:** Before version 14

```

dt = New Table( "Example",
    New Column( "Rand NM",
        set formula( Random Normal Mixture( [-3, 3], [1, 1], [.3, .7] ) )
    )
);
dt << add rows( 1000 );
Distribution( Continuous Distribution( Column( :Rand NM ), Vertical( 0 ) ) );


```

### [Random Poisson](#random-poisson)

**Syntax:** y = Random Poisson( lambda )

**Description:** Returns a random number from a Poisson distribution.

**JMP Version Added:** Before version 14

```

exrpoilambda = 20;
exrpoilsz = Log( 300 );
New Window( "Example: Random Poisson and Empirical Distribution",
    exrpoiy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 50 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        exrpoisz = Round( Exp( exrpoilsz ) );
        exrpoisamp = J( Round( exrpoisz ), 1, . );
        exrpoifreq = J( Round( 50 + 1 ), 1, . );
        For( exrpoik = 1, exrpoik <= Round( exrpoisz ), exrpoik++,
            exrpoisamp[exrpoik] = Random Poisson( exrpoilambda )
        );
        For( exrpoik = 0, exrpoik <= 50, exrpoik++,
            exrpoifreq[exrpoik + 1] = Sum( exrpoisamp <= exrpoik ) / Round( exrpoisz )
        );
        exrpoitmp1 = 0;
        exrpoitmp2 = 0;
        For( exrpoik = 0, exrpoik < 50, exrpoik++,
            H Line( exrpoik, exrpoik + 1, Poisson Distribution( exrpoilambda, exrpoik ) );
            V Line(
                exrpoik + 1,
                Poisson Distribution( exrpoilambda, exrpoik ),
                Poisson Distribution( exrpoilambda, exrpoik + 1 )
            );
        );
        Pen Color( "blue" );
        For( exrpoik = 0, exrpoik < 50, exrpoik++,
            H Line( exrpoik, exrpoik + 1, exrpoifreq[exrpoik + 1] );
            V Line( exrpoik + 1, exrpoifreq[exrpoik + 1], exrpoifreq[exrpoik + 2] );
        );
        Text(
            {10, 0.2},
            " \!U03BB=",
            Round( exrpoilambda, 2 ),
            " sample size=",
            Round( exrpoisz )
        );
    ),
    H List Box(
        Slider Box( Log( 10 ), Log( 5000 ), exrpoilsz, exrpoiy << reshow ),
        Text Box( " random sample size" )
    )
);


```

### [Random Reset](#random-reset)

**Syntax:** Random Reset( seed number )

**Description:** Restarts the random sequences with a new seed.

**JMP Version Added:** Before version 14

```

Random Reset( 1 );
Random Normal();


```

### [Random Seed State](#random-seed-state)

**Syntax:** Random Seed State( <seed state> )

**Description:** Retrieves or restores the random seed state to or from a blob object.

**JMP Version Added:** Before version 14

```

r = Random Seed State();
Random Seed State( r );


```

### [Random SEV](#random-sev)

**Syntax:** y = Random SEV( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a SEV distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random SEV( 50, 5 );
//produce a vector of random numbers
v = J( 1, 10, Random SEV( 50, 5 ) );
//show results
Show( x, v );


```

### [Random SHASH](#random-shash)

**Syntax:** y = Random SHASH( gamma, delta, theta, sigma )

**Description:** Returns a random number from the sinh-arcsinh (SHASH) distribution.

**JMP Version Added:** 14

**Example 1**

```


//produce a single random number
x = Random SHASH( 0, 1, 0, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random SHASH( 0, 1, 0, 1 ) );
//show results
Show( x, v );


```

**SHASH Transformation**

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [Random Shuffle](#random-shuffle)

**Syntax:** y = Random Shuffle( matrix )

**Description:** Returns the matrix with the elements shuffled into a random order.

**JMP Version Added:** Before version 14

```

exA = [1 2 6, 3 5 8];
Random Shuffle( exA );


```

### [Random SVD](#random-svd)

**Syntax:** {U, M, V} = Random SVD( X , \<nSingularValues=min(nRow,nCol)>, \<nOver=10>, \<nIter=2>)

**Description:** Computes the singular value decomposition of matrix X using the randomized singular value decomposition by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** 17

```

Random SVD( [11 22, 33 44], 1 );


```

### [Random t](#random-t)

**Syntax:** y = Random t( df, \<nonCentrality=0> )

**Description:** Returns a random number from an t distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random t( 2 );
//produce a vector of random numbers
v = J( 1, 10, Random t( 2 ) );
//show results
Show( x, v );


```

### [Random Triangular](#random-triangular)

**Syntax:** y = Random Triangular( a, b, c ); y = Random Triangular( b, c ); y = Random Triangular( b )

**Description:** Returns a random number from a triangular distribution with lower limit a, mode b, and upper limit c. Random Triangular(b,c) is equivalent to Random Triangular(0,b,c). Random Triangular(b) is equivalent to Random Triangular(0,b,1).

**JMP Version Added:** Before version 14

```

Random Reset( 13579 );
x = Random Triangular( 0.8 );
Random Reset( 13579 );
y = Random Triangular( 0, 0.8, 1 );
Show( x, y );


```

### [Random Uniform](#random-uniform)

**Syntax:** y = Random Uniform( <min>, <max> )

**Description:** Returns a random number from a uniform distribution between min and max, exclusive.

**JMP Version Added:** Before version 14

**Example 1**

```


//produce a single random number
x = Random Uniform( 1, 10 );
//produce a vector of random numbers
v = J( 1, 10, Random Uniform( 1, 10 ) );
//show results
Show( x, v );


```

**Example 2**

```

Random Uniform( 1, 10 );


```

### [Random Weibull](#random-weibull)

**Syntax:** y = Random Weibull( beta, \<alpha=1> )

**Description:** Returns a random number from a Weibull distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Weibull( 3, 20 );
//produce a vector of random numbers
v = J( 1, 10, Random Weibull( 3, 20 ) );
//show results
Show( x, v );


```

### [Random ZI Negative Binomial](#random-zi-negative-binomial)

**Syntax:** y = Random ZI Negative Binomial( lambda, sigma, pi )

**Description:** Returns a random number from a zero-inflated Negative Binomial distribution with location parameter lambda, scale parameter sigma, and zero inflation parameter pi.

**JMP Version Added:** 19

**Example 1**

```

exnbpp = 0.3;
exnbpn = 20;
rnb = Random ZI Negative Binomial( 25, .5, .05 );
New Window( "Example: Zero Inflated Negative Binomial",
    exnbpy = Graph Box(
        Y Scale( 0, 0.075 ),
        X Scale( -1, 100 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( i = 0, i < 100, i++,
            V Line( i, 0, ZI Negative Binomial Probability( i, 25, .5, .05 ) )
        );
        Pen Color( "blue" );,
        Pen Size( 4 ),
        V Line( rnb, 0, ZI Negative Binomial Probability( rnb, 25, .5, .05 ) );
        Text(
            {25, 0.06},
            "lambda=",
            Round( 25 ),
            ", sigma=",
            Round( .5, 2 ),
            ", pi=",
            Round( .05, 2 )
        );
        Text(
            {25, 0.05},
            "x=",
            Round( rnb, 2 ),
            ", Prob=",
            Round( ZI Negative Binomial Probability( rnb, 25, .5, .05 ), 4 )
        );
    ),
    H List Box(
        Button Box( "Generate a Random Zero Inflated Negative Binomial Number",
            rnb = Random ZI Negative Binomial( 25, .5, .05 );
            exnbpy << reshow;
        )
    )
);


```

**Example 2**

```

Random Reset( 19 );
dt = As Table( J( 1000, 1, Random ZI Negative Binomial( 5, 2, .2 ) ) );
Column( 1 ) << set name( "Random ZiNB" );
dt << Distribution(
    Continuous Distribution(
        Column( :Random ZiNB ),
        Vertical( 0 ),
        Fit ZI Negative Binomial,
        CDF Plot( 1 )
    )
);


```

### [Random ZI Poisson](#random-zi-poisson)

**Syntax:** y = Random ZI Poisson Binomial( lambda, pi )

**Description:** Returns a random number from a zero-inflated Poisson distribution with location parameter lambda and zero inflation parameter pi.

**JMP Version Added:** 19

**Example 1**

```

exnbpp = 0.3;
exnbpn = 20;
rp = Random ZI Poisson( 20, .05 );
New Window( "Example: Zero Inflated Poisson",
    exnbpy = Graph Box(
        Y Scale( 0, 0.1 ),
        X Scale( -1, 60 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( i = 0, i < 100, i++,
            V Line( i, 0, ZI Poisson Probability( i, 20, .05 ) )
        );
        Pen Color( "blue" );,
        Pen Size( 4 ),
        V Line( rp, 0, ZI Poisson Probability( rp, 20, .05 ) );
        Text( {30, 0.06}, "lambda=", Round( 20 ), ", pi=", Round( .05, 2 ) );
        Text(
            {30, 0.05},
            "x=",
            Round( rp, 2 ),
            ", Prob=",
            Round( ZI Poisson Probability( rp, 20, .05 ), 4 )
        );
    ),
    H List Box(
        Button Box( "Generate a Random Zero Inflated Poisson Number",
            rp = Random ZI Poisson( 20, .05 );
            exnbpy << reshow;
        )
    )
);


```

**Example 2**

```

Random Reset( 19 );
dt = As Table( J( 1000, 1, Random ZI Poisson( 5, .2 ) ) );
Column( 1 ) << set name( "Random ZIP" );
dt << Distribution(
    Continuous Distribution(
        Column( :Random ZIP ),
        Vertical( 0 ),
        Fit ZI Poisson,
        CDF Plot( 1 )
    )
);


```

### [Range](#range)

**Syntax:** y = Range( x1, ... )

**Description:** Returns the minimum and maximum values among the combined arguments, which can be scalar, matrix or list arguments.

**JMP Version Added:** 15

```

Eval List( {Range( Pi(), e() ), Range( [33 44 22] )} );


```

### [Range Slider Box](#range-slider-box)

**Syntax:** y = Range Slider Box( minValue, maxValue, lowVariable, highVariable, script )

**Description:** Returns a display box that shows a range slider control that ranges from minValue to maxValue. As the two sliders' positions change, their values are placed into lowVariable and highVariable, and the script is run.

**JMP Version Added:** Before version 14

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);


```

### [Rank](#rank)

**Syntax:** y = Rank Index( x )

**Description:** Returns a vector of indices that, used as a subscript to the original vector v, sorts the vector by rank. Excludes missing values.

**JMP Version Added:** Before version 14

```

Rank( [33, 22, 44, 11, ., 33] );


```

### [Rank Index](#rank-index)

**Syntax:** y = Rank Index( x )

**Description:** Returns a vector of indices that, used as a subscript to the original vector v, sorts the vector by rank. Excludes missing values.

**JMP Version Added:** Before version 14

```

Rank Index( [33, 22, 44, 11, ., 33] );


```

### [Ranking](#ranking)

**Syntax:** y = Ranking( x, < \<<tie("average"|"row"|"minimum"|"maximum"|"arbitrary")> )

**Description:** Returns a vector of ranks of the values of x, low to high as 1 to n, ties arbitrary.

**JMP Version Added:** Before version 14

```

Ranking( [33, 22, 44, 11, 33] );
Ranking( [22, 11, 33, 11, 44, 55, 44, 44, 44], <<Tie( "minimum" ) );


```

### [Ranking Tie](#ranking-tie)

**Syntax:** y = Ranking Tie( x, < \<<tie("average"|"row"|"minimum"|"maximum"|"arbitrary")> )

**Description:** Returns a vector of ranks of the values of x, but ranks for ties averaged.

**JMP Version Added:** Before version 14

```

Ranking Tie( [33, 22, 44, 11, 33] );


```

### [Recode](#recode)

**Syntax:** recode(string|number|list, {<transform>, ...}, \<Multiple Response (Separator(sepChar))>, \<By Word(Delimiters(<chars>)>)

**Description:** Apply the listed transformations to the input value(s) and return the result. The Multiple Response and By Word options split supplied character data into smaller input values. Once the input values are determined, the transformations are applied to those values separately.

Special JSL variables are populated during the execution of the command:

```
_rcNow is the current value of the input after the previous transformation(s).

_rcOrig is the original value of the input.

```

**JMP Version Added:** 15

**Example 1**

```

Recode(
    "27513-0000",
    {Regex( _rcNow, "(\d\d\d\d\d)-\d+", "\1", GLOBALREPLACE ), Num( _rcNow )}
);


```

**Example 2**

```

Recode(
    "A B C",
    {Map Value( _rcNow, {"A", "Apple", "B", "Banana"}, Unmatched( "Unknown fruit" ) )},
    By Word
);


```

### [Rect](#rect)

**Syntax:** Rect( left, top, right, bottom, \<fill=0> ); Rect( {left, top}, {right, bottom} )

**Description:** Draws a rectangle, filled if fill is nonzero.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "Green" );
        Pen Size( 2 );
        Fill Color( "Red" );
        Rect( 15, 75, 65, 55, 1 );
        Rect( 10, 80, 70, 50 );
    )
);


```

### [Recurse](#recurse)

**Syntax:** y = Recurse( x1, ... )

**Description:** Calls the containing function.

**JMP Version Added:** Before version 14

```

ex rev = Function( {s},
    If( Length( s ) <= 1,
        s,
        Recurse( Substr( s, 2 ) ) || Left( s, 1 )
    )
);
ex rev( "abcd" );


```

### [Regex](#regex)

**Syntax:** result = Regex( source, pattern, \<format, <IGNORECASE>, <GLOBALREPLACE>> )

**Description:** Searches in the source text for a match to the pattern. The format defaults to "\\0" (the entire match) but could be "Fred" (for a constant replacement) or "\\1" (to use the text matched by the first parenthesis in the pattern). Returns numeric missing for no match. Case must match by default.

**JMP Version Added:** Before version 14

```

Regex(
    "   Are you there Alice?, asked Jerry.",
    " (here|there) (\w+).+(said|asked) (\w+)\.",
    "  I am \1, \4, replied \2."
);


```

### [Regex Match](#regex-match)

**Syntax:** Regex Match( source, pattern, \<replacement | NULL>, <MATCHCASE> )

**Description:** Executes a regular expression match and returns a list of the entire matched text and the matches for each back reference created by an open parenthesis. Optionally, the third argument specifies a replacement string for the entire match; the replacement string can use back references.

**JMP Version Added:** Before version 14

```


source = "believe";
// [aeiou] matches exactly one vowel
// .*? is a reluctant (vs greedy) match. try it without the ? to see the greedy behavior
// \1 is a back reference to the first ( group -- [aeiou] is inside the first ( group
matches = Regex Match(
    source, // a variable allows updating some text
    "([aeiou])(.*?)(\1)", // a regex with parens makes back references
    ">\2<" // the match is replaced by text that uses a back reference
);
Show( source, matches );
// results:
// source = "b>li<ve";
// matches = {"elie", "e", "li", "e"};
// notes:
// matches[1] is the entire match AND the part that will be replaced
// matches[2] is back ref \1  this is the letter e matched by [aeiou]
// matches[3] is back ref \2  this is the letter li matched by .*?
// matches[4] is back ref \3  this is another letter e match by \1, which was an e
//
// the * operator is greedy by default, taking as many characters as it can, and
// only backing up if required. Adding the ? makes it reluctant, taking characters
// one at a time and allowing the remaining pattern to have a chance earlier.


```

### [Register Addin](#register-addin)

**Syntax:** Register Addin( uniqueId, homeFolder, \<displayName(name)>, \<MinJMPVersion(version)>, \<MaxJMPVersion(version)>, \<AutoLoad(0|1)> )

**Description:** Register an add-in. An Autoload value of 1 forces the add-in to load when registered. A value of 0 leaves the add-in unloaded. If AutoLoad is not specified the addin.def setting will be used if found otherwise the default will be for the add-in to be loaded.

**JMP Version Added:** Before version 14

```

Register Addin(
    "com.mycompany.myaddin",
    "$DOCUMENTS/myaddin",
    displayname( "Sample Addin" )
);


```

### [Remove](#remove)

**Syntax:** y = Remove( x, <i>, \<n=1> ); y = Remove( x, {list} )

**Description:** Returns a copy of list x, deleting n items starting with the ith item or deleting a list of items specified by the list argument.

**JMP Version Added:** Before version 14

```

Remove( {11, 22, 33, 44, 55}, 3, 2 );


```

### [Remove Color Theme](#remove-color-theme)

**Syntax:** Remove Color Theme("Name"|{"Name", <flags>, {color, ...}, \<{position, ...}>})

**Description:** Removes a custom color theme from the global list, either by name or by the full color theme object.

**JMP Version Added:** Before version 14

```

Remove Color Theme( "Yellow To Blue" );


```

### [Remove Custom Functions](#remove-custom-functions)

**Syntax:** Remove Custom Functions({function 1 full name, function 2 full name, ...} | function full name)

**Description:** Removes a list of custom functions from the environment.

**JMP Version Added:** 14

```

Remove Custom Functions( {"custom:Add", "custom:Sub"} );


```

### [Remove From](#remove-from)

**Syntax:** Remove From( x, <i>, \<n=1> )

**Description:** Modifies list, associative array, or display box x by removing items. Associative arrays specify the item to be removed with a key value i. Lists and display boxes remove starting with the item in position i. A list will remove multiple items at once if the n option is specified. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Remove From( ex, 3, 2 );
ex;


```

**Example 2**

```

ex = ["a" => 10, "b" => 3, "c" => 12, => 0];
Remove From( ex, "c" );
ex;


```

**Example 3**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Remove From( hlist, 1 );


```

### [Rename Directory](#rename-directory)

**Syntax:** rc = Rename Directory( old, new )

**Description:** Renames a directory without moving or copying it; the new name does NOT include a path. Returns 1 if the directory was renamed. Returns 0 if the directory was unable to be renamed or the path is invalid.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/subD" );
Delete Directory( "$TEMP/Loss Function Templates" );
rc0 = Copy Directory( "$SAMPLE_DATA/Loss Function Templates", "$TEMP" );
rc1 = Rename Directory( "$TEMP/Loss Function Templates", "subD" /* NO PATH */ );
rc2 = Directory Exists( "$TEMP/Loss Function Templates" );
rc3 = Directory Exists( "$TEMP/subD" );
rc4 = Delete Directory( "$TEMP/subD" );
rc5 = Directory Exists( "$TEMP/subD" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Rename File](#rename-file)

**Syntax:** rc = Rename File( old, new )

**Description:** Renames a file without moving or copying it; the new name does NOT include a path. Returns 1 if the file was renamed. Returns 0 if the file was unable to be renamed. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc1 = Rename File( "$TEMP/x.jmp", "y.jmp" /* NO PATH */ );
rc2 = File Exists( "$TEMP/x.jmp" );
rc3 = File Exists( "$TEMP/y.jmp" );
rc4 = Delete File( "$TEMP/y.jmp" );
rc5 = File Exists( "$TEMP/y.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Repeat](#repeat)

**Syntax:** s = Repeat( x, n, \<m=1> )

**Description:** Returns the text, matrix, or list specified by the x argument concatenated with itself n times. If x is a number or a matrix, then n indicates vertical repetition and the optional argument m designates horizontal repetition.

**JMP Version Added:** Before version 14

```

Show( Repeat( {"A", "B"}, 3 ), Repeat( 2, 3 ), Repeat( 2, 1, 3 ) );


```

### [Report](#report)

**Syntax:** y = Report( platform object )

**Description:** Returns a reference to the display tree for the report from a platform.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Report( Bivariate( Y( :weight ), X( :height ), Fit Line ) );


```

### [Resample Freq](#resample-freq)

**Syntax:** Resample Freq( \<rate=1>, <column> )

**Description:** Generates a frequency count for sampling with replacement, useful for bootstrap samples. With no arguments, the function generates a 100% resample. The rate argument specifies the rate of resampling. If the column argument is specified, the sample size chosen is rate multiplied by the sum of the specified column. A negative rate signals that fractional frequencies are allowed.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Freq", numeric, formula( Resample Freq() ) );
New Window( "w", theBox = V List Box() );
For( i = 1, i <= 30, i++,
    Column( "Freq" ) << EvalFormula;
    theBox << append(
        V List Box( Bivariate( Y( :height ), X( :weight ), Freq( :Freq ), Fit Line( 1 ) ) )
    );
);
newDt = theBox["Parameter Estimates", Table Box( 1 )] << MakeCombinedDataTable;
newDt << Distribution( Y( :Estimate ), By( :Term ), Horizontal Layout( 1 ) );
theBox << CloseWindow;


```

### [Return](#return)

**Syntax:** Return(<Expr>, ..., <ExprN>)

**Description:** Returns an expression value from a user-defined function.

**JMP Version Added:** Before version 14

**Example 1**

```

vr = Function( {},
    x = 2;
    y = 4;
    Return( Char( x * y ) );
);
lvr = Function( {},
    x = 2;
    y = 4;
    For( i = 1, i < 5, i++,
        If( i == 3,
            Return( i * x * y )
        )
    );
);
nr = Function( {}, Return() );
vrv = vr();
lvrv = lvr();
nrv = nr();
Show( vrv, lvrv, nrv );


```

**Example 2**

```

f = Function( {a, b},
    Return( a - b, a + b )
);
{lo, hi} = f( 10, 1 );
Show( lo, hi );
Show( f( 7, 15 ) );


```

### [Reverse](#reverse)

**Syntax:** y = Reverse( x )

**Description:** Returns a copy of list x with the item order reversed.

**JMP Version Added:** Before version 14

```

Reverse( {11, 22, 33, 44, 55} );


```

### [Reverse Into](#reverse-into)

**Syntax:** Reverse Into( x )

**Description:** Modifies list or display box x with the item order reversed. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Reverse Into( ex );
ex;


```

**Example 2**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Reverse Into( hlist );


```

### [Revert Menu](#revert-menu)

**Syntax:** Revert Menu()

**Description:** Reverts to factory default menus.

**JMP Version Added:** Before version 14

```

/* Reverts menus back to factory default settings. */


```

### [RGB Color](#rgb-color)

**Syntax:** y = RGB Color( r, g, b ); y = RGB Color( {r, g, b} )

**Description:** Returns a color number from the red, green, and blue components, all between 0 and 1. RGB Color(1, 1, 1) is white.

**JMP Version Added:** Before version 14

```

New Window( "RGB Color Example", 
    /* 1 through 16 are good */ 
    division = 6;
    blocks = division + 1;
    ysize = 400 / Sqrt( division );
    xsize = ysize * blocks;
    fract = 1 / division;
    /* 100 is default axis range */
    yBlockSize = 100 / blocks;
    xBlockSize = 100 / (blocks * blocks);
    Graph(
        frameSize( xsize, ysize ),
        For( blue = 0, blue <= 1, blue += fract,
            For( red = 0, red <= 1, red += fract,
                For( green = 0, green <= 1, green += fract,
                    y = red / fract * yBlockSize;
                    x = green / fract * xBlockSize + blue / fract * xBlockSize * blocks;
                    /* here's the example */
                    Fill Color( RGB Color( red, green, blue ) );
                    Rect( x, y, x + xBlockSize, y + yBlockSize, 1 );
                )
            )
        )
    );
);


```

### [Right](#right)

**Syntax:** sub = Right( s, n, <filler> )

**Description:** Returns a truncated or padded version of the original string or list s. The result contains the right n characters or list items, padded with any filler on the left if the length of s is less than n.

**JMP Version Added:** Before version 14

```

Right( "http://www.jmp.com", 3 );


```

### [Robust PCA](#robust-pca)

**Syntax:** {A,E} = Robust PCA( X , \<Lambda(2/sqrt(max(nrow,ncol)))>, \<tolerance=1e-10>,\<maxit(75)>,\<Center(1)>,\<Scale(1)>

**Description:** Robustly decomposes data into a low-rank matrix and a sparse matrix of residuals. Outliers are detected in the residuals. It can also impute missing values.

**JMP Version Added:** 16

```

X = [1 -3, -1 -2, -3 -4, -4 -3, -3 1, 3 3] * [-2 5 -1 -2 1, 4 5 -4 -3 1];
X[2, 3] += 15;
Result = Robust PCA( X, Center( 0 ), Scale( 0 ), Lambda( .80 ) );


```

### [Root](#root)

**Syntax:** y = Root( x, \<n=2> )

**Description:** Returns the nth root of x.

**JMP Version Added:** Before version 14

```

Round( Root( 2, 3 ), 4 ) /* cube root */;


```

### [Round](#round)

**Syntax:** y = Round( x, <n> )

**Description:** Rounds x to n digits after the decimal point (or 0 digits if n is not specified). Note that the n argument can be negative.

**JMP Version Added:** Before version 14

```

Round( 213, -1 );


```

### [Row](#row)

**Syntax:** y = Row(); Row() = y

**Description:** Returns the current row in a data table. Can be set as an L-value. Reset the current row by assigning value of 0.

**JMP Version Added:** Before version 14

**Reset Row**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Add Rows( 5 );
Show( Row() );
Row() = 0;


```

**Set Row**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 3;
:height * :weight;


```

### [Row State](#row-state)

**Syntax:** y = Row State( <dt>, <r> ); Row State( <dt>, <r> ) = y

**Description:** Returns the row state of the current (or rth) row in the current data table. If the Row State() function is used as an L-value, it changes the row state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Color State( {1, .5, 1} );
Color To RGB( Color Of( Row State( 3 ) ) );


```

### [Run Program](#run-program)

**Syntax:** obj = Run Program( Executable( "path/etc.exe" ), < Options( {"/a", "/b etc" } ) >, < Parameter( optParm ) >, < Read Function( Function( {this, optParm}, etc ) | "text" | "blob" ) >, < Write Function( Function( {this, optParm}, etc ) ) > )

**Description:** Control an external program using stdin and stdout.

**JMP Version Added:** Before version 14

**Example 1**

```

RP = Run Program(
    Executable( "PING.EXE"/*path probably not needed*/ ),
    Options( {"-n 5", "localhost"} ),
    ReadFunction( Function( {this}, Write( this << read ) ) )
);


```

**Example 2**

```

RP = Run Program(
    Executable( "CMD.EXE"/*path probably not needed*/ ),
    Options( {"/a", "/q", "/c dir"} ),
    ReadFunction( Function( {this}, Write( this << read ) ) )
);


```

**Example 3**

```

commands = {"echo this is a test\!n", "ping -n 1 localhost\!n", "exit\!n"};
icommand = 0;
RP = Run Program(
    Executable( "CMD.EXE" ),
    Options( {"/a", "/q"} ),
    ReadFunction( Function( {this}, Write( this << Read ) ) ),
    WriteFunction(
        Function( {this},
            icommand++;
            If( icommand <= N Items( commands ),
                this << Write( commands[icommand] );
                Show( commands[icommand] );
            ,
                this << WriteEOF;
                Show( this << CanRead, this << CanWrite, this << isReadEOF );
            );
        )
    )
);


```

### [SAS Name](#sas-name)

**Syntax:** sasName = SAS Name( string|namelist )

**Description:** Converts JMP variable names to a string containing valid SAS variable names by changing special characters and blanks to underscores. The argument can be specified as a string or a list of strings.

**JMP Version Added:** Before version 14

```

SAS Name( {"x 1", "x 2"} );


```

### [SAS Open For Var Names](#sas-open-for-var-names)

**Syntax:** nameList = SAS Open For Var Names( path )

**Description:** Returns a list of variable names from a SAS data set.

**JMP Version Added:** Before version 14

```

SAS Open For Var Names( "C:\my data\somedata.sas7bdat" );


```

### [Save Log](#save-log)

**Syntax:** f = Save Log( <path> )

**Description:** Writes the contents of the log to the specified file location. If the write is successful, this function returns the name of the created file.

**JMP Version Added:** Before version 14

```

Save Log( "$TEMP/log.txt" );
exlogText = Load Text File( "$TEMP/log.txt" );
Substr( exlogText, 1, 30 );


```

### [Save Text File](#save-text-file)

**Syntax:** f = Save Text File( path, text|blob, \<mode("replace"|"append")> )

**Description:** Creates a text file with the file name that is specified by the path argument and contents specified by the text string argument. If the save is successful, the Save Text File() function returns the pathname of the created file.

**JMP Version Added:** Before version 14

```

Save Text File( "$TEMP/DeleteMe.txt", "The quick brown fox" );
Load Text File( "$TEMP/DeleteMe.txt" );


```

### [SbInv](#sbinv)

**Syntax:** x = SbInv( z, gamma, delta, theta, sigma )

**Description:** Transforms a standard normal variable to a double bounded Johnson variable.

**JMP Version Added:** Before version 14

```

SbInv( 1.96, 1.5, 2, 1, 2 );


```

### [SbTrans](#sbtrans)

**Syntax:** z = SbTrans( x, gamma, delta, theta, sigma )

**Description:** Transforms a double bounded Johnson variable to a standard normal variable.

**JMP Version Added:** Before version 14

```

Round( SbTrans( 2.114, 1.5, 2, 1, 2 ), 2 );


```

### [Scene Box](#scene-box)

**Syntax:** box = Scene Box( xsize, ysize )

**Description:** Returns a display box for 3D graphics.

**JMP Version Added:** Before version 14

```

Scene = Scene Box( 600, 600 );
Scene << backgroundcolor( 0 );
Scene << showarcball( always );
New Window( "See HelloWorld.jsl in sample scripts", Scene );
Scene << perspective( 45, .2, 20 );
Scene << Translate( 0.0, 0.0, -4.5 );
ex = Scene Display List();
ex << color( .9, .9, .9 );
ex << Text( center, middle, .3, "Hello World" );
Scene << arcball( ex, 1.5 );
Scene << update;


```

### [Scene Display List](#scene-display-list)

**Syntax:** list = Scene Display List()

**Description:** Returns a display list for 3D graphics.

**JMP Version Added:** Before version 14

```

ex = Scene Display List();
ex << color( .9, .9, .9 );
ex << Text( center, middle, .3, "Hello World" );
exScene = Scene Box( 600, 600 );
exScene << backgroundcolor( 0 );
exScene << showarcball( always );
New Window( "See HelloWorld.jsl in sample scripts", exScene );
exScene << perspective( 45, .2, 20 );
exScene << Translate( 0.0, 0.0, -4.5 );
exScene << arcball( ex, 1.5 );
exScene << update;


```

### [Schedule](#schedule)

**Syntax:** Schedule( sec, scpt )

**Description:** Schedules an event that runs the scpt script argument after sec seconds have elapsed.

**JMP Version Added:** Before version 14

```

Schedule(
    10,
    Beep();
    Print( "Time's up!" );
);


```

### [Scheffe Cubic](#scheffe-cubic)

**Syntax:** y = Scheffe Cubic( x1, x2 )

**Description:** Evaluates as x1*x2*(x1-x2); used to support modeling notation for cubic mixture models.

**JMP Version Added:** Before version 14

```

Scheffe Cubic( [1, -1, 1, -1, 1], [-1, -1, 1, 1, -1] );


```

### [Scoring Impute](#scoring-impute)

**Syntax:** {imputedRow} = Scoring Impute ( rowWithMissing , VMat, colMeanVec, colStdDevVec)

**Description:** Provides streaming functionality for the Automated Data Imputation (ADI) algorithm. The input arguments are a row vector that contains missing values, a loading matrix (also called the V matrix) that is produced by the ADI algorithm, a vector of the column means ignoring missing cells, and a vector of the column standard deviations ignoring missing cells. It returns the row vector with the missing values imputed using least squares estimation.

**JMP Version Added:** 14

```

Scoring Impute(
    [1 2 3 . 4 .],
    [.5 .6, .3 .4, .1 .2, .6 .7, .3 .3, .5 .4],
    [0, 0, 0, 0, 0, 0],
    [1, 1, 1, 1, 1, 1]
);


```

### [Script Box](#script-box)

**Syntax:** y = Script Box( <s>, \<"C" | "JavaScript" | "JSL" | "JSON" | "Python" | "R" | "SAS" | "SQL" | "Text" | "XML">, <width>, <height> )

**Description:** Returns a display box to edit a script. By default the editor has JSL syntax highlighting and behavior.

**JMP Version Added:** Before version 14

**JSL**

```

Script = Script Box( "// This window is editable.", "JSL", 300, 100 );
New Window( "This is a script box", Script );


```

**Python script**

```

pyscript = "\[import numpy as np
a = np.arange(15).reshape(3, 5)]\";
Script = Script Box( pyscript, "Python", 300, 100 );
New Window( "This is a python script box", Script );


```

### [Scroll Box](#scroll-box)

**Syntax:** y = Scroll Box( \<Size( x, y )>, displayBox )

**Description:** Returns a display box that positions a larger child box using scroll bars.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        Scroll Box(
            Size( 200, 100 ),
            V List Box(
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
            ),
            <<Set Stretch( "Window", "Window" )
        )
    )
);


```

### [Second](#second)

**Syntax:** sec = Second( datetime )

**Description:** Returns the seconds part of a date-time value, including any fractional part, 0 - 60 exclusive.

**JMP Version Added:** Before version 14

```

Second( Today() );


```

### [Selected](#selected)

**Syntax:** y = Selected( <rs> );Selected( \<Row State( <r> )> ) = y

**Description:** Returns the selected component of the specified row state value, 0 or 1. If Selected is used as an L-value, it changes the selected state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Selected State( 1 );
Selected( Row State( 3 ) );
Row() = 3;
Selected();


```

### [Selected State](#selected-state)

**Syntax:** rs = Selected State( x )

**Description:** Returns a row state value with the selected component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Selected State( 1 );
Selected( Row State( 3 ) );


```

### [Send](#send)

**Syntax:** r = obj \<< msg( args ); r = obj \<< msg; r = Send( obj, msg )

**Description:** Sends a message (in the form of an expression) to an object.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Bivariate( Y( :weight ), X( :height ) ) << Fit Line;


```

### [Sequence](#sequence)

**Syntax:** y = Sequence( start, end, \<incr=1>, \<n=1> )

**Description:** Returns the Row()th item in the sequence of numbers from start to end incremented by incr. Each number in the sequence is repeated n times. Because of its dependence on Row(), the Sequence() function is mainly useful in column formulas. To create sequences as JSL matrices, see Index().

**JMP Version Added:** Before version 14

```

Row() = 3;
Sequence( 1, 9, 2 );


```

### [Set Clipboard](#set-clipboard)

**Syntax:** Set Clipboard( text )

**Description:** Puts the specified text onto the system clipboard used by the Edit menu.

**JMP Version Added:** Before version 14

```

Set Clipboard( "example" );


```

### [Set Default Directory](#set-default-directory)

**Syntax:** Set Default Directory( path )

**Description:** Sets the JMP default directory, which is used as a base for subsequent relative paths.

**JMP Version Added:** Before version 14

```

Set Default Directory( "$SAMPLE_DATA" );
Open( "Big Class.jmp" );


```

### [Set Difference](#set-difference)

**Syntax:** list = Set Difference( list1, list2 )

**Description:** Returns the list of items that occur in list1 but not in list2. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Difference( {1, 3}, {3, 2} ) );
Show( Set Difference( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );


```

### [Set Environment Variable](#set-environment-variable)

**Syntax:** value = Set Environment Variable( string, < string> )

**Description:** Sets the value of the specified environment variable in the operating system. If the second argument is either missing or is an empty string then the environment variable is deleted.

NOTE: On the Macintosh operating system, the variable name is case-sensitive.

**JMP Version Added:** Before version 14

```

Set Environment Variable( "PATH", "some path to a directory" );


```

### [Set File Search Path](#set-file-search-path)

**Syntax:** Set File Search Path(path | {list of paths})

**Description:** Sets the current list of directories to search for opening files. "." means the current directory.

**JMP Version Added:** Before version 14

```

Set File Search Path(
    {Convert File Path( "$SAMPLE_DATA/" ), Convert File Path( "$SAMPLE_DATA/Time Series/" )}
);
Show( Get File Search Path() );
Show( Convert File Path( "Air.jmp", search ) );
Show( Convert File Path( "Full of Air.jmp", search ) );
Show( Convert File Path( "Iris.jmp", search ) );


```

### [Set Global Window Handler](#set-global-window-handler)

**Syntax:** Set Global Window Handler( Handler Function )

**Description:** Sets a function to be called each time a new window is created.

**JMP Version Added:** 17

```

Set Global Window Handler(
    Function( {window},
        Print( window << get window title() );
        window << close window();
    )
);
New Window( "My Window" );
Clear Global Window Handler();


```

### [Set Intersection](#set-intersection)

**Syntax:** list = Set Intersect( list1, list2 )

**Description:** Returns the list of items that occur in both lists. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Intersection( {1, 3}, {3, 2} ) );
Show( Set Intersection( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );
dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << get rows where( Set Intersection( :sports, {"Soccer"} ) != {} );


```

### [Set Path Variable](#set-path-variable)

**Syntax:** Set Path Variable( name, <value> )

**Description:** Sets a path variable, which is a name like SAMPLE_DATA that is substituted for when found in pathnames.

**JMP Version Added:** Before version 14

```

Set Path Variable( "SAMPLE_DATA", Get Path Variable( "SAMPLE_DATA" ) );


```

### [Set Platform Preference](#set-platform-preference)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Set Platform Preferences](#set-platform-preferences)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Set Preference](#set-preference)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Set Preferences](#set-preferences)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Set Toolbar Visibility](#set-toolbar-visibility)

**Syntax:** rc = Set Toolbar Visibility( "toolbar-name" | Default | All, \<window-class-name | All>, \<True | False> )

**Description:** Sets the visibility of a given toolbar for a given class of windows. toolbar-name is the internal name of the toolbar. If Default is passed in as the toolbar name, the specified window class is restored to the default toolbar set for that class of windows. Examples of window-class-name are Data Table, Script, Report, and Journal. If window-class-name is All, then visibility for the specified toolbar is set for all classes of windows.

Returns 1 if successful, 0 if unsuccessful.

**JMP Version Added:** Before version 14

```


// Make the Analyze toolbar visible in Script windows
Set Toolbar Visibility( "Analyze", Script, true );

// Make the Analyze toolbar visible in all classes of windows
Set Toolbar Visibility( "Analyze", All, true );

// Revert Script windows to the default toolbar set for Script windows
Set Toolbar Visibility( Default, Script );

// Revert all windows to their default toolbar set
Set Toolbar Visibility( Default, All );


```

### [Set Union](#set-union)

**Syntax:** list = Set Union( list1, list2 )

**Description:** Returns the list of items that occur in either list. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Union( {1, 3}, {3, 2} ) );
Show( Set Union( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );
all = {};
Open( "$SAMPLE_DATA/Big Class Families.jmp" );
For Each Row( all = Set Union( all, :sports ) );
all = Set Unique( all );
Show( all );


```

### [Set Unique](#set-unique)

**Syntax:** list = Set Unique( list )

**Description:** Returns the list of unique items that occur in the input list. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Unique( {1, 3, 2} ) );
Show( Set Unique( {1, 3, 4, 3, 3, 2, 3, 5, 3} ) );
Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Row() = 1;
Show( Set Unique( :sports ) );


```

### [SEV Density](#sev-density)

**Syntax:** y = SEV Density( x, mu, sigma )

**Description:** Returns the density at x of a smallest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 50;
sig = 5;
New Window( "Example: SEV Density",
    y = Graph Box(
        Y Scale( 0, .06 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( SEV Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [SEV Distribution](#sev-distribution)

**Syntax:** p = SEV Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a smallest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 50;
sig = 5;
New Window( "Example: SEV Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( SEV Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [SEV Quantile](#sev-quantile)

**Syntax:** q = SEV Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a smallest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 50;
sig = 5;
qq = .5;
New Window( "Example: SEV Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( SEV Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( SEV Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 80, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Shade State](#shade-state)

**Syntax:** rs = Shade State( x )

**Description:** Returns a row state value with the color shade component set to the specified value. Needs to be combined with a Hue State() value to produce a valid color.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Combine States( Hue State( 5 ), Shade State( 1 ) );


```

### [Shape](#shape)

**Syntax:** r = Shape( M, nr, <nc>, \<<bycol)

**Description:** Reshapes the M matrix or scalar across rows to be nr rows by nc columns. A missing value is permitted for nr. Data from M is replicated as needed to fill the nr by nc matrix. The optional argument \<<bycol fills the data by column. By default, the data is filled by row. Common uses are to reshape a vector into a matrix or to vectorize a matrix.

**JMP Version Added:** Before version 14

```

Eval List(
    {Shape( [11 22, 33 44], 1, 4 ), Shape( [11 22, 33 44], 1 ), Shape( [11 22, 33 44], ., 4 )
    }
);


```

### [Shape Seg](#shape-seg)

**Syntax:** me = Shape Seg( {Path(<path>), ...}, < Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) > )

**Description:** Returns a display seg with a collection of shapes. Each shape draws a stroke along the given path if fill is 0, or paints the interior of the given path if fill is not 0. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** Before version 14

```

New Window( "Shape Seg Example",
    Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);


```

### [SHASH Density](#shash-density)

**Syntax:** d = SHASH Density( x, gamma, delta, theta, sigma )

**Description:** Returns the density at x of a sinh-arcsinh (SHASH) distribution. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

**Example 1**

```

SHASH Density( 0, -1, 2, -2, 3 );


```

**SHASH Transformation**

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [SHASH Distribution](#shash-distribution)

**Syntax:** p = SHASH Distribution( q, gamma, delta, theta, sigma )

**Description:** Returns the probability that a sinh-arcsinh (SHASH) distributed random variable is less than q. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

**Example 1**

```

gamma = 0.5;
delta = 1;
theta = 1;
sigma = 1;
New Window( "Example: SHASH Distribution",
    jsuc = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -2, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( SHASH Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 0.9},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsuc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, jsuc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 2, theta, jsuc << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 2, sigma, jsuc << reshow ), Text Box( " \!U03C3" ) )
);


```

**SHASH Transformation**

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [SHASH Quantile](#shash-quantile)

**Syntax:** q = SHASH Quantile( p, gamma, delta, theta, sigma )

**Description:** Returns the quantile from a sinh-arcsinh (SHASH) distribution, the value for which the probability is p that a random value would be lower. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

**Example 1**

```

SHASH Quantile( .5, 1, 2, 3, 1 );


```

**SHASH Transformation**

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [SHASHInv](#shashinv)

**Syntax:** x = SHASHInv( z, gamma, delta, theta, sigma )

**Description:** Transforms a standard normal variable to a sinh-arcsinh (SHASH) distributed variable.

**JMP Version Added:** 14

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
x1 = SHASHInv( result1, gamma, delta, theta, sigma );
x2 = SinH( (ArcSinH( result1 ) - gamma) / delta ) * sigma + theta;
Show( x1, x2 );


```

### [SHASHTrans](#shashtrans)

**Syntax:** z = SHASHTrans( x, gamma, delta, theta, sigma )

**Description:** Transforms a sinh-arcsinh (SHASH) distributed variable to a standard normal distributed variable. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [Sheet Part](#sheet-part)

**Syntax:** y = Sheet Part( title, childbox )

**Description:** Returns a display box containing the childbox display box argument with the specified title.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [Shift](#shift)

**Syntax:** y = Shift( x, \<n=1> )

**Description:** Returns a copy of list x with the first n items moved to the end of the list, or, if n is negative, the last n items moved to the start.

**JMP Version Added:** Before version 14

```

Shift( {11, 22, 33, 44, 55}, 2 );


```

### [Shift Into](#shift-into)

**Syntax:** Shift Into( x, \<n=1> )

**Description:** Modifies list or display box x with the first n items moved to the end of the list, or, if n is negative, the last n items moved to the start. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Shift Into( ex, -2 );
ex;


```

**Example 2**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Shift Into( hlist, -2 );


```

### [Short Date](#short-date)

**Syntax:** s = Short Date( datetime, <format> )

**Description:** Returns a numeric (MM/DD/YYYY) locale-specific representation of a date-time value.

**JMP Version Added:** Before version 14

```

Short Date( Today() );


```

### [Shortest Edit Script](#shortest-edit-script)

**Syntax:** list = Shortest Edit Script(A,B); matrix = Shortest Edit Script( strings( A, B, matrix(1), limit(9999) ) ); list = Shortest Edit Script( lines( A, B, separators("defaults to newline"), ignore("defaults to none")|ignoreWhiteSpace(), matrix(0), limit(9999) ) ); matrix = Shortest Edit Script( sequences(nA, nB, Function({iA,iB}, adata[iA] == bdata[ib] ) ) )

**Description:** Returns one of the shortest edit scripts to convert string A into string B. The simple form only returns a list. strings() and lines() have an option to return a matrix or a list. sequences() only returns a matrix. The optional limit() will stop the function early if the edit list has more than limit inserts and deletes. lines() compares lines rather than characters; the optional ignore("characters") or ignoreWhiteSpace() defaults to no ignored characters. ESC will stop the function if needed.

**JMP Version Added:** Before version 14

```

editList = Shortest Edit Script( "time flies like an arrow", "fruit flies like a banana" );
common = "";/* assemble a longest common subsequence */For( i = 1, i <= N Items( editList ),
    i++,
    If( editList[i][1] == "Common", /* or Insert or Remove */common = common || editList[i][2
        ] /* the snippet */
    )
);
common;


```

### [Show](#show)

**Syntax:** Show( x, ... )

**Description:** Displays the name and value of the arguments in the log, one per line.

**JMP Version Added:** Before version 14

```

Show( 355 / 113, Pi() );


```

### [Show Addin Builder Dialog](#show-addin-builder-dialog)

**Syntax:** Show Addin Builder Dialog()

**Description:** Brings up a dialog that can be used to make custom add-ins.

**JMP Version Added:** Before version 14

```

Show Addin Builder Dialog();


```

### [Show Addins Dialog](#show-addins-dialog)

**Syntax:** Show Addins Dialog()

**Description:** Brings up a dialog that shows the status of all registered add-ins.

**JMP Version Added:** Before version 14

```

Show Addins Dialog();


```

### [Show Classes](#show-classes)

**Syntax:** Show Classes( < \<class name | class reference>, ... > )

**Description:** Show the contents of all user-defined classes.

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
Show Classes();


```

### [Show Commands](#show-commands)

**Syntax:** Show Commands( \<keyword=Builtins> )

**Description:** Creates one or more data tables that contain information about various JSL components. The keyword argument determines the content of the output table. Specify Builtins (the default) for built-in operators and functions. Specify Scriptables for all the scriptable commands for objects. Specify Translations for English and localized versions of the scriptable commands. Specify Display Boxes for scriptable commands related to display boxes and display segs. Specify Scriptable Names for the names of scriptable objects. Specify Platform Names for names of platforms.

**JMP Version Added:** Before version 14

```

Show Commands();


```

### [Show Globals](#show-globals)

**Syntax:** Show Globals()

**Description:** Lists all the currently defined global symbols and their values.

**JMP Version Added:** Before version 14

```

Show Globals();


```

### [Show Namespaces](#show-namespaces)

**Syntax:** Show Namespaces( < <namespace reference>, ... > )

**Description:** Show the contents of all user defined namespaces, both named and anonymous.

**JMP Version Added:** Before version 14

```

New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
Show Namespaces( "complex" );
Delete Namespaces( "complex" );


```

### [Show Preferences](#show-preferences)

**Syntax:** Show Preferences()

**Description:** Shows the current preference settings in the log.

**JMP Version Added:** Before version 14

```

Show Preferences();


```

### [Show Properties](#show-properties)

**Syntax:** Show Properties( object )

**Description:** Shows in the log the messages that an object responds to.

**JMP Version Added:** Before version 14

```

Show Properties( Current Data Table() );


```

### [Show Symbols](#show-symbols)

**Syntax:** Show Symbols()

**Description:** Lists all the currently defined symbols and their values.

**JMP Version Added:** Before version 14

```

Show Symbols();


```

### [Simplify Expr](#simplify-expr)

**Syntax:** resultExpr = Simplify Expr( expr( ... ) )

**Description:** Returns an equivalent expression that simplifies the argument expression in various ways.

**JMP Version Added:** Before version 14

```

Simplify Expr( Expr( 2 * 3 * a + b * (a + 3 - c) - a * b ) );


```

### [Sin](#sin)

**Syntax:** y = Sine( x )

**Description:** Returns the trigonometric sine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Sine( Pi() / 6 );


```

### [Sine](#sine)

**Syntax:** y = Sine( x )

**Description:** Returns the trigonometric sine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Sine( Pi() / 6 );


```

### [SinH](#sinh)

**Syntax:** y = SinH( x )

**Description:** Returns the hyperbolic sine of x.

**JMP Version Added:** Before version 14

```

SinH( 1 );


```

### [Slider Box](#slider-box)

**Syntax:** box = Slider Box(minValue, maxValue, variable, script, \<set width(n)>, \<rescale slider(minValue, maxValue)>)

**Description:** Returns a display box that shows a slider control that ranges from minValue to maxValue. As the slider's position changes, its value is placed into variable and the script is run.

**JMP Version Added:** Before version 14

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);


```

### [SlInv](#slinv)

**Syntax:** x = SlInv( z, gamma, delta, theta, \<sigma=1> )

**Description:** Transforms a standard normal variable to a Johnson SL variable.

**JMP Version Added:** Before version 14

```

SlInv( 1.96, 1.5, 2, 1 );


```

### [SlTrans](#sltrans)

**Syntax:** z = SlTrans( x, gamma, delta, theta, \<sigma=1> )

**Description:** Transforms a Johnson SL variable to a standard normal variable.

**JMP Version Added:** Before version 14

```

Round( SlTrans( 2.259, 1.5, 2, 1 ), 2 );


```

### [Sobol Quasi Random Sequence](#sobol-quasi-random-sequence)

**Syntax:** points = Sobol Quasi Random Sequence(nDim, nRow)

**Description:** Generate a sequence of space filling quasi-random numbers using the Sobol sequence in up to 4000 dimensions.

**JMP Version Added:** Before version 14

```

A = Sobol Quasi Random Sequence( 3, 100 );
As Table( A );
Scatterplot 3D( Y( :Col1, :Col2, :Col3 ) );


```

### [Socket](#socket)

**Syntax:** socketHandle = Socket( \<STREAM | DGRAM> )

**Description:** Creates a socket variable that can communicate with sockets on this or another networked computer. The default argument is STREAM. Try your own company's website.

**JMP Version Added:** Before version 14

```


// see the socket's OBJECT messages in the scripting index for better examples
tCall = Socket();
tcall << Ioctl( FIONBIO, 1 );
rc = tCall << connect( "www.jmp.com", "80" );
If( rc[2] == "ok",
    tCall << <<Char To Blob(
        "GET /en_us/home.html HTTP/1.1~0d~0aHost: www.jmp.com~0d~0aConnection: Close~0d~0a~0d~0a",
        "ASCII~HEX"
    );
    While( 1,
        tMessage = tCall << Recv( 100000 );
        If(
            tMessage[2] == "ok",
                Show( Length( tMessage[3] ) ); //typically about six chunks of around 5-20K bytes
        ,
            Starts With( tMessage[2], "WOULDBLOCK" ),
                Show( "waiting" ) // sometimes data might not be available yet
        ,
            Starts With( tMessage[2], "CLOSED" ),
                Break(); // this is the desired result
        , // else
            Show( tMessage );
            Stop();
        );
    );
    tCall << Close();// done
, // else
    Show( rc );
    Stop();
);


```

### [Solve](#solve)

**Syntax:** y = Solve( A, B )

**Description:** Solves the linear system A\*x=B for x. The Solve() function is equivalent to Inverse(A)\*B if A is non-singular. Note that the A argument must be a square matrix.

**JMP Version Added:** Before version 14

```

Solve( [1 1, -1 4], [11, 14] );


```

### [Sort Ascending](#sort-ascending)

**Syntax:** y = Sort Ascending( x )

**Description:** Returns a copy of list or matrix x with the items in ascending order.

**JMP Version Added:** Before version 14

```

Sort Ascending( {111, 212, 133, 114, 55} );


```

### [Sort Descending](#sort-descending)

**Syntax:** y = Sort Descending( x )

**Description:** Returns a copy of list or matrix x with the items in descending order.

**JMP Version Added:** Before version 14

```

Sort Descending( {111, 212, 133, 114, 55} );


```

### [Sort List](#sort-list)

**Syntax:** y = Sort List( x )

**Description:** Returns a copy of list x with the items in ascending order.

**JMP Version Added:** Before version 14

```

Sort List( {111, 212, 133, 114, 55} );


```

### [Sort List Into](#sort-list-into)

**Syntax:** Sort List Into( x )

**Description:** Modifies list x with the items in ascending order. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

```

ex = {111, 212, 133, 114, 55};
Sort List Into( ex );
ex;


```

### [Spacer Box](#spacer-box)

**Syntax:** y = Spacer Box( \<Size( x, y )>, \<Color( c )>)

**Description:** Returns a display box that can be used to maintain space between other display boxes or fill a cell in a Lineup Box. The Size arguments are specified in pixels, and the Color argument is any valid JSL color.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 3 ),
        Text Box( "a" ),
        Spacer Box(),
        Text Box( "b" ),
        Spacer Box(),
        Text Edit Box( "Under Spacer Box" )
    )
);


```

### [Sparse SVD](#sparse-svd)

**Syntax:** {U, M, V} = Sparse SVD( X , \<nSingularValues=min(nRow,nCol)>, \<tolerance=1e-10>)

**Description:** Computes the singular value decomposition of matrix X using the implicitly restarted, partially reorthogonalized Lanczos method for sparse matrices by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** Before version 14

```

Sparse SVD( [11 22, 33 44], 1, 1e-8 );


```

### [Speak](#speak)

**Syntax:** Speak( text, \<Wait( sync )> )

**Description:** Speaks the text if supported by the operating system. Specifying the optional Wait(true) argument delays script execution until speech has finished.

**JMP Version Added:** Before version 14

```

Speak( "Hello" );


```

### [Spin Box](#spin-box)

**Syntax:** y = Spin Box( <script> )

**Description:** Returns a display box to show a button with up/down controls. The script argument is invoked with an argument that indicates the direction of the arrow clicked (negative is down, positive is up). A magnitude of 1 indicates a single click, while larger values can be used to indicate a repeating action.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box(
        2,
        nb = Number Edit Box( 3 ),
        sb = Spin Box( Function( {value}, nb << Increment( value ) ) )
    )
);
nb << Set Increment( 1 );


```

### [Spline Coef](#spline-coef)

**Syntax:** coef = Spline Coef( x, y, lambda, <weights> )

**Description:** Returns a five-column matrix of coefficients in the following order: knots||a||b||c||d for each of the unique values in x. The smoothing parameter lambda must be a positive value, where larger values of lambda result in greater stiffness of the spline. The optional weights vector specifies a weight for each value in x. A weight of zero removes the corresponding point from the spline fit.

**JMP Version Added:** Before version 14

```

Spline Eval( 0 :: 10, Spline Coef( 0 :: 10, Sqrt( 0 :: 10 ), 100 ) );


```

### [Spline Eval](#spline-eval)

**Syntax:** yhat = Spline Eval( x, coef, \<extrapolation=-1> )

**Description:** Evaluates the spline predictions using the coef matrix in the same form as returned by the Spline Coef() function. extrapolation indicates how far beyond the spline range, as a fraction of the range, to extend evaluation before returning missing values.

**JMP Version Added:** Before version 14

```


New Window( "Spline Fit",
    window:x = 20 :: 80;
    window:y = 50 + Sin( (20 :: 80) / 10 ) * 40 + J(
        1,
        N Col( window:x ),
        Random Normal( 0, 10 )
    );
    window:loglambda = 2;
    window:g = Graph Box(
        Pen Color( "blue" );
        window:m = Spline Coef( window:x, window:y, Power( 10, window:loglambda ) );
        Marker( window:x, window:y );
        Y Function( Spline Eval( a, window:m, 0.05 ), a );
    );,
    H List Box(
        Text Box( "Lambda: " ),
        Slider Box( -2, 5, window:loglambda, window:g << reshow )
    )
)
;


```

### [Spline Smooth](#spline-smooth)

**Syntax:** yhat = Spline Smooth( x, y, lambda, <weights> )

**Description:** Returns the smoothed predicted values from a spline fit. The smoothing parameter lambda must be a positive value, where larger values of lambda result in greater stiffness of the spline. The optional weights vector specifies a weight for each value in x. A weight of zero removes the corresponding point from the spline fit.

**JMP Version Added:** Before version 14

```

Spline Smooth( 0 :: 10, Sqrt( 0 :: 10 ), 100 );


```

### [Sqrt](#sqrt)

**Syntax:** y = Sqrt( x )

**Description:** Returns the positive square root of the x argument, which can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Round( Sqrt( 2 ), 4 );


```

### [Squash](#squash)

**Syntax:** y = Squash( x )

**Description:** Returns 1 / (1 + Exp( x )), which converts a number in the domain -∞...+∞ into range 1...0. The Squash() function is useful in logistic regression.

**JMP Version Added:** Before version 14

```

Squash( 10 );


```

### [Squish](#squish)

**Syntax:** y = Logist( x )

**Description:** Returns 1 / (1 + Exp( -x )), which converts a number in the domain -∞...+∞ into range 0...1. The Logist() function is useful in logistic regression.

**JMP Version Added:** Before version 14

```

Logist( 2 );


```

### [SSQ](#ssq)

**Syntax:** y = SSQ( x1, ... )

**Description:** Returns the sum of squares of all elements

**JMP Version Added:** Before version 14

```

Eval List( {SSQ( Pi(), e() ), SSQ( [33 44 22 20 30] )} );


```

### [Starts With](#starts-with)

**Syntax:** b = Starts With( s, sub )

**Description:** Returns 1 if s starts with sub, otherwise returns 0. The s and sub arguments can be both strings or both lists. Equivalent to Left( s, Length( sub )) == sub.

**JMP Version Added:** Before version 14

```

Starts With( "http://www.jmp.com", "http:" );


```

### [Status Msg](#status-msg)

**Syntax:** Status Msg( message )

**Description:** Displays the specified message in the status bar.

**JMP Version Added:** Before version 14

```

Status Msg( "calculating..." );


```

### [Std Dev](#std-dev)

**Syntax:** y = Std Dev( x1, ... )

**Description:** Returns the standard deviation of the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Std Dev( Pi(), e() ), Std Dev( [33 44 22 20 30] )} );


```

### [Step](#step)

**Syntax:** y = Step( x, x1, y1, x2, y2, ... ) y = Step( x, [x1, x2, ...], [y1, y2, ...] )

**Description:** Returns the yi argument corresponding to the largest xi value which satisfies xi less than or equal to the x argument. Note that the xi arguments must be specified in order.

**JMP Version Added:** Before version 14

```

Step( 2.5, [1 2 3], [15, 20, 30] );


```

### [STK:ArchSpiral](#stkarchspiral)

**Syntax:** STK:ArchSpiral(t, \<a = 1>, \<n = 1>)

**Description:** Takes in a given angle t (in radians) and returns the x,y coordinate pair as a matrix for location on the Archimedean Spiral, given scaling parameter, "a" and the "n"-th root

**Example 1**

```

STK:ArchSpiral( 3, 1, 1 );


```

**Example 2**

```

For Each( {v, i}, 1 :: 30, Show( STK:ArchSpiral( v ) ) );


```

### [STK:arctan2](#stkarctan2)

**Syntax:** STK:arctan2(x,y)

**Description:** The arctangent function that takes in 2 arguments. See https://en.wikipedia.org/wiki/Atan2 for motivation and details.

**Example 1**

```

STK:arctan2( 3, 4 );


```

**Example 2**

```

STK:arctan2( 3, 4 );


```

### [STK:Cart2Polar](#stkcart2polar)

**Syntax:** STK:Cart2Polar(x,y)

**Description:** Runs both the Radius() and Theta() in one function, returning the pair in a matrix.

**Example 1**

```

STK:Cart2Polar( 3, 4 );


```

**Example 2**

```


x = [1, -1, 1, -1];
y = [1, 1, -1, -1];

For Each( {{a, b}, index}, Across( x, y ), Show( STK:Cart2Polar( a, b ) ) );


```

### [STK:deg2rad](#stkdeg2rad)

**Syntax:** STK:deg2rad(d)

**Description:** Converts a value from degrees to radians

**Example 1**

```

STK:deg2rad( 45 );


```

**Example 2**

```

STK:um2mm( 45 );


```

### [STK:DieIndex](#stkdieindex)

**Syntax:** STK:DieIndex(x,y)

**Description:** Combines the x- and y-die coordinate columns into a single text column. For use with the STK generated wafer shapefiles.

**Example 1**

```

STK:DieIndex( 3, 4 );


```

**Example 2**

```

Example;


```

### [STK:LPCVDSim](#stklpcvdsim)

**Syntax:** STK:LPCVDSim(x, y, \<time = 30>, \<temp = 600>, \<press = 20>, \<flow = 2>, \<gas1 = 1>, \<gas2 = 1>, \<r = 150>, \<tbase = 200>)

**Description:** A simulation of a hypothetical LPCVD profile. Optional parameters include Deposition Time (time = 30), Deposition Temperature (temp = 600), Total Chamber Pressure (press = 20), Gas Flow Rate (flow = 2), Reagent Gas 1 Flow (gas1 = 1), Reagent Gas 2 Flow (gas2 = 1), Wafer Radius (r = 150), Baseline Film Thickness (tbase = 200).

NOTE: This simulator is entirely empirical and for demonstration, teaching, or testing purposes only.

**Example 1**

```

STK:LPCVDSim( 0, 0 );


```

**Example 2**

```

STK:LPCVDSim( 0, 0, 100 );


```

### [STK:mm2um](#stkmm2um)

**Syntax:** STK:mm2um(x)

**Description:** Converts a value from millimeters (mm) to microns (um).

**Example 1**

```

STK:mm2um( 3 );


```

**Example 2**

```

STK:mm2um( 3 );


```

### [STK:MShape](#stkmshape)

**Syntax:** STK:MShape( m )

**Description:** Returns the shape of the matrix as a [nCols nRows] vector.

**Example 1**

```

STK:MShape( J( 13, 20 ) );


```

**Example 2**

```

STK:MShape( J( 13, 20 ) );


```

### [STK:Polar2Cart](#stkpolar2cart)

**Syntax:** STK:Polar2Cart(x,y)

**Description:** Runs both the xCart() and yCart() in one function, returning the pair in a matrix. Assumes theta is in radians.

**Example 1**

```

STK:Polar2Cart( 1, Pi() / 4 );


```

**Example 2**

```


x = [1, -1, 1, -1];
y = [1, 1, -1, -1];

For Each( {{a, b}, index}, Across( x, y ),
    p = STK:Cart2Polar( a, b );
    c = STK:Polar2Cart( p[1], p[2] );
    Show( p, c );
);


```

### [STK:ProcessSim](#stkprocesssim)

**Syntax:** STK:ProcessSim(n, \<radius = 150>, \<stat = "Mean">, \<result = "summary">)

**Description:** A simulation of a hypothetical Process based on the LPCVDSim Function. Returns a single value by default using any desired statistic JMP provides directly. A matrix of the measurement coordinates and result value are optional by providing "full" as the final argument

**Example 1**

```

STK:ProcessSim( 13 );


```

**Example 2**

```

STK:ProcessSim( 13, 150 );


```

**Example 3**

```

STK:ProcessSim( 100, 150, "Std Dev", "full" );


```

### [STK:rad2deg](#stkrad2deg)

**Syntax:** STK:rad2deg(r)

**Description:** Converts a value from radians to degrees

**Example 1**

```

STK:rad2deg( 0.79 );


```

**Example 2**

```

STK:um2mm( 0.79 );


```

### [STK:Radius](#stkradius)

**Syntax:** STK:Radius(x,y)

**Description:** Uses the Pythagorean Transform to convert X,Y data pairs to a radius.

**Example 1**

```

STK:Radius( 3, 4 );


```

**Example 2**

```

STK:Radius( 3, 4 );


```

### [STK:Theta](#stktheta)

**Syntax:** STK:Theta(x,y)

**Description:** Uses the arccosine function to return the angle of an X,Y data pair in radians.

**Example 1**

```

STK:Theta( 3, 4 );


```

**Example 2**

```

STK:Theta( 3, 4 );


```

### [STK:um2mm](#stkum2mm)

**Syntax:** STK:um2mm(x)

**Description:** Converts a value from microns to millimeters.

**Example 1**

```

STK:um2mm( 3 );


```

**Example 2**

```

STK:um2mm( 3 );


```

### [STK:xCart](#stkxcart)

**Syntax:** STK:xCart(r,t)

**Description:** Takes in a radius and angle (in radians) and returns the x-component of the cartesian coordinate pair.

**Example 1**

```

STK:xCart( 1, Pi() / 4 );


```

**Example 2**

```

STK:xCart( 1, Pi() / 4 );


```

### [STK:yCart](#stkycart)

**Syntax:** STK:yCart(r,t)

**Description:** Takes in a radius and angle (in radians) and returns the y-component of the cartesian coordinate pair

**Example 1**

```

STK:yCart( 1, Pi() / 4 );


```

**Example 2**

```

STK:yCart( 1, Pi() / 4 );


```

### [Stop](#stop)

**Syntax:** Stop()

**Description:** Immediately terminates the execution of a JSL script

**JMP Version Added:** Before version 14

```

For( i = 1, i <= 10, i++,
    If( i == 7, Stop() );
    Print( "i=" || Char( i ) );
);


```

### [Straight Line Depreciation](#straight-line-depreciation)

**Syntax:** x = Straight Line Depreciation( cost, salvage, life )

**Description:** Returns the straight-line depreciation of an asset for one period. Equivalent to the SLN function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Straight Line Depreciation( 1000, 100, 3 );


```

### [String Col Box](#string-col-box)

**Syntax:** y = String Col Box( title, {strings} )

**Description:** Returns a display box to show the strings specified by the strings argument, which is a list of character strings.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [String Col Edit Box](#string-col-edit-box)

**Syntax:** y = String Col Edit Box( title, {strings} )

**Description:** Returns a display box to show the strings specified by the strings argument, which is a list of character strings.

**JMP Version Added:** Before version 14

```

a = b = c = "";
New Window( "Example",
    Modal,
    <<Return Result,
    Outline Box( "Table", Table Box( seb = String Col Edit Box( "names", {a, b, c} ) ) )
);


```

### [Students t Density](#students-t-density)

**Syntax:** p = t Density( q, df, \<nonCentrality=0> )

**Description:** Returns the density function of Student's t.

**JMP Version Added:** Before version 14

```

tdedf = 1;
New Window( "Example: Students t Density",
    tdegr = Graph Box(
        Y Scale( -.05, 0.45 ),
        X Scale( -8, 8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Density( tdeq, Exp( tdedf ) ), tdeq );
        H Line( 2, 3, 0.3 );
        Pen Color( "blue" );
        Y Function( Normal Density( tdeq ), tdeq );
        H Line( 2, 3, 0.25 );
        Text( {2, 0.35}, "df=", Round( Exp( tdedf ), 2 ) );
        Text( {3.5, 0.3}, "Student t" );
        Text( {3.5, 0.25}, "Normal" );
    ),
    H List Box(
        Text Box( "df " ),
        Slider Box( Log( 0.1 ), Log( 1000 ), tdedf, tdegr << reshow )
    )
);


```

### [Students t Distribution](#students-t-distribution)

**Syntax:** p = t Distribution( q, df, \<nonCentrality=0> )

**Description:** Returns the probability that a Student's t distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

tdidf = 1;
New Window( "Example: Students t Distribution",
    tdigr = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( tdiq, tdidf ), tdiq );
        Text( {-4.5, 0.9}, "df=", Round( tdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tdidf, tdigr << reshow ) )
);


```

### [Students t Quantile](#students-t-quantile)

**Syntax:** q = t Quantile( p, df, \<nonCentrality=0> )

**Description:** Returns the quantile from a Student's t distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

extqdf = 1;
extqqq = 0.5;
New Window( "Example: Students t Quantile",
    extqgr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( q, Round( extqdf ) ), q );
        Pen Color( "blue" );
        V Line( t Quantile( extqqq, Round( extqdf ) ), 0, 1 );
        Text( {-4.5, 0.9}, "df=", Round( extqdf, 2 ), " quantile=", Round( extqqq, 2 ) );
    ),
    H List Box( Slider Box( 1, 30, extqdf, extqgr << reshow ), Text Box( " df" ) ),
    H List Box( Slider Box( 0.01, 0.99, extqqq, extqgr << reshow ), Text Box( " quantile" ) ), 

);


```

### [Subscribe to Data Table List](#subscribe-to-data-table-list)

**Syntax:** aSub = Subscribe to Data Table List( \<subscriber name | "">, \<OnOpen(fn) | OnClose(fn) | On Rename(fn)>)

**Description:** Subscribe to the data table list to be notified when a new data table has been added or closed.

**JMP Version Added:** Before version 14

**Example 1**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "closing" );
    Print( dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnClose( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );


```

**Example 2**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab, b},
    dtname = (dtab << getname());
    Print( "renaming ", b, " to ", dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnRename( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
dt << setname( "xxx" );


```

### [Subscript](#subscript)

**Syntax:** y = x[i]; y = m[row, col]; y = Subscript( x, i )

**Description:** Returns the ith value of a subscriptable object, which can be a column of a data table, a matrix, a list, or a report display element.

**JMP Version Added:** Before version 14

```

{11, 12, 13}[2];


```

### [Substitute](#substitute)

**Syntax:** y = Substitute( x, patternExpr1, replacementExpr1, ... ) y = Substitute( x, patternString1, replacementString1, ..., < \<<IGNORECASE > )

**Description:** Returns a copy of string, list or expression x, replacing instances of each pattern expression with the corresponding replacement expression. The optional \<<IGNORECASE argument enables case-insensitive matching if x is a string.

**JMP Version Added:** Before version 14

**Example 1**

```

Substitute( Expr( a + Sqrt( a ) ), Expr( a ), Expr( b ) );


```

**Example 2**

```

Substitute( "All things considered", "All", "Some" );


```

**Example 3**

```

lst = {"a", "b", "c"};
Substitute( lst, "a", "A" );


```

**Example 4**

```

Substitute( "All things considered", {"things", "All"}, {"ideas", "Some"} );


```

**Example 5**

```

Substitute( "Apple,orange,banana-grape",
    Items( Get Punctuation Characters() || "-'", "" ), " "
);


```

**Example 6**

```

Substitute( "Apple,APPLE,apple", "apple", "orange", <<IGNORECASE );


```

### [Substitute Into](#substitute-into)

**Syntax:** Substitute Into( x, patternExpr1, replacementExpr1, ... ) Substitute Into( x, patternString1, replacementString1, ..., < \<<IGNORECASE > )

**Description:** Modifies string, list or expression x, replacing instances of each pattern expression with the corresponding replacement expression. Note that the x argument must be a variable. The optional \<<IGNORECASE argument enables case-insensitive matching if x is a string.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = Expr( a + Sqrt( a ) );
Substitute Into( ex, Expr( a ), Expr( b ) );
Name Expr( ex );


```

**Example 2**

```

ex = "All things considered";
Substitute Into( ex, "All", "Some" );
Show( ex );


```

**Example 3**

```

lst = {"a", "b", "c"};
Substitute Into( lst, "a", "A" );
Show( lst );


```

**Example 4**

```

s = "Apple,APPLE,apple";
Substitute Into( s, "apple", "orange", <<IGNORECASE );
Show( s );


```

### [Substr](#substr)

**Syntax:** sub = Substr( s, start, <count> )

**Description:** Returns the part of string s composed of count characters starting at position start. A negative or absent count means the rest of the string. A negative start means starting start characters from the end. The Substr() function can also be applied to lists.

**JMP Version Added:** Before version 14

```

Eval List( {Substr( "undergo", 4 ), Substr( {10, 11, 12, 13, 14}, 2, 3 )} );


```

### [Subtract](#subtract)

**Syntax:** y = x0 - x1; y = Subtract( x0, x1, ... )

**Description:** Subtracts all subsequent arguments from the first argument. Arguments can be numbers, matrices, or lists of numbers.

**JMP Version Added:** Before version 14

```

6 - 2 - 1;


```

### [Subtract To](#subtract-to)

**Syntax:** y -= x; Subtract To( y, x )

**Description:** Subtracts a value from a variable or from a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex -= 2;
ex;


```

### [SuInv](#suinv)

**Syntax:** x = SuInv( z, gamma, delta, theta, sigma )

**Description:** Transforms a standard normal variable to an unbounded Johnson variable.

**JMP Version Added:** Before version 14

```

SuInv( 1.96, 1.5, 2, 1, 2 );


```

### [Sum](#sum)

**Syntax:** y = Sum( x1, ... )

**Description:** Returns the sum of the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Sum( Pi(), e() ), Sum( [33 44 22 20 30] )} );


```

### [Sum Of Years Digits Depreciation](#sum-of-years-digits-depreciation)

**Syntax:** x = Sum Of Years Digits Depreciation( cost, salvage, life, per )

**Description:** Returns the sum-of-years' digits depreciation of an asset for a specified period. Equivalent to the SYD function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Sum Of Years Digits Depreciation( 1000, 100, 3, 2 );


```

### [Summarize](#summarize)

**Syntax:** Summarize( <dt>, nameBy=By( colBy ), name1=statName1( col1 ), ... )

**Description:** Calculates various summary statistics across a By column. The statistic names are Count, Sum, Mean, Max or Maximum, Min or Minimum, StdDev, Corr, Quantile, First. The statistics can be calculated only for numeric columns. The results are stored as matrices in variables with the specified names.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( exg = By( :sex ), exm = Mean( :height ) );
Eval List( {exg, Round( exm, 1 )} );


```

### [Summarize YByX](#summarize-ybyx)

**Syntax:** Summarize YByX( X(x columns),Y(y columns), Group(grouping columns), Freq(freq column), Weight(Weight column))

**Description:** Calculates all Fit Y by X combinations

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize YByX( X( :age, :height ), Y( :sex, :weight ) );


```

### [Summation](#summation)

**Syntax:** y = Summation( assignExpr, limit, bodyExpr )

**Description:** Returns the sum of evaluations of the bodyExpr arguments, each time incrementing the variable from the assignExpr argument until it is greater than or equal to the limit argument.

**JMP Version Added:** Before version 14

```

Summation( i = 0, 10, 1 / Factorial( i ) );


```

### [Suppress Formula Eval](#suppress-formula-eval)

**Syntax:** Suppress Formula Eval( \<suppress=1> )

**Description:** Suppresses the evaluation of formulas in all data tables if the argument if nonzero.

**JMP Version Added:** Before version 14

```

Suppress Formula Eval( 1 );


```

### [SuTrans](#sutrans)

**Syntax:** z = SuTrans( x, gamma, delta, theta, sigma )

**Description:** Transforms an unbounded Johnson variable to a standard normal variable.

**JMP Version Added:** Before version 14

```

Round( SuTrans( 1.46, 1.5, 2, 1, 2 ), 2 );


```

### [SVD](#svd)

**Syntax:** {U, M, V} = SVD( X )

**Description:** Computes the singular value decomposition of matrix X by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** Before version 14

```

SVD( [11 22, 33 44] );


```

### [SVD LAPACK](#svd-lapack)

**Syntax:** {U, M, V} = SVD LAPACK( X )

**Description:** Computes the singular value decomposition of matrix X by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** 17

```

SVD LAPACK( [11 22, 33 44] );


```

### [Sweep](#sweep)

**Syntax:** y = Sweep( A, <indices> )

**Description:** Returns the sweep of the matrix A on diagonal pivots indicated by indices. This is a way of inverting a matrix one pivot at a time.

**JMP Version Added:** Before version 14

```

exMat = [5 4 1 1, 4 5 1 1, 1 1 4 2, 1 1 2 4];
exMatswp = Sweep( exMat, [1, 2, 3, 4] );
exMatinv = Inverse( exMat );
Show( exMatswp );
Show( exMatinv );


```

### [Sym Matrix Mult BLAS](#sym-matrix-mult-blas)

**Syntax:** y = Sym Matrix Mult BLAS( A, B, ... )

**Description:** Performs matrix multiplication, where A is a symmetric matrix. The matrix arguments must be conformable: NCol(A)==NRow(B).

**JMP Version Added:** 17

```

exMatA = [1 2 3, -2 0 -1, 0 1 1];
exMatA = exMatA` * exMatA;
exMatB = [1 2, 1 2, 1 2];
exMatM2 = Sym Matrix Mult BLAS( exMatA, exMatB );


```

### [t Density](#t-density)

**Syntax:** p = t Density( q, df, \<nonCentrality=0> )

**Description:** Returns the density function of Student's t.

**JMP Version Added:** Before version 14

```

tdedf = 1;
New Window( "Example: Students t Density",
    tdegr = Graph Box(
        Y Scale( -.05, 0.45 ),
        X Scale( -8, 8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Density( tdeq, Exp( tdedf ) ), tdeq );
        H Line( 2, 3, 0.3 );
        Pen Color( "blue" );
        Y Function( Normal Density( tdeq ), tdeq );
        H Line( 2, 3, 0.25 );
        Text( {2, 0.35}, "df=", Round( Exp( tdedf ), 2 ) );
        Text( {3.5, 0.3}, "Student t" );
        Text( {3.5, 0.25}, "Normal" );
    ),
    H List Box(
        Text Box( "df " ),
        Slider Box( Log( 0.1 ), Log( 1000 ), tdedf, tdegr << reshow )
    )
);


```

### [t Distribution](#t-distribution)

**Syntax:** p = t Distribution( q, df, \<nonCentrality=0> )

**Description:** Returns the probability that a Student's t distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

tdidf = 1;
New Window( "Example: Students t Distribution",
    tdigr = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( tdiq, tdidf ), tdiq );
        Text( {-4.5, 0.9}, "df=", Round( tdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tdidf, tdigr << reshow ) )
);


```

### [t Log CDistribution](#t-log-cdistribution)

**Syntax:** y = t Log CDistribution( x, df, <nc> )

**Description:** Returns the log of 1 - t distribution.

**JMP Version Added:** Before version 14

```

tlcdidf = 1;
New Window( "Example: Students t Log CDistribution",
    tlcdigr = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Log CDistribution( tlcdiq, tlcdidf ), tlcdiq );
        Text( {-4.5, -0.9}, "df=", Round( tlcdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tlcdidf, tlcdigr << reshow ) )
);


```

### [t Log Density](#t-log-density)

**Syntax:** y = t Log Density( x, df, <nc> )

**Description:** Returns the log of the t probability density.

**JMP Version Added:** Before version 14

```

tldedf = 1;
New Window( "Example: Students t Log Density",
    tldegr = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Log Density( tldeq, tldedf ), tldeq );
        Text( {2.5, -0.35}, "df=", Round( tldedf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, tldedf, tldegr << reshow ) )
);


```

### [t Log Distribution](#t-log-distribution)

**Syntax:** y = t Log Distribution( x, df, <nc> )

**Description:** Returns the log of the t distribution.

**JMP Version Added:** Before version 14

```

tldidf = 1;
New Window( "Example: Students t Log Distribution",
    tldigr = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Log Distribution( tldiq, tldidf ), tldiq );
        Text( {-4.5, -0.9}, "df=", Round( tldidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tldidf, tldigr << reshow ) )
);


```

### [t Noncentrality](#t-noncentrality)

**Syntax:** nc = t Noncentrality( x, df, prob )

**Description:** Solves for the noncentrality parameter of a Student's t distribution such that prob = t Distribution( x, df, nc ).

**JMP Version Added:** Before version 14

```

New Window( "Example: t Noncentrality",
    tncgr = Graph Box(
        Y Scale( 0.01, 0.99 ),
        X Scale( 0.01, 0.99 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( 3, 2, t Noncentrality( 3, 2, q ) ), q );
    )
);
t Distribution( 3, 2, t Noncentrality( 3, 2, 0.5 ) );


```

### [t Quantile](#t-quantile)

**Syntax:** q = t Quantile( p, df, \<nonCentrality=0> )

**Description:** Returns the quantile from a Student's t distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

extqdf = 1;
extqqq = 0.5;
New Window( "Example: Students t Quantile",
    extqgr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( q, Round( extqdf ) ), q );
        Pen Color( "blue" );
        V Line( t Quantile( extqqq, Round( extqdf ) ), 0, 1 );
        Text( {-4.5, 0.9}, "df=", Round( extqdf, 2 ), " quantile=", Round( extqqq, 2 ) );
    ),
    H List Box( Slider Box( 1, 30, extqdf, extqgr << reshow ), Text Box( " df" ) ),
    H List Box( Slider Box( 0.01, 0.99, extqqq, extqgr << reshow ), Text Box( " quantile" ) ), 

);


```

### [Tab Box](#tab-box)

**Syntax:** y = Tab Box( Tab Page Box(...), TabPageBox(...), ... )

**Description:** Creates a tabbed-page panel in a display box window.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        "alpha",
        Panel Box( "panel", Text Box( "text" ) ),
        "beta",
        Popup Box( {"x", ex = 1, "y", ex = 2} )
    )
);


```

### [Tab Page Box](#tab-page-box)

**Syntax:** y = Tab Page Box( \<Title("string")>, \<Tip(0|1)>, \<Closeable(0|1)>, \<Icon("string")>, \<Moveable(0|1)>, contents)

**Description:** Returns a display box that that can be used in a Tab Box or as a stand-alone container with title. Recognized options include Title(string) to specify a title, Tip(string) to specify a tooltip, Closeable(0|1) to specify whether the page can be closed, Icon(string) to specify the icon, and Moveable(0|1) to specify whether the page can be moved.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);


```

### [Table Box](#table-box)

**Syntax:** y = Table Box( displayBox, ... )

**Description:** Returns a display box that composes a table of the String Col Box, Number Col Box, and Plot Col Box column display boxes provided by the arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [Tan](#tan)

**Syntax:** y = Tangent( x )

**Description:** Returns the trigonometric tangent of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Tangent( Pi() / 4 );


```

### [Tangent](#tangent)

**Syntax:** y = Tangent( x )

**Description:** Returns the trigonometric tangent of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Tangent( Pi() / 4 );


```

### [TanH](#tanh)

**Syntax:** y = TanH( x )

**Description:** Returns the hyperbolic tangent of x.

**JMP Version Added:** Before version 14

```

TanH( 1 );


```

### [Text](#text)

**Syntax:** Text( <properties>, {x, y}, text, ... ) Text( {left, top, right, bottom}, text )

**Description:** Moves to the {x, y} position and draws text specified by the text argument. Named property arguments include Center Justified, Right Justified, Erased, Boxed, Counterclockwise, Clockwise. The position arguments, named arguments, and strings can be mixed in any order. You can also use four x, y coordinates to describe a box within which to draw the text. In that case, properties are not used.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    Graph Box(
        Text Color( "red" );
        Text( Center Justified, {50, 20}, "centered" );
    )
);


```

**Example 2**

```

New Window( "Example",
    Graph Box(
        Text Color( "blue" );
        Text( {20, 80, 40, 70}, "some text" );
    )
);


```

### [Text Box](#text-box)

**Syntax:** y = Text Box( text, \<<Justify Text( strPos ), \<<Set Wrap( width ) )

**Description:** Constructs a display box that contains the text in the string argument text. The optional arguments are available to control the text justification or set the text wrap width. The argument for Justify Text should be a string containing left, right, or center.

**JMP Version Added:** Before version 14

```

New Window( "Justification Example",
    Outline Box( "text",
        V List Box(
            Text Box( "Text implicitly justified over multiple lines:", <<Set Wrap( 100 ) ),
            Text Box( " " ),
            Text Box(
                "Text left justified over multiple lines:",
                <<Justify Text( "left" ),
                <<Set Wrap( 100 )
            ),
            Text Box( " " ),
            Text Box(
                "Text center justified over multiple lines:",
                <<Justify Text( "center" ),
                <<Set Wrap( 100 )
            ),
            Text Box( " " ),
            Text Box(
                "Text right justified over multiple lines:",
                <<Justify Text( "right" ),
                <<Set Wrap( 100 )
            )
        )
    )
);


```

### [Text Color](#text-color)

**Syntax:** Text Color( \<name|index|rgbList> )

**Description:** Sets the color for drawing text.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Text Color( "red" );
        Text( {50, 20}, "label" );
    )
);


```

### [Text Edit Box](#text-edit-box)

**Syntax:** y = Text Edit Box( text, \<<Password Style( bool ), \<<Set Script( script ), \<<Set Width( value ) )

**Description:** Constructs an editable box that contains the quoted string text, returning the display box reference. The optional arguments are available to control the display of the text, to attach a script to the text box, and to set the width in pixels of the text box. Specifying Set Width(-1) forces a resize to content. Note that a script can be attached to the text edit box either by adding the script as an optional argument or by sending the Set Script message.

**JMP Version Added:** Before version 14

```

New Window( "Example: Text Edit Box",
    Outline Box( "Picker Example",
        H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
    ),
    Outline Box( "Text Edit Box with password style Example",
        H List Box(
            Text Box( "Enter password:    " ),
            exq = Text Edit Box( "", Password Style( 1 ), Set Script( Print( "changed!" ) ) )
        ),
        Button Box( "print to log", Set Script( Print( exq << Get Text() ) ) ),
        Button Box( "hide password", Set Script( exq << Password Style( 1 ) ) ),
        Button Box( "show password", Set Script( exq << Password Style( 0 ) ) )
    )
); // "look in the log window"


```

### [Text Font](#text-font)

**Syntax:** {nm, sz, st, an} = Text Font(fontName, <size>, \<"bold italic underline strikeout">, <angle>

**Description:** Sets the font for subsequent Text() drawing. Use without any arguments to get the current font settings. Angle is in degrees clockwise.

**JMP Version Added:** 15

```

New Window( "Degrees",
    Graph Box(
        FrameSize( 400, 400 ),
        X Scale( -100, 100 ),
        Y Scale( -100, 100 ),
        Local( {fname, fsize, fstyle, fangle, i, a},
            {fname, fsize, fstyle, fangle} = Text Font();
            Text Font( If( Host is( "Mac" ), "Helvetica", "Arial" ), 30, "Italic Bold" );
            Text( Center Justified, {0, -10}, "JMP" );
            For( i = 0, i < 360, i += 15,
                Text Font( {fname, 10, "plain", -i + 90} );
                a = i * Pi() / 180;
                Text( Center Justified, {80 * Cos( a ), 80 * Sin( a )}, Char( i ) );
                Line( {70 * Cos( a ), 70 * Sin( a )}, {76 * Cos( a ), 76 * Sin( a )} );
            );
        )
    )
);


```

### [Text Score](#text-score)

**Syntax:** score vector = Text Score( text column, text-to-number, <weighting>, \<{<center>, <scale>, scoring matrix}>);

**Description:** Used to create scoring formulas in Text Explorer. The text-to-number argument is an associative array mapping lowercase words to numbers. The weighting argument is either "Binary", "Ternary", "Count", "LogCount", "LCA" or an array of inverse document frequency weights for TFLogIDF. The scoring matrix must have the same number of columns as words in the associative array, or one more if LCA. The output is a vector of scores. If no scoring matrix is specified, it returns a vector of count scores. If no weighting is specified, it uses Count. This function does not support the Stem for Combining option.

**JMP Version Added:** Before version 14

```

score = Text Score(
    "over the lazy dogs back",
    ["lazy" => 1, "dogs" => 2],
    "Count",
    [1 0, 0 1]
);
Show( score );


```

### [Text Seg](#text-seg)

**Syntax:** seg = Text Seg("text")

**JMP Version Added:** 17

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( ts1 = Text Seg( "default location fixed bottom left" ) );


```

### [Text Size](#text-size)

**Syntax:** Text Size( n )

**Description:** Sets the font size that for text drawing.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Text Size( 20 );
        Text( {50, 20}, "label" );
    )
);


```

### [This Project](#this-project)

**Syntax:** project = this project()

**Description:** From within a project, returns the corresponding project object. Outside of a project, returns nothing.

**JMP Version Added:** 14

```

If(
    Is Empty( This Project() ), Print( "Project: (none)" ),
    Print( "Project: " || (This Project() << Get Window Title()) ),
);


```

### [Throw](#throw)

**Syntax:** Throw(<message>, <Boolean>)

**Description:** Diverts execution to the enclosing Try(). Otherwise, script execution is stopped. If message begins with an exclamation point, the error will be fatal and cannot be caught by Try(). The second argument is an optional boolean for including a traceback.

**JMP Version Added:** Before version 14

**Fatal Throw**

```


Try( Throw( "!This is a fatal error" ), Print( "CATCH message not reached" ) );
Print( "AFTER TRY message not reached" );


```

**Traceback**

```

Throw( "A line number is included in this error", 1 );


```

**Try-Catch**

```

Try( If( Random Uniform() < 0.5, 1, Throw() ), "thrown" );


```

### [Tick Seconds](#tick-seconds)

**Syntax:** t = Tick Seconds()

**Description:** Returns a time value in seconds, usually accurate to at least 1/60 of a second (a "tick"), depending on the computer. Only useful relative to another Tick Seconds() value.

**JMP Version Added:** Before version 14

```

t1 = Tick Seconds();
Open( "$SAMPLE_DATA/Big Class.jmp" );
t2 = Tick Seconds();
Round( t2 - t1, 3 );


```

### [Time Of Day](#time-of-day)

**Syntax:** sec = Time Of Day( datetime )

**Description:** Returns the time part of a date-time value, including any fractional seconds.

**JMP Version Added:** Before version 14

```

Format( Time Of Day( Today() ), "h:m:s" );


```

### [Titlecase](#titlecase)

**Syntax:** st = Titlecase( s )

**Description:** Converts to title case

**JMP Version Added:** Before version 14

```

Titlecase( "The dog crossed the road" );


```

### [To Color Space](#to-color-space)

**Syntax:** color = To Color Space( color, colorSpace )

**Description:** Translates a color into another color space. Out of gamut colors are mapped to fit when converting to smaller color spaces.

**JMP Version Added:** 18

**Example 1**

```

To Color Space( "red", "LMS" );


```

**Example 2**

```

To Color Space( {0.871, 0.032, 0.061, "lRGB"}, "HLS" );


```

**Example 3**

```

To Color Space( {0.941, 0.196, 0.274, "lRGB", 0.871, 0.032, 0.061}, "HLS" );


```

### [Today](#today)

**Syntax:** dt = Today()

**Description:** Returns the date-time value of the current moment.

**JMP Version Added:** Before version 14

```

As Date( Today() );


```

### [Trace](#trace)

**Syntax:** y = Trace( x )

**Description:** Returns the sum of the diagonal elements of a square matrix.

**JMP Version Added:** Before version 14

```

Trace( [11 22, 33 44] );


```

### [Transform Each](#transform-each)

**Syntax:** list = Transform Each({<value>, <index>} | {<element>, \<index | {row, col}>} | {\<key | {key, value}>, <index>} | {\<values | {value1, ..., valueN}>, <index>}, list | matrix | associative array | expression | Across( container1, ..., <containerN>, \<Count( "Longest" | "Shortest" | "Enforce Equal" | n )> ), \<Output( "List" | "Matrix" | "Associative Array" | "Expression", <expr head name> )>, <locals list>, body)

**Description:** Does everything the For Each function does, but also returns a container with the result at each iteration. By default, returns a container matching the type of the input container, but can be changed using the Output argument. For List or Expression output, Empty() will be used when there is no result. For Matrix output, a numeric missing value is used when there is no result, or when the result is non-numeric. For Associative Array output, the key will not exist when there is no result. When Continue() is used, it is equivalent to returning no value for that iteration.

**JMP Version Added:** 16

**Associative Array**

```

values = Transform Each( {{key, value}}, ["A" => 8, "B" => 6, "C" => 10], value + 1 );
Show( values );


```

**Expression 1**

```

ex = Transform Each( {value}, Expr( MyExpr( 10, 20, 30 ) ), value + 1 );
Show( ex );


```

**Expression 2**

```

// Find Functions defined in a script
parsedScript = Include( "$SAMPLE_SCRIPTS/BayesPlotForFactors.jsl", <<ParseOnly );
functionNames = Transform Each( {statement}, Name Expr( parsedScript ), Output( "List" ),
    {lhs, rhs},
    If( Head( statement ) == Expr( Assign() ),
        rhs = Arg( statement, 2 );
        If( !Is Empty( rhs ) & Contains( {Function()}, Head( rhs ) ),
            Head Name( Arg( statement, 1 ) ),
            Empty()
        );
    ,
        Empty()
    )
);
functionNames = Filter Each( {f}, functionNames, !Is Empty( f ) );
Show( functionNames );


```

**List**

```

values = Transform Each( {value}, {10, 20, 30}, value + 5 );
Show( values );


```

**Matrix**

```

values = Transform Each( {element}, 10 :: 15, element + 5 );
Show( values );


```

**Output**

```


Write( "\!N===List===" );
lst = Transform Each( {value}, [10, 20, 30], Output( "List" ), value + 1 );
Show( lst );

Write( "\!N===Matrix===" );
mat = Transform Each( {value}, {10, 20, 30}, Output( "Matrix" ), value + 1 );
Show( mat );

Write( "\!N===Associative Array===" );
aa = Transform Each( {value}, {10, 20, 30}, Output( "Associative Array" ), value + 1 );
Show( aa );

Write( "\!N===Expression===" );
ex = Transform Each( {value}, {10, 20, 30}, Output( "Expression", "My Values" ), value + 1 );
Show( ex );


```

### [Transparency](#transparency)

**Syntax:** Transparency( <alpha> )

**Description:** Sets the transparency used in the drawing commands. Alpha ranges between 0 (clear) and 1 (opaque, the default). Some operating systems do not support this.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 500, 500 ),
        X Scale( -3, 3 ),
        Y Scale( -3, 3 ),
        Transparency( .1 );
        Fill Color( RGB Color( 1/*red*/, 0/*green*/, 0/*blue*/ ) );
        For( i = 0, i < 10000, i++,
            Circle( {Random Normal(), Random Normal()}, 0.05, "FILL" )
        );
    )
);


```

### [Transpose](#transpose)

**Syntax:** y = Transpose( matrix ); y = matrix\`

**Description:** Transposes the matrix argument by interchanging the rows and columns.

**JMP Version Added:** Before version 14

```

Show( Transpose( [11 22, 33 44] ), [11 22, 33 44]` );


```

### [Tree Box](#tree-box)

**Syntax:** tree = Tree Box( \<{rootnodes}>, \<Size( x, y )>, \<Multiselect( 0|1 )> )

**Description:** Constructs a display box to show hierarchical information.

**JMP Version Added:** Before version 14

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );


```

### [Tree Node](#tree-node)

**Syntax:** node = Tree Node( <label> )

**Description:** Constructs a tree node intended for display within a Tree Box.

**JMP Version Added:** Before version 14

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Nodes", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );


```

### [Triangulation](#triangulation)

**Syntax:** triangulation = Triangulation( X(Column1, Column2), < Y(Column) > )

**Description:** Returns an object containing the Delaunay triangulation of the given point set. The optional Y will be averaged for duplicate points, and all points in the output will be unique.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );


```

**Example 2**

```

tri = Triangulation( X( [0 0 1 1], [0 1 0 1] ), Y( [0 1 2 3] ) );


```

### [Trigamma](#trigamma)

**Syntax:** y = Trigamma( x )

**Description:** Returns the trigamma function evaluated at x, where the trigamma function is the derivative of the digamma function.

**JMP Version Added:** Before version 14

```

Trigamma( 5 );


```

### [Trim](#trim)

**Syntax:** sub = Trim( s, \<left|right|both> )

**Description:** Returns a copy of string s with any leading or trailing whitespace characters removed. The second argument specifies either the leading or trailing whitespace characters. If you do not specify the second argument, whitespace characters are removed from both ends.

**JMP Version Added:** Before version 14

```

Trim( " title   ", both );


```

### [Trim Whitespace](#trim-whitespace)

**Syntax:** sub = Trim Whitespace( s, \<left|right|both> )

**Description:** Returns a copy of string s with any leading or trailing whitespace characters removed. The second argument specifies either the leading or trailing whitespace characters. If you do not specify the second argument, whitespace characters are removed from both ends.

**JMP Version Added:** Before version 14

```

Trim Whitespace( "  The  dog    crossed    the  road  " );


```

### [TripleS Import](#triples-import)

**Syntax:** TripleSImport( <path to xml file> )

**Description:** Opens Triple-S files. The Triple-S format comprises an xml or sss file and either a csv file or a dat/asc file. Both files must have the same name with the appropriate extension and must be in the same directory. Specify the xml or sss filepath to import the data.

**JMP Version Added:** Before version 14

```

TripleS Import(); //To get a file dialog to select the XML file
TripleS Import( "c:/MyFile.xml" ); //To open the Triple-S MyFile


```

### [Try](#try)

**Syntax:** y = Try( expr, <catchExpr> )

**Description:** Evaluates and returns the expr argument, unless the evaluation causes a Throw() or internal exception. In that case, the evaluation of catchExpr is returned. If you use exception_msg as the catchExpr, a list containing more information about the error is returned.

**JMP Version Added:** Before version 14

**Example 1**

```

Try( Sqrt( "s" ), "invalid" );


```

**Example 2**

```

Try( Sqrt( "s" ), exception_msg );


```

### [Tukey HSD P value](#tukey-hsd-p-value)

**Syntax:** p = Tukey HSD P value( q, nGroups, dfe )

**Description:** Returns the p-value from Tukey's HSD multiple comparisons test, where q is the test statistic, nGroups is the number of groups in the study, and dfe is the error degrees of freedom (based on the total study sample).

Note that q is Tukey's adjusted critical value, which is the quantile of Tukey's studentized range distribution divided by the sqrt(2).

**JMP Version Added:** Before version 14

```

Tukey HSD P value( 3.73, 6, 34 );


```

### [Tukey HSD Quantile](#tukey-hsd-quantile)

**Syntax:** q = Tukey HSD Quantile( 1-alpha, nGroups, dfe )

**Description:** Returns the quantile needed in Tukey's HSD multiple comparisons test, where 1-alpha is the confidence level, nGroups is the number of groups in the study, and dfe is the error degrees of freedom (based on the total study sample).

Note that q is Tukey's adjusted critical value, which is the quantile of Tukey's studentized range distribution divided by the sqrt(2).

**JMP Version Added:** Before version 14

```

alpha = 0.05;
dfe = 5;
Tukey HSD Quantile( 1 - alpha, 20, dfe );
New Window( "Example: Tukey HSD Quantile",
    tdigr = Graph Box(
        Y Scale( 2, 8 ),
        X Scale( 2.5, 15.5 ),
        YName( "Tukey HSD Quantile" ),
        XName( "Groups" ),
        Pen Color( "red" );
        For( i = 3, i <= 15, i++,
            V Line( i, 0, Tukey HSD Quantile( 1 - alpha, i, dfe ) )
        );
        Text( {3, 7}, "dfe=", Round( dfe, 2 ) );
    ),
    H List Box( Text Box( "dfe" ), Slider Box( 3, 10, dfe, tdigr << reshow ) )
);


```

### [Type](#type)

**Syntax:** y = Type( x )

**Description:** Returns a string naming the type of the value of the argument x.

**JMP Version Added:** Before version 14

```

Type( [1 2 3] );


```

### [Unlineup Box](#unlineup-box)

**Syntax:** y = UnLineup Box(displayBoxArgs, ... )

**Description:** Returns a display box that temporarily suspends the column layout of a Lineup Box. The child of the Unlineup Box will be stretched to span all columns of the Lineup Box.

**JMP Version Added:** 16

```

New Window( "unlineup",
    Lineup Box( N Col( 2 ),
        Unlineup Box( Text Box( "First Section", <<Justify Text( "Center" ) ) ),
        Button Box( "First Section 1" ),
        Button Box( "First Section 2" ),
        Unlineup Box( Text Box( "Second Section", <<Justify Text( "Center" ) ) ),
        Button Box( "Second Section 1" ),
        Button Box( "Second Section 2" )
    )
);


```

### [Unlock Globals](#unlock-globals)

**Syntax:** Unlock Globals( name, ... )

**Description:** Unlocks specified global names, allowing them to be modified and to be cleared by the Clear Globals function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Unlock Symbols](#unlock-symbols)

**Syntax:** Unlock Symbols( name, ... )

**Description:** Unlocks specified global names, allowing them to be modified and to be cleared by the Clear Symbols function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Unregister Addin](#unregister-addin)

**Syntax:** Unregister Addin( uniqueId)

**Description:** Unregister an add-in

**JMP Version Added:** Before version 14

```

Unregister Addin( "com.mycompany.myaddin" );


```

### [Unsubscribe to Data Table List](#unsubscribe-to-data-table-list)

**Syntax:** aSub = Unsubscribe to Data Table List(<subscriber name>, \<"OnOpen" | "OnClose" | "OnRename" | "ALL">)

**Description:** Remove a subscription to the data table list that had been added thru the command "subscribe to data table list".

**JMP Version Added:** Before version 14

**Example 1**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "closing" );
    Print( dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnClose( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );
Unsubscribe to Data Table List( aSub, "on close" );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );


```

**Example 2**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "closing" );
    Print( dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnClose( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );
Unsubscribe to Data Table List( aSub, "all" );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );


```

### [Update MATLAB Dependencies](#update-matlab-dependencies)

**Syntax:** Update MATLAB Dependencies(\<Patch(0|1)>)

**Description:** Updates the required MATLAB dependencies.

**JMP Version Added:** Before version 14

```


If( Check MATLAB Dependencies(),
    Update MATLAB Dependencies(),
    Print( "Dependencies are updated" )
);


```

### [Uppercase](#uppercase)

**Syntax:** su = Uppercase( s )

**Description:** Converts lowercase letters to uppercase letters in the specified string. Rules for upper and lower case are locale dependent.

**JMP Version Added:** Before version 14

```

Uppercase( "Café #23" );


```

### [V Center Box](#v-center-box)

**Syntax:** y = V Center Box( <childbox> )

**Description:** Returns a display box with the childbox display box argument centered in the vertical space defined by the maximum size of that child and all the other siblings of the center box.

**JMP Version Added:** Before version 14

```

New Window( "test",
    H List Box(
        V Center Box( Text Box( "V+V" ) ),
        V List Box(
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            H Center Box( Text Box( "H+H" ) ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" )
        )
    )
);


```

### [V Concat](#v-concat)

**Syntax:** y = a |/ b; y = V Concat( a, b, ... )

**Description:** Concatenates matrices vertically. Arguments must have same number of columns.

**JMP Version Added:** Before version 14

```

[11 22] |/ [33 44];


```

### [V Concat To](#v-concat-to)

**Syntax:** matrix1 |/= matrix2; V Concat To( matrix1, matrix2 )

**Description:** Concatenates in place, vertically. a |/= b is equivalent to a = a |/ b. This is an assignment operator.

**JMP Version Added:** Before version 14

```

exA = [1 2, 3 4];
exB = [5 6, 7 8, 9 10];
exC = [1, 1, 1, 1, 1];
exD = V Concat To( exA, exB );
exE = Concat( exD, exC );
/* exA is changed and exD is not. */
Show( exA, exB, exC, exD, exE );
/* Also see ConcatTo(), VConcat() */


```

### [V Line](#v-line)

**Syntax:** V Line( x ); V Line( x, y1, y2 )

**Description:** Draws a vertical line at x from y1 to y2 or through the entire frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 2 );
        V Line( 20, 10, 50 );
    )
);


```

### [V List Box](#v-list-box)

**Syntax:** y = V List Box( \<Align( center|right )>, displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a vertical layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for right or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker", V List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ) )
);


```

### [V Max](#v-max)

**Syntax:** b = V Max( matrix )

**Description:** Returns a row vector containing the maximum of each column in the argument.

**JMP Version Added:** Before version 14

```

V Max( [11 22, 33 44, 55 66] );


```

### [V Mean](#v-mean)

**Syntax:** m = V Mean( matrix )

**Description:** Returns a row vector containing the mean of each column in the argument.

**JMP Version Added:** Before version 14

```

V Mean( [11 22, 33 44, 55 66] );


```

### [V Median](#v-median)

**Syntax:** m = V Median( matrix )

**Description:** Returns a row vector containing the median of each column in the argument.

**JMP Version Added:** 15

```

V Median( [11 22, 33 44, 35 46, 55 66] );


```

### [V Min](#v-min)

**Syntax:** a = V Min( matrix )

**Description:** Returns a row vector containing the minimum of each column in the argument.

**JMP Version Added:** Before version 14

```

V Min( [11 22, 33 44, 55 66] );


```

### [V Quantile](#v-quantile)

**Syntax:** m = V Quantile( matrix, p )

**Description:** Returns a row vector containing the specified quantile p of each column in the argument.

**JMP Version Added:** 15

```

V Quantile( [11 22, 33 44, 35 46, 55 66], .25 );


```

### [V Robust Standardize](#v-robust-standardize)

**Syntax:** b = V Robust Standardize( X, \<center=1>, \<scale=1> )

**Description:** Returns a matrix that is centered by the median and scaled by a robust estimate of the standard deviation of matrix X. The optional Boolean arguments specify if centering and scaling are performed.

**JMP Version Added:** 17

```

V Robust Standardize( J( 150, 4, Random Normal() ), 1, 1 );


```

### [V Scroll Box](#v-scroll-box)

**Syntax:** y = V Scroll Box( \<Size( y )>, displayBox )

**Description:** Returns a display box that positions a larger child box using a vertical scroll bar.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        V Scroll Box(
            Size( 100 ),
            V List Box(
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
            ),
            <<Set Stretch( "Window", "Window" )
        )
    )
);


```

### [V Sheet Box](#v-sheet-box)

**Syntax:** y = V Sheet Box( \<<Hold( rpt ), displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a vertical layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for right or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [V Size](#v-size)

**Syntax:** v = V Size()

**Description:** Returns the vertical size of the graphics frame in pixels.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Text Size( V Size() / 4 );
        Text( {50, 20}, "label" );
    )
);


```

### [V Splitter Box](#v-splitter-box)

**Syntax:** y = V Splitter Box( \<Size(x,y)>, displayBox, ... )

**Description:** Returns a display box that arranges other display boxes vertically, with interactive control of sizes. Child sizes are specified as a proportion of the width or height of the Splitter Box. The optional Size argument is only used for the top-most Splitter Box; lower level boxes are sized like any other child box.

**JMP Version Added:** Before version 14

```

New Window( "Splitter",
    V Splitter Box(
        Size( 800, 600 ),
        H Splitter Box( graph = Graph Box(), Script Box(), <<Sizes( {0.6, 0.4} ) ),
        H Splitter Box(
            pict = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ),
            spacer = Spacer Box(),
            <<Sizes( {0.4, 0.6} )
        )
    )
);
graph[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
pict << Set Min Size( 100, 100 );
pict << Set Max Size( 500, 500 );
pict << Set Stretch( "Window", "Window" );
spacer << Set Fill( 1 );
spacer << Color( "Red" );
spacer << Set Stretch( "Window", "Window" );


```

### [V Standardize](#v-standardize)

**Syntax:** b = V Standardize( X )

**Description:** Returns a matrix that is the centered and scaled version of matrix X. Each column of b has mean 0 and standard deviation 1.

**JMP Version Added:** Before version 14

```

V Standardize( [11 22, 33 44, 55 66] );


```

### [V Std](#v-std)

**Syntax:** b = V Std( matrix )

**Description:** Returns a row vector containing the standard deviations of each column in the argument.

**JMP Version Added:** Before version 14

```

V Std( [11 22, 33 44, 55 66] );


```

### [V Sum](#v-sum)

**Syntax:** s = V Sum( matrix )

**Description:** Returns a row vector containing the sum of each column in the argument.

**JMP Version Added:** Before version 14

```

V Sum( [11 22, 33 44, 55 66] );


```

### [Varimax](#varimax)

**Syntax:** {R,T} = Varimax( F, \<norm=1> )

**Description:** Performs a varimax rotation of the specified matrix F. Returns a list that contains the rotated matrix and the orthogonal rotation matrix. By default, a normalized varimax rotation is performed. Specify norm = 0 to perform a non-normalized varimax rotation.

**JMP Version Added:** Before version 14

```

Varimax( [1.2 .4, .9 1.5] );


```

### [Vec Diag](#vec-diag)

**Syntax:** y = Vec Diag( x )

**Description:** Returns the diagonal elements of the square matrix as a vector.

**JMP Version Added:** Before version 14

```

Vec Diag( [11 22, 33 44] );


```

### [Vec Quadratic](#vec-quadratic)

**Syntax:** Vec Quadratic( S, X )

**Description:** Evaluates as Vec Diag( X * S * X\` ).

**JMP Version Added:** Before version 14

```

exS = [1 3 5, 3 2 6, 5 6 1];
exX = [1 3 5, 2 4 6];
Vec Quadratic( exS, exX );


```

### [VPTree](#vptree)

**Syntax:** tab = VPTree( [ matrix ] )

**Description:** Returns a table for efficiently looking up near neighbors. The matrix arguments are k-dimensional points. There is no built in limit on the number of dimensions or points.

**JMP Version Added:** 16

```

tab = VPTree( [1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6] );
{rows, dist} = tab << K nearest rows( 2, [1.1 .9 1] );
"2 nearest rows to [1.1 .9 1] are " || Char( rows );


```

### [Wait](#wait)

**Syntax:** Wait( <x> )

**Description:** Waits for x seconds before proceeding with execution. The default value for x is 3 seconds. If x is 0 or greater, JMP will complete any operating system events (e.g. screen drawing) as well as any pending callbacks (e.g. formula evaluation) in addition to the wait. If x is less than 0, only the screen drawing and pending OS events are confirmed to be completed before proceeding.

**JMP Version Added:** Before version 14

**Callbacks**

```

Wait( 0 ); // Wait for OS events and callbacks


```

**OS Events**

```

Wait( -1 ); // Wait for OS events


```

**Simple**

```

Wait( 1.5 );


```

### [Watch](#watch)

**Syntax:** w = Watch( all|name1, ... )

**Description:** Creates a window showing variables from Global, Here, and Local namespaces and their values.

**JMP Version Added:** Before version 14

```

x = 1;
y = 2;
z = "abc";
w = Watch( all );
Wait( 5 );
x = x * 5;
y = y / 25;
z = z || "def";
Wait( 5 );
w << close Window();


```

### [Wavelet Basis Coef](#wavelet-basis-coef)

**Syntax:** y = Wavelet Basis Coef( x, grid, coef, \<wavelet = "Haar" or "Biorthogonal" or "Coiflet" or "Daubechies" or "Symlet">, \<param = 0> )

**Description:** Returns the prediction at the points x for the specified Wavelet model. The grid parameter is a vector specifying the grid of the data for the wavelet model. The coef parameter is a vector of wavelet coefficients. The wavelet parameter is the name of the wavelet model. The optional param parameter is the wavelet model parameter (if necessary, defaults to 0).

**JMP Version Added:** 17

```

Wavelet Basis Coef( 2.5, [1, 2, 3, 4], [0, 1, 2, 3], "Haar" );


```

### [Web](#web)

**Syntax:** Web( string, <JMP Window> )

**Description:** Opens the URL or file stored in string in the default web browser. The optional second argument specifies that the HTML open in a JMP browser window.

**JMP Version Added:** Before version 14

**Event Handler**

```

//Making a clickable link show up in a formula column
New Table( "Example",
    Add Rows( 2 ),
    New Column( "URL",
        "Character",
        "Nominal",
        Formula( "https://www.jmp.com/" || :Page ),
        Set Property(
            "Event Handler",
            Event Handler(
                Click( JSL Quote( Function( {dt, col, row}, Web( dt:col[row] ) ) ) )
            )
        )
    ),
    New Column( "Page",
        "Character",
        "Nominal",
        Set Values( {"support/knowledge_base.shtml", "en_us/about.html"} )
    )
);


```

**Simple**

```

Web( "http://www.jmp.com/" );


```

### [Web Browser Box](#web-browser-box)

**Syntax:** wb = Web Browser Box( url )

**Description:** Returns a display box to view a web page, specified by the url string argument.

**JMP Version Added:** Before version 14

```

New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Window", "Window" );
wb << Set Max Size( 10000, 10000 );


```

### [Week Of Year](#week-of-year)

**Syntax:** d = Week Of Year( datetime, \<rule=1> )

**Description:** Returns the week of the year containing a date-time value using one of three rules. By default (rule 1), weeks start on Sunday with the first Sunday of the year being week 2. Week 1 will be a partial week or empty (as in 2006). For rule 2, the first Sunday is week 1, with previous days being week 0. For rule 3, the ISO week number is returned, where weeks start on Monday and week 1 is the first week of the year with four days in that year. With ISO weeks, it's possible for the first or last three days of the year to belong to the neighboring year's week number.

**JMP Version Added:** Before version 14

**Example 1**

```

Week Of Year( Today() );


```

**Example 2**

```

Show(
    Week Of Year( 01jan2012, 1 ),
    Week Of Year( 01jan2012, 2 ),
    Week Of Year( 01jan2012, 3 )
);


```

### [Weibull Density](#weibull-density)

**Syntax:** y = Weibull Density( x, shape, \<scale=1>, \<threshold=0> )

**Description:** Returns the density at x of a Weibull probability distribution with a shape parameter and optional scale parameter.

**JMP Version Added:** Before version 14

```

shape = 0.5;
New Window( "Example: Weibull Density",
    y = Graph Box(
        Y Scale( 0, 2 ),
        X Scale( 0, 1.5 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Weibull Density( x, shape ), x );
        Text( {1.1, 1.8}, " shape=", Round( shape, 2 ) );
    ),
    H List Box( Slider Box( 0, 5, shape, y << reshow ), Text Box( " shape" ) )
);


```

### [Weibull Distribution](#weibull-distribution)

**Syntax:** p = Weibull Distribution( x, shape, \<scale=1>, \<threshold=0> )

**Description:** Returns the probability that a Weibull distributed random variable (with a shape parameter and optional scale parameter) is less than x.

**JMP Version Added:** Before version 14

```

shape = 2;
New Window( "Example: Weibull Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 2 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Weibull Distribution( x, shape ), x );
        Text( {0.1, 0.9}, " shape=", Round( shape, 2 ) );
    ),
    H List Box( Slider Box( 0, 5, shape, y << reshow ), Text Box( " shape" ) )
);


```

### [Weibull Quantile](#weibull-quantile)

**Syntax:** q = Weibull Quantile( p, beta, \<alpha=1>, \<threshold=0> )

**Description:** Returns the quantile from a Weibull distribution, the value for which the probability is p that a random value would be lower, where beta and alpha are the shape and scale parameters, respectively.

**JMP Version Added:** Before version 14

```

exwqbeta = 2;
exwqqq = 0.5;
New Window( "Example: Weibull Quantile",
    exwqy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( 0, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Weibull Distribution( exwqq, exwqbeta ), exwqq );
        Pen Color( "blue" );
        V Line( Weibull Quantile( exwqqq, exwqbeta ), 0, 1 );
        Text(
            {0.1, 0.9},
            " \!U03B2=",
            Round( exwqbeta, 2 ),
            " quantile=",
            Round( exwqqq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 5, exwqbeta, exwqy << reshow ), Text Box( " \!U03B2" ) ),
    H List Box( Slider Box( 0.01, 0.99, exwqqq, exwqy << reshow ), Text Box( " quantile" ) )
);


```

### [Where](#where)

**Syntax:** Where( <dt>, clause )

**Description:** Returns indices (usually row numbers) matching the given where clause. The optional dt changes the Current Data Table during the evaluation. These clauses are often written by JMP using the Data Filter. This will often by faster than using Loc, \<<Get Rows Where or \<<Select Where. The behavior is undefined if the clause modifies the sequences or any symbols during evaluation.

**JMP Version Added:** 18

**Column Functions**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Select << Select Rows( Where( Col Max( :height, :age ) >= 68 ) );
dt << Clear Select << Select Rows( Where( :height == Col Max( :height, :age ) ) );


```

**Columns**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Get Rows Where( :sex == "M" );
Where( :sex == "M" );
Where( dt, :sex == "M" );


```

**Matrix/List**

```

xs = [10 20 30 . 50];
xs[Where( xs >= 20 )];
xs[Where( !Is Missing( xs ) )];
ys = {10, 20, "30", ., 50};
ys[Where( ys >= 20 )];


```

**Other**

```

xs = [10 20 30 . 50];
ys = [0 0 0 1 1];
Where( xs > 20 & ys );

xs = {{10}, {20}, {15}};
Where( xs[1] < 18 );


```

**Row States**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [2 4 6] ) << Exclude( 1 );
Where( Excluded() );
Where( !Excluded() );


```

### [While](#while)

**Syntax:** While( testExpr, bodyExpr )

**Description:** Evaluates the testExpr and bodyExpr expressions repeatedly as long as testExpr evaluates to a nonzero value.

**JMP Version Added:** Before version 14

```

i = 1;
s = "";
While( i < 1000,
    s ||= " " || Char( i );
    i *= 2;
);
s;


```

### [Wild](#wild)

**Syntax:** Wild()

**Description:** Denotes a wildcard position that matches any expression (only used in expression patterns).

**JMP Version Added:** Before version 14

```

extestexpr = Expr(
    For( i = 1, i <= 14, i++, Print( "YES!!!" ) );
    Show( "END" );
);
Extract Expr( extestexpr, For( i = 1, Wild(), i++, Print( "YES!!!" ) ) );


```

### [Wild List](#wild-list)

**Syntax:** Wild List()

**Description:** Denotes a series of wildcard arguments that match anything (only used in expression patterns).

**JMP Version Added:** Before version 14

```

extestexpr = Expr(
    For( i = 1, i <= 14, i++, Print( "YES!!!" ) );
    Show( "END" );
);
Extract Expr( extestexpr, For( i = 1, Wild List(), Print( "YES!!!" ) ) );


```

### [Window](#window)

**Syntax:** y = Window( \<string|int> )

**Description:** This function is deprecated and retained only for backward compatibility with existing scripts. For new scripts, use Get Window() or Get Window List().

**JMP Version Added:** Before version 14

```

Window( "Big Class" );


```

### [With Window Handler](#with-window-handler)

**Syntax:** With Window Handler( JSL Code, Handler Function )

**Description:** Runs a block of code with a function to be called each time a new window is created.

**JMP Version Added:** 17

```

With Window Handler(
    New Window( "My Window" ),
    Function( {window},
        Print( window << get window title() );
        window << close window();
    )
);


```

### [Word](#word)

**Syntax:** w = Word( n|[first last], s, <delim>, \<Unmatched(result string)>

**Description:** Returns the nth word of string s, where words are sub-strings separated by any number of any of the characters in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate word.

**JMP Version Added:** Before version 14

**Example 1**

```

Word( 3, "http://www.jmp.com", ":/." );


```

**Example 2**

```

Word( [2 -1], "This is a sentence" );


```

**Example 3**

```

Word( 4, "Apple+Banana Tree,,Pear,,Peach,,Grape", Get Punctuation Characters() );


```

**Example 4**

```

Word( 5, "a b c d", Unmatched( "None" ) );


```

**Example 5**

```

Word( 2, "abcd", "" );


```

### [Words](#words)

**Syntax:** wl = Words( \<[first last]>, s, <delim>)

**Description:** Returns a list of sub-strings separated by any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate word.

**JMP Version Added:** Before version 14

**Example 1**

```

Eval List( {Words( "http://www.jmp.com", ":/." ), Words( "hello", "" )} );


```

**Example 2**

```

Words( "Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

**Example 3**

```

Words( [1 2], "Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

### [Wrap List Box](#wrap-list-box)

**Syntax:** y = Wrap List Box( displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout, but will wrap that list when printing.

**JMP Version Added:** Before version 14

```

New Window( "WrapListBox",
    Wrap List Box(
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "1" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "2" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "3" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "4" ) )
    )
);


```

### [Write](#write)

**Syntax:** Write( x, ... )

**Description:** Displays the specified values in the log without adding quotation marks, spaces, or line breaks (as Print() does).

**JMP Version Added:** Before version 14

```

Write( "fraction = ", 355 / 113, "\!N", "pi       = ", Pi() );


```

### [X Function](#x-function)

**Syntax:** X Function( xExpr, yName, <properties> )

**Description:** Draws function xExpr in the X dimension as variable yName varies across the range of the Y axis of the graph. Additional named property arguments include Min(minimum X), Max(maximum Y), Fill(fill pattern, value to fill to), Inc(upper bound of increment).

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        X Function( 20 + 40 * Sin( a / 30 ), a );
    )
);


```

### [X Origin](#x-origin)

**Syntax:** x = X Origin()

**Description:** Returns the x value for the left edge of the graphics frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [X Range](#x-range)

**Syntax:** x = X Range()

**Description:** Returns the x distance from left to right. X Origin() + X Range() is the right edge.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [X Scale](#x-scale)

**Syntax:** X Scale( <xMin>, <xMax> )

**Description:** Sets a new scale for the graphics frame.

**JMP Version Added:** Before version 14

```

/* Default value for X Scale() is (0,100). */
New Window( "Example",
    Graph Box(
        Y Scale( -10, 90 ),
        X Scale( -10, 90 ),
        Oval(
            X Origin() + 10,
            (Y Origin() + Y Range()) - 10,
            (X Origin() + X Range()) - 10,
            Y Origin() + 10,
            1
        )
    )
);


```

### [XML Attr](#xml-attr)

**Syntax:** value = XML Attr( attr name ); aa = XML Attr()

**Description:** Extracts the string value of an XML attribute in the context of being evaluating in a Parse XML() command. If no name if given, an associative array of all attribute name/value pairs is returned.

**JMP Version Added:** Before version 14

```

ex =
"<table name='fromxml'><col name='x'>[1 2 3]</col><col name='y'>[11 22 33]</col></table>";
Parse XML( ex,
    On Element( "table", Start Tag( New Table( XML Attr( "name" ) ) ) ),
    On Element(
        "col",
        End Tag( New Column( XML Attr( "name" ), Set Values( Parse( XML Text() ) ) ) )
    )
);


```

### [XML Decode](#xml-decode)

**Syntax:** text = XML Decode( textxml )

**Description:** Decodes symbols in XML to ordinary text, changes " to ", < to \<, &gt to >; & to &.

**JMP Version Added:** Before version 14

```

text = XML Decode( "isSmallAlpha = letter&gt;=&quot;a&quot; &amp; letter&lt;=&quot;z&quot;" );


```

### [XML Encode](#xml-encode)

**Syntax:** textxml = XML Encode( text )

**Description:** Prepares text for embedding in XML, changes " to ", < to \<, > to > & to &.

**JMP Version Added:** Before version 14

```

textxml = XML Encode( "\[isSmallAlpha = letter>="a" & letter<="z"]\" );


```

### [XML Text](#xml-text)

**Syntax:** value = XML Text()

**Description:** Extracts the string text of the body of an XML tag in the context of being evaluating in a Parse XML() command.

**JMP Version Added:** Before version 14

```

ex =
"<table name='fromxml'><col name='x'>[1 2 3]</col><col name='y'>[11 22 33]</col></table>";
Parse XML( ex,
    On Element( "table", Start Tag( New Table( XML Attr( "name" ) ) ) ),
    On Element(
        "col",
        End Tag( New Column( XML Attr( "name" ), Set Values( Parse( XML Text() ) ) ) )
    )
);


```

### [XPath Query](#xpath-query)

**Syntax:** result = XPath Query(xml, xpath expression)

**Description:** Runs an XPath query against an XML document.

**JMP Version Added:** Before version 14

```

result = XPath Query(
    "<doc><colors><color>red</color><color>green</color><color>blue</color></colors></doc>",
    "//color/text()"
);


```

### [XY Function](#xy-function)

**Syntax:** XY Function( x(t), y(t), t, min(0), max(1), inc(.01) | steps(100) )

**Description:** This graphic script function combines an expression x(t) and an expression y(t) to draw an x-y curve for the specified range of parameter t. Inc() is the maximum increment on t, or steps() is the minimum number of steps on t. Use steps() or inc() if the default value does not show details.

**JMP Version Added:** Before version 14

```

New Window( "Spiral",
    Graph Box(
        Pen Color( "red" );
        xCenter = 50;
        yCenter = 50;
        minAngle = 0;
        maxAngle = Pi() * 2 * 20;
        XY Function(
            xCenter + ((ta / 3) * Cos( ta )),
            yCenter + ((ta / 3) * Sin( ta )),
            ta,
            Min( minAngle ),
            Max( maxAngle ),
            inc( Pi() / 100 )
        );
    )
);
/* sin() and cos() use ta as an argument (rotates)
   AND as a factor (expands) in this example.
   (sin and cos use radians, not degrees.) */


```

### [Y Function](#y-function)

**Syntax:** Y Function( yExpr, xName, <properties> )

**Description:** Draws function yExpr in the Y dimension as variable xName varies across the range of the X axis of the graph. Additional named property arguments include Min(minimum X), Max(maximum X), Fill(fill pattern, value to fill to), Inc(upper bound of increment).

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        Y Function( 20 + 40 * Sin( a / 30 ), a );
    )
);


```

### [Y Origin](#y-origin)

**Syntax:** y = Y Origin()

**Description:** Returns the y value for the bottom edge of the graphics frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [Y Range](#y-range)

**Syntax:** y = Y Range()

**Description:** Returns the y distance from bottom to top. Y Origin() + Y Range() is the top edge.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [Y Scale](#y-scale)

**Syntax:** Y Scale( <yMin>, <yMax> )

**Description:** Sets a new scale for the graphics frame.

**JMP Version Added:** Before version 14

```

/* Default value for Y Scale() is (0,100).*/
New Window( "Example",
    Graph Box(
        Y Scale( -10, 90 ),
        X Scale( -10, 90 ),
        Oval(
            X Origin() + 10,
            (Y Origin() + Y Range()) - 10,
            (X Origin() + X Range()) - 10,
            Y Origin() + 10,
            1
        )
    )
);


```

### [Year](#year)

**Syntax:** yr = Year( datetime )

**Description:** Returns the year part of a date-time value.

**JMP Version Added:** Before version 14

```

Year( Today() );


```

### [Zero Or Missing](#zero-or-missing)

**Syntax:** y = Zero Or Missing( x )

**Description:** Returns the logical NOT of x with missing values treated as zeros: 1 if x is missing or zero and 0 otherwise.

**JMP Version Added:** Before version 14

```

Zero Or Missing( 1 < 2 );


```

### [ZI Negative Binomial Distribution](#zi-negative-binomial-distribution)

**Syntax:** cumprob = ZI Negative Binomial Distribution( k, lambda, sigma, pi )

**Description:** Returns the probability that a zero-inflated Negative Binomial distributed random variable is less than or equal to k, where lambda is the location parameter, sigma is the scale parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
sigma = .5;
p = .2;
New Window( "Example: Zero Inflated Negative Binomial Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, ZI Negative Binomial Distribution( k, lambda, sigma, p ) );
            V Line(
                k + 1,
                ZI Negative Binomial Distribution( k, lambda, sigma, p ),
                ZI Negative Binomial Distribution( k + 1, lambda, sigma, p )
            );
        );
        Text( {30, 0.3}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .2}, "\!U03C3=", Round( sigma, 2 ) );
        Text( {30, .1}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( 0.01, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0.001, 2, sigma, ppy << reshow ), Text Box( "\!U03C3" ) ),
        H List Box( Slider Box( 0, .99, p, ppy << reshow ), Text Box( " \!U03C0" ) ),

    )
);


```

### [ZI Negative Binomial Probability](#zi-negative-binomial-probability)

**Syntax:** prob = ZI Negative Binomial Probability( k, lambda, sigma, pi)

**Description:** Returns the probability that a zero-inflated Negative Binomial distributed random variable is equal to k, where lambda is the location parameter, sigma is the scale parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
sigma = .5;
p = .1;
New Window( "Example: Zero Inflated Negative Binomial Probability",
    ppy = Graph Box(
        Y Scale( 0, .4 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( k = 0, k <= 40, k++,
            V Line( k, 0, ZI Negative Binomial Probability( k, lambda, sigma, p ) )
        );
        Text( {30, 0.3}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .25}, "\!U03C3=", Round( sigma, 2 ) );
        Text( {30, .2}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( .01, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0.001, 2, sigma, ppy << reshow ), Text Box( "\!U03C3" ) ),
        H List Box( Slider Box( 0, .25, p, ppy << reshow ), Text Box( " \!U03C0" ) )
    )
);


```

### [ZI Negative Binomial Quantile](#zi-negative-binomial-quantile)

**Syntax:** q = ZI Negative Binomial Quantile( lambda, sigma, pi, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the zero-inflated Negative Binomial( lambda, sigma, pi ) distribution is larger than or equal to cumprob.

**JMP Version Added:** 19

```

qexpl = 20;
qexpsig = .5;
qexpp = .2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: ZI Negative Binomial Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line(
                qexpk,
                qexpk + 1,
                ZI Negative Binomial Distribution( qexpk, qexpl, qexpsig, qexpp )
            );
            V Line(
                qexpk + 1,
                ZI Negative Binomial Distribution( qexpk, qexpl, qexpsig, qexpp ),
                ZI Negative Binomial Distribution( qexpk + 1, qexpl, qexpsig, qexpp )
            );
        );
        Pen Color( "blue" );
        V Line( ZI Negative Binomial Quantile( qexpl, qexpsig, qexpp, qexpq ), 0, 1.0 );
        Text(
            {2, 0.9},
            " \!U03BB=",
            Round( qexpl, 2 ),
            " \!U03C3=",
            Round( qexpsig, 2 ),
            " \!U03C0=",
            Round( qexpp, 2 )
        );
        Text(
            {2, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( ZI Negative Binomial Quantile( qexpl, qexpsig, qexpp, qexpq ) )
        );
    ),
    H List Box( Slider Box( 0.001, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0.001, 2, qexpsig, qexpy << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, .99, qexpp, qexpy << reshow ), Text Box( " \!U03C0" ) ),
    H List Box( Slider Box( 0.001, .999, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [ZI Poisson Distribution](#zi-poisson-distribution)

**Syntax:** cumprob = ZI Poisson Distribution( k, lambda, pi )

**Description:** Returns the probability that a zero-inflated Poisson distributed random variable is less than or equal to k, where lambda is the location parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
p = .2;
New Window( "Example: Zero Inflated Poisson Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, ZI Poisson Distribution( k, lambda, p ) );
            V Line(
                k + 1,
                ZI Poisson Distribution( k, lambda, p ),
                ZI Poisson Distribution( k + 1, lambda, p )
            );
        );
        Text( {30, 0.2}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .1}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( 0, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0, .99, p, ppy << reshow ), Text Box( " \!U03C0" ) ),

    )
);


```

### [ZI Poisson Probability](#zi-poisson-probability)

**Syntax:** prob = ZI Poisson Probability( k, lambda, pi)

**Description:** Returns the probability that a zero-inflated Poisson distributed random variable is equal to k, where lambda is the location parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
p = .2;
New Window( "Example: Poisson Probability",
    ppy = Graph Box(
        Y Scale( 0, .6 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( k = 0, k <= 40, k++,
            V Line( k, 0, ZI Poisson Probability( k, lambda, p ) )
        );
        Text( {30, 0.5}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .4}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( 0, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0, .99, p, ppy << reshow ), Text Box( " \!U03C0" ) ),

    )
);


```

### [ZI Poisson Quantile](#zi-poisson-quantile)

**Syntax:** q = ZI Poisson Quantile( lambda, pi, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the zero-inflated Poisson( lambda, pi ) distribution is larger than or equal to cumprob.

**JMP Version Added:** 19

```

qexpl = 20;
qexpp = .2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: ZI Poisson Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, ZI Poisson Distribution( qexpk, qexpl, qexpp ) );
            V Line(
                qexpk + 1,
                ZI Poisson Distribution( qexpl, qexpp, qexpk ),
                ZI Poisson Distribution( qexpl, qexpp, qexpk + 1 )
            );
        );
        Pen Color( "blue" );
        V Line( ZI Poisson Quantile( qexpl, qexpp, qexpq ), 0, 1.0 );
        Text( {2, 0.9}, " \!U03BB=", Round( qexpl, 2 ), " \!U03C0=", Round( qexpp, 2 ) );
        Text(
            {2, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( ZI Poisson Quantile( qexpl, qexpp, qexpq ) )
        );
    ),
    H List Box( Slider Box( 0, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0, .99, qexpp, qexpy << reshow ), Text Box( " \!U03C0" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

# [Assignment](#assignment)

### [Add To](#add-to)

**Syntax:** y += x; Add To( y, x )

**Description:** Adds a value to a variable or to a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex += 2;
ex;


```

### [Assign](#assign)

**Syntax:** y = x; Assign( y, x )

**Description:** Assigns a value to a variable or a list of variables.

**JMP Version Added:** Before version 14

```

{ex1, ex2} = {Pi(), 1};
ex1 + ex1;


```

### [Divide To](#divide-to)

**Syntax:** y /= x; Divide To( y, x )

**Description:** Divides a value into a variable or into a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex /= 2;
ex;


```

### [Multiply To](#multiply-to)

**Syntax:** y \*= x; Multiply To( y, x )

**Description:** Multiplies a value to a variable or to a list of variables.

**JMP Version Added:** Before version 14

```

ex = 3;
ex *= 2;
ex;


```

### [PostDecrement](#postdecrement)

**Syntax:** x--; PostDecrement( x )

**Description:** Subtracts 1 from a variable or from a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex--;
ex;


```

### [PostIncrement](#postincrement)

**Syntax:** x++; PostIncrement( x )

**Description:** Adds 1 to a variable or to a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex++;
ex;


```

### [Subtract To](#subtract-to)

**Syntax:** y -= x; Subtract To( y, x )

**Description:** Subtracts a value from a variable or from a list of variables.

**JMP Version Added:** Before version 14

```

ex = 1;
ex -= 2;
ex;


```

# [CAS](#cas)

### [CAS Connect](#cas-connect)

**Syntax:** CAS Connect(\<URL(...)>, \<Username(...)>, \<Password(...)>, \<Prompt(Never | Always | IfNeeded)>, \<Session("session id")>, \<Proxy Server("http://my_proxy:80")>, \<Proxy User("proxy_username")>, \<Bypass Proxy("http://localhost:80")>, \<Certificates(...)>, \<Verify Certificates(1 | 0)>, \<No Verify Certificates(1 | 0)>, \<Timeout(seconds)>, \<Authorization Method("Basic" | "Bearer")>)

**Description:** Connects to a new CAS server. CAS Connect uses URL, User name, Password arguments and optionally Prompt and Session. Prompt can be IfNeeded, Always, or Never. URL, user name, password can be omitted if the Prompt argument is IfNeeded or Always. The default value for Prompt is Never. Session can be used to reconnect to an existing CAS session. The session must be valid for the URL, user name, and password used in the connection. The optional Certificates argument is useful for supplying trusted certificates for https connections to CAS. The optional Verify Certificates or No Verify Certificates argument is useful to temporarily accept self-signed certificates. The optional Proxy Server argument is useful for supplying a proxy host in a proxy environment. The optional Proxy User argument is useful for supplying user and password information for a proxy environment. The optional Bypass Proxy argument is use for bypassing the proxy for certain hosts. The optional Timeout argument sets a timeout value for the CAS connection operations. The optional Authorization Method argument specifies how JMP connects to CAS. This is dependent on the CAS deployment.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = CAS Connect(
    URL( url ),
    Username( "myCas_user" ),
    Prompt( Always ),
    Certificates( "c:\mycerts.crt" )
);


```

### [CAS Delete Table](#cas-delete-table)

**Syntax:** CAS Delete Table(tablename, <remove>)

**Description:** This action deletes the filesystem table. The in memory table is not affected. Specifying Quiet will suppress errors for a non-existent table. Specifying remACs will remove access controls for a table. Specifying Remove will also remove the table from memory.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
CAS Delete Table( "Casuser", "Big Class" );


```

### [CAS Disconnect](#cas-disconnect)

**Syntax:** CAS Disconnect()

**Description:** Disconnects from a CAS server and optionally terminates the session. By default, the session is terminated when disconnected.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = CAS Connect( URL( url ), Username( "myCas_user" ), Prompt( Always ) );
CAS Disconnect();


```

### [CAS Export Data](#cas-export-data)

**Syntax:** y = CAS Export Data(jmp_data_table, cas_libref, cas_dataset, \<named_arguments>)

**Description:** Exports a table to a CAS server. jmp_data_table is the JMP data table to export while cas_libref and cas_dataset are the target locations on the CAS server. The optional named argument is Save(1|0). When a table is exported to CAS, it is not persisted to CAS filesystem unless the Save option is used. Most CAS actions occur in memory.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "CASUSER", "Big Class" );


```

### [CAS Get Data Sets](#cas-get-data-sets)

**Syntax:** y = CAS Get Data Sets(\<"caslib">)

**Description:** Gets a list of available CAS data sets. These data sets are found on the CAS filesystem. The optional argument limits the list of data sets to the CAS library. If no argument is used, then the data set list contains the fully qualified data set name (library.dataset). If the argument is used, then the data set list is a list of data set names.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
cas << Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class", Save( 1 ) );
datasets = CAS Get Data Sets( "casuser" );
Show( datasets );
cas << Delete Table( "Casuser", "Big Class" );
datasets = CAS Get Data Sets( "casuser" );
Show( datasets );


```

### [CAS Get Libraries](#cas-get-libraries)

**Syntax:** y = CAS Get Libraries()

**Description:** Gets a list of available CAS libraries.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
libraries = CAS Get Libraries();
Show( libraries );


```

### [CAS Import Data](#cas-import-data)

**Syntax:** dt = CAS Import Data(libref, dataset, \<named_arguments>)

**Description:** Imports a table from a CAS server. Optional named arguments are Invisible(0|1), Private(0|1) and UseLabelsForVarNames(0|1).

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
CAS Import Data( "Casuser.Big Class" );


```

### [CAS Is Connected](#cas-is-connected)

**Syntax:** CAS Is Connected

**Description:** Returns 1 if there is an active CAS server connection. Otherwise, returns 0.

**JMP Version Added:** 15

```


connected = CAS Is Connected();
Show( connected );


```

### [CAS Remove Table](#cas-remove-table)

**Syntax:** CAS Remove Table(tablename, <delete>)

**Description:** This action drops the in-memory table. The file that was created with the save action is not affected. Specifying delete will also delete the table from the file system.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Export Data( Open( "$SAMPLE_DATA\Big Class.jmp" ), "Casuser", "Big Class" );
CAS Remove Table( "Casuser", "Big Class" );


```

### [CAS Table To Data Table](#cas-table-to-data-table)

**Syntax:** dt = CAS Table To Data Table(jsonstring, \<Invisible(1|0) | Private(1|0) | Use Labels for Var Names(1|0)>)

**Description:** Converts a SAS CAS Table JSON text to a JMP data table.

**JMP Version Added:** 15

```


json =
"\[
{
  "_ctb": true,
  "label": "Selected Rows from Table BIG CLASS",
  "name": "Fetch",
  "title": "Selected Rows from Table BIG CLASS",
  "schema": [
    {
      "format": "",
      "label": "",
      "name": "_Index_",
      "type": "int",
      "width": 4
    },
    {
      "format": "",
      "label": "",
      "name": "name",
      "type": "string",
      "width": 9
    },
    {
      "format": "",
      "label": "",
      "name": "age",
      "type": "double",
      "width": 8
    },
    {
      "format": "",
      "label": "",
      "name": "sex",
      "type": "string",
      "width": 1
    },
    {
      "format": "",
      "label": "",
      "name": "height",
      "type": "double",
      "width": 8
    },
    {
      "format": "",
      "label": "",
      "name": "weight",
      "type": "double",
      "width": 8
    }
  ],
  "rows": [
    [
      1,
      "KATIE",
      12,
      "F",
      59,
      95
    ],
    [
      2,
      "LOUISE",
      12,
      "F",
      61,
      123
    ],
    [
      3,
      "JANE",
      12,
      "F",
      55,
      74
    ],
    [
      4,
      "JACLYN",
      12,
      "F",
      66,
      145
    ],
    [
      5,
      "LILLIE",
      12,
      "F",
      52,
      64
    ],
    [
      6,
      "TIM",
      12,
      "M",
      60,
      84
    ],
    [
      7,
      "JAMES",
      12,
      "M",
      61,
      128
    ],
    [
      8,
      "ROBERT",
      12,
      "M",
      51,
      79
    ],
    [
      9,
      "BARBARA",
      13,
      "F",
      60,
      112
    ],
    [
      10,
      "ALICE",
      13,
      "F",
      61,
      107
    ],
    [
      11,
      "SUSAN",
      13,
      "F",
      56,
      67
    ],
    [
      12,
      "JOHN",
      13,
      "M",
      65,
      98
    ],
    [
      13,
      "JOE",
      13,
      "M",
      63,
      105
    ],
    [
      14,
      "MICHAEL",
      13,
      "M",
      58,
      95
    ],
    [
      15,
      "DAVID",
      13,
      "M",
      59,
      79
    ],
    [
      16,
      "JUDY",
      14,
      "F",
      61,
      81
    ],
    [
      17,
      "ELIZABETH",
      14,
      "F",
      62,
      91
    ],
    [
      18,
      "LESLIE",
      14,
      "F",
      65,
      142
    ],
    [
      19,
      "CAROL",
      14,
      "F",
      63,
      84
    ],
    [
      20,
      "PATTY",
      14,
      "F",
      62,
      85
    ]
  ]
}
]\";
dt = CAS Table To Data Table( json );


```

### [CAS Terminate Sessions](#cas-terminate-sessions)

**Syntax:** CAS Terminate Sessions

**Description:** Terminates all CAS sessions owned by the current user.

**JMP Version Added:** 15

```


CAS Connect( Prompt( ifNeeded ) );
CAS Terminate Sessions();


```

### [Current CAS Connection](#current-cas-connection)

**Syntax:** Current CAS Connection()

**Description:** Obtains the connection to the current CAS Server.

**JMP Version Added:** 15

```


connection = Current CAS Connection();
Show( connection );


```

### [New CAS Action](#new-cas-action)

**Syntax:** action = New CAS Action(...)

**Description:** Creates a CAS Action.

**JMP Version Added:** 15

```


echo = [=> ];
echo["a"] = 1;
echo["b"] = JSON Literal( true );
echo["c"] = 3.141559;
action = New CAS Action( Action( "builtins.echo" ), JSON( echo ) );


```

### [New CAS DATA Step action](#new-cas-data-step-action)

**Syntax:** action = New CAS DATA Step Action(...)

**Description:** Creates a CAS DATA step action.

**JMP Version Added:** 15

```


cas = Current CAS Connection();
code =
"\[
    data temp;
    x = 9.1; y = 6; z = sqrt(x**2 + y**2);
    A = "SAS"; B = "Statistics";
    put _ALL_;              /* display all variables and values */
    run;
]\";
action = New CAS DATA Step action( Code( code ) );
cas << Submit( action );


```

### [New CAS Server](#new-cas-server)

**Syntax:** cas = New CAS Server(\<...>)

**Description:** Creates a new CAS server.

**JMP Version Added:** 15

```


url = "http://myCasURL";
cas = New CAS Server( Connect( URL( url ), Prompt( IfNeeded ) ) );


```

# [Character Pattern](#character-pattern)

### [Pat Abort](#pat-abort)

**Syntax:** Pat Abort()

**Description:** Generates a pattern value that causes the entire match to fail immediately with no further backup and retry.

**JMP Version Added:** Before version 14

```

source = "xxxxx";
n = 0;
pattern = Pat Succeed() + Pat Arb() >> xs + Expr(
    Show( xs );
    n = n + 1;
    If( n > 16,
        Pat Abort(),
        Pat Fail()
    );
);
rc = Pat Match( source, pattern, NULL, FULLSCAN );


```

### [Pat Altern](#pat-altern)

**Syntax:** Pat Altern( pat1, pat2, ... )

**Description:** Generates a pattern value that matches any one of the supplied patterns. Generally written as pat1 | pat2 | ....

**JMP Version Added:** Before version 14

```

Pat Match(
    "123456789",
    ((Pat Pos( 2 ) + "1") | (Pat Pos( 1 ) + "2") | (Pat Pos( 0 ) + "3")) >> result
);
result;


```

### [Pat Any](#pat-any)

**Syntax:** Pat Any( string )

**Description:** Generates a pattern value that will match any one character in the string.

**JMP Version Added:** Before version 14

```

operators = Pat Any( "*+-/" );
text = "abc+def";
Pat Match( text, operators >> op );
op;


```

### [Pat Arb](#pat-arb)

**Syntax:** Pat Arb( pattern )

**Description:** Generates a pattern value that matches zero or more characters.

**JMP Version Added:** Before version 14

```

Pat Match(
    "123nonnumeric456",
    Pat Span( "0123456789" ) + Pat Arb() >> result + Pat Span( "0123456789" )
);
result;


```

### [Pat Arb No](#pat-arb-no)

**Syntax:** Pat Arb No( pattern )

**Description:** Generates a pattern value that matches its argument zero or more times. Same as patRepeat(pattern,0,infinity,RELUCTANT); (\*? in regex).

**JMP Version Added:** Before version 14

```

Pat Match(
    "xyz aaaaabbbbbb@ccc no c is matched because reluctant",
    Pat Arb No( "a" ) >> a + Pat Arb No( "b" ) >> b + "@" + Pat Arb No( "c" ) >> c
);
" a=" || a || " b=" || b || " c=" || c;


```

### [Pat At](#pat-at)

**Syntax:** Pat At( variable )

**Description:** Generates a pattern value that matches zero characters and assigns the current cursor position to variable. Generally written as patpos()>>variable.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", Pat Len( 2 ) + Pat At( result ) );
result;


```

### [Pat Break](#pat-break)

**Syntax:** Pat Break( string )

**Description:** Generates a pattern value that matches zero or more characters not in the string, stopping before a (required) character in the string.

**JMP Version Added:** Before version 14

```

b = "- ";
Pat Match( "one two three-", Pat Repeat( Pat Break( b ) >> word + Pat Any( b ) ) );
word;


```

### [Pat Concat](#pat-concat)

**Syntax:** Pat Concat( pat1, pat2, ... )

**Description:** Generates a pattern value that matches each of the supplied patterns in turn. Generally written as pat1 + pat2 + ....

**JMP Version Added:** Before version 14

```

num = Pat Break( "," );
sep = ",";
Pat Match( "1.3,7.9,8.66", num + sep + num >> result + sep + num );
result;


```

### [Pat Conditional](#pat-conditional)

**Syntax:** Pat Conditional( pattern, variable )

**Description:** Generates a pattern value that matches the supplied pattern and stores the matched text in variable on success. Generally written as pattern >? variable.

**JMP Version Added:** Before version 14

```

a = "unchanged";
b = "unchanged";
Pat Match( "123456789", (Pat Len( 2 ) >? a | Pat Len( 1 ) >? b) + "2" );
" a=" || a || " b=" || b;


```

### [Pat Fail](#pat-fail)

**Syntax:** Pat Fail()

**Description:** Generates a pattern value that always fails to match going forward, forcing the matcher to retry alternatives.

**JMP Version Added:** Before version 14

```

source = "xxxxx";
n = 0;
pattern = Pat Succeed() + Pat Arb() >> xs + Expr(
    Show( xs );
    n = n + 1;
    If( n > 16,
        Pat Abort(),
        Pat Fail()
    );
);
rc = Pat Match( source, pattern, NULL, FULLSCAN );


```

### [Pat Fence](#pat-fence)

**Syntax:** Pat Fence()

**Description:** Generates a pattern value that matches zero characters going forwards and fails when backing up, causing the match to fail. Also used to trim down the pattern backup stack.

**JMP Version Added:** Before version 14

```

rc = Pat Match( "123456789", (Pat Len( 1 ) | Pat Len( 2 )) >> result + Pat Fence() + "3" );
"rc=" || Char( rc ) || " result=" || result;


```

### [Pat Immediate](#pat-immediate)

**Syntax:** Pat Immediate( pattern, variable )

**Description:** Generates a pattern value that matches the supplied pattern and immediately stores the matched text in variable. Generally written as pattern >> variable.

**JMP Version Added:** Before version 14

```

a = "unchanged";
b = "unchanged";
Pat Match( "123456789", (Pat Len( 2 ) >> a | Pat Len( 1 ) >> b) + "2" );
" a=" || a || " b=" || b;


```

### [Pat Len](#pat-len)

**Syntax:** Pat Len( n )

**Description:** Generates a pattern value that matches n characters.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", Pat Len( 2 ) + Pat Len( 3 ) >> result );
result;


```

### [Pat Look Ahead](#pat-look-ahead)

**Syntax:** Pat Look Ahead( pattern, \<0|1> )

**Description:** A zero width pattern match after the current position. The second optional argument defaults to 0. 1 designates a negative match, or a non-match.

**JMP Version Added:** Before version 14

**Example 1**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        "s" + Pat Look Ahead( "'" ),
        "z"
    ), /* find an s that IS followed by an apostrophe and replace it with z */
    Print( test )
);


```

**Example 2**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        "s" + Pat Look Ahead( "'", 1 ),
        "z"
    ), /* find an s that is NOT followed by an apostrophe and replace it with z */
    Print( test )
);


```

**Example 3**

```

Test = "a bb ccc dddd";
While( /* keep repeating the match until it won't match */
    Pat Match(
        Test,
        Pat Len( 1 ) >> xxx/* find any character */
        + Pat Look Behind( Expr( xxx ) + Expr( xxx ) ) /* back up 2 positions, which includes the character just found */
        + Pat Look Ahead( Expr( xxx ) /* and look ahead one position */ ),
        "@" /* replacement for the middle character of a triple */
    ),
    Print( test ) /* show each intermediate result */
);


```

### [Pat Look Behind](#pat-look-behind)

**Syntax:** Pat Look Behind( pattern, \<0|1> )

**Description:** A zero width pattern match before the current position. The second optional argument defaults to 0. 1 designates a negative match, or a non-match.

**JMP Version Added:** Before version 14

**Example 1**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        Pat Look Behind( "'" ) + "s",
        "z"
    ), /* find an s that IS preceded by an apostrophe and replace it with z */Print( test )
);


```

**Example 2**

```

Test = "These are Bob's sons' nails.";
While( /* repeat the match until it fails */Pat Match(
        Test,
        Pat Look Behind( "'", 1 ) + "s",
        "z"
    ), /* find an s that is NOT preceded by an apostrophe and replace it with a z */
    Print( test )
);


```

**Example 3**

```

Test = "a bb ccc dddd";
While( /* keep repeating the match until it won't match */
    Pat Match(
        Test,
        Pat Len( 1 ) >> xxx/* find any character */
        + Pat Look Behind( Expr( xxx ) + Expr( xxx ) ) /* back up 2 positions, which includes the character just found */
        + Pat Look Ahead( Expr( xxx ) /* and look ahead one position */ ),
        "@" /* replacement for the middle character of a triple */
    ),
    Print( test ) /* show each intermediate result */
);


```

### [Pat Match](#pat-match)

**Syntax:** Pat Match( source, pattern, <replacement> )

**Description:** Executes the pattern match in the pattern variable against the string in the source variable; optional replacement text replaces the matched text.

**JMP Version Added:** Before version 14

```

string = "John Smith";
Pat Match(
    string,
    Pat Break( " " ) >> first + Pat Span( " " ) + Pat Rem() >> last,
    last || ", " || first
);
string;


```

### [Pat Not Any](#pat-not-any)

**Syntax:** Pat Not Any( string )

**Description:** Generates a pattern value that will match any one character not in the string.

**JMP Version Added:** Before version 14

```

delimiter = ";,-";
text = "fish,dog,cat,";
Pat Match( text, Pat Repeat( Pat Not Any( delimiter ) ) >> word + Pat Any( delimiter ) );
word;


```

### [Pat Pos](#pat-pos)

**Syntax:** Pat Pos( n )

**Description:** Generates a pattern value that matches zero characters if the cursor is at position n. With no argument, the Pat Pos() function returns the cursor position for >> or >? assignment: patpos()>>variable.

**JMP Version Added:** Before version 14

```

Pat Match(
    "ab3defghi",
    Pat Pos( 2 ) + Pat Len( 1 ) >> v/*v=3*/+ Expr( Pat Len( v ) )
    +Pat Pos( /* no argument returns current position = 6 */ ) >> result
);
result;


```

### [Pat R Pos](#pat-r-pos)

**Syntax:** Pat R Pos( n )

**Description:** Generates a pattern value that matches zero characters if the cursor is n characters from the end.

**JMP Version Added:** Before version 14

```

Pat Match( "quick brown fox", Pat R Pos( 3 ) + Pat Rem() >> result );
result;


```

### [Pat R Tab](#pat-r-tab)

**Syntax:** Pat R Tab( n )

**Description:** Generates a pattern value that matches zero or more characters to move the cursor forward to n characters before the end.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", "23" + Pat R Tab( 2 ) >> result );
result;


```

### [Pat Regex](#pat-regex)

**Syntax:** Pat Regex( string )

**Description:** Generates a pattern value that matches the regular expression in the string.

**JMP Version Added:** Before version 14

```

string = "John Smith";
Regex Match( string, Pat Regex( "([^ ]+)([ ]+)([^ ]+)" ), "\3, \1" );
string;


```

### [Pat Rem](#pat-rem)

**Syntax:** Pat Rem()

**Description:** Generates a pattern value that matches the remainder of the text.

**JMP Version Added:** Before version 14

```

Pat Match( "the quick fox", Pat R Pos( 3 ) + Pat Rem() >> result );
result;


```

### [Pat Repeat](#pat-repeat)

**Syntax:** Pat Repeat( pattern, \<min=1>, \<max=infinity>, <GREEDY or RELUCTANT=GREEDY> )

**Description:** Generates a pattern value that matches the supplied pattern between min and max times.

**JMP Version Added:** Before version 14

```

Pat Match(
    "xyz aaaaabbbbbbccc 3 c is matched because greedy",
    Pat Repeat( "a" ) >> a + Pat Repeat( "b" ) >> b + Pat Repeat( "c" ) >> c
);
" a=" || a || " b=" || b || " c=" || c;


```

### [Pat Span](#pat-span)

**Syntax:** Pat Span( string )

**Description:** Generates a pattern value that matches one or more characters in the string.

**JMP Version Added:** Before version 14

```

sp = Pat Span( "0123456789.-" );
Pat Match( "junk=-33.44e33", sp >> result );
result;


```

### [Pat String](#pat-string)

**Syntax:** Pat String( string )

**Description:** Generates a pattern value that matches the string. Generally the string can be used without using the Pat String() function.

**JMP Version Added:** Before version 14

```

x = Pat String( "a" || "b" );
Pat Match(
    "acbdbababc",
    Pat Arb() >> before + Pat Repeat( x ) >> match + Pat Rem() >> after
);
"before=" || before || " match=" || match || " after=" || after;


```

### [Pat Succeed](#pat-succeed)

**Syntax:** Pat Succeed()

**Description:** Generates a pattern value that always matches zero characters, even when backing up.

**JMP Version Added:** Before version 14

```

source = "xxxxx";
n = 0;
pattern = Pat Succeed() + Pat Arb() >> xs + Expr(
    Show( xs );
    n = n + 1;
    If( n > 16,
        Pat Abort(),
        Pat Fail()
    );
);
rc = Pat Match( source, pattern, NULL, FULLSCAN );


```

### [Pat Tab](#pat-tab)

**Syntax:** Pat Tab( n )

**Description:** Generates a pattern value that matches zero or more characters to move the cursor forward to position n.

**JMP Version Added:** Before version 14

```

Pat Match( "123456789", "23" + Pat Tab( 6 ) >> result );
result;


```

### [Pat Test](#pat-test)

**Syntax:** Pat Test( expression )

**Description:** Generates a pattern value that matches zero characters if the expression is nonzero. The expression is re-evaluated during each test, as if Expr() was used.

**JMP Version Added:** Before version 14

```

nCats = 0;
whichCat = 3;
string = "catch a catnapping cat in a catsup factory";
rc = Pat Match(
    string,
    "cat" + Pat Test(
        nCats = nCats + 1;
        nCats == whichCat;
    ),
    "dog"
);
string;


```

### [Regex Match](#regex-match)

**Syntax:** Regex Match( source, pattern, \<replacement | NULL>, <MATCHCASE> )

**Description:** Executes a regular expression match and returns a list of the entire matched text and the matches for each back reference created by an open parenthesis. Optionally, the third argument specifies a replacement string for the entire match; the replacement string can use back references.

**JMP Version Added:** Before version 14

```


source = "believe";
// [aeiou] matches exactly one vowel
// .*? is a reluctant (vs greedy) match. try it without the ? to see the greedy behavior
// \1 is a back reference to the first ( group -- [aeiou] is inside the first ( group
matches = Regex Match(
    source, // a variable allows updating some text
    "([aeiou])(.*?)(\1)", // a regex with parens makes back references
    ">\2<" // the match is replaced by text that uses a back reference
);
Show( source, matches );
// results:
// source = "b>li<ve";
// matches = {"elie", "e", "li", "e"};
// notes:
// matches[1] is the entire match AND the part that will be replaced
// matches[2] is back ref \1  this is the letter e matched by [aeiou]
// matches[3] is back ref \2  this is the letter li matched by .*?
// matches[4] is back ref \3  this is another letter e match by \1, which was an e
//
// the * operator is greedy by default, taking as many characters as it can, and
// only backing up if required. Adding the ? makes it reluctant, taking characters
// one at a time and allowing the remaining pattern to have a chance earlier.


```

# [Character](#character)

### [Blob To Char](#blob-to-char)

**Syntax:** s = Blob To Char( blob, \<encoding="utf-8"> )

**Description:** Makes a character string from a BLOB (Binary Large Object), using the specified encoding. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, shift_jis, euc-jp, and ascii~hex.

**JMP Version Added:** Before version 14

```

Blob To Char( Hex To Blob( "436166C3A9" ) ) || Blob To Char(
    Hex To Blob( "436166C3A9" ),
    "ascii~hex"
);


```

### [Blob To Matrix](#blob-to-matrix)

**Syntax:** m = Blob To Matrix( blob, type, bytesEach, endian, \<nCols=1> )

**Description:** Makes a matrix by converting bytes in the blob to numbers. type is either "int", "uint" or "float". bytesEach is either 1, 2, 4, or 8. endian indicates whether the first byte is the most significant ("big") or the least significant ("little"); "native" indicates the machine's native format.

**JMP Version Added:** Before version 14

```

Blob To Matrix( Hex To Blob( "00010002FFFFFFFE" ), "int", 2, "big", 2 );


```

### [Char](#char)

**Syntax:** s = Char( x, <w>, <d>, < \<<Use Locale( Boolean ) >, < \<<Full Precision( Boolean ) > )

**Description:** Returns a representation of x as a character string, using the maximum width w and decimal places d if the x argument is numeric. \<<FullPrecision writes numeric values using all available precision.

**JMP Version Added:** Before version 14

#### [Full Precision](#full-precision)

```

Show( Char( 88.54 ), Char( 88.54, <<Full Precision( 1 ) ) );


```

#### [Simple](#simple)

```

Char( Pi(), 10, 4 );


```

#### [Use Locale](#use-locale)

```

Char( 2.1, <<Use Locale( 1 ) );


```

### [Char To Blob](#char-to-blob)

**Syntax:** blob = Char To Blob( string, \<encoding="utf-8"> )

**Description:** Makes a BLOB (Binary Large Object) from a string of characters, using the specified encoding. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, shift_jis, euc-jp, and ascii~hex.

**JMP Version Added:** Before version 14

```

Char To Blob( "Café", "utf-16be" );


```

### [Char To Hex](#char-to-hex)

**Syntax:** h = Char To Hex( value, \<"integer">|\<encoding="utf-8"> )

**Description:** Returns the hexadecimal text corresponding to the given value and encoding, which can be a number, a string, or a blob. If the value is a number, IEEE 754 64-bit encoding is used unless the optional argument, "integer", is provided. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, ascii~hex, shift_jis, and euc-jp.

**JMP Version Added:** Before version 14

```

Hex( 1024, "integer" ) || " " || Hex( "Café", "utf-16be" );


```

### [Collapse Whitespace](#collapse-whitespace)

**Syntax:** scw = Collapse Whitespace( s )

**Description:** Trims leading and trailing whitespace and removes duplicate interior white spaces

**JMP Version Added:** Before version 14

```

Collapse Whitespace( "  The  dog    crossed    the  road  " );


```

### [Concat](#concat)

**Syntax:** s = s1 || s2 ...; m = m1 || m2 ...; s = Concat( s1, s2, ... )

**Description:** Concatenates strings into a longer string or matrices into a wider matrix.

**JMP Version Added:** Before version 14

```

[1 2] || [3 4] || [5 6];


```

### [Concat Items](#concat-items)

**Syntax:** string = Concat Items( {list of strings}, <separatorString> )

**Description:** Joins a list of strings into one long string, separating each from next with the separator, a blank if unspecified.

**JMP Version Added:** Before version 14

```

Concat Items( {"www", "jmp", "com"}, "." );


```

### [Concat To](#concat-to)

**Syntax:** string1 ||= string2; matrix1 ||= matrix2; Concat To( a, b )

**Description:** Concatenates in place. a ||= b is equivalent to a = a || b. This is an assignment operator.

**JMP Version Added:** Before version 14

```

ex = "hello ";
ex ||= "world";


```

### [Contains](#contains)

**Syntax:** pos = Contains( x, item, \<start=1> )

**Description:** Returns the position of item within x, starting at position start if provided. If start is negative, the search starts backward from length( x ) - start. The argument x can be a string or a list.

**JMP Version Added:** Before version 14

```

Show( Contains( "redreed", "re", -1 ) );
Show( Contains( {"A", 2, "C", [1 5], "C"}, "C", 4 ) );


```

### [Contains Item](#contains-item)

**Syntax:** b = Contains Item( x, item | list | Pat Regex(), <delimiter> )

**Description:** Returns a Boolean indicating whether the word [item], one of a list of words [list], or pattern [pattern] matches one of the words in the text represented by [x]. Words are delimited by the characters in the optional delimiter [delimiter] string. A comma, ",", character is the default delimiter. Blanks are trimmed from the ends of each extracted word from the input text string [x].

**JMP Version Added:** Before version 14

**Example 1**

```

Show( Contains Item( "A, 2, C, D, C", "C", ", " ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Food Journal.jmp" );
dt << New Column( "Cheese",
    numeric,
    continuous,
    Formula( Contains Item( dt:Item Name, "Cheese", ", " ) )
);
dt << Distribution( Column( :Cheese ) );


```

**Example 3**

```

//find repeated character c in cdcef
Contains Item( "abcde,bcdef,cdcef", Pat Regex( "(.).*?\1" ), "," );


```

### [Ends With](#ends-with)

**Syntax:** b = Ends With( s, sub )

**Description:** Returns 1 if s ends with sub, otherwise returns 0. The s and sub arguments can be both strings or both lists. Equivalent to Right( s, Length( sub )) == sub.

**JMP Version Added:** Before version 14

```

Ends With( "http://www.jmp.com", ".com" );


```

### [Hex](#hex)

**Syntax:** h = Hex( value, \<"integer">|\<encoding="utf-8">|\<Base(number)>,\<Pad To(number)> )

**Description:** Returns the hexadecimal (or other base number system) text corresponding to the given value and encoding, which can be a number a string or a blob. If the value is a number, IEEE 754 64-bit encoding is used unless one of the optional arguments, integer or Base, is provided. If Base is specified, the function returns the text corresponding to the specified number in that base number system instead of hexadecimal. The base must be an integer value between 2 and 36 inclusive. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, ascii~hex, shift_jis and euc-jp.

**JMP Version Added:** Before version 14

```

Hex( 1024, "integer" ) || " " || Hex( "Café", "utf-16be" ) || " " ||
Hex( 11, Base( 2 ), Pad To( 8 ) );


```

### [Hex To Blob](#hex-to-blob)

**Syntax:** blob = Hex To Blob( hex string )

**Description:** Makes a BLOB (Binary Large OBject) from the given string of hexadecimal codes, which can also include spaces, commas, carriage returns, and line feeds.

**JMP Version Added:** Before version 14

```

Hex To Blob( "FF78CE" );


```

### [Hex To Char](#hex-to-char)

**Syntax:** s = Hex To Char( hextext, \<encoding="utf-8"> )

**Description:** Returns the text corresponding to the hexadecimal text, using the specified encoding. Supported encodings include utf-8, utf-16le, utf-16be, us-ascii, iso-8859-1, ascii~hex, shift_jis, and euc-jp.

**JMP Version Added:** Before version 14

```

Hex To Char( "436166C3A9" ) || Hex To Char( "00430061006600E9", "utf-16be" );


```

### [Hex To Number](#hex-to-number)

**Syntax:** x = Hex To Number( hextext, \<Base(number)> )

**Description:** Returns the number corresponding to the hexadecimal (or other base number system) text. 16 hex digits are converted as IEEE 754 64-bit floating point numbers; otherwise the input is treated as a hex integer. If Base is specified, the text is treated as a string representing the number in that base. Base must be an integer between 2 and 36 inclusive.

**JMP Version Added:** Before version 14

```

Hex To Number( "11110000", Base( 2 ) );


```

### [Insert](#insert)

**Syntax:** z = Insert( x, y, <i> )

**Description:** Returns a copy of list x with y inserted at the ith position or appended to the end if the optional i argument is not specified.

**JMP Version Added:** Before version 14

```

z = {11, 22, 33};
z = Insert( z, 99, 2 );


```

### [Insert Into](#insert-into)

**Syntax:** Insert Into( x, y, <i> )

**Description:** Modifies list, associative array, or display box x with y inserted into the collection. Lists and display boxes support an optional i to specify the position, or the items will be appended if the position is not specified. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33};
Insert Into( ex, 99 );
ex;


```

**Example 2**

```

ex = ["a" => 10, "b" => 3, => 0];
Insert Into( ex, "c", 12 );
ex;


```

**Example 3**

```

New Window( "boxes", hlist = H List Box( Button Box( "a" ), Button Box( "b" ) ) );
Wait( 1 );
Insert Into( hlist, Button Box( "c" ) );


```

### [Item](#item)

**Syntax:** w = Item( n|[first last], s, <delim>, \<Unmatched(result string)>, \<Include Boundary Delimiters(0|1)>)

**Description:** Returns the nth item of the s argument, where items are the (possibly empty) sub-strings separated by exactly one of any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate item.

**JMP Version Added:** Before version 14

**Example 1**

```

Item( 5, "http://www.jmp.com", ":/." );


```

**Example 2**

```

Item( [2 -1], "This is a sentence" );


```

**Example 3**

```

Item( 4, "Apple+Banana Tree,,Pear,,Peach,,Grape", Get Punctuation Characters() );


```

**Example 4**

```

Item( 5, "a b c d", Unmatched( "None" ) );


```

**Example 5**

```

Item( 2, "abcd", "" );


```

**Example 6**

```

Item( 2, ",abcd", ",", Include Boundary Delimiters );


```

### [Items](#items)

**Syntax:** wl = Items(\<[first last]>, s, <delim>, \<Include Boundary Delimiters(0|1)>)

**Description:** Returns a list of (possibly empty) sub-strings separated by exactly one of any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate item.

**JMP Version Added:** 15

**Example 1**

```

Eval List( {Items( "http://www.jmp.com", ":/." ), Items( "hello", "" )} );


```

**Example 2**

```

Items( ",Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

**Example 3**

```

Items(
    ",Apple,Banana Tree,Peach",
    Get Punctuation Characters(),
    Include Boundary Delimiters
);


```

**Example 4**

```

Items( [1 2], ",Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

### [Left](#left)

**Syntax:** sub = Left( s, n, <filler> )

**Description:** Returns a truncated or padded version of the original string or list s. The result contains the left n characters or list items, padded with any filler on the right if the length of s is less than n.

**JMP Version Added:** Before version 14

```

exurl = "http://www.jmp.com";
Left( exurl, Contains( exurl, ":" ) - 1 );


```

### [Length](#length)

**Syntax:** l = Length( x )

**Description:** Returns the length of the given string (in characters), list (in items), associative array (in number of keys), blob (in bytes), matrix (in elements), or namespace/class (in number of functions and variables).

**JMP Version Added:** Before version 14

**Example 1**

```

Length( "Café" );


```

**Example 2**

```

Length( {1, 2 + 3, [11 22]} );


```

**Example 3**

```

Length( ["a" => 10, "b" => 3, => 0] );


```

**Example 4**

```

Length( Char To Blob( "Café" ) );


```

### [Lowercase](#lowercase)

**Syntax:** sl = Lowercase( s )

**Description:** Converts uppercase letters to lowercase letters in the specified string. Rules for upper and lower case are locale dependent.

**JMP Version Added:** Before version 14

```

Lowercase( "CAFÉ #23" );


```

### [Matrix To Blob](#matrix-to-blob)

**Syntax:** m = Matrix To Blob( matrix, type, bytesEach, endian )

**Description:** Makes a blob from a matrix by converting the matrix elements to 1, 2, or 4 byte signed or unsigned integers or 4 or 8 byte floating point numbers.

**JMP Version Added:** Before version 14

```

Matrix To Blob( [3.14, 1.414], "float", 4, "big" );


```

### [Munger](#munger)

**Syntax:** r = Munger( s, startPos, findStringOrNChars, <replaceString> )

**Description:** Searches the s argument for a substring or position depending on combination of arguments.

**JMP Version Added:** Before version 14

```

Eval List( {Munger( "over there", 1, "t", "" ), Munger( "17 June 2000", 4, 4, "March" )} );


```

### [Num](#num)

**Syntax:** y = Num( s, < \<<Use Locale( use=1 ) >, < \<<Restrict > )

**Description:** Converts s to a number using any built-in format, including date and currency formats. Returns missing if the conversion fails. The optional \<<Restrict only allows conversion using integer, decimal, and scientific formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Show( Num( "3.1e6" ), Num( "1989-10-04" ), Num( "5%" ), Num( "£23" ) );


```

**Example 2**

```

Show(
    Num( "3.1e6", <<Restrict ),
    Num( "1989-10-04", <<Restrict ),
    Num( "5%", <<Restrict ),
    Num( "£23", <<Restrict )
);


```

### [Regex](#regex)

**Syntax:** result = Regex( source, pattern, \<format, <IGNORECASE>, <GLOBALREPLACE>> )

**Description:** Searches in the source text for a match to the pattern. The format defaults to "\\0" (the entire match) but could be "Fred" (for a constant replacement) or "\\1" (to use the text matched by the first parenthesis in the pattern). Returns numeric missing for no match. Case must match by default.

**JMP Version Added:** Before version 14

```

Regex(
    "   Are you there Alice?, asked Jerry.",
    " (here|there) (\w+).+(said|asked) (\w+)\.",
    "  I am \1, \4, replied \2."
);


```

### [Remove](#remove)

**Syntax:** y = Remove( x, <i>, \<n=1> ); y = Remove( x, {list} )

**Description:** Returns a copy of list x, deleting n items starting with the ith item or deleting a list of items specified by the list argument.

**JMP Version Added:** Before version 14

```

Remove( {11, 22, 33, 44, 55}, 3, 2 );


```

### [Remove From](#remove-from)

**Syntax:** Remove From( x, <i>, \<n=1> )

**Description:** Modifies list, associative array, or display box x by removing items. Associative arrays specify the item to be removed with a key value i. Lists and display boxes remove starting with the item in position i. A list will remove multiple items at once if the n option is specified. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Remove From( ex, 3, 2 );
ex;


```

**Example 2**

```

ex = ["a" => 10, "b" => 3, "c" => 12, => 0];
Remove From( ex, "c" );
ex;


```

**Example 3**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Remove From( hlist, 1 );


```

### [Repeat](#repeat)

**Syntax:** s = Repeat( x, n, \<m=1> )

**Description:** Returns the text, matrix, or list specified by the x argument concatenated with itself n times. If x is a number or a matrix, then n indicates vertical repetition and the optional argument m designates horizontal repetition.

**JMP Version Added:** Before version 14

```

Show( Repeat( {"A", "B"}, 3 ), Repeat( 2, 3 ), Repeat( 2, 1, 3 ) );


```

### [Reverse](#reverse)

**Syntax:** y = Reverse( x )

**Description:** Returns a copy of list x with the item order reversed.

**JMP Version Added:** Before version 14

```

Reverse( {11, 22, 33, 44, 55} );


```

### [Reverse Into](#reverse-into)

**Syntax:** Reverse Into( x )

**Description:** Modifies list or display box x with the item order reversed. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Reverse Into( ex );
ex;


```

**Example 2**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Reverse Into( hlist );


```

### [Right](#right)

**Syntax:** sub = Right( s, n, <filler> )

**Description:** Returns a truncated or padded version of the original string or list s. The result contains the right n characters or list items, padded with any filler on the left if the length of s is less than n.

**JMP Version Added:** Before version 14

```

Right( "http://www.jmp.com", 3 );


```

### [Set Difference](#set-difference)

**Syntax:** list = Set Difference( list1, list2 )

**Description:** Returns the list of items that occur in list1 but not in list2. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Difference( {1, 3}, {3, 2} ) );
Show( Set Difference( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );


```

### [Set Intersection](#set-intersection)

**Syntax:** list = Set Intersect( list1, list2 )

**Description:** Returns the list of items that occur in both lists. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Intersection( {1, 3}, {3, 2} ) );
Show( Set Intersection( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );
dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << get rows where( Set Intersection( :sports, {"Soccer"} ) != {} );


```

### [Set Union](#set-union)

**Syntax:** list = Set Union( list1, list2 )

**Description:** Returns the list of items that occur in either list. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Union( {1, 3}, {3, 2} ) );
Show( Set Union( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );
all = {};
Open( "$SAMPLE_DATA/Big Class Families.jmp" );
For Each Row( all = Set Union( all, :sports ) );
all = Set Unique( all );
Show( all );


```

### [Set Unique](#set-unique)

**Syntax:** list = Set Unique( list )

**Description:** Returns the list of unique items that occur in the input list. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Unique( {1, 3, 2} ) );
Show( Set Unique( {1, 3, 4, 3, 3, 2, 3, 5, 3} ) );
Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Row() = 1;
Show( Set Unique( :sports ) );


```

### [Shift](#shift)

**Syntax:** y = Shift( x, \<n=1> )

**Description:** Returns a copy of list x with the first n items moved to the end of the list, or, if n is negative, the last n items moved to the start.

**JMP Version Added:** Before version 14

```

Shift( {11, 22, 33, 44, 55}, 2 );


```

### [Shift Into](#shift-into)

**Syntax:** Shift Into( x, \<n=1> )

**Description:** Modifies list or display box x with the first n items moved to the end of the list, or, if n is negative, the last n items moved to the start. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Shift Into( ex, -2 );
ex;


```

**Example 2**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Shift Into( hlist, -2 );


```

### [Starts With](#starts-with)

**Syntax:** b = Starts With( s, sub )

**Description:** Returns 1 if s starts with sub, otherwise returns 0. The s and sub arguments can be both strings or both lists. Equivalent to Left( s, Length( sub )) == sub.

**JMP Version Added:** Before version 14

```

Starts With( "http://www.jmp.com", "http:" );


```

### [Substitute](#substitute)

**Syntax:** y = Substitute( x, patternExpr1, replacementExpr1, ... ) y = Substitute( x, patternString1, replacementString1, ..., < \<<IGNORECASE > )

**Description:** Returns a copy of string, list or expression x, replacing instances of each pattern expression with the corresponding replacement expression. The optional \<<IGNORECASE argument enables case-insensitive matching if x is a string.

**JMP Version Added:** Before version 14

**Example 1**

```

Substitute( Expr( a + Sqrt( a ) ), Expr( a ), Expr( b ) );


```

**Example 2**

```

Substitute( "All things considered", "All", "Some" );


```

**Example 3**

```

lst = {"a", "b", "c"};
Substitute( lst, "a", "A" );


```

**Example 4**

```

Substitute( "All things considered", {"things", "All"}, {"ideas", "Some"} );


```

**Example 5**

```

Substitute( "Apple,orange,banana-grape",
    Items( Get Punctuation Characters() || "-'", "" ), " "
);


```

**Example 6**

```

Substitute( "Apple,APPLE,apple", "apple", "orange", <<IGNORECASE );


```

### [Substitute Into](#substitute-into)

**Syntax:** Substitute Into( x, patternExpr1, replacementExpr1, ... ) Substitute Into( x, patternString1, replacementString1, ..., < \<<IGNORECASE > )

**Description:** Modifies string, list or expression x, replacing instances of each pattern expression with the corresponding replacement expression. Note that the x argument must be a variable. The optional \<<IGNORECASE argument enables case-insensitive matching if x is a string.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = Expr( a + Sqrt( a ) );
Substitute Into( ex, Expr( a ), Expr( b ) );
Name Expr( ex );


```

**Example 2**

```

ex = "All things considered";
Substitute Into( ex, "All", "Some" );
Show( ex );


```

**Example 3**

```

lst = {"a", "b", "c"};
Substitute Into( lst, "a", "A" );
Show( lst );


```

**Example 4**

```

s = "Apple,APPLE,apple";
Substitute Into( s, "apple", "orange", <<IGNORECASE );
Show( s );


```

### [Substr](#substr)

**Syntax:** sub = Substr( s, start, <count> )

**Description:** Returns the part of string s composed of count characters starting at position start. A negative or absent count means the rest of the string. A negative start means starting start characters from the end. The Substr() function can also be applied to lists.

**JMP Version Added:** Before version 14

```

Eval List( {Substr( "undergo", 4 ), Substr( {10, 11, 12, 13, 14}, 2, 3 )} );


```

### [Text Score](#text-score)

**Syntax:** score vector = Text Score( text column, text-to-number, <weighting>, \<{<center>, <scale>, scoring matrix}>);

**Description:** Used to create scoring formulas in Text Explorer. The text-to-number argument is an associative array mapping lowercase words to numbers. The weighting argument is either "Binary", "Ternary", "Count", "LogCount", "LCA" or an array of inverse document frequency weights for TFLogIDF. The scoring matrix must have the same number of columns as words in the associative array, or one more if LCA. The output is a vector of scores. If no scoring matrix is specified, it returns a vector of count scores. If no weighting is specified, it uses Count. This function does not support the Stem for Combining option.

**JMP Version Added:** Before version 14

```

score = Text Score(
    "over the lazy dogs back",
    ["lazy" => 1, "dogs" => 2],
    "Count",
    [1 0, 0 1]
);
Show( score );


```

### [Titlecase](#titlecase)

**Syntax:** st = Titlecase( s )

**Description:** Converts to title case

**JMP Version Added:** Before version 14

```

Titlecase( "The dog crossed the road" );


```

### [Trim](#trim)

**Syntax:** sub = Trim( s, \<left|right|both> )

**Description:** Returns a copy of string s with any leading or trailing whitespace characters removed. The second argument specifies either the leading or trailing whitespace characters. If you do not specify the second argument, whitespace characters are removed from both ends.

**JMP Version Added:** Before version 14

```

Trim( " title   ", both );


```

### [Trim Whitespace](#trim-whitespace)

**Syntax:** sub = Trim Whitespace( s, \<left|right|both> )

**Description:** Returns a copy of string s with any leading or trailing whitespace characters removed. The second argument specifies either the leading or trailing whitespace characters. If you do not specify the second argument, whitespace characters are removed from both ends.

**JMP Version Added:** Before version 14

```

Trim Whitespace( "  The  dog    crossed    the  road  " );


```

### [Uppercase](#uppercase)

**Syntax:** su = Uppercase( s )

**Description:** Converts lowercase letters to uppercase letters in the specified string. Rules for upper and lower case are locale dependent.

**JMP Version Added:** Before version 14

```

Uppercase( "Café #23" );


```

### [Word](#word)

**Syntax:** w = Word( n|[first last], s, <delim>, \<Unmatched(result string)>

**Description:** Returns the nth word of string s, where words are sub-strings separated by any number of any of the characters in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate word.

**JMP Version Added:** Before version 14

**Example 1**

```

Word( 3, "http://www.jmp.com", ":/." );


```

**Example 2**

```

Word( [2 -1], "This is a sentence" );


```

**Example 3**

```

Word( 4, "Apple+Banana Tree,,Pear,,Peach,,Grape", Get Punctuation Characters() );


```

**Example 4**

```

Word( 5, "a b c d", Unmatched( "None" ) );


```

**Example 5**

```

Word( 2, "abcd", "" );


```

### [Words](#words)

**Syntax:** wl = Words( \<[first last]>, s, <delim>)

**Description:** Returns a list of sub-strings separated by any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate word.

**JMP Version Added:** Before version 14

**Example 1**

```

Eval List( {Words( "http://www.jmp.com", ":/." ), Words( "hello", "" )} );


```

**Example 2**

```

Words( "Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

**Example 3**

```

Words( [1 2], "Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

### [XPath Query](#xpath-query)

**Syntax:** result = XPath Query(xml, xpath expression)

**Description:** Runs an XPath query against an XML document.

**JMP Version Added:** Before version 14

```

result = XPath Query(
    "<doc><colors><color>red</color><color>green</color><color>blue</color></colors></doc>",
    "//color/text()"
);


```

# [Comparison](#comparison)

### [Equal](#equal)

**Syntax:** z = x == y == ...; z = Equal( x, y, ... )

**Description:** Returns 1 if each argument is equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 == 1;


```

### [Greater](#greater)

**Syntax:** z = x > y > ... ; z = Greater( x, y, ... )

**Description:** Returns 1 if each argument is greater than the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

3 > 2 > 1;


```

### [Greater or Equal](#greater-or-equal)

**Syntax:** z = x >= y >= ... ; z = Greater or Equal( x, y, ... )

**Description:** Returns 1 if each argument is greater than or equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

3 >= 2 >= 2;


```

### [Is Missing](#is-missing)

**Syntax:** y = Is Missing( x )

**Description:** Returns 1 if the x argument is a missing value; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Missing( . );


```

### [Is Same Color](#is-same-color)

**Syntax:** x = Is Same Color( color1, color2, ... )

**Description:** Compares colors for equality.

**JMP Version Added:** 18

**Example 1**

```

Is Same Color( "black", 0 );


```

**Example 2**

```

Is Same Color( "red", "green", "blue" );


```

**Example 3**

```

Is Same Color( "red", To Color Space( "hls", "red" ) );


```

**Example 4**

```

Is Same Color( To Color Space( "LUV", "red" ), "red" );


```

### [Less](#less)

**Syntax:** z = x < y < ... ; z = Less( x, y, ... )

**Description:** Returns 1 if each argument is less than the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

[1 1 1] < [0 1 2];


```

### [Less LessEqual](#less-lessequal)

**Syntax:** z = x < y \<= ... ; z = Less LessEqual( x, y, ... )

**Description:** Returns 1 if the first argument is less than the second argument and each argument except the first is less than or equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 < 2 <= 2;


```

### [Less or Equal](#less-or-equal)

**Syntax:** z = x \<= y \<= ... ; z = Less or Equal( x, y, ... )

**Description:** Returns 1 if each argument is less than or equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 <= 2 <= 2;


```

### [LessEqual Less](#lessequal-less)

**Syntax:** z = x \<= y < ... ; z = LessEqual Less( x, y, ... )

**Description:** Returns 1 if the first argument is less than or equal to the second argument and each argument except the first is less than the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

2 <= 2 < 3;


```

### [Not Equal](#not-equal)

**Syntax:** z = x != y != ...; z = Not Equal( x, y, ... )

**Description:** Returns 1 if each argument is not equal to the next argument; returns 0 otherwise.

**JMP Version Added:** Before version 14

```

1 != 2 != 1;


```

# [Conditional](#conditional)

### [And](#and)

**Syntax:** y = x1 & x2; y = And( x1, x2, ... )

**Description:** Returns the logical AND of all arguments: 1 if all arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

1 < 2 & 3 < 4;


```

### [AndMZ](#andmz)

**Syntax:** y = AndMZ( x1, x2, ... )

**Description:** Returns the logical AND of all arguments with missing values treated as zeros: 1 if all arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

AndMZ( 1 < 2, 3 < 4 );


```

### [Break](#break)

**Syntax:** Break()

**Description:** Causes a break in flow of control within a For or While loop.

**JMP Version Added:** Before version 14

```

For( i = 1, i <= 10, i++,
    If( i == 5, Break() );
    Print( "i=" || Char( i ) );
);


```

### [Choose](#choose)

**Syntax:** y = Choose( i, expr1, expr2, ..., exprElse )

**Description:** Evaluates and returns the ith expr argument or the exprElse argument if there is no ith expr argument.

**JMP Version Added:** Before version 14

```

Choose( Random Integer( 1, 5 ), "red", "blue", "other" );


```

### [Continue](#continue)

**Syntax:** Continue()

**Description:** Causes a continuation of next iteration of flow of control within a For or While loop.

**JMP Version Added:** Before version 14

```

For( i = 1, i <= 10, i++,
    If( i < 2, Continue() );
    Print( "i=" || Char( i ) );
);


```

### [Filter Each](#filter-each)

**Syntax:** list = Filter Each({<value>, <index>} | {<element>, \<index | {row, col}>} | {\<key | {key, value}>, <index>} | {\<values | {value1, ..., valueN}>, <index>}, list | matrix | associative array | expression | Across( container1, ..., <containerN>, \<Count( "Longest" | "Shortest" | "Enforce Equal" | n )> ), <locals list>, body)

**Description:** Does everything that the For Each function does, but also returns a list of filtered values from the original container based on a boolean value result. The type of the result will match the type of the input container. For Matrix input, a row vector matrix will be returned, since the size of the matrix cannot be known.

**JMP Version Added:** 16

#### [Associative Array](#associative-array)

```

values = Filter Each( {{key, value}}, ["A" => 8, "B" => 6, "C" => 10], value > 6 );
Show( values );


```

#### [Expression](#expression)

```

values = Filter Each( {value}, Expr( MyExpr( 1, 2, 3, 4 ) ), Mod( value, 2 ) == 0 );
Show( values );


```

#### [List](#list)

```

values = Filter Each( {x}, {0, -5, 2, -10, 4}, x > 0 );
Show( values );


```

#### [Matrix](#matrix)

```

values = Filter Each( {x, i}, 100 :: 120, i > 10 );
Show( values );


```

### [For](#for)

**Syntax:** For( initExpr, whileExpr, nextExpr, bodyExpr )

**Description:** Evaluates initExpr once and repeatedly evaluates whileExpr, bodyExpr, and nextExpr as long as whileExpr evaluates to a nonzero value.

**JMP Version Added:** Before version 14

```

s = "";
For( i = 1, i < 10, i++,
    s ||= " " || Char( i )
);
Trim( s );


```

### [For Each](#for-each)

**Syntax:** For Each({<value>, <index>} | {<element>, \<index | {row, col}>} | {\<key | {key, value}>, <index>} | {\<values | {value1, ..., valueN}>, <index>}, list | matrix | associative array | expression | Across( container1, ..., <containerN>, \<Count( "Longest" | "Shortest" | "Enforce Equal" | n )> ), <locals list>, body)

**Description:** Iterates over a container, either a list, matrix, associative array, or expression, providing the value, element, or key at each iteration. The index number is also available at each iteration. For Associative Array containers, the key and value can be accessed using a two-item list. For Matrix containers, a linear index is provided by default, but a two item list can be used to access the row and column indices. These symbols are provided within the body of the loop only, with a built-in Local block. A locals list can also be provided, which are initialized after the first iteration symbols are set.

**JMP Version Added:** 16

#### [Across](#across)

```


// Across multiple containers
x = {1, 3};
y = {2, 4};
For Each( {{a, b}, index}, Across( x, y ), Show( a, b, index ) );

// Across list of containers
xy = {{1, 3}, {2, 4}};
For Each( {{a, b}, index}, Across( xy ), Show( a, b, index ) );


```

#### [Across - Count](#across-count)

```


list1 = {1, 3, 5, 7, 9};
list2 = {2, 4}; 

Write( "\!N===Longest [default]===" );
For Each( {{l1, l2}}, Across( list1, list2, Count( "Longest" ) ), Show( l1, l2 ) );

Write( "\!N===Shortest===" );
For Each( {{s1, s2}}, Across( list1, list2, Count( "Shortest" ) ), Show( s1, s2 ) );

Write( "\!N===N===" );
For Each( {{n1, n2}}, Across( list1, list2, Count( 7 ) ), Show( n1, n2 ) );

Write( "\!N===Enforce Equal===" );
Try(
    For Each( {values}, Across( list1, list2, Count( "Enforce Equal" ) ), Show( values ) ),
    Print( "Error occurred" )
);


```

#### [Associative Array](#associative-array_1)

```

For Each( {{key, value}, index}, ["A" => 8, "B" => 6, "C" => 10], Show( key, value, index ) );


```

#### [Expression](#expression_1)

```

For Each( {value, index}, Expr( MyExpr( 10, 20, 30 ) ), Show( value ) );


```

#### [List](#list_1)

```

For Each( {value, index}, {10, 20, 30}, Show( value, index ) );


```

#### [Matrix](#matrix_1)

```

For Each( {element, {row, col}}, 10 :: 15, Show( element, row, col ) );


```

#### [Matrix - Linear Index](#matrix-linear-index)

```

For Each( {element, index}, 10 :: 15, Show( element, index ) );


```

### [For Each Row](#for-each-row)

**Syntax:** y = For Each Row( <dt>, body )

**Description:** Evaluates the body expression iteratively for each row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( :height = -:height );


```

### [If](#if)

**Syntax:** y = If( condition1, result1, \<condition2, result2>, ..., <elseResult> )

**Description:** Evaluates the first of each pair of arguments and returns the evaluation of the result expression associated with the first condition argument that evaluates to a nonzero result. The condition arguments are evaluated in order. If all of the condition arguments evaluate to zero, the optional elseResult is evaluated and the result is returned. If no elseResult is specified, and none of the conditions are true, a missing value is returned. If all of the condition arguments evaluate to missing, a missing value is returned.

**JMP Version Added:** Before version 14

```

If( Random Uniform() < 0.5,
    "heads",
    "tails"
);


```

### [IfMZ](#ifmz)

**Syntax:** y = IfMZ( condition1, result1, \<condition2, result2>, ..., <elseResult> )

**Description:** Evaluates the first of each pair of arguments and returns the evaluation of the result expression associated with the first condition argument that evaluates to a nonzero result. The condition arguments are evaluated in order. If all condition arguments evaluate to zero or missing, the optional elseResult is evaluated and the result is returned. If no elseResult is specified, and none of the conditions are true, a missing value is returned. (IfMZ() is equivalent to If() where missing values for evaluated condition arguments are treated as zero.)

**JMP Version Added:** Before version 14

```

x = 1;
Show( IfMZ( x == 1, 10, x == 2, 20, 30 ) );
x = .;
Show( IfMZ( x == 1, 10, x == 2, 20, 30 ) );
x = .;
Show( If( x == 1, 10, x == 2, 20, 30 ) );


```

### [IfMax](#ifmax)

**Syntax:** y = IfMax( expr1, result1, expr2, result2, ..., <allMissingResult> )

**Description:** Evaluates the first of each pair of arguments, and returns the evaluation of the result expression associated with the maximum of the expressions. If there are ties, it returns the first maximum. If all expressions are missing, it returns Empty if an even number of arguments, or the last argument if odd. The test expressions must evaluate to numeric, but the result expressions can be anything.

**JMP Version Added:** Before version 14

```

TomScore = 45;
JonScore = 47;
TimScore = 46;
highestScorer = IfMax( TomScore, "Tom", JonScore, "Jon", TimScore, "Tim", "Noone" );


```

### [IfMin](#ifmin)

**Syntax:** y = IfMin( expr1, result1, expr2, result2, ..., <allMissingResult> )

**Description:** Evaluates the first of each pair of arguments, and returns the evaluation of the result expression associated with the minimum of the expressions. If there are ties, it returns the first minimum. If all expressions are missing, it returns Empty if an even number of arguments, or the last argument if odd. The test expressions must evaluate to numeric, but the result expressions can be anything.

**JMP Version Added:** Before version 14

```

TomScore = 45;
JonScore = 47;
TimScore = 46;
lowestScorer = IfMin( TomScore, "Tom", JonScore, "Jon", TimScore, "Tim", "Noone" );


```

### [Interpolate](#interpolate)

**Syntax:** y = Interpolate(x|xmatrix|xlist, x1, y1, x2, y2); y = Interpolate(x | xmatrix | xlist, xmatrix, ymatrix); z = Interpolate({ x, y }, xvector, yvector, zmatrix)

**Description:** Finds the xi arguments that x is between and linearly interpolates the corresponding yi arguments. Note that the xi arguments must be specified in order.

**JMP Version Added:** Before version 14

**Example 1**

```


New Window( "Interpolate",
    window:x = (2 :: 9) * 10;
    window:y = 50 + Sin( (2 :: 9) ) * 40;
    Graph Box(
        Pen Color( "blue" );
        Marker( window:x, window:y );
        Y Function( Interpolate( a, window:x, window:y ), a );
    );
)
;


```

**Example 2**

```

Interpolate( 2.5, [1 2 3], [15, 20, 30] );


```

**Example 3**

```

Interpolate( {.5, .8}, [0 1], [0 1], [10 20, 12 18] );


```

**Example 4**

```


xd = Transpose( Index( 1, 6 * Pi(), 0.3 ) );
yd = Sin( xd );

xd2 = xd + 0.15;
yd2 = Interpolate( xd2, xd, yd );

New Window( "Interpolated values are blue",
    Graph Box(
        X Scale( 1, 6 * Pi() ),
        Y Scale( -1, 1 ),
        For( i = 0, i < N Rows( xd ), i++,
            Pen Color( "red" );
            Circle( {xd[i], yd[i]}, 0.01 );
            Pen Color( "blue" );
            Circle( {xd2[i], yd2[i]}, 0.01 );
        )
    )
);


```

### [Is Associative Array](#is-associative-array)

**Syntax:** y = Is Associative Array( x )

**Description:** Returns 1 is the x argument is an associative array, otherwise returns 0.

**JMP Version Added:** Before version 14

```

Is Associative Array( [1 => 2] );


```

### [Is Class](#is-class)

**Syntax:** isns = Is Class( class reference )

**Description:** Returns 1 if the class argument is a class. Otherwise, a 0 is returned.

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
iscl = Is Class( cl );
Show( iscl );
cl << Delete;
Delete Classes( "complex" );


```

### [Is Empty](#is-empty)

**Syntax:** y = Is Empty( name )

**Description:** Returns 1 if the variable is undefined or holds the Empty() value.

**JMP Version Added:** Before version 14

**Example 1**

```

Is Empty( x );


```

**Example 2**

```

x = Empty();
Is Empty( x );


```

**Example 3**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
If( Is Empty( dt ),
    Print( "There is no open data table." ),
    Print( "This data table is open: " || (dt << Get Name()) )
);
Wait( 1 );
Close( DT, "nosave" );
Wait( 1 );
If( Is Empty( dt ),
    Print( "There is no open data table." ),
    Print( "This data table is open: " || (dt << Get Name()) )
);


```

### [Is Expr](#is-expr)

**Syntax:** y = Is Expr( x )

**Description:** Returns 1 if the x argument is an expression, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Expr( Expr( x ) );


```

### [Is List](#is-list)

**Syntax:** y = Is List( x )

**Description:** Returns 1 if the x argument is a list, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is List( {1, 2, 3} );


```

### [Is Name](#is-name)

**Syntax:** y = Is Name( x )

**Description:** Returns 1 if the x argument is a name, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Name( Name Expr( n ) );


```

### [Is Namespace](#is-namespace)

**Syntax:** isns = Is Namespace( namespace reference )

**Description:** Returns 1 if the namespace argument is a namespace; otherwise a 0 is returned.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
isns = Is Namespace( ns );
Show( isns );
ns << Delete;


```

### [Is Number](#is-number)

**Syntax:** y = Is Number( x )

**Description:** Returns 1 if the x argument is a number, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Number( 213 );


```

### [Is Scriptable](#is-scriptable)

**Syntax:** tf = Is Scriptable( x )

**Description:** Returns 1 if the x argument is a scriptable object, 0 otherwise.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Is Scriptable( Bivariate( Y( :weight ), X( :height ) ) );


```

### [Is String](#is-string)

**Syntax:** y = Is String( x )

**Description:** Returns 1 if the x argument is a string, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is String( "abc" );


```

### [Match](#match)

**Syntax:** y = Match( x, v1, expr1, v2, expr2, ..., exprElse )

**Description:** Evaluates and returns the exprN argument corresponding to the first vN argument that equals x or evaluates and returns the exprElse argument if no value equals x.

**JMP Version Added:** Before version 14

```

Match( Year( Today() ), 2013, "snake", 2014, "horse", 2015, "goat", "other" );


```

### [MatchMZ](#matchmz)

**Syntax:** y = MatchMZ( x, v1, expr1, v2, expr2, ..., exprElse )

**Description:** Evaluates and returns the exprN argument corresponding to the first vN argument that equals x or evaluates and returns the exprElse argument if no value equals x. (The MatchMZ() function behaves the same as the Match() function, except that missing values are treated as 0.)

**JMP Version Added:** Before version 14

```

MatchMZ( Year( Today() ), 2013, "snake", 2014, "horse", 2015, "goat", "other" );


```

### [Not](#not)

**Syntax:** y = !x; y = Not( x )

**Description:** Returns the logical NOT of x: 1 if x is zero, missing if x is missing, and 0 otherwise.

**JMP Version Added:** Before version 14

```

!(1 < 2);


```

### [Or](#or)

**Syntax:** y = x1 | x2; y = Or( x1, x2, ... )

**Description:** Returns the logical OR of all arguments: 1 if any arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

1 < 2 | 3 < 2;


```

### [OrMZ](#ormz)

**Syntax:** y = OrMZ( x1, x2, ... )

**Description:** Returns the logical OR of all arguments with missing values treated as zeros: 1 if any arguments are nonzero and 0 otherwise.

**JMP Version Added:** Before version 14

```

OrMZ( 1 < 2, 3 < 2 );


```

### [Return](#return)

**Syntax:** Return(<Expr>, ..., <ExprN>)

**Description:** Returns an expression value from a user-defined function.

**JMP Version Added:** Before version 14

**Example 1**

```

vr = Function( {},
    x = 2;
    y = 4;
    Return( Char( x * y ) );
);
lvr = Function( {},
    x = 2;
    y = 4;
    For( i = 1, i < 5, i++,
        If( i == 3,
            Return( i * x * y )
        )
    );
);
nr = Function( {}, Return() );
vrv = vr();
lvrv = lvr();
nrv = nr();
Show( vrv, lvrv, nrv );


```

**Example 2**

```

f = Function( {a, b},
    Return( a - b, a + b )
);
{lo, hi} = f( 10, 1 );
Show( lo, hi );
Show( f( 7, 15 ) );


```

### [Step](#step)

**Syntax:** y = Step( x, x1, y1, x2, y2, ... ) y = Step( x, [x1, x2, ...], [y1, y2, ...] )

**Description:** Returns the yi argument corresponding to the largest xi value which satisfies xi less than or equal to the x argument. Note that the xi arguments must be specified in order.

**JMP Version Added:** Before version 14

```

Step( 2.5, [1 2 3], [15, 20, 30] );


```

### [Stop](#stop)

**Syntax:** Stop()

**Description:** Immediately terminates the execution of a JSL script

**JMP Version Added:** Before version 14

```

For( i = 1, i <= 10, i++,
    If( i == 7, Stop() );
    Print( "i=" || Char( i ) );
);


```

### [Transform Each](#transform-each)

**Syntax:** list = Transform Each({<value>, <index>} | {<element>, \<index | {row, col}>} | {\<key | {key, value}>, <index>} | {\<values | {value1, ..., valueN}>, <index>}, list | matrix | associative array | expression | Across( container1, ..., <containerN>, \<Count( "Longest" | "Shortest" | "Enforce Equal" | n )> ), \<Output( "List" | "Matrix" | "Associative Array" | "Expression", <expr head name> )>, <locals list>, body)

**Description:** Does everything the For Each function does, but also returns a container with the result at each iteration. By default, returns a container matching the type of the input container, but can be changed using the Output argument. For List or Expression output, Empty() will be used when there is no result. For Matrix output, a numeric missing value is used when there is no result, or when the result is non-numeric. For Associative Array output, the key will not exist when there is no result. When Continue() is used, it is equivalent to returning no value for that iteration.

**JMP Version Added:** 16

#### [Associative Array](#associative-array_2)

```

values = Transform Each( {{key, value}}, ["A" => 8, "B" => 6, "C" => 10], value + 1 );
Show( values );


```

#### [Expression 1](#expression-1)

```

ex = Transform Each( {value}, Expr( MyExpr( 10, 20, 30 ) ), value + 1 );
Show( ex );


```

#### [Expression 2](#expression-2)

```

// Find Functions defined in a script
parsedScript = Include( "$SAMPLE_SCRIPTS/BayesPlotForFactors.jsl", <<ParseOnly );
functionNames = Transform Each( {statement}, Name Expr( parsedScript ), Output( "List" ),
    {lhs, rhs},
    If( Head( statement ) == Expr( Assign() ),
        rhs = Arg( statement, 2 );
        If( !Is Empty( rhs ) & Contains( {Function()}, Head( rhs ) ),
            Head Name( Arg( statement, 1 ) ),
            Empty()
        );
    ,
        Empty()
    )
);
functionNames = Filter Each( {f}, functionNames, !Is Empty( f ) );
Show( functionNames );


```

#### [List](#list_2)

```

values = Transform Each( {value}, {10, 20, 30}, value + 5 );
Show( values );


```

#### [Matrix](#matrix_2)

```

values = Transform Each( {element}, 10 :: 15, element + 5 );
Show( values );


```

#### [Output](#output)

```


Write( "\!N===List===" );
lst = Transform Each( {value}, [10, 20, 30], Output( "List" ), value + 1 );
Show( lst );

Write( "\!N===Matrix===" );
mat = Transform Each( {value}, {10, 20, 30}, Output( "Matrix" ), value + 1 );
Show( mat );

Write( "\!N===Associative Array===" );
aa = Transform Each( {value}, {10, 20, 30}, Output( "Associative Array" ), value + 1 );
Show( aa );

Write( "\!N===Expression===" );
ex = Transform Each( {value}, {10, 20, 30}, Output( "Expression", "My Values" ), value + 1 );
Show( ex );


```

### [While](#while)

**Syntax:** While( testExpr, bodyExpr )

**Description:** Evaluates the testExpr and bodyExpr expressions repeatedly as long as testExpr evaluates to a nonzero value.

**JMP Version Added:** Before version 14

```

i = 1;
s = "";
While( i < 1000,
    s ||= " " || Char( i );
    i *= 2;
);
s;


```

### [Zero Or Missing](#zero-or-missing)

**Syntax:** y = Zero Or Missing( x )

**Description:** Returns the logical NOT of x with missing values treated as zeros: 1 if x is missing or zero and 0 otherwise.

**JMP Version Added:** Before version 14

```

Zero Or Missing( 1 < 2 );


```

# [Constant](#constant)

### [Pi](#pi)

**Syntax:** y = Pi()

**Description:** Returns the mathematical constant π, accurate to approximately 15 decimal digits: 3.1415926535....

**JMP Version Added:** Before version 14

```

Char( Pi(), 5 );


```

### [e](#e)

**Syntax:** y = e()

**Description:** Returns the mathematical constant e, accurate to approximately 15 decimal digits: 2.7182818....

**JMP Version Added:** Before version 14

```

Round( e(), 10 );


```

# [Date Time](#date-time)

### [Abbrev Date](#abbrev-date)

**Syntax:** s = Abbrev Date( datetime, <format> )

**Description:** Returns an abbreviated locale-specific representation of a date-time value.

**JMP Version Added:** Before version 14

```

Abbrev Date( Today() );


```

### [As Date](#as-date)

**Syntax:** dt = As Date( datetime )

**Description:** Returns a date-time value marked internally as a date for output purposes.

**JMP Version Added:** Before version 14

```

As Date( Today() );


```

### [Date DMY](#date-dmy)

**Syntax:** z = Date DMY( d, m, y )

**Description:** Converts day, month, and year into a JMP date-time value, which is the number of seconds since 01Jan1904.

**JMP Version Added:** Before version 14

```

As Date( Date DMY( 15, 7, 2000 ) );


```

### [Date Difference](#date-difference)

**Syntax:** delta = Date Difference( dt1, dt2, intervalName, \<alignment="start"> )

**Description:** Returns the difference in intervals of two date/time values. Supported values of intervalName are "Year", "Quarter", "Month", "Week", "Day", "Hour", "Minute", "Second", and "Numeric". An alignment of "Start" includes full or partial intervals, while "Actual" only includes full intervals. An alignment of "Fractional" returns fractional differences, using averages for the duration of "Year", "Quarter", and "Month" intervals.

**JMP Version Added:** Before version 14

**Example 1**

```

Date Difference( Date DMY( 31, 1, 2015 ), Date DMY( 1, 3, 2015 ), "Month", "start" );


```

**Example 2**

```

Date Difference( Date DMY( 31, 1, 2015 ), Date DMY( 1, 3, 2015 ), "Month", "actual" );


```

**Example 3**

```

Date Difference( Date DMY( 31, 1, 2015 ), Date DMY( 1, 3, 2015 ), "Month", "fractional" );


```

### [Date Increment](#date-increment)

**Syntax:** d = Date Increment( datetime, intervalName, \<incr=1>, \<alignment="start"> )

**Description:** Returns a new date-time value by adding incr number of intervals. Supported values of intervalName are "Year", "Quarter", "Month", "Week", "Day", "Hour", "Minute", "Second", and "Numeric". An alignment of "Start" truncates to the nearest interval prior to adding the increment, while "Actual" retains the full input date/time. An alignment of "Fractional" allows fractional incr values, using averages for the duration of "Year", "Quarter", and "Month" intervals.

**JMP Version Added:** Before version 14

**Example 1**

```

Date Increment( Today(), "Month", 100, "start" );


```

**Example 2**

```

Date Increment( Today(), "Month", 100, "actual" );


```

**Example 3**

```

Date Increment( Today(), "Month", 100, "fractional" );


```

### [Date MDY](#date-mdy)

**Syntax:** z = Date MDY( m, d, y )

**Description:** Converts month, day, and year into a JMP date value, which is the number of seconds since 01Jan1904.

**JMP Version Added:** Before version 14

```

As Date( Date MDY( 7, 15, 2000 ) );


```

### [Day](#day)

**Syntax:** d = Day( datetime )

**Description:** Returns the day of month part of a date-time value, 1 - 31.

**JMP Version Added:** Before version 14

```

Day( Today() );


```

### [Day Of Week](#day-of-week)

**Syntax:** d = Day Of Week( datetime )

**Description:** Returns the day of the week of a date-time value. Sunday = 1, ..., Saturday = 7.

**JMP Version Added:** Before version 14

```

Day Of Week( Today() );


```

### [Day Of Year](#day-of-year)

**Syntax:** d = Day Of Year( datetime )

**Description:** Returns the day of the year of a date-time value. January 1 is 1.

**JMP Version Added:** Before version 14

```

Day Of Year( Today() );


```

### [Days In Month](#days-in-month)

**Syntax:** v = Days In Month(year, month)

**Description:** Return the number of days in a given month.

**JMP Version Added:** 15

```

v = Days In Month( 2016, 2 );


```

### [Format](#format)

**Syntax:** s = Format( x, formatString, <options> ) s = Format( x, "Format Pattern", pattern, <options> )

**Description:** Returns the number in the specified format. Formats include items in the Column Info dialog, such as "Best" and "h:m:s". See Topic Help for other options, including p-value, currency, date and time, and geographic formats.

**JMP Version Added:** Before version 14

#### [Date Time](#date-time_1)

```

Print( Format( Today(), "yyyyQq" ), Format( Today(), "m/d/y h:m" ) );


```

#### [Format Pattern](#format-pattern)

```

Print( Format( Today(), "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm><:><ss>" ) );


```

#### [Full Precision](#full-precision)

```

Show( Format( 88.54, "Best" ), Format( 88.54, "Best", "Full Precision" ) );


```

#### [Percent, Currency](#percent-currency)

```

pct = Format( 0.123, "Percent", 2 );
amt = Format( 123.4567, "Currency", "EUR", 2 );
result = "Revenue increase: " || amt || " or " || pct || ".";


```

### [Format Date](#format-date)

**Syntax:** s = Format( x, formatString, <options> ) s = Format( x, "Format Pattern", pattern, <options> )

**Description:** Returns the number in the specified format. Formats include items in the Column Info dialog, such as "Best" and "h:m:s". See Topic Help for other options, including p-value, currency, date and time, and geographic formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Print( Format( Today(), "yyyyQq" ), Format( Today(), "m/d/y h:m" ) );


```

**Example 2**

```

Print( Format( Today(), "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm><:><ss>" ) );


```

**Example 3**

```

pct = Format( 0.123, "Percent", 2 );
amt = Format( 123.4567, "Currency", "EUR", 2 );
result = "Revenue increase: " || amt || " or " || pct || ".";


```

### [HP Time](#hp-time)

**Syntax:** t = HP Time()

**Description:** Returns a High Precision time value in microseconds. Only useful relative to another HP Time() value. The time value represents the number of microseconds since the start of the JMP session.

**JMP Version Added:** Before version 14

```

bt = HP Time();
Open( "$SAMPLE_DATA/Big Class.jmp" );
et = HP Time();
it = et - bt;
Show( it );


```

### [Hour](#hour)

**Syntax:** hr = Hour( datetime, \<12> )

**Description:** Returns the hours part of a date-time value, in 12-hour mode (12, 1 - 11) or 24-hour mode (0 - 23).

**JMP Version Added:** Before version 14

```

Hour( Today() );


```

### [ISO Year](#iso-year)

**Syntax:** yr = ISO Year( datetime )

**Description:** Returns the ISO Year of a date-time value. ISO Years correspond to ISO Weeks; they begin on the Monday of the first week containing at least four days.

**JMP Version Added:** 16

```

ISO Year( Today() );


```

### [In Days](#in-days)

**Syntax:** y = In Days( \<x=1> )

**Description:** Converts x from a number of days to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Days( 1.5 );


```

### [In Hours](#in-hours)

**Syntax:** y = In Hours( \<x=1> )

**Description:** Converts x from a number of hours to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Hours( 0.5 );


```

### [In Minutes](#in-minutes)

**Syntax:** y = In Minutes( \<x=1> )

**Description:** Converts x from a number of minutes to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Minutes( 1 );


```

### [In Weeks](#in-weeks)

**Syntax:** y = In Weeks( \<x=1> )

**Description:** Converts x from a number of weeks to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Weeks( 1 );


```

### [In Years](#in-years)

**Syntax:** y = In Years( \<x=1> )

**Description:** Converts x from a number of years to the equivalent number of seconds.

**JMP Version Added:** Before version 14

```

In Years( 1 );


```

### [Informat](#informat)

**Syntax:** dt = In Format( s, formatString, < \<<Use Locale(b=1)>, < \<<Restrict > ) dt = In Format( s, "Format Pattern", pattern, < \<<Use Locale(b=1)> )

**Description:** Parses a string of a given format. If the format is a date-time format, the value is expressed as if surrounded by As Date(), returning the date in ddMonyyyy format. The optional \<<Restrict used with the "Best" formatString only allows conversion using integer, decimal, and scientific formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Informat( "07152000", "MMDDYYYY" );


```

**Example 2**

```

Informat( "07.15.2000", "Format Pattern", "<MM>.<DD>.<YYYY>" );


```

**Example 3**

```

Informat( "86.8287° W", "Longitude DDD" );


```

**Example 4**

```

Informat( "123.45%", "Percent" );


```

**Example 5**

```

Show(
    Informat( "1.23e4", "Best" ),
    Informat( "1.23e4", "Best", <<Restrict ),
    Informat( "1989-10-04", "Best" ),
    Informat( "1989-10-04", "Best", <<Restrict )
);


```

### [Is Leap Year](#is-leap-year)

**Syntax:** v = Is Leap Year(year)

**Description:** Return whether a given year is a leap year.

**JMP Version Added:** 15

```

v = Is Leap Year( 2016 );


```

### [Long Date](#long-date)

**Syntax:** s = Long Date( datetime, <format> )

**Description:** Returns a long locale-specific representation of a date-time value.

**JMP Version Added:** Before version 14

```

Long Date( Today() );


```

### [MDYHMS](#mdyhms)

**Syntax:** s = MDYHMS( datetime, <format> )

**Description:** Returns a representation of a date-time value with the ordering: month, day, year, hour, minute, second.

**JMP Version Added:** Before version 14

```

MDYHMS( Today() );


```

### [Minute](#minute)

**Syntax:** min = Minute( datetime )

**Description:** Returns the minutes part of a date-time value, 0 - 59.

**JMP Version Added:** Before version 14

```

Minute( Today() );


```

### [Month](#month)

**Syntax:** mon = Month( datetime )

**Description:** Returns the month part of a date-time value, 1 - 12.

**JMP Version Added:** Before version 14

```

Month( Today() );


```

### [Nth Day Of Week in the Month](#nth-day-of-week-in-the-month)

**Syntax:** n = Nth Day Of Week in the Month( datetime )

**Description:** Returns an integer that represents the number of instances of the day of the week of the datetime argument that have occurred in the month. For example, November 28, 2019 is the 4th Thursday of the month, so the function returns 4.

**JMP Version Added:** 16

```

Nth Day Of Week in the Month( Date MDY( 11, 28, 2019 ) );


```

### [Parse Date](#parse-date)

**Syntax:** dt = In Format( s, formatString, < \<<Use Locale(b=1)>, < \<<Restrict > ) dt = In Format( s, "Format Pattern", pattern, < \<<Use Locale(b=1)> )

**Description:** Parses a string of a given format. If the format is a date-time format, the value is expressed as if surrounded by As Date(), returning the date in ddMonyyyy format. The optional \<<Restrict used with the "Best" formatString only allows conversion using integer, decimal, and scientific formats.

**JMP Version Added:** Before version 14

**Example 1**

```

Informat( "07152000", "MMDDYYYY" );


```

**Example 2**

```

Informat( "07.15.2000", "Format Pattern", "<MM>.<DD>.<YYYY>" );


```

**Example 3**

```

Informat( "86.8287° W", "Longitude DDD" );


```

**Example 4**

```

Informat( "123.45%", "Percent" );


```

**Example 5**

```

Show(
    Informat( "1.23e4", "Best" ),
    Informat( "1.23e4", "Best", <<Restrict ),
    Informat( "1989-10-04", "Best" ),
    Informat( "1989-10-04", "Best", <<Restrict )
);


```

### [Quarter](#quarter)

**Syntax:** q = Quarter( datetime )

**Description:** Returns the quarter part of a date-time value, 1 - 4.

**JMP Version Added:** Before version 14

```

Quarter( Today() );


```

### [Second](#second)

**Syntax:** sec = Second( datetime )

**Description:** Returns the seconds part of a date-time value, including any fractional part, 0 - 60 exclusive.

**JMP Version Added:** Before version 14

```

Second( Today() );


```

### [Short Date](#short-date)

**Syntax:** s = Short Date( datetime, <format> )

**Description:** Returns a numeric (MM/DD/YYYY) locale-specific representation of a date-time value.

**JMP Version Added:** Before version 14

```

Short Date( Today() );


```

### [Tick Seconds](#tick-seconds)

**Syntax:** t = Tick Seconds()

**Description:** Returns a time value in seconds, usually accurate to at least 1/60 of a second (a "tick"), depending on the computer. Only useful relative to another Tick Seconds() value.

**JMP Version Added:** Before version 14

```

t1 = Tick Seconds();
Open( "$SAMPLE_DATA/Big Class.jmp" );
t2 = Tick Seconds();
Round( t2 - t1, 3 );


```

### [Time Of Day](#time-of-day)

**Syntax:** sec = Time Of Day( datetime )

**Description:** Returns the time part of a date-time value, including any fractional seconds.

**JMP Version Added:** Before version 14

```

Format( Time Of Day( Today() ), "h:m:s" );


```

### [Today](#today)

**Syntax:** dt = Today()

**Description:** Returns the date-time value of the current moment.

**JMP Version Added:** Before version 14

```

As Date( Today() );


```

### [Week Of Year](#week-of-year)

**Syntax:** d = Week Of Year( datetime, \<rule=1> )

**Description:** Returns the week of the year containing a date-time value using one of three rules. By default (rule 1), weeks start on Sunday with the first Sunday of the year being week 2. Week 1 will be a partial week or empty (as in 2006). For rule 2, the first Sunday is week 1, with previous days being week 0. For rule 3, the ISO week number is returned, where weeks start on Monday and week 1 is the first week of the year with four days in that year. With ISO weeks, it's possible for the first or last three days of the year to belong to the neighboring year's week number.

**JMP Version Added:** Before version 14

**Example 1**

```

Week Of Year( Today() );


```

**Example 2**

```

Show(
    Week Of Year( 01jan2012, 1 ),
    Week Of Year( 01jan2012, 2 ),
    Week Of Year( 01jan2012, 3 )
);


```

### [Year](#year)

**Syntax:** yr = Year( datetime )

**Description:** Returns the year part of a date-time value.

**JMP Version Added:** Before version 14

```

Year( Today() );


```

# [Discrete Probability](#discrete-probability)

### [Beta Binomial Distribution](#beta-binomial-distribution)

**Syntax:** cumprob = Beta Binomial Distribution( k, p, n, delta )

**Description:** Returns the probability that a Beta Binomial distributed random variable is less than or equal to k.

**JMP Version Added:** Before version 14

```

p = 0.5;
n = 25;
delta = 0;
New Window( "Example: BetaBinomial Distribution",
    y = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, n + 1 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= n, k++,
            H Line( k, k + 1, Beta Binomial Distribution( k, p, n, delta ) );
            V Line(
                k + 1,
                Beta Binomial Distribution( k, p, n, delta ),
                Beta Binomial Distribution( k + 1, p, n, delta )
            );
        );
        Text( {15, 0.1}, "n=", Round( n ), " p=", Round( p, 2 ) );
        Text( {15, 0.04}, "Dispersion=", Round( delta, 2 ) );
    ),
    H List Box( Slider Box( 0.01, 0.99, p, y << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( -0.01, 0.99, delta, y << reshow ), Text Box( " Dispersion" ) )
);


```

### [Beta Binomial Probability](#beta-binomial-probability)

**Syntax:** prob = Beta Binomial Probability( k, p, n, delta )

**Description:** Returns the probability that a Beta Binomial distributed random variable is equal to k.

**JMP Version Added:** Before version 14

```

n = 25;
p = 0.5;
delta = 0;
New Window( "Binomial and BetaBinomial Probabilities",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, n + 1 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( x = 0, x <= n, x++,
            Pen Color( "red" );
            V Line( x, 0, Binomial Probability( p, n, x ) );
            Pen Color( "blue" );
            V Line( x + 0.35, 0, Beta Binomial Probability( x, p, n, delta ) );
        );
        Text( {1, 0.25}, "p=", Round( p, 8 ), " Dispersion=", Round( delta, 8 ) );
        Text( {0, 0.28}, "Red = Binomial, Blue = BetaBinomial" );
    ),
    H List Box( Slider Box( 0.2, 0.8, p, clty << reshow ), Text Box( " p" ) ),
    H List Box(
        Slider Box( -0.05, 0.999, delta, clty << reshow ),
        Text Box( " Dispersion" )
    )
);


```

### [Beta Binomial Quantile](#beta-binomial-quantile)

**Syntax:** q = Beta Binomial Quantile( p, n, delta, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Beta Binomial( p, n, delta ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qbinexp = 0.3;
qbinexn = 20;
qbinexq = 0.5;
delta = 0;
New Window( "Example: BetaBinomial Quantile",
    qbinexy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qbinexk = 0, qbinexk < Round( qbinexn ), qbinexk++,
            H Line(
                qbinexk,
                qbinexk + 1,
                Beta Binomial Distribution( qbinexk, qbinexp, Round( qbinexn ), delta )
            );
            V Line(
                qbinexk + 1,
                Beta Binomial Distribution( qbinexk, qbinexp, Round( qbinexn ), delta ),
                Beta Binomial Distribution( qbinexk + 1, qbinexp, Round( qbinexn ), delta )
            );
        );
        Pen Color( "blue" );
        V Line( Beta Binomial Quantile( qbinexp, Round( qbinexn ), delta, qbinexq ), 0, 1 );
        Text(
            {6, 0.17},
            "n=",
            Round( qbinexn ),
            " p=",
            Round( qbinexp, 2 ),
            " Disp.=",
            Round( Delta, 2 ),
            " q=",
            Round( qbinexq, 2 )
        );
        Text(
            {6, 0.1},
            "quantile=",
            Round( Beta Binomial Quantile( qbinexp, Round( qbinexn ), delta, qbinexq ) )
        );
    ),
    H List Box( Slider Box( 0, 0.99, qbinexp, qbinexy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 40, qbinexn, qbinexy << reshow ), Text Box( " n" ) ),
    H List Box(
        Slider Box( -0.01, 0.99, delta, qbinexy << reshow ),
        Text Box( " Dispersion" )
    ),
    H List Box( Slider Box( 0, 1, qbinexq, qbinexy << reshow ), Text Box( " q" ) )
);


```

### [Binomial Distribution](#binomial-distribution)

**Syntax:** cumprob = Binomial Distribution( p, n, k )

**Description:** Returns the probability that a Binomially distributed random variable is less than or equal to k.

**JMP Version Added:** Before version 14

```

p = 0.5;
n = 30;
New Window( "Example: Binomial Distribution",
    y = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 31 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= n, k++,
            H Line( k, k + 1, Binomial Distribution( p, n, k ) );
            V Line(
                k + 1,
                Binomial Distribution( p, n, k ),
                Binomial Distribution( p, n, k + 1 )
            );
        );
        Text( {20, 0.1}, "n=", Round( n ), " p=", Round( p, 2 ) );
    ),
    H List Box( Slider Box( 0, 1, p, y << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 30, n, y << reshow ), Text Box( " n" ) )
);


```

### [Binomial Probability](#binomial-probability)

**Syntax:** prob = Binomial Probability( p, n, k )

**Description:** Returns the probability that a Binomially distributed random variable is equal to k.

**JMP Version Added:** Before version 14

```

cltp = 0.03;
cltn = 30;
New Window( "Example: Binomial Probability and Central Limit Theorem",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 60 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( cltk = 0, cltk <= cltn, cltk++,
            V Line( cltk, 0, Binomial Probability( cltp, cltn, cltk ) )
        );
        Text( {15, 0.09}, "n=", Round( cltn ), " p=", Round( cltp, 2 ) );
    ),
    H List Box( Slider Box( 0.01, 0.99, cltp, clty << reshow ), Text Box( " p" ) ),
    H List Box(
        Slider Box( 0, 2000, cltn, clty << reshow ),
        Text Box( " n ( Drag me and see Central Limit Theorem )" )
    )
);


```

### [Binomial Quantile](#binomial-quantile)

**Syntax:** q = Binomial Quantile( p, n, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Binomial( p, n ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qbinexp = 0.3;
qbinexn = 20;
qbinexq = 0.5;
New Window( "Example: Binomial Quantile",
    qbinexy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qbinexk = 0, qbinexk < Round( qbinexn ), qbinexk++,
            H Line(
                qbinexk,
                qbinexk + 1,
                Binomial Distribution( qbinexp, Round( qbinexn ), qbinexk )
            );
            V Line(
                qbinexk + 1,
                Binomial Distribution( qbinexp, Round( qbinexn ), qbinexk ),
                Binomial Distribution( qbinexp, Round( qbinexn ), qbinexk + 1 )
            );
        );
        Pen Color( "blue" );
        V Line( Binomial Quantile( qbinexp, Round( qbinexn ), qbinexq ), 0, 1.0 );
        Text(
            {6, 0.17},
            "n=",
            Round( qbinexn ),
            " p=",
            Round( qbinexp, 2 ),
            " q=",
            Round( qbinexq, 2 ),
            " quantile=",
            Round( Binomial Quantile( qbinexp, Round( qbinexn ), qbinexq ) )
        );
    ),
    H List Box( Slider Box( 0, 1, qbinexp, qbinexy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 40, qbinexn, qbinexy << reshow ), Text Box( " n" ) ),
    H List Box( Slider Box( 0, 1, qbinexq, qbinexy << reshow ), Text Box( " q" ) )
);


```

### [Gamma Poisson Distribution](#gamma-poisson-distribution)

**Syntax:** cumprob = Gamma Poisson Distribution( k, lambda, sigma )

**Description:** Returns the probability that a gamma Poisson distributed random variable is less than or equal to k, where lambda is the mean parameter, sigma is the overdispersion parameter, and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 20;
sigma = 2;
New Window( "Example: Gamma Poisson Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, Gamma Poisson Distribution( k, lambda, sigma ) );
            V Line(
                k + 1,
                Gamma Poisson Distribution( k, lambda, sigma ),
                Gamma Poisson Distribution( k + 1, lambda, sigma )
            );
        );
        Text( {2, 0.95}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {2, 0.87}, "\!U03C3=", Round( sigma, 2 ) );
    ),
    H List Box( Slider Box( 3, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 1, 5, sigma, ppy << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Gamma Poisson Probability](#gamma-poisson-probability)

**Syntax:** prob = Gamma Poisson Probability( k, lambda, sigma )

**Description:** Returns the probability that a gamma Poisson distributed random variable is equal to k, where lambda is the mean parameter, sigma is the overdispersion parameter, and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 5;
sigma = 2;
New Window( "Poisson and Gamma Poisson",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 20.5 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( x = 0, x <= 20, x++,
            Pen Color( "red" );
            V Line( x, 0, Poisson Probability( lambda, x ) );
            Pen Color( "blue" );
            V Line( x + 0.35, 0, Gamma Poisson Probability( x, lambda, sigma ) );
        );
        Text( {1, 0.25}, "\!U03BB=", Round( lambda, 8 ), " \!U03C3=", Round( sigma, 8 ) );
        Text( {0, 0.28}, "Red = Poisson, Blue = Gamma Poisson" );
    ),
    H List Box( Slider Box( 3, 10, lambda, clty << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 1, 5, sigma, clty << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Gamma Poisson Quantile](#gamma-poisson-quantile)

**Syntax:** q = Gamma Poisson Quantile( lambda, sigma, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Gamma Poisson( lambda, sigma ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qexpl = 20;
qexps = 2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: Gamma Poisson Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, Gamma Poisson Distribution( qexpk, qexpl, qexps ) );
            V Line(
                qexpk + 1,
                Gamma Poisson Distribution( qexpk, qexpl, qexps ),
                Gamma Poisson Distribution( qexpk + 1, qexpl, qexps )
            );
        );
        Pen Color( "blue" );
        V Line( Gamma Poisson Quantile( qexpl, qexps, qexpq ), 0, 1 );
        Text( {1, 0.9}, " \!U03BB=", Round( qexpl, 2 ), " \!U03C3=", Round( qexps, 2 ) );
        Text(
            {1, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( Gamma Poisson Quantile( qexpl, qexps, qexpq ) )
        );
    ),
    H List Box( Slider Box( 3, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 1, 5, qexps, qexpy << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [Hypergeometric Distribution](#hypergeometric-distribution)

**Syntax:** cumprob = Hypergeometric Distribution( N, K, n, x, <r> )

**Description:** Returns the probability that a hypergeometrically distributed random variable is less than or equal to x, where N is the population size, K is the number of items in the category of interest, n is the sample size, x is the count of interest, and r is the optional odds ratio.

**JMP Version Added:** Before version 14

```

exhdK = 10;
exhdn = 10;
New Window( "Example: Hypergeometric Distribution",
    exy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 21 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exhdx = 0, exhdx < Round( exhdn ), exhdx++,
            H Line(
                exhdx,
                exhdx + 1,
                Hypergeometric Distribution( 20, Round( exhdK ), Round( exhdn ), exhdx )
            );
            V Line(
                exhdx + 1,
                Hypergeometric Distribution( 20, Round( exhdK ), Round( exhdn ), exhdx ),
                Hypergeometric Distribution( 20, Round( exhdK ), Round( exhdn ), exhdx + 1 )
            );
        );
        Text( {10, 0.17}, "N=", 20, " K=", Round( exhdK ), " n=", Round( exhdn ) );
    ),
    H List Box( Slider Box( 0, 20, exhdK, exy << reshow ), Text Box( " K" ) ),
    H List Box( Slider Box( 0, 20, exhdn, exy << reshow ), Text Box( " n" ) )
);


```

### [Hypergeometric Probability](#hypergeometric-probability)

**Syntax:** prob = Hypergeometric Probability( N, K, n, x, <r> )

**Description:** Returns the probability that a hypergeometrically distributed random variable is equal to x, where N is the population size, K is the number of items in the category of interest, n is the sample size, x is the count of interest, and r is the optional odds ratio.

**JMP Version Added:** Before version 14

```

exhdK = 10;
exhdn = 10;
New Window( "Example: Hypergeometric Probability",
    exhdy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 21 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exhdx = 0, exhdx <= Round( exhdn ), exhdx++,
            V Line(
                exhdx,
                0,
                Hypergeometric Probability( 20, Round( exhdK ), Round( exhdn ), exhdx )
            )
        );
        Text( {10, 0.17}, "N=", 20, " K=", Round( exhdK ), " n=", Round( exhdn ) );
    ),
    H List Box( Slider Box( 0, 20, exhdK, exhdy << reshow ), Text Box( " K" ) ),
    H List Box( Slider Box( 0, 20, exhdn, exhdy << reshow ), Text Box( " n" ) )
);


```

### [Neg Binomial Distribution](#neg-binomial-distribution)

**Syntax:** cumprob = Neg Binomial Distribution( p, n, k )

**Description:** Returns the probability that a negative binomially distributed random variable is less than or equal to k, where the probability of success is p and the number of successes is n.

**JMP Version Added:** Before version 14

```

exnbdp = 0.5;
exnbdn = 10;
New Window( "Example: Neg Binomial Distribution",
    exnbdy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exnbdk = 0, exnbdk < 100, exnbdk++,
            H Line(
                exnbdk,
                exnbdk + 1,
                Neg Binomial Distribution( exnbdp, Round( exnbdn ), exnbdk )
            );
            V Line(
                exnbdk + 1,
                Neg Binomial Distribution( exnbdp, Round( exnbdn ), exnbdk ),
                Neg Binomial Distribution( exnbdp, Round( exnbdn ), exnbdk + 1 )
            );
        );
        Text( {30, 0.07}, "n=", Round( exnbdn ), " p=", Round( exnbdp, 2 ) );
    ),
    H List Box( Slider Box( 0, 1, exnbdp, exnbdy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 1, 20, exnbdn, exnbdy << reshow ), Text Box( " n" ) )
);


```

### [Neg Binomial Probability](#neg-binomial-probability)

**Syntax:** prob = Neg Binomial Probability( p, n, k )

**Description:** Returns the probability that a negative binomially distributed random variable is equal to k, where the probability of success is p and the number of successes is n.

**JMP Version Added:** Before version 14

```

exnbpp = 0.5;
exnbpn = 10;
New Window( "Example: Neg Binomial Probability",
    exnbpy = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exnbpk = 0, exnbpk < 100, exnbpk++,
            V Line( exnbpk, 0, Neg Binomial Probability( exnbpp, exnbpn, exnbpk ) )
        );
        Text( {30, 0.27}, "n=", Round( exnbpn ), " p=", Round( exnbpp, 2 ) );
    ),
    H List Box( Slider Box( 0, 1, exnbpp, exnbpy << reshow ), Text Box( " p" ) ),
    H List Box( Slider Box( 0, 40, exnbpn, exnbpy << reshow ), Text Box( " n" ) )
);


```

### [Negative Binomial Distribution](#negative-binomial-distribution)

**Syntax:** cumprob = Negative Binomial Distribution( k, lambda, sigma )

**Description:** Returns the probability that a Negative Binomial distributed random variable is less than or equal to k, where lambda is the location parameter, sigma is the scale parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 20;
sigma = 2;
New Window( "Example: Negative Binomial Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, Negative Binomial Distribution( k, lambda, sigma ) );
            V Line(
                k + 1,
                Negative Binomial Distribution( k, lambda, sigma ),
                Negative Binomial Distribution( k + 1, lambda, sigma )
            );
        );
        Text( {2, 0.95}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {2, 0.87}, "\!U03C3=", Round( sigma, 2 ) );
    ),
    H List Box( Slider Box( 3, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( .01, 5, sigma, ppy << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Negative Binomial Probability](#negative-binomial-probability)

**Syntax:** prob = Negative Binomial Probability( k, lambda, sigma )

**Description:** Returns the probability that a Negative Binomial distributed random variable is equal to k, where lambda is the location parameter, sigma is the scale parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 5;
sigma = 2;
New Window( "Poisson and Negative Binomial",
    clty = Graph Box(
        Y Scale( 0, 0.3 ),
        X Scale( -1, 20.5 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( x = 0, x <= 20, x++,
            Pen Color( "red" );
            V Line( x, 0, Poisson Probability( lambda, x ) );
            Pen Color( "blue" );
            V Line( x + 0.35, 0, Negative Binomial Probability( x, lambda, sigma ) );
        );
        Text( {1, 0.25}, "\!U03BB=", Round( lambda, 8 ), " \!U03C3=", Round( sigma, 8 ) );
        Text( {0, 0.28}, "Red = Poisson, Blue = Negative Binomial" );
    ),
    H List Box( Slider Box( 3, 10, lambda, clty << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( .01, 5, sigma, clty << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Negative Binomial Quantile](#negative-binomial-quantile)

**Syntax:** q = Gamma Negative Binomial Quantile( lambda, sigma, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Negative Binomial( lambda, sigma ) distribution is larger than or equal to cumprob.

**JMP Version Added:** 19

```

qexpl = 20;
qexps = 2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: Negative Binomial Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, Negative Binomial Distribution( qexpk, qexpl, qexps ) );
            V Line(
                qexpk + 1,
                Negative Binomial Distribution( qexpk, qexpl, qexps ),
                Negative Binomial Distribution( qexpk + 1, qexpl, qexps )
            );
        );
        Pen Color( "blue" );
        V Line( Negative Binomial Quantile( qexpl, qexps, qexpq ), 0, 1 );
        Text( {1, 0.9}, " \!U03BB=", Round( qexpl, 2 ), " \!U03C3=", Round( qexps, 2 ) );
        Text(
            {1, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( Negative Binomial Quantile( qexpl, qexps, qexpq ) )
        );
    ),
    H List Box( Slider Box( 3, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( .01, 5, qexps, qexpy << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [Poisson Distribution](#poisson-distribution)

**Syntax:** cumprob = Poisson Distribution( lambda, k )

**Description:** Returns the probability that a Poisson distributed random variable is less than or equal to k, where lambda is the mean parameter and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 4;
New Window( "Example: Poisson Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, Poisson Distribution( lambda, k ) );
            V Line(
                k + 1,
                Poisson Distribution( lambda, k ),
                Poisson Distribution( lambda, k + 1 )
            );
        );
        Text( {2, 0.9}, "\!U03BB=", Round( lambda, 2 ) );
    ),
    H List Box( Slider Box( 0, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) )
);


```

### [Poisson Probability](#poisson-probability)

**Syntax:** prob = Poisson Probability( lambda, k )

**Description:** Returns the probability that a Poisson distributed random variable is equal to k, where lambda is the mean parameter and k is the count of interest.

**JMP Version Added:** Before version 14

```

lambda = 4;
New Window( "Example: Poisson Probability",
    pdy = Graph Box(
        Y Scale( 0, 0.20 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( k = 0, k <= 40, k++,
            V Line( k, 0, Poisson Probability( lambda, k ) )
        );
        Text( {30, 0.18}, "\!U03BB=", Round( lambda, 2 ) );
    ),
    H List Box( Slider Box( 0, 40, lambda, pdy << reshow ), Text Box( " \!U03BB" ) )
);


```

### [Poisson Quantile](#poisson-quantile)

**Syntax:** q = Poisson Quantile( lambda, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the Poisson( lambda ) distribution is larger than or equal to cumprob.

**JMP Version Added:** Before version 14

```

qexpl = 20;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: Poisson Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, Poisson Distribution( qexpl, qexpk ) );
            V Line(
                qexpk + 1,
                Poisson Distribution( qexpl, qexpk ),
                Poisson Distribution( qexpl, qexpk + 1 )
            );
        );
        Pen Color( "blue" );
        V Line( Poisson Quantile( qexpl, qexpq ), 0, 1.0 );
        Text(
            {6, 0.17},
            " \!U03BB=",
            Round( qexpl, 2 ),
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( Poisson Quantile( qexpl, qexpq ) )
        );
    ),
    H List Box( Slider Box( 0, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [ZI Negative Binomial Distribution](#zi-negative-binomial-distribution)

**Syntax:** cumprob = ZI Negative Binomial Distribution( k, lambda, sigma, pi )

**Description:** Returns the probability that a zero-inflated Negative Binomial distributed random variable is less than or equal to k, where lambda is the location parameter, sigma is the scale parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
sigma = .5;
p = .2;
New Window( "Example: Zero Inflated Negative Binomial Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, ZI Negative Binomial Distribution( k, lambda, sigma, p ) );
            V Line(
                k + 1,
                ZI Negative Binomial Distribution( k, lambda, sigma, p ),
                ZI Negative Binomial Distribution( k + 1, lambda, sigma, p )
            );
        );
        Text( {30, 0.3}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .2}, "\!U03C3=", Round( sigma, 2 ) );
        Text( {30, .1}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( 0.01, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0.001, 2, sigma, ppy << reshow ), Text Box( "\!U03C3" ) ),
        H List Box( Slider Box( 0, .99, p, ppy << reshow ), Text Box( " \!U03C0" ) ),

    )
);


```

### [ZI Negative Binomial Probability](#zi-negative-binomial-probability)

**Syntax:** prob = ZI Negative Binomial Probability( k, lambda, sigma, pi)

**Description:** Returns the probability that a zero-inflated Negative Binomial distributed random variable is equal to k, where lambda is the location parameter, sigma is the scale parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
sigma = .5;
p = .1;
New Window( "Example: Zero Inflated Negative Binomial Probability",
    ppy = Graph Box(
        Y Scale( 0, .4 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( k = 0, k <= 40, k++,
            V Line( k, 0, ZI Negative Binomial Probability( k, lambda, sigma, p ) )
        );
        Text( {30, 0.3}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .25}, "\!U03C3=", Round( sigma, 2 ) );
        Text( {30, .2}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( .01, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0.001, 2, sigma, ppy << reshow ), Text Box( "\!U03C3" ) ),
        H List Box( Slider Box( 0, .25, p, ppy << reshow ), Text Box( " \!U03C0" ) )
    )
);


```

### [ZI Negative Binomial Quantile](#zi-negative-binomial-quantile)

**Syntax:** q = ZI Negative Binomial Quantile( lambda, sigma, pi, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the zero-inflated Negative Binomial( lambda, sigma, pi ) distribution is larger than or equal to cumprob.

**JMP Version Added:** 19

```

qexpl = 20;
qexpsig = .5;
qexpp = .2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: ZI Negative Binomial Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line(
                qexpk,
                qexpk + 1,
                ZI Negative Binomial Distribution( qexpk, qexpl, qexpsig, qexpp )
            );
            V Line(
                qexpk + 1,
                ZI Negative Binomial Distribution( qexpk, qexpl, qexpsig, qexpp ),
                ZI Negative Binomial Distribution( qexpk + 1, qexpl, qexpsig, qexpp )
            );
        );
        Pen Color( "blue" );
        V Line( ZI Negative Binomial Quantile( qexpl, qexpsig, qexpp, qexpq ), 0, 1.0 );
        Text(
            {2, 0.9},
            " \!U03BB=",
            Round( qexpl, 2 ),
            " \!U03C3=",
            Round( qexpsig, 2 ),
            " \!U03C0=",
            Round( qexpp, 2 )
        );
        Text(
            {2, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( ZI Negative Binomial Quantile( qexpl, qexpsig, qexpp, qexpq ) )
        );
    ),
    H List Box( Slider Box( 0.001, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0.001, 2, qexpsig, qexpy << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, .99, qexpp, qexpy << reshow ), Text Box( " \!U03C0" ) ),
    H List Box( Slider Box( 0.001, .999, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

### [ZI Poisson Distribution](#zi-poisson-distribution)

**Syntax:** cumprob = ZI Poisson Distribution( k, lambda, pi )

**Description:** Returns the probability that a zero-inflated Poisson distributed random variable is less than or equal to k, where lambda is the location parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
p = .2;
New Window( "Example: Zero Inflated Poisson Distribution",
    ppy = Graph Box(
        Y Scale( 0, 1.01 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        For( k = 0, k <= 40, k++,
            H Line( k, k + 1, ZI Poisson Distribution( k, lambda, p ) );
            V Line(
                k + 1,
                ZI Poisson Distribution( k, lambda, p ),
                ZI Poisson Distribution( k + 1, lambda, p )
            );
        );
        Text( {30, 0.2}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .1}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( 0, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0, .99, p, ppy << reshow ), Text Box( " \!U03C0" ) ),

    )
);


```

### [ZI Poisson Probability](#zi-poisson-probability)

**Syntax:** prob = ZI Poisson Probability( k, lambda, pi)

**Description:** Returns the probability that a zero-inflated Poisson distributed random variable is equal to k, where lambda is the location parameter, pi is the zero inflation parameter, and k is the count of interest.

**JMP Version Added:** 19

```

lambda = 4;
p = .2;
New Window( "Example: Poisson Probability",
    ppy = Graph Box(
        Y Scale( 0, .6 ),
        X Scale( -1, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( k = 0, k <= 40, k++,
            V Line( k, 0, ZI Poisson Probability( k, lambda, p ) )
        );
        Text( {30, 0.5}, "\!U03BB=", Round( lambda, 2 ) );
        Text( {30, .4}, "\!U03C0=", Round( p, 2 ) );
    ),
    V List Box(
        H List Box( Slider Box( 0, 40, lambda, ppy << reshow ), Text Box( " \!U03BB" ) ),
        H List Box( Slider Box( 0, .99, p, ppy << reshow ), Text Box( " \!U03C0" ) ),

    )
);


```

### [ZI Poisson Quantile](#zi-poisson-quantile)

**Syntax:** q = ZI Poisson Quantile( lambda, pi, cumprob )

**Description:** Returns the smallest integer quantile for which the cumulative probability of the zero-inflated Poisson( lambda, pi ) distribution is larger than or equal to cumprob.

**JMP Version Added:** 19

```

qexpl = 20;
qexpp = .2;
qexpn = 40;
qexpq = 0.5;
New Window( "Example: ZI Poisson Quantile",
    qexpy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 41 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( qexpk = 0, qexpk < Round( qexpn ), qexpk++,
            H Line( qexpk, qexpk + 1, ZI Poisson Distribution( qexpk, qexpl, qexpp ) );
            V Line(
                qexpk + 1,
                ZI Poisson Distribution( qexpl, qexpp, qexpk ),
                ZI Poisson Distribution( qexpl, qexpp, qexpk + 1 )
            );
        );
        Pen Color( "blue" );
        V Line( ZI Poisson Quantile( qexpl, qexpp, qexpq ), 0, 1.0 );
        Text( {2, 0.9}, " \!U03BB=", Round( qexpl, 2 ), " \!U03C0=", Round( qexpp, 2 ) );
        Text(
            {2, 0.8},
            " q=",
            Round( qexpq, 2 ),
            " quantile=",
            Round( ZI Poisson Quantile( qexpl, qexpp, qexpq ) )
        );
    ),
    H List Box( Slider Box( 0, 40, qexpl, qexpy << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0, .99, qexpp, qexpy << reshow ), Text Box( " \!U03C0" ) ),
    H List Box( Slider Box( 0, 1, qexpq, qexpy << reshow ), Text Box( " q" ) )
);


```

# [Display](#display)

### [Alignment Cell Box](#alignment-cell-box)

**Syntax:** y = Alignment Cell Box( row, col, nRow, nCol, \<Sides(left+2*top+4*right+8\*bottom=15)> \<RowSpan(nRow matrix)> \<ColSpan(nCol matrix)>, matrix or list of strings )

**Description:** Returns a reference to a display box that contains the row (or column) contents that are contained inside of an Alignment Grid Box.

**JMP Version Added:** 19

```


New Window( "Crosstab",
    Alignment Grid Box(
        Alignment Cell Box( 0, 1, 1, 1, ColSpan( [3] ), {"sex"} ),
        Alignment Cell Box( 1, 1, 1, 3, {"F", "M", "Total"} ),
        Alignment Cell Box( 3, 0, 1, 1, Sides( 0 ), ColSpan( [4] ), {"age"} ),
        Alignment Cell Box( 4, 0, 6, 1, {"  12", "  13", "  14", "  15", "  16", "  17"} ),
        Alignment Cell Box(
            4,
            1,
            6,
            3,
            {"5 (28%)", "3 (14%)", "8 (20%)", "3 (17%)", "4 (18%)", "7 (18%)", "5 (28%)",
            "7 (32%)", "12 (30%)", "2 (11%)", "5 (23%)", "7 (18%)", "2 (11%)", "1 (5%)",
            "3 (8%)", "1 (6%)", "2 (9%)", "3 (8%)"}
        )
    )
);


```

### [Alignment Grid Box](#alignment-grid-box)

**Syntax:** y = Alignment Grid Box( alignment cell boxes )

**Description:** Returns a reference to a display box that can contain alignment cell boxes.

**JMP Version Added:** 19

```


New Window( "Crosstab",
    Alignment Grid Box(
        Alignment Cell Box( 0, 1, 1, 1, ColSpan( [3] ), {"sex"} ),
        Alignment Cell Box( 1, 1, 1, 3, {"F", "M", "Total"} ),
        Alignment Cell Box( 3, 0, 1, 1, Sides( 0 ), ColSpan( [4] ), {"age"} ),
        Alignment Cell Box( 4, 0, 6, 1, {"  12", "  13", "  14", "  15", "  16", "  17"} ),
        Alignment Cell Box(
            4,
            1,
            6,
            3,
            {"5 (28%)", "3 (14%)", "8 (20%)", "3 (17%)", "4 (18%)", "7 (18%)", "5 (28%)",
            "7 (32%)", "12 (30%)", "2 (11%)", "5 (23%)", "7 (18%)", "2 (11%)", "1 (5%)",
            "3 (8%)", "1 (6%)", "2 (9%)", "3 (8%)"}
        )
    )
);


```

### [Alignment Multi Box](#alignment-multi-box)

**Syntax:** y = Alignment Multi Box( row, col, nRow, nCol, nElements, list-of-nElements-matrices or empty values, list-of-nElements-lists of strings or empty values )

**Description:** Returns a reference to a display box that contains multiple elements inside each cell that is contained inside of an Alignment Grid Box.

**JMP Version Added:** 19

```


New Window( "Alignment MultiBox",
    Border Box( Top( 15 ), Left( 15 ), Right( 15 ), Bottom( 15 ),
        Alignment Grid Box(
            Alignment Multi Box( 0, 1, 1, 1, 2, {}, {{"Freq"}, {"Share"}} ),
            Alignment Cell Box( 0, 2, 1, 1, ColSpan( [2] ), {"sex"} ),
            Alignment Cell Box( 1, 2, 1, 2, ColSpan( [1, 1] ), {"F", "M"} ),
            Alignment Cell Box( 2, 0, 1, 1, RowSpan( [7] ), {"age"} ),
            Alignment Cell Box(
                2,
                1,
                7,
                1,
                {"12", "13", "14", "15", "16", "17", "Total Responses"}
            ),
            Alignment Multi Box(
                2,
                2,
                6,
                2,
                2,
                {[5 3, 5 2, 2 1, 3 4, 7 5, 1 2], [0.277 0.167, 0.278 0.111, 0.111 0.055,
                0.136 0.181, 0.318 0.227, 0.045 0.090]},
                {Empty(), Empty()}
            ),
            Alignment Cell Box( 8, 2, 1, 2, [18 22] )
        )
    )
);


```

### [Alpha Shape](#alpha-shape)

**Syntax:** ashape = Alpha Shape(Triangulation)

**Description:** Returns the alpha shape for the given triangulation.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
triang = Triangulation( X( :X, :Y ), Y( :POP ) );
ashape = Alpha Shape( triang );


```

### [Border Box](#border-box)

**Syntax:** y = Border Box( \<Left( pix )>, \<Right( pix )>, \<Top( pix )>, \<Bottom( pix )>, \<Sides( 0 )>, displayBoxArg )

**Description:** Returns a display box to add space around the argument display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 1 ), spacing( 10 ),
        Text Box( "Quadratic Formula" ),
        Border Box( Left( 10 ), Right( 10 ), bottom( 10 ), top( 10 ), sides( 15 ),
            Expr As Picture( Expr( (-b + Sqrt( b ^ 2 - 4 * a * c )) / (2 * a) ) )
        )
    )
);


```

### [Box Plot Seg](#box-plot-seg)

**Syntax:** b = Box Plot Seg(<data>, <frequency>, <weight>, \<vertical=0|1>)

**Description:** Returns a display seg representing a box plot based on the passed in x and y values.

**JMP Version Added:** Before version 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box( Frame Size( 40, 180 ), Y Scale( 0, 5 ), Box Plot Seg( [1, 2, 3, 4] ) )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));


```

### [Busy Light](#busy-light)

**Syntax:** y = Busy Light( < \<<Automatic(0|1)>, \<Size(x, y)>, < \<<Disable> )

**Description:** Creates a rotating image to indicate a busy process.

**JMP Version Added:** Before version 14

```

New Window( "Example", Busy Light( <<automatic ) );


```

### [Button Box](#button-box)

**Syntax:** y = Button Box( title, script )

**Description:** Returns a display box to show a titled button. The script argument is run when the button is clicked.

**JMP Version Added:** Before version 14

```

New Window( "Example", Button Box( "Press Me", Print( "Pressed." ) ) );


```

### [Calendar Box](#calendar-box)

**Syntax:** y = Calendar Box()

**Description:** Returns a display box containing a calendar control. The calendar supports single-selection of a date and optional time.

**JMP Version Added:** Before version 14

```

New Window( "Calendar Box Example", Calendar Box() );


```

### [Check Box](#check-box)

**Syntax:** y = Check Box( {item, ...}, <script> )

**Description:** Returns a display box to show one or more check boxes.

**JMP Version Added:** Before version 14

```

New Window( "Example", cb = Check Box( {"Good"}, Show( cb << Get() ) ) );


```

### [Clear Global Window Handler](#clear-global-window-handler)

**Syntax:** Clear Global Window Handler()

**Description:** Clears a window handler previously set by Set Global Window Handler.

**JMP Version Added:** 17

```

Set Global Window Handler(
    Function( {window},
        Print( window << get window title() );
        window << close window();
    )
);
New Window( "My Window" );
Clear Global Window Handler();


```

### [Col Box](#col-box)

**Syntax:** y = Col Box( title, boxes )

**Description:** Returns a column box made up of the given display boxes.

**JMP Version Added:** Before version 14

```

dt = New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);


```

### [Col List Box](#col-list-box)

**Syntax:** y = Col List Box( \<Data Table( name )>, <all>|\<character|numeric>, \<width( pix )>, <grouped>, \<maxSelected( n )>, \<nlines( n )>, \<MaxItems( n )>, \<MinItems( n )>, \<onChange( expr )>, < \<<Modeling Type({"Any","Continuous","Nominal","Ordinal","Multiple Response","Unstructured Text","Vector","None","Row State"}) >, < \<< Set Data Type(Any|Numeric|Character)>, <script> )

**Description:** Returns a display box to show list box to select data table columns. Use the \<<Modeling Type message to allow specialty modeling types or to restrict the types allowed. The default value of "Any" will allow any column with a classic modeling type ("Continuous", "Nominal", "Ordinal").

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 1", Col List Box( all, width( 250 ), maxSelected( 1 ) ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 2",
    Col List Box( all, <<Set Data Type( "numeric" ), width( 250 ), maxSelected( 1 ) )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 3",
    H List Box(
        ll1 = Col List Box( all ),
        Button Box( "Add", ll2 << append( ll1 << get selected ) ),
        ll2 = Col List Box( "numeric", MaxItems( 1 ), nlines( 1 ) ),
        Button Box( "Remove", ll2 << remove selected )
    )
);


```

### [Col Span Box](#col-span-box)

**Syntax:** y = Col Span Box( title, children )

**Description:** Returns a column that has a header that spans child columns

**JMP Version Added:** Before version 14

```

New Window( "test",
    Table Box(
        Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);


```

### [Column Dialog](#column-dialog)

**Syntax:** y = Column Dialog( \<var = ColList("Label", \<Min Col(min)>, \<Max Col(max)>, \<Width(w)>, \<Data Type("Numeric"|"Character"|"Any")>, \<Modeling Type({\<"Continuous">, \<"Nominal">, \<"Ordinal">, \<"None">, \<"Multiple Response">, \<"Unstructured Text">, \<"Vector">})> )>, \<var=EditText("string")>, \<var=EditNumber(num)>, \<var=Check Box( "Text", 0|1)>, \<var=RadioButtons( "a", "b" )>, \<var=Combo Box("choice1", ...)>, \<HList(box, ...)>, \<VList(box, ...)>, \<LineUp(ncol, box, ...)>, \<Text Box("string")>, \<Window Title("title")>, \<Window Icon("icon string")>, \<Dialog Description("description")>, \<Recall(script)>, \<Help Script(script)>)

**Description:** Prompts the user with a modal window with fields to select columns of a data table. The specification can include several types of input boxes as well as container boxes to organize the window.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Consumer Preferences.jmp" );
Column Dialog(
    ex y = ColList( "Y", Min Col( 1 ), Max Col( 2 ), Data Type( "Numeric" ) ),
    ex x = ColList( "X", Max Col( 1 ), Modeling Type( {"Continuous", "Multiple Response"} ) ),
    Line Up( 2,
        Text Box( "Alpha" ), ex = EditNumber( .05 ),
        Text Box( "Beta" ), ey = EditText( "xyz" )
    ),
    HList( cb = Check Box( "check", 1 ) ),
    HList( combo = Combo Box( "option1", "option2" ) ),
    HList( rb = RadioButtons( "a", "b" ) ),
    Window Title( "Custom Launch Dialog" ),
    Window Icon( "RowState" ), //icon string can be a full path file name of an image file.
    Dialog Description( "The dialog before a groundbreaking discovery!" ),
    Recall Script(
        Function( {dlgBox},
            dlgBox[list box box( 2 )] << remove all;
            dlgBox[list box box( 1 )] << clear selection;
            dlgBox[list box box( 1 )] << set selected( 3 );
            dlgBox[Button Box( 2 )] << click;
        )
    ),
    Help Script( Web( "http://www.jmp.com/" ) )
);


```

### [Combo Box](#combo-box)

**Syntax:** y = Combo Box( {item \<( tipstr )>, ...}, <script> )

**Description:** Returns a display box to show a combo box with a popup menu. Each item in the combo box can have an optional tooltip that is specified as a string inside of parentheses following the item text string.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    cb = Combo Box( {"single", "double", "triple"("tool tip")}, Show( cb << Get() ) )
);


```

### [Context Box](#context-box)

**Syntax:** y = Context Box( displayBox, ... )

**Description:** Returns a display box that establishes a scoped evaluation context. Allows different parts of a display window to be executed independently of each other.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Context Box(
        Outline Box( "Picker",
            V List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
        )
    )
);


```

### [Contour Seg](#contour-seg)

**Syntax:** me = Contour Seg( Triangulation, [ levels ], < zColor([colors], \<Cycle Colors|Interpolate Colors>) >, < Transparency([] | t) >

**Description:** Returns a display seg representing contours of a Triangulation. Optional colors can be specified for each level as a matrix or list. The transparency can be specified as a number or matrix.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        )
    )
);


```

### [Current Report](#current-report)

**Syntax:** y = Current Report( \<Project(title|index|box|window)> )

**Description:** Returns a display box reference to the current report in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

Current Report();


```

### [Current Window](#current-window)

**Syntax:** y = Current Window( \<Project(title|index|box|window)> )

**Description:** Returns a reference to the current window in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Example Outline",
        Text Box( "Example Text" ),
        Button Box( "Close", Current Window() << Close Window )
    )
);


```

### [Data Filter Context Box](#data-filter-context-box)

**Syntax:** y = Data Filter Context Box( displayBox )

**Description:** Returns a display box that defines the extent of the local data filters contained in a display tree. Data filters and Data Filter Context Boxes can be arranged in a hierarchy and will be shared among platforms or boxes contained within the Data Filter Context Boxes.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Shared Local Filter",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter( Local, Add Filter( columns( :sex ), Where( :sex == "F" ) ) ),
            dt << Bubble Plot(
                X( :weight ),
                Y( :height ),
                Fit To Window( "On" ),
                Sizes( :age ),
                Title Position( 0, 0 )
            ),
            dt << Graph Builder(
                Size( 525, 456 ),
                Show Control Panel( 0 ),
                Fit To Window( "On" ),
                Variables( X( :weight ), Y( :age ) ),
                Elements( Box Plot( X, Y, Legend( 4 ) ) ),

            )
        )
    )
);


```

### [Data Filter Source Box](#data-filter-source-box)

**Syntax:** y = Data Filter Source Box( displayBox )

**Description:** Returns a display box that defines the source of a selection filter. Selected rows in reports contained by the Data Filter Source Box will be included for analysis in the other reports contained within a common Data Filter Context Box.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Selection Filter",
    Data Filter Context Box(
        H List Box(
            Data Filter Source Box(
                Graph Builder(
                    Size( 208, 207 ),
                    Show Control Panel( 0 ),
                    Show Legend( 0 ),
                    Variables( X( :age ) ),
                    Elements( Bar( X, Legend( 3 ) ) ),
                    SendToReport(
                        Dispatch( {}, "Graph Builder", OutlineBox, {Set Title( "Filter" )} )
                    )
                )
            ),
            Platform(
                Current Data Table(),
                Bubble Plot(
                    X( :weight ),
                    Y( :height ),
                    Sizes( :age ),
                    Title Position( 0, 0 )
                )
            )
        )
    )
);


```

### [Data Grid Box](#data-grid-box)

**Syntax:** y = Data Grid Box( )

**Description:** Returns a display box that can hold a data table.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example", x = Data Grid Box() );
x << Set Data Table( dt );


```

### [Data Table Box](#data-table-box)

**Syntax:** y = Data Table Box( datatable )

**Description:** Returns a table box representing the given data table.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example", Data Table Box( dt ) );


```

### [Data Table Col Box](#data-table-col-box)

**Syntax:** y = Data Table Col Box( col )

**Description:** Returns a column box corresponding to the given data table column.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    Table Box( Data Table Col Box( :name ), Data Table Col Box( :height ) )
);


```

### [Data Table Plot Col Box](#data-table-plot-col-box)

**Syntax:** y = Data Table Plot Col Box( col )

**Description:** Returns a Plot Col Box corresponding to the given data table column and optionally uses the second and third data table columns to create control limits.

**JMP Version Added:** 17

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    Table Box( Data Table Plot Col Box( :weight ), Data Table Plot Col Box( :height ) )
);


```

### [Dialog](#dialog)

**Syntax:** y = Dialog( specification )

**Description:** Prompts the user with a modal window. This function is deprecated. Please use the New Window function with the \<<Modal argument.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Dialog equivalent
If(
    ex = New Window( "Dialog() example",
        <<Modal,
        <<Return Result,
        V List Box(
            H List Box( "Set this value", variable = Number Edit Box( 42 ) ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    );
    ex["button"] == 1;
,
    ex["variable"],
    "CANCEL"
);


```

**Example 2**

```

// Deprecated
If(
    ex = Dialog(
        Title( " Dialog() example" ),
        vlist(
            hlist( "Set this value", variable = EditNumber( 42 ) ),
            hlist( Button( "OK" ), Button( "Cancel" ) )
        )
    );
    ex["button"] == 1;
,
    ex["variable"],
    "CANCEL"
);


```

### [Excerpt Box](#excerpt-box)

**Syntax:** y = Excerpt Box( rptnum, lstSubscripts )

**Description:** Returns a display box containing the excerpt designated by the report held at number rptnum and the list of display subscripts lstSubscripts. The subscripts reflect the current state of the report, after previous excerpts have been removed.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [Expr As Picture](#expr-as-picture)

**Syntax:** y = Expr As Picture( expr( ... ), <width in pixels>, \<Max Matrix Size( dim )> )

**Description:** Returns an image containing the specified expression as a formula picture. The default width is 600 pixels and the default max matrix size is 100.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 1 ), spacing( 10 ),
        Text Box( "Quadratic Formula" ),
        Border Box( Left( 10 ), Right( 10 ), bottom( 10 ), top( 10 ), sides( 15 ),
            Expr As Picture( Expr( (-b + Sqrt( b ^ 2 - 4 * a * c )) / (2 * a) ) )
        )
    )
);


```

### [Filter Col Selector](#filter-col-selector)

**Syntax:** y = Filter Col Selector(\<Data Table(name)>, \<width(pixels)>, \<nlines(n)>, <script>, \<onchange(expr)>)

**Description:** Returns a display box that contains a list of items. Control allows column filtering.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example", fontobj = lb = Filter Col Selector( width( 250 ) ) );


```

### [Get Project](#get-project)

**Syntax:** project = Get Project( title|index|box|window )

**Description:** Returns a reference to a specific open project by title, index, or box.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );

Print( Get Project( 2 ) << Get Window Title() );


```

**Example 2**

```

Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );

project = Get Project( "Big Class" );


```

### [Get Project List](#get-project-list)

**Syntax:** projectList = Get Project List()

**Description:** Returns a list of all open projects.

**JMP Version Added:** Before version 14

```

New Project();
Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );

Print( Get Project List() << Get Window Title() );


```

### [Get Window](#get-window)

**Syntax:** window = Get Window( \<Project(title|index|box|window)>, \<Type(string)>, title|index|box )

**Description:** Returns a reference to a specific open window by title, index, or box.

The search is limited to windows in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

Use the optional Type() argument with one of "Data Tables", "Journals", "Reports", or "Dialogs" to limit the search to windows of a particular type.

**JMP Version Added:** 14

**Example 1**

```

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

window = Get Window( "Big Class" );


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS\Big Class.jmpprj" );

window = Get Window( Project( project ), "Big Class" );


```

### [Get Window List](#get-window-list)

**Syntax:** windowList = Get Window List( \<Project(title|index|box|window)>, \<Type(string)> )

**Description:** Returns a list of all open windows.

The list is limited to windows in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

Use the optional Type() argument with one of "Data Tables", "Journals", "Reports", or "Dialogs" to limit the list to windows of a particular type.

**JMP Version Added:** 14

**Example 1**

```

Print( Get Window List() << Get Window Title() );


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS\Big Class.jmpprj" );

Print( Get Window List( Project( project ) ) << Get Window Title() );


```

**Example 3**

```

project = Open( "$SAMPLE_PROJECTS\Big Class.jmpprj" );

Print( Get Window List( Project( project ), Type( "Data Tables" ) ) << Get Window Title() );


```

### [Global Box](#global-box)

**Syntax:** box = Global Box( name )

**Description:** Creates a display box showing the value of a global variable.

**JMP Version Added:** Before version 14

```

ex = .6;
New Window( "Example", Global Box( ex ) );


```

### [Graph](#graph)

**Syntax:** y = Graph Box( props, script )

**Description:** Returns a display box containing a graph with axes. Named property arguments can be title("title"), XScale(low,high), YScale(low,high), FrameSize(h,v), XName("x"), yName("y"), DoubleBuffer, and SuppressAxes.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( "Blue" );
        Line( [10 30 70], [88 22 44] );
    )
);


```

### [Graph 3D Box](#graph-3d-box)

**Syntax:** y = Graph 3D Box()

**Description:** (Experimental) Returns a display box with 3D content that can be used with other display boxes to create custom reports.

**JMP Version Added:** Before version 14

```

x3d = Graph 3D Box(
    framesize( 300, 300 ),
    Xname( "X Axis" ),
    Yname( "Y Axis" ),
    Zname( "Z Axis" )
);
New Window( "Graph3DBox Example", x3d );
x3d << addmarkers( /*x*/[20 20 20 20], /*y*/[20 20 20 20], /*z*/[10 20 30 40] );
x3d << AddVector(
    [60 60 60]/*from*/,
    [90 60 60, 60 90 60, 60 60 90]/*to*/,
    ShaftThickness( [.1] ),
    FromThickness( [.2] ),
    ToThickness( [.3] ),
    ShaftColor( [-255] ),
    FromColor( [-16711680] ),
    ToColor( [-65280] ),
    Facets( Round ),
    FromCap( Sphere ),
    toCap( Point )
);


```

### [Graph Box](#graph-box)

**Syntax:** y = Graph Box( props, script )

**Description:** Returns a display box containing a graph with axes. Named property arguments can be title("title"), XScale(low,high), YScale(low,high), FrameSize(h,v), XName("x"), yName("y"), DoubleBuffer, and SuppressAxes.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( "Blue" );
        Line( [10 30 70], [88 22 44] );
    )
);


```

### [H Center Box](#h-center-box)

**Syntax:** y = H Center Box( <childbox> )

**Description:** Returns a display box with the childbox display box argument centered in the horizontal space defined by the maximum size of that child and all the other siblings of the center box.

**JMP Version Added:** Before version 14

```

New Window( "test",
    H List Box(
        V Center Box( Text Box( "V+V" ) ),
        V List Box(
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            H Center Box( Text Box( "H+H" ) ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" )
        )
    )
);


```

### [H List Box](#h-list-box)

**Syntax:** y = H List Box( \<Align( center|bottom )>, displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for bottom or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker", H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ) )
);


```

### [H Scroll Box](#h-scroll-box)

**Syntax:** y = H Scroll Box( \<Size( x )>, displayBox )

**Description:** Returns a display box that positions a larger child box using a horizontal scroll bar.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        H Scroll Box(
            Size( 200 ),
            H List Box(
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
            ),
            <<Set Stretch( "Window", "Window" )
        )
    )
);


```

### [H Sheet Box](#h-sheet-box)

**Syntax:** y = H Sheet Box( \<<Hold( rpt ), displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for right or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [H Splitter Box](#h-splitter-box)

**Syntax:** y = H Splitter Box( \<Size(x,y)>, displayBox, ... )

**Description:** Returns a display box that arranges other display boxes horizontally, with interactive control of sizes. Child sizes are specified as a proportion of the width or height of the Splitter Box. The optional Size argument is only used for the top-most Splitter Box; lower level boxes are sized like any other child box.

**JMP Version Added:** Before version 14

```

New Window( "Splitter",
    V Splitter Box(
        Size( 800, 600 ),
        H Splitter Box( graph = Graph Box(), Script Box(), <<Sizes( {0.6, 0.4} ) ),
        H Splitter Box(
            pict = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ),
            spacer = Spacer Box(),
            <<Sizes( {0.4, 0.6} )
        )
    )
);
graph[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
pict << Set Min Size( 100, 100 );
pict << Set Max Size( 500, 500 );
pict << Set Stretch( "Window", "Window" );
spacer << Set Fill( 1 );
spacer << Color( "Red" );
spacer << Set Stretch( "Window", "Window" );


```

### [Hier Box](#hier-box)

**Syntax:** y = Hier Box( text, Hier Box( ... ), Hier Box( ... ), ... )

**Description:** Returns a display box for hierarchy trees. The text argument is the node's name and can be a Text Edit Box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Hier Box(
        Text Edit Box( "Cause 1" ),
        Hier Box( Text Edit Box( "Subcause 1.1" ), <<direction( 1 ) ),
        Hier Box( Text Box( "Subcause 1.2" ) ),
        <<Change Type( Fishbone ),
        <<direction( 1 )
    )
);


```

### [Hist Seg](#hist-seg)

**Syntax:** b = Hist Seg([data], \<[freq data]>,\<[weight data]>, \<vertical=0|1>, \<Row States()>)

**Description:** Returns a hist seg

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, .2 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);


```

### [Icon Box](#icon-box)

**Syntax:** Box = Icon Box( "Name" )

**Description:** Constructs a display box containing an icon, where the name argument can be a JMP icon name or a path to a an image.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    ex1 = Icon Box( "Popup" ),
    ex2 = Icon Box( "Locked" ),
    ex3 = Icon Box( "Labeled" ),
    ex4 = Icon Box( "Sub" ),
    ex5 = Icon Box( "Excluded" ),
    ex6 = Icon Box( "Hidden" ),
    ex7 = Icon Box( "Continuous" ),
    ex8 = Icon Box( "Nominal" ),
    ex9 = Icon Box( "Ordinal" )
);


```

**Example 2**

```

New Window( "Example with Path", ex = Icon Box( "$SAMPLE_IMAGES/pi.gif" ) );


```

### [If Box](#if-box)

**Syntax:** box = If Box( 0|1, displayBoxArgs )

**Description:** Returns a display box that conditionally displays the specified display box arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    H List Box(
        englishBox = If Box( 1, Text Box( "Good day" ) ),
        frenchBox = If Box( 0, Text Box( "Bon Jour" ) )
    )
);
Wait( 5 );
englishBox << Set( 0 );
frenchBox << Set( 1 );


```

### [If Seg](#if-seg)

**Syntax:** seg = If Seg(\<state=0|1>)

**Description:** Returns a display seg that shows or hides display seg children.

**JMP Version Added:** Before version 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);


```

### [Journal Box](#journal-box)

**Syntax:** y = Journal Box( journalText )

**Description:** Constructs a display box from instructions that would be stored in a journal.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
sample = Distribution( Y( :height ) );
sampjourn = sample << Get Journal;
New Window( "Distribution of Height",
    Text Box( "Here is the result of the distribution platform for Height." ),
    Journal Box( sampjourn )
);


```

### [Line Seg](#line-seg)

**Syntax:** ls = Line Seg(x values, y values, \<Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) >, < Sizes( s ) > )>)

**Description:** Returns a display seg with lines connecting all of the x and y values.

**JMP Version Added:** Before version 14

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Line Seg" ));


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y, RowStates( dt ) ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Line Seg" ));


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example",
    g = Graph Box( Line Seg( x, y, RowStates( dt, {1, 3, 5} ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Line Seg" ));


```

### [Lines Seg](#lines-seg)

**Syntax:** ls = Lines Seg([x1 y1 x2 y2,...])

**Description:** Returns a display seg with a sequence of line segments for the passed in x and y values.

**JMP Version Added:** Before version 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Lines Seg" ));


```

### [Lineup Box](#lineup-box)

**Syntax:** y = Lineup Box( \<NCol( nc )>, \<Spacing( pixels, <vspace> )>, displayBoxArgs, ... )

**Description:** Returns a display box to show an alignment of boxes in nc columns. The optional Spacing argument specifies the horizontal and vertical space around the display boxes. If the vspace argument is used, vspace is the vertical space and pixels is the horizontal space.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 1 ), spacing( 10 ),
        Text Box( "Quadratic Formula" ),
        Border Box( Left( 10 ), Right( 10 ), bottom( 10 ), top( 10 ), sides( 15 ),
            Expr As Picture( Expr( (-b + Sqrt( b ^ 2 - 4 * a * c )) / (2 * a) ) )
        )
    )
);


```

### [Lineup Ruler Box](#lineup-ruler-box)

**Syntax:** y = Lineup Box( \<Widths( {width1, width2, ...} )>, displayBoxArgs, ... )

**Description:** Returns a display box that sets the column widths of the Lineup Boxes that it contains.

**JMP Version Added:** 16

```


New Window( "Lineup Ruler",
    lrb = Lineup Ruler Box(
        Widths( {120, 200} ),
        Outline Box( "Customer 1",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(), 

            )
        ),
        Outline Box( "Customer 2",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(), 

            )
        )
    )
);


```

### [List Box](#list-box)

**Syntax:** y = List Box( {item, ...}, \<width( pixels )>, \<maxSelected( 9999 )>, \<nlines( 12 )>, <script> )

**Description:** Returns a display box to show a list box of selection items. If item itself is a two-item list containing the item name and a string specifying a modeling type or sorting order, such as "Ordinal" or "Ascending", the appropriate icon will show up next to that item in the list box.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example", b = List Box( {"single", "double", "triple"}, nlines( 10 ) ) );


```

**Example 2**

```

New Window( "Example",
    lb = List Box(
        {{"First Item", "continuous"}, {"Second Item", "ordinal"}, {"Third Item", "nominal"}},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);


```

### [Marker Seg](#marker-seg)

**Syntax:** me = Marker Seg( x, y, < Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) >, < Sizes( s ) > )

**Description:** Returns a display seg with markers for all of the x and y values.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
sz = Column( "age" ) << get values;
aa = [=> 0];
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ), sizes( sz ) )
    )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt, {3, 4, 11, 7, 13} ) )
    )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt, 11 :: 15 ) )
    )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg(
            xx,
            yy,
            Row States( dt, {{1, 2, 3}, {4, 5}, {6}, {7, 12, 15, 9}, {21, 8}} )
        )
    )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = [1 2 3 4 5];
yy = [2 3 4 5 6];
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg(
            xx,
            yy,
            Row States(
                {Color State( "Blue" ), Color State( "Orange" ), Color State( "Green" ),
                Color State( "Purple" ), Color State( "Red" )}
            )
        )
    )
);


```

### [Matrix Box](#matrix-box)

**Syntax:** y = Matrix Box( matrix, < \<<Column Names( "c1", "c2", ... )>, < \<<Row Names( "r1", "r2", ... )> )

**Description:** Returns a display box to show a matrix of numbers.

**JMP Version Added:** Before version 14

```

New Window( "Example", Matrix Box( [11 22 33, 44 55 66], <<RowNames( "First", "Second" ) ) );


```

### [MouseBox](#mousebox)

**Syntax:** box = MouseBox( displayBoxArgs )

**Description:** Returns a box that can make JSL callbacks for mouse actions

**JMP Version Added:** Before version 14

```

New Window( "Example",
    MouseBox(/*first sibling*/Text Box( "drag from here" ),
        <<setDragText( "hello" ),
        <<setTooltip( "source" ),
        <<setDragEnable( 1 ),
        <<setDragBegin(/* decide if a drag is allowed */
            Function( {this, clickpt},
                "magic text";/* 0.0 to prevent the drag.  1.0 is the same as 'this<<getDragText' */
            )
        ),
        <<setDragEnd(/* clean up after a drag finishes or cancels */
            Function( {this, clickpt, how}, /* how=move,copy,ignore */
                If(
                    how != "ignore" & !Is Empty( this << getDestBox ) & this << getDestBox
                     == this << sib, /* the getDestBox check makes sure the destination of the drag-and-drop was my sibling and not some other program beyond our control */
                    (this << child) << setText(
                        "done!" /* 'move' suggests clearing the source */
                    )
                )
            )
        )
    ),
    MouseBox(/*second sibling*/Text Box( "drag to here" ),
        <<setTooltip( "destination" ),
        <<setDropEnable( 1 ),
        <<setDropTrack(/* decide if dropping is allowed, before the drop.  The getSourceBox check makes sure the source of the drag-and-drop is my sibling, and not some other program */
            Function( {this, clickpt},
                If( !Is Empty( this << getSourceBox ) & this == (this << getSourceBox) << sib,
                    1, /*else*/0
                )
            )
        ),
        <<setDropCommit(/* accept the drop */Function( {this, clickpt, text},
                (this << child) << setText( text )
            )
        )
    )
);


```

### [Move to Project](#move-to-project)

**Syntax:** Move to Project(\<Source(project)>, \<Destination(project)>, \<Windows({list of windows to move})>)

**Description:** Moves one or more windows into a project, out of a project, or between projects. Only one of Source and Destination must be specified; the other will default to the current project. (Use only Source to move windows into the current project, and only Destination to move windows out of it.) A data table window will be moved together with its dependent reports, though only one need be specified in the Windows argument. If omitted, the Windows argument defaults to all open windows in the source project.

**JMP Version Added:** 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
report = dt << Run Script( "Bivariate" );

project = New Project();

Move to Project( destination( project ), windows( {report} ) );


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );
Move to Project( Source( project ) );
project << Close Window();


```

### [New Image](#new-image)

**Syntax:** img = New Image() img = New Image( width, height ) img = New Image( pathname ) img = New Image( picture ) img = New Image( matrix of JSL color pixels ) img = New Image( rgb|r|g|rgba, {i, i, i} )

**Description:** Returns a new image which can then be edited through JSL commands. If a path is specified to an existing image file, the file should be a .JPG, .PNG, .GIF, .BMP or .TIF file.

**JMP Version Added:** Before version 14

**Example 1**

```

image = New Image( "$SAMPLE_IMAGES/windmap.png" );
New Window( "new image", image );


```

**Example 2**

```

pic = Open( "$SAMPLE_IMAGES/windmap.png", png );
image2 = New Image( pic );
New Window( "new image", image2 );


```

**Example 3**

```

image3 = New Image();
mat = J( 256, 256 );
For( y = 0, y < 256, y++,
    For( x = 0, x < 256, x++,
        mat[y * 256 + x] = RGB Color( y / 255.0, 0.0, x / 255.0 )
    )
);
image3 << Set Pixels( mat );
New Window( "image", image3 );


```

### [New Project](#new-project)

**Syntax:** project = new Project( <project messages> )

**Description:** Creates a new empty project window. One or more project messages can be included as arguments in order to create a project in one step.

**JMP Version Added:** Before version 14

**Example 1**

```

project = New Project();


```

**Example 2**

```

project = New Project(
    Run Script(
        dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
        dt << Run Script( "Bivariate" );
    )
);


```

**Example 3**

```

project = New Project(
    Run Script(
        Open( "$SAMPLE_DATA/Big Class.jmp" );
        New Window( "Big Class - Bivariate of weight by height",
            Bivariate( Y( :weight ), X( :height ) )
        );
    )
);


```

**Example 4**

```

project = New Project(
    Set Bookmarks(
        {File( "$SAMPLE_DATA/Animals.jmp" ), File( "$SAMPLE_DATA/Big Class.jmp" )}
    ),
    Run Script(
        Open( "$SAMPLE_DATA/Big Class.jmp" );
        New Window( "Big Class - Bivariate of weight by height",
            Bivariate( Y( :weight ), X( :height ) )
        );
    )
);


```

**Example 5**

```

project = New Project(
    Run Script( Open( "$SAMPLE_SCRIPTS/demoCorr.jsl", Set Window ID( "demoCorr" ), Script ) ),
    Set Layout(
        H Splitter Box(
            <<Set Sizes( {0.15, 0.85} ),
            Tab Page Box( Title( "Window List" ), Window ID( "Windows" ) ),
            V Splitter Box(
                <<Set Sizes( {0.7, 0.3} ),
                Tab Page Box( Title( "demoCorr" ), Window ID( "demoCorr" ) ),
                Tab Page Box( Title( "Log" ), Window ID( "Log" ) )
            )
        )
    )
);


```

### [New Window](#new-window)

**Syntax:** w = New Window( title, < \<<Type("Report" | "Dialog" | "Modal Dialog" | "Journal" | "Launcher" | "Script")>, < \<< Return Result>, < \<< On Open(expr | function | method)>, < \<< On Close(expr | function | method)>, < \<<On Validate(expr | function | method)>, < \<<Show Menu(0 | 1)>, < \<<Show Toolbars(0 | 1)>, < \<<Suppress AutoHide(0 | 1)>, < \<<Window View("Visible" | "Invisible")>, < \<<Language("C" | "JavaScript" | "JSL" | "JSON" | "Python" | "R" | "SAS" | "SQL" | "Text" | "XML")>, < \<<Size(x, y)>, displayBox | script)

**Description:** Creates a window containing the specified display box or script. A report window is created by default, unless the Type option is specified. A window of Type("Modal Dialog") halts execution until the dialog is responded to. On Open, On Validate, and Return Result are available only for modal windows. On Open() evaluates its expression, function, or class method when the window is created. If On Close() returns false, the window is prevented from closing. On Validate() runs its expression, function, or class method when the OK button is clicked. If the expression returns true, the window is closed. Otherwise, the window remains open. Return Result changes the window's return value when it closes to match that of the deprecated Dialog() function. For window types that support toolbars, use Show Toolbars to specify changes from the default behavior. The options Show Menu and Suppress AutoHide are Windows only. The Window View("Invisible") option can be used for any window other than a Modal Dialog. A window of Type("Script") creates a JSL document unless the \<<Language option is specified.

**JMP Version Added:** Before version 14

#### [[Win] Toolbars and Menus](#win-toolbars-and-menus)

```

// Compare settings for toolbars and menus
// Suppress AutoHide is Windows only
g = Graph Box(
    Frame Size( 300, 300 ),
    Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    Pen Color( "Blue" );
    Line( [10 30 70], [88 22 44] );
);
New Window( "Default - menu and toolbars", g );
New Window( "Menu, no toolbars, suppress autohide",
    Suppress AutoHide( 1 ),
    Show Toolbars( 0 ),
    g
);
New Window( "Toolbars, no menu", Show Menu( 0 ), g );
New Window( "No menu, no toolbars", Show Menu( 0 ), Show Toolbars( 0 ), g );


```

#### [Dialog](#dialog_1)

```


ex = New Window( "Dialog example",
    <<Type( "Dialog" ),
    V List Box(
        Panel Box( "Sample data dialog",
            Button Box( "Open Sample Data", Open( "$SAMPLE_DATA/Big Class.jmp" ) )
        ),
        H List Box( Button Box( "Close", Try( ex << CloseWindow ) ) )
    )
);


```

#### [Invisible](#invisible)

```


g = Graph Box(
    Frame Size( 300, 300 ),
    Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    Pen Color( "Blue" );
    Line( [10 30 70], [88 22 44] );
);
w = New Window( "My Window's Title", <<WindowView( "Invisible" ), g );
p = w << Get Picture();
w << Close Window;
psize = p << Size;
New Window( "picture", Outline Box( "picture size: " || Char( psize ), p ) );


```

#### [Modal Dialog](#modal-dialog)

```


ex = New Window( "Modal Dialog example",
    <<Type( "Modal Dialog" ),
    <<Return Result,
    <<On Validate(
        num = myEditBox << Get;
        If( num >= 1 & num <= 100, // in range
            myEditBox << Background Color( "Background" ); // this field does not need attention
            1; //the number is good, validate
        , // else out of range
            myEditBox << Background Color( "Light Yellow" ); // this field needs attention
            0; // the number is bad, do not validate
        ) // the result of this if(...) is the OnValidate( ) answer, 0 or 1
        ;
    ),
    V List Box(
        Text Box( "Enter a value between [1,100]:" ),
        H List Box( myEditBox = Number Edit Box( 42 ) ),
        H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
    )
);

//  the Modal window must be closed before the following code runs

If(
    ex["button"] == 1 // not canceled
, // then show the value
    Write( ex["myEditBox"] ); // note: myEditBox is the name of the variable holding the text edit box
, // else report no selection
    Write( "CANCEL" ); // cancel button or red X was pressed
);


```

#### [Python script](#python-script)

```

pyscript = "\[import numpy as np
a = np.arange(15).reshape(3, 5)]\";
ex = New Window( "Script example", <<Type( "Script" ), <<Language( "Python" ), pyscript );


```

#### [Report](#report)

```

g = Graph Box(
    Frame Size( 300, 300 ),
    Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    Pen Color( "Blue" );
    Line( [10 30 70], [88 22 44] );
);
New Window( "My Window's Title", g );


```

#### [Script](#script)

```

script = JSL Quote(Names Default To Here(1);
dt=Open("$SAMPLE_DATA/Big Class.jmp");
dt << Run Script("Bivariate");
);
ex = New Window( "Script example", <<Type( "Script" ), script );


```

### [Number Col Box](#number-col-box)

**Syntax:** y = Number Col Box( title, numbers )

**Description:** Returns a display box to show the numbers specified by the numbers argument, which can be a list or matrix.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [Number Col Edit Box](#number-col-edit-box)

**Syntax:** y = Number Col Edit Box( title, numbers )

**Description:** Returns a display box to show the numbers specified by the numbers argument, which can be a list or matrix.

**JMP Version Added:** Before version 14

```

x = y = z = 0;
New Window( "Example",
    Modal,
    <<Return Result,
    Outline Box( "Table", Table Box( neb = Number Col Edit Box( "values", {x, y, z} ) ) )
);


```

### [Number Edit Box](#number-edit-box)

**Syntax:** y = Number Edit Box( initValue, <width> )

**Description:** Returns an edit box that accepts only numeric input. Specify the optional width argument to set the width of the box in characters.

**JMP Version Added:** Before version 14

```

New Window( "Example", neb = Number Edit Box( 5 ) );
x = neb << get;


```

### [Outline Box](#outline-box)

**Syntax:** y = Outline Box( title, <command script pairs list>, displayBox, ... )

**Description:** Creates an outline element in the report, returning the display box reference. To include a menu in the outline node, specify the command script pairs list, a list specifying menu commands and associated scripts.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        {"Show label value", Show( teb << get text )},
        H List Box( Text Box( "Label:" ), teb = Text Edit Box( Char( 213 ) ) )
    )
);


```

### [Page Break Box](#page-break-box)

**Syntax:** Page Break Box()

**Description:** Creates a display box that forces a page break.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( "Blue" );
        Line( [10 30 70], [88 22 44] );
    ),
    Page Break Box(),
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [77 44 11], [75 25 50] );
        Pen Color( "Red" );
        Line( [70 30 10], [88 22 44] );
    )
);


```

### [Panel Box](#panel-box)

**Syntax:** y = Panel Box( title, displayBoxArgs )

**Description:** Returns a display box to label and enclose the argument display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        "alpha",
        Panel Box( "panel", Text Box( "text" ) ),
        "beta",
        Popup Box( {"x", ex = 1, "y", ex = 2} )
    )
);


```

### [Picture Box](#picture-box)

**Syntax:** pict = Picture Box( Picture Object )

**Description:** Creates a display box that contains a graphics picture object. You can either open a picture and then reference it, or you can use the Open command with a path to the picture in place of the Picture Object argument.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    Picture Box( Open( "$SAMPLE_IMAGES/black rhino footprint.jpg", jpg ) )
);


```

**Example 2**

```

pict = Open( "$SAMPLE_IMAGES/black rhino footprint.jpg", jpg );
New Window( "Example", Picture Box( pict ) );


```

### [Pie Seg](#pie-seg)

**Syntax:** ps = Pie Seg(\<{ xorigin, yorigin }>, <radius>, \<style("pie", "ring", "coxcomb")>, values)

**Description:** Creates a Pie Seg at the specified origin, with the specified radius, based on values specified in matrix format.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);


```

### [Platform](#platform)

**Syntax:** y = Platform( dataTable, script )

**Description:** Evaluates the given script in the context of the given data table. Returns the resulting display box for embedding in a display tree.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Platform example",
    H List Box(
        Platform(
            dt,
            Bubble Plot( X( :weight ), Y( :height ), Sizes( :age ), Title Position( 0, 0 ) )
        ),
        Platform(
            dt,
            Bubble Plot( X( :weight ), Y( :age ), Sizes( :height ), Title Position( 0, 0 ) )
        )
    )
);


```

### [Plot Col Box](#plot-col-box)

**Syntax:** y = Plot Col Box( title, numbers )

**Description:** Returns a display box to graph the numbers. The numbers argument can be a list or matrix.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [Poly Seg](#poly-seg)

**Syntax:** ps = Poly Seg(x values, y values)

**Description:** Returns a display seg that represents a polygon with vertices based on the passed in x and y values.

**JMP Version Added:** Before version 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( "Poly Seg" ));


```

### [Popup Box](#popup-box)

**Syntax:** y = Popup Box( {label1, script1, ...} )

**Description:** Returns a display box with a popup menu defined by label/script pairs.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        "alpha",
        Popup Box( {"x", ex = 1, "y", ex = 2} ),
        "beta",
        Panel Box( "panel", Text Box( "text" ) )
    )
);


```

### [Radio Box](#radio-box)

**Syntax:** y = Radio Box( {item, ...}, <script> )

**Description:** Returns a display box to show a set of radio buttons.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    rb = Radio Box( {"single", "double", "triple"}, Show( rb << Get() ) )
);


```

### [Range Slider Box](#range-slider-box)

**Syntax:** y = Range Slider Box( minValue, maxValue, lowVariable, highVariable, script )

**Description:** Returns a display box that shows a range slider control that ranges from minValue to maxValue. As the two sliders' positions change, their values are placed into lowVariable and highVariable, and the script is run.

**JMP Version Added:** Before version 14

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);


```

### [Report](#report_1)

**Syntax:** y = Report( platform object )

**Description:** Returns a reference to the display tree for the report from a platform.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Report( Bivariate( Y( :weight ), X( :height ), Fit Line ) );


```

### [Scene Box](#scene-box)

**Syntax:** box = Scene Box( xsize, ysize )

**Description:** Returns a display box for 3D graphics.

**JMP Version Added:** Before version 14

```

Scene = Scene Box( 600, 600 );
Scene << backgroundcolor( 0 );
Scene << showarcball( always );
New Window( "See HelloWorld.jsl in sample scripts", Scene );
Scene << perspective( 45, .2, 20 );
Scene << Translate( 0.0, 0.0, -4.5 );
ex = Scene Display List();
ex << color( .9, .9, .9 );
ex << Text( center, middle, .3, "Hello World" );
Scene << arcball( ex, 1.5 );
Scene << update;


```

### [Scene Display List](#scene-display-list)

**Syntax:** list = Scene Display List()

**Description:** Returns a display list for 3D graphics.

**JMP Version Added:** Before version 14

```

ex = Scene Display List();
ex << color( .9, .9, .9 );
ex << Text( center, middle, .3, "Hello World" );
exScene = Scene Box( 600, 600 );
exScene << backgroundcolor( 0 );
exScene << showarcball( always );
New Window( "See HelloWorld.jsl in sample scripts", exScene );
exScene << perspective( 45, .2, 20 );
exScene << Translate( 0.0, 0.0, -4.5 );
exScene << arcball( ex, 1.5 );
exScene << update;


```

### [Script Box](#script-box)

**Syntax:** y = Script Box( <s>, \<"C" | "JavaScript" | "JSL" | "JSON" | "Python" | "R" | "SAS" | "SQL" | "Text" | "XML">, <width>, <height> )

**Description:** Returns a display box to edit a script. By default the editor has JSL syntax highlighting and behavior.

**JMP Version Added:** Before version 14

#### [JSL](#jsl)

```

Script = Script Box( "// This window is editable.", "JSL", 300, 100 );
New Window( "This is a script box", Script );


```

#### [Python script](#python-script_1)

```

pyscript = "\[import numpy as np
a = np.arange(15).reshape(3, 5)]\";
Script = Script Box( pyscript, "Python", 300, 100 );
New Window( "This is a python script box", Script );


```

### [Scroll Box](#scroll-box)

**Syntax:** y = Scroll Box( \<Size( x, y )>, displayBox )

**Description:** Returns a display box that positions a larger child box using scroll bars.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        Scroll Box(
            Size( 200, 100 ),
            V List Box(
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
            ),
            <<Set Stretch( "Window", "Window" )
        )
    )
);


```

### [Set Global Window Handler](#set-global-window-handler)

**Syntax:** Set Global Window Handler( Handler Function )

**Description:** Sets a function to be called each time a new window is created.

**JMP Version Added:** 17

```

Set Global Window Handler(
    Function( {window},
        Print( window << get window title() );
        window << close window();
    )
);
New Window( "My Window" );
Clear Global Window Handler();


```

### [Shape Seg](#shape-seg)

**Syntax:** me = Shape Seg( {Path(<path>), ...}, < Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) > )

**Description:** Returns a display seg with a collection of shapes. Each shape draws a stroke along the given path if fill is 0, or paints the interior of the given path if fill is not 0. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** Before version 14

```

New Window( "Shape Seg Example",
    Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);


```

### [Sheet Part](#sheet-part)

**Syntax:** y = Sheet Part( title, childbox )

**Description:** Returns a display box containing the childbox display box argument with the specified title.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [Slider Box](#slider-box)

**Syntax:** box = Slider Box(minValue, maxValue, variable, script, \<set width(n)>, \<rescale slider(minValue, maxValue)>)

**Description:** Returns a display box that shows a slider control that ranges from minValue to maxValue. As the slider's position changes, its value is placed into variable and the script is run.

**JMP Version Added:** Before version 14

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);


```

### [Spacer Box](#spacer-box)

**Syntax:** y = Spacer Box( \<Size( x, y )>, \<Color( c )>)

**Description:** Returns a display box that can be used to maintain space between other display boxes or fill a cell in a Lineup Box. The Size arguments are specified in pixels, and the Color argument is any valid JSL color.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box( N Col( 3 ),
        Text Box( "a" ),
        Spacer Box(),
        Text Box( "b" ),
        Spacer Box(),
        Text Edit Box( "Under Spacer Box" )
    )
);


```

### [Spin Box](#spin-box)

**Syntax:** y = Spin Box( <script> )

**Description:** Returns a display box to show a button with up/down controls. The script argument is invoked with an argument that indicates the direction of the arrow clicked (negative is down, positive is up). A magnitude of 1 indicates a single click, while larger values can be used to indicate a repeating action.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Lineup Box(
        2,
        nb = Number Edit Box( 3 ),
        sb = Spin Box( Function( {value}, nb << Increment( value ) ) )
    )
);
nb << Set Increment( 1 );


```

### [String Col Box](#string-col-box)

**Syntax:** y = String Col Box( title, {strings} )

**Description:** Returns a display box to show the strings specified by the strings argument, which is a list of character strings.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [String Col Edit Box](#string-col-edit-box)

**Syntax:** y = String Col Edit Box( title, {strings} )

**Description:** Returns a display box to show the strings specified by the strings argument, which is a list of character strings.

**JMP Version Added:** Before version 14

```

a = b = c = "";
New Window( "Example",
    Modal,
    <<Return Result,
    Outline Box( "Table", Table Box( seb = String Col Edit Box( "names", {a, b, c} ) ) )
);


```

### [Tab Box](#tab-box)

**Syntax:** y = Tab Box( Tab Page Box(...), TabPageBox(...), ... )

**Description:** Creates a tabbed-page panel in a display box window.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        "alpha",
        Panel Box( "panel", Text Box( "text" ) ),
        "beta",
        Popup Box( {"x", ex = 1, "y", ex = 2} )
    )
);


```

### [Tab Page Box](#tab-page-box)

**Syntax:** y = Tab Page Box( \<Title("string")>, \<Tip(0|1)>, \<Closeable(0|1)>, \<Icon("string")>, \<Moveable(0|1)>, contents)

**Description:** Returns a display box that that can be used in a Tab Box or as a stand-alone container with title. Recognized options include Title(string) to specify a title, Tip(string) to specify a tooltip, Closeable(0|1) to specify whether the page can be closed, Icon(string) to specify the icon, and Moveable(0|1) to specify whether the page can be moved.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);


```

### [Table Box](#table-box)

**Syntax:** y = Table Box( displayBox, ... )

**Description:** Returns a display box that composes a table of the String Col Box, Number Col Box, and Plot Col Box column display boxes provided by the arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Table",
        Table Box(
            String Col Box( "names", {"x", "y", "z"} ),
            Number Col Box( "values", {11, 22, 33} ),
            Plot Col Box( "values", {11, 22, 33} )
        )
    )
);


```

### [Text Box](#text-box)

**Syntax:** y = Text Box( text, \<<Justify Text( strPos ), \<<Set Wrap( width ) )

**Description:** Constructs a display box that contains the text in the string argument text. The optional arguments are available to control the text justification or set the text wrap width. The argument for Justify Text should be a string containing left, right, or center.

**JMP Version Added:** Before version 14

```

New Window( "Justification Example",
    Outline Box( "text",
        V List Box(
            Text Box( "Text implicitly justified over multiple lines:", <<Set Wrap( 100 ) ),
            Text Box( " " ),
            Text Box(
                "Text left justified over multiple lines:",
                <<Justify Text( "left" ),
                <<Set Wrap( 100 )
            ),
            Text Box( " " ),
            Text Box(
                "Text center justified over multiple lines:",
                <<Justify Text( "center" ),
                <<Set Wrap( 100 )
            ),
            Text Box( " " ),
            Text Box(
                "Text right justified over multiple lines:",
                <<Justify Text( "right" ),
                <<Set Wrap( 100 )
            )
        )
    )
);


```

### [Text Edit Box](#text-edit-box)

**Syntax:** y = Text Edit Box( text, \<<Password Style( bool ), \<<Set Script( script ), \<<Set Width( value ) )

**Description:** Constructs an editable box that contains the quoted string text, returning the display box reference. The optional arguments are available to control the display of the text, to attach a script to the text box, and to set the width in pixels of the text box. Specifying Set Width(-1) forces a resize to content. Note that a script can be attached to the text edit box either by adding the script as an optional argument or by sending the Set Script message.

**JMP Version Added:** Before version 14

```

New Window( "Example: Text Edit Box",
    Outline Box( "Picker Example",
        H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
    ),
    Outline Box( "Text Edit Box with password style Example",
        H List Box(
            Text Box( "Enter password:    " ),
            exq = Text Edit Box( "", Password Style( 1 ), Set Script( Print( "changed!" ) ) )
        ),
        Button Box( "print to log", Set Script( Print( exq << Get Text() ) ) ),
        Button Box( "hide password", Set Script( exq << Password Style( 1 ) ) ),
        Button Box( "show password", Set Script( exq << Password Style( 0 ) ) )
    )
); // "look in the log window"


```

### [Text Seg](#text-seg)

**Syntax:** seg = Text Seg("text")

**JMP Version Added:** 17

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( ts1 = Text Seg( "default location fixed bottom left" ) );


```

### [This Project](#this-project)

**Syntax:** project = this project()

**Description:** From within a project, returns the corresponding project object. Outside of a project, returns nothing.

**JMP Version Added:** 14

```

If(
    Is Empty( This Project() ), Print( "Project: (none)" ),
    Print( "Project: " || (This Project() << Get Window Title()) ),
);


```

### [Tree Box](#tree-box)

**Syntax:** tree = Tree Box( \<{rootnodes}>, \<Size( x, y )>, \<Multiselect( 0|1 )> )

**Description:** Constructs a display box to show hierarchical information.

**JMP Version Added:** Before version 14

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );


```

### [Tree Node](#tree-node)

**Syntax:** node = Tree Node( <label> )

**Description:** Constructs a tree node intended for display within a Tree Box.

**JMP Version Added:** Before version 14

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Nodes", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );


```

### [Triangulation](#triangulation)

**Syntax:** triangulation = Triangulation( X(Column1, Column2), < Y(Column) > )

**Description:** Returns an object containing the Delaunay triangulation of the given point set. The optional Y will be averaged for duplicate points, and all points in the output will be unique.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );


```

**Example 2**

```

tri = Triangulation( X( [0 0 1 1], [0 1 0 1] ), Y( [0 1 2 3] ) );


```

### [Unlineup Box](#unlineup-box)

**Syntax:** y = UnLineup Box(displayBoxArgs, ... )

**Description:** Returns a display box that temporarily suspends the column layout of a Lineup Box. The child of the Unlineup Box will be stretched to span all columns of the Lineup Box.

**JMP Version Added:** 16

```

New Window( "unlineup",
    Lineup Box( N Col( 2 ),
        Unlineup Box( Text Box( "First Section", <<Justify Text( "Center" ) ) ),
        Button Box( "First Section 1" ),
        Button Box( "First Section 2" ),
        Unlineup Box( Text Box( "Second Section", <<Justify Text( "Center" ) ) ),
        Button Box( "Second Section 1" ),
        Button Box( "Second Section 2" )
    )
);


```

### [V Center Box](#v-center-box)

**Syntax:** y = V Center Box( <childbox> )

**Description:** Returns a display box with the childbox display box argument centered in the vertical space defined by the maximum size of that child and all the other siblings of the center box.

**JMP Version Added:** Before version 14

```

New Window( "test",
    H List Box(
        V Center Box( Text Box( "V+V" ) ),
        V List Box(
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            H Center Box( Text Box( "H+H" ) ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" )
        )
    )
);


```

### [V List Box](#v-list-box)

**Syntax:** y = V List Box( \<Align( center|right )>, displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a vertical layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for right or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker", V List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ) )
);


```

### [V Scroll Box](#v-scroll-box)

**Syntax:** y = V Scroll Box( \<Size( y )>, displayBox )

**Description:** Returns a display box that positions a larger child box using a vertical scroll bar.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Outline Box( "Picker",
        V Scroll Box(
            Size( 100 ),
            V List Box(
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ),
                H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) )
            ),
            <<Set Stretch( "Window", "Window" )
        )
    )
);


```

### [V Sheet Box](#v-sheet-box)

**Syntax:** y = V Sheet Box( \<<Hold( rpt ), displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a vertical layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for right or center alignment of the contents inside the display box.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [V Splitter Box](#v-splitter-box)

**Syntax:** y = V Splitter Box( \<Size(x,y)>, displayBox, ... )

**Description:** Returns a display box that arranges other display boxes vertically, with interactive control of sizes. Child sizes are specified as a proportion of the width or height of the Splitter Box. The optional Size argument is only used for the top-most Splitter Box; lower level boxes are sized like any other child box.

**JMP Version Added:** Before version 14

```

New Window( "Splitter",
    V Splitter Box(
        Size( 800, 600 ),
        H Splitter Box( graph = Graph Box(), Script Box(), <<Sizes( {0.6, 0.4} ) ),
        H Splitter Box(
            pict = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ),
            spacer = Spacer Box(),
            <<Sizes( {0.4, 0.6} )
        )
    )
);
graph[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
pict << Set Min Size( 100, 100 );
pict << Set Max Size( 500, 500 );
pict << Set Stretch( "Window", "Window" );
spacer << Set Fill( 1 );
spacer << Color( "Red" );
spacer << Set Stretch( "Window", "Window" );


```

### [Web Browser Box](#web-browser-box)

**Syntax:** wb = Web Browser Box( url )

**Description:** Returns a display box to view a web page, specified by the url string argument.

**JMP Version Added:** Before version 14

```

New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Window", "Window" );
wb << Set Max Size( 10000, 10000 );


```

### [Window](#window)

**Syntax:** y = Window( \<string|int> )

**Description:** This function is deprecated and retained only for backward compatibility with existing scripts. For new scripts, use Get Window() or Get Window List().

**JMP Version Added:** Before version 14

```

Window( "Big Class" );


```

### [With Window Handler](#with-window-handler)

**Syntax:** With Window Handler( JSL Code, Handler Function )

**Description:** Runs a block of code with a function to be called each time a new window is created.

**JMP Version Added:** 17

```

With Window Handler(
    New Window( "My Window" ),
    Function( {window},
        Print( window << get window title() );
        window << close window();
    )
);


```

### [Wrap List Box](#wrap-list-box)

**Syntax:** y = Wrap List Box( displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout, but will wrap that list when printing.

**JMP Version Added:** Before version 14

```

New Window( "WrapListBox",
    Wrap List Box(
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "1" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "2" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "3" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "4" ) )
    )
);


```

# [Expression](#expression)

### [Arg](#arg)

**Syntax:** y = Arg( x, i )

**Description:** Returns the ith argument of the evaluated expression or Empty() if there is no ith argument.

**JMP Version Added:** Before version 14

```

Arg( Expr( Sum( a, b, c ) ), 2 );


```

### [Arg Expr](#arg-expr)

**Syntax:** y = Arg Expr( expr, i )

**Description:** Returns the ith argument of the expression or Empty() if there is no ith argument. This function is deprecated. Please use Arg() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Arg Expr() equivalent
Arg( Expr( Sum( a, b, c ) ), 2 );


```

**Example 2**

```

// Deprecated
Arg Expr( Sum( a, b, c ), 2 );


```

### [Eval Expr](#eval-expr)

**Syntax:** y = Eval Expr( x )

**Description:** Returns a copy of expression x with each Expr() clause within x replaced with its evaluated value.

**JMP Version Added:** Before version 14

```

Eval Expr( Length( Expr( "X" || Char( 12 ) ) ) );


```

### [Expr](#expr)

**Syntax:** y = Expr( x )

**Description:** Returns its argument unevaluated. Used to quote expressions.

**JMP Version Added:** Before version 14

```

Expr( x + y );


```

### [Extract Expr](#extract-expr)

**Syntax:** y = Extract Expr( expr, pattern )

**Description:** Returns a subexpression matching the specified pattern.

**JMP Version Added:** Before version 14

```

Extract Expr( a + b * c, Wild() * Wild() );


```

### [Head](#head)

**Syntax:** y = Head( x )

**Description:** Returns the head of the evaluated expression, without its arguments.

**JMP Version Added:** Before version 14

```

Head( Expr( Sum( a, b, c ) ) );


```

### [Head Expr](#head-expr)

**Syntax:** y = Head Expr( expr )

**Description:** Returns the head of the expression, without its arguments. This function is deprecated. Please use Head() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Head Expr() equivalent
Head( Expr( Sum( a, b, c ) ) );


```

**Example 2**

```

// Deprecated
Head Expr( Sum( a, b, c ) );


```

### [Head Name](#head-name)

**Syntax:** y = Head Name( x )

**Description:** Returns the head of the evaluated expression as a string, without its arguments.

**JMP Version Added:** Before version 14

```

Head Name( Expr( Sum( a, b, c ) ) );


```

### [Head Name Expr](#head-name-expr)

**Syntax:** y = Head Name Expr( expr )

**Description:** Returns the head of the expression as a string, without its arguments. This function is deprecated. Please use Head Name() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated Head Name Expr() equivalent
Head Name( Expr( Sum( a, b, c ) ) );


```

**Example 2**

```

// Deprecated
Head Name Expr( Sum( a, b, c ) );


```

### [N Arg](#n-arg)

**Syntax:** n = N Arg( expr )

**Description:** Returns the number of arguments of the evaluated expression head.

**JMP Version Added:** Before version 14

```

N Arg( Expr( Sum( a, b, c ) ) );


```

### [N Arg Expr](#n-arg-expr)

**Syntax:** n = N Arg Expr( expr )

**Description:** Returns the number of arguments of the expression head. This function is deprecated. Please use N Arg() instead.

**JMP Version Added:** Before version 14

**Example 1**

```

// See Example 2 for the deprecated N Arg Expr() equivalent
N Arg( Expr( Sum( a, b, c ) ) );


```

**Example 2**

```

// Deprecated
N Arg Expr( Sum( a, b, c ) );


```

### [Name Expr](#name-expr)

**Syntax:** y = Name Expr( x )

**Description:** Returns the value of a symbol, without evaluating it if it is an expression.

**JMP Version Added:** Before version 14

```

ex = Expr( 1 + 2 );
Eval List( {ex, Name Expr( ex )} );


```

# [File](#file)

### [Close](#close)

**Syntax:** Close( \<dataTableRef|name>, \<NoSave|Save( "path" )> )

**Description:** Closes the data table referenced by the first argument, which defaults to the current data table in the current project (or no project if not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

The second argument is used to save the data table. Use an appropriate file extension in the path to save the data table as a non-JMP format. Specifying NoSave bypasses the prompt to save or disregard changes.

**JMP Version Added:** Before version 14

```

exdt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 3 );
Close( exdt, NoSave );


```

### [Close All](#close-all)

**Syntax:** Close All( \<Project(title|index|box|window)>, Data Tables | Reports | Journals, \<invisible | private>, \<NoSave|Save> )

**Description:** Closes all open resources of a specific type: data tables, journals, or reports.

Only windows in the current project (or no project if not running the script in a project) will be closed. To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

exdt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
exdt2 = Open( "$SAMPLE_DATA/Animals.jmp" );
Wait( 3 );
Close All( Data Tables, NoSave );


```

### [Convert File Path](#convert-file-path)

**Syntax:** path = Convert File Path( path, \<absolute|relative>, \<posix|windows>, \<base( path )>, <search> )

**Description:** Returns the converted path.

**JMP Version Added:** Before version 14

```

For Each( {pv},
    {"HOME", "DOCUMENTS", "SAMPLE_DATA", "SAMPLE_IMPORT_DATA", "SAMPLE_SCRIPTS",
    "SAMPLE_IMAGES", "USER_APPDATA", "USER_JMPDATA", "MAPS", "USER_JMPDATA_ALL", "TEMP"},
    Write(
        pv || Repeat( " ", 20 - Length( pv ) ) || " => " || Convert File Path( "$" || pv )
         || "\!N"
    )
);


```

### [Copy Directory](#copy-directory)

**Syntax:** rc = Copy Directory( from, to, \<recursive(0|1)> )

**Description:** Copies files from one directory to another, optionally copying subdirectories. The directory name will be created at the to-path and should not be part of the to-path. Returns 1 if the directory was copied or 0 if the directory was unable to be copied. Throws an error if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Copy Directory( "$SAMPLE_DATA/Loss Function Templates", "$TEMP" );/* creates $TEMP/Loss Function Templates */ 
rc1 = File Exists( "$TEMP/Loss Function Templates/Normal.jmp" );
rc2 = Delete File( "$TEMP/Loss Function Templates/Normal.jmp" );
rc3 = File Exists( "$TEMP/Loss Function Templates/Normal.jmp" );
rc4 = Delete Directory( "$TEMP/Loss Function Templates" );
rc5 = Directory Exists( "$TEMP/Loss Function Templates" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 1 0 1 0 */


```

### [Copy File](#copy-file)

**Syntax:** rc = Copy File( from, to )

**Description:** Copies a file from the original file to a new file with the same or a different name. Specify a complete path and file name for the destination. Returns 1 if the file was copied or 0 if the file was unable to be copied. Throws an error if the path is invalid or does not exist. A file cannot be copied when either the from or to path is invalid, or if the to file already exists.

**JMP Version Added:** Before version 14

```

rc0 = File Exists( "$TEMP/x.jmp" );
rc1 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc2 = File Exists( "$TEMP/x.jmp" );
rc3 = Delete File( "$TEMP/x.jmp" );
rc4 = File Exists( "$TEMP/x.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 );/* 0 1 1 1 0 */


```

### [Create Directory](#create-directory)

**Syntax:** rc = Create Directory( path )

**Description:** Creates a directory. Returns 1 if directory was created. Returns 0 if the directory already exists or if JMP was unable to create the directory.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/sub1" );
rc0 = Create Directory( "$TEMP/sub1/sub2/sub3" );
Save Text File( "$TEMP/sub1/sub2/sub3/temp.txt", "example text" );
date = Last Modification Date( "$TEMP/sub1/sub2/sub3/temp.txt" );
rc1 = Delete Directory( "$TEMP/sub1" );
rc2 = File Exists( "$TEMP/sub1/sub2/sub3/temp.txt" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " ||
Format( date, "ddmonyyyy:h:m:s" );/* 1 1 0 date:time */


```

### [Create Excel Workbook](#create-excel-workbook)

**Syntax:** Create Excel Workbook(<Workbook Name>, \<{List of open tables}>, <Optional list of worksheet names> )

**Description:** Generate an Excel Workbook from open JMP Data Tables

**JMP Version Added:** Before version 14

**Example 1**

```

dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt2 = Open( "$SAMPLE_DATA/Abrasion.jmp" );
Create Excel Workbook( "$TEMP/MyWorkbook.xlsx", {dt1, dt2}, {"Big", "Abrasive"} );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Abrasion.jmp" );
Create Excel Workbook(
    "$TEMP/MyWorkbook.xlsx",
    {"Big Class", "Abrasion"},
    {"Big", "Abrasive"}
);


```

### [Creation Date](#creation-date)

**Syntax:** date = Creation Date( path )

**Description:** Returns the creation date of a file or directory. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Format( Creation Date( "$SAMPLE_DATA/Big Class.jmp" ), "ddmonyyyy:h:m:s" );


```

### [Delete Directory](#delete-directory)

**Syntax:** rc = Delete Directory( path, \<Allow Undo( boolean )> )

**Description:** Deletes a directory and its files and subdirectories. Returns 1 if the directory was deleted. Returns 0 if directory was unable to be deleted or the path is invalid.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/sub1" );
rc0 = Create Directory( "$TEMP/sub1/sub2/sub3" );
Save Text File( "$TEMP/sub1/sub2/sub3/temp.txt", "example text" );
date = Last Modification Date( "$TEMP/sub1/sub2/sub3/temp.txt" );
rc1 = Delete Directory( "$TEMP/sub1" );
rc2 = File Exists( "$TEMP/sub1/sub2/sub3/temp.txt" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " ||
Format( date, "ddmonyyyy:h:m:s" );/* 1 1 0 date:time */


```

### [Delete File](#delete-file)

**Syntax:** rc = Delete File( path, \<Allow Undo( boolean )> )

**Description:** Deletes a file. Returns 1 if the file was deleted. Returns 0 if file was unable to be deleted. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc1 = File Exists( "$TEMP/x.jmp" );
rc2 = Delete File( "$TEMP/x.jmp" );
rc3 = File Exists( "$TEMP/x.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) /* 1 1 1 0 */;


```

### [Directory Exists](#directory-exists)

**Syntax:** rc = Directory Exists( path )

**Description:** Determine whether the directory exists. Returns 1 if the path exists. Returns 0 if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

If( Directory Exists( "$SAMPLE_DATA/Loss Function Templates" ),
    "ok",
    "missing!"
);


```

### [File Exists](#file-exists)

**Syntax:** rc = File Exists( path )

**Description:** Determine whether the file exists. Returns 1 if the file path exists. Returns 0 if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

If( File Exists( "$SAMPLE_DATA/Big Class.jmp" ),
    "ok",
    "missing!"
);


```

### [File Size](#file-size)

**Syntax:** size = File Size( path )

**Description:** Returns the size of the file at the given path. Returns missing when file path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

File Size( "$SAMPLE_DATA/Big Class.jmp" );


```

### [Files In Directory](#files-in-directory)

**Syntax:** y = Files In Directory( "path", \<recursive(0|1)>, \<include hidden(0|1)> )

**Description:** Returns the list of file names in a directory that is specified by path. If the Recursive argument is not specified, directory names are included in the list.

**JMP Version Added:** Before version 14

**Example 1**

```

Files In Directory( "$HOME" );


```

**Example 2**

```

Filter Each( {fn}, Files In Directory( "$SAMPLE_DATA", recursive( 1 ) ),
    Contains( Lowercase( fn ), "stacked" )
);


```

### [Find All](#find-all)

**Syntax:** Find All( \<Project(title|index|box|window)>, Data Tables | Reports | Journals, \<invisible | private> )

**Description:** Finds all open resources of a specific type: data tables, journals, or reports.

Only windows in the current project (or no project if not running the script in a project) will be included. To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** 14

```


exdt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
exdt2 = Open( "$SAMPLE_DATA/Animals.jmp" );
windows = Find All( Data Tables );
For( i = 1, i <= N Items( windows ), i++,
    Write( Char( windows[i] << Get Window Title ) || "\!N" )
);


```

### [Get Default Directory](#get-default-directory)

**Syntax:** y = Get Default Directory()

**Description:** Returns the JMP default directory, which is used as a base for subsequent relative paths. This path is the directory containing the currently executing script if the script is saved.

**JMP Version Added:** Before version 14

```

Show( Get Default Directory() );
Set Default Directory( "$SAMPLE_DATA" );
Show( Get Default Directory() );


```

### [Get Excel Worksheets](#get-excel-worksheets)

**Syntax:** list = Get Excel Worksheets("filepath")

**Description:** Returns a list of worksheets within an Excel Workbook

**JMP Version Added:** Before version 14

```

sheetList = Get Excel Worksheets( "$SAMPLE_IMPORT_DATA\Team Results.xlsx" );
Show( sheetList );


```

### [Get File Search Path](#get-file-search-path)

**Syntax:** y = Get File Search Path()

**Description:** Returns the current list of directories to search for opening files.

**JMP Version Added:** Before version 14

```

Get File Search Path();


```

### [Get Path Variable](#get-path-variable)

**Syntax:** value = Get Path Variable( name )

**Description:** Returns the value of a path variable, which is a name like SAMPLE_DATA that is substituted for when found in pathnames.

**JMP Version Added:** Before version 14

**Example 1**

```

Get Path Variable( "SAMPLE_DATA" );
/* try: SAMPLE_DATA, SAMPLE_IMPORT_DATA, SAMPLE_SCRIPTS
See full listing of Path Variables in the other example
See also Convert File Path() and Set Path Variable() */


```

#### [Listing](#listing)

```

// Run for a Path Variable listing
path vars = {"SAMPLE_DATA", "DESKTOP", "DOCUMENTS", "DOWNLOADS", "TEMP", "HOME",
"USER_APPDATA", "ALL_HOME", "BUILTIN_SCRIPTS", "SAMPLE_APPS", "SAMPLE_DASHBOARDS",
"SAMPLE_IMAGES", "SAMPLE_IMPORT_DATA", "SAMPLE_PROJECTS", "SAMPLE_SCRIPTS"};
path vars ||= Transform Each( {id}, Get Addins() << ID, Eval Insert( "ADDIN_HOME(^id^)" ) );
path vars = Filter Each( {var}, path vars, Directory Exists( Get Path Variable( var ) ) );

New Window( "Path Variables",
    <<Type( "Dialog" ),
    Outline Box( "Path Variables",
        H List Box(
            Button Box( "Open Paths",
                For Each( {row}, tbl << Get Selected Rows, {path},
                    path = tbl[String Col Box( 2 )] << Get( row );
                    Open( path );
                )
            ),
            Button Box( "Copy Paths",
                If( N Items( tbl << Get Selected Rows ),
                    Set Clipboard(
                        Concat Items(
                            Transform Each( {row}, tbl << Get Selected Rows, Output( "List" ),
                                tbl[String Col Box( 2 )] << Get( row )
                            ),
                            "\!N"
                        )
                    )
                )
            )
        ),
        window:tbl = Table Box(
            String Col Box( "Variable", path vars ),
            String Col Box( "Path",
                Transform Each( {var}, path vars, Get Path Variable( var ) )
            ),
            <<Set Selectable Rows
        )
    )
);


```

### [Google Sheet Export](#google-sheet-export)

**Syntax:** Google Sheet Export(dt, Email(address), Spreadsheet(url|id) | New Spreadsheet(name), Sheet Name(name))

**Description:** Exports a Data Table to a new Google Spreadsheet or a new Sheet within an existing Google Spreadsheet.

**JMP Version Added:** 15

```

email = "youremail@gmail.com"; //Replace this with your email
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Google Sheet Export(
    dt,
    Email( email ),
    New Spreadsheet( "JSL Example" ),
    Sheet Name( "Example 1" )
);


```

### [Google Sheet Import](#google-sheet-import)

**Syntax:** Google Sheet Import(Email(address), Spreadsheet(url|id), \<Sheets("sheetName1", ... "sheetNameN")>, \<Sheet Settings( Has Column Headers(Boolean), Data Starts on Row(n), Cell Range(range), Import Cell Colors(Boolean), Supress Empty Columns(Boolean))>)

**Description:** Opens a Google Sheet file.

**JMP Version Added:** 15

```

email = "youremail@gmail.com"; //Replace this with your email
spreadsheet =
"https://docs.google.com/spreadsheets/d/1AqV2ZkzzMtFrk-devlFdQW2Sb09ipOQaCQ1p0iho-iE/"; 

Google Sheet Import(
    Email( email ),
    Spreadsheet( spreadsheet ),
    Sheets( "Sheet1", "Sheet2" ),
    Sheet Settings(
        Has Column Headers( 0 ),
        Data Starts on Row( 1 ),
        Cell Range( "A1:C2" ),
        Import Cell Colors( 0 ),
        Suppress Empty Columns( 1 )
    )
);


```

### [Is Directory](#is-directory)

**Syntax:** rc = Is Directory( path )

**Description:** Determine if the given path is a directory. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Is Directory( "$SAMPLE_DATA" );
rc1 = Is Directory( "$SAMPLE_DATA/Big Class.jmp" );
Char( rc0 ) || " " || Char( rc1 );/* 1 0 */


```

### [Is Directory Writable](#is-directory-writable)

**Syntax:** rc = Is Directory Writable( path )

**Description:** Determine if the given directory path is writable. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Is Directory Writable( "$SAMPLE_DATA" );


```

### [Is File](#is-file)

**Syntax:** rc = Is File( path )

**Description:** Determine if the given path is a file. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Is File( "$SAMPLE_DATA" );
rc1 = Is File( "$SAMPLE_DATA/Big Class.jmp" );
Char( rc0 ) || " " || Char( rc1 );/* 0 1 */


```

### [Is File Writable](#is-file-writable)

**Syntax:** rc = Is File Writable( path )

**Description:** Determine if the given file path is writable. Returns 0 when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Is File Writable( "$SAMPLE_DATA/Big Class.jmp" );


```

### [JSON Literal](#json-literal)

**Syntax:** l = JSON Literal( string )

**Description:** Returns a valid JSON Boolean or null constant value depending on the specification of the parameter.

**JMP Version Added:** 14

```


myJSON =
"{ \!"myChar\!": \!"Character Value\!", \!"myNum\!": 12345, \!"myBool\!": true, \!"myOtherChar\!": \!"Another char value\!", \!"myNull\!": null, \!"x\!": 54321, \!"myOtherBool\!": false, \!"y\!": \!"Hello\!" }";
parsed = Parse JSON( myJSON );
x = parsed["myBool"];
Show( x );
If( x == JSON Literal( true ),
    Show( "Worked" ),
    Show( "Didn't work" )
);


```

### [JSON To Data Table](#json-to-data-table)

**Syntax:** dt = JSON To Data Table( jsonstring, \<Invisible( boolean ) | Private( boolean )>, \<Guess(Stack(Boolean)|"Tall"|"Wide")>, \<JSON Settings(...)> )

**Description:** Convert JSON text to a JMP data table

**JMP Version Added:** 14

```

dt = JSON To Data Table(
    "[ { \!"name\!": \!"KATIE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 59, \!"weight\!": 95 }, { \!"name\!": \!"LOUISE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 61, \!"weight\!": 123 }, { \!"name\!": \!"JANE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 55, \!"weight\!": 74 } ]"
);


```

### [JSON To List](#json-to-list)

**Syntax:** l = JSON To List( jsonstring )

**Description:** Convert JSON text to a JSL list representing the structure specified by the JSON data.

**JMP Version Added:** Before version 14

```

l = JSON To List(
    "[ { \!"name\!": \!"KATIE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 59, \!"weight\!": 95 }, { \!"name\!": \!"LOUISE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 61, \!"weight\!": 123 }, { \!"name\!": \!"JANE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 55, \!"weight\!": 74 } ]"
);
Show( l );


```

### [Last Modification Date](#last-modification-date)

**Syntax:** date = Last Modification Date( path )

**Description:** Returns the last modification date of a file or directory. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Format( Last Modification Date( "$SAMPLE_DATA/Big Class.jmp" ), "ddmonyyyy:h:m:s" );


```

### [Load Text File](#load-text-file)

**Syntax:** text = Load Text File( path, \<Charset("best guess", \<force("throw" | "alert" | "silent")>)>, \<LineSeparator("!N")>, <XMLParse>|<SASODSXML>|<JSON>|\<BLOB( \<readOffsetFromBegin(0)>|\<readOffsetFromEnd(42)>, \<readLength(2147483647)>, \<base64Compressed( 1 / *0: ascii~hex* /)> )> )

**Description:** Reads a whole text file into a JSL variable. Load Text File() prompts for a file name. Load Text File( path ) returns a string. The XMLParse option converts XML into an expression tree. The SASODSXML parses as SAS ODS default XML. The [{JSON}] option converts JSON into an expression tree. The BLOB argument returns binary data in a JSL Blob variable; optional named parameters to BLOB enable reading a substring from the file.

**JMP Version Added:** Before version 14

```

ex = Load Text File(
    Get Path Variable( "sample_import_data" ) || "/animals.txt"
/*, Charset("ascii")*/
/*, LineSeparator("\!r\!n")*/
/*, BLOB*/
);
Word( 4, ex, " \!t\!n\!r" );


```

### [Move Directory](#move-directory)

**Syntax:** rc = Move Directory( from, to )

**Description:** Moves a directory from one place to another. Returns 1 if the directory was moved. Returns 0 if the directory was unable to be moved. Throws an error if the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/subB" );
Delete Directory( "$TEMP/Loss Function Templates" );
rc0 = Copy Directory( "$SAMPLE_DATA/Loss Function Templates", "$TEMP" );
Create Directory( "$TEMP/subB" );
rc1 = Move Directory( "$TEMP/Loss Function Templates", "$TEMP/subB" );
rc2 = Directory Exists( "$TEMP/Loss Function Templates" );
rc3 = Directory Exists( "$TEMP/subB" );
rc4 = Delete Directory( "$TEMP/subB" );
rc5 = Directory Exists( "$TEMP/subB" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Move File](#move-file)

**Syntax:** rc = Move File( from, to )

**Description:** Moves a file from one place to another. Returns 1 if the file was moved. Returns 0 if the file was unable to be moved. Throws an error when the path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

If( File Exists( "$TEMP/y.jmp" ),
    Delete File( "$TEMP/y.jmp" )
);
rc0 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc1 = Move File( "$TEMP/x.jmp", "$TEMP/y.jmp" );
rc2 = File Exists( "$TEMP/x.jmp" );
rc3 = File Exists( "$TEMP/y.jmp" );
rc4 = Delete File( "$TEMP/y.jmp" );
rc5 = File Exists( "$TEMP/y.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Open](#open)

**Syntax:** Open( filePath, \<data table options | Excel import options | text import options | SAS import options | HTML import options | esriShapeFile import options | PDF import options | other file options > )

**Description:** Returns a reference to a data table or other JMP file or object created from a file. If no path is specified, the Open dialog appears. If a folder path is specified, the system file browser is opened and no object is returned. Refer to the Syntax Reference for a complete description of available options.

**JMP Version Added:** Before version 14

#### [Add-In](#add-in)

```

/* Installing Add-In:
Open( Add-In to open,
    <Check For Updates( "never" | "startup" | "always")>, // "always" will check for updates at startup and while jmp is running
    <Update Prompt(0|1)>) // whether or not the add-in will silently update or prompt first */
Open( "$downloads\test.jmpaddin", Check For Updates( "always" ), Update Prompt( 1 ) );


```

#### [Data Table](#data-table)

```

/* Data tables, other JMP files, external files:
   Open( filePath,
     <Invisible | Private>,
     <Select Columns( "col", ... )>,
     <Ignore Columns( "col", ... )>,
     <Add to Recent Files(bool)>,
     <Quarantine Action("Allow Scripts"|"Block Scripts"|"Do Not Open"|"Show Dialog")>
     <Force Refresh>,
     <Enable Filter Views(bool)>,
     <"file type">
   )
*/
//Basic data table open
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
//Data table open with some options
dt2 = Open( "$SAMPLE_DATA/Fitness.jmp", Select Columns( "Name", "Sex", "Age", "Weight" ) );


```

#### [Excel](#excel)

```

/* Excel files imported into a data table:
   Open( excelFilePath,
     <Worksheets( "sheet name" | {"sheet name", "sheet name", ...} | "n" )>,
     <Use for all sheets(0|1)>,
     <Concatenate Worksheets(0|1)>,
     <Create Concatenation Column(0|1)>,
     <Worksheet Settings( 0|1,
       Has Column Headers(0|1),
       Number of Rows in Headers(n),
       Headers Start on Row(n),
       Data Starts on Row(n),
       Data Starts on Column(n),
       Data Ends on Row(n),
       Data Ends on Column(n),
       Replicated Spanned Rows(0|1),
       Suppress Hidden Rows(0|1),
       Suppress Hidden Columns(0|1),
       Treat as Hierarchy(0|1)
     )>,
     <Invisible | Private>
   )
*/

/* Using the Excel Wizard dialog:
   Open("$SAMPLE_IMPORT_DATA/Bigclass.xlsx", "Excel Wizard");  
*/

dt = Open(
    "$SAMPLE_IMPORT_DATA/Team Results.xlsx",
    Worksheets( "Ungrouped Team Results" ),
    Worksheet Settings( Headers Start on Row( 3 ), Data Starts on Row( 4 ) )
);


```

#### [Folder](#folder)

```

/* Open of folder launches file browser */
Open( "$SAMPLE_DATA" );


```

#### [Other](#other)

```

/* Other options:
   SAS File imported as a data table:
   Open( sasFilePath,
     <Invisible | Private>,
     <Use Labels for Var Names(0|1)>,
     <Password( "password" )>
   )

   SAS Transport File imported as a data table, members are separate tables within the larger file:
   Open( sasTransportFilePath,
     <Use Labels for Var Names(0|1)>,
     <Members({"Table1", "Table2"})>
   )

   HTML file imported as a data table:
   Open( htmlFilePath,
     <Invisible | Private>,
     <HTML Table(n, <ColumnNames(n)>, DataStarts(n)>)>
   )

   Get column names as a list for a JMP Data Table without opening the table:
   Open( jmpDataTableFilePath, 
     "Column Names Only"
   )

   esriShapeFile opened for use as a map shape data table:
   Open( esriShapeFilePath,
     <Invisible | Private>,
     Columns( Shape=numeric(n),
     Part=numeric(n),
     X=numeric(n),
     Y=numeric(n) ),
              Polygon Import Options(Simplification Factor(f), Geodesic(g))
   )
*/
//SAS Example:
dt1 = Open( "$SAMPLE_IMPORT_DATA/Bigclass.sas7bdat", Use Labels for Var Names( 1 ) );

// HTML Example:
dt2 = Open(
    "https://en.wikipedia.org/wiki/Black_Mountains_(North_Carolina)",
    HTML Table( 3, Column Names( 1 ), Data Starts( 2 ) )
);

// Column Names Only Example: 
colNames = Open( "$SAMPLE_DATA/Semiconductor Capability.jmp", "Column Names Only" );

// SHP Shapefile Example with polygon simplification: 
Open(
    "$SAMPLE_IMPORT_DATA/parishes.shp",
    Polygon Import Options( Simplification Factor( 200 ), Geodesic( 1 ) )
);


```

#### [PDF](#pdf)

```

/* PDF file imported as one or multiple data tables
open(pdfFilePath,
    PDF Tables(Table(<Name(name)>, Add Rows(Page(n | {page list}), <Header Rows(n)>, Rect(top, left, right, bottom), <RowBorders(n, ...)>, <Column Borders(n, ....)>), ...)) |
    PDF All Tables(< Combine(All | Matching Headers | None)>, <Minimum Rows(n)>, <Minimum Columns(n)>) |
    PDF Text(<Pages(n, ...)>, <sort>) |
    PDF Wizard
);*/
dt = Open( "$SAMPLE_DATA\big class.jmp" );
w = New Window( "test", Data Table Box( dt ) );
w << save picture( "$DOCUMENTS\test.pdf", pdf );
pdftable = Open( "$DOCUMENTS\test.pdf", PDF All Tables( Combine( all ) ) ); // just some of the rows
pdftable2 = Open(
    "$DOCUMENTS\test.pdf",
    PDF Tables( Table( Table Name( "test" ), Add Rows( Page( 1 ), Rect( 0, 0, 5, 3 ) ) ) )
);


```

#### [Picture](#picture)

```

/* Picture file imported as a picture object */
pic = Open( "$SAMPLE_IMAGES/tile.jpg", jpg );
New Window( "Picture", Outline Box( "Picture", Picture Box( pic ) ) );


```

#### [Text](#text)

```

/* Text files imported into a data table:
   Open( textFilePath,
     <Invisible | Private>,
     CharSet("option") // "Best Guess", "utf-8", "utf-16", "us-ascii", "windows-1252", "x-max-roman", "x-mac-japanese", "shift-jis", "euc-jp", "utf-16be", "gb2312"
     <Number of Columns(n)>,
     <Columns(colName=colType(colWidth),... )>,// colType is Character|Numeric and colWidth is an integer specifying the width of the column
     <End Of Field (Tab|Space|Comma|Semicolon|Other|None)>,
     <EOF Other ("char")>,
     <End Of Line (CRLF|CR|LF|Semicolon|Other)>,
     <EOL Other ("char")>,
     <Strip Quotes|Strip Enclosing Quotes (0|1)>,
     <Labels|Table Contains Column Headers (0|1)>,
     <Year Rule|Two digit year rule ("decade start")>, // For example, if the earliest date is 1979, use "1970". If the earliest date is 2001, use "20xx".
     Treat Empty Columns as Numeric(0|1)
     Scan Whole File(0|1) // 1 means scan the whole file and 0 means scan for 5 seconds.
     <Column Names Start|Column Names are on line (n)>,
     <Data Starts|Data starts on line (n)>,
     <Lines to Read>, // a number
     <Use Apostrophe as Quotation Mark>,
     <CompressNumericColumns(0|1)>,
     <CompressCharacterColumns(0|1)>,
     <CompressAllowListCheck(0|1)>
   )
*/
dt = Open( "$SAMPLE_IMPORT_DATA/EOF_comma.txt", Table Contains Column Headers( 0 ) );


```

### [Parse JSON](#parse-json)

**Syntax:** l = Parse JSON( jsonstring )

**Description:** Convert JSON text to a JSL list or associative array representing the structure specified by the JSON data.

**JMP Version Added:** 14

```

l = Parse JSON(
    "[ { \!"name\!": \!"KATIE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 59, \!"weight\!": 95 }, { \!"name\!": \!"LOUISE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 61, \!"weight\!": 123 }, { \!"name\!": \!"JANE\!", \!"age\!": 12, \!"sex\!": \!"F\!", \!"height\!": 55, \!"weight\!": 74 } ]"
);
Show( l );


```

### [Pick Directory](#pick-directory)

**Syntax:** path = Pick Directory( <prompt>, <path>, \<Show Files( boolean )> )

**Description:** Prompts the user with an Open Directory window, returning the pathname of the chosen directory. The optional prompt string is shown at the top of the window. Show Files can be any of the three arguments, and takes a Boolean argument. 1 shows files in the Pick Directory window, 0 does not. The default value is 0. The path string specifies the directory that the Pick Directory window initially displays. If you use the path string, it must follow the prompt string, but Show Files can be between them.

**JMP Version Added:** Before version 14

#### [Show Files](#show-files)

```

Pick Directory( "Select a directory", "$DOCUMENTS", Show Files( 1 ) );


```

#### [Simple](#simple)

```

Pick Directory( "Select a directory" );


```

### [Pick File](#pick-file)

**Syntax:** path = Pick File( <prompt>, <initial directory>, <filterList>, <first filter>, \<saveFlag=0|1>, <default file>, <multiple> )

**Description:** Prompts the user with an Open window, returning the pathname of the chosen file. The filterList argument is a list of strings of the form: "Label|suffix1;suffix2;...". The first filter argument specifies which filter is initially shown. The fifth argument indicates whether the window should function as a save (saveFlag = 1) or open (saveFlag = 0) window. The default file argument specifies the file that is initially selected. The multiple argument allows multiple files to be selected if saveFlag is 0.

**JMP Version Added:** Before version 14

**Example 1**

```

Pick File(
    "Select JMP File",
    "$DOCUMENTS",
    {"JMP Files|jmp;jsl;jrn", "All Files|*"},
    1,
    0,
    "newJmpFile.jmp"
);


```

**Example 2**

```

Files = Pick File(
    "Select JMP File",
    "$SAMPLE_DATA",
    {"JMP Files|jmp;jsl;jrn", "All Files|*"},
    1,
    0,
    "",
    "multiple"
);
For( i = 1, i <= N Items( Files ), i++,
    Try( Open( Files[i] ) )
);


```

**Example 3**

```

filename = Pick File(
    "Save As Text",
    "$DOCUMENTS",
    {"Text File|txt"},
    1,
    1, // Save Flag
    "export.txt"
);
If( Is Missing( filename ),
    Print( "Canceled" ),
    Save Text File( filename, "The quick brown fox" )
);


```

### [Rename Directory](#rename-directory)

**Syntax:** rc = Rename Directory( old, new )

**Description:** Renames a directory without moving or copying it; the new name does NOT include a path. Returns 1 if the directory was renamed. Returns 0 if the directory was unable to be renamed or the path is invalid.

**JMP Version Added:** Before version 14

```

Delete Directory( "$TEMP/subD" );
Delete Directory( "$TEMP/Loss Function Templates" );
rc0 = Copy Directory( "$SAMPLE_DATA/Loss Function Templates", "$TEMP" );
rc1 = Rename Directory( "$TEMP/Loss Function Templates", "subD" /* NO PATH */ );
rc2 = Directory Exists( "$TEMP/Loss Function Templates" );
rc3 = Directory Exists( "$TEMP/subD" );
rc4 = Delete Directory( "$TEMP/subD" );
rc5 = Directory Exists( "$TEMP/subD" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Rename File](#rename-file)

**Syntax:** rc = Rename File( old, new )

**Description:** Renames a file without moving or copying it; the new name does NOT include a path. Returns 1 if the file was renamed. Returns 0 if the file was unable to be renamed. Throws an error when path is invalid or does not exist.

**JMP Version Added:** Before version 14

```

rc0 = Copy File( "$SAMPLE_DATA/Loss Function Templates/Normal.jmp", "$TEMP/x.jmp" );
rc1 = Rename File( "$TEMP/x.jmp", "y.jmp" /* NO PATH */ );
rc2 = File Exists( "$TEMP/x.jmp" );
rc3 = File Exists( "$TEMP/y.jmp" );
rc4 = Delete File( "$TEMP/y.jmp" );
rc5 = File Exists( "$TEMP/y.jmp" );
Char( rc0 ) || " " || Char( rc1 ) || " " || Char( rc2 ) || " " || Char( rc3 ) || " " ||
Char( rc4 ) || " " || Char( rc5 );/* 1 1 0 1 1 0 */


```

### [Save Text File](#save-text-file)

**Syntax:** f = Save Text File( path, text|blob, \<mode("replace"|"append")> )

**Description:** Creates a text file with the file name that is specified by the path argument and contents specified by the text string argument. If the save is successful, the Save Text File() function returns the pathname of the created file.

**JMP Version Added:** Before version 14

```

Save Text File( "$TEMP/DeleteMe.txt", "The quick brown fox" );
Load Text File( "$TEMP/DeleteMe.txt" );


```

### [Set Default Directory](#set-default-directory)

**Syntax:** Set Default Directory( path )

**Description:** Sets the JMP default directory, which is used as a base for subsequent relative paths.

**JMP Version Added:** Before version 14

```

Set Default Directory( "$SAMPLE_DATA" );
Open( "Big Class.jmp" );


```

### [Set File Search Path](#set-file-search-path)

**Syntax:** Set File Search Path(path | {list of paths})

**Description:** Sets the current list of directories to search for opening files. "." means the current directory.

**JMP Version Added:** Before version 14

```

Set File Search Path(
    {Convert File Path( "$SAMPLE_DATA/" ), Convert File Path( "$SAMPLE_DATA/Time Series/" )}
);
Show( Get File Search Path() );
Show( Convert File Path( "Air.jmp", search ) );
Show( Convert File Path( "Full of Air.jmp", search ) );
Show( Convert File Path( "Iris.jmp", search ) );


```

### [Set Path Variable](#set-path-variable)

**Syntax:** Set Path Variable( name, <value> )

**Description:** Sets a path variable, which is a name like SAMPLE_DATA that is substituted for when found in pathnames.

**JMP Version Added:** Before version 14

```

Set Path Variable( "SAMPLE_DATA", Get Path Variable( "SAMPLE_DATA" ) );


```

### [TripleS Import](#triples-import)

**Syntax:** TripleSImport( <path to xml file> )

**Description:** Opens Triple-S files. The Triple-S format comprises an xml or sss file and either a csv file or a dat/asc file. Both files must have the same name with the appropriate extension and must be in the same directory. Specify the xml or sss filepath to import the data.

**JMP Version Added:** Before version 14

```

TripleS Import(); //To get a file dialog to select the XML file
TripleS Import( "c:/MyFile.xml" ); //To open the Triple-S MyFile


```

# [Finance](#finance)

### [Double Declining Balance](#double-declining-balance)

**Syntax:** x = Double Declining Balance( cost, salvage, life, period, \<factor=2> )

**Description:** Returns the depreciation of an asset for a specified period using the double-declining balance method or some other depreciation factor. Equivalent to the DDB function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Double Declining Balance( 10000, 100, 3, 2 );


```

### [Future Value](#future-value)

**Syntax:** x = Future Value( rate, nper, pmt, \<pv=0>, \<type=0> )

**Description:** Returns the future value of an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the FV function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Future Value( .03, 12, 100, 0, 1 );


```

### [Interest Payment](#interest-payment)

**Syntax:** x = Interest Payment( rate, per, nper, pv, \<fv=0>, \<type=0> )

**Description:** Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the IPMT function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Payment( .05 / 12, 30 * 12, 100000 ) - Interest Payment( .05 / 12, 13, 30 * 12, 100000 )
-Principal Payment( .05 / 12, 13, 30 * 12, 100000 );


```

### [Interest Rate](#interest-rate)

**Syntax:** x = Interest Rate( nper, pmt, pv, \<fv=0>, \<type=0>, \<guess=0.1> )

**Description:** Returns the interest rate per period of an annuity. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the RATE function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Interest Rate( 30 * 12, Payment( .05 / 12, 30 * 12, 100000 ), 100000 );


```

### [Internal Rate of Return](#internal-rate-of-return)

**Syntax:** x = Internal Rate of Return( values, \<guess=0.1> ); x = Internal Rate of Return( guess, value1, value2, \<value3, ...> )

**Description:** Returns the internal rate of return for a series of cash flows represented by the numbers in the values argument. Equivalent to the IRR function in Microsoft Excel. The second prototype of the function accepts all scalar arguments.

**JMP Version Added:** Before version 14

```

Internal Rate of Return( [-10000, 1000, 900, 950] );
Internal Rate of Return( .01, -10000, 1000, 900, 950 );


```

### [Modified Internal Rate of Return](#modified-internal-rate-of-return)

**Syntax:** x = Modified Internal Rate of Return( values, finance_rate, reinvest_rate ); x = Modified Internal Rate of Return( finance_rate, reinvest_rate, value1, value2, \<value3, ...> )

**Description:** Returns the modified internal rate of return for a series of periodic cash flows, taking into account both the cost of the investment and the interest received on reinvestment of cash. Equivalent to the MIRR function in Microsoft Excel. The second prototype of the function accepts all scalar arguments.

**JMP Version Added:** Before version 14

```

Modified Internal Rate of Return( [-10000, 1000, 900, 950], .1, -.12 );
Modified Internal Rate of Return( .1, -.12, -10000, 1000, 900, 950 );


```

### [Net Present Value](#net-present-value)

**Syntax:** x = Net Present Value( rate, values ); x = Net Present Value( rate, value1, value2, \<value3, ...> )

**Description:** Returns the net present value of an investment by using a discount rate and a series of future payments (negative values) and income (positive values). The values argument is a one dimensional matrix. Equivalent to the NPV function in Microsoft Excel. The second prototype of the function accepts all scalar arguments.

**JMP Version Added:** Before version 14

```

Net Present Value( .05, [-10000, 1000, 900, 9500] );
Net Present Value( .05, -10000, 1000, 900, 9500 );


```

### [Number of Periods](#number-of-periods)

**Syntax:** x = Number of Periods( rate, pmt, pv, \<fv=0>, \<type=0> )

**Description:** Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the NPER function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Number of Periods( .05 / 12, -2000, 100000 );


```

### [Payment](#payment)

**Syntax:** x = Payment( rate, nper, pv, \<fv=0>, \<type=0> )

**Description:** Returns the payment for a loan based on constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the PMT function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Payment( .05 / 12, 30 * 12, 100000 ) - Interest Payment( .05 / 12, 13, 30 * 12, 100000 )
-Principal Payment( .05 / 12, 13, 30 * 12, 100000 );


```

### [Present Value](#present-value)

**Syntax:** x = Present Value( rate, nper, pmt, \<fv=0>, \<type=0> )

**Description:** Returns the present value of an investment. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the PV function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Present Value( .05 / 12, 30 * 12, 1000 );


```

### [Principal Payment](#principal-payment)

**Syntax:** x = Principal Payment( rate, per, nper, pv, \<fv=0>, \<type=0> )

**Description:** Returns the payment on the principal for a given period for an investment based on periodic, constant payments and a constant interest rate. The type argument is 0 for end-of-period payments and 1 for beginning-of-period payments. Equivalent to the PPMT function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Payment( .05 / 12, 30 * 12, 100000 ) - Interest Payment( .05 / 12, 13, 30 * 12, 100000 )
-Principal Payment( .05 / 12, 13, 30 * 12, 100000 );


```

### [Straight Line Depreciation](#straight-line-depreciation)

**Syntax:** x = Straight Line Depreciation( cost, salvage, life )

**Description:** Returns the straight-line depreciation of an asset for one period. Equivalent to the SLN function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Straight Line Depreciation( 1000, 100, 3 );


```

### [Sum Of Years Digits Depreciation](#sum-of-years-digits-depreciation)

**Syntax:** x = Sum Of Years Digits Depreciation( cost, salvage, life, per )

**Description:** Returns the sum-of-years' digits depreciation of an asset for a specified period. Equivalent to the SYD function in Microsoft Excel.

**JMP Version Added:** Before version 14

```

Sum Of Years Digits Depreciation( 1000, 100, 3, 2 );


```

# [Graphics](#graphics)

### [Add Color Theme](#add-color-theme)

**Description:** Creates a new custom color theme and registers it with the theme picker.

**JMP Version Added:** Before version 14

**Example 1**

```

Add Color Theme( {"Yellow To Blue", 0, {{255, 255, 0}, {0, 0, 255}}, {0.0, 1.0}} );


```

**Example 2**

```

Add Color Theme(
    {"Black To Red To White", {"Continuous", "Categorical", "Diverging"}, {{0, 0, 0}, {255, 0,
    0}, {255, 255, 255}, Missing( "Green" )}, {"Full Color", "Tritanopia", "Tritanomaly"}}
);


```

### [Arc](#arc)

**Syntax:** Arc( left, top, right, bottom, startAngle, endAngle )

**Description:** Draws an arc of an oval. The angles are in degrees, specified with 0 degrees at 12:00 and 90 degrees at 3:00. To line them up with the radian values used by sin() and cos() you must reverse the rotation and add the 90 degree phase shift. For example, radians = 2 * pi() * (90 - degrees) / 360. Arcs sweep clockwise from start to end.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        Arc( 10, 80, 70, 30, 0, 90 );
    )
);


```

### [Arrow](#arrow)

**Syntax:** Arrow( {x1, y1}, {x2, y2}, ... ); Arrow( xMatrix, yMatrix )

**Description:** Draws a line with an arrow or a sequence of such lines.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 4 );
        Arrow( [10 30 90], [88 22 44] );
    )
);


```

### [Back Color](#back-color)

**Syntax:** Back Color( \<name|index|rgbList> )

**Description:** Sets the background color for the erase mode in the Text() function.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Back Color( "red" );
        Text( Erased, {50, 20}, "Hello" );
    )
);


```

### [Blend Colors](#blend-colors)

**Syntax:** color = Blend Colors( color1, color2, <percent2>, <colorSpace>, <hueDirection> )

**Description:** Blends two colors with a configurable percentage and color space.

**JMP Version Added:** 18

**Example 1**

```

Blend Colors( "black", "white", 0.25 );


```

**Example 2**

```

Blend Colors( "red", "blue", "sRGB" );


```

**Example 3**

```

Blend Colors( "red", "blue", "lRGB" );


```

**Example 4**

```

Blend Colors( "red", "blue", 0.5, "LUV" );


```

**Example 5**

```

Blend Colors( "red", "blue", 0.75, "HLS" );


```

**Example 6**

```

c1 = "red";
c2 = "blue";
steps = 20;
New Window( "HLS Radial Color Blending",
    Graph(
        frameSize( 290, 110 ),
        X Scale( 0, 150 ),
        Y Scale( 0, 55 ),
        Suppress Axes,
        Text( {2, 47}, "Short" ),
        Text( {2, 32}, "Long" ),
        Text( {2, 17}, "Positive" ),
        Text( {2, 2}, "Negative" ),
        For( i = 0, i < steps, i += 1,
            x = i * 6 + 30;
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Short" ) );
            Rect( x, 45, x + 5, 55, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Long" ) );
            Rect( x, 30, x + 5, 40, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Positive" ) );
            Rect( x, 15, x + 5, 25, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HLS", "Negative" ) );
            Rect( x, 0, x + 5, 10, 1 );
        )
    )
);


```

**Example 7**

```

c1 = "blue";
c2 = "red";
steps = 20;
New Window( "HCLuv Radial Color Blending",
    Graph(
        frameSize( 290, 110 ),
        X Scale( 0, 150 ),
        Y Scale( 0, 55 ),
        Suppress Axes,
        Text( {2, 47}, "Short" ),
        Text( {2, 32}, "Long" ),
        Text( {2, 17}, "Positive" ),
        Text( {2, 2}, "Negative" ),
        For( i = 0, i < steps, i += 1,
            x = i * 6 + 30;
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Short" ) );
            Rect( x, 45, x + 5, 55, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Long" ) );
            Rect( x, 30, x + 5, 40, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Positive" ) );
            Rect( x, 15, x + 5, 25, 1 );
            Fill Color( Blend Colors( c1, c2, i / (steps - 1), "HCLuv", "Negative" ) );
            Rect( x, 0, x + 5, 10, 1 );
        )
    )
);


```

### [Char To Path](#char-to-path)

**Syntax:** m = Char To Path( pathText )

**Description:** Converts a path specification from character form to matrix form.

**JMP Version Added:** Before version 14

```

Show( Char To Path( "M10 10 L50 10 L30 50 Z M20 20 L40 20 L30 40 Z" ) );


```

### [Circle](#circle)

**Syntax:** Circle( {x, y}, radius|PixelRadius( px ), ..., \<"FILL"> )

**Description:** Draws a circle centered at {x, y}. The radius can be specified as an integer based on the vertical axis or as a number of pixels. A pixel-based radius creates a circle that does not vary in size when the vertical axis changes. Arguments can be repeated in any order to draw multiple circles. "FILL", if used, must be last, and fills the circles with the fill color rather than drawing them with the pen color.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        Circle( {20, 20}, 4, 7, 10/* no fill for concentric circles */ );
        Fill Color( "blue" );
        Transparency( .25 );/* transparent fill for concentric circles */
        Circle( {60, 20}, 4, 7, 10, "FILL" );
        Fill Color( "green" );
        Transparency( 1 );/* solid fill */Circle(
            PixelRadius( 18 ),
            {40, 20},
            {40, 50},
            {40, 80},
            "FILL"
        );
    )
);


```

### [Color Difference](#color-difference)

**Syntax:** color = Color Difference( color1, color2, <difference metric>)

**Description:** Returns the difference between two colors under a specified color difference metric.

**JMP Version Added:** 18

**Example 1**

```

Color Difference( "red", "blue" );


```

**Example 2**

```

Color Difference( "red", "blue", "sRGB" );


```

**Example 3**

```

Color Difference( "red", "blue", "redmean" );


```

**Example 4**

```

Color Difference( "red", "blue", "CIE76" );


```

**Example 5**

```

Color Difference( "red", "blue", "CIE94" );


```

**Example 6**

```

Color Difference( "red", "blue", "CIEDE2000" );


```

**Example 7**

```

Color Difference( "red", "blue", "dEok" );


```

### [Color To HLS](#color-to-hls)

**Syntax:** {h, l, s} = Color To HLS( color )

**Description:** Returns a list of the hue, lightness, and saturation components. The color argument can be any valid JSL color, or a matrix of color numbers.

**JMP Version Added:** Before version 14

```

Color To HLS( RGB Color( 1.0, 0.5, 0.5 ) );


```

### [Color To RGB](#color-to-rgb)

**Syntax:** {r, g, b} = Color To RGB( color )

**Description:** Returns a list of the red, green, and blue components, between 0 and 1. The color argument can be any valid JSL color, or a matrix of color numbers.

**JMP Version Added:** Before version 14

```

Color To RGB( HLS Color( 30 / 360, 0.5, 1 ) );


```

### [Contour](#contour)

**Syntax:** Contour( xVector, yVector, zGridMatrix, zContours, < \<<zColor( color, option )>, < \<<Fill|Fill Between|Fill Below|Fill Above>, < \<<Transparency(vector)> )

**Description:** Draws contours given a grid of values. If there are fewer colors specified than there are contours, options of "Interpolate Colors" or "Cycle Colors" determines how the colors will be applied.

**JMP Version Added:** Before version 14

```


New Window( "Example",
    H List Box(
        Outline Box( "Line",
            Graph Box(
                Contour( 1 :: 100, 1 :: 100, (1 :: 100)` * (1 :: 100), 7 ^ (0 :: 4) )
            )
        ),
        Outline Box( "Line Colors",
            Graph Box(
                Contour(
                    1 :: 100,
                    1 :: 100,
                    (1 :: 100)` * (1 :: 100),
                    7 ^ (0 :: 4),
                    <<zColor( {"Blue", "Red"} )
                )
            )
        )
    ),
    H List Box(
        Outline Box( "Fill Cycle",
            Graph Box(
                Contour(
                    1 :: 100,
                    1 :: 100,
                    (1 :: 100)` * (1 :: 100),
                    7 ^ (0 :: 4),
                    <<zColor(
                        {RGB Color( 218, 218, 255 ), RGB Color( 255, 218, 218 )},
                        "Cycle Colors"
                    ),
                    fill
                )
            )
        ),
        Outline Box( "Fill Interpolate",
            Graph Box(
                Contour(
                    1 :: 100,
                    1 :: 100,
                    (1 :: 100)` * (1 :: 100),
                    7 ^ (0 :: 4),
                    <<zColor( {"Blue", "Red"}, "Interpolate Colors" ),
                    fill
                )
            )
        )
    )
);


```

### [Contour Function](#contour-function)

**Syntax:** Contour Function( zExpr, xName, yName, z|zMatrix, < \<<XGrid( min, max, incr )>, < \<<YGrid( min, max, incr )>, < \<<ZColor( color, option )>, < \<<ZLabeled>, < \<<Filled>, < \<<FillBetween>, < \<<Ternary>, < \<<Transparency( t )> )

**Description:** Evaluates the expression on a grid of xName and yName values and draws the contour lines. The color can be specified as a number, a matrix, a list of RGB values, a list of color names, or a Color Theme. The transparency t can be specified as a number or as a matrix. If the Ternary option is specified, the contours are clipped to a ternary coordinate system.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    Graph Box(
        Contour Function(
            Log( a * a + b * b ),
            a,
            b,
            1 :: 10,
            <<ZColor( {"blue", "green", "red"}, "Cycle Colors" ),
            Transparency( 0.9 )
        )
    )
);


```

**Example 2**

```

New Window( "Example",
    Graph Box(
        Contour Function(
            Log( a * a + b * b ),
            a,
            b,
            1 :: 10,
            <<Filled,
            <<ZColor( {{1, 0.1, 0.1}, {0.1, 1, 0.1}, {0.1, 0.1, 1}}, "Interpolate Colors" )
        )
    )
);


```

### [Drag Line](#drag-line)

**Syntax:** Drag Line( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws a polyline at the indicated points. Unlike Line though, the points can be dragged across the screen, updating the values in the (LValue) matrix arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Line( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Marker](#drag-marker)

**Syntax:** Drag Marker( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws movable markers at the indicated points. The matrix values are updated as the markers are moved.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Marker( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Polygon](#drag-polygon)

**Syntax:** Drag Polygon( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws a filled polygon at the indicated points. The points can be dragged across the screen, updating the values in the (LValue) matrix arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Polygon( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Rect](#drag-rect)

**Syntax:** Drag Rect( xMatrixName, yMatrixName, <dragScript>, <MouseUpScript> )

**Description:** Draws a rectangle at the indicated points. Unlike Rect though, these corners can be dragged across the screen, updating the values in the (LValue) matrix arguments.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33];
    exy = [88 22];,
    Graph Box(
        Drag Rect( exx, exy );
        Line( exx, exy );
    )
);


```

### [Drag Text](#drag-text)

**Syntax:** Drag Text( xMatrixName, yMatrixName, text, <dragScript>, <MouseUpScript> )

**Description:** Draws the text at the indicated points. Unlike the Text() function, however, the points can be dragged across the screen, updating the values in the xMatrixName and yMatrixName matrix arguments. The text argument can be a string argument or a list of strings.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = [11 33 77];
    exy = [88 22 44];,
    Graph Box(
        Drag Text( exx, exy, "hello" );
        Line( exx, exy );
    )
);


```

### [Fill Color](#fill-color)

**Syntax:** Fill Color( \<name|index|rgbList> )

**Description:** Sets the color for drawing filled areas.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( {1, 1, .5} );
        Polygon( [10 30 90], [88 22 44] );
    )
);


```

### [Fill Pattern](#fill-pattern)

**Syntax:** Fill Pattern( name|mask|image )

**Description:** Sets the pattern for drawing filled areas. A mask is a matrix of values between 0 and 1 to be applied to the current fill color.

**JMP Version Added:** Before version 14

#### [Image](#image)

```


image = New Image( "$SAMPLE_IMAGES/pi.gif" );
New Window( "Example",
    Graph Box(
        Fill Pattern( image );
        Polygon( [10 30 90], [88 22 44] );
    )
);


```

#### [Mask](#mask)

```

New Window( "Example",
    Graph Box(
        Fill Pattern( [1 0.5 0 0, 0.5 0 0 1, 0 0 1 0.5, 0 1 0.5 0] );
        Polygon( [10 30 90], [88 22 44] );
    )
);


```

### [Get Color Theme Detail](#get-color-theme-detail)

**Syntax:** script = Get Color Theme Detail(name)

**Description:** Returns the script for a given color theme name

**JMP Version Added:** Before version 14

```

Get Color Theme Detail( "JMP Default" );


```

### [Get Color Theme Names](#get-color-theme-names)

**Syntax:** {list of names} = Get Color Theme Names(<kind>)

**Description:** Returns a list of color theme strings which match the optional parameter kind. kind is one of the following: "continuous", "categorical", "sequential", "diverging", "qualitative", or "chromatic".

**JMP Version Added:** Before version 14

**Example 1**

```

Get Color Theme Names();


```

**Example 2**

```

Get Color Theme Names( "sequential" );


```

### [Gradient Function](#gradient-function)

**Syntax:** Gradient Function( zExpr, xName, yName, zLimits, zColor( color list or matrix ), < \<<XGrid( min, max, incr )>, < \<<YGrid( min, max, incr )>, < \<<Transparency( t )> )

**Description:** Fills the graph with a gradient between two colors. The zExpr argument is a function in terms of the variables specified by xName and yName. The vector zLimits specifies the range of values for zExpr. The zColor argument is a vector or list that defines the two colors that are blended together to create the gradient. The Transparency is a single value applied to the entire grid.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Gradient Function(
            Log( a * a + b * b ),
            a,
            b,
            [2 10],
            Z Color( {"Green", "Orange"} )
        )
    )
);


```

### [H Line](#h-line)

**Syntax:** H Line( y ); H Line( x1, x2, y )

**Description:** Draws a horizontal line at y from x1 to x2 or through the entire frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 2 );
        H Line( 10, 50, 20 );
    )
);


```

### [H Size](#h-size)

**Syntax:** h = H Size()

**Description:** Returns the horizontal size of the graphics frame in pixels.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( H Size() / 20 );
        Line( [10 30 90], [88 22 44] );
    )
);


```

### [HLS Color](#hls-color)

**Syntax:** y = HLS Color( h, l, s ); y = HLS Color( {h, l, s} )

**Description:** Returns a color number from the hue, lightness, and saturation components, all between 0 and 1.

**JMP Version Added:** Before version 14

```

New Window( "Color Wheel",
    Graph(
        frameSize( 200, 200 ),
        For( hue = 0, hue < 360, hue += 30,
            y = 50 - 40 * Cos( hue * 2 * Pi() / 360 );
            x = 50 + 40 * Sin( hue * 2 * Pi() / 360 );
            Fill Color( HLS Color( hue / 360, 0.5, 1 ) );
            Oval( x - 10, y - 10, x + 10, y + 10, 1 );
        )
    )
);


```

### [Handle](#handle)

**Syntax:** Handle( xPos, yPos, dragScript, <mouseUpScript> )

**Description:** Draws a square marker at the coordinates specified by xPos and yPos and repeatedly evaluates the dragScript expression when the mouse is pressed over the marker. Before running the script, the globals x and y are set to the mouse value and are restored to their original values afterward. The mouseUpScript expression is run after the mouse button is released.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = 20;
    exy = 50;,
    Graph Box(
        Frame Size( 200, 200 ),
        Handle(
            exx,
            exy,
            exx = x;
            exy = y;
        );
        Circle( {0, 0}, Sqrt( exx * exx + exy * exy ) );
    )
);


```

### [Heat Color](#heat-color)

**Syntax:** y = Heat Color( x ); y = Heat Color( x, < \<<theme> )

**Description:** Returns a color corresponding to a value between 0 and 1. Default theme is "Blue to Gray to Red". Any theme supported by Cell Plot is supported here. Matrix arguments supported.

**JMP Version Added:** Before version 14

```

New Window( "Color Bar",
    Graph(
        For( z = 0, z < 1, z += .1,
            x = 10 + 80 * z;
            Fill Color( Heat Color( z, <<"Green to Black to Red" ) );
            Rect( x - 5, 45, x + 5, 55, 1 );
        )
    )
);


```

### [In Path](#in-path)

**Syntax:** b = In Path( x, y, pathMatrix|pathText )

**Description:** Returns 1 if the point (x,y) is in the given path, otherwise returns 0.

**JMP Version Added:** Before version 14

```


New Window( "Example",
    window:p = "M10 10 L52 10 L37 52 Z M20 16 L40 20 L35 40 Z";
    Graph Box(
        Fill Color( "light blue" );
        Path( window:p, 1 );
        For Each( {x}, 5 :: 55 :: 5,
            For Each( {y}, 5 :: 55 :: 5,
                Marker(
                    Marker State( If( In Path( x, y, window:p ), "x", "circle" ) ),
                    {x, y}
                )
            )
        );
    );
);


```

### [In Polygon](#in-polygon)

**Syntax:** b = In Polygon( x, y, xMatrix, <yMatrix> )

**Description:** Returns 1 if the point (x,y) is in the polygon defined by the vector arguments, otherwise returns 0.

**JMP Version Added:** Before version 14

```

In Polygon( 11, 22, [10 20 30], [10 30 20] );


```

### [Level Color](#level-color)

**Syntax:** y = Level Color( i ); y = Level Color( i, n ); y = Level Color( i, n, <theme> ); y = Level Color( i, <theme> )

**Description:** Returns a category color, where i is the category level; n is the number of categories (optional); and theme are the color themes in the Column Info dialog's Value Color combo box. ("JMP Default" is the default theme.) The category index must be >= 1 and \<= the number of categories specified in the call or defined by the theme. If the second argument is a character, it is the color theme and n is unspecified.

**JMP Version Added:** Before version 14

```

New Window( "Color Bar",
    Graph(
        For( x = 1, x <= 100, x += 5,
            Fill Color( Level Color( x, 100, "Green to Black to Red" ) );
            Rect( x - 5, 45, x + 5, 55, 1 );
        )
    )
);


```

### [Line](#line)

**Syntax:** Line( {x1, y1}, {x2, y2}, ..., < \<<Value Space( 0|1 ) >, < \<<Smooth( tension, domain, min response, max response ) > ); Line( xMatrix, yMatrix, < \<<Value Space(0 | 1) >, < \<<Smooth( tension, domain, min response, max response ) > )

**Description:** Draws a line or connected lines. In the default case, the line is drawn linearly between the endpoints. If the Value Space option is set, the line follows the projection specified by the underlying axis scales. If the Smooth option is set, connections are smoothed, constrained by tension, domain dimension, min response, and max response.

**JMP Version Added:** Before version 14

#### [Constrained smoothing](#constrained-smoothing)

```

New Window( "Constrained smoothing",
    Graph Box(
        Pen Color( "gray" );
        H Line( 90 );
        H Line( 92 );
        H Line( 10 );
        H Line( 8 );
        Pen Color( "red" );
        Line( Index( 10, 90, 10 ), [20 10 90 90 60 70 10 10 40], <<Smooth( . ) );
        Pen Color( "blue" );
        Line( Index( 10, 90, 10 ), [20 10 90 90 60 70 10 10 40], <<Smooth( ., "X", 8, 92 ) );
    )
);


```

#### [Polyline](#polyline)

```

New Window( "Example", Graph Box( Line( [10 30 90], [88 22 44] ) ) );


```

#### [Smoothing](#smoothing)

```

New Window( "Smoothing",
    Graph Box(
        XAxis( Min( 0 ), Max( 10 ), Inc( 2 ) ),
        YAxis( Min( -1.1 ), Max( 1.1 ), Inc( 1 ) ),
        Pen Color( "gray" );
        H Line( 1 );
        H Line( -1 );
        H Line( 0 );
        Line( 0 :: 10, Sin( 0 :: 10 ) );
        Pen Color( "red" );
        Line( 0 :: 10, Sin( 0 :: 10 ), <<Smooth( . ) );
        Pen Color( "blue" );
        Line( 0 :: 10, Sin( 0 :: 10 ), <<Smooth( 0.25 ) );
    )
);


```

#### [Value space interpolation](#value-space-interpolation)

```

New Window( "Interpolate in value space",
    Graph Box(
        XAxis( Scale( "Log" ), Min( 10 ), Max( 100 ) ),
        YAxis( Scale( "Log" ), Min( 10 ), Max( 100 ) ),
        Line( [10 30 90], [88 22 44], <<Value Space( 1 ) )
    )
);


```

### [Line Style](#line-style)

**Syntax:** Line Style( x )

**Description:** Sets the current line style, which can be one of: 0 (Solid), 1 (Dotted), 2 (Dashed), 3 (DashDot), or 4 (DashDotDot).

**JMP Version Added:** Before version 14

```

New Window( "Line Style Example",
    Graph Box(
        Frame Size( 500, 400 ),
        named line styles = {"Solid", "Dotted", "Dashed", "Dash Dot", "Dash Dot Dot",
        "Dash Dash Dot", "Dash Dash Dot Dot", "Long Dash", "Long Dash Dash", "Dense Dash",
        "Sparse Dash", "Sparse Dot", "Sparse Dash Dot"};
        For Each( {istyle, i}, named line styles, {x = 5 :: 75, y = 12 * Sin( x / 12 )},
            Text( {x[N Items( x )] + 1, y[N Items( y )] + 92 - 6 * i - 1.5}, istyle );
            Line Style( istyle );
            Pen Size( 2 );
            Line( x, y + 92 - 6 * i );
        );
    )
);


```

### [Mandelbrot](#mandelbrot)

**Syntax:** v = Mandelbrot( n, radius, x, y )

**Description:** calculates the value of the Mandelbrot function at x,y, stopping after n iterations or when radius exceeded

**JMP Version Added:** Before version 14

```

grid = 50;
rmax = 0/*zero for smooth*/;
nmax = 50;// http://wikipedia.org/wiki/Mandelbrot_set 
New Window( "Mandelbrot - use magnifier to zoom in",
    g = Graph Box(
        X Scale( -3, 3 ),
        Y Scale( -2, 2 ),
        framesize( 600, 400 ),
        Gradient Function(
            Mandelbrot( nmax, rmax, a, b ), // return value: number of iterations before something interesting happened
            a, // standard GradientFunction stuff...
            b,
            Matrix( {0, nmax} ), // range to map the colors onto
            Z Color(
                {RGB Color( 0, 0, 0 ), RGB Color( 1, 0, 0 ), RGB Color( 1, 1, 0 ),
                RGB Color( 0, 1, 0 ), RGB Color( 0, 1, 1 ), RGB Color( 0, 0, 1 ),
                RGB Color( .3, .3, .4 )}
            ),
            <<xgrid(
                X Origin(), X Origin() + X Range(),
                X Range() / (Floor( grid * H Size() / V Size() ))
            ),
            <<ygrid( Y Origin(), Y Origin() + Y Range(), Y Range() / (Floor( grid )) ), 

        )
    ),
    H List Box( Slider Box( 2, 500, nmax, g << reshow ), Global Box( nmax ) ),
    H List Box( Slider Box( 0, 5, rmax, g << reshow ), Global Box( rmax ) ),
    H List Box( Slider Box( 2, 500, grid, g << reshow ), Global Box( grid ) ), 

);
g << Set X Axis(
    {Format( "Best", 15 ), Show Major Ticks( 0 ), Rotated Labels( "Parallel" )}
);
g << Set Y Axis(
    {Format( "Best", 15 ), Show Major Ticks( 0 ), Rotated Labels( "Parallel" )}
);


```

### [Marker](#marker)

**Syntax:** Marker( <rs>, {x1, y1}, {x2, y2}, ... ); Marker( <rs>, xMatrix, yMatrix )

**Description:** Draws markers at the indicated coordinates.

**JMP Version Added:** Before version 14

```

New Window( "Example", Graph Box( Marker( Marker State( 3 ), [11 44 77], [75 25 50] ) ) );


```

### [Marker Size](#marker-size)

**Syntax:** Marker Size( n )

**Description:** Sets the size markers are drawn in the graphics frame. 0 = dot, 1 = small, ....

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Marker Size( 5 );
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
    )
);


```

### [Mousetrap](#mousetrap)

**Syntax:** Mousetrap( dragScript, <mouseUpScript> )

**Description:** Evaluates the dragScript expression repeatedly while the mouse is pressed within the graph and not handled by another graph object. Before running the script, the globals x and y are set to the mouse value and are restored to their original values afterward. The mouseUpScript expression is run after the mouse button is released.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    exx = 20;
    exy = 50;,
    Graph Box(
        Frame Size( 200, 200 ),
        Mousetrap(
            exx = x;
            exy = y;
        );
        Circle( {0, 0}, Sqrt( exx * exx + exy * exy ) );
    )
);


```

### [New Heat Image](#new-heat-image)

**Syntax:** New Heat Image( Matrix, \<Color Theme / gradient ( ... )>

**Description:** Creates a heat map image based on a matrix and color theme or gradient.

**JMP Version Added:** 16

```


nx = 20; // data is this size
ny = 15;
data = J( ny, nx, Random Normal() ); // ny=rows, nx=cols
// create a magnified matrix for seeing each value
magnify = 10;
big data = J( N Rows( data ) * magnify, N Cols( data ) * magnify );
big data = Transform Each( {z, {row, col}}, big data, 
    // and filling each value with one from the small matrix
    data[Floor( (row - 1) / magnify ) + 1, Floor( (col - 1) / magnify ) + 1]
);
New Window( "small and big",
    Lineup Box( N Col( 3 ),
        New Heat Image(
            data,
            gradient(
                {Color Theme( "Blue To Gray To Orange" ), Scale Type( "Standard Deviation" )}
            )
        ),
        New Heat Image(
            big data,
            gradient(
                {Color Theme( "Blue To Gray To Orange" ), Scale Type( "Standard Deviation" )}
            )
        ),
        New Heat Image(
            Abs( big data ),
            gradient(
                {Color Theme( "White to Black" ), Scale Values( [0 2] ),
                Reverse Gradient( 1 )}
            )
        )
    )
);


```

### [Normal Contour](#normal-contour)

**Syntax:** Normal Contour( prob, meanMatrix, stdMatrix, corrMatrix, <colorsMatrix>, \<fill=0> )

**Description:** Draws normal probability contour(s) for k populations and two variables. The prob argument can be either a scalar probability or a matrix of probabilities. The meanMatrix and stdsMatrix arguments are k by 2 matrices, and the corrMatrix argument is a k by 1 vector. The colorsMatrix argument specifies the color(s) for the k contour(s); colors must be specified as JSL colors (either JSL color integer values or return values of JSL color functions such as the RGB Color() or HLS Color() functions). The fill argument specifies the amount of transparency for the contour fill color.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "blue" );
        Normal Contour( 0.95, [40 40], [15 5], [0.5], Empty(), 0.1 );,
        Normal Contour(
            0.95,
            [40 40, 60 50],
            [15 5, 10 10],
            [-0.9, -0.5],
            Matrix( {RGB Color( {0.1, 0.9, 0.1} ), 3} ),
            0.2
        )
    )
);


```

### [Oval](#oval)

**Syntax:** Oval( left, top, right, bottom, \<fill=0> )

**Description:** Draws an oval within the specified rectangle, filled if fill is nonzero.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "Green" );
        Pen Size( 2 );
        Fill Color( "Red" );
        Oval( 15, 75, 65, 55, 1 );
        Oval( 10, 80, 70, 50 );
    )
);


```

### [Path](#path)

**Syntax:** Path( pathMatrix|pathText, \<fill=0> )

**Description:** Draws a stroke along the given path if fill is 0, or paints the interior of the given path if fill is not 0. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "blue" );
        Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3], 1 );
        Path( "M20,20 C20,60 60,60 60,20 Z", 0 );
    )
);


```

### [Path To Char](#path-to-char)

**Syntax:** s = Path To Char( pathMatrix )

**Description:** Converts a path specification from matrix form to character form.

**JMP Version Added:** Before version 14

```

Path To Char( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] );


```

### [Pen Color](#pen-color)

**Syntax:** Pen Color( \<name|index|rgbList> )

**Description:** Sets the color for drawing lines.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( {.3, .5, .7} );
        Circle( {20, 20}, 10 );
    )
);


```

### [Pen Size](#pen-size)

**Syntax:** Pen Size( <x> )

**Description:** Sets the pen size in pixels for drawing lines.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 4 );
        Line( [10 30 90], [88 22 44] );
    )
);


```

### [Pick Color](#pick-color)

**Syntax:** color = Pick Color( <window title>, \<name|index|rgbList> )

**Description:** Returns a color that was selected with the standard color picker.

**JMP Version Added:** 14

```

pickedColor = Pick Color( "Pick a Line Color", "Red" );
New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( pickedColor );
        Line( [10 30 70], [88 22 44] );
    )
);


```

### [Pick Color Theme](#pick-color-theme)

**Syntax:** theme = Pick Color Theme( <window title>, \<Color Theme(name|specification)>, \<Type("Continuous" | "Sequential" | "Bad to Good" | "Categorical")>)

**Description:** Returns a color theme that was selected with the standard color theme picker. The initial theme can be specified explicitly or by specifying a Type to use the themes from preferences.

**JMP Version Added:** 17

#### [Graph Builder](#graph-builder)

```


theme = Pick Color Theme( "Choose a color theme", Type( "Bad to Good" ) );
dt = Open( "$SAMPLE_DATA/SATByYear.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( Color( :SAT Math ), Shape( :State ) ),
    Elements( Map Shapes( Legend( 2 ) ) )
);
server = gb << Get Legend Server;
item = server << Get Legend Item( 2, 1 );
item << Set Properties( {Gradient( {Color Theme( theme )} )} );


```

#### [Row Legend](#row-legend)

```


pickedTheme = Pick Color Theme( "Pick a Color Theme" );
biv = Open( "$SAMPLE_DATA/Big Class.jmp" ) << Run Script( "Bivariate" );
Report( biv )[FrameBox( 1 )] << Row Legend( "age", Color Theme( pickedTheme ) );


```

### [Pie](#pie)

**Syntax:** Pie( left, top, right, bottom, startAngle, endAngle )

**Description:** Draws a pie slice.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Pie( 10, 80, 70, 40, 0, 90 );
    )
);


```

### [Pixel Line To](#pixel-line-to)

**Syntax:** Pixel Line To( h, v )

**Description:** Draws a line from the current pixel-based pen coordinate to the horizontal and vertical coordinates given.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pixel Origin( 50, 50 ); // in axis coordinates
        // others are pixels, relative to pixel origin
        Pixel Move To( 0, 0 );
        Pixel Line To( 0, 80 );
        Pixel Move To( 2, 0 );
        Pixel Line To( 2, 40 );
        Pixel Move To( 4, 0 );
        Pixel Line To( 4, 20 );
    )
);


```

### [Pixel Move To](#pixel-move-to)

**Syntax:** Pixel Move To( h, v )

**Description:** Moves the pixel-addressed pen to the horizontal and vertical coordinate relative to the origin.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pixel Origin( 50, 50 ); // in axis coordinates
        // others are pixels, relative to pixel origin
        Pixel Move To( 0, 0 );
        Pixel Line To( 0, 80 );
        Pixel Move To( 2, 0 );
        Pixel Line To( 2, 40 );
        Pixel Move To( 4, 0 );
        Pixel Line To( 4, 20 );
    )
);


```

### [Pixel Origin](#pixel-origin)

**Syntax:** Pixel Origin( x, y )

**Description:** Sets the origin that pixel drawing commands are based on.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pixel Origin( 50, 50 ); // in axis coordinates
        // others are pixels, relative to pixel origin
        Pixel Move To( 0, 0 );
        Pixel Line To( 0, 80 );
        Pixel Move To( 2, 0 );
        Pixel Line To( 2, 40 );
        Pixel Move To( 4, 0 );
        Pixel Line To( 4, 20 );
    )
);


```

### [Pixel Path](#pixel-path)

**Syntax:** PixelPath( h, v, pathMatrix|pathText, \<fill=0>, \<scale=1.0>, \<orient={0.0,1.0}> )

**Description:** Draws a stroke along the given pixel-based path if fill is 0, or paints the interior of the given path if fill is not 0. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax. The path will be scaled and translated about its origin according to the optional parameters, with the orientation specified in the axis space.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "blue" );
        angle = 45 * Pi() / 180; // 45 deg in radians
        Pixel Origin( 20, 80 );
        Pixel Path(
            0,
            0, // offset from pixel origin in pixels
            [-10 -10 1,
            10 -10 0,
            20 20 0,
            -10 20 -3],
            1, // fill
            2.0, // scale
            {Sin( angle ), Cos( angle )} // clockwise rotation
        );
        Pixel Origin( 80, 20 );
        Pixel Path(
            0,
            0,
            "M-10,-10 C10,-10 20,20 -10,20 Z",
            0,
            1.0,
            {Sin( -angle ), Cos( -angle )}
        );
    )
);


```

### [Pixel Text](#pixel-text)

**Syntax:** Pixel Text( <properties>, {h, v}, text, ... )

**Description:** Moves to the {h, v} pixel position and draws text specified by the text argument. Named property arguments include Center Justified, Right Justified, Top Align, Bottom Align, Erased, Boxed, Counterclockwise, Clockwise. The position arguments, named arguments, and strings can be mixed in any order.

**JMP Version Added:** Before version 14

```


New Window( "Example",
    Graph Box(
        Pixel Origin( 10, 80 ); // in axis coordinates
        Pixel Move To( 0, 0 );
        Pixel Line To( 160, 140 ); // in pixels from pixel origin
        Pixel Text( {0, 0}, "default" );
        Pixel Text( Erased, Boxed, Clockwise, {75, 75}, "Erased Boxed Clockwise" );
        Pixel Text(
            Center Justified,
            Bottom Align,
            {160, 140},  // in pixels from pixel origin
            "Bottom Align\!NCenter Justified"
        );
    )
);


```

### [Polygon](#polygon)

**Syntax:** Polygon( {x1, y1}, {x2, y2}, ..., \<<fill(bool) ); Polygon( xMatrix, <yMatrix>, \<<fill(bool) )

**Description:** Draws the polygon specified by the points.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "gray" );
        Polygon( [10 30 90], [88 22 44] );
        Polygon( [10 10, 50 80, 80 20, 50 50], <<Fill( 0 ) );
    )
);


```

### [Polygon Area](#polygon-area)

**Syntax:** area = Polygon Area( {x1, y1}, {x2, y2}, ... ); area = Polygon Area( xMatrix, yMatrix )

**Description:** Calculates the area of the specified polygon.

**JMP Version Added:** 14

**Example 1**

```

area = Polygon Area( {0, 0}, {0, 10}, {10, 10}, {10, 0} );


```

**Example 2**

```

area = Polygon Area( [10 20 30], [10 30 20] );


```

### [Polygon Centroid](#polygon-centroid)

**Syntax:** {cx, cy} = Polygon Centroid( {x1, y1}, {x2, y2}, ... ); centroid = Polygon Centroid( xMatrix, yMatrix )

**Description:** Calculates the centroid of the specified polygon.

**JMP Version Added:** 14

**Example 1**

```

{cx, cy} = Polygon Centroid( {0, 0}, {0, 10}, {10, 10}, {10, 0} );


```

**Example 2**

```

centroid = Polygon Centroid( [10 20 30], [10 30 20] );


```

### [Polygon Simplify](#polygon-simplify)

**Syntax:** rows = Polygon Simplify( xMatrix|xyMatrix, <yMatrix>, \<<\<detail factor(f=200)>, \<<\<multiple(ids)>, \<<\<geodesic(bool)> )

**Description:** Removes points from a polygon that carry a low amount of detail and returns indices of the remaining points. detail factor is inversely proportional to the detail error tolerance. multiple(ids) indicates that many polygons should be simplified together so that common edges are treated consistently. ids is a matrix with one row per point. geodesic(1) indicates coordinates are latitude and longitude for distance measurement.

**JMP Version Added:** 19

**Example 1**

```

New Window( "Example",
    Graph Box(
        Fill Color( "cyan" );
        xx = 18 * [1 1 1 1 1 2 3 4 5 5 5 5 5 4 3 2] + J( 1, 16, Random Uniform( -5, 5 ) );
        yy = 18 * [1 2 3 4 5 5 5 5 5 4 3 2 1 1 1 1] + J( 1, 16, Random Uniform( -5, 5 ) );
        Polygon( xx, yy );
        rows = Polygon Simplify( xx, yy, <<detail factor( 10 ) );
        Polygon( xx[rows], yy[rows], <<Fill( 0 ) );
    )
);


```

#### [Multiple polygons](#multiple-polygons)

```

dt = Open( "$SAMPLE_IMPORT_DATA/Parishes.shp" );
rows = Where( dt, 4 <= :Shape <= 7 );
polys = dt[rows, {"X", "Y"}];
ids = dt[rows, {"Shape"}] * 100 + dt[rows, {"Part"}];
Close( dt, NoSave );

simple rows = Polygon Simplify(
    polys,
    <<detail factor( 500 ),
    <<multiple( ids ),
    <<geodesic( 1 )
);
unique ids = Associative Array( ids );

minx = Min( polys[0, 1] );
maxx = Max( polys[0, 1] );
sx = maxx - minx;
miny = Min( polys[0, 2] );
maxy = Max( polys[0, 2] );
sy = maxy - miny;

New Window( "Parishes",
    Graph Box(
        Frame Size( 600, 600 ),
        X Scale( minx - sx * 0.02, maxx + sx * 0.02 ),
        Y Scale( miny - sy * 0.02, maxy + sy * 0.02 ), 

        For Each( {id}, unique ids, 

            rows = simple rows[Loc( ids[simple rows] == id )];
            Pen Color( "light red" );
            Pen Size( 4 );
            Polygon( polys[rows, 0], <<Fill( 0 ) );

            rows = Loc( ids == id );
            Pen Color( "black" );
            Pen Size( 1 );
            Polygon( polys[rows, 0], <<Fill( 0 ) );

            {cx, cy} = Polygon Centroid( polys[rows, 0] );
            Text( Center Justified, {cx, cy}, Char( id ) );
        )
    )
);


```

### [RGB Color](#rgb-color)

**Syntax:** y = RGB Color( r, g, b ); y = RGB Color( {r, g, b} )

**Description:** Returns a color number from the red, green, and blue components, all between 0 and 1. RGB Color(1, 1, 1) is white.

**JMP Version Added:** Before version 14

```

New Window( "RGB Color Example", 
    /* 1 through 16 are good */ 
    division = 6;
    blocks = division + 1;
    ysize = 400 / Sqrt( division );
    xsize = ysize * blocks;
    fract = 1 / division;
    /* 100 is default axis range */
    yBlockSize = 100 / blocks;
    xBlockSize = 100 / (blocks * blocks);
    Graph(
        frameSize( xsize, ysize ),
        For( blue = 0, blue <= 1, blue += fract,
            For( red = 0, red <= 1, red += fract,
                For( green = 0, green <= 1, green += fract,
                    y = red / fract * yBlockSize;
                    x = green / fract * xBlockSize + blue / fract * xBlockSize * blocks;
                    /* here's the example */
                    Fill Color( RGB Color( red, green, blue ) );
                    Rect( x, y, x + xBlockSize, y + yBlockSize, 1 );
                )
            )
        )
    );
);


```

### [Rect](#rect)

**Syntax:** Rect( left, top, right, bottom, \<fill=0> ); Rect( {left, top}, {right, bottom} )

**Description:** Draws a rectangle, filled if fill is nonzero.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "Green" );
        Pen Size( 2 );
        Fill Color( "Red" );
        Rect( 15, 75, 65, 55, 1 );
        Rect( 10, 80, 70, 50 );
    )
);


```

### [Remove Color Theme](#remove-color-theme)

**Syntax:** Remove Color Theme("Name"|{"Name", <flags>, {color, ...}, \<{position, ...}>})

**Description:** Removes a custom color theme from the global list, either by name or by the full color theme object.

**JMP Version Added:** Before version 14

```

Remove Color Theme( "Yellow To Blue" );


```

### [Text](#text)

**Syntax:** Text( <properties>, {x, y}, text, ... ) Text( {left, top, right, bottom}, text )

**Description:** Moves to the {x, y} position and draws text specified by the text argument. Named property arguments include Center Justified, Right Justified, Erased, Boxed, Counterclockwise, Clockwise. The position arguments, named arguments, and strings can be mixed in any order. You can also use four x, y coordinates to describe a box within which to draw the text. In that case, properties are not used.

**JMP Version Added:** Before version 14

**Example 1**

```

New Window( "Example",
    Graph Box(
        Text Color( "red" );
        Text( Center Justified, {50, 20}, "centered" );
    )
);


```

**Example 2**

```

New Window( "Example",
    Graph Box(
        Text Color( "blue" );
        Text( {20, 80, 40, 70}, "some text" );
    )
);


```

### [Text Color](#text-color)

**Syntax:** Text Color( \<name|index|rgbList> )

**Description:** Sets the color for drawing text.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Text Color( "red" );
        Text( {50, 20}, "label" );
    )
);


```

### [Text Font](#text-font)

**Syntax:** {nm, sz, st, an} = Text Font(fontName, <size>, \<"bold italic underline strikeout">, <angle>

**Description:** Sets the font for subsequent Text() drawing. Use without any arguments to get the current font settings. Angle is in degrees clockwise.

**JMP Version Added:** 15

```

New Window( "Degrees",
    Graph Box(
        FrameSize( 400, 400 ),
        X Scale( -100, 100 ),
        Y Scale( -100, 100 ),
        Local( {fname, fsize, fstyle, fangle, i, a},
            {fname, fsize, fstyle, fangle} = Text Font();
            Text Font( If( Host is( "Mac" ), "Helvetica", "Arial" ), 30, "Italic Bold" );
            Text( Center Justified, {0, -10}, "JMP" );
            For( i = 0, i < 360, i += 15,
                Text Font( {fname, 10, "plain", -i + 90} );
                a = i * Pi() / 180;
                Text( Center Justified, {80 * Cos( a ), 80 * Sin( a )}, Char( i ) );
                Line( {70 * Cos( a ), 70 * Sin( a )}, {76 * Cos( a ), 76 * Sin( a )} );
            );
        )
    )
);


```

### [Text Size](#text-size)

**Syntax:** Text Size( n )

**Description:** Sets the font size that for text drawing.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Text Size( 20 );
        Text( {50, 20}, "label" );
    )
);


```

### [To Color Space](#to-color-space)

**Syntax:** color = To Color Space( color, colorSpace )

**Description:** Translates a color into another color space. Out of gamut colors are mapped to fit when converting to smaller color spaces.

**JMP Version Added:** 18

**Example 1**

```

To Color Space( "red", "LMS" );


```

**Example 2**

```

To Color Space( {0.871, 0.032, 0.061, "lRGB"}, "HLS" );


```

**Example 3**

```

To Color Space( {0.941, 0.196, 0.274, "lRGB", 0.871, 0.032, 0.061}, "HLS" );


```

### [Transparency](#transparency)

**Syntax:** Transparency( <alpha> )

**Description:** Sets the transparency used in the drawing commands. Alpha ranges between 0 (clear) and 1 (opaque, the default). Some operating systems do not support this.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Frame Size( 500, 500 ),
        X Scale( -3, 3 ),
        Y Scale( -3, 3 ),
        Transparency( .1 );
        Fill Color( RGB Color( 1/*red*/, 0/*green*/, 0/*blue*/ ) );
        For( i = 0, i < 10000, i++,
            Circle( {Random Normal(), Random Normal()}, 0.05, "FILL" )
        );
    )
);


```

### [V Line](#v-line)

**Syntax:** V Line( x ); V Line( x, y1, y2 )

**Description:** Draws a vertical line at x from y1 to y2 or through the entire frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Size( 2 );
        V Line( 20, 10, 50 );
    )
);


```

### [V Size](#v-size)

**Syntax:** v = V Size()

**Description:** Returns the vertical size of the graphics frame in pixels.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Text Size( V Size() / 4 );
        Text( {50, 20}, "label" );
    )
);


```

### [X Function](#x-function)

**Syntax:** X Function( xExpr, yName, <properties> )

**Description:** Draws function xExpr in the X dimension as variable yName varies across the range of the Y axis of the graph. Additional named property arguments include Min(minimum X), Max(maximum Y), Fill(fill pattern, value to fill to), Inc(upper bound of increment).

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        X Function( 20 + 40 * Sin( a / 30 ), a );
    )
);


```

### [X Origin](#x-origin)

**Syntax:** x = X Origin()

**Description:** Returns the x value for the left edge of the graphics frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [X Range](#x-range)

**Syntax:** x = X Range()

**Description:** Returns the x distance from left to right. X Origin() + X Range() is the right edge.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [X Scale](#x-scale)

**Syntax:** X Scale( <xMin>, <xMax> )

**Description:** Sets a new scale for the graphics frame.

**JMP Version Added:** Before version 14

```

/* Default value for X Scale() is (0,100). */
New Window( "Example",
    Graph Box(
        Y Scale( -10, 90 ),
        X Scale( -10, 90 ),
        Oval(
            X Origin() + 10,
            (Y Origin() + Y Range()) - 10,
            (X Origin() + X Range()) - 10,
            Y Origin() + 10,
            1
        )
    )
);


```

### [XY Function](#xy-function)

**Syntax:** XY Function( x(t), y(t), t, min(0), max(1), inc(.01) | steps(100) )

**Description:** This graphic script function combines an expression x(t) and an expression y(t) to draw an x-y curve for the specified range of parameter t. Inc() is the maximum increment on t, or steps() is the minimum number of steps on t. Use steps() or inc() if the default value does not show details.

**JMP Version Added:** Before version 14

```

New Window( "Spiral",
    Graph Box(
        Pen Color( "red" );
        xCenter = 50;
        yCenter = 50;
        minAngle = 0;
        maxAngle = Pi() * 2 * 20;
        XY Function(
            xCenter + ((ta / 3) * Cos( ta )),
            yCenter + ((ta / 3) * Sin( ta )),
            ta,
            Min( minAngle ),
            Max( maxAngle ),
            inc( Pi() / 100 )
        );
    )
);
/* sin() and cos() use ta as an argument (rotates)
   AND as a factor (expands) in this example.
   (sin and cos use radians, not degrees.) */


```

### [Y Function](#y-function)

**Syntax:** Y Function( yExpr, xName, <properties> )

**Description:** Draws function yExpr in the Y dimension as variable xName varies across the range of the X axis of the graph. Additional named property arguments include Min(minimum X), Max(maximum X), Fill(fill pattern, value to fill to), Inc(upper bound of increment).

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Pen Color( "red" );
        Y Function( 20 + 40 * Sin( a / 30 ), a );
    )
);


```

### [Y Origin](#y-origin)

**Syntax:** y = Y Origin()

**Description:** Returns the y value for the bottom edge of the graphics frame.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [Y Range](#y-range)

**Syntax:** y = Y Range()

**Description:** Returns the y distance from bottom to top. Y Origin() + Y Range() is the top edge.

**JMP Version Added:** Before version 14

```

New Window( "Example",
    Graph Box(
        Fill Color( "red" );
        Oval(
            X Origin() + 10,
            Y Origin() + Y Range() - 10,
            X Origin() + X Range() - 10,
            Y Origin() + 10,
            1
        );
    )
);


```

### [Y Scale](#y-scale)

**Syntax:** Y Scale( <yMin>, <yMax> )

**Description:** Sets a new scale for the graphics frame.

**JMP Version Added:** Before version 14

```

/* Default value for Y Scale() is (0,100).*/
New Window( "Example",
    Graph Box(
        Y Scale( -10, 90 ),
        X Scale( -10, 90 ),
        Oval(
            X Origin() + 10,
            (Y Origin() + Y Range()) - 10,
            (X Origin() + X Range()) - 10,
            Y Origin() + 10,
            1
        )
    )
);


```

# [JMP Clinical](#jmp-clinical)

### [JMPClinicalReviewAPI:addReport](#jmpclinicalreviewapiaddreport)

**Syntax:** JMPClinicalReviewAPI:addReport(reportDefinitionID = "", reportUserCustomizedTitle = ., reportOptionValues = [=>]}, {rb, reportDefinition, ret, templateContent, addedReports, addedReport)

**Description:** Adds a report to Review Builder

\*

\* reportDefinitionID => String: The name/id of the Report to add (e.g. "AdverseEventsDistribution").

\* reportUserCustomizedTitle => String: The user-customized report title (e.g., "My AE Dist").

\* Specify numeric missing (.) to indicate the title is not customized by the user.

\* reportOptionValues => Associative Array: Internal widget option name-value pairs

\* (e.g., ["objRefNS:eventcb_AdverseEvents_AE" => "PRE", "objRefNS:TEAECheckBox" => "Yes"]).

\* Specify [=>] to use all default option values.

\*

\* return - a namespace to the added report

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:addReport(
    "AdverseEventsDistribution",
    "Customized Adverse Events Distribution",
    ["objRefNS:stkcb" => "AESER"]
);


```

### [JMPClinicalReviewAPI:applyReportSubjectSelectionToReviewSubjectFilter](#jmpclinicalreviewapiapplyreportsubjectselectiontoreviewsubjectfilter)

**Syntax:** JMPClinicalReviewAPI:applyReportSubjectSelectionToReviewSubjectFilter(reportID = .)

**Description:** Applies the subject selection from the specified report in Review Builder to the Review Subject Filter

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
Current Data Table() << SelectWhere( :Serious Event == "Y" );
Wait( 1 );
JMPClinicalReviewAPI:applyReportSubjectSelectionToReviewSubjectFilter( . );
Wait( 1 );
JMPClinicalReviewAPI
:changeReviewSubjectFilterSelection( ":Unique Subject Identifier" );


```

### [JMPClinicalReviewAPI:changeReport](#jmpclinicalreviewapichangereport)

**Syntax:** JMPClinicalReviewAPI:changeReport(reportID = ., reportUserCustomizedTitle = empty(), reportOptionValues = [=>])

**Description:** Renames a report tab and/or changes one or more option values in a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* reportUserCustomizedTitle => String: The new report title.

\* Specify empty() to make no changes to the report title.

\* Specify numeric missing (.) to indicate the title is no longer customized by the user (to allow the report to be dynamically named).

\* reportOptionValues => Associative Array: Internal widget option name-value pairs specifying values to change.

\* (e.g., ["objRefNS:eventcb_AdverseEvents_AE" => "PRE", "objRefNS:TEAECheckBox" => "Yes"]).

\* Specify [=>] to make no changes to the report option values.

\* Specify numeric missing (.) to reset the report to its default option values.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

\* Invalid options and option values are ignored.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
Wait( 1 );
JMPClinicalReviewAPI:changeReport(
    .,
    "Customized Adverse Events Distribution",
    ["objRefNS:stkcb" => "AESER"]
);


```

### [JMPClinicalReviewAPI:changeReportColumnSwitcherSelection](#jmpclinicalreviewapichangereportcolumnswitcherselection)

**Syntax:** JMPClinicalReviewAPI:changeReportColumnSwitcherSelection(reportID = ., columnSwitcherIndex = 1, columnToSelect = empty())

**Description:** Changes the column switcher selection in a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* columnSwitcherIndex => Integer: The index of the column switcher within the specified report.

\* The first (or only) column switcher in a report will have an index of 1. The default value is 1.

\* columnToSelect => String: The column name to select in the column switcher.

\* Specify numeric missing (.) to reset the column switcher to its default column.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

\* Invalid column names are ignored.

```

JMPClinicalReviewAPI:addReport( "FindingsBoxPlots" );
Wait( 1 );
JMPClinicalReviewAPI
:changeReportColumnSwitcherSelection( ., 1, "Glucose (mmol/L)" );


```

### [JMPClinicalReviewAPI:changeReportFilterSelection](#jmpclinicalreviewapichangereportfilterselection)

**Syntax:** JMPClinicalReviewAPI:changeReportFilterSelection(reportID = ., extendWhereStmt = ., indexForMultiple = 1)

**Description:** Changes the current report filter selection in a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* extendWhereStmt => String: The column and values to select. Example: ":Serious Event == {!"N!"}"

\* Specify a column without an operator or value to clear the report filter selection. Example: ":Serious Event"

\* indexForMultiple => Integer: If the column specified in the extendWhereStmt is used multiple times,

\* this index specifies which occurrence to use.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI
:changeReportFilterSelection(
    .,
    ":Overall Percent Occurrence >= 10 & :Overall Percent Occurrence <= 50"
);


```

### [JMPClinicalReviewAPI:changeReportOptions](#jmpclinicalreviewapichangereportoptions)

**Syntax:** JMPClinicalReviewAPI:changeReportOptions(reportID = ., reportOptionValues = [=>])

**Description:** Changes one or more option values in a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* reportOptionValues => Associative Array: Internal widget option name-value pairs specifying values to change

\* (e.g., ["objRefNS:eventcb_AdverseEvents_AE" => "PRE", "objRefNS:TEAECheckBox" => "Yes"]).

\* Specify numeric missing (.) to reset the report to its default option values.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

\* Invalid options and option values are ignored.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
Wait( 1 );
JMPClinicalReviewAPI:changeReportOptions( ., ["objRefNS:stkcb" => "AESER"] );


```

### [JMPClinicalReviewAPI:changeReviewSubjectFilter](#jmpclinicalreviewapichangereviewsubjectfilter)

**Syntax:** JMPClinicalReviewAPI:changeReviewSubjectFilter(savedFilter = .)

**Description:** Changes the Review Subject Filter in Review Builder

\*

\* savedFilter => String: The filter definition or name of a saved subject filter

\* Specify empty(), numeric missing (.), "", or " " to reset the filter.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
//JMPClinicalReviewAPI:changeReviewSubjectFilter("My Saved Filter Name");
Wait( 1 );
JMPClinicalReviewAPI
:changeReviewSubjectFilter(
    "Current Data Table() << Data Filter(Title( \!"Review Subject Filter\!" ), Conditional, Mode( Select( 0 ), Show( 1 ), Include( 1 ) ), Add Filter(columns(:Age, :Sex, :Race, :Unique Subject Identifier)))"
);
Wait( 1 );
JMPClinicalReviewAPI:changeReviewSubjectFilter( . );


```

### [JMPClinicalReviewAPI:changeReviewSubjectFilterSelection](#jmpclinicalreviewapichangereviewsubjectfilterselection)

**Syntax:** JMPClinicalReviewAPI:changeReviewSubjectFilterSelection(extendWhereStmt = ., indexForMultiple = 1)

**Description:** Changes the current Review Subject Filter selection in Review Builder

\*

\* extendWhereStmt => String: The column and values to select. Example: ":Sex == {!"F!"}"

\* Specify a column without an operator or value to clear the Review Subject Filter selection. Example: ":Sex"

\* indexForMultiple => Integer: If the column specified in the extendWhereStmt is used multiple times,

\* this index specifies which occurrence to use.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI
:changeReviewSubjectFilterSelection( ":Sex == {\!"F\!"}" );
Wait( 1 );
JMPClinicalReviewAPI:changeReviewSubjectFilterSelection( ":Sex" );


```

### [JMPClinicalReviewAPI:closeReviewBuilder](#jmpclinicalreviewapiclosereviewbuilder)

**Syntax:** JMPClinicalReviewAPI:closeReviewBuilder()

**Description:** Closes the current Review Builder instance

\*

\* return - N/A

```

JMPClinicalReviewAPI:closeReviewBuilder();


```

### [JMPClinicalReviewAPI:createLiveReport](#jmpclinicalreviewapicreatelivereport)

**Syntax:** JMPClinicalReviewAPI:createLiveReport(publishOptions = [=>], reportRefs = {})

**Description:** Create a web-based JMP Live version of the Review

\*

\* publishOptions => Associative Array: the keys and values for the following publish options:

\*

\* "ConnectionName" => String: the name of the JMP Live Connection

\* "Space" => String: the title or key of the JMP Live Space to publish to, within the JMP Live Connection

\* "Folder" => String: the title, path, or ID of the JMP Live Folder to publish to, within the JMP Live Space

\* Specify "" to publish to the space root.

\* "PublishData" => Number: 0 = disallow data to be published, 1 = allow data to be published

\* "PublishOptimization" => Number: 1 = best interactivity, 2 = best performance

\* "PublishNotes" => Number: 0 = do not include notes, 1 = include notes

\* "PatientProfilesPublishPopulation" => String: "SELECTED" = publish selected patients only (default), "ALL" = publish all patients

\* "PatientProfilesPublishGraphs" => Number: 0 = do not publish graphs, 1 = publish graphs (default)

\* "PatientProfilesPublishTables" => Number: 0 = do not publish tables, 1 = publish tables (default)

\*

\* Omit keys or specify empty() values to use the current interactive Create Live Report dialog default values.

\* \*CAUTION: Key and value omission is offered as a convenience. Publish failure is likely if the

\* interactive dialog has never been opened. Specify all keys and values to rule out unintended influence

\* from interactive publish options.

\*

\* Specify empty() instead of an associative array for the publishOptions argument to surface the interactive

\* Create Live Report dialog.

\* \*CAUTION: Doing so will pause script execution for user input.

\*

\* reportRefs => List: If not empty list, create for only this list of report references

\*

\* return - a String: URL of the web report

#### [Batch](#batch)

```

/*
 * Use the following environment variables to control elements of the batch execution: 
 *
 * set JMPClinicalBatchMode=true                    options include: true, debug
 * set JMPClinicalBatchLogPath=%CD%\                the path where the log file should be written
 * set JMPClinicalBatchConfiguration=Default        the configuration to use. if not specified, the last configuration used interactively will be used 
 * set JMPClinicalBatchCurrentStudy=                the study to use for Review Builder operations (not used by the JMPClinicalStudyManagerAPI)
*/

exitJMPClinicalBatch = Function( {},
    {},
    Save Log(
        Get Environment Variable( "JMPClinicalBatchLogPath" ) ||
        "JMPClinicalBatchLog.log"
    );
    Exit();
);

Show( JMPClinicalReviewAPI:getCurrentStudy() );
// Build a review template
rn = JMPClinicalReviewAPI:addReport(
    "AdverseEventsDistribution",
    "Customized Adverse Events Distribution",
    ["objRefNS:stkcb" => "AESER"]
);
JMPClinicalReviewAPI:renameReport(
    ., "AESER Stack Adverse Events Distribution"
); // . refers to the currently selected report tab
JMPClinicalReviewAPI:changeReportOptions(
    rn,
    ["objRefNS:eventcb_AdverseEvents_AE" => "PRE"]
); // Can also use report namespace, reference, index, title, or name
Show( JMPClinicalReviewAPI:getReportOptions( . ) );
Show( JMPClinicalReviewAPI:getAllReportReferences() );
Show(
    JMPClinicalReviewAPI:getReportReference( "AdverseEventsDistribution" )
); // CAUTION: Report names are NOT guaranteed to be unique within a review
Show(
    JMPClinicalReviewAPI:getReportIndex(
        "AESER Stack Adverse Events Distribution"
    )
); // Report titles are guaranteed to be unique within a review
Show( JMPClinicalReviewAPI:getReportTitle( 1 ) ); // Report indicies are guaranteed to be unique within a review 
Show( JMPClinicalReviewAPI:getReportName( . ) ); // The currently selected report tab is guaranteed to be unique within a review
JMPClinicalReviewAPI:resetReport( . );
JMPClinicalReviewAPI:renameReport( ., . );
JMPClinicalReviewAPI:addReport(
    "FindingsBoxPlots",
    "Customized Findings Box Plots",
    [=> ]
);
Show( JMPClinicalReviewAPI:getReportColumnSwitcherSelection( ., 1 ) );
JMPClinicalReviewAPI
:changeReportColumnSwitcherSelection( ., 1, "Calcium (mmol/L)" );
JMPClinicalReviewAPI:changeReport( ., ., . );
JMPClinicalReviewAPI:deleteReport( . );
JMPClinicalReviewAPI:deleteReport( . );
JMPClinicalReviewAPI:addReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI
:changeReportFilterSelection(
    .,
    ":Overall Percent Occurrence >= 10 & :Overall Percent Occurrence <= 50"
);
JMPClinicalReviewAPI
:changeReportFilterSelection(
    ., ":\!"Toxicity Grade/Severity\!"n == {\!"MODERATE\!"}"
);
JMPClinicalReviewAPI
:changeReportFilterSelection( ., ":Serious Event == {\!"N\!"}" );
Show( JMPClinicalReviewAPI:getReportFilterSelection( . ) );
Current Data Table() << SelectWhere( :Serious Event == "Y" );
Wait( 0 );
JMPClinicalReviewAPI:applyReportSubjectSelectionToReviewSubjectFilter( . );
JMPClinicalReviewAPI:moveReport(
    "DemographicsDistribution", "AdverseEventsDistribution"
);
JMPClinicalReviewAPI:moveReport( 2, 1 );
JMPClinicalReviewAPI:duplicateReport( 1 );
JMPClinicalReviewAPI:selectReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:createStaticReportForReport( . );
JMPClinicalReviewAPI:createLiveReportForReport( ., [=> ] );
JMPClinicalReviewAPI:selectReport( 1 );
JMPClinicalReviewAPI:showReportTables( . );
JMPClinicalReviewAPI:changeReviewSubjectFilter( "My Saved Filter Name" ); // Change the review subject filter to a saved one (by name)
JMPClinicalReviewAPI
:changeReviewSubjectFilter( // Change the review subject filter to this definition
    "Current Data Table() << Data Filter(Title( \!"Review Subject Filter\!" ),
    Conditional, Mode( Select( 0 ), Show( 1 ), Include( 1 ) ),
    Add Filter(columns(:Age, :Sex, :Race, :Unique Subject Identifier)))"
);
JMPClinicalReviewAPI:changeReviewSubjectFilter( . ); // Reset the review subject filter
JMPClinicalReviewAPI
:changeReviewSubjectFilterSelection( ":Sex == {\!"F\!"}" );
Show( JMPClinicalReviewAPI:getReviewSubjectFilterSelection() );
JMPClinicalReviewAPI:saveReviewTemplate( "ReviewManagementExamples", 1 );
JMPClinicalReviewAPI:resetAllReports();
JMPClinicalReviewAPI:deleteAllReports();
JMPClinicalReviewAPI:closeReviewBuilder();

// Use an existing review template
JMPClinicalReviewAPI:openReviewTemplate(
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\ReviewTemplates\Medical Monitoring.jmpcrt",
    1, 0, 1, 0
);
If( !Directory Exists( "C:\JMPClinicalReviewManager" ),
    Create Directory( "C:\JMPClinicalReviewManager" )
);
If( Directory Exists( "C:\JMPClinicalReviewManager" ),
    JMPClinicalReviewAPI:createStaticReport(
        "PDF", 0, "C:\JMPClinicalReviewManager\APIReview.pdf", "SELECTED", 1,
        1
    )
);
JMPClinicalReviewAPI:createLiveReport(
    ["ConnectionName" => Empty(),
    "Space" => "_PERSONAL_",
    "Folder" => "",
    "PublishData" => 0,
    "PublishOptimization" => 1,
    "PublishNotes" => 0,
    "PatientProfilesPublishPopulation" => "SELECTED",
    "PatientProfilesPublishGraphs" => 1,
    "PatientProfilesPublishTables" => 1]
);
JMPClinicalReviewAPI:closeReviewBuilder();
exitJMPClinicalBatch();
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

#### [Simple](#simple)

```

JMPClinicalReviewAPI:openReviewTemplate(
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\ReviewTemplates\Medical Monitoring.jmpcrt",
    1, 0, 1, 0
);
Web(
    JMPClinicalReviewAPI:createLiveReport(
        ["ConnectionName" => Empty(),
        "Space" => "_PERSONAL_",
        "Folder" => "",
        "PublishData" => 0,
        "PublishOptimization" => 1,
        "PublishNotes" => 0,
        "PatientProfilesPublishPopulation" => "SELECTED",
        "PatientProfilesPublishGraphs" => 1,
        "PatientProfilesPublishTables" => 1]
    )
);


```

### [JMPClinicalReviewAPI:createLiveReportForReport](#jmpclinicalreviewapicreatelivereportforreport)

**Syntax:** JMPClinicalReviewAPI:createLiveReportForReport(reportID = ., publishOptions = [=>])

**Description:** Create a web-based JMP Live version of one report in a Review

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* publishOptions => Associative Array: the keys and values for the following publish options:

\*

\* "ConnectionName" => String: the name of the JMP Live Connection

\* "Space" => String: the title or key of the JMP Live Space to publish to, within the JMP Live Connection

\* "Folder" => String: the title, path, or ID of the JMP Live Folder to publish to, within the JMP Live Space

\* Specify "" to publish to the space root.

\* "PublishData" => Number: 0 = disallow data to be published, 1 = allow data to be published

\* "PublishOptimization" => Number: 1 = best interactivity, 2 = best performance

\* "PublishNotes" => Number: 0 = do not include notes, 1 = include notes

\* "PatientProfilesPublishPopulation" => String: "SELECTED" = publish selected patients only (default), "ALL" = publish all patients

\* "PatientProfilesPublishGraphs" => Number: 0 = do not publish graphs, 1 = publish graphs (default)

\* "PatientProfilesPublishTables" => Number: 0 = do not publish tables, 1 = publish tables (default)

\*

\* Omit keys or specify empty() values to use the current interactive Create Live Report dialog default values.

\* \*CAUTION: Key and value omission is offered as a convenience. Publish failure is likely if the

\* interactive dialog has never been opened. Specify all keys and values to rule out unintended influence

\* from interactive publish options.

\*

\* Specify empty() instead of an associative array for the publishOptions argument to surface the interactive

\* Create Live Report dialog.

\* \*CAUTION: Doing so will pause script execution for user input.

\*

\* return - a String: URL of the web report

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:addReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:selectReport( 1 );
Web( JMPClinicalReviewAPI:createLiveReportForReport( ., [=> ] ) );


```

### [JMPClinicalReviewAPI:createStaticReport](#jmpclinicalreviewapicreatestaticreport)

**Syntax:** JMPClinicalReviewAPI:createStaticReport(type = empty(), includeNotes = empty(), filePath = empty(), patientProfilesPublishPopulation = "SELECTED", patientProfilesPublishGraphs = 1, patientProfilesPublishTables = 1, reportRefs = {})

**Description:** Create a static version (PDF or RTF) of the Review

\*

\* type => String: "PDF" or "RTF"

\* includeNotes => Number: 0 = do not include notes, 1 = include notes

\* filePath => String: full file path where to save report. If not specified, the default

\* static report location is used - as specified in the configuration as /user/clinical/staticreportpath

\* patientProfilesPublishPopulation => String: "SELECTED" = publish selected patients only (default), "ALL" = publish all patients

\* patientProfilesPublishGraphs => Number: 0 = do not publish graphs, 1 = publish graphs (default)

\* patientProfilesPublishTables => Number: 0 = do not publish tables, 1 = publish tables (default)

\* reportRefs => List: If not empty list, create for only this list of report references

\*

\* return - a String: Path to the static report

#### [Batch](#batch_1)

```

/*
 * Use the following environment variables to control elements of the batch execution: 
 *
 * set JMPClinicalBatchMode=true                    options include: true, debug
 * set JMPClinicalBatchLogPath=%CD%\                the path where the log file should be written
 * set JMPClinicalBatchConfiguration=Default        the configuration to use. if not specified, the last configuration used interactively will be used 
 * set JMPClinicalBatchCurrentStudy=                the study to use for Review Builder operations (not used by the JMPClinicalStudyManagerAPI)
*/

exitJMPClinicalBatch = Function( {},
    {},
    Save Log(
        Get Environment Variable( "JMPClinicalBatchLogPath" ) ||
        "JMPClinicalBatchLog.log"
    );
    Exit();
);

Show( JMPClinicalReviewAPI:getCurrentStudy() );
// Build a review template
rn = JMPClinicalReviewAPI:addReport(
    "AdverseEventsDistribution",
    "Customized Adverse Events Distribution",
    ["objRefNS:stkcb" => "AESER"]
);
JMPClinicalReviewAPI:renameReport(
    ., "AESER Stack Adverse Events Distribution"
); // . refers to the currently selected report tab
JMPClinicalReviewAPI:changeReportOptions(
    rn,
    ["objRefNS:eventcb_AdverseEvents_AE" => "PRE"]
); // Can also use report namespace, reference, index, title, or name
Show( JMPClinicalReviewAPI:getReportOptions( . ) );
Show( JMPClinicalReviewAPI:getAllReportReferences() );
Show(
    JMPClinicalReviewAPI:getReportReference( "AdverseEventsDistribution" )
); // CAUTION: Report names are NOT guaranteed to be unique within a review
Show(
    JMPClinicalReviewAPI:getReportIndex(
        "AESER Stack Adverse Events Distribution"
    )
); // Report titles are guaranteed to be unique within a review
Show( JMPClinicalReviewAPI:getReportTitle( 1 ) ); // Report indicies are guaranteed to be unique within a review 
Show( JMPClinicalReviewAPI:getReportName( . ) ); // The currently selected report tab is guaranteed to be unique within a review
JMPClinicalReviewAPI:resetReport( . );
JMPClinicalReviewAPI:renameReport( ., . );
JMPClinicalReviewAPI:addReport(
    "FindingsBoxPlots",
    "Customized Findings Box Plots",
    [=> ]
);
Show( JMPClinicalReviewAPI:getReportColumnSwitcherSelection( ., 1 ) );
JMPClinicalReviewAPI
:changeReportColumnSwitcherSelection( ., 1, "Calcium (mmol/L)" );
JMPClinicalReviewAPI:changeReport( ., ., . );
JMPClinicalReviewAPI:deleteReport( . );
JMPClinicalReviewAPI:deleteReport( . );
JMPClinicalReviewAPI:addReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI
:changeReportFilterSelection(
    .,
    ":Overall Percent Occurrence >= 10 & :Overall Percent Occurrence <= 50"
);
JMPClinicalReviewAPI
:changeReportFilterSelection(
    ., ":\!"Toxicity Grade/Severity\!"n == {\!"MODERATE\!"}"
);
JMPClinicalReviewAPI
:changeReportFilterSelection( ., ":Serious Event == {\!"N\!"}" );
Show( JMPClinicalReviewAPI:getReportFilterSelection( . ) );
Current Data Table() << SelectWhere( :Serious Event == "Y" );
Wait( 0 );
JMPClinicalReviewAPI:applyReportSubjectSelectionToReviewSubjectFilter( . );
JMPClinicalReviewAPI:moveReport(
    "DemographicsDistribution", "AdverseEventsDistribution"
);
JMPClinicalReviewAPI:moveReport( 2, 1 );
JMPClinicalReviewAPI:duplicateReport( 1 );
JMPClinicalReviewAPI:selectReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:createStaticReportForReport( . );
JMPClinicalReviewAPI:createLiveReportForReport( ., [=> ] );
JMPClinicalReviewAPI:selectReport( 1 );
JMPClinicalReviewAPI:showReportTables( . );
JMPClinicalReviewAPI:changeReviewSubjectFilter( "My Saved Filter Name" ); // Change the review subject filter to a saved one (by name)
JMPClinicalReviewAPI
:changeReviewSubjectFilter( // Change the review subject filter to this definition
    "Current Data Table() << Data Filter(Title( \!"Review Subject Filter\!" ),
    Conditional, Mode( Select( 0 ), Show( 1 ), Include( 1 ) ),
    Add Filter(columns(:Age, :Sex, :Race, :Unique Subject Identifier)))"
);
JMPClinicalReviewAPI:changeReviewSubjectFilter( . ); // Reset the review subject filter
JMPClinicalReviewAPI
:changeReviewSubjectFilterSelection( ":Sex == {\!"F\!"}" );
Show( JMPClinicalReviewAPI:getReviewSubjectFilterSelection() );
JMPClinicalReviewAPI:saveReviewTemplate( "ReviewManagementExamples", 1 );
JMPClinicalReviewAPI:resetAllReports();
JMPClinicalReviewAPI:deleteAllReports();
JMPClinicalReviewAPI:closeReviewBuilder();

// Use an existing review template
JMPClinicalReviewAPI:openReviewTemplate(
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\ReviewTemplates\Medical Monitoring.jmpcrt",
    1, 0, 1, 0
);
If( !Directory Exists( "C:\JMPClinicalReviewManager" ),
    Create Directory( "C:\JMPClinicalReviewManager" )
);
If( Directory Exists( "C:\JMPClinicalReviewManager" ),
    JMPClinicalReviewAPI:createStaticReport(
        "PDF", 0, "C:\JMPClinicalReviewManager\APIReview.pdf", "SELECTED", 1,
        1
    )
);
JMPClinicalReviewAPI:createLiveReport(
    ["ConnectionName" => Empty(),
    "Space" => "_PERSONAL_",
    "Folder" => "",
    "PublishData" => 0,
    "PublishOptimization" => 1,
    "PublishNotes" => 0,
    "PatientProfilesPublishPopulation" => "SELECTED",
    "PatientProfilesPublishGraphs" => 1,
    "PatientProfilesPublishTables" => 1]
);
JMPClinicalReviewAPI:closeReviewBuilder();
exitJMPClinicalBatch();
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

#### [Simple](#simple_1)

```

JMPClinicalReviewAPI:openReviewTemplate(
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\ReviewTemplates\Medical Monitoring.jmpcrt",
    1, 0, 1, 0
);
If( !Directory Exists( "C:\JMPClinicalReviewManager" ),
    Create Directory( "C:\JMPClinicalReviewManager" )
);
If( Directory Exists( "C:\JMPClinicalReviewManager" ),
    Open(
        JMPClinicalReviewAPI
        :createStaticReport(
            "PDF", 0, "C:\JMPClinicalReviewManager\APIReview.pdf",
            "SELECTED", 1, 1
        )
    )
);


```

### [JMPClinicalReviewAPI:createStaticReportForReport](#jmpclinicalreviewapicreatestaticreportforreport)

**Syntax:** JMPClinicalReviewAPI:createStaticReportForReport(reportID = ., type = empty(), includeNotes = empty(), filePath = empty(), patientProfilesPublishPopulation = "SELECTED", patientProfilesPublishGraphs = 1, patientProfilesPublishTables = 1)

**Description:** Create a static version (PDF, RTF, PowerPoint) of one report in a Review

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* type => String: "PDF", "RTF", or "PowerPoint"

\* includeNotes => Number: 0 = do not include notes, 1 = include notes

\* filePath => String: full file path where to save report. If not specified, the default

\* static report location is used - as specified in the configuration as /user/clinical/staticreportpath

\* patientProfilesPublishPopulation => String: "SELECTED" = publish selected patients only (default), "ALL" = publish all patients

\* patientProfilesPublishGraphs => Number: 0 = do not publish graphs, 1 = publish graphs (default)

\* patientProfilesPublishTables => Number: 0 = do not publish tables, 1 = publish tables (default)

\*

\* return - a String: Path to the static report

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:addReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:selectReport( 1 );
Open( JMPClinicalReviewAPI:createStaticReportForReport( . ) );


```

### [JMPClinicalReviewAPI:deleteAllReports](#jmpclinicalreviewapideleteallreports)

**Syntax:** JMPClinicalReviewAPI:deleteAllReports()

**Description:** Deletes all report tabs from Review Builder

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:addReport( "DemographicsDistribution" );
Wait( 1 );
JMPClinicalReviewAPI:deleteAllReports();


```

### [JMPClinicalReviewAPI:deleteReport](#jmpclinicalreviewapideletereport)

**Syntax:** JMPClinicalReviewAPI:deleteReport(reportID = .)

**Description:** Deletes a report tab from Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
Wait( 1 );
JMPClinicalReviewAPI:deleteReport( . );


```

### [JMPClinicalReviewAPI:duplicateReport](#jmpclinicalreviewapiduplicatereport)

**Syntax:** JMPClinicalReviewAPI:duplicateReport(reportID = .)

**Description:** Duplicates a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:duplicateReport( . );


```

### [JMPClinicalReviewAPI:getAllReportReferences](#jmpclinicalreviewapigetallreportreferences)

**Syntax:** JMPClinicalReviewAPI:getAllReportReferences()

**Description:** Returns a report reference for every report tab in Review Builder

\*

\* return - a list of report references. If the review is empty, an empty list {} is returned.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:addReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:getAllReportReferences();


```

### [JMPClinicalReviewAPI:getCurrentStudy](#jmpclinicalreviewapigetcurrentstudy)

**Syntax:** JMPClinicalReviewAPI:getCurrentStudy()

**Description:** Returns the name of the current study.

\*

\* return - if there is a current study, the study name (a string); otherwise Empty().

```

JMPClinicalReviewAPI:getCurrentStudy();


```

### [JMPClinicalReviewAPI:getReportColumnSwitcherSelection](#jmpclinicalreviewapigetreportcolumnswitcherselection)

**Syntax:** JMPClinicalReviewAPI:getReportColumnSwitcherSelection(reportID = ., columnSwitcherIndex = 1)

**Description:** Returns the current column switcher selection in a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* columnSwitcherIndex => Integer: The index of the column switcher within the specified report.

\* The first (or only) column switcher in a report will have an index of 1. The default value is 1.

\*

\* return - a String: The currently selected column in the column switcher.

```

JMPClinicalReviewAPI:addReport( "FindingsBoxPlots" );
JMPClinicalReviewAPI:getReportColumnSwitcherSelection( ., 1 );


```

### [JMPClinicalReviewAPI:getReportFilterSelection](#jmpclinicalreviewapigetreportfilterselection)

**Syntax:** JMPClinicalReviewAPI:getReportFilterSelection(reportID = .)

**Description:** Returns the current report filter selection in a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - a String: The current report filter selection.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI
:changeReportFilterSelection(
    .,
    ":Overall Percent Occurrence >= 10 & :Overall Percent Occurrence <= 50"
);
JMPClinicalReviewAPI:getReportFilterSelection( . );


```

### [JMPClinicalReviewAPI:getReportIndex](#jmpclinicalreviewapigetreportindex)

**Syntax:** JMPClinicalReviewAPI:getReportIndex(reportID = .)

**Description:** Returns the report index from a report reference in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: The index (position) of the report tab within the review. The first tab will have an index of 1.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:getReportIndex( . );


```

### [JMPClinicalReviewAPI:getReportName](#jmpclinicalreviewapigetreportname)

**Syntax:** JMPClinicalReviewAPI:getReportName(reportID = .)

**Description:** Returns the report name/id from a report reference in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - a String: The name/id of the report.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:getReportName( . );


```

### [JMPClinicalReviewAPI:getReportOptions](#jmpclinicalreviewapigetreportoptions)

**Syntax:** JMPClinicalReviewAPI:getReportOptions(reportID = .)

**Description:** Returns the options and option values from a report reference in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Associative Array: The internal widget option name-value pairs.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:getReportOptions( . );


```

### [JMPClinicalReviewAPI:getReportReference](#jmpclinicalreviewapigetreportreference)

**Syntax:** JMPClinicalReviewAPI:getReportReference(reportID = ., warnInvalidReportReference = 1)

**Description:** Returns a report reference from a report namespace, selected tab, tab index, report title, reference, or report name in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* warnInvalidReportReference => Integer: Specify 1 to warn, or 0 to not warn, about an invalid report reference.

\*

\* return - a reference to the report. If the report reference invalid, empty() is returned.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:getReportReference( . );


```

### [JMPClinicalReviewAPI:getReportTitle](#jmpclinicalreviewapigetreporttitle)

**Syntax:** JMPClinicalReviewAPI:getReportTitle(reportID = .)

**Description:** Returns the report title from a report reference in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - a String: The title of the report.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:getReportTitle( . );


```

### [JMPClinicalReviewAPI:getReviewBuilder](#jmpclinicalreviewapigetreviewbuilder)

**Syntax:** JMPClinicalReviewAPI:getReviewBuilder(show=1)

**Description:** Gets an instance of a Review Builder. If an instance doesn't

\* exist, one will be created.

\*

\* show - 1(default) = show the window, 0 = hide the window, -1 = keep original window visibility

\*

\* return - a reference to the Review Builder object

```

JMPClinicalReviewAPI:getReviewBuilder();


```

### [JMPClinicalReviewAPI:getReviewSubjectFilterSelection](#jmpclinicalreviewapigetreviewsubjectfilterselection)

**Syntax:** JMPClinicalReviewAPI:getReviewSubjectFilterSelection()

**Description:** Returns the current Review Subject Filter selection in Review Builder

\*

\* return - a String: The current Review Subject Filter selection.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI
:changeReviewSubjectFilterSelection( ":Sex == {\!"F\!"}" );
JMPClinicalReviewAPI:getReviewSubjectFilterSelection();


```

### [JMPClinicalReviewAPI:moveReport](#jmpclinicalreviewapimovereport)

**Syntax:** JMPClinicalReviewAPI:moveReport(fromReportID = ., toReportID = .)

**Description:** Moves a report tab from its starting index to a new index in Review Builder

\*

\* fromReportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* toReportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

r1 = JMPClinicalReviewAPI:getReportReference(
    JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" )
);
r2 = JMPClinicalReviewAPI:getReportReference(
    JMPClinicalReviewAPI:addReport( "DemographicsDistribution" )
);
Wait( 1 );
JMPClinicalReviewAPI:moveReport( r1, r2 );


```

### [JMPClinicalReviewAPI:openReviewTemplate](#jmpclinicalreviewapiopenreviewtemplate)

**Syntax:** JMPClinicalReviewAPI:openReviewTemplate(templatePath, useNewReviewBuilder=1, returnType=0, toleratePre17Template=1, closeReportsWithInexactOptionValueMatches=0)

**Description:** Open a Review Template

\*

\* templatePath => String: path to the Review Template to open

\* useNewReviewBuilder => Number:

\* 0 = reuse a Review Builder instance if one exists, otherwise open a new one

\* 1 = close any existing Review Builder instance and open a new one (default)

\* returnType => Number:

\* 0 = return a success code (1 if successful, 0 or missing (.) if unsuccessful or cancelled) (default)

\* 1 = return a reference to the Review Builder object (behavior prior to JMP Clinical 18.2)

\* toleratePre17Template => Number:

\* 0 = abort the template run if the template predates JMP Clinical 17

\* 1 = run the template to the extent possible regardless of template version (default)

\* closeReportsWithInexactOptionValueMatches => Number:

\* 0 = keep all reports (default)

\* 1 = close all reports with inexact option value matches

\*

\* return:

\* if returnType = 0, 1 if successful, 0 or missing (.) if unsuccessful or cancelled

\* if returnType = 1, a reference to the Review Builder object

#### [Batch](#batch_2)

```

/*
 * Use the following environment variables to control elements of the batch execution: 
 *
 * set JMPClinicalBatchMode=true                    options include: true, debug
 * set JMPClinicalBatchLogPath=%CD%\                the path where the log file should be written
 * set JMPClinicalBatchConfiguration=Default        the configuration to use. if not specified, the last configuration used interactively will be used 
 * set JMPClinicalBatchCurrentStudy=                the study to use for Review Builder operations (not used by the JMPClinicalStudyManagerAPI)
*/

exitJMPClinicalBatch = Function( {},
    {},
    Save Log(
        Get Environment Variable( "JMPClinicalBatchLogPath" ) ||
        "JMPClinicalBatchLog.log"
    );
    Exit();
);

Show( JMPClinicalReviewAPI:getCurrentStudy() );
// Build a review template
rn = JMPClinicalReviewAPI:addReport(
    "AdverseEventsDistribution",
    "Customized Adverse Events Distribution",
    ["objRefNS:stkcb" => "AESER"]
);
JMPClinicalReviewAPI:renameReport(
    ., "AESER Stack Adverse Events Distribution"
); // . refers to the currently selected report tab
JMPClinicalReviewAPI:changeReportOptions(
    rn,
    ["objRefNS:eventcb_AdverseEvents_AE" => "PRE"]
); // Can also use report namespace, reference, index, title, or name
Show( JMPClinicalReviewAPI:getReportOptions( . ) );
Show( JMPClinicalReviewAPI:getAllReportReferences() );
Show(
    JMPClinicalReviewAPI:getReportReference( "AdverseEventsDistribution" )
); // CAUTION: Report names are NOT guaranteed to be unique within a review
Show(
    JMPClinicalReviewAPI:getReportIndex(
        "AESER Stack Adverse Events Distribution"
    )
); // Report titles are guaranteed to be unique within a review
Show( JMPClinicalReviewAPI:getReportTitle( 1 ) ); // Report indicies are guaranteed to be unique within a review 
Show( JMPClinicalReviewAPI:getReportName( . ) ); // The currently selected report tab is guaranteed to be unique within a review
JMPClinicalReviewAPI:resetReport( . );
JMPClinicalReviewAPI:renameReport( ., . );
JMPClinicalReviewAPI:addReport(
    "FindingsBoxPlots",
    "Customized Findings Box Plots",
    [=> ]
);
Show( JMPClinicalReviewAPI:getReportColumnSwitcherSelection( ., 1 ) );
JMPClinicalReviewAPI
:changeReportColumnSwitcherSelection( ., 1, "Calcium (mmol/L)" );
JMPClinicalReviewAPI:changeReport( ., ., . );
JMPClinicalReviewAPI:deleteReport( . );
JMPClinicalReviewAPI:deleteReport( . );
JMPClinicalReviewAPI:addReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI
:changeReportFilterSelection(
    .,
    ":Overall Percent Occurrence >= 10 & :Overall Percent Occurrence <= 50"
);
JMPClinicalReviewAPI
:changeReportFilterSelection(
    ., ":\!"Toxicity Grade/Severity\!"n == {\!"MODERATE\!"}"
);
JMPClinicalReviewAPI
:changeReportFilterSelection( ., ":Serious Event == {\!"N\!"}" );
Show( JMPClinicalReviewAPI:getReportFilterSelection( . ) );
Current Data Table() << SelectWhere( :Serious Event == "Y" );
Wait( 0 );
JMPClinicalReviewAPI:applyReportSubjectSelectionToReviewSubjectFilter( . );
JMPClinicalReviewAPI:moveReport(
    "DemographicsDistribution", "AdverseEventsDistribution"
);
JMPClinicalReviewAPI:moveReport( 2, 1 );
JMPClinicalReviewAPI:duplicateReport( 1 );
JMPClinicalReviewAPI:selectReport( "DemographicsDistribution" );
JMPClinicalReviewAPI:createStaticReportForReport( . );
JMPClinicalReviewAPI:createLiveReportForReport( ., [=> ] );
JMPClinicalReviewAPI:selectReport( 1 );
JMPClinicalReviewAPI:showReportTables( . );
JMPClinicalReviewAPI:changeReviewSubjectFilter( "My Saved Filter Name" ); // Change the review subject filter to a saved one (by name)
JMPClinicalReviewAPI
:changeReviewSubjectFilter( // Change the review subject filter to this definition
    "Current Data Table() << Data Filter(Title( \!"Review Subject Filter\!" ),
    Conditional, Mode( Select( 0 ), Show( 1 ), Include( 1 ) ),
    Add Filter(columns(:Age, :Sex, :Race, :Unique Subject Identifier)))"
);
JMPClinicalReviewAPI:changeReviewSubjectFilter( . ); // Reset the review subject filter
JMPClinicalReviewAPI
:changeReviewSubjectFilterSelection( ":Sex == {\!"F\!"}" );
Show( JMPClinicalReviewAPI:getReviewSubjectFilterSelection() );
JMPClinicalReviewAPI:saveReviewTemplate( "ReviewManagementExamples", 1 );
JMPClinicalReviewAPI:resetAllReports();
JMPClinicalReviewAPI:deleteAllReports();
JMPClinicalReviewAPI:closeReviewBuilder();

// Use an existing review template
JMPClinicalReviewAPI:openReviewTemplate(
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\ReviewTemplates\Medical Monitoring.jmpcrt",
    1, 0, 1, 0
);
If( !Directory Exists( "C:\JMPClinicalReviewManager" ),
    Create Directory( "C:\JMPClinicalReviewManager" )
);
If( Directory Exists( "C:\JMPClinicalReviewManager" ),
    JMPClinicalReviewAPI:createStaticReport(
        "PDF", 0, "C:\JMPClinicalReviewManager\APIReview.pdf", "SELECTED", 1,
        1
    )
);
JMPClinicalReviewAPI:createLiveReport(
    ["ConnectionName" => Empty(),
    "Space" => "_PERSONAL_",
    "Folder" => "",
    "PublishData" => 0,
    "PublishOptimization" => 1,
    "PublishNotes" => 0,
    "PatientProfilesPublishPopulation" => "SELECTED",
    "PatientProfilesPublishGraphs" => 1,
    "PatientProfilesPublishTables" => 1]
);
JMPClinicalReviewAPI:closeReviewBuilder();
exitJMPClinicalBatch();
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

#### [Simple](#simple_2)

```

JMPClinicalReviewAPI:openReviewTemplate(
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\ReviewTemplates\Medical Monitoring.jmpcrt",
    1, 0, 1, 0
);


```

### [JMPClinicalReviewAPI:renameReport](#jmpclinicalreviewapirenamereport)

**Syntax:** JMPClinicalReviewAPI:renameReport(reportID = ., reportUserCustomizedTitle = .)

**Description:** Renames a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\* reportUserCustomizedTitle => String: The new report title.

\* Specify numeric missing (.) to indicate the title is no longer customized by the user (to allow the report to be dynamically named).

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport(
    "AdverseEventsDistribution",
    .,
    ["objRefNS:stkcb" => "AESER"]
);
Wait( 1 );
JMPClinicalReviewAPI:renameReport(
    ., "Customized Adverse Events Distribution"
);
Wait( 1 );
JMPClinicalReviewAPI:renameReport( ., . );


```

### [JMPClinicalReviewAPI:resetAllReports](#jmpclinicalreviewapiresetallreports)

**Syntax:** JMPClinicalReviewAPI:resetAllReports()

**Description:** Resets option values in all report tabs in Review Builder

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport(
    "AdverseEventsDistribution",
    "Customized Adverse Events Distribution",
    ["objRefNS:stkcb" => "AESER"]
);
JMPClinicalReviewAPI:addReport( "FindingsBoxPlots" );
JMPClinicalReviewAPI
:changeReportColumnSwitcherSelection( ., 1, "Glucose (mmol/L)" );
Wait( 1 );
JMPClinicalReviewAPI:resetAllReports();


```

### [JMPClinicalReviewAPI:resetReport](#jmpclinicalreviewapiresetreport)

**Syntax:** JMPClinicalReviewAPI:resetReport(reportID = .)

**Description:** Resets option values in a report tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport(
    "AdverseEventsDistribution",
    "Customized Adverse Events Distribution",
    ["objRefNS:stkcb" => "AESER"]
);
Wait( 1 );
JMPClinicalReviewAPI:resetReport( . );


```

### [JMPClinicalReviewAPI:saveReviewTemplate](#jmpclinicalreviewapisavereviewtemplate)

**Syntax:** JMPClinicalReviewAPI:saveReviewTemplate(reviewTemplatePath = "", allowOverwrite = 0)

**Description:** Saves a review template

\*

\* reviewTemplatePath => String: The full path (including the filename) of the review template.

\* Specify a filename without a drive or folder to use the default review templates folder.

\* Specify "" to use the default path.

\* allowOverwrite => Integer: If the specified review template file already exists,

\* 1 allows overwrites, 0 prevents overwrites.

\*

\* return - a String: The path to the saved review template file (if successful), or "" (if unsuccessful).

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:saveReviewTemplate( "ScriptingIndexExample", 1 );


```

### [JMPClinicalReviewAPI:selectReport](#jmpclinicalreviewapiselectreport)

**Syntax:** JMPClinicalReviewAPI:selectReport(reportID = .)

**Description:** Makes the specified report tab the currently selected tab in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

r1 = JMPClinicalReviewAPI:getReportReference(
    JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" )
);
r2 = JMPClinicalReviewAPI:getReportReference(
    JMPClinicalReviewAPI:addReport( "DemographicsDistribution" )
);
Wait( 1 );
JMPClinicalReviewAPI:selectReport( r1 );


```

### [JMPClinicalReviewAPI:setCurrentStudy](#jmpclinicalreviewapisetcurrentstudy)

**Syntax:** JMPClinicalReviewAPI:setCurrentStudy(study)

**Description:** Sets the current study to the one specified.

\*

\* study - a string containing the name of the study to set as the current study,

\* or Empty() to set the current study to

\*

\* return - if the current study was succesfully set, 1; otherwise 0.

```

JMPClinicalReviewAPI:setCurrentStudy( "Nicardipine" );


```

### [JMPClinicalReviewAPI:showReportTables](#jmpclinicalreviewapishowreporttables)

**Syntax:** JMPClinicalReviewAPI:showReportTables(reportID = .)

**Description:** Shows (or hides if already shown) tables for the specified report in Review Builder

\*

\* reportID => Namespace, Numeric Missing, Integer, or String: The namespace, selected tab, tab index, report title, reference, or report name\* corresponding to a report.

\* Specify numeric missing (.) to refer to the currently selected report tab.

\* \*CAUTION: Although report titles are guaranteed to be unique within a review, report names are not. If using the

\* report name as the reportID and multiple copies of that report exist in a review, the FIRST match will be used.

\*

\* return - an Integer: 1 if successful, 0 if unsuccessful.

```

JMPClinicalReviewAPI:addReport( "AdverseEventsDistribution" );
JMPClinicalReviewAPI:showReportTables( . );


```

### [JMPClinicalStudyManagerAPI:addStudies](#jmpclinicalstudymanagerapiaddstudies)

**Syntax:** JMPClinicalStudyManagerAPI:addStudies(listOfAddStudyArgumentLists = {})

**Description:** Adds the studies to current configuration (use the JMPClinicalBatchConfiguration environment variable).

\*

\* listOfAddStudyArgumentLists - List - Each element of this list is a list corresponding to the arguments to pass to JMPClinicalStudyManagerAPI:addStudy().

\* See JMPClinicalStudyManagerAPI:addStudy() for more details.

\*

\* return - N/A

```

JMPClinicalStudyManagerAPI:addStudies(
    {{"Nicardipine",
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\Sample Data\Nicardipine\SDTM",
    {},
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\Sample Data\Nicardipine\ADaM",
    {}, 1}, {"NicardipineAbbr",
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\Sample Data\Nicardipine\SDTM",
    {}, "", {}, 1}}
);


```

### [JMPClinicalStudyManagerAPI:addStudy](#jmpclinicalstudymanagerapiaddstudy)

**Syntax:** JMPClinicalStudyManagerAPI:addStudy(studyName="", SDTMFolder="", selectedSDTMDomains = {}, ADaMFolder="", selectedADaMDomains = {}, makeCurrentStudy=1, testResultsLoadOnly = "STANDARD", partialDatesStartDateImputationMethod = "FIRST", partialDatesEndDateImputationMethod = "LAST", studyDayValueDerivation = "MISSING", studyDayAnchorDateForStudyDayCalculation = "TREATMENT_START")

**Description:** Adds the study to current configuration (use the JMPClinicalBatchConfiguration environment variable).

\*

\* studyName - String - name of the study

\* SDTMFolder - String - path to the SDTM data folder. Use "" if no SDTM data (at least one of SDTMFolder or ADaM must be specified)

\* selectedSDTMDomains - List - list of the selected domains for the SDTM folder. Use {} to take all possible domains

\* ADaMFolder - String - path to the ADaM data folder. Use "" if no ADaM data (at least one of SDTMFolder or ADaM must be specified)

\* selectedADaMDomains - List - list of the selected domains for the ADaM folder. Use {} to take all possible domains

\* makeCurrentStudy - Integer (0|1) - Use 1 to set the current study to studyName

\* testResultsLoadOnly - String ("STANDARD"|"ORIGINAL")

\* partialDatesStartDateImputationMethod - String ("FIRST"|"LAST")

\* partialDatesEndDateImputationMethod - String ("FIRST"|"LAST")

\* studyDayValueDerivation - String ("ALL"|"MISSING")

\* studyDayAnchorDateForStudyDayCalculation - String ("TREATMENT_START"|"REFERENCE_START")

\*

\*

\* return - N/A

#### [Batch](#batch_3)

```

/*
 * Use the following environment variables to control elements of the batch execution: 
 *
 * set JMPClinicalBatchMode=true                    options include: true, debug
 * set JMPClinicalBatchLogPath=%CD%\                the path where the log file should be written
 * set JMPClinicalBatchConfiguration=Default        the configuration to use. if not specified, the last configuration used interactively will be used 
 * set JMPClinicalBatchCurrentStudy=                the study to use for Review Builder operations (not used by the JMPClinicalStudyManagerAPI)
*/

exitJMPClinicalBatch = Function( {},
    {},
    Save Log(
        Get Environment Variable( "JMPClinicalBatchLogPath" ) ||
        "JMPClinicalBatchLog.log"
    );
    Exit();
);

JMPClinicalStudyManagerAPI:addStudy(
    "APIStudyName",
    Convert File Path( "$CLINICAL_HOME" || "/Sample Data/Nicardipine/SDTM" ),
    {},
    Convert File Path( "$CLINICAL_HOME" || "/Sample Data/Nicardipine/ADaM" ),
    {},
    1
);
exitJMPClinicalBatch();
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

#### [Simple](#simple_3)

```

JMPClinicalStudyManagerAPI:addStudy(
    "Nicardipine",
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\Sample Data\Nicardipine\SDTM",
    {},
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\Sample Data\Nicardipine\ADaM",
    {}, 1
);


```

### [JMPClinicalStudyManagerAPI:addValueOrderDomain](#jmpclinicalstudymanagerapiaddvalueorderdomain)

**Syntax:** JMPClinicalStudyManagerAPI:addValueOrderDomain(studies, domain}, {default local)

**Description:** Registers a domain with the custom value order and color system, for the given studies and domain.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain to add

\*

\* return - none

\*

\* CAUTION: Be sure that the domain name is valid. All custom domains registered with this function

\* will be unregistered the next time the study is refreshed or updated with a new snapshot.

```

JMPClinicalStudyManagerAPI:addValueOrderDomain( "Nicardipine", "ZZ" );
JMPClinicalStudyManagerAPI:getValueOrderDomains( "Nicardipine" );


```

### [JMPClinicalStudyManagerAPI:addValueOrderVariable](#jmpclinicalstudymanagerapiaddvalueordervariable)

**Syntax:** JMPClinicalStudyManagerAPI:addValueOrderVariable(studies, domain, variable, values = {})

**Description:** Registers a variable with the custom value order and color system, for the given studies and domain.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable to add

\* values (optional) - list - names of the values to add

\*

\* return - none

\*

\* CAUTION: Be sure that the domain name, its variables, and its values are all valid. All

\* custom domains, variables, and values registered with this function will be unregistered

\* the next time the study is refreshed or updated with a new snapshot.

```

JMPClinicalStudyManagerAPI
:addValueOrderVariable(
    "Nicardipine",
    "ZZ",
    "ZZVAR",
    {"ZZ VALUE 1", "ZZ VALUE 2"}
);
JMPClinicalStudyManagerAPI
:getValueOrderDomainVariables( "Nicardipine", "ZZ" );


```

### [JMPClinicalStudyManagerAPI:applyAllTreatmentValueOrder](#jmpclinicalstudymanagerapiapplyalltreatmentvalueorder)

**Syntax:** JMPClinicalStudyManagerAPI:applyAllTreatmentValueOrder(studies, domain, variable, applyOrder = 0, applyColor = 1)

**Description:** Copies the value order preferences from one treatment variable to all, in variables registered by the custom value order and color system.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain from which to copy from

\* variable - String - name of the variable from which to copy from

\* applyOrder - integer - specifies (0) do not copy order preferences, (1) copy order preferences

\* applyColor - integer - specifies (0) do not copy color preferences, (1) copy color preferences

\*

\* return - none

```

JMPClinicalStudyManagerAPI
:applyAllTreatmentValueOrder( "Nicardipine", "ADSL", "ARM", 1, 1 );
Show(
    JMPClinicalStudyManagerAPI
    :getValueOrderVariableLegendPreview( "Nicardipine", "ADSL", "ARM", 2 ),
    JMPClinicalStudyManagerAPI
    :getValueOrderVariableLegendPreview(
        "Nicardipine", "ADSL", "TRT01P", 2
    )
);


```

### [JMPClinicalStudyManagerAPI:deleteStudies](#jmpclinicalstudymanagerapideletestudies)

**Syntax:** JMPClinicalStudyManagerAPI:deleteStudies(studyNames, keepOnDelete="PREF"}, {default local)

**Description:** Deletes the studies from the current configuration (use the JMPClinicalBatchConfiguration environment variable).

\*

\* studyNames - String, or List of Strings - name of the study, or names of the studies, to delete

\* keepOnDelete - String - "PREF" (default) honor the preference for keeping notes even after delete, "NO" override the preference and do not keep notes, "YES" override the preference and keep notes

\*

\* return - N/A

#### [Batch](#batch_4)

```

/*
 * Use the following environment variables to control elements of the batch execution 
 * set JMPClinicalBatchMode=true                    options include: true, debug
 * set JMPClinicalBatchLogPath=%CD%\                the path where the log file should be written
 * set JMPClinicalBatchConfiguration=Default        the configuration to use. if not specified, the last configuration used interactively will be used 
 * set JMPClinicalBatchCurrentStudy=                the study to use for Review Builder operations (not used by the JMPClinicalStudyManagerAPI)
*/

exitJMPClinicalBatch = Function( {},
    {},
    Save Log(
        Get Environment Variable( "JMPClinicalBatchLogPath" ) ||
        "JMPClinicalBatchLog.log"
    );
    Exit();
);

JMPClinicalStudyManagerAPI:deleteStudies( {"APIStudyName"} );
exitJMPClinicalBatch();
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

#### [Simple](#simple_4)

```

JMPClinicalStudyManagerAPI:deleteStudies( "Nicardipine" );


```

### [JMPClinicalStudyManagerAPI:deleteValueOrderDomain](#jmpclinicalstudymanagerapideletevalueorderdomain)

**Syntax:** JMPClinicalStudyManagerAPI:deleteValueOrderDomain(studies, domain}, {default local)

**Description:** Unregisters a domain with the custom value order and color system, for the given studies and domain.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain to delete

\*

\* return - none

\*

\* CAUTION: Be sure that the domain name is valid. All factory domains unregistered with this

\* function will be registered the next time the study is refreshed or updated with a new

\* snapshot.

```

JMPClinicalStudyManagerAPI:deleteValueOrderDomain( "Nicardipine", "ZZ" );
JMPClinicalStudyManagerAPI:getValueOrderDomains( "Nicardipine" );


```

### [JMPClinicalStudyManagerAPI:deleteValueOrderVariable](#jmpclinicalstudymanagerapideletevalueordervariable)

**Syntax:** JMPClinicalStudyManagerAPI:deleteValueOrderVariable(studies, domain, variable, values = {})

**Description:** Unregisters a variable with the custom value order and color system, for the given studies and domain.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable to delete

\* values (optional) - list - names of the values to delete (if any values are specified, only these values (and not the variable) will be deleted)

\*

\* return - none

\*

\* CAUTION: Be sure that the domain name, its variables, and its values are all valid. All

\* factory domains, variables, and values unregistered with this function will be registered

\* the next time the study is refreshed or updated with a new snapshot.

```

JMPClinicalStudyManagerAPI
:deleteValueOrderVariable( "Nicardipine", "ZZ", "ZZVAR" );
JMPClinicalStudyManagerAPI
:getValueOrderDomainVariables( "Nicardipine", "ZZ" );


```

### [JMPClinicalStudyManagerAPI:getADaMFolder](#jmpclinicalstudymanagerapigetadamfolder)

**Syntax:** JMPClinicalStudyManagerAPI:getADaMFolder(study)

**Description:** Returns the path of the ADaM folder for the given study.

\*

\* study - String - name of the study

\*

\* return - a String of the path for the ADaM folder

```

JMPClinicalStudyManagerAPI:getADaMFolder(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getAllStudyPreferences](#jmpclinicalstudymanagerapigetallstudypreferences)

**Syntax:** JMPClinicalStudyManagerAPI:getAllStudyPreferences(study)

**Description:** Returns all study preferences for the given study.

\*

\* study - String - name of the study

\*

\* return - an associative arrays of all preferences for the given study

```

JMPClinicalStudyManagerAPI
:getAllStudyPreferences( JMPClinicalStudyManagerAPI:getCurrentStudy() );


```

### [JMPClinicalStudyManagerAPI:getCreatedBy](#jmpclinicalstudymanagerapigetcreatedby)

**Syntax:** JMPClinicalStudyManagerAPI:getCreatedBy(study)

**Description:** Returns the userid that created the given study.

\*

\* study - String - name of the study

\*

\* return - a String of the userid that added the study

```

JMPClinicalStudyManagerAPI:getCreatedBy(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getCurrentStudy](#jmpclinicalstudymanagerapigetcurrentstudy)

**Syntax:** JMPClinicalStudyManagerAPI:getCurrentStudy()

**Description:** Returns the name of the current study.

\*

\* return - if there is a current study, the study name (a string); otherwise Empty().

```

JMPClinicalStudyManagerAPI:getCurrentStudy();


```

### [JMPClinicalStudyManagerAPI:getDomainList](#jmpclinicalstudymanagerapigetdomainlist)

**Syntax:** JMPClinicalStudyManagerAPI:getDomainList(study)

**Description:** Returns the list of domains for the given study.

\*

\* study - String - name of the study

\*

\* return - a list of Strings of the domains

```

JMPClinicalStudyManagerAPI:getDomainList(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getInitialDate](#jmpclinicalstudymanagerapigetinitialdate)

**Syntax:** JMPClinicalStudyManagerAPI:getInitialDate(study)

**Description:** Returns the numeric date the given study was added.

\*

\* study - String - name of the study

\*

\* return - a Number (date). Use asDate(...) to get date representation

```

As Date(
    JMPClinicalStudyManagerAPI:getInitialDate(
        JMPClinicalStudyManagerAPI:getCurrentStudy()
    )
);


```

### [JMPClinicalStudyManagerAPI:getLastUpdatedBy](#jmpclinicalstudymanagerapigetlastupdatedby)

**Syntax:** JMPClinicalStudyManagerAPI:getLastUpdatedBy(study)

**Description:** Returns the userid that last updated the given study.

\*

\* study - String - name of the study

\*

\* return - a String of the userid that lasy updated the study

```

JMPClinicalStudyManagerAPI:getLastUpdatedBy(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getLastUpdatedDate](#jmpclinicalstudymanagerapigetlastupdateddate)

**Syntax:** JMPClinicalStudyManagerAPI:getLastUpdatedDate(study)

**Description:** Returns the numeric date the given study was last modified.

\*

\* study - String - name of the study

\*

\* return - a Number (date). Use asDate(...) to get date representation

```

As Date(
    JMPClinicalStudyManagerAPI
    :getLastUpdatedDate( JMPClinicalStudyManagerAPI:getCurrentStudy() )
);


```

### [JMPClinicalStudyManagerAPI:getPartialDatesEndDateImputationMethod](#jmpclinicalstudymanagerapigetpartialdatesenddateimputationmethod)

**Syntax:** JMPClinicalStudyManagerAPI:getPartialDatesEndDateImputationMethod(study)

**Description:** Returns the advanced option.

\*

\* study - String - name of the study

\*

\* return - a String of the advanced option

```

JMPClinicalStudyManagerAPI
:getPartialDatesEndDateImputationMethod(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getPartialDatesStartDateImputationMethod](#jmpclinicalstudymanagerapigetpartialdatesstartdateimputationmethod)

**Syntax:** JMPClinicalStudyManagerAPI:getPartialDatesStartDateImputationMethod(study)

**Description:** Returns the advanced option.

\*

\* study - String - name of the study

\*

\* return - a String of the advanced option

```

JMPClinicalStudyManagerAPI
:getPartialDatesStartDateImputationMethod(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getSDTMFolder](#jmpclinicalstudymanagerapigetsdtmfolder)

**Syntax:** JMPClinicalStudyManagerAPI:getSDTMFolder(study)

**Description:** Returns the path of the SDTM folder for the given study.

\*

\* study - String - name of the study

\*

\* return - a String of the path for the SDTM folder

```

JMPClinicalStudyManagerAPI:getSDTMFolder(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getSelectedADaMDomains](#jmpclinicalstudymanagerapigetselectedadamdomains)

**Syntax:** JMPClinicalStudyManagerAPI:getSelectedADaMDomains(study)

**Description:** Returns the list of selected ADaM domains for the given study.

\*

\* study - String - name of the study

\*

\* return - a List of the selected domains for the ADaM folder

```

JMPClinicalStudyManagerAPI
:getSelectedADaMDomains( JMPClinicalStudyManagerAPI:getCurrentStudy() );


```

### [JMPClinicalStudyManagerAPI:getSelectedSDTMDomains](#jmpclinicalstudymanagerapigetselectedsdtmdomains)

**Syntax:** JMPClinicalStudyManagerAPI:getSelectedSDTMDomains(study)

**Description:** Returns the list of selected SDTM domains for the given study.

\*

\* study - String - name of the study

\*

\* return - a List of the selected domains for the SDTM folder

```

JMPClinicalStudyManagerAPI
:getSelectedSDTMDomains( JMPClinicalStudyManagerAPI:getCurrentStudy() );


```

### [JMPClinicalStudyManagerAPI:getSizeOnDisk](#jmpclinicalstudymanagerapigetsizeondisk)

**Syntax:** JMPClinicalStudyManagerAPI:getSizeOnDisk(study)

**Description:** Returns the number of MB on disk for all domains registered for the given study.

\*

\* study - String - name of the study

\*

\* return - a number that is the number of MB used by the data files on disk for the given study

```

JMPClinicalStudyManagerAPI:getSizeOnDisk(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getSnapshotNumber](#jmpclinicalstudymanagerapigetsnapshotnumber)

**Syntax:** JMPClinicalStudyManagerAPI:getSnapshotNumber(study)

**Description:** Returns number for the snapshot of the given study.

\*

\* study - String - name of the study

\*

\* return - a number of the snapshot. If snapshots aren't enabled, 0 is returned.

```

JMPClinicalStudyManagerAPI:getSnapshotNumber(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getStudyDayAnchorDateForStudyDayCalculation](#jmpclinicalstudymanagerapigetstudydayanchordateforstudydaycalculation)

**Syntax:** JMPClinicalStudyManagerAPI:getStudyDayAnchorDateForStudyDayCalculation(study)

**Description:** Returns the advanced option.

\*

\* study - String - name of the study

\*

\* return - a String of the advanced option

```

JMPClinicalStudyManagerAPI
:getStudyDayAnchorDateForStudyDayCalculation(
    JMPClinicalStudyManagerAPI:getCurrentStudy()
);


```

### [JMPClinicalStudyManagerAPI:getStudyDayValueDerivation](#jmpclinicalstudymanagerapigetstudydayvaluederivation)

**Syntax:** JMPClinicalStudyManagerAPI:getStudyDayValueDerivation(study)

**Description:** Returns the advanced option.

\*

\* study - String - name of the study

\*

\* return - a String of the advanced option

```

JMPClinicalStudyManagerAPI
:getStudyDayValueDerivation( JMPClinicalStudyManagerAPI:getCurrentStudy() );


```

### [JMPClinicalStudyManagerAPI:getStudyExists](#jmpclinicalstudymanagerapigetstudyexists)

**Syntax:** JMPClinicalStudyManagerAPI:getStudyExists(study)

**Description:** Returns >=1 if study exists, 0 otherwise.

\*

\* study - String - name of the study

\*

\* return - an integer

```

JMPClinicalStudyManagerAPI:getStudyExists( "Nicardipine" );


```

### [JMPClinicalStudyManagerAPI:getStudyList](#jmpclinicalstudymanagerapigetstudylist)

**Syntax:** JMPClinicalStudyManagerAPI:getStudyList()

**Description:** Gets the list of studies for the current configuration (use the JMPClinicalBatchConfiguration environment variable)

\*

\* return - a List of the names of the studies

```

JMPClinicalStudyManagerAPI:getStudyList();


```

### [JMPClinicalStudyManagerAPI:getStudyPreference](#jmpclinicalstudymanagerapigetstudypreference)

**Syntax:** JMPClinicalStudyManagerAPI:getStudyPreference(study, preference)

**Description:** Returns the given study preference for the given study.

\*

\* study - String - name of the study

\* preference - String - name of the preference

\*

\* return - a of the given preference for the given study

```

JMPClinicalStudyManagerAPI:getStudyPreference(
    "Nicardipine", "objRefNS:treatcb"
);


```

### [JMPClinicalStudyManagerAPI:getTestResultsLoadOnly](#jmpclinicalstudymanagerapigettestresultsloadonly)

**Syntax:** JMPClinicalStudyManagerAPI:getTestResultsLoadOnly(study)

**Description:** Returns the advanced option.

\*

\* study - String - name of the study

\*

\* return - a String of the advanced option

```

JMPClinicalStudyManagerAPI
:getTestResultsLoadOnly( JMPClinicalStudyManagerAPI:getCurrentStudy() );


```

### [JMPClinicalStudyManagerAPI:getValueOrderDomainLabel](#jmpclinicalstudymanagerapigetvalueorderdomainlabel)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderDomainLabel(study, domain)

**Description:** Returns the domain label registered by the custom value order and color system, for the given study and domain.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\*

\* return - a String of the domain label

```

JMPClinicalStudyManagerAPI:getValueOrderDomainLabel( "Nicardipine", "LB" );


```

### [JMPClinicalStudyManagerAPI:getValueOrderDomainVariables](#jmpclinicalstudymanagerapigetvalueorderdomainvariables)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderDomainVariables(study, domain)

**Description:** Returns the list of variables registered by the custom value order and color system, for the given study and domain.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\*

\* return - a list of variables

```

JMPClinicalStudyManagerAPI
:getValueOrderDomainVariables( "Nicardipine", "LB" );


```

### [JMPClinicalStudyManagerAPI:getValueOrderDomains](#jmpclinicalstudymanagerapigetvalueorderdomains)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderDomains(study)

**Description:** Returns the list of domains registered by the custom value order and color system, for the given study.

\*

\* study - String - name of the study

\*

\* return - a list of domains

```

JMPClinicalStudyManagerAPI:getValueOrderDomains( "Nicardipine" );


```

### [JMPClinicalStudyManagerAPI:getValueOrderValueColorOverride](#jmpclinicalstudymanagerapigetvalueordervaluecoloroverride)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderValueColorOverride(study, domain, variable, value, returnRGB = 0)

**Description:** Returns any value color override of the value of the variable registered by the custom value order and color system, for the given study, domain, variable, and value.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\* value - String - name of the value

\* returnRGB - integer - if 0 (default), returns JMP internal color value (integer); if 1, returns RGB ({red, green, blue}) color values (three numbers) in the 0-to-1 range; if 2, returns RGB in the 0-to-255 range

\*

\* return - a number of the color override for the value (if an override does not exist for the value, missing (.) is returned)

```

JMPClinicalStudyManagerAPI
:getValueOrderValueColorOverride(
    "Nicardipine", "ADSL", "TRT01P", "Placebo", 2
);


```

### [JMPClinicalStudyManagerAPI:getValueOrderVariableColorOverrides](#jmpclinicalstudymanagerapigetvalueordervariablecoloroverrides)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderVariableColorOverrides(study, domain, variable, returnRGB = 0)

**Description:** Returns the value color overrides of the variable registered by the custom value order and color system, for the given study, domain, and variable.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\* returnRGB - integer - if 0 (default), returns JMP internal color values (single integers); if 1, returns RGB ({red, green, blue}) color values (three numbers) in the 0-to-1 range; if 2, returns RGB in the 0-to-255 range

\*

\* return - an associative array (variable value (String), color (number)) of the color overrides

```

JMPClinicalStudyManagerAPI
:getValueOrderVariableColorOverrides( "Nicardipine", "ADSL", "TRT01P", 2 );


```

### [JMPClinicalStudyManagerAPI:getValueOrderVariableColorTheme](#jmpclinicalstudymanagerapigetvalueordervariablecolortheme)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderVariableColorTheme(study, domain, variable)

**Description:** Returns the value color theme of the variable registered by the custom value order and color system, for the given study, domain, and variable.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\*

\* return - a String of the color theme name

```

JMPClinicalStudyManagerAPI
:getValueOrderVariableColorTheme( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:getValueOrderVariableLabel](#jmpclinicalstudymanagerapigetvalueordervariablelabel)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderVariableLabel(study, domain, variable)

**Description:** Returns the variable label registered by the custom value order and color system, for the given study, domain, and variable.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\*

\* return - a String of the variable label

```

JMPClinicalStudyManagerAPI
:getValueOrderVariableLabel( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:getValueOrderVariableLegendPreview](#jmpclinicalstudymanagerapigetvalueordervariablelegendpreview)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderVariableLegendPreview(study, domain, variable, returnRGB = 0)

**Description:** Returns the value order and colors of the variable registered by the custom value order and color system, for the given study, domain, and variable.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\* returnRGB - integer - if 0 (default), returns JMP internal color value (integer); if 1, returns RGB ({red, green, blue}) color values (three numbers) in the 0-to-1 range; if 2, returns RGB in the 0-to-255 range

\*

\* return - an ordered list (according to value order) of associative arrays specifying color (variable value (String), color (number))

```

JMPClinicalStudyManagerAPI
:getValueOrderVariableLegendPreview( "Nicardipine", "LB", "JMPC_ANRIND", 2 );


```

### [JMPClinicalStudyManagerAPI:getValueOrderVariableSortState](#jmpclinicalstudymanagerapigetvalueordervariablesortstate)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderVariableSortState(study, domain, variable)

**Description:** Returns the sort state of value order of the variable registered by the custom value order and color system, for the given study, domain, and variable.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\*

\* return - a String of the value order sort state

```

JMPClinicalStudyManagerAPI
:getValueOrderVariableSortState( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:getValueOrderVariableValueOrder](#jmpclinicalstudymanagerapigetvalueordervariablevalueorder)

**Syntax:** JMPClinicalStudyManagerAPI:getValueOrderVariableValueOrder(study, domain, variable)

**Description:** Returns the value order of the variable registered by the custom value order and color system, for the given study, domain, and variable.

\*

\* study - String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\*

\* return - a list of the value order

```

JMPClinicalStudyManagerAPI
:getValueOrderVariableValueOrder( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:loadStudyADSLDataTable](#jmpclinicalstudymanagerapiloadstudyadsldatatable)

**Syntax:** JMPClinicalStudyManagerAPI:loadStudyADSLDataTable(study)

**Description:** Loads the ADSL table into memory.

\*

\* study - String - name of the study

\*

\* return - Table Reference - data table reference for the ADSL table for the study

\*

\* throws - exception if study specified doesn't exist

```

JMPClinicalStudyManagerAPI
:loadStudyADSLDataTable( JMPClinicalStudyManagerAPI:getCurrentStudy() );


```

### [JMPClinicalStudyManagerAPI:refreshStudies](#jmpclinicalstudymanagerapirefreshstudies)

**Syntax:** JMPClinicalStudyManagerAPI:refreshStudies(studyNames = {})

**Description:** Refreshes the metadata of the studies in the current configuration (use the JMPClinicalBatchConfiguration environment variable).

\*

\* studyNames - String, or List of Strings - name of the study, or names of the studies, to refresh

\*

\* return - N/A

#### [Batch](#batch_5)

```

/*
 * Use the following environment variables to control elements of the batch execution 
 * set JMPClinicalBatchMode=true                    options include: true, debug
 * set JMPClinicalBatchLogPath=%CD%\                the path where the log file should be written
 * set JMPClinicalBatchConfiguration=Default        the configuration to use. if not specified, the last configuration used interactively will be used 
 * set JMPClinicalBatchCurrentStudy=                the study to use for Review Builder operations (not used by the JMPClinicalStudyManagerAPI)
*/

exitJMPClinicalBatch = Function( {},
    {},
    Save Log(
        Get Environment Variable( "JMPClinicalBatchLogPath" ) ||
        "JMPClinicalBatchLog.log"
    );
    Exit();
);

JMPClinicalStudyManagerAPI:refreshStudies( {"APIStudyName"} );
exitJMPClinicalBatch();
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

#### [Simple](#simple_5)

```

JMPClinicalStudyManagerAPI:refreshStudies( {"Nicardipine"} );


```

### [JMPClinicalStudyManagerAPI:resetAllValueOrderInfo](#jmpclinicalstudymanagerapiresetallvalueorderinfo)

**Syntax:** JMPClinicalStudyManagerAPI:resetAllValueOrderInfo(studies)

**Description:** Resets all information in the custom value order and color system, for the given studies.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\*

\* return - none

\*

\* CAUTION: All custom value order and color settings for the specified studies will be reset

\* to factory defaults.

```

JMPClinicalStudyManagerAPI:resetAllValueOrderInfo( "Nicardipine" );


```

### [JMPClinicalStudyManagerAPI:setAllStudyPreferences](#jmpclinicalstudymanagerapisetallstudypreferences)

**Syntax:** JMPClinicalStudyManagerAPI:setAllStudyPreferences(study, preferenceValueAssociation)

**Description:** Sets all preferences for the given study.

\*

\* study - String - name of the study

\* preferenceValueAssociation - Associative Array - names and values of preferences

\*

\* return - N/A

```

studyPreferences = JMPClinicalStudyManagerAPI
:getAllStudyPreferences( "Nicardipine" );
JMPClinicalStudyManagerAPI
:setAllStudyPreferences( "Nicardipine", studyPreferences );


```

### [JMPClinicalStudyManagerAPI:setCurrentStudy](#jmpclinicalstudymanagerapisetcurrentstudy)

**Syntax:** JMPClinicalStudyManagerAPI:setCurrentStudy(study)

**Description:** Sets the current study to the one specified.

\*

\* study - a string containing the name of the study to set as the current study,

\* or Empty() to set the current study to

\*

\* return - if the current study was succesfully set, 1; otherwise 0.

```

JMPClinicalStudyManagerAPI:setCurrentStudy( "Nicardipine" );
JMPClinicalStudyManagerAPI:getCurrentStudy();


```

### [JMPClinicalStudyManagerAPI:setStudyPreference](#jmpclinicalstudymanagerapisetstudypreference)

**Syntax:** JMPClinicalStudyManagerAPI:setStudyPreference(study, preference, value)

**Description:** Sets the given study preference to the given value for the given study.

\*

\* study - String - name of the study

\* preference - String - name of the preference

\* value - - value of the preference

\*

\* return - N/A

```

JMPClinicalStudyManagerAPI:setStudyPreference(
    "Nicardipine", "objRefNS:treatcb", "ARM"
);
JMPClinicalStudyManagerAPI:getStudyPreference(
    "Nicardipine", "objRefNS:treatcb"
);


```

### [JMPClinicalStudyManagerAPI:setValueOrderDomainLabel](#jmpclinicalstudymanagerapisetvalueorderdomainlabel)

**Syntax:** JMPClinicalStudyManagerAPI:setValueOrderDomainLabel(studies, domain, newDomainLabel)

**Description:** Sets the domain label registered by the custom value order and color system, for the given studies and domain.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain

\* newDomainLabel - String - new label of the domain

\*

\* return - none

\*

\* CAUTION: This function should only be used when registering custom domains to the value

\* order and color system. Be sure that the domain name is valid and the new domain label

\* is correct.

```

JMPClinicalStudyManagerAPI
:setValueOrderDomainLabel( "Nicardipine", "LB", "Labs" );
JMPClinicalStudyManagerAPI:getValueOrderDomainLabel( "Nicardipine", "LB" );


```

### [JMPClinicalStudyManagerAPI:setValueOrderValueColorOverride](#jmpclinicalstudymanagerapisetvalueordervaluecoloroverride)

**Syntax:** JMPClinicalStudyManagerAPI:setValueOrderValueColorOverride(studies, domain, variable, value, override)

**Description:** Sets the value color override of the value of the variable registered by the custom value order and color system, for the given studies, domain, variable, and value.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\* value - String - name of the value

\* override - number - the color value of the specified level value (either internal value (integer) or RGB (list of three numbers) or color name (String))

\* return - none

```

JMPClinicalStudyManagerAPI
:setValueOrderValueColorOverride(
    "Nicardipine",
    "ADSL",
    "TRT01P",
    "Placebo",
    {200, 0, 0}
);
JMPClinicalStudyManagerAPI
:getValueOrderValueColorOverride(
    "Nicardipine", "ADSL", "TRT01P", "Placebo", 2
);


```

### [JMPClinicalStudyManagerAPI:setValueOrderVariableColorOverrides](#jmpclinicalstudymanagerapisetvalueordervariablecoloroverrides)

**Syntax:** JMPClinicalStudyManagerAPI:setValueOrderVariableColorOverrides(studies, domain, variable, overrides)

**Description:** Sets the value color overrides of the variable registered by the custom value order and color system, for the given studies, domain, and variable.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain -OR- "*All*" to specify all domains and variables in each specified study

\* variable - String - name of the variable (ignored if domain argument = 1)

\* overrides - associative array - level names (keys) and color values (values) of the level color overrides (either internal values (integer) or RGB (list of three numbers) or color name (String)) -OR- String specifying a special action: "*Clear*" clear (no overrides), "*Reset*" reset to default, "*All*" mark all existing level colors as overrides

\*

\* return - none

```

JMPClinicalStudyManagerAPI
:setValueOrderVariableColorOverrides(
    "Nicardipine",
    "ADSL",
    "TRT01P",
    ["Placebo" => {200, 0, 0}]
);
JMPClinicalStudyManagerAPI
:getValueOrderVariableColorOverrides( "Nicardipine", "ADSL", "TRT01P", 2 );


```

### [JMPClinicalStudyManagerAPI:setValueOrderVariableColorTheme](#jmpclinicalstudymanagerapisetvalueordervariablecolortheme)

**Syntax:** JMPClinicalStudyManagerAPI:setValueOrderVariableColorTheme(studies, domain, variable, theme)

**Description:** Sets the value color theme of the variable registered by the custom value order and color system, for the given studies, domain, and variable.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain -OR- "*All*" to specify all domains and variables in each specified study

\* variable - String - name of the variable (ignored if domain argument = "*All*")

\* theme - String - name of the color theme -OR- a special action: "*Reset*": reset to default

\*

\* return - none

```

JMPClinicalStudyManagerAPI
:setValueOrderVariableColorTheme(
    "Nicardipine", "LB", "JMPC_ANRIND", "JMP Dark"
);
JMPClinicalStudyManagerAPI
:getValueOrderVariableColorTheme( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:setValueOrderVariableLabel](#jmpclinicalstudymanagerapisetvalueordervariablelabel)

**Syntax:** JMPClinicalStudyManagerAPI:setValueOrderVariableLabel(studies, domain, variable, newVariableLabel)

**Description:** Sets the variable label registered by the custom value order and color system, for the given studies domain, and variable.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\* newVariableLabel - String - new label of the variable

\*

\* return - none

\*

\* CAUTION: This function should only be used when registering custom domains and variables

\* to the value order and color system. Be sure that the domain and variable names are valid

\* and the new variable label is correct.

```

JMPClinicalStudyManagerAPI
:setValueOrderVariableLabel(
    "Nicardipine", "LB", "JMPC_ANRIND", "Indicator for Reference Range"
);
JMPClinicalStudyManagerAPI
:getValueOrderVariableLabel( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:setValueOrderVariableSortState](#jmpclinicalstudymanagerapisetvalueordervariablesortstate)

**Syntax:** JMPClinicalStudyManagerAPI:setValueOrderVariableSortState(studies, domain, variable, sortstate)

**Description:** Sets the sort state of value order of the variable registered by the custom value order and color system, for the given studies, domain, and variable.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain -OR- "*All*" to specify all domains and variables in each specified study

\* variable - String - name of the variable (ignored if domain argument = 1)

\* sortstate - String - name of the value order sort state -OR- a special action: "*Reset*" reset to default

\* return - none

\* side effect - also sorts the level values accordingly

```

JMPClinicalStudyManagerAPI
:setValueOrderVariableSortState(
    "Nicardipine", "LB", "JMPC_ANRIND", "Natural Descending"
);
JMPClinicalStudyManagerAPI
:getValueOrderVariableSortState( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:setValueOrderVariableValueOrder](#jmpclinicalstudymanagerapisetvalueordervariablevalueorder)

**Syntax:** JMPClinicalStudyManagerAPI:setValueOrderVariableValueOrder(studies, domain, variable, valueorder)

**Description:** Sets the value order of the variable registered by the custom value order and color system, for the given studies, domain, and variable.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\* valueorder - list - level names of the variable in any specified order (all levels must be present and must match case exactly)

\* return - none

\* side effect - also sets the sort state to "Ad Hoc"

```

JMPClinicalStudyManagerAPI
:setValueOrderVariableValueOrder(
    "Nicardipine",
    "LB",
    "JMPC_ANRIND",
    {"HIGH", "NORMAL", "LOW"}
);
JMPClinicalStudyManagerAPI
:getValueOrderVariableValueOrder( "Nicardipine", "LB", "JMPC_ANRIND" );


```

### [JMPClinicalStudyManagerAPI:swapValueColor](#jmpclinicalstudymanagerapiswapvaluecolor)

**Syntax:** JMPClinicalStudyManagerAPI:swapValueColor(studies, domain, variable, value1, value2)

**Description:** Swaps the value color of two levels within a variable registered by the custom value order and color system, for the given studies, domain, and variable.

\*

\* studies - list - names (Strings) of the studies -OR- String - name of the study

\* domain - String - name of the domain

\* variable - String - name of the variable

\* value1 - String - name of one value

\* value2 - String - name of another value

\*

\* return - none

```

JMPClinicalStudyManagerAPI:swapValueColor(
    "Nicardipine", "LB", "JMPC_ANRIND", "LOW", "HIGH"
);
JMPClinicalStudyManagerAPI
:getValueOrderVariableLegendPreview( "Nicardipine", "LB", "JMPC_ANRIND", 2 );


```

### [JMPClinicalStudyManagerAPI:updateSnapStudy](#jmpclinicalstudymanagerapiupdatesnapstudy)

**Syntax:** JMPClinicalStudyManagerAPI:updateSnapStudy(selectedStudy="", snapshotNumber=., newSdtmSourceDataFolder="", newSelectedSDTMDomains={}, newAdamSourceDataFolder="", newSelectedADaMDomains={}, cb_trt_val=1, cb_spid_val=1, cb_seq_val=1, cb_dom_val=1, cb_grp_val=1, cb_ref_val=1, cb_lnk_val=1, cb_lnkg_val=1)

**Description:** Update the snapshot of the study in the current configuration (use the JMPClinicalBatchConfiguration environment variable).

\*

\* selectedStudy - String - name of the study

\* snapshotNumber - integer - the new snapshot number

\* newSdtmSourceDataFolder - String - path to the new SDTM data folder. Use "" if no SDTM data (at least one of newSdtmSourceDataFolder or newAdamSourceDataFolder must be specified)

\* newSelectedSDTMDomains - List - list of the selected domains for the new SDTM folder. Use {} to take all possible domains

\* newAdamSourceDataFolder - String - path to the new ADaM data folder. Use "" if no ADaM data (at least one of newSdtmSourceDataFolder or newAdamSourceDataFolder must be specified)

\* newSelectedADaMDomains - List - list of the selected domains for the new ADaM folder. Use {} to take all possible domains

\* cb_trt_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Treatment Variables"

\* cb_spid_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Sponsor-Defined Identifier"

\* cb_seq_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Sequence Number"

\* cb_dom_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Domain"

\* cb_grp_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Group ID"

\* cb_ref_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Reference ID"

\* cb_lnk_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Link ID"

\* cb_lnkg_val - integer - the checkbox state (1 = checked, 0 = unchecked) of "Exclude comparisons of Link Group ID"

\*

\* return - N/A

#### [Batch](#batch_6)

```

/*
 * Use the following environment variables to control elements of the batch execution 
 * set JMPClinicalBatchMode=true                    options include: true, debug
 * set JMPClinicalBatchLogPath=%CD%\                the path where the log file should be written
 * set JMPClinicalBatchConfiguration=Default        the configuration to use. if not specified, the last configuration used interactively will be used 
 * set JMPClinicalBatchCurrentStudy=                the study to use for Review Builder operations (not used by the JMPClinicalStudyManagerAPI)
*/

exitJMPClinicalBatch = Function( {},
    {},
    Save Log(
        Get Environment Variable( "JMPClinicalBatchLogPath" ) ||
        "JMPClinicalBatchLog.log"
    );
    Exit();
);

JMPClinicalStudyManagerAPI:updateSnapStudy(
    "APIStudyName",
    JMPClinicalStudyManagerAPI:getSnapshotNumber( "APIStudyName" ) + 1,
    Convert File Path(
        "$CLINICAL_HOME" || "/Sample Data/NicardipineAbbr/SDTM"
    ),
    {},
    "",
    {}
);
exitJMPClinicalBatch();
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

#### [Simple](#simple_6)

```

JMPClinicalStudyManagerAPI:updateSnapStudy(
    "Nicardipine",
    JMPClinicalStudyManagerAPI:getSnapshotNumber( "Nicardipine" ) + 1,
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\Sample Data\Nicardipine\SDTM",
    {},
    "C:\ProgramData\JMP\JMPClinical\19\Clinical\Sample Data\Nicardipine\ADaM",
    {}, 1
);


```

### [jg:domain](#jgdomain)

**Syntax:** jg:domain( parent=empty(), \_name="", \_label="", \_origin={}, \_fileTypeOriginal="", \_fileTypeWorking="", \_model="", \_class="", \_creationDateOriginal=., \_creationDateWorking=., \_modificationDateOriginal=., \_modificationDateWorking=., \_fileSizeOriginal=., \_fileSizeWorking=., \_nTotalRows=0, \_flagsTrue={})

**Description:** Creates a new JMP Clinical domain object.

```

dom = jg:domain( Empty(), "dom", "Domain" );


```

### [jg:notebook](#jgnotebook)

**Syntax:** jg:notebook( parent=empty())

**Description:** Creates a new JMP Clinical notebook object.

```

notebook = jg:notebook( Empty() );


```

### [jg:study](#jgstudy)

**Syntax:** jg:study( \_name="", \_label="", \_origin={}, \_sdtmFolderOriginal="", \_selectedSdtmDomains={}, \_adamFolderOriginal="", \_selectedAdamDomains={}, \_snapshotNumber=0, \_initialDate=., \_createdBy="", \_lastUpdatedDate=., \_lastUpdatedBy="", \_releaseVersion="", \_testResultsLoadOnly="", \_partialDatesStartDateImputationMethod="", \_partialDatesEndDateImputationMethod="", \_studyDayValueDerivation="", \_studyDayAnchorDateForStudyDayCalculation="", \_flagsTrue={"saveJMPTables", "compressJMPTables", "compressJMPColumns", "clinical"})

**Description:** Creates a new JMP Clinical study object.

```

s = jg:study( "study" );


```

### [jg:variable](#jgvariable)

**Syntax:** jg:variable( parent=empty(), \_name="", \_label="", \_origin={}, \_type="", \_colmin=., \_colmax=., \_valuelist={}, \_key=0, \_class="", \_nMissingRows=0, \_flagsTrue={})

**Description:** Creates a new JMP Clinical variable object.

```

var = jg:variable( Empty(), "var", "Variable" );


```

### [processNS:runReport](#processnsrunreport)

**Syntax:** processNS:runReport()

**Description:** Comprises the statements to execute in a JMP Clinical custom report.

**CustomReportExample1**

```

// The header section for report title and category.
processNS:label = "Custom Report Example 1";
processNS:cdiscClass = "Custom Reports";

// The main report code.
processNS:runReport = Function( {},
    {Default Local}, 
    // Surfaces a built-in JMP platform on the current data table (tadsl) and opens in a new window.
    Graph Builder()
);
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

**CustomReportExample2**

```

// The header section for report title and category.
processNS:label = "Custom Report Example 2";
processNS:cdiscClass = "Custom Reports";

// The main report code.
processNS:runReport = Function( {},
    {Default Local}, 
    // Obtain the path to the study's ADSL data set.
    path = jg:getPath( "/user/clinical/data/adam", "ADSL.jmp" );
    If( !File Exists( path ), 
        // A custom error check.
        processNS:fatalError(
            "This report requires an ARM variable in the ADSL dataset.", 1
        )
    , 
        // Open the study's ADSL data set.
        objRefNS:dt = Open( path, invisible );
        // Send content to the output pane.
        processNS:setReportOutput(
            V List Box(
                // Create a Graph Builder object, hiding the control panel, using ARM as an X variable, displayed as a pie ring.
                objRefNS:gb = Graph Builder(
                    Show Control Panel( 0 ),
                    Variables( X( :ARM ) ),
                    Elements( Pie( X, Legend( 3 ), Pie Style( "Ring" ) ) )
                )
            )
        );
        // Keep track of data sets created in this report so that they are automatically closed when the report tab is closed.
        processNS:addDataTableReference(
            "Custom Report Example Data", "objRefNS:dt"
        );
    );
);

0;
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

**CustomReportExample3**

```

// The header section for report title, category, and icon.
processNS:label = "Custom Report Example 3";
processNS:cdiscClass = "Custom Reports";
processNS:icon =
"/install/clinical/documentation/icons/clinical/DonutGraph3d.gif";
processNS:description =
"This report creates a pie chart of values from the selected ADSL variable.";

// The main report code.
processNS:runReport = Function( {},
    {Default Local}, 
    // Including functions shared across reports.
    Include(
        Convert File Path(
            "$CLINICAL_HOME/JSLFiles/DataPrep.JSL",
            absolute,
            windows
        )
    );
    objRefNS:in_adsl = prepADSL();

    // Change JMP names to SAS Labels.
    jg:setColumnJMPNamesToSASLabels( objRefNS:in_adsl );

    // Linking an analysis data table to adsl. This allows the Review Subject Filter to filter the report.
    reportRefNS:linkAnalysisTableToADSLTable( objRefNS:in_adsl );

    // Apply value order and color preferences to an analysis data table.
    jg:ApplyValueOrderToTables(
        Eval List( {objRefNS:in_adsl} ),
        objRefNS:StudyName
    );

    // Retrieve the column names.
    objRefNS:columnNames = objRefNS:in_adsl << getColumnNames( "string" );

    // Send content to the output pane.
    processNS:setReportOutput(
        V List Box(
            // Create a Graph Builder object, hiding the control panel, using the first column in the
            //  data table as the initially selected column, displayed as a pie ring, offering a
            //  column switcher to choose from any column in the data table.
            objRefNS:gb = Graph Builder(
                Show Control Panel( 0 ),
                Variables( X( Eval( objRefNS:columnNames[1] ) ) ),
                Elements( Pie( X, Legend( 3 ), Pie Style( "Ring" ) ) ),
                Column Switcher(
                    Eval( objRefNS:columnNames[1] ),
                    Eval( objRefNS:columnNames )
                )
            )
        )
    );

    // Collapse empty Options panel.
    objRefNS:mainhlb << ClosePanel( 1 );

    // Keep track of data sets created in this report so that they are automatically closed when the report tab is closed.
    processNS:addDataTableReference(
        "Custom Report Example Data", "objRefNS:in_adsl"
    );

    // Send these objects to JMP Live.
    processNS:defineStaticReportContent( {objRefNS:gb} );

    // Send these objects to the static report.
    processNS:defineLiveReportContent( {{objRefNS:gb}} );
);

0;
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

**CustomReportExample4**

```

// The header section for report title, category, icon, and help.
processNS:label = "Custom Report Example 4";
processNS:labelSkeleton = "Custom Report with Variables {{^1}}, Example 4"; // For dynamically renaming the report with a substring. See the 'renameReport' examples.
processNS:reportSelectorTab = 1; // 1: Display on report selector; 0: Do not display on report selector.
processNS:drillDown = 0; // 1: This report can also be used as a drilldown; 0: This report cannot also be used as a drilldown.
processNS:cdiscClass = "Custom Reports";
processNS:icon =
"/install/clinical/documentation/icons/clinical/DistributionAnalysis.gif";
processNS:documentation = "https://www.jmp.com/";
processNS:description =
"This report demonstrates a basic requirements declaration, switches data table columns names to SAS Labels, "
 ||
"applies value order and color preferences, adds a drill down button, writes notes to the JMP log, checks for a custom error "
 ||
"condition, declares a function for use within a widget script, defines an assortment of custom widgets, creates a report filter, "
 ||
"tracks data tables so that they are automatically closed when the report is closed, and defines content to publish to Create Static "
 || "Report and Create Live Report.";

// Specify any variable requirements here. Those requirements not met will automatically prevent the report from running.
processNS:requirements = ["_ONE_OR_MORE_DEMOGRAPHICS_" => {{"ARM"}}];

// The main report code.
processNS:runReport = Function( {},
    {Default Local}, 
    // Including functions shared across reports.
    Include(
        Convert File Path(
            "$CLINICAL_HOME/JSLFiles/DataPrep.JSL",
            absolute,
            windows
        )
    );
    objRefNS:in_adsl = prepADSL();

    // Change JMP names to SAS Labels.
    jg:setColumnJMPNamesToSASLabels( objRefNS:in_adsl );

    // Linking an analysis data table to adsl. This allows the Review Subject Filter to filter the report.
    reportRefNS:linkAnalysisTableToADSLTable( objRefNS:in_adsl );

    // Apply value order and color preferences to an analysis data table.
    jg:ApplyValueOrderToTables(
        Eval List( {objRefNS:in_adsl} ),
        objRefNS:StudyName
    );

    // Add predefined drill downs to the report.
    processNS:addDrillDowns( {"ShowSubjects"} );

    // Working with requirements return. (Not necessary for this report.)
    processNS:note(
        "Datasets in _ONE_OR_MORE_DEMOGRAPHICS_: " ||
        Char(
            objRefNS:requirementsReturn["domains_wild"][
            "_ONE_OR_MORE_DEMOGRAPHICS_"]["present"]
        )
    );
    processNS:note(
        "Datasets passing requirements for _ONE_OR_MORE_DEMOGRAPHICS_: " ||
        Char(
            objRefNS:requirementsReturn["domains_wild"][
            "_ONE_OR_MORE_DEMOGRAPHICS_"]["pass"]
        )
    );
    domainsPass = objRefNS:requirementsReturn["domains_wild"][
    "_ONE_OR_MORE_DEMOGRAPHICS_"]["pass"];
    For( i = 1, i <= N Items( domainsPass ), i++,
        processNS:note(
            "Required chosen variables in " || domainsPass[i] || ": " ||
            Char(
                objRefNS:requirementsReturn["domains"][domainsPass[i]][
                "required_chosen"]
            )
        )
    );

    // A custom error check. (Not necessary for this report. Set to 1 to simulate an error.)
    If( 0,
        processNS:fatalError(
            "Cannot run this report because condition X was not met.", 1
        )
    );

    // Creating a function for use within this report only.
    objRefNS:createResults = Function( {cols = {}},
        {Default Local},
        distCode = "objRefNS:in_adsl << Distribution(";
        For( i = 1, i <= N Items( cols ), i++,
            If( i > 1, distCode ||= "," );
            distCode ||= Eval Insert(
                "\[
                Nominal Distribution(Column(:Name("^cols[i]^")))
            ]\"
            );
        );
        distCode ||= ")";
        Eval(
            Parse(
                Eval Insert(
                    "\[
            // Send content to the output pane.
            processNS:setReportOutput(
                VListBox(
                    // Create a Distribution object using the code built in distCode.
                    objRefNS:db = ^distCode^
                )
            );
        ]\"
                )
            )
        );
    );

    // Calling a widget constructor (in non-inline form, with a script that runs after the user changes the value, running the script initially).
    processNS
    :makeCreateAdditionalDistributionsForSelectedVariablesWidget(
        0, // 0 is non-inline form; use 1 for inline form
        // script
        Expr(
            Expr(
                Expr(
            // Retrieve the current values this widget, convert them into JMP names, and store these in objRefNS:tadslCols.
                    objRefNS:tadslCols = jg
                    :getColumnJMPNames(
                        jg:getWidgetValue(
                            "objRefNS:CreateAdditionalDistributionsForSelectedVariablesolb"
                        ), objRefNS:in_adsl
                    );

            // Call the function defined in this report.
                    objRefNS:createResults( objRefNS:tadslCols );

            // Renaming a report.
                    //processNS:renameReportTitleDomain("ADSL"); // Honors configuration display preferences for domains.
                    processNS
                    :renameReportTitleSubstring(
                        Char( objRefNS:tadslCols )
                    );
            //processNS:renameReportTitle("This entirely replaces the original report title."); // Freeform -- does not use processNS:labelSkeleton.

                    // When a widget value change requires the entire report to rerun, issue the following, but be sure to set the runScriptInitial
                    //  argument in the widget constructor to 0 to prevent an endless loop.
                    //processNS:rerunReport();
                )
            )
        ),
        1 // 0 is do not run the script initially; 1 is run the script initially
    );

    // Example custom widget creation.
    processNS:makeWidget(
        ["ref" => "objRefNS:w1", "class" => "ComboBoxClass"]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w2",
        "class" => "ComboBoxClass",
        "label" => "ComboBoxClass Widget 2",
        "values" => {"A~a", "B~b", "C~c"}, "initialvalue" => "B"]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w3",
        "class" => "ComboBoxClass",
        "label" => "ComboBoxClass Widget 3",
        "valuesdataref" => "objRefNS:in_adsl"]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w4",
        "class" => "CalendarFieldClass",
        "label" => "CalendarFieldClass Widget",
        "initialvalue" => "01/01/2015",
        "selectedformat" => "d/m/y"]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w5",
        "class" => "CheckboxClass",
        "label" => "CheckboxClass Widget",
        "initialvalue" => "No",
        "scriptd" => Expr(
            Expr(
                Expr(
                    If( !((objRefNS:w5):isChecked()),
                        Try(
                            (objRefNS:w6):inputContainer <<
                            Visibility( "collapse" )
                        ),
                        Try(
                            (objRefNS:w6):inputContainer <<
                            Visibility( "visible" )
                        )
                    )
                )
            )
        )]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w6",
        "class" => "FileAndFolderFieldClass",
        "label" => "FileAndFolderFieldClass Widget",
        "selectionoptions" => ["selectDirectory" => 1], "scriptd" =>
        Expr(
            Expr(
                Expr(
                    If( !((objRefNS:w5):isChecked()),
                        Try(
                            (objRefNS:w6):inputContainer <<
                            Visibility( "collapse" )
                        ),
                        Try(
                            (objRefNS:w6):inputContainer <<
                            Visibility( "visible" )
                        )
                    )
                )
            )
        ), "script" => Expr(
            Expr(
                Expr(
                    processNS:rerunReport()
                )
            )
        )]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w7",
        "class" => "ListBoxClass",
        "label" => "ListBoxClass Widget",
        "maxselected" => 2,
        "values" => {"A~a", "B~b", "C~c"}, "initialvalue" => {"B", "C"},
        "script" => Expr(
            Expr(
                Expr(
                    processNS:rerunReport()
                )
            )
        )]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w8",
        "class" => "ManualEntryListBoxClass",
        "label" => "ManualEntryListBoxClass Widget"]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w9",
        "class" => "ManualEntryOrderedListBoxClass",
        "label" => "ManualEntryOrderedListboxClass Widget",
        "initialvalue" => {"a", "b", "c"}, "script" =>
        Expr(
            Expr(
                Expr(
                    processNS:rerunReport()
                )
            )
        )]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w10",
        "class" => "OrderedListBoxClass",
        "label" => "OrderedListBoxClass Widget",
        "values" => {"A~a", "B~b", "C~c"}, "displayoption" => 2,
        "initialvalue" => {"B"}]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w11",
        "class" => "RadioBoxClass",
        "label" => "RadioBoxClass Widget",
        "values" => {"a", "b", "c"}, "initialvalue" => "b",
        "script" => Expr(
            Expr(
                Expr(
                    processNS:rerunReport()
                )
            )
        )]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w12",
        "class" => "SliderFieldClass",
        "label" => "SliderFieldClass Widget",
        "min" => 10,
        "max" => 20,
        "script" => Expr(
            Expr(
                Expr(
                    processNS:rerunReport()
                )
            )
        )]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w13",
        "class" => "SpinnerFieldClass",
        "label" => "SpinnerFieldClass Widget",
        "min" => 10,
        "max" => 20,
        "increment" => 2]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w14",
        "class" => "TextFieldClass",
        "label" => "TextFieldClass Widget",
        "initialvalue" => "Test",
        "script" => Expr(
            Expr(
                Expr(
                    processNS:rerunReport()
                )
            )
        )]
    );
    processNS:makeWidget(
        ["ref" => "objRefNS:w16",
        "class" => "OrderedListBoxClass",
        "label" => "OrderedListBoxClass Widget 2",
        "valuesdataref" => "objRefNS:in_adsl",
        "initialvalue" => {"AGE"}]
    );

    // Obtain the current internal value from a widget.
    processNS:note(
        "objRefNS:w2's value is " || Char(
            jg:getWidgetValue( "objRefNS:w2" )
        ) || "."
    );

    // Obtain the current display value from a widget.
    processNS:note(
        "objRefNS:w2's value is " || Char(
            jg:getWidgetValueAlternate( "objRefNS:w2" )
        ) || "."
    );

    // Place the above widget into the Options Data panel.
    processNS:appendDataOptions(
        V List Box(
            // Paste the inputContainer (displaybox) of the widgets in the display tree.
            (objRefNS:CreateAdditionalDistributionsForSelectedVariablesolb)
            :inputContainer, 
            // Example custom widgets created above.
            (objRefNS:w1):inputContainer,
            (objRefNS:w2):inputContainer,
            (objRefNS:w3):inputContainer,
            (objRefNS:w4):inputContainer,
            (objRefNS:w5):inputContainer,
            (objRefNS:w6):inputContainer,
            (objRefNS:w7):inputContainer,
            (objRefNS:w8):inputContainer,
            (objRefNS:w9):inputContainer,
            (objRefNS:w10):inputContainer,
            (objRefNS:w11):inputContainer,
            (objRefNS:w12):inputContainer,
            (objRefNS:w13):inputContainer,
            (objRefNS:w14):inputContainer, 
            // Example custom widget created inline.
            processNS:makeWidget(
                ["ref" => "objRefNS:w15",
                "class" => "CheckboxClass",
                "label" => "CheckboxClass Widget 2",
                "inline" => 1]
            ),
            (objRefNS:w16):inputContainer
        ),
        0
    );

    // Create a Report Filter.
    If( Length( objRefNS:tadslCols ),
        objRefNS:ReportDataFilterReferenceList = reportRefNS
        :createReportFilter( objRefNS:in_adsl, objRefNS:tadslCols );
        // Do not display the filter histograms and bars.
        objRefNS:rptfilter = objRefNS:ReportDataFilterReferenceList[2];
        objRefNS:rptfilter << Show Histograms and Bars( 0 );
    );

    // Place the Report Filter in the Options Display panel.
    processNS:appendDisplayOptions(
        objRefNS:ReportDataFilterReferenceList[1]
    );

    // Keep track of data sets created in this report so that they are automatically closed when the report tab is closed.
    processNS:addDataTableReference(
        "Custom Report Example ADSL Data", "objRefNS:in_adsl"
    );

    // Send these objects to JMP Live.
    processNS:defineStaticReportContent( {objRefNS:db} );

    // Send these objects to the static report.
    processNS:defineLiveReportContent( {{objRefNS:db}} );
);

0;
/*
===================================================================================

Copyright © 2025 JMP Statistical Discovery LLC, Cary, NC, USA. All rights reserved.

JMP STATISTICAL DISCOVERY LLC ("JMP") PERMITS THE USE OF THIS COMPUTER SOFTWARE
CODE ("CODE") ON AN AS-IS BASIS AND AUTHORIZES YOU TO USE THE CODE SUBJECT TO
THE TERMS LISTED HEREIN. BY USING THE CODE, YOU AGREE TO THESE TERMS. YOUR USE
OF THE CODE IS AT YOUR OWN RISK. JMP MAKES NO REPRESENTATION OR WARRANTY,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE,
WITH RESPECT TO THE CODE.

You may use the Code solely as part of a software product you currently have
licensed from JMP, JMP's parent company, SAS Institute Inc. ("SAS US") or one
of SAS' subsidiaries (together with SAS US, "SAS") or authorized agents (the
"Software"), and not for any other purpose. The Code is designed to either
correct an error in the Software or to add functionality to the Software but
has not necessarily been tested. Accordingly, JMP makes no representation or
warranty that the Code (1) will operate error-free or (2) will not contain any
viruses or other applications or executables (including, without limitation,
any "trap doors," "worms" and "time bombs") that will degrade or infect any
software product that you license from JMP or any other software or your
network or systems. JMP is under no obligation to maintain, support, or
continue to distribute the Code.

Neither JMP nor its licensors shall be liable to you or any third party for any
general, special, direct, indirect, consequential, incidental, or other damages
whatsoever arising out of or related to your use or inability to use the Code,
even if JMP has been advised of the possibility of such damages. Except as
otherwise provided above, the Code is governed by the same agreement that
governs the Software. If you do not have an existing agreement with JMP or SAS
governing the Software, you may not use the Code.

US export laws and regulations apply to the Code and any other JMP-provided
technology ("Controlled Material"). The Controlled Material originates from the
United States. Customer agrees to comply with these and other applicable export
and import laws and regulations, except as prohibited or penalized by law
("Trade Law"). Customer warrants that Customer and its users are not: (a)
prohibited by Trade Law from accessing Controlled Material without US
government approval; (b) located in or under control of any country or other
territory subject to general export or trade embargo under Trade Law; or (c)
engaged in any of the following end-uses: nuclear, chemical or biological
weapons; nuclear facilities not under International Atomic Energy Agency
safeguards; missiles or unmanned aerial vehicles capable of long-range use or
weapons delivery, military training or assistance, military or intelligence
end-use in Russia or in any country in Country Group D:5 of the United States
Export Administration Regulations; deep water, Arctic offshore or shale oil or
gas exploration involving Russia or Russian companies, or Russian energy export
pipelines. Customer will not import or use any data within the System that is
subject to the US International Traffic Arms Regulations. United States export
classification information for JMP software and its affiliates is available at
jmp.com/export.

JMP and all other JMP Statistical Discovery LLC product or service names are
registered trademarks or trademarks of SAS Institute Inc. in the USA and other
countries. ® indicates USA registration. Other brand and product names are
registered trademarks or trademarks of their respective companies.

==============================================================================
*/


```

# [JMP Live](#jmp-live)

### [New JMP Live](#new-jmp-live)

**Syntax:** New JMP Live(Connection("Connection Name"), \<Prompt("No" | "If Needed")>)

**Description:** Start a connection to JMP Live using stored connection information. Connection is optional and defaults to the connection specified as the default in Connection Manager. If provided it looks up the connection by the name. Prompt is optional and defaults to "No". The valid values for prompt are "Yes", "No", and "If Needed". A value of "Yes" always prompts for login credentials. A value of "No" never prompts for login credentials, but could result in an authentication failure. A value of "If Needed" prompts for credentials only if the current stored credentials are not valid. Returns a JMP Live Connection object.

**JMP Version Added:** 15

**Example 1**

```

jmplive = New JMP Live();


```

**Example 2**

```

jmplive = New JMP Live( Connection( "MyJMPLive" ), Prompt( No ) );


```

**Example 3**

```

jmplive = New JMP Live( Connection( "MyJMPLive" ), Prompt( If Needed ) );


```

### [New JMP Live Content](#new-jmp-live-content)

**Syntax:** obj = New JMP Live Content(jmpreport|Image(path_to_image)|Data(jmpdatatable)|Map(jmpmap), \<Title(...)>, \<Description(...)>, \<Publish Data(0|1)>, \<Enable Warnings(0|1)>, \<Optimization("Interactivity" | "Performance")>

**Description:** Creates interactive content for publishing on JMP Live.

```
The first parameter is required and specifies the data to use for the content. That data can be a report, a data table, a map or an image.

Title and Description are used to customize any type of content that is being published. The remaining parameters are optional and used to customize report content only.

Publish Data indicates whether the data used in the report is published to JMP Live. The data for the report is published by default.

Enable Warnings indicates whether Control Chart Warnings should be enabled for the report. Control Chart Warnings are disabled by default.

Optimization is used to customize the way the report is published to JMP Live. The report is published to enable greater interactivity by default.

```

**JMP Version Added:** 17

**Example 1**

```

bc = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = bc << Run Script( "Distribution" );

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Sample Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    dist,
    Title( "Distribution Web Report" ),
    Description( "This report was created with the sample found in the Scripting Index" ),
    Publish Data( 1 ),
    Optimization( "Interactivity" )
);

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 2**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Data Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content(
    Data( "$SAMPLE_DATA/Big Class.jmp" ),
    Title( "Big Class Sample Table" ),
    Description(
        "This data table was published with the sample found in the Scripting Index"
    )
);

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 3**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Map Content" )
);
folder = jmpliveresult << As Scriptable;

content = New JMP Live Content( Map( "$SAMPLE_DATA/S4-XY.jmp" ) );

jmpliveresult = liveconnection << Publish( content, Folder( folder ) );


```

**Example 4**

```

liveconnection = New JMP Live();
jmpliveresult = liveconnection << Create Folder(
    Parent Folder( "~" ),
    Title( "Folder for Image Content" )
);
folder = jmpliveresult << As Scriptable;

imageContent = New JMP Live Content(
    Image( "$SAMPLE_IMAGES/black rhino footprint.jpg" ),
    Title( "Rhino Footprint" ),
    Description( "An image of a rhino footprint from the Sample Data" )
);

jmpliveresult = liveconnection << Publish( imageContent, Folder( folder ) );


```

# [List](#list)

### [As List](#as-list)

**Syntax:** y = As List( matrix )

**Description:** Returns a list representation of a matrix. Multi-column matrices are converted to a list of lists, one per row, as would be expected by the Matrix operator.

**JMP Version Added:** Before version 14

```

As List( [11 22 33, 44 55 66] );


```

### [Concat Items](#concat-items)

**Syntax:** string = Concat Items( {list of strings}, <separatorString> )

**Description:** Joins a list of strings into one long string, separating each from next with the separator, a blank if unspecified.

**JMP Version Added:** Before version 14

```

Concat Items( {"www", "jmp", "com"}, "." );


```

### [Eval List](#eval-list)

**Syntax:** y = Eval List( list )

**Description:** Returns a list where every item in the list has been evaluated.

**JMP Version Added:** Before version 14

**Example 1**

```

Eval List( {1 + 2, 3 + 4} );


```

**Example 2**

```

x = 5;
y = 10;
Eval List( {x, y} );


```

### [Insert](#insert)

**Syntax:** z = Insert( x, y, <i> )

**Description:** Returns a copy of list x with y inserted at the ith position or appended to the end if the optional i argument is not specified.

**JMP Version Added:** Before version 14

```

z = {11, 22, 33};
z = Insert( z, 99, 2 );


```

### [Insert Into](#insert-into)

**Syntax:** Insert Into( x, y, <i> )

**Description:** Modifies list, associative array, or display box x with y inserted into the collection. Lists and display boxes support an optional i to specify the position, or the items will be appended if the position is not specified. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33};
Insert Into( ex, 99 );
ex;


```

**Example 2**

```

ex = ["a" => 10, "b" => 3, => 0];
Insert Into( ex, "c", 12 );
ex;


```

**Example 3**

```

New Window( "boxes", hlist = H List Box( Button Box( "a" ), Button Box( "b" ) ) );
Wait( 1 );
Insert Into( hlist, Button Box( "c" ) );


```

### [Is List](#is-list)

**Syntax:** y = Is List( x )

**Description:** Returns 1 if the x argument is a list, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is List( {1, 2, 3} );


```

### [Items](#items)

**Syntax:** wl = Items(\<[first last]>, s, <delim>, \<Include Boundary Delimiters(0|1)>)

**Description:** Returns a list of (possibly empty) sub-strings separated by exactly one of any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate item.

**JMP Version Added:** 15

**Example 1**

```

Eval List( {Items( "http://www.jmp.com", ":/." ), Items( "hello", "" )} );


```

**Example 2**

```

Items( ",Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

**Example 3**

```

Items(
    ",Apple,Banana Tree,Peach",
    Get Punctuation Characters(),
    Include Boundary Delimiters
);


```

**Example 4**

```

Items( [1 2], ",Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

### [Length](#length)

**Syntax:** l = Length( x )

**Description:** Returns the length of the given string (in characters), list (in items), associative array (in number of keys), blob (in bytes), matrix (in elements), or namespace/class (in number of functions and variables).

**JMP Version Added:** Before version 14

**Example 1**

```

Length( "Café" );


```

**Example 2**

```

Length( {1, 2 + 3, [11 22]} );


```

**Example 3**

```

Length( ["a" => 10, "b" => 3, => 0] );


```

**Example 4**

```

Length( Char To Blob( "Café" ) );


```

### [List](#list_1)

**Syntax:** y = {a, b, ...}; y = List( a, b, ... )

**Description:** Creates a list of items without evaluating them.

**JMP Version Added:** Before version 14

```

{1, 2 + 3, [11 22]};


```

### [N Items](#n-items)

**Syntax:** y = N Items( x )

**Description:** Returns the number of items in a list, the number of elements in a matrix, the number of keys in an associative array, the number of functions and variables in a namespace, the number of methods and variables in a class object, or the number of children of a display box.

**JMP Version Added:** Before version 14

**Example 1**

```

N Items( {1, 2 + 3, [11 22]} );


```

**Example 2**

```

N Items( ["a" => 10, "b" => 3, => 0] );


```

**Example 3**

```

New Window( "boxes", hlist = H List Box( Button Box( "a" ), Button Box( "b" ) ) );
N Items( hlist );


```

### [Remove](#remove)

**Syntax:** y = Remove( x, <i>, \<n=1> ); y = Remove( x, {list} )

**Description:** Returns a copy of list x, deleting n items starting with the ith item or deleting a list of items specified by the list argument.

**JMP Version Added:** Before version 14

```

Remove( {11, 22, 33, 44, 55}, 3, 2 );


```

### [Remove From](#remove-from)

**Syntax:** Remove From( x, <i>, \<n=1> )

**Description:** Modifies list, associative array, or display box x by removing items. Associative arrays specify the item to be removed with a key value i. Lists and display boxes remove starting with the item in position i. A list will remove multiple items at once if the n option is specified. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Remove From( ex, 3, 2 );
ex;


```

**Example 2**

```

ex = ["a" => 10, "b" => 3, "c" => 12, => 0];
Remove From( ex, "c" );
ex;


```

**Example 3**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Remove From( hlist, 1 );


```

### [Reverse](#reverse)

**Syntax:** y = Reverse( x )

**Description:** Returns a copy of list x with the item order reversed.

**JMP Version Added:** Before version 14

```

Reverse( {11, 22, 33, 44, 55} );


```

### [Reverse Into](#reverse-into)

**Syntax:** Reverse Into( x )

**Description:** Modifies list or display box x with the item order reversed. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Reverse Into( ex );
ex;


```

**Example 2**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Reverse Into( hlist );


```

### [Set Difference](#set-difference)

**Syntax:** list = Set Difference( list1, list2 )

**Description:** Returns the list of items that occur in list1 but not in list2. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Difference( {1, 3}, {3, 2} ) );
Show( Set Difference( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );


```

### [Set Intersection](#set-intersection)

**Syntax:** list = Set Intersect( list1, list2 )

**Description:** Returns the list of items that occur in both lists. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Intersection( {1, 3}, {3, 2} ) );
Show( Set Intersection( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );
dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
dt << get rows where( Set Intersection( :sports, {"Soccer"} ) != {} );


```

### [Set Union](#set-union)

**Syntax:** list = Set Union( list1, list2 )

**Description:** Returns the list of items that occur in either list. Items can be repeated. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Union( {1, 3}, {3, 2} ) );
Show( Set Union( {1, 3, 4, 3}, {3, 2, 3, 5, 3} ) );
all = {};
Open( "$SAMPLE_DATA/Big Class Families.jmp" );
For Each Row( all = Set Union( all, :sports ) );
all = Set Unique( all );
Show( all );


```

### [Set Unique](#set-unique)

**Syntax:** list = Set Unique( list )

**Description:** Returns the list of unique items that occur in the input list. If an argument is a multiple-response column reference, it is treated as a list of its values in the current row.

**JMP Version Added:** 19

```

Show( Set Unique( {1, 3, 2} ) );
Show( Set Unique( {1, 3, 4, 3, 3, 2, 3, 5, 3} ) );
Open( "$SAMPLE_DATA/Big Class Families.jmp" );
Row() = 1;
Show( Set Unique( :sports ) );


```

### [Shift](#shift)

**Syntax:** y = Shift( x, \<n=1> )

**Description:** Returns a copy of list x with the first n items moved to the end of the list, or, if n is negative, the last n items moved to the start.

**JMP Version Added:** Before version 14

```

Shift( {11, 22, 33, 44, 55}, 2 );


```

### [Shift Into](#shift-into)

**Syntax:** Shift Into( x, \<n=1> )

**Description:** Modifies list or display box x with the first n items moved to the end of the list, or, if n is negative, the last n items moved to the start. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = {11, 22, 33, 44, 55};
Shift Into( ex, -2 );
ex;


```

**Example 2**

```

New Window( "boxes",
    hlist = H List Box( Button Box( "a" ), Button Box( "b" ), Button Box( "c" ) )
);
Wait( 1 );
Shift Into( hlist, -2 );


```

### [Sort List](#sort-list)

**Syntax:** y = Sort List( x )

**Description:** Returns a copy of list x with the items in ascending order.

**JMP Version Added:** Before version 14

```

Sort List( {111, 212, 133, 114, 55} );


```

### [Sort List Into](#sort-list-into)

**Syntax:** Sort List Into( x )

**Description:** Modifies list x with the items in ascending order. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

```

ex = {111, 212, 133, 114, 55};
Sort List Into( ex );
ex;


```

### [Substitute](#substitute)

**Syntax:** y = Substitute( x, patternExpr1, replacementExpr1, ... ) y = Substitute( x, patternString1, replacementString1, ..., < \<<IGNORECASE > )

**Description:** Returns a copy of string, list or expression x, replacing instances of each pattern expression with the corresponding replacement expression. The optional \<<IGNORECASE argument enables case-insensitive matching if x is a string.

**JMP Version Added:** Before version 14

**Example 1**

```

Substitute( Expr( a + Sqrt( a ) ), Expr( a ), Expr( b ) );


```

**Example 2**

```

Substitute( "All things considered", "All", "Some" );


```

**Example 3**

```

lst = {"a", "b", "c"};
Substitute( lst, "a", "A" );


```

**Example 4**

```

Substitute( "All things considered", {"things", "All"}, {"ideas", "Some"} );


```

**Example 5**

```

Substitute( "Apple,orange,banana-grape",
    Items( Get Punctuation Characters() || "-'", "" ), " "
);


```

**Example 6**

```

Substitute( "Apple,APPLE,apple", "apple", "orange", <<IGNORECASE );


```

### [Substitute Into](#substitute-into)

**Syntax:** Substitute Into( x, patternExpr1, replacementExpr1, ... ) Substitute Into( x, patternString1, replacementString1, ..., < \<<IGNORECASE > )

**Description:** Modifies string, list or expression x, replacing instances of each pattern expression with the corresponding replacement expression. Note that the x argument must be a variable. The optional \<<IGNORECASE argument enables case-insensitive matching if x is a string.

**JMP Version Added:** Before version 14

**Example 1**

```

ex = Expr( a + Sqrt( a ) );
Substitute Into( ex, Expr( a ), Expr( b ) );
Name Expr( ex );


```

**Example 2**

```

ex = "All things considered";
Substitute Into( ex, "All", "Some" );
Show( ex );


```

**Example 3**

```

lst = {"a", "b", "c"};
Substitute Into( lst, "a", "A" );
Show( lst );


```

**Example 4**

```

s = "Apple,APPLE,apple";
Substitute Into( s, "apple", "orange", <<IGNORECASE );
Show( s );


```

### [Words](#words)

**Syntax:** wl = Words( \<[first last]>, s, <delim>)

**Description:** Returns a list of sub-strings separated by any of the characters specified in the delim argument. If delim is absent, the space character is used. If delim is the empty string, each character is treated as a separate word.

**JMP Version Added:** Before version 14

**Example 1**

```

Eval List( {Words( "http://www.jmp.com", ":/." ), Words( "hello", "" )} );


```

**Example 2**

```

Words( "Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

**Example 3**

```

Words( [1 2], "Apple,Banana Tree,Peach", Get Punctuation Characters() );


```

# [MATLAB](#matlab)

### [Check MATLAB Dependencies](#check-matlab-dependencies)

**Syntax:** Check MATLAB Dependencies()

**Description:** Checks if MATLAB dependencies are installed.

**JMP Version Added:** Before version 14

```


If( !Check MATLAB Dependencies(),
    Install MATLAB Dependencies();
    Print( "Dependencies are installed" );
,
    Print( "Dependencies are installed" )
);


```

### [Install MATLAB Dependencies](#install-matlab-dependencies)

**Syntax:** Install MATLAB Dependencies(\<Patch(0|1)>)

**Description:** Installs the required MATLAB dependencies.

**JMP Version Added:** Before version 14

```


If( !Check MATLAB Dependencies(),
    Install MATLAB Dependencies(),
    Print( "Dependencies are installed" )
);


```

### [MATLAB Connect](#matlab-connect)

**Syntax:** MATLABConnection = MATLAB Connect(\<Echo(0|1)>)

**Description:** Returns a MATLAB connection scriptable object.

**JMP Version Added:** Before version 14

```

MATLABConnection = MATLAB Connect();
x = MatlabConnection << Is Connected;
Show( x );


```

### [MATLAB Control](#matlab-control)

**Syntax:** MATLAB Control( Echo(bool) )

**Description:** Changes the control options for MATLAB.

**JMP Version Added:** Before version 14

```


MATLAB Init( Echo( true ) );
MATLAB Control( Echo( false ) );
MATLAB Submit(
    "\[
    v = [9 8 7, 6 5 4, 3 2 1];
    m = [1 2 3, 4 5 6, 7 8 9];
    rowjoin = [v ; m]
    coljoin = [v , m]
]\"
);
MATLAB Term();


```

### [MATLAB Execute](#matlab-execute)

**Syntax:** MATLAB Execute( { list of Inputs }, { list of Outputs }, statements, \<Echo(0|1)>, \<Expand(0|1)> )

**Description:** Sends a list of inputs, executes statements and returns a list of outputs.

**JMP Version Added:** Before version 14

```

MATLAB Init();
a = "abcdef";
d = 3.141;
v = [9 8 7, 6 5 4, 3 2 1];
m = [1 2 3, 4 5 6, 7 8 9];
ml = MATLAB Execute(
    {v, m, a, d},
    {x, z, a, d},
    "\[
a = v * m; % matrix product
d = v / m; % = v * inv(m) called Right division
z = m \ v; % = m * inv(v) called Left division
x = m .* v; % element-wise product
]\"
);
Show( v, m, ml, x, z, a, d );
MATLAB Term();


```

### [MATLAB Get](#matlab-get)

**Syntax:** y = MATLAB Get( name )

**Description:** Returns data from MATLAB, where the name argument can represent any of the following MATLAB data types ( numeric | string | matrix | list | data frame).

**JMP Version Added:** Before version 14

```

MATLAB Init();
x1 = [1, 2, 3];
MATLAB Send( x1 );
x2 = MATLAB Get( x1 );
Show( x1, x2 );
dt1 = Open( "$SAMPLE_DATA/Big Class.jmp" );
MATLAB Send( dt1 );
dt2 = MATLAB Get( dt1 );
dt2 << New Data View;
Close( dt1 );
MATLAB Term();


```

### [MATLAB Get Graphics](#matlab-get-graphics)

**Syntax:** MATLAB graphics = MATLAB Get Graphics( format )

**Description:** Returns the last graphics object written to the MATLAB graph display window in a graphics format specified by the format argument.

**JMP Version Added:** Before version 14

```

MATLAB Init();
ml = MATLAB Submit( "\[
plot(1:10)
]\" );
plot = MATLAB Get Graphics( png );
pngJMP = New Window( "Plot", Picture Box( plot ) );
pngJMP << Close Window;
MATLAB Submit( "close" );//Needed this command to close the figure generated from Matlab
MATLAB Term();


```

### [MATLAB Get Version](#matlab-get-version)

**Syntax:** version = MATLAB Get Version()

**Description:** Returns the version number of MATLAB being used with the JMP MATLAB interfaces.

**JMP Version Added:** 14

```

MATLAB Init();
version = MATLAB Get Version();
Show( version );
MATLAB Term();


```

### [MATLAB Init](#matlab-init)

**Syntax:** MATLAB Init(\<Echo(0|1)>)

**Description:** Initializes the MATLAB Interfaces.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = MATLAB Get( str );
Show( getStr );
MATLAB Term();


```

### [MATLAB Is Connected](#matlab-is-connected)

**Syntax:** connected = MATLAB Is Connected()

**Description:** Returns 1 if there is an active MATLAB connection; otherwise, returns 0.

**JMP Version Added:** Before version 14

```

MATLAB Init();
x = MATLAB Is Connected();
Show( x );
MATLAB Term();


```

### [MATLAB JMP Name to MATLAB Name](#matlab-jmp-name-to-matlab-name)

**Syntax:** MATLAB name = MATLAB JMP Name To MATLAB Name( JMP name )

**Description:** Maps a JMP variable name to a MATLAB variable name using MATLAB variable naming rules.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB name = MATLAB JMP Name to MATLAB Name( a b c );
Show( MATLAB name );
MATLAB Term();


```

### [MATLAB Load](#matlab-load)

**Syntax:** MATLAB Load( path )

**Description:** Loads variables into MATLAB from a .mat file and returns the variables to a JSL associative array.

**JMP Version Added:** 19

```

MATLAB Init();
// if .mat file contained: x = 40; y = 'hello';
vars = MATLAB Load( "path/to/.mat" );
Show( vars << Get Value( "x" ), vars << Get Value( "y" ) );
MATLAB Term();


```

### [MATLAB Send](#matlab-send)

**Syntax:** MATLAB Send( name, \<MATLAB Name( name )>, <Named Arguments> )

**Description:** Sends data to MATLAB, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table).

**JMP Version Added:** Before version 14

```

MATLAB Init();
x = [1, 2, 3];
MATLAB Send( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
MATLAB Send( dt );
Close( dt );
MATLAB Submit( "x" );
MATLAB Submit( "dt" );
MATLAB Term();


```

### [MATLAB Send File](#matlab-send-file)

**Syntax:** MATLAB Send File( filename, \<MATLAB Name( name )> )

**Description:** Sends a data file to MATLAB, where the filename argument is a string that specifies a path name to the file to be sent to MATLAB.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Send File( "$SAMPLE_DATA/Big Class.jmp" );
MATLAB Send File( "$SAMPLE_DATA/Baseball.jmp" );
MATLAB Submit( "BigClass" );
MATLAB Submit( "Baseball" );
MATLAB Term();


```

### [MATLAB Submit](#matlab-submit)

**Syntax:** MATLAB Submit( statements, \<Echo(0|1)>, \<Expand(0|1)> )

**Description:** Submit statements to MATLAB. Statements can be in the form of a string value or list of string values.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
a = 200;
]\" );
getStr = MATLAB Get( str );
getNum = MATLAB Get( a );
Show( getStr, getNum );
MATLAB Term();


```

### [MATLAB Submit File](#matlab-submit-file)

**Syntax:** MATLAB Submit File( path, \<Echo(0|1)>, \<Expand(0|1)> )

**Description:** Submits statements to MATLAB using a file specified by the path argument.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit File( "file containing MATLAB source.m" );
MATLAB Term();


```

### [MATLAB Term](#matlab-term)

**Syntax:** MATLAB Term()

**Description:** Terminates the MATLAB interfaces.

**JMP Version Added:** Before version 14

```

MATLAB Init();
MATLAB Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = MATLAB Get( str );
Show( getStr );
MATLAB Term();


```

### [Update MATLAB Dependencies](#update-matlab-dependencies)

**Syntax:** Update MATLAB Dependencies(\<Patch(0|1)>)

**Description:** Updates the required MATLAB dependencies.

**JMP Version Added:** Before version 14

```


If( Check MATLAB Dependencies(),
    Update MATLAB Dependencies(),
    Print( "Dependencies are updated" )
);


```

# [Matrix](#matrix)

### [Add Vectors BLAS](#add-vectors-blas)

**Syntax:** z = Add Vectors BLAS( x, y, alpha )

**JMP Version Added:** 17

```

x = [1, 2, 3, 4];
y = [5, 6, 7, 8];
alpha = 0.5;
z = Add Vectors BLAS( x, y, alpha );


```

### [All](#all)

**Syntax:** y = All( x, ... )

**Description:** Returns 1 if all elements are nonzero, zero otherwise.

**JMP Version Added:** Before version 14

```

All( [1 2 3] );


```

### [Any](#any)

**Syntax:** y = Any( x, ... )

**Description:** Returns 1 if any element is nonzero, zero otherwise.

**JMP Version Added:** Before version 14

```

Any( [1 0 2] );


```

### [B Spline Coef](#b-spline-coef)

**Syntax:** coef = B Spline Coef( x, Internal Knot Grid, \<degree = 3>, \<KnotEndPoints = min(x) || max(x)> )

**Description:** Returns the matrix of B-Spline coefficients. Internal Knot Grid is either the number of desired knot points based on percentiles of x or a vector specifying the internal knot points. Optional parameter degree specifies the degree of the B-splines with a default of 3. Optional parameter KnotEndPoints takes a 2x1 matrix containing [lower, upper] locations for the knots on the boundary. The knot end points default to the min and max of x. The second example demonstrates how B-spline coefficients can be used as the design matrix in a linear model.

**JMP Version Added:** 14

**Example 1**

```

B Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 2 );
B Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], [3, 7] );


```

**Example 2**

```

xx = (0 :: 10)`;
yy = [0, 1, 0, -1, 0, 1, 0, -1, 0, 1, 0];
designMat = B Spline Coef( xx, 2 );
Linear Regression( yy, designMat, <<nointercept );


```

### [CDF](#cdf)

**Syntax:** {QuantVec, CumProbVec} = CDF( Y )

**Description:** Returns values of the empirical cumulative probability distribution function for vector or list Y. Cumulative probability is the proportion of data values less than or equal to the corresponding entry in vector QuantVec

**JMP Version Added:** Before version 14

```

/* Generate random values, Normal(0,1) */
Y = J( 150, 1, Random Normal() );

/* CDF function */
{Quant, CumProb} = CDF( Y ); 

/* Draw empirical and theorical CDF */
New Window( "Empirical CDF",
    Graph Box(
        X Scale( -3, 3 ),
        Y Scale( 0, 1 ),
        Pen Color( "red" );
        For( i = 2, i <= N Row( Quant ), i++,
            H Line( Quant[i - 1], Quant[i], CumProb[i] );
            V Line( Quant[i - 1], CumProb[i - 1], CumProb[i] );
        );
        i = N Row( Quant );
        V Line( Quant[i], CumProb[i], 1 );
        Pen Color( "blue" );
        Y Function( Normal Distribution( q ), q );
    )
);


```

### [Chol Update](#chol-update)

**Syntax:** L2 = Chol Update( L, V, C )

**Description:** Returns an updated Cholesky root of A+V\*C\*V' where C is an m by m symmetric matrix and V is an n by m matrix. The argument L must be the Cholesky root of an n by n matrix A.

**JMP Version Added:** Before version 14

```

/* The inner product of a design matrix */
exS = [16 1 0 11 -1 12,
1 11 -1 1 -1 1,
0 -1 12 -1 1 0,
11 1 -1 11 -1 9,
-1 -1 1 -1 9 -1,
12 1 0 9 -1 12];
/* Conduct the Cholesky decomposition */
exAchol = Cholesky( exS );

/* Two column vectors to be applied to change the design matrix */
exV = [1 1, 0 0, 0 1, 0 0, 0 0, 0 1];

/* The first column vector is added to one of the rows in the design matrix */
/* The second column vector is subtracted from one of the rows in the design matrix */
exC = [1 0, 0 -1];

/* Update the Cholesky decomposition manually */
exAnew = exS + exV * exC * exV`;
exAcholnew = Cholesky( exAnew );

/* Update the Cholesky decomposition more efficiently */
exAcholnew_test = Chol Update( exAchol, exV, exC );

/* Results are the same */
Show( exAcholnew_test );
Show( exAcholnew );


```

### [Cholesky](#cholesky)

**Syntax:** L = Cholesky( A )

**Description:** Returns the Cholesky decomposition of a positive semi-definite matrix. L is a lower triangular matrix such that L\*L\` = A.

**JMP Version Added:** Before version 14

```

Cholesky( [1 2, 2 13] );


```

### [Correlation](#correlation)

**Syntax:** y = Correlation( x , < \<<"Pairwise" >, < \<<"Shrink" >, < \<<Freq(vector) >, < \<<Weight(vector) > )

**Description:** Returns the correlation matrix of the matrix argument x. The "Pairwise" argument handles missing values in pairwise rather than rowwise fashion. The "Shrink" argument reduces the off-diagonal elements by a factor that is determined using the method described in Schafer and Strimmer, 2005. The Freq and Weight arguments specify vectors of frequency or weight values, respectively.

**JMP Version Added:** Before version 14

```

Correlation( [1 3 5, 3 2 6, 5 6 1] );


```

### [Covariance](#covariance)

**Syntax:** y = Covariance( x , < \<<"Pairwise" >, < \<<"Shrink" >, < \<<Freq(vector) >, < \<<Weight(vector) > )

**Description:** Returns the covariance matrix of the matrix argument x. The "Pairwise" argument handles missing values in pairwise rather than rowwise fashion. The "Shrink" argument reduces the off-diagonal elements by a factor that is determined using the method described in Schafer and Strimmer, 2005. The Freq and Weight arguments specify vectors of frequency or weight values, respectively.

**JMP Version Added:** Before version 14

```

Covariance( [1 3 5, 3 2 6, 5 6 1] );


```

### [Design](#design)

**Syntax:** y = Design( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for each unique value of the argument. Use the levelsList argument to specify a list of the levels for the design matrix. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design( exLevels ) );
/* Also see DesignNom, DesignOrd */

/* example that Design(...) takes two arguments */
Show( Design( 3, {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design( exLevels, {1, 2, 3} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

/* example that Design(...) takes three arguments */
Show( Design( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Design Last](#design-last)

**Syntax:** y = Design Last( v, < levelsList, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for all but the last of the unique values of the argument. The last level is coded as a row of 0s. If the levelsList argument is specified, the last level is the last level in levelsList. Otherwise, the last level is defined as the largest value in v. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design Last(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design Last( exLevels ) );
/* see what is different from Design(...) */
Show( Design( exLevels ) );

/* Also see Design, DesignOrd */

/* example that Design Last(...) takes two arguments */
Show( Design Last( 3, {1, 2, 3} ) );
Show( Design( 3, {1, 2, 3} ) );
Show( Design Last( [1 2], {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design Last( exLevels, {1, 2, 3} ) );
Show( Design( exLevels, {1, 2, 3} ) );
Show( Design Last( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

/* example that Design Last(...) takes three arguments */
Show( Design Last( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design Last( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Design Nom](#design-nom)

**Syntax:** y = Design Nom( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for all but the last of the unique values of the argument. The last level is coded as a row of -1s. If the levelsList argument is specified, the last level is the last level in levelsList. Otherwise, the last level is defined as the largest value in v. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design Nom(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design Nom( exLevels ) );
/* see what is different from Design(...) */
Show( Design( exLevels ) );

/* Also see Design, DesignOrd */

/* example that Design Nom(...) takes two arguments */
Show( Design Nom( 3, {1, 2, 3} ) );
Show( Design( 3, {1, 2, 3} ) );
Show( Design Nom( [1 2], {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design Nom( exLevels, {1, 2, 3} ) );
Show( Design( exLevels, {1, 2, 3} ) );
Show( Design Nom( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

 /* example that Design Nom(...) takes three arguments */
Show( Design Nom( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design Nom( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Design Ord](#design-ord)

**Syntax:** y = Design Ord( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column for all but the last of the unique values of the argument. The first level is coded as a row of 0s. Each subsequent (nth) level in the levelsList argument is coded as a row of (n-1) 1s and the rest 0s. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that Design Ord(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( Design Ord( exLevels ) );
/* see what is different from Design Nom(...) */
Show( Design Nom( exLevels ) );

/* Also see Design, Design Nom */

/* example that Design Ord(...) takes two arguments */
Show( Design Ord( 3, {1, 2, 3} ) );
Show( Design Nom( 3, {1, 2, 3} ) );
Show( Design Ord( [1 2], {1, 2, 3} ) );
Show( Design Nom( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( Design Ord( exLevels, {1, 2, 3} ) );
Show( Design Nom( exLevels, {1, 2, 3} ) );
Show( Design Ord( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design Nom( {"a", "b"}, {"a", "b", "c"} ) );

/* example that Design Ord(...) takes three arguments */
Show( Design Ord( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( Design Ord( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [DesignF](#designf)

**Syntax:** y = DesignF( v, < levelsList|\<<Levels, \<<ElseMissing > )

**Description:** Creates a design matrix that contains a column of 1s and 0s for all but the last of the unique values of the argument. The last level is coded as a row of -1s. If the levelsList argument is specified, the last level is the last level in levelsList. Otherwise, the last level is defined as the largest value in v. If the \<<Levels argument is specified, the return value is a list that contains the design matrix and a list of the levels. If the \<<ElseMissing argument is specified, missing values are placed in the design matrix for values in the v argument that do not appear in the levelsList. Otherwise, 0s are placed in the design matrix.

**JMP Version Added:** Before version 14

```

/* example that DesignF(...) takes one argument */
exLevels = [1, 2, 3, 2, 1];
Show( DesignF( exLevels ) );
/* see what is different from Design(...) */
Show( Design( exLevels ) );

/* Also see Design, DesignOrd */

/* example that DesignF(...) takes two arguments */
Show( DesignF( 3, {1, 2, 3} ) );
Show( Design( 3, {1, 2, 3} ) );
Show( DesignF( [1 2], {1, 2, 3} ) );
Show( Design( [1 2], {1, 2, 3} ) );
exLevels = [1, 2, 3, 2, 1, 2, 3];
Show( DesignF( exLevels, {1, 2, 3} ) );
Show( Design( exLevels, {1, 2, 3} ) );
Show( DesignF( {"a", "b"}, {"a", "b", "c"} ) );
Show( Design( {"a", "b"}, {"a", "b", "c"} ) );

/* example that DesignF(...) takes three arguments */
Show( DesignF( [1, 2, 3, 4, 5], {1, 2, 3, 4}, <<ElseMissing ) );
Show( DesignF( [1, 2, 3, 4, 5], {1, 2, 3, 4} ) );


```

### [Det](#det)

**Syntax:** y = Det( x )

**Description:** Returns the determinant of a square matrix.

**JMP Version Added:** Before version 14

```

Det( [11 22, 33 44] );


```

### [Diag](#diag)

**Syntax:** y = Diag( matrix ); y = Diag( vector ); y = Diag( matrix1, matrix )

**Description:** Constructs a diagonal matrix from either a matrix or a vector. If two arguments are specified, the function returns the concatenation of the matrices diagonally.

**JMP Version Added:** Before version 14

```

Diag( [11 22] );


```

### [Direct Product](#direct-product)

**Syntax:** y = Direct Product( A, B )

**Description:** Returns the direct or Kronecker product. Result has A[i,j]\*B, expanding to all possible products.

**JMP Version Added:** Before version 14

```

exA = [1 2, 3 4];
exB = [1 1 1, 2 2 2, 3 3 3];
exProd = Direct Product( exA, exB );
Show( exProd );

/* verify results */
Show( exProd[1 :: 3, 1 :: 3] == exB );
Show( exProd[4 :: 6, 1 :: 3] == (exB * 3) );
Show( exProd[1 :: 3, 4 :: 6] == (exB * 2) );
Show( exProd[4 :: 6, 4 :: 6] == (exB * 4) );

/* Also see H Direct Product */


```

### [Distance](#distance)

**Syntax:** y = Distance( x1, x2, <scales>, <powers> )

**Description:** Produces a matrix of distances between rows of x1 and rows of x2. To customize the scaling and powers for each column, specify the extra arguments scale and powers. For Kriging, Exp(-distance(x1,x2)) is used.

**JMP Version Added:** Before version 14

```

/*1-D example*/
exX1 = [1, 2, 3, 4];
exX2 = [2, 4, 6, 8]; 
/*Compute squared Euclidean distance*/
exD = Distance( exX1, exX2 ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum( (exX1[exi, 0] - exX2[exj, 0]) ^ 2 )
    )
);
Show( exDm == exD ); 

/*2-D example*/
exX1 = [1 1, 2 2, 3 3, 4 4];
exX2 = [2 1, 4 2, 6 0, 8 7]; 
/*Compute squared Euclidean distance*/
exD = Distance( exX1, exX2 ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum( (exX1[exi, 0] - exX2[exj, 0]) ^ 2 )
    )
);
Show( exDm == exD ); 

/*2-D example*/
exX1 = [1 1, 2 2, 3 3, 4 4];
exX2 = [2 1, 4 2, 6 0, 8 7]; 
/*Compute squared Euclidean distance, with a scaler [0.5 2.0]*/
exD = Distance( exX1, exX2, [0.5 2.0] ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum( [0.5 2.0] :* (Abs( exX1[exi, 0] - exX2[exj, 0] ) ^ 2) )
    )
);
Show( exDm == exD ); 

/*2-D example*/
exX1 = [1 1, 2 2, 3 3, 4 4];
exX2 = [2 1, 4 2, 6 0, 8 7]; 
/*Compute squared Euclidean distance, with scalers [0.5 2.0] and powers [1.5 2.0]*/
exD = Distance( exX1, exX2, [0.5 2.0], [1.5 2.0] ); 
/*Verify result*/
exDm = J( 4, 4, . );
For( exi = 1, exi <= 4, exi++,
    For( exj = 1, exj <= 4, exj++,
        exDm[exi, exj] = Sum(
            [0.5 2.0] :* (Abs( exX1[exi, 0] - exX2[exj, 0] ) :^ [1.5 2.0])
        )
    )
);
Show( exDm == exD );


```

### [E Div](#e-div)

**Syntax:** y = A :/ B; y = E Div( A, B )

**Description:** Returns an element-wise division of matrices.

**JMP Version Added:** Before version 14

```

[11 22 33] :/ [1 2 3];


```

### [E Max](#e-max)

**Syntax:** y = E Max( A, B )

**Description:** Returns a matrix that is the maximum of corresponding elements of its arguments.

**JMP Version Added:** 16

```

E Max( [1 22 33], [11 2 3] );


```

### [E Min](#e-min)

**Syntax:** y = E Min( A, B )

**Description:** Returns a matrix that is the minimum of corresponding elements of its arguments.

**JMP Version Added:** 16

```

E Min( [1 22 33], [11 2 3] );


```

### [E Mult](#e-mult)

**Syntax:** y = A :\* B; y = E Mult( A, B )

**Description:** Returns an element-wise multiplication of matrices.

**JMP Version Added:** Before version 14

```

[1 2 3] :* [11 22 33];


```

### [Eigen](#eigen)

**Syntax:** {M, E} = Eigen( X )

**Description:** Performs eigenvalue decomposition of symmetric matrix X. Returns list {M, E} such that E\*Diag(M)\*E\` = X.

**JMP Version Added:** Before version 14

```

X = [11 22, 22 33];
{M, E} = Eigen( X );
E * Diag( M ) * E`;


```

### [Eigen BLAS](#eigen-blas)

**Syntax:** z = Eigen BLAS( X, \<nvec = ncol> )

**JMP Version Added:** 17

```

X = [5 4 1 1, 4 5 1 1, 1 1 4 2, 1 1 2 4];
{M1, E1} = Eigen BLAS( X );


```

### [Estimate Bartlett Factor Score](#estimate-bartlett-factor-score)

**Syntax:** {factorScores} = Estimate Bartlett Factor Score( dataRow , mvMeanVec, lvMeanVec, modSRAM, modARAM )

**Description:** Estimates factor scores, using Bartlett's method, from a structural equation model (SEM). The input arguments are a row vector of data, the model-implied means for the manifest variables, the model-implied means for the latent variables, the S RAM matrix from an SEM, and the A RAM matrix from an SEM. It returns a row vector with estimated factor scores based on the SEM.

**JMP Version Added:** 16

```

Estimate Bartlett Factor Score(
    [2 2 0],
    [2.085 2.76 1.56],
    [0],
    [1 0 0 0 0,
    0 0.684181992749 0 0 0,
    0 0 1.19686444665695 0 0,
    0 0 0 0.875198112795068 0,
    0 0 0 0 0.953592961124492],
    [0 0 0 0 0,
    2.085 0 0 0 1,
    2.76 0 0 0 0.61913203807175,
    1.56 0 0 0 0.710365935511608,
    0 0 0 0 0]
);


```

### [Estimate Factor Score](#estimate-factor-score)

**Syntax:** {factorScores} = Estimate Factor Score( dataRow , modImpVarCov, mvMeanVec, lvMeanVec )

**Description:** Estimates factor scores, using the regression method, from a structural equation model (SEM). The input arguments are a row vector of data, a model-implied variance-covariance matrix, a vector of model-implied manifest variable means, and a vector of model-implied latent variable means. It returns a row vector with estimated factor scores based on the SEM.

**JMP Version Added:** 15

```

Estimate Factor Score(
    [7 10 5 2 2 0],
    [1.66 0.45 0.58 -0.58 -0.44 -0.5 0.59 -0.58,
    0.45 1.22 0.44 -0.44 -0.33 -0.38 0.45 -0.44,
    0.58 0.44 1.88 -0.57 -0.43 -0.49 0.58 -0.57,
    -0.58 -0.44 -0.57 1.64 0.57 0.65 -0.58 0.76,
    -0.44 -0.33 -0.43 0.57 1.56 0.49 -0.44 0.57,
    -0.5 -0.38 -0.49 0.65 0.49 1.36 -0.5 0.65,
    0.59 0.45 0.58 -0.58 -0.44 -0.5 0.59 -0.58,
    -0.58 -0.44 -0.57 0.76 0.57 0.65 -0.58 0.76],
    [6.59, 8.81, 2.92, 2.09, 2.76, 1.56],
    [0, 0]
);


```

### [Fourier Basis Coef](#fourier-basis-coef)

**Syntax:** coef = Fourier Basis Coef( x, Number Pairs, \<Period = max(x)-min(x)+1> )

**Description:** Returns the matrix of Fourier Basis coefficients. Number Pairs is the number of sin() and cos() pairs for the basis. Optional parameter Period specifies the period for the trigonometric functions and defaults to max(x) - min(x) + 1.

**JMP Version Added:** 14

```

Fourier Basis Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] / 10, 2 );
Fourier Basis Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10] / 10, 2, 2 );


```

### [G Inverse](#g-inverse)

**Syntax:** g = G Inverse( A )

**Description:** Returns the generalized (Moore-Penrose) matrix inverse.

**JMP Version Added:** Before version 14

```

Round( G Inverse( [11 22, 33 44] ), 2 );


```

### [H Direct Product](#h-direct-product)

**Syntax:** y = H Direct Product( A, B )

**Description:** Returns the horizontal direct product, which is the direct product of each row of matrices A and B.

**JMP Version Added:** Before version 14

```

exA = [1 2, 3 4];
exB = [1 1 1, 2 2 2];
exProd = H Direct Product( exA, exB );
Show( exProd );

/* verify result */
Show( exProd[1, 1 :: 6] == Direct Product( exA[1, 1 :: 2], exB[1, 1 :: 3] ) );
Show( exProd[2, 1 :: 6] == Direct Product( exA[2, 1 :: 2], exB[2, 1 :: 3] ) );


```

### [Hadamard](#hadamard)

**Syntax:** y = Hadamard( n, \<normalize = 0> )

**Description:** Creates a Hadamard matrix of order n.

**JMP Version Added:** 15

```

Show( Hadamard( 12 ), Hadamard( 12, 1 ) );


```

### [Hough Line Transform](#hough-line-transform)

**Syntax:** accum = Hough Line Transform( matrix, \<NAngle(number)> \<NRadius(number)> )

**Description:** Returns the Hough transform for detecting lines in image data

**JMP Version Added:** Before version 14

**Example 1**

```

xx = .4;
yy = .4;
angleDegrees = (1 :: 180)`;
angle = Pi() * angleDegrees / (180);
New Window( "Hough Transform Demo 1",
    Border Box( Left( 20 ), Top( 20 ), Right( 15 ), Bottom( 15 ),
        V List Box(
            Text Box( "Click and drag the circle in a straight line." ),
            Graph Box(
                X Scale( -1, 1 ),
                Y Scale( -1, 1 ),
                Circle( {xx, yy}, .05 );
                Text( {xx + .1, yy + .1}, Char( xx, 4 ) || " " || Char( yy, 4 ) );
                Mousetrap(
                    xx = x;
                    yy = y;
                    gb << reshow;
                );
            ),
            Text Box( "For angle 1 to 180 , x*Cos(angle)+y*Sin(angle)" ),
            Text Box( "What position stays constant as you move?" ),
            gb = Graph Box(
                X Scale( 0, 180 ),
                XName( "Angle" ),
                Y Scale( -1.5, 1.5 ),
                YName( "Distance to Line" ),
                Line( angleDegrees, xx * Cos( angle ) + yy * Sin( angle ) )
            )
        )
    )
);


```

**Example 2**

```

nRow = 35;
nCol = 35;

// Make a wafer template missing outside a radius
waferTemplate = J( nRow, nCol, 0 );
If( 0,
    For( i = 1, i <= nRow, i++,
        For( j = 1, j <= nCol, j++,
            If( (i - nrow / 2) ^ 2 + (j - nCol / 2) ^ 2 > ((nRow + nCol) / 4) ^ 2,
                waferTemplate[i, j] = .
            )
        )
    )
);
wafer = waferTemplate;
wafer[5, 22] = 1;
lightGray = RGB Color( .9, .9, .9 );
showWafer = Expr(
    For( i = 1, i <= nRow, i++,
        For( j = 1, j <= nCol, j++,
            z = wafer[i, j];
            If( Is Missing( z ),
                Continue()
            );
            Fill Color( If( z == 0, lightGray, 3 ) );
            Rect( i - nrow / 2, j - nCol / 2, i - nrow / 2 - 1, j - nCol / 2 + 1, 1 );
        )
    )
);
showHough = Expr(
    accum = Hough Line Transform( wafer );
    maxAccum = Max( Max( accum ), 1 );
    accumHeat = Heat Color( accum / maxAccum );
    nr = N Row( accum );
    nc = N Col( accum );
    For( i = 1, i <= nr, i++,
        For( j = 1, j <= nc, j++,
            z = accumHeat[i, j];
            Fill Color( z );
            Rect( j - 1, nr - i, j, nr - i + 1, 1 );
        )
    );
    //Marginals
    radiusDensity = V Max( accum` );
    radiusScale = 3 * Max( radiusDensity ) / Mean( radiusDensity );
    radiusColor = Heat Color( radiusDensity / radiusScale );
    If( 1,
        angleDensity = V Max( accum );
        angleScale = 3 * Max( angleDensity ) / Mean( angleDensity );
        angleColor = Heat Color( angleDensity / angleScale );
    ,
        angle1 = angleDensity - Mean( angleDensity );
        angle1 = angle1 :* (angle1 > 0);
        angleColor = Heat Color( angle1 / Max( angle1 ) );
    );
    For( j = 1, j <= nc, j++,
        Fill Color( angleColor[j] );
        Rect( j - 1, -5, j, -8, 1 );
    );
    For( i = 1, i <= nr, i++,
        Fill Color( radiusColor[i] );
        Rect( 185, nr - i, 190, nr - i + 1, 1 );
    );
);
mouseAction = Expr(
    i = Floor( x + nrow / 2 + .5 );
    j = Floor( y + ncol / 2 + .5 );
    If( i > 0 & i <= nRow & j > 0 & j <= nCol,
        wafer[i, j]
        ++);
    bothBox << reshow;
);
New Window( "Hough Transform Demo 2",
    Border Box( Left( 15 ), Top( 15 ), Right( 10 ), Bottom( 10 ),
        bothBox = V List Box(
            Text Box( "Click to add points in the top frame along a slanted line." ),
            Text Box( "The Hough transform is shown below with marginal densities." ),
            Text Box( "" ),
            H List Box(
                Button Box( "Clear",
                    wafer = waferTemplate;
                    bothBox << Reshow;
                ),
                Button Box( "Add Random",
                    wafer = wafer | J( nRow, nCol, Random Uniform() < .05 );
                    bothBox << Reshow;
                )
            ),
            waferBox = Graph Box(
                X Scale( -18, 18 ),
                Y Scale( -18, 18 ),
                FrameSize( 300, 300 ),
                XName( "Angle" ),
                YName( "Radius" ),
                Mousetrap( mouseAction ),
                showWafer
            ),
            houghBox = Graph Box(
                X Scale( 0, 190 ),
                Y Scale( -10, 50 ),
                FrameSize( 500, 200 ),
                showHough
            )
        )
    )
);


```

### [Identity](#identity)

**Syntax:** y = Identity( n )

**Description:** Creates an n-by-n identity matrix, with ones on diagonal, zeros elsewhere.

**JMP Version Added:** Before version 14

```

Identity( 2 );


```

### [Index](#index)

**Syntax:** ii = n1::n2; ii = n1::n2::n3; ii = Index( n1, n2, \<n3=1>)

**Description:** Returns a row matrix that contains the sequence of values from n1 to n2 by increments of n3.

**JMP Version Added:** Before version 14

```

1 :: 10;


```

### [Inner Product BLAS](#inner-product-blas)

**Syntax:** y = Inner Product BLAS( A, B, ... )

**JMP Version Added:** 17

```

a = [1, 2, 3, -2, 0, -1, 0, 1, 1];
b = [4, 5, 6, -2, 0, -1, 0, 7, 2];
y = Inner Product BLAS( a, b );


```

### [Inv](#inv)

**Syntax:** y = Inverse( x ); y = Inv( x )

**Description:** Returns the inverse of the x argument, which must be a square non-singular matrix.

**JMP Version Added:** Before version 14

```

Round( Inverse( [11 22, 33 44] ), 2 );


```

### [Inv Update](#inv-update)

**Syntax:** y = Inv Update( S, X, \<w=1> )

**Description:** Returns an updated inverse matrix, where the first argument S is a symmetric positive definite matrix with the same number of columns as X, the second argument X is a matrix that contains the rows to add or delete, and the third argument w determines whether to add or delete rows (use 1 to add rows and -1 to delete rows). This function evaluates as S-w\*S\*X`\*Inv(I+w\*X\*S\*X`)\*X\*S, where I is an identity matrix and Inv(A) means an inverse matrix of A.

**JMP Version Added:** Before version 14

```

/* Generate a design matrix */
exX = [1 0 4 2,
1 0 5 1,
1 0 2 4,
5 4 4 5,
0 1 4 3,
0 1 9 1,
0 1 2 4,
0 1 1 9,
0 1 5 2,
0 1 2 1,
0 1 4 5];
S = Inverse( exX` * exX );
Show( "----------Adding Rows (w=1) --------" );
X = [5 4 3 3, 4 3 2 1, 9 1 2 5];
w = 1;
y = Inv Update( S, X, w );
Show( "Result of Inv Update" );
Show( y );
Show( "Result of updating formula" );
Show( S - w * S * X` * Inv( Identity( N Row( X ) ) + w * X * S * X` ) * X * S );
Show( "Result of direct calculation" );
Show( Inverse( (exX |/ X)` * (exX |/ X) ) );
Show( "----------Deleting Rows (w=-1) --------" );
X = [0 1 5 2, 0 1 2 1, 0 1 4 5];
w = -1;
y = Inv Update( S, X, w );
Show( "Result of Inv Update" );
Show( y );
Show( "Result of updating formula" );
Show( S - w * S * X` * Inv( Identity( N Row( X ) ) + w * X * S * X` ) * X * S );
Show( "Result of direct calculation" );
p = N Row( exX ) - 3;
Show( Inverse( exX[Index( 1, p ), 0]` * exX[Index( 1, p ), 0] ) );


```

### [Inverse](#inverse)

**Syntax:** y = Inverse( x ); y = Inv( x )

**Description:** Returns the inverse of the x argument, which must be a square non-singular matrix.

**JMP Version Added:** Before version 14

```

Round( Inverse( [11 22, 33 44] ), 2 );


```

### [Is Matrix](#is-matrix)

**Syntax:** y = Is Matrix( x )

**Description:** Returns 1 if the argument is a matrix, 0 otherwise.

**JMP Version Added:** Before version 14

```

Is Matrix( [11 22 33] );


```

### [J](#j)

**Syntax:** y = J( nr, <nc>, <v> ); y = J( nr, nc ); y = J( n )

**Description:** Creates a matrix (nr by nc) of values that are determined by the third argument. The default value of the second argument equals the first argument. The default value of the third argument is 1. But the third argument can be a number, a variable name of a number, or JSL code. If the third argument is code, the code is evaluated and assigned the return value to every element in the matrix, element by element, row by row.

**JMP Version Added:** Before version 14

```


// Produce a 2x3 matrix, filled with 15.
m = J( 2, 3, 15 );
// Produce a default 4x4 matrix, filled with 1.
m = J( 4 );
// Produce a 2x3 matrix, filled with a number determined by a variable.
a = 3.14;
m = J( 2, 3, a );
// Produce a vector of random numbers from the Uniform distribution.
m = J( 1, 100, Random Uniform() );
// Produce a 2x3 matrix, filled with a sequence of integers.
a = 0;
m = J( 2, 3, a = a + 1 );
// This is a fun example to illustrate what is possible for the third argument.
i = 1;
J(
    10,
    1,
    Print(
        Eval Insert(
            "For the ^i^^if(i < 4, words(\!"st,nd,rd\!",\!",\!")[i], \!"th\!")^ time, I'm not a loop!"
        )
    );
    Round( 1 / Sqrt( 5 ) * ((1 + Sqrt( 5 )) / 2) ^ i++ );
);


```

### [KDTable](#kdtable)

**Syntax:** tab = KDTable( [ 1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6 ] )

**Description:** Returns a table for efficiently looking up near neighbors. The matrix arguments are k-dimensional points. There is no built in limit on the number of dimensions or points.

**JMP Version Added:** Before version 14

```

tab = KDTable( [1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6] );
{rows, dist} = tab << K nearest rows( 2, 1 );
"2 nearest rows to row 1 are " || Char( rows );


```

### [Least Squares Solve](#least-squares-solve)

**Syntax:** {Beta, VarBeta} = Least Squares Solve(y, X, \<<noIntercept, \<<weights(optionalWeightVector), \<<method("Sweep"|"GInv"))

**Description:** Returns a list that contains a vector of estimates, Beta = Inverse(X'X)X'y, and the estimated variance matrix of Beta. The optional \<<noIntercept argument specifies a no-intercept model. The optional \<<weights argument specifies a vector of weights to perform weighted least squares. The optional \<<method argument enables you to choose between the default Sweep method and a generalized inverse ("GInv") method for solving the normal equations.

**JMP Version Added:** Before version 14

```

/*Simple Linear Regression*/
y = [3, 5, 7, 5];
X = [1, 2, 3, 4];
{Beta, VarBeta} = Least Squares Solve( y, X );


```

### [Linear Regression](#linear-regression)

**Syntax:** {Estimates, Std_Error, Diagnostics} = Linear Regression(y, X, \<<noIntercept, \<<printToLog, \<<weight(WeightVector), \<<freq(FrequencyVector)

**Description:** Fits a linear regression for the assumed model y = X * beta + error. The optional \<<noIntercept argument specifies a no-intercept model. The optional \<<printToLog argument specifies that a summary of fit is printed to the log window. The optional weight argument specifies a vector of weights to perform weighted least squares, and the optional freq argument specifies a vector of frequencies. Returns a list containing a vector of the estimates, a vector of the standard errors, and a list of diagnostics. The list of diagnostics contains vectors of the t statistics and p-values for the estimates, as well as the R-Square and adjusted R-Square values for the regression fit.

**JMP Version Added:** 14

**Example 1**

```

/*Simple Linear Regression: y = intercept + beta * x + error*/
y = [3, 5, 7, 5];
X = [1, 2, 3, 4];
{Estimates, Std_Error, Diagnostics} = Linear Regression( y, X, <<printToLog ); 
/*
t_ratio = Diagnostics["t_ratio"]; 
p_value = Diagnostics["p_value"]; 
RSquare = Diagnostics["RSquare"]; 
RSquare Adj = Diagnostics["RSquare Adj"];
*/


```

**Example 2**

```

/*Model: y = beta_1*x + beta_2*x^2 + error*/
y = [3, 5, 7, 5];
X = [1 1, 2 4, 3 9, 4 16];
{Estimates, Std_Error, Diagnostics} = Linear Regression( y, X, <<noIntercept, <<printToLog );


```

**Example 3**

```

/*Categorical Variable Example*/
/*Model: y = beta_1*boy + beta_2*girl + beta_3*x + error*/
y = [3, 5, 7, 5];
x = [1, 2, 3, 4];
gender = {"boy", "girl", "girl", "boy"};
designMat = Design( gender ) || x;
{Estimates, Std_Error, Diagnostics} = Linear Regression(
    y,
    designMat,
    <<noIntercept,
    <<printToLog
);


```

### [Loc](#loc)

**Syntax:** y = Loc( m ); y = Loc( v, x )

**Description:** Returns a matrix of the positions of the matrix m that are nonzero.If two arguments are specified, Loc(v, x) returns a matrix of the positions of the list or matrix v that are equal to the value x. Prefer Where instead where possible.

**JMP Version Added:** Before version 14

**Example 1**

```

/*more examples, above*/
Show( Loc( [1 0 1 0 1 0] ) );
Show( Loc( {"A", 2, 3, 2, 5, 2, 4, [1 5]}, 2 ) );
Show( Loc( {"A", 2, 3, 2, 5, 2, 4, [1 5]}, [1 5] ) );


```

**Example 2**

```

Loc( [0, -2, 3, 0, 5, ., -7, ., 9] ) /*missing is not zero or non-zero*/;


```

**Example 3**

```

Loc( [5, 7, 5, ., 5], 5 );


```

**Example 4**

```

Loc( [5, 7, 5, ., 5] == 5 ) /*[5,7,5, . ,5]==5   ==>   [1, 0, 1, ., 1]*/;


```

**Example 5**

```

Loc( {"a", "fred", "b", "fred"}, "fred" );


```

### [Loc Max](#loc-max)

**Syntax:** y = Loc Max( x )

**Description:** Returns the first position in x of the maximum value.

**JMP Version Added:** Before version 14

```

Loc Max( [11 22 33 22 33 11] );


```

### [Loc Min](#loc-min)

**Syntax:** y = Loc Min( x )

**Description:** Returns the first position in x of the minimum value.

**JMP Version Added:** Before version 14

```

Loc Min( [11 22 33 22 33 11] );


```

### [Loc Nonmissing](#loc-nonmissing)

**Syntax:** y = Loc Nonmissing( matrixArg,...,{listArg},... )

**Description:** Returns a vector of row numbers in argument matrix rows that have no missing values, or for lists, those that are nonmissing numbers or nonempty character.

**JMP Version Added:** Before version 14

```

Loc Nonmissing( [1 2 3, 4 . 6, 7 8 ., 8 7 6] );


```

### [Loc Sorted](#loc-sorted)

**Syntax:** idx = Loc Sorted( x, y )

**Description:** Creates a column vector of subscript positions where the values of x have values less than or equal to the values in y based on a binary search. x must be a matrix sorted in ascending order without missing values.

**JMP Version Added:** Before version 14

```

Show(
    Loc Sorted( [11 22 33 44 55], [11 33 55] ),
    Loc Sorted( [11 22 33 44 55], [1] ),
    Loc Sorted( [11 22 33 44 55], [500] )
);


```

### [Low Rank Symmetric Update BLAS](#low-rank-symmetric-update-blas)

**Syntax:** y = Low Rank Symmetric Update BLAS( A, U, s )

**JMP Version Added:** 17

```

A = [2 0, 0 2];
U = [2 4, 3 5];
s = 2.5;
AUpdate = Low Rank Symmetric Update BLAS( A, U, s );


```

### [Matrix](#matrix_1)

**Syntax:** y = Matrix( {{x11, ..., x1m}, {...}, {xn1, ..., xnm}} ) y = Matrix( {x1, ..., xn} ) y = Matrix( n, m )

**Description:** Constructs an n-by-m matrix. If you specify a list of n lists that each contain m row values, the matrix is formed by vertically concatenating the evaluated lists. If you specify a single list of n items, the return value is an n-by-1 column vector. If you specify two integer arguments, the return value is a matrix of zeros that contains n rows and m columns.

**JMP Version Added:** Before version 14

**Example 1**

```

Matrix( {{11, 22, 33}, {44, 55, 66}} );


```

**Example 2**

```

Matrix( {{[1 2 3], 4, 5, 6, 7, 8, 9}} );


```

**Example 3**

```

Matrix( {2, 3 + 7} );


```

**Example 4**

```

Matrix( 2, 3 );


```

### [Matrix Mult](#matrix-mult)

**Syntax:** y = Matrix Mult( A, B, ... ); y = A * B

**Description:** Performs matrix multiplication. The matrix arguments must be conformable: NCol(a)==NRow(b). Note that A * B also works.

**JMP Version Added:** Before version 14

```

exMatA = [1 2 3, -2 0 -1, 0 1 1];
exMatB = [1 2, 1 2, 1 2];
exMatM1 = exMatA * exMatB;
exMatM2 = Matrix Mult( exMatA, exMatB );
exMatC = [1 2, 1 2];
exMatM3 = Matrix Mult( exMatA, exMatB, exMatC );
Show( exMatM1 );
Show( exMatM2 );
Show( exMatM3 );


```

### [Matrix Mult BLAS](#matrix-mult-blas)

**Syntax:** y = Matrix Mult BLAS( A, B, ... )

**Description:** Performs matrix multiplication. The matrix arguments must be conformable: NCol(A)==NRow(B).

**JMP Version Added:** 17

```

exMatA = [1 2 3, -2 0 -1, 0 1 1];
exMatB = [1 2, 1 2, 1 2];
exMatM2 = Matrix Mult BLAS( exMatA, exMatB );


```

### [Matrix Rank](#matrix-rank)

**Syntax:** r = Matrix Rank( X )

**Description:** Returns the rank of the matrix X.

**JMP Version Added:** 14

```

Matrix Rank( [1 0 0, 0 1 0, 0 1 0] );


```

### [Mode](#mode)

**Syntax:** y = Mode( list or matrix )

**Description:** Picks the 'most frequent' item from a matrix or list, the lower value for ties

**JMP Version Added:** Before version 14

```

Show( Mode( [1, 2, 3, 2, 1] ), Mode( {"a", "b", "c", "b", "a", "b"} ) );


```

### [Multivariate Normal Impute](#multivariate-normal-impute)

**Syntax:** y = Multivariate Normal Impute( yVec, meanYvec, symCovMat, colMin, colMax )

**Description:** Returns a response vector with imputed values for the missing values in the yVec vector of responses. Imputations are based on a multivariate normal distribution with mean vector meanYvec and symmetric covariance matrix symCovMat. Optional arguments colMin and colMax are the respective vectors of column minimums and maximums. These arguments provide bounds for the imputations.

**JMP Version Added:** Before version 14

```

mat = [0.430735257211985 -0.935632420013493 . 0.424649913158299,
. -0.687720061441453 0.29665732536624 -1.94898001941576,
-0.0425472526673373 0.463229145080277 0.635619352779951 .];
cov = Covariance( mat, <<"Pairwise"/*, <<"shrink"*/ );
colMean = V Mean( mat );
colMin = V Min( mat );
colMax = V Max( mat );
For( it = 1, it <= N Row( mat ), it++,
    mat[it, 0] = Multivariate Normal Impute( mat[it, 0], colMean, cov, colMin, colMax )`
);
Print( mat );


```

### [N Col](#n-col)

**Syntax:** y = N Col(); y = N Col( dataTable ); y = N Col( matrix )

**Description:** Returns the number of columns in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Col( [11 22, 33 44] );


```

### [N Cols](#n-cols)

**Syntax:** y = N Cols(); y = N Cols( dataTable ); y = N Col( matrix )

**Description:** Returns the number of columns in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Col( [11 22, 33 44] );


```

### [NChooseK Matrix](#nchoosek-matrix)

**Syntax:** m = NChooseK Matrix( n, k )

**Description:** Creates a matrix of nChooseK(n,k) rows and k columns forming all the combinations of k integers from 1 to n.

**JMP Version Added:** Before version 14

```

Print( NChooseK Matrix( 5, 3 ) );


```

### [Ortho](#ortho)

**Syntax:** L = Ortho( A, \<Centered( 1 )>, \<Scaled( 1 )> )

**Description:** Orthogonalizes the columns of a matrix. Center option makes them sum to zero. Scale option makes them unit length.

**JMP Version Added:** Before version 14

```

Ortho( [1 1, 1 -1] );


```

### [Ortho Poly](#ortho-poly)

**Syntax:** L = Ortho Poly( V, order )

**Description:** Returns orthogonal polynomials of vector V up to order specified by the order argument. The V argument can be a row or column vector. Scale option makes them unit length.

**JMP Version Added:** Before version 14

```

Ortho Poly( 1 :: 10, 2 );


```

### [P Spline Coef](#p-spline-coef)

**Syntax:** coef = P Spline Coef( x, Internal Knot Grid, \<degree = 3>, \<KnotEndPoints = min(x) || max(x)> )

**Description:** Returns the matrix of P-Spline coefficients. Internal Knot Grid is either the number of desired knot points based on percentiles of x or a vector specifying the internal knot points. Optional parameter degree specifies the degree of the P-splines with a default of 3.

**JMP Version Added:** 14

```

P Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], 2 );
P Spline Coef( [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10], [3, 7] );


```

### [Parallel Assign](#parallel-assign)

**Syntax:** tf = ParallelAssign( { thread_local_var = global_var, ... }, m[ a, b ] = expression using a and b )

**Description:** Use multiple threads to assign values to the matrix. If any thread throws an exception, a message will be printed to the log and the return value will be 0. If all threads complete without error, the return value will be 1. Functions that launch platforms, create or use data tables, or access the graphics subsystem are only supported on the main thread, and will throw an exception if called from a worker thread.

**JMP Version Added:** Before version 14

```

m = J( 3, 2, -1 );
If( Parallel Assign( {/*no locals */ }, m[a/* 1,2,3 */, b/* 1,2 */ ] = a * a + b ) == 0,
    Throw( "thread failed" )
);
m;/* 1*1+1  1*1+2, 2*2+1  2*2+2, 3*3+1  3*3+2 */


```

### [Print Matrix](#print-matrix)

**Syntax:** s = Print Matrix( M, \<<ignore locale( 0 ), \<<style( "parseable" ), \<<separate( ", " ), \<<line begin( "[ " ), \<<line end( " ]" ) )

**Description:** Prints the matrix M. The optional argument ignore locale determines whether the printing of decimal separators should respect Locale information, where zero means to respect Locale. The optional argument style determines whether to use a style and which style to use. The available styles are parseable, which is a reformatted JSL matrix expression, latex, and other. When the style argument is other, the last three optional arguments define the beginning and ending characters of printed rows and separating characters of concatenated entries.

**JMP Version Added:** Before version 14

```

A = [3.509 0.003, 874.4 0.00384, 0.03 0.093];
Print Matrix( A );
Print Matrix( A, <<ignore locale( 1 ) );
Print Matrix( A, <<style( "latex" ) );
Print Matrix(
    A,
    <<style( "other" ),
    <<line begin( "| " ),
    <<line end( " |" ),
    <<separate( " | " )
);


```

### [QR](#qr)

**Syntax:** {Q, R} = QR( X )

**Description:** Creates an m by m orthogonal matrix Q and an m by n upper triangular matrix R, such that X = Q * R. The argument X is an m by n matrix.

**JMP Version Added:** Before version 14

```

QR( [11 22, 33 44] );


```

### [QR LAPACK](#qr-lapack)

**Syntax:** {Q, R} = QR LAPACK( X )

**Description:** Creates an m by k orthogonal matrix Q and a k by n upper triangular matrix R, such that X = Q * R. The argument X is an m by n matrix, where k is min(m, n).

**JMP Version Added:** 17

```

QR LAPACK( [11 22, 33 44] );


```

### [Quadratic Form BLAS](#quadratic-form-blas)

**Syntax:** y = Quadratic Form BLAS( A, x )

**JMP Version Added:** 17

```

A = [2 0, 0 2];
x = [2, 3];
y = Quadratic Form BLAS( A, x );


```

### [Random SVD](#random-svd)

**Syntax:** {U, M, V} = Random SVD( X , \<nSingularValues=min(nRow,nCol)>, \<nOver=10>, \<nIter=2>)

**Description:** Computes the singular value decomposition of matrix X using the randomized singular value decomposition by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** 17

```

Random SVD( [11 22, 33 44], 1 );


```

### [Rank](#rank)

**Syntax:** y = Rank Index( x )

**Description:** Returns a vector of indices that, used as a subscript to the original vector v, sorts the vector by rank. Excludes missing values.

**JMP Version Added:** Before version 14

```

Rank( [33, 22, 44, 11, ., 33] );


```

### [Rank Index](#rank-index)

**Syntax:** y = Rank Index( x )

**Description:** Returns a vector of indices that, used as a subscript to the original vector v, sorts the vector by rank. Excludes missing values.

**JMP Version Added:** Before version 14

```

Rank Index( [33, 22, 44, 11, ., 33] );


```

### [Ranking](#ranking)

**Syntax:** y = Ranking( x, < \<<tie("average"|"row"|"minimum"|"maximum"|"arbitrary")> )

**Description:** Returns a vector of ranks of the values of x, low to high as 1 to n, ties arbitrary.

**JMP Version Added:** Before version 14

```

Ranking( [33, 22, 44, 11, 33] );
Ranking( [22, 11, 33, 11, 44, 55, 44, 44, 44], <<Tie( "minimum" ) );


```

### [Ranking Tie](#ranking-tie)

**Syntax:** y = Ranking Tie( x, < \<<tie("average"|"row"|"minimum"|"maximum"|"arbitrary")> )

**Description:** Returns a vector of ranks of the values of x, but ranks for ties averaged.

**JMP Version Added:** Before version 14

```

Ranking Tie( [33, 22, 44, 11, 33] );


```

### [Robust PCA](#robust-pca)

**Syntax:** {A,E} = Robust PCA( X , \<Lambda(2/sqrt(max(nrow,ncol)))>, \<tolerance=1e-10>,\<maxit(75)>,\<Center(1)>,\<Scale(1)>

**Description:** Robustly decomposes data into a low-rank matrix and a sparse matrix of residuals. Outliers are detected in the residuals. It can also impute missing values.

**JMP Version Added:** 16

```

X = [1 -3, -1 -2, -3 -4, -4 -3, -3 1, 3 3] * [-2 5 -1 -2 1, 4 5 -4 -3 1];
X[2, 3] += 15;
Result = Robust PCA( X, Center( 0 ), Scale( 0 ), Lambda( .80 ) );


```

### [SVD](#svd)

**Syntax:** {U, M, V} = SVD( X )

**Description:** Computes the singular value decomposition of matrix X by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** Before version 14

```

SVD( [11 22, 33 44] );


```

### [SVD LAPACK](#svd-lapack)

**Syntax:** {U, M, V} = SVD LAPACK( X )

**Description:** Computes the singular value decomposition of matrix X by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** 17

```

SVD LAPACK( [11 22, 33 44] );


```

### [Scoring Impute](#scoring-impute)

**Syntax:** {imputedRow} = Scoring Impute ( rowWithMissing , VMat, colMeanVec, colStdDevVec)

**Description:** Provides streaming functionality for the Automated Data Imputation (ADI) algorithm. The input arguments are a row vector that contains missing values, a loading matrix (also called the V matrix) that is produced by the ADI algorithm, a vector of the column means ignoring missing cells, and a vector of the column standard deviations ignoring missing cells. It returns the row vector with the missing values imputed using least squares estimation.

**JMP Version Added:** 14

```

Scoring Impute(
    [1 2 3 . 4 .],
    [.5 .6, .3 .4, .1 .2, .6 .7, .3 .3, .5 .4],
    [0, 0, 0, 0, 0, 0],
    [1, 1, 1, 1, 1, 1]
);


```

### [Shape](#shape)

**Syntax:** r = Shape( M, nr, <nc>, \<<bycol)

**Description:** Reshapes the M matrix or scalar across rows to be nr rows by nc columns. A missing value is permitted for nr. Data from M is replicated as needed to fill the nr by nc matrix. The optional argument \<<bycol fills the data by column. By default, the data is filled by row. Common uses are to reshape a vector into a matrix or to vectorize a matrix.

**JMP Version Added:** Before version 14

```

Eval List(
    {Shape( [11 22, 33 44], 1, 4 ), Shape( [11 22, 33 44], 1 ), Shape( [11 22, 33 44], ., 4 )
    }
);


```

### [Solve](#solve)

**Syntax:** y = Solve( A, B )

**Description:** Solves the linear system A\*x=B for x. The Solve() function is equivalent to Inverse(A)\*B if A is non-singular. Note that the A argument must be a square matrix.

**JMP Version Added:** Before version 14

```

Solve( [1 1, -1 4], [11, 14] );


```

### [Sort Ascending](#sort-ascending)

**Syntax:** y = Sort Ascending( x )

**Description:** Returns a copy of list or matrix x with the items in ascending order.

**JMP Version Added:** Before version 14

```

Sort Ascending( {111, 212, 133, 114, 55} );


```

### [Sort Descending](#sort-descending)

**Syntax:** y = Sort Descending( x )

**Description:** Returns a copy of list or matrix x with the items in descending order.

**JMP Version Added:** Before version 14

```

Sort Descending( {111, 212, 133, 114, 55} );


```

### [Sparse SVD](#sparse-svd)

**Syntax:** {U, M, V} = Sparse SVD( X , \<nSingularValues=min(nRow,nCol)>, \<tolerance=1e-10>)

**Description:** Computes the singular value decomposition of matrix X using the implicitly restarted, partially reorthogonalized Lanczos method for sparse matrices by returning a list {U, M, V} such that U\*diag(M)\*V\` is equal to X.

**JMP Version Added:** Before version 14

```

Sparse SVD( [11 22, 33 44], 1, 1e-8 );


```

### [Spline Coef](#spline-coef)

**Syntax:** coef = Spline Coef( x, y, lambda, <weights> )

**Description:** Returns a five-column matrix of coefficients in the following order: knots||a||b||c||d for each of the unique values in x. The smoothing parameter lambda must be a positive value, where larger values of lambda result in greater stiffness of the spline. The optional weights vector specifies a weight for each value in x. A weight of zero removes the corresponding point from the spline fit.

**JMP Version Added:** Before version 14

```

Spline Eval( 0 :: 10, Spline Coef( 0 :: 10, Sqrt( 0 :: 10 ), 100 ) );


```

### [Spline Eval](#spline-eval)

**Syntax:** yhat = Spline Eval( x, coef, \<extrapolation=-1> )

**Description:** Evaluates the spline predictions using the coef matrix in the same form as returned by the Spline Coef() function. extrapolation indicates how far beyond the spline range, as a fraction of the range, to extend evaluation before returning missing values.

**JMP Version Added:** Before version 14

```


New Window( "Spline Fit",
    window:x = 20 :: 80;
    window:y = 50 + Sin( (20 :: 80) / 10 ) * 40 + J(
        1,
        N Col( window:x ),
        Random Normal( 0, 10 )
    );
    window:loglambda = 2;
    window:g = Graph Box(
        Pen Color( "blue" );
        window:m = Spline Coef( window:x, window:y, Power( 10, window:loglambda ) );
        Marker( window:x, window:y );
        Y Function( Spline Eval( a, window:m, 0.05 ), a );
    );,
    H List Box(
        Text Box( "Lambda: " ),
        Slider Box( -2, 5, window:loglambda, window:g << reshow )
    )
)
;


```

### [Spline Smooth](#spline-smooth)

**Syntax:** yhat = Spline Smooth( x, y, lambda, <weights> )

**Description:** Returns the smoothed predicted values from a spline fit. The smoothing parameter lambda must be a positive value, where larger values of lambda result in greater stiffness of the spline. The optional weights vector specifies a weight for each value in x. A weight of zero removes the corresponding point from the spline fit.

**JMP Version Added:** Before version 14

```

Spline Smooth( 0 :: 10, Sqrt( 0 :: 10 ), 100 );


```

### [Sweep](#sweep)

**Syntax:** y = Sweep( A, <indices> )

**Description:** Returns the sweep of the matrix A on diagonal pivots indicated by indices. This is a way of inverting a matrix one pivot at a time.

**JMP Version Added:** Before version 14

```

exMat = [5 4 1 1, 4 5 1 1, 1 1 4 2, 1 1 2 4];
exMatswp = Sweep( exMat, [1, 2, 3, 4] );
exMatinv = Inverse( exMat );
Show( exMatswp );
Show( exMatinv );


```

### [Sym Matrix Mult BLAS](#sym-matrix-mult-blas)

**Syntax:** y = Sym Matrix Mult BLAS( A, B, ... )

**Description:** Performs matrix multiplication, where A is a symmetric matrix. The matrix arguments must be conformable: NCol(A)==NRow(B).

**JMP Version Added:** 17

```

exMatA = [1 2 3, -2 0 -1, 0 1 1];
exMatA = exMatA` * exMatA;
exMatB = [1 2, 1 2, 1 2];
exMatM2 = Sym Matrix Mult BLAS( exMatA, exMatB );


```

### [Trace](#trace)

**Syntax:** y = Trace( x )

**Description:** Returns the sum of the diagonal elements of a square matrix.

**JMP Version Added:** Before version 14

```

Trace( [11 22, 33 44] );


```

### [Transpose](#transpose)

**Syntax:** y = Transpose( matrix ); y = matrix\`

**Description:** Transposes the matrix argument by interchanging the rows and columns.

**JMP Version Added:** Before version 14

```

Show( Transpose( [11 22, 33 44] ), [11 22, 33 44]` );


```

### [V Concat](#v-concat)

**Syntax:** y = a |/ b; y = V Concat( a, b, ... )

**Description:** Concatenates matrices vertically. Arguments must have same number of columns.

**JMP Version Added:** Before version 14

```

[11 22] |/ [33 44];


```

### [V Concat To](#v-concat-to)

**Syntax:** matrix1 |/= matrix2; V Concat To( matrix1, matrix2 )

**Description:** Concatenates in place, vertically. a |/= b is equivalent to a = a |/ b. This is an assignment operator.

**JMP Version Added:** Before version 14

```

exA = [1 2, 3 4];
exB = [5 6, 7 8, 9 10];
exC = [1, 1, 1, 1, 1];
exD = V Concat To( exA, exB );
exE = Concat( exD, exC );
/* exA is changed and exD is not. */
Show( exA, exB, exC, exD, exE );
/* Also see ConcatTo(), VConcat() */


```

### [V Max](#v-max)

**Syntax:** b = V Max( matrix )

**Description:** Returns a row vector containing the maximum of each column in the argument.

**JMP Version Added:** Before version 14

```

V Max( [11 22, 33 44, 55 66] );


```

### [V Mean](#v-mean)

**Syntax:** m = V Mean( matrix )

**Description:** Returns a row vector containing the mean of each column in the argument.

**JMP Version Added:** Before version 14

```

V Mean( [11 22, 33 44, 55 66] );


```

### [V Median](#v-median)

**Syntax:** m = V Median( matrix )

**Description:** Returns a row vector containing the median of each column in the argument.

**JMP Version Added:** 15

```

V Median( [11 22, 33 44, 35 46, 55 66] );


```

### [V Min](#v-min)

**Syntax:** a = V Min( matrix )

**Description:** Returns a row vector containing the minimum of each column in the argument.

**JMP Version Added:** Before version 14

```

V Min( [11 22, 33 44, 55 66] );


```

### [V Quantile](#v-quantile)

**Syntax:** m = V Quantile( matrix, p )

**Description:** Returns a row vector containing the specified quantile p of each column in the argument.

**JMP Version Added:** 15

```

V Quantile( [11 22, 33 44, 35 46, 55 66], .25 );


```

### [V Robust Standardize](#v-robust-standardize)

**Syntax:** b = V Robust Standardize( X, \<center=1>, \<scale=1> )

**Description:** Returns a matrix that is centered by the median and scaled by a robust estimate of the standard deviation of matrix X. The optional Boolean arguments specify if centering and scaling are performed.

**JMP Version Added:** 17

```

V Robust Standardize( J( 150, 4, Random Normal() ), 1, 1 );


```

### [V Standardize](#v-standardize)

**Syntax:** b = V Standardize( X )

**Description:** Returns a matrix that is the centered and scaled version of matrix X. Each column of b has mean 0 and standard deviation 1.

**JMP Version Added:** Before version 14

```

V Standardize( [11 22, 33 44, 55 66] );


```

### [V Std](#v-std)

**Syntax:** b = V Std( matrix )

**Description:** Returns a row vector containing the standard deviations of each column in the argument.

**JMP Version Added:** Before version 14

```

V Std( [11 22, 33 44, 55 66] );


```

### [V Sum](#v-sum)

**Syntax:** s = V Sum( matrix )

**Description:** Returns a row vector containing the sum of each column in the argument.

**JMP Version Added:** Before version 14

```

V Sum( [11 22, 33 44, 55 66] );


```

### [VPTree](#vptree)

**Syntax:** tab = VPTree( [ matrix ] )

**Description:** Returns a table for efficiently looking up near neighbors. The matrix arguments are k-dimensional points. There is no built in limit on the number of dimensions or points.

**JMP Version Added:** 16

```

tab = VPTree( [1 1 1, 1 2 1, 1 2 2, 2 2 2, 3 3 3, 4 5 6] );
{rows, dist} = tab << K nearest rows( 2, [1.1 .9 1] );
"2 nearest rows to [1.1 .9 1] are " || Char( rows );


```

### [Varimax](#varimax)

**Syntax:** {R,T} = Varimax( F, \<norm=1> )

**Description:** Performs a varimax rotation of the specified matrix F. Returns a list that contains the rotated matrix and the orthogonal rotation matrix. By default, a normalized varimax rotation is performed. Specify norm = 0 to perform a non-normalized varimax rotation.

**JMP Version Added:** Before version 14

```

Varimax( [1.2 .4, .9 1.5] );


```

### [Vec Diag](#vec-diag)

**Syntax:** y = Vec Diag( x )

**Description:** Returns the diagonal elements of the square matrix as a vector.

**JMP Version Added:** Before version 14

```

Vec Diag( [11 22, 33 44] );


```

### [Vec Quadratic](#vec-quadratic)

**Syntax:** Vec Quadratic( S, X )

**Description:** Evaluates as Vec Diag( X * S * X\` ).

**JMP Version Added:** Before version 14

```

exS = [1 3 5, 3 2 6, 5 6 1];
exX = [1 3 5, 2 4 6];
Vec Quadratic( exS, exX );


```

### [Wavelet Basis Coef](#wavelet-basis-coef)

**Syntax:** y = Wavelet Basis Coef( x, grid, coef, \<wavelet = "Haar" or "Biorthogonal" or "Coiflet" or "Daubechies" or "Symlet">, \<param = 0> )

**Description:** Returns the prediction at the points x for the specified Wavelet model. The grid parameter is a vector specifying the grid of the data for the wavelet model. The coef parameter is a vector of wavelet coefficients. The wavelet parameter is the name of the wavelet model. The optional param parameter is the wavelet model parameter (if necessary, defaults to 0).

**JMP Version Added:** 17

```

Wavelet Basis Coef( 2.5, [1, 2, 3, 4], [0, 1, 2, 3], "Haar" );


```

# [Numeric](#numeric)

### [Abs](#abs)

**Syntax:** y = Abs( x )

**Description:** Returns the absolute value of x. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Abs( -5 );


```

### [Ceiling](#ceiling)

**Syntax:** y = Ceiling( x )

**Description:** Returns the smallest integer greater than or equal to x. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Ceiling( 1.2 );


```

### [Derivative](#derivative)

**Syntax:** y = Derivative( expr, name )

**Description:** Returns the symbolic derivative for the given expression with respect to the specified variable name.

**JMP Version Added:** Before version 14

```

Derivative( Sin( x ), x );


```

### [Floor](#floor)

**Syntax:** y = Floor( x )

**Description:** Returns the largest integer less than or equal to x. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Floor( 1.2 );


```

### [Integrate](#integrate)

**Syntax:** y = Integrate( expr, varname, lowLimit, upLimit, \<<Tolerance(1e-10), \<<StoreInfo(list), \<<StartingValue(val) )

**Description:** Integrates an expression with respect to a scalar value, using adaptive quadrature method from Gander and Gautschi (2000). If the variable specified with varname has a value assigned to it or the \<<StartingValue() optional argument specifies a starting value, that value is used as a typical value to improve the accuracy of the integral. To specify infinite ranges of integration, set lowLimit, upLimit, or both to missing. If \<<StoreInfo() is specified, the argument of \<<StoreInfo() will contain diagnostics of the numerical integration routine. If \<<Tolerance() is specified, the argument of \<<Tolerance() is used as the tolerance level in the autointegration function used to evaluate the integral. Smaller values result in longer run time but more precise results.

**JMP Version Added:** Before version 14

**Example 1**

```

Integrate( Exp( -x ), x, 0, . );


```

**Example 2**

```

x = 100;
Integrate( Normal Density( x - 100 ), x, ., . );


```

### [Invert Expr](#invert-expr)

**Syntax:** y = Invert Expr( expr, xname, yname )

**Description:** Inverts the expr expression argument, unfolding around the single occurrence of xname.

**JMP Version Added:** Before version 14

```

Invert Expr( Sqrt( Log( x ) ), x, y );


```

### [Mod](#mod)

**Syntax:** z = Modulo( x, y )

**Description:** Returns the remainder from dividing x by y. The remainder has the same sign as x.

**JMP Version Added:** Before version 14

```

Modulo( 10, 3 );


```

### [Modulo](#modulo)

**Syntax:** z = Modulo( x, y )

**Description:** Returns the remainder from dividing x by y. The remainder has the same sign as x.

**JMP Version Added:** Before version 14

```

Modulo( 10, 3 );


```

### [Normal Integrate](#normal-integrate)

**Syntax:** {mean, var} = Normal Integrate( muVector, sigmaMatrix, expr, x, NStrata, NSim )

**Description:** Returns the result of radial-spherical integration for smooth functions of multivariate normal variables. The basic idea is the same as one method in Genz and Monahan(1996). But Radau-Gauss-Laguerre type quadrature is used for the radial direction.

**JMP Version Added:** Before version 14

```

Normal Integrate(
    J( 3, 1, 0 ),
    Identity( 3 ),
    ex[1] ^ 4 * ex[2] ^ 2 * ex[3] ^ 2,
    ex,
    2,
    5000
);


```

### [Num Deriv](#num-deriv)

**Syntax:** y = Num Deriv( f( x, ... ), <parnum>)

**Description:** Returns the numerical derivative of the f( x,... ) function with respect to one of its arguments. You can specify that argument as the second argument in the Num Deriv function. If no second argument is specified, the derivative is taken with respect to the function's first argument. The derivative is evaluated using numeric values specified in the f( x,... ) function expression.

**JMP Version Added:** Before version 14

```

f = Function( {x, y}, x ^ 2 + y );
Num Deriv( f( 2, 1 ) );
Num Deriv( f( 2, 1 ), 2 );


```

### [Num Deriv2](#num-deriv2)

**Syntax:** y = Num Deriv2( f( x, ... ) )

**Description:** Returns the numerical second derivative of the f( x,... ) function with respect to x. The derivative is evaluated using numeric values specified in the f( x,... ) function expression.

**JMP Version Added:** Before version 14

```

f = Function( {x}, x ^ 3 );
Num Deriv2( f( 2 ) );


```

### [Round](#round)

**Syntax:** y = Round( x, <n> )

**Description:** Rounds x to n digits after the decimal point (or 0 digits if n is not specified). Note that the n argument can be negative.

**JMP Version Added:** Before version 14

```

Round( 213, -1 );


```

### [Simplify Expr](#simplify-expr)

**Syntax:** resultExpr = Simplify Expr( expr( ... ) )

**Description:** Returns an equivalent expression that simplifies the argument expression in various ways.

**JMP Version Added:** Before version 14

```

Simplify Expr( Expr( 2 * 3 * a + b * (a + 3 - c) - a * b ) );


```

# [Optimization](#optimization)

### [Constrained Maximize](#constrained-maximize)

**Syntax:** Constrained Maximize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<LessThanEQ({mat_A, vec_b}), \<<GreaterThanEQ({mat_A, vec_b}), \<<EqualTo({mat_A, vec_b}), \<<MaxIter( 250 ), \<<tolerance( .00001 ), \<<ShowDetails(True), \<<StartingValues([x1, x2, ... ])), \<<SetVariableLimit({lowerLimitVector,upperLimitVector})

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that maximize the expr expression with optional linear constraints. The variables, x1, x2, and so on, can be scalars or vectors. Lower and upper bounds must be specified for each variable in parentheses following the variable's name or with the optional parameter \<<SetVariableLimits(). Optional arguments for the Constrained Maximize function enable you to specify the following: linear constraints, maximum number of iterations, desired tolerance, output details, starting values, and limits for the optimization variables. (See example 2.) Linear constraints are specified using the mat_A coefficient matrix and the vec_b right hand side vector.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple Example*/
f = Expr(
    -2 * x1 ^ 2 - 2 * x2 ^ 2 + 2 * x1 * x2 + 4 * x1 + 6 * x2
);
A = [1 1, 1 5];
b = [2, 5];
minFun = Constrained Maximize(
    f,
    {x1( 0, 5 ), x2( 0, 5 )},
    <<lessthanEQ( {A, b} )/*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    <<StartingValues( [1, .5] )
);
Eval List( {x1, x2, minFun} );


```

**Example 2**

```

/*Simple Example with optional parameters included*/ 
x = [., .];
f = Expr(
    -2 * x[1] ^ 2 - 2 * x[2] ^ 2 + 2 * x[1] * x[2] + 4 * x[1] + 6 * x[2]
);
A = [1 1, 1 5];
b = [2, 5];
{objVal, iters, gradient, hessian} = Constrained Maximize(
    f,
    {x},
    <<lessthanEQ( {A, b} )/*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    MaxIter( 250 ),
    <<tolerance( 1e-5 ),
    <<showDetails( True ),
    <<StartingValues( [1, .5] ),
    <<setVariableLimit( {[0, 0], [5, 5]} )
);
Show( x, objVal, iters, gradient, hessian );


```

### [Constrained Minimize](#constrained-minimize)

**Syntax:** Constrained Minimize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<LessThanEQ({mat_A, vec_b}), \<<GreaterThanEQ({mat_A, vec_b}), \<<EqualTo({mat_A, vec_b}), \<<MaxIter( 250 ), \<<tolerance( .00001 ), \<<ShowDetails(True), \<<StartingValues([x1, x2, ... ])), \<<SetVariableLimit({low,high})

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that minimize the expr expression with optional linear constraints. The variables, x1, x2, and so on, can be scalars or vectors. Lower and upper bounds must be specified for each variable in parentheses following the variable's name or with the optional parameter \<<SetVariableLimits(). Optional arguments for the Constrained Minimize function enable you to specify the following: linear constraints, maximum number of iterations, desired tolerance, output details, starting values, and limits for the optimization variables. (See example 2.) Linear constraints are specified using the mat_A coefficient matrix and the vec_b right hand side vector.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple Example*/
f = Expr(
    2 * x1 ^ 2 + 2 * x2 ^ 2 - 2 * x1 * x2 - 4 * x1 - 6 * x2
);
A = [1 1, 1 5];
b = [2, 5];
minFun = Constrained Minimize(
    f,
    {x1( 0, 5 ), x2( 0, 5 )},
    <<lessthanEQ( {A, b} )/*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    <<StartingValues( [1, .5] )
);
Eval List( {x1, x2, minFun} );


```

**Example 2**

```

/*Simple Example with optional parameters included*/ 
x = [., .];
f = Expr(
    2 * x[1] ^ 2 + 2 * x[2] ^ 2 - 2 * x[1] * x[2] - 4 * x[1] - 6 * x[2]
);
A = [1 1, 1 5];
b = [2, 5];
{objVal, iters, gradient, hessian} = Constrained Minimize(
    f,
    {x},
    <<lessthanEQ( {A, b} ) /*and/or <<GreaterThanEQ({A,b}) and/or <<EqualTo({A,b})*/,
    MaxIter( 250 ),
    <<tolerance( 1e-5 ),
    <<showDetails( True ),
    <<StartingValues( [1, .5] ),
    <<setVariableLimit( {[0, 0], [5, 5]} )
);
Show( x, objVal, iters, gradient, hessian );


```

### [Desirability](#desirability)

**Syntax:** des = Desirability( yVector, dVector, y )

**Description:** Returns a desirability curve, where yVector is a vector of 3 input values, dVector is the corresponding 3 desirability values, and y is the argument of which to calculate the desirability.

**JMP Version Added:** Before version 14

```

dvec = [0.1 0.9 0.1];
yvec = [1 5 10];
New Window( "Desirability",
    Graph Box(
        X Scale( 0, 12 ),
        Y Scale( 0, 1 ),
        Frame Size( 500, 400 ),
        Drag Marker( yvec, dvec );
        Y Function( Desirability( yvec, dvec, x ), x );
    )
);


```

### [LPSolve](#lpsolve)

**Syntax:** {x, z} = LPSolve( A, b, c, L, U, neq, nle, nge, \<slackVars=0> )

**Description:** Minimizes the objective function subject to the given constraints and returns a list of two items. The first list item, x, contains the decision variables (and slack variable values if slackVars=1). The second list item, z, contains optimal objective function value (if one exists). The first five arguments are matrices. The A argument is the matrix of constraint coefficients. The b argument is the column of right hand side values of the constraints. The c argument is the vector of cost coefficients of the objective function. The L and U arguments are the lower and upper bounds for the variables, respectively. The neq, nle, and nge arguments are the number of equality constraints, less than or equal constraints, and greater than or equal constraints, respectively. Note that the constraints must be listed as equality first, less than or equal next, and greater than or equal last.

**JMP Version Added:** Before version 14

```

A = [5 -2 6, 2 4 0, 3 8 -4];
b = [17, 19, 14];
c = [9 6 -4];
L = [. 0 .];
U = [0 . .];
{x, z} = LPSolve( A, b, c, L, U, 1, 1, 1, 1 );
Show( x, z );


```

### [Maximize](#maximize)

**Syntax:** Maximize( expr, {x1, x2, ...} ); Maximize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<MaxIter( 250 ), \<<Tolerance( .00000001 ), \<<details(both | returnDetails | displaySteps), \<<gradient(), \<<hessian(), method(NR | SR1), \<<useNumericDeriv(True))

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that maximize the expr expression. You can specify lower and upper bounds for each argument in parentheses following the argument's name. If expr is not a concave function, Maximize might find a local maximum rather than the global maximum. If this is a concern, try multiple starting values. Also, Maximize works best for functions with a continuous second derivative. Additional arguments for the Maximize function enable you to set the maximum number of iterations, tolerance for convergence, and view more details about the optimization. Click the Topic Help button for more information about the optional arguments.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple example*/ 
x = 0;
y = 0;
maxf = Maximize( ((2 * x ^ 2 + 12 * x * y - y * 3)), {x, y} );
Eval List( {x, y, maxf} );


```

**Example 2**

```

/*Find the MLE for a Normal Distribution with a random sample of 3 observations*/
x = [3 4 5]; /* observed values*/ 
n = 3;
logDens = Expr(
    (-n / 2) * Log( 2 * Pi() * sigSq ) - Summation( i = 1, 3, ((x[i] - mu) ^ 2) ) / (2 *
    sigSq)
);
mu = 3;
sigSq = 1;/*initial values*/ 
{maxReached, iters, gradient, hessian} = Maximize(
    logDens,
    {mu, sigSq( 0, . )},
    <<details( both )
);


```

**Example 3**

```

/*Simple example with all optional arguments*/ 
x = 0;
y = 0;
{objVal, iters, gradient, hessian} = Maximize(
    ((2 * x ^ 2 + 12 * x * y - y * 3)),
    {x( -1, 1 ), y( -1, 1 )},
    <<maxIter( 200 ),
    <<tolerance( 10 ^ -6 ),
    <<details( both )
);


```

### [Minimize](#minimize)

**Syntax:** Minimize( expr, {x1, x2, ...} ); Minimize( expr, {x1( low1, up1 ), x2( low2, up2 ), ...}, \<<MaxIter( 250 ), \<<Tolerance( .00000001 ), \<<details(both | returnDetails | displaySteps), \<<gradient(), \<<Hessian(), \<<method(NR | SR1), \<<useNumericDeriv(True))

**Description:** Finds values for the function's arguments, given in the list {x1, x2, ...}, that minimize the expr expression. You can specify lower and upper bounds for each argument in parentheses following the argument's name. If expr is not a convex function, Minimize might find a local minimum rather than the global minimum. If this is a concern, try multiple starting values. Also, Minimize works best for functions with a continuous second derivative. Additional arguments for the Minimize function enable you to set the maximum number of iterations, tolerance for convergence, and view more details about the optimization. Click the Topic Help button for more information about the optional arguments.

**JMP Version Added:** Before version 14

**Example 1**

```

/*Simple Example*/
x = 0;
y = 0;
minFun = Minimize( (y * 3 - 2 * x ^ 2 - 12 * x * y), {x, y} );
Eval List( {x, y, minFun} );


```

**Example 2**

```

/*Nonlinear Sums of Squares Example*/
x = [1.309, 1.471, 1.49, 1.565, 1.611, 1.68];
y = [2.138, 3.421, 3.597, 4.34, 4.882, 5.66];
sseExpr = Expr(
    Summation( i = 1, 6, (y[i] - b1 * x[i] ^ b2) ^ 2 )
);
b1 = 1;
b2 = 5;
{objVal, iters, gradient, hessian} = Minimize(
    sseExpr,
    {b1, b2},
    <<details( both ),
    <<tolerance( 10 ^ -16 )
);


```

**Example 3**

```

/*Simple example with some optional arguments*/
x = 0;
y = 0;
{objVal, iters, gradient, hessian} = Minimize(
    ((2 * x ^ 2 + 12 * x * y - y * 3)),
    {x( -1, 1 ), y( -1, 1 )},
    <<maxIter( 200 ),
    <<tolerance( 10 ^ -6 ),
    <<details( both )
);


```

**Example 4**

```

/*Example with gradient, hessian, and method(nr) options*/
xx = [1.309, 1.471, 1.49, 1.565, 1.611, 1.68];
yy = [2.138, 3.421, 3.597, 4.34, 4.882, 5.66];
tmp3 = Expr(
    Summation( i = 1, 6, (yy[i] - b1 * xx[i] ^ b2) ^ 2 )
);
b1 = 1;
b2 = 5;
Minimize(
    tmp3,
    {b1, b2},
    <<details( both ),
    <<tolerance( 10 ^ -10 ),
    <<Method( nr ),
    <<gradient(
        {Summation( i = 1, 6, -2 * xx[i] ^ b2 * (yy[i] - b1 * xx[i] ^ b2) ),
        Summation(
            i = 1,
            6,
            2 * (b1 * Ln( xx[i] ) * xx[i] ^ b2) * (b1 * xx[i] ^ b2 - yy[i])
        )}
    ),
    <<hessian(
        {{Summation( i = 1, 6, 2 * xx[i] ^ (2 * b2) ),
        Summation( i = 1, 6, 2 * Ln( xx[i] ) * xx[i] ^ b2 * (2 * b1 * xx[i] ^ b2 - yy[i]) )},
        {Summation(
            i = 1,
            6,
            2 * b1 * Ln( xx[i] ) ^ 2 * xx[i] ^ b2 * (2 * b1 * xx[i] ^ b2 - yy[i])
        )}}
    )
);


```

**Example 5**

```

/*Example with usNumericDeriv and method(sr1) options*/
xx = [1.309, 1.471, 1.49, 1.565, 1.611, 1.68];
yy = [2.138, 3.421, 3.597, 4.34, 4.882, 5.66];
tmp3 = Expr(
    Summation( i = 1, 6, (yy[i] - b1 * xx[i] ^ b2) ^ 2 )
);
b1 = 1;
b2 = 5;
{objValue, iter, gradient, hessian} = Minimize(
    tmp3,
    {b1, b2},
    <<details( both ),
    <<tolerance( 10 ^ -16 ),
    <<Method( sr1 ),
    <<useNumericDeriv( True )
);


```

# [PI Server](#pi-server)

### [New PI Client](#new-pi-client)

**Syntax:** New Pi Client(URL(base URL), \<Authentication Method("None"|"Basic"|"NTLM"|"Kerberos")>, \<Username(userid)>,\<Password(password)>)

**Description:** Creates a new PI Client instance that can be used to import data from a PI server.

**JMP Version Added:** 17

**Example 1**

```

/* Import raw data */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "basic" ),
    Username( "myuserid" ),
    Password( "mypassword" )
);
importer = client << Importer(
    AF Path( "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A" ), /* Asset Framework path */
    Series( "raw" ),
    Start Time( "*-1d" ), /* PI time string */
    End Time( "*" ),      /* PI time string */
    Boundary Type( "inside" ), /* choices are "inside", "outside", "interpolated" */
    UTC( 0 ), /* whether specified start/end times are based on UTC - default is zero */
    Max Count( 5000 ), /* Max. number of values to fetch - default is 5000 */
    Filter( "" ), /* Optional filter */
    Retrieve Attribute Status( 0 ) /* Whether to retrieve value attributes (i.e. "good", "questionable", "substituted", "annotated") - default is 0 */
);
importer << Run;


```

**Example 2**

```

/* Import plot data using Kerberos for authentication */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "kerberos" )
);
importer = client << Importer(
    AF Path( "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A" ),
    Series( "plot" ),
    Start Time( "*-1d" ),
    End Time( "*" ),
    UTC( 0 ),
    Intervals( 24 )
); /* No of time intervals to fetch*/
importer << Run;


```

**Example 3**

```

/* Import interpolated data from a server that does not require authentication */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "none" )
);
importer = client << Importer(
    AF Path( "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A" ),
    Series( "interpolated" ),
    Start Time( "*-1d" ),
    End Time( "*" ),
    UTC( 0 ),
    Sync Time Boundary Type( "inside" ),   /*  choices are "inside", "outside" */
    Interval( "1h" ),            /* interval period */
    Sync Time( "01JUL2021" ),    /* optional sync point - ie. intervals begin from this point */
    Filter( "" )
);
importer << Run;


```

## [Item Messages](#item-messages)

### [Importer](#importer)

**Syntax:** Importer(AF Path(Asset Framework path), \<Series(string)>, \<Start Time(PI time string)>, \<End Time(PI time string)>, \<UTC(boolean)>, \<Boundary Type(string)>, \<Max Count(integer)>, \<Filter(string)>, \<Retrieve Attribute Status(boolean)>, \<Intervals(integer)>, \<Sync Time(PI time string)>, \<Sync Time Boundary Type(string)>, \<Interval(duration in PI AFTimeSpan format)>, \<Timeout(integer)>)

**Description:** Creates a new raw importer instance.

**JMP Version Added:** 17

**Example 1**

```

/* Import raw data */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "basic" ),
    Username( "myuserid" ),
    Password( "mypassword" )
);
importer = client << Importer(
    AF Path(                 /* Asset Framework paths */
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A",
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I B",
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I C"
    ),
    Series( "raw" ),
    Start Time( "*-1d" ), /* PI time string */
    End Time( "*" ),      /* PI time string */
    UTC( 0 ), /* whether specified start/end times are based on UTC - default is zero */
    Boundary Type( "inside" ), /* choices are "inside", "outside", "interpolated" */
    Max Count( 5000 ), /* Max. number of values to fetch - default is 5000 */
    Filter( "" ), /* Optional filter */
    Retrieve Attribute Status( 0 ), /* Whether to retrieve value attributes (i.e. "good", "questionable", "substituted", "annotated") - default is 0 */
    Timeout( 120 ) /*add extra time for the server to respond*/
);
importer << Run;


```

**Example 2**

```

/* Import plot data  */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "kerberos" )
);
importer = client << Importer(
    AF Path(                 /* Asset Framework paths */
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A",
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I B",
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I C"
    ),
    Series( "plot" ),
    Start Time( "*-1d" ),
    End Time( "*" ),
    UTC( 0 ),
    Intervals( 24 )
); /* No of time intervals to fetch*/
importer << Run;


```

**Example 3**

```

/* Import interpolated data from a server that does not require authentication */
client = New PI Client(
    URL( "https://myserver.com/piwebapi" ),
    Authentication Method( "none" )
);
importer = client << Importer(
    AF Path(                 /* Asset Framework paths */
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I A",
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I B",
        "\\myserver\PIData\Atlanta Data Center\Server Rack1\ION 6200 Power Meter1|I C"
    ),
    Series( "interpolated" ),
    Start Time( "*-1d" ),
    End Time( "*" ),
    UTC( 0 ),
    Sync Time Boundary Type( "inside" ),   /*  choices are "inside", "outside" */
    Interval( "1h" ),            /* interval period */
    Sync Time( "01JUL2021" ),    /* optional sync point - ie. intervals begin from this point */
    Filter( "" )
);
importer << Run;


```

# [Probability](#probability)

### [Beta Density](#beta-density)

**Syntax:** y = Beta Density( q, alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns the density at q for a beta distribution, where q is in the interval theta to theta + sigma, alpha and beta are shape parameters, and theta and sigma are threshold and range parameters, respectively.

**JMP Version Added:** Before version 14

```

alpha = 0.5;
beta = 0.5;
New Window( "Example: Beta Density",
    y = Graph Box(
        Y Scale( 0, 2.5 ),
        X Scale( 0, 1 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Beta Density( q, alpha, beta ), q );
        Text( {0.55, 2.2}, "\!U03B1=", Round( alpha, 2 ), " \!U03B2=", Round( beta, 2 ) );
    ),
    H List Box( Slider Box( 0, 10, alpha, y << reshow ), Text Box( " \!U03B1" ) ),
    H List Box( Slider Box( 0, 10, beta, y << reshow ), Text Box( " \!U03B2" ) )
);


```

### [Beta Distribution](#beta-distribution)

**Syntax:** p = Beta Distribution( q, alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns the probability that a beta distributed random variable is less than q, where alpha and beta are shape parameters and theta and sigma are threshold and range parameters, respectively.

**JMP Version Added:** Before version 14

```

alpha = 0.5;
beta = 0.5;
New Window( "Example: Beta Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 1 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Beta Distribution( q, alpha, beta ), q );
        Text( {0.1, 0.9}, "\!U03B1=", Round( alpha, 2 ), " \!U03B2=", Round( beta, 2 ) );
    ),
    H List Box( Slider Box( 0, 10, alpha, y << reshow ), Text Box( " \!U03B1" ) ),
    H List Box( Slider Box( 0, 10, beta, y << reshow ), Text Box( " \!U03B2" ) )
);


```

### [Beta Quantile](#beta-quantile)

**Syntax:** q = Beta Quantile( p, alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns the quantile from a Beta distribution, the value for which the probability is p that a random value would be lower, where alpha and beta are shape parameters and theta and sigma are threshold and range parameters, respectively.

**JMP Version Added:** Before version 14

```

Beta Quantile( 0.95, 2, 5 );


```

### [Cauchy Density](#cauchy-density)

**Syntax:** y = Cauchy Density( q, <center>, <scale> )

**Description:** Returns the density at q of a Cauchy distribution with center mu and scale sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Cauchy Density",
    y = Graph Box(
        Y Scale( 0, .4 ),
        X Scale( -6, 6 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Cauchy Density( q ), q );
    )
);


```

### [Cauchy Distribution](#cauchy-distribution)

**Syntax:** p = Cauchy Distribution( q, <center>, <scale> )

**Description:** Returns the probability that a Cauchy distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

New Window( "Example: Cauchy Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -6, 6 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Cauchy Distribution( q ), q );
    )
);


```

### [Cauchy Quantile](#cauchy-quantile)

**Syntax:** q = Cauchy Quantile( p, <center>, <scale> )

**Description:** Returns the quantile from a Cauchy distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

New Window( "Example: Cauchy Quantile",
    Graph Box(
        Y Scale( -6, 6 ),
        X Scale( 0, 1 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Cauchy Quantile( p ), p );
    )
);


```

### [ChiSquare Density](#chisquare-density)

**Syntax:** p = ChiSquare Density( q, df, \<nonCentrality=0> )

**Description:** Returns the density at q of a Chi-square distribution with df degrees of freedom.

**JMP Version Added:** Before version 14

```

cdedf = 2;
New Window( "Example: ChiSquare Density",
    cdey = Graph Box(
        Y Scale( 0, 0.4 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Density( cdeq, cdedf ), cdeq );
        Text( {7, 0.35}, "df=", Round( cdedf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, cdedf, cdey << reshow ) )
);


```

### [ChiSquare Distribution](#chisquare-distribution)

**Syntax:** p = ChiSquare Distribution( q, df, \<nonCentrality=0> )

**Description:** Returns the probability that a Chi-square distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

cdidf = 2;
New Window( "Example: ChiSquare Distribution",
    cdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Distribution( cdiq, cdidf ), cdiq );
        Text( {1, 0.9}, "df=", Round( cdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, cdidf, cdiy << reshow ) )
);


```

### [ChiSquare Log CDistribution](#chisquare-log-cdistribution)

**Syntax:** y = ChiSquare Log CDistribution( x, df, \<nonCentrality=0> )

**Description:** Returns the log of 1 - Chi-square distribution.

**JMP Version Added:** Before version 14

```

clcdidf = 2;
New Window( "Example: ChiSquare Log CDistribution",
    clcdiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Log CDistribution( clcdiq, clcdidf ), clcdiq );
        Text( {1, -0.9}, "df=", Round( clcdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, clcdidf, clcdiy << reshow ) )
);


```

### [ChiSquare Log Density](#chisquare-log-density)

**Syntax:** y = ChiSquare Log Density( x, df, \<nonCentrality=0> )

**Description:** Returns the log of the Chi-square probability density.

**JMP Version Added:** Before version 14

```

cldedf = 1;
New Window( "Example: ChiSquare Log Density",
    cldey = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Log Density( cldeq, cldedf ), cldeq );
        Text( {7, -0.35}, "df=", Round( cldedf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, cldedf, cldey << reshow ) )
);


```

### [ChiSquare Log Distribution](#chisquare-log-distribution)

**Syntax:** y = ChiSquare Log Distribution( x, df, \<nonCentrality=0> )

**Description:** Returns the log of the Chi-square distribution.

**JMP Version Added:** Before version 14

```

cldidf = 2;
New Window( "Example: ChiSquare Log Distribution",
    cldiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Log Distribution( cldiq, cldidf ), cldiq );
        Text( {1, -0.9}, "df=", Round( cldidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, cldidf, cldiy << reshow ) )
);


```

### [ChiSquare Noncentrality](#chisquare-noncentrality)

**Syntax:** nc = ChiSquare Noncentrality( x, df, prob )

**Description:** Returns the noncentrality parameter nc such that prob is equal to the probability that a Chi-square distributed random variable with df degrees of freedom is less than x.

**JMP Version Added:** Before version 14

```

New Window( "Example: ChiSquare Noncentrality",
    chincgr = Graph Box(
        Y Scale( 0.01, 0.99 ),
        X Scale( 0.01, 0.99 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( ChiSquare Noncentrality( 3, 2, ChiSquare Distribution( 3, 2, q ) ), q );
    )
);
ChiSquare Noncentrality( 3, 2, ChiSquare Distribution( 3, 2, 0.5 ) );


```

### [ChiSquare Quantile](#chisquare-quantile)

**Syntax:** q = ChiSquare Quantile( p, df, \<nonCentrality=0> )

**Description:** Returns the quantile from a Chi-Square distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

ChiSquare Quantile( 0.15, 5 );


```

### [Dunnett P value](#dunnett-p-value)

**Syntax:** p = Dunnett P value( q, nTrt, dfe, \<lambdaVec = .> )

**Description:** Returns the p-value from Dunnett's multiple comparisons test, where q is the test statistic, nTrt is the number of treatments being compared to the control group, dfe is the error degrees of freedom (based on the total study sample), and the optional lambdaVec is a vector of parameters, which by default are set to 1/sqrt(2).

**JMP Version Added:** Before version 14

```

Dunnett P value( 1.67623, 3, 11 );


```

### [Dunnett Quantile](#dunnett-quantile)

**Syntax:** q = Dunnett Quantile( 1-alpha, nTrt, dfe, \<lambdaVec = .> )

**Description:** Returns the quantile needed in Dunnett's multiple comparisons test, where 1-alpha is the confidence level, nTrt is the number of treatments being compared to the control group, dfe is the error degrees of freedom (based on the total study sample), and the optional lambdaVec is a vector of parameters, which by default are set to 1/sqrt(2).

**JMP Version Added:** Before version 14

```

Dunnett Quantile( 0.95, 3, 11 );


```

### [ExGaussian Density](#exgaussian-density)

**Syntax:** y = ExGaussian Density( x, location, scale, shape )

**Description:** Returns the density at x of an ExGaussian distribution.

**JMP Version Added:** 18

```

New Window( "Example: ExGaussian Density",
    y = Graph Box(
        Y Scale( 0, .2 ),
        X Scale( -2, 15 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( ExGaussian Density( x, 0, .5, .25 ), x );
    )
);


```

### [ExGaussian Distribution](#exgaussian-distribution)

**Syntax:** y = ExGaussian Distribution( x, location, scale, shape )

**Description:** Returns the probability that an ExGaussian distributed random variable is less than x.

**JMP Version Added:** 18

```

New Window( "Example: ExGaussian Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -2, 15 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( ExGaussian Distribution( x, 0, .5, .25 ), x );
    )
);


```

### [ExGaussian Quantile](#exgaussian-quantile)

**Syntax:** q = ExGaussian Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from an ExGaussian distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** 18

```

New Window( "Example: ExGaussian Quantile",
    Graph Box(
        Y Scale( -2, 15 ),
        X Scale( 0, 1 ),
        XName( "p" ),
        Pen Color( "red" );
        Y Function( ExGaussian Quantile( p, 0, .5, .25 ), p );
    )
);


```

### [Exp Density](#exp-density)

**Syntax:** y = Exp Density( x, \<theta=1> )

**Description:** Returns the density at x of an exponential distribution with parameter theta.

**JMP Version Added:** 14

```

New Window( "Example: Exp Density",
    y = Graph Box(
        Y Scale( 0, 0.45 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exp Density( x, 2 ), x );
    )
);


```

### [Exp Distribution](#exp-distribution)

**Syntax:** p = Exp Distribution( x, \<theta=1> )

**Description:** Returns the probability that an exponentially distributed random variable is less than x.

**JMP Version Added:** 14

```

New Window( "Example: Exp Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exp Distribution( x, 2 ), x );
    )
);


```

### [Exp Quantile](#exp-quantile)

**Syntax:** q = Exp Quantile( p, \<theta=1> )

**Description:** Returns the quantile from an exponential distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** 14

```

New Window( "Example: Exp Quantile",
    y = Graph Box(
        Y Scale( 0, 4 ),
        X Scale( 0, 1 ),
        Pen Color( "red" );
        Y Function( Exp Quantile( qq, 2 ), qq );
    )
);


```

### [Exponential Density](#exponential-density)

**Syntax:** y = Exponential Density( x, \<theta=1> )

**Description:** Returns the density at x of an exponential distribution with parameter theta.

**JMP Version Added:** 17

```

New Window( "Example: Exponential Density",
    y = Graph Box(
        Y Scale( 0, 0.45 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exponential Density( x, 2 ), x );
    )
);


```

### [Exponential Distribution](#exponential-distribution)

**Syntax:** p = Exponential Distribution( x, \<theta=1> )

**Description:** Returns the probability that an exponentially distributed random variable is less than x.

**JMP Version Added:** 17

```

New Window( "Example: Exponential Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 4 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Exponential Distribution( x, 2 ), x );
    )
);


```

### [Exponential Quantile](#exponential-quantile)

**Syntax:** q = Exponential Quantile( p, \<theta=1> )

**Description:** Returns the quantile from an exponential distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** 17

```

New Window( "Example: Exponential Quantile",
    y = Graph Box(
        Y Scale( 0, 4 ),
        X Scale( 0, 1 ),
        Pen Color( "red" );
        Y Function( Exponential Quantile( qq, 2 ), qq );
    )
);


```

### [F Density](#f-density)

**Syntax:** y = F Density( q, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the density at q of an F distribution with dfn and dfd degrees of freedom.

**JMP Version Added:** Before version 14

```

fdedfn = 2;
fdedfd = 2;
New Window( "Example: F Density",
    fdey = Graph Box(
        Y Scale( 0, 0.8 ),
        X Scale( 0, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Density( fdeq, fdedfn, fdedfd ), fdeq );
        Text( {2.5, 0.7}, "dfn=", Round( fdedfn, 2 ), " dfd=", Round( fdedfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, fdedfn, fdey << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 10, fdedfd, fdey << reshow ) )
);


```

### [F Distribution](#f-distribution)

**Syntax:** y = F Distribution( q, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the probability that an F distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

fdidfn = 5;
fdidfd = 5;
New Window( "Example: F Distribution",
    fdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Distribution( fdiq, fdidfn, fdidfd ), fdiq );
        Text( {0.5, 0.9}, "dfn=", Round( fdidfn, 2 ), " dfd=", Round( fdidfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 0.5, 10, fdidfn, fdiy << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 0.5, 10, fdidfd, fdiy << reshow ) )
);


```

### [F Log CDistribution](#f-log-cdistribution)

**Syntax:** y = F Log CDistribution( x, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the log of 1 - F Distribution.

**JMP Version Added:** Before version 14

```

flcddfn = 5;
flcddfd = 5;
New Window( "Example: F Log CDistribution",
    flcdy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Log CDistribution( flcdq, flcddfn, flcddfd ), flcdq );
        Text( {0.5, -0.9}, "dfn=", Round( flcddfn, 2 ), " dfd=", Round( flcddfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, flcddfn, flcdy << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 30, flcddfd, flcdy << reshow ) )
);


```

### [F Log Density](#f-log-density)

**Syntax:** y = F Log Density( x, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the log of the F probability density.

**JMP Version Added:** Before version 14

```

fldedfn = 1;
fldedfd = 1;
New Window( "Example: F Log Density",
    fldey = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Log Density( fldeq, fldedfn, fldedfd ), fldeq );
        Text( {2.5, -0.7}, "dfn=", Round( fldedfn, 2 ), " dfd=", Round( fldedfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, fldedfn, fldey << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 10, fldedfd, fldey << reshow ) )
);


```

### [F Log Distribution](#f-log-distribution)

**Syntax:** y = F Log Distribution( x, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the log of the F distribution.

**JMP Version Added:** Before version 14

```

flddfn = 5;
flddfd = 5;
New Window( "Example: F Log Distribution",
    fldy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 10 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Log Distribution( fldq, flddfn, flddfd ), fldq );
        Text( {0.5, -0.9}, "dfn=", Round( flddfn, 2 ), " dfd=", Round( flddfd, 2 ) );
    ),
    H List Box( Text Box( "dfn " ), Slider Box( 1, 10, flddfn, fldy << reshow ) ),
    H List Box( Text Box( "dfd " ), Slider Box( 1, 30, flddfd, fldy << reshow ) )
);


```

### [F Noncentrality](#f-noncentrality)

**Syntax:** nc = F Noncentrality( x, dfnum, dfden, prob )

**Description:** Solves for the noncentrality parameter nc such that prob = F Distribution( x, ndf, ddf, nc ).

**JMP Version Added:** Before version 14

```

New Window( "Example: F Noncentrality",
    fncgr = Graph Box(
        Y Scale( 0.01, 0.99 ),
        X Scale( 0.01, 0.99 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( F Noncentrality( 3, 2, 5, F Distribution( 3, 2, 5, q ) ), q );
    )
);
F Noncentrality( 3, 2, 5, F Distribution( 3, 2, 5, 0.4 ) );


```

### [F Power](#f-power)

**Syntax:** p = F Power( alpha, dfh, dfm, d, n )

**Description:** Calculates the power of an F Test, where alpha is the significance level, dfh is the hypothesis degrees of freedom, dfm is the degrees of freedom in the whole model, d is the squared effect size, SSH/(n\*sigma^2) where SSH is the sum of squares for the hypothesis, and n is the total number of observations. Note that for the ANOVA model, d = Sum(a[i]^2)/(k * sigma^2) where a[i] are effects and k is the number of means.

**JMP Version Added:** Before version 14

```

alpha = 0.05;
obs = 25;
dfh = 5;
dfm = 5;
d = 1;
New Window( "Example: F Power (alpha=.05,dfh=5,dfm=5)",
    fpdigr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( 0, 1 ),
        YName( "Power" ),
        XName( "d" ),
        Pen Color( "red" );
        Y Function( F Power( alpha, dfh, dfm, d, obs ), d );
        Text( {0.75, 0.1}, "obs=", Round( obs ) );
    ),
    H List Box( Text Box( "obs" ), Slider Box( 10, 100, obs, fpdigr << reshow ) )
);


```

### [F Quantile](#f-quantile)

**Syntax:** q = F Quantile( p, dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns the quantile from an F distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

F Quantile( 0.7, 5, 3 );


```

### [F Sample Size](#f-sample-size)

**Syntax:** n = F Sample Size( alpha, dfh, dfm, d, power )

**Description:** Calculates the sample size, where alpha is the significance level, dfh is the hypothesis degrees of freedom, dfm is the degrees of freedom in the whole model, d is the squared effect size, SSH/(n\*sigma^2) where SSH is the sum of squares for the hypothesis, and power is the power desired. Note that for the ANOVA model, d = Sum(a[i]^2)/(k * sigma^2) where a[i] are effects and k is the number of means.

**JMP Version Added:** Before version 14

```

alpha = 0.05;
pow = 0.6;
dfh = 5;
dfm = 5;
d = 1;
New Window( "Example: F Sample Size (alpha=.05,dfh=5,dfm=5)",
    fpdigr = Graph Box(
        Y Scale( 0, 50 ),
        X Scale( 0.5, 5 ),
        YName( "Sample Size" ),
        XName( "d" ),
        Pen Color( "red" );
        Y Function( F Sample Size( alpha, dfh, dfm, d, pow ), d );
        Text( {0.75, 0.2}, "power=", Round( pow, 2 ) );
    ),
    H List Box( Text Box( "power" ), Slider Box( 0.2, 0.95, pow, fpdigr << reshow ) )
);


```

### [FDR Adjust](#fdr-adjust)

**Syntax:** y = FDR Adjust( matrix )

**Description:** Returns the false discovery rate adjustment for the specified p-values using the Benjamini-Hochberg method.

**JMP Version Added:** 19

```

FDR Adjust( [0.5, 0.2, 0.05, 0.01] );


```

### [Frechet Density](#frechet-density)

**Syntax:** y = Frechet Density( x, mu, sigma )

**Description:** Returns the density at x of a Fréchet distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .5;
New Window( "Example: Frechet Density",
    y = Graph Box(
        Y Scale( 0, .06 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Frechet Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Frechet Distribution](#frechet-distribution)

**Syntax:** p = Frechet Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a Fréchet distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .5;
New Window( "Example: Frechet Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Frechet Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Frechet Quantile](#frechet-quantile)

**Syntax:** q = Frechet Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a Fréchet distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .5;
qq = .5;
New Window( "Example: Frechet Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Frechet Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Frechet Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [GLog Density](#glog-density)

**Syntax:** y = GLog Density( q, mu, sigma, lambda )

**Description:** Returns the density at q of a generalized logarithm distribution with location mu, scale sigma, and shape lambda.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: GLog Density",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GLog Density( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( " \!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( " \!U03BB" ) )
);


```

### [GLog Distribution](#glog-distribution)

**Syntax:** p = GLog Distribution( q, mu, sigma, lambda )

**Description:** Returns the probability that a generalized logarithm distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: Glog Distribution",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GLog Distribution( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( " \!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( " \!U03BB" ) )
);


```

### [GLog Quantile](#glog-quantile)

**Syntax:** q = GLog Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from a generalized logarithm distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
p = 0.4;
New Window( "Example: GLog Quantile",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GLog Distribution( x, mu, sigma, lambda ), x );
        Pen Color( "Blue" );
        V Line( GLog Quantile( p, mu, sigma, lambda ), 0, 1 );
        Text(
            {-9, 0.9},
            "\!U03BC=",
            Round( mu, 4 ),
            " \!U03C3=",
            Round( sigma, 4 ),
            " \!U03BB=",
            Round( lambda, 4 )
        );
        Text( {-9, 0.8}, "p=", Round( p, 3 ) );
        Text( {-9, 0.7}, "quantile= ", Round( GLog Quantile( p, mu, sigma, lambda ), 2 ) );
    ),
    H List Box( Slider Box( -2, 2, mu, gdey << reshow ), Text Box( " \!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( " \!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( " \!U03BB" ) ),
    H List Box( Slider Box( 0.01, 0.99, p, gdey << reshow ), Text Box( " p" ) )
);


```

### [Gamma Density](#gamma-density)

**Syntax:** y = Gamma Density( q, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the density at q of a Gamma probability distribution, where the alpha shape parameter argument must be positive.

**JMP Version Added:** Before version 14

```

gdealpha = Log( 1.5 );
New Window( "Example: Gamma Density",
    gdey = Graph Box(
        Y Scale( 0, 0.5 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Density( gdeq, Exp( gdealpha ) ), gdeq );
        Text( {9, 0.45}, "\!U03B1=", Round( Exp( gdealpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gdealpha, gdey << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Distribution](#gamma-distribution)

**Syntax:** p = Gamma Distribution( q, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the probability that a Gamma distributed random variable is less than q, where the alpha shape parameter argument must be positive. IGamma() is an alias name to Gamma Distribution(). The Gamma Distribution() function is equivalent to Gamma(alpha,q)/Gamma(alpha).

**JMP Version Added:** Before version 14

```

gdialpha = Log( 1.5 );
New Window( "Example: Gamma Distribution",
    gdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Distribution( gdiq, Exp( gdialpha ) ), gdiq );
        Text( {1, 0.9}, "\!U03B1=", Round( Exp( gdialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gdialpha, gdiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Log CDistribution](#gamma-log-cdistribution)

**Syntax:** p = Gamma Log CDistribution( x, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the log of 1 - Gamma distribution.

**JMP Version Added:** Before version 14

```

glcdialpha = Log( 1.5 );
New Window( "Example: Gamma Log CDistribution",
    glcdiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Log CDistribution( glcdiq, Exp( glcdialpha ) ), glcdiq );
        Text( {1, -0.9}, "\!U03B1=", Round( Exp( glcdialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), glcdialpha, glcdiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Log Density](#gamma-log-density)

**Syntax:** y = Gamma Log Density( x, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the log of the Gamma probability density.

**JMP Version Added:** Before version 14

```

gldealpha = Log( 1.5 );
New Window( "Example: Gamma Log Density",
    gldey = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Log Density( gldeq, Exp( gldealpha ) ), gldeq );
        Text( {9, -0.45}, "\!U03B1=", Round( Exp( gldealpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gldealpha, gldey << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Log Distribution](#gamma-log-distribution)

**Syntax:** p = Gamma Log Distribution( x, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the log of the Gamma distribution.

**JMP Version Added:** Before version 14

```

gldialpha = Log( 1.5 );
New Window( "Example: Gamma Log Distribution",
    gldiy = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Log Distribution( gldiq, Exp( gldialpha ) ), gldiq );
        Text( {1, -0.9}, "\!U03B1=", Round( Exp( gldialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gldialpha, gldiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Gamma Quantile](#gamma-quantile)

**Syntax:** q = Gamma Quantile( p, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the quantile from a Gamma distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

Gamma Quantile( 0.75, 4 );


```

### [GenGamma Density](#gengamma-density)

**Syntax:** y = GenGamma Density( x, mu, sigma, lambda )

**Description:** Returns the density at x of an extended generalized gamma probability distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: GenGamma Density",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -5, 10 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GenGamma Density( y, mu, sigma, lambda ), y );
        Text( {-4, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-4, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [GenGamma Distribution](#gengamma-distribution)

**Syntax:** p = GenGamma Distribution( x, mu, sigma, lambda )

**Description:** Returns the probability that an extended generalized gamma distributed random variable (with parameters mu, sigma, and lambda) is less than x.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: GenGamma Distribution",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GenGamma Distribution( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [GenGamma Quantile](#gengamma-quantile)

**Syntax:** q = GenGamma Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from an extended generalized gamma distribution (with parameters mu, sigma, and lambda), the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
p = 0.4;
New Window( "Example: GenGamma Quantile",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( GenGamma Distribution( x, mu, sigma, lambda ), x );
        Pen Color( "Blue" );
        V Line( GenGamma Quantile( p, mu, sigma, lambda ), 0, 1 );
        Text(
            {-9, 0.9},
            "\!U03BC=",
            Round( mu, 4 ),
            " \!U03C3=",
            Round( sigma, 4 ),
            " \!U03BB=",
            Round( lambda, 4 )
        );
        Text( {-9, 0.8}, "p=", Round( p, 3 ) );
        Text(
            {-9, 0.7},
            "quantile= ",
            Round( GenGamma Quantile( p, mu, sigma, lambda ), 2 )
        );
    ),
    H List Box( Slider Box( -2, 2, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) ),
    H List Box( Slider Box( 0.01, 0.99, p, gdey << reshow ), Text Box( " p" ) )
);


```

### [IGamma](#igamma)

**Syntax:** p = Gamma Distribution( q, \<alpha=1>, \<scale=1>, \<threshold=0> )

**Description:** Returns the probability that a Gamma distributed random variable is less than q, where the alpha shape parameter argument must be positive. IGamma() is an alias name to Gamma Distribution(). The Gamma Distribution() function is equivalent to Gamma(alpha,q)/Gamma(alpha).

**JMP Version Added:** Before version 14

```

gdialpha = Log( 1.5 );
New Window( "Example: Gamma Distribution",
    gdiy = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 12 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Gamma Distribution( gdiq, Exp( gdialpha ) ), gdiq );
        Text( {1, 0.9}, "\!U03B1=", Round( Exp( gdialpha ), 2 ) );
    ),
    H List Box(
        Slider Box( Log( 0.1 ), Log( 12 ), gdialpha, gdiy << reshow ),
        Text Box( " \!U03B1" )
    )
);


```

### [Johnson Sb Density](#johnson-sb-density)

**Syntax:** y = Johnson Sb Density( q, gamma, delta, theta, sigma )

**Description:** Returns the density at q of a Johnson Sb distribution, where q is in the interval theta to theta + sigma, delta>0 and gamma between -∞ and +∞ are shape parameters, sigma>0 is a scale parameter, and theta between -∞ and +∞ is a threshold parameter. Note: theta is the lower endpoint of the distribution and sigma is the range of the support of the distribution.

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 0.5;
theta = 0.5;
sigma = 1;
New Window( "Example: Johnson Sb Density",
    jsbp = Graph Box(
        Y Scale( 0, 5.5 ),
        X Scale( 0.2, 1.8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sb Density( q, gamma, delta, theta, sigma ), q );
        Text(
            {0.5, 4.5},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsbp << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, jsbp << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( -2, 2, theta, jsbp << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 10, sigma, jsbp << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Sb Distribution](#johnson-sb-distribution)

**Syntax:** p = Johnson Sb Distribution( q, gamma, delta, theta, sigma )

**Description:** Returns the probability that a Johnson Sb distributed random variable is less than q. (Note: see the Johnson Sb Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 0.5;
theta = 0.5;
sigma = 3;
New Window( "Example: Johnson Sb Distribution",
    jsbc = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0.2, 3.8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sb Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {0.3, 0.8},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsbc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 1, delta, jsbc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 1, theta, jsbc << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 4, sigma, jsbc << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Sb Quantile](#johnson-sb-quantile)

**Syntax:** q = Johnson Sb Quantile( p, gamma, delta, theta, sigma )

**Description:** Returns the quantile from a Johnson Sb distribution, the value for which the probability is p that a random value would be lower. (Note: p is the first parameter. See the Johnson Sb Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

Johnson Sb Quantile( 0.5, 0.5, 1, 1, 1 );


```

### [Johnson Sl Density](#johnson-sl-density)

**Syntax:** y = Johnson Sl Density( q, gamma, delta, theta, \<sigma=1> )

**Description:** Returns the density at q of a Johnson Sl distribution, where q is in the interval theta to +∞, delta>0 and gamma between -∞ and +∞ are shape parameters, sigma equal to +1 or -1 is a scale parameter, and theta between -∞ and +∞ is a threshold parameter. Note: When sigma = 1, theta is the lower bound on the distribution, and when sigma=-1, theta is the upper bound. Also, positive sigma implies positive skew, and negative sigma implies negative skew.

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 0;
sigma = 1;
New Window( "Example: Johnson Sl Density",
    jslp = Graph Box(
        Y Scale( 0, 1.5 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sl Density( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 1.1},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 )
        );
    ),
    jslpcb = Check Box(
        {"\!U03C3 = +1 (Note: When unchecked \!U03C3 = -1)"},
        <<set( 1 ),
        sigma = [-1, 1][((jslpcb << get()) + 1)];
        jslp << reshow;
    ),
    H List Box( Slider Box( -15, 15, gamma, jslp << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 10, delta, jslp << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( -5, 5, theta, jslp << reshow ), Text Box( " \!U03B8" ) )
);


```

### [Johnson Sl Distribution](#johnson-sl-distribution)

**Syntax:** p = Johnson Sl Distribution( q, gamma, delta, theta, \<sigma=1> )

**Description:** Returns the probability that a Johnson Sl distributed random variable is less than q. (Note: see the Johnson Sl Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 0;
sigma = 1;
New Window( "Example: Johnson Sl Distribution",
    jslc = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Sl Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 0.9},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 )
        );
    ),
    jslccb = Check Box(
        {"\!U03C3 = +1 (Note: When unchecked \!U03C3 = -1)"},
        <<set( 1 ),
        sigma = [-1, 1][((jslccb << get()) + 1)];
        jslc << reshow;
    ),
    H List Box( Slider Box( -15, 15, gamma, jslc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 10, delta, jslc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( -5, 5, theta, jslc << reshow ), Text Box( " \!U03B8" ) )
);


```

### [Johnson Sl Quantile](#johnson-sl-quantile)

**Syntax:** q = Johnson Sl Quantile( p, gamma, delta, theta, \<sigma=1> )

**Description:** Returns the quantile from a Johnson Sl distribution, the value for which the probability is p that a random value would be lower. (Note: p is the first parameter. See the Johnson Sl Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

Johnson Sl Quantile( 0.5, 0.5, 1, 1, 1 );


```

### [Johnson Su Density](#johnson-su-density)

**Syntax:** y = Johnson Su Density( q, gamma, delta, theta, sigma )

**Description:** Returns the density at q of a Johnson Su distribution, where q is between -∞ and +∞, delta>0 and gamma between -∞ and +∞ are shape parameters, sigma>0 is a scale parameter, and theta between -∞ and +∞ is a threshold parameter.

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 1;
sigma = 1;
New Window( "Example: Johnson Su Density",
    y = Graph Box(
        Y Scale( 0, 1.5 ),
        X Scale( -2, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Su Density( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 1.3},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, y << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, y << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 2, theta, y << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 2, sigma, y << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Su Distribution](#johnson-su-distribution)

**Syntax:** p = Johnson Su Distribution( q, gamma, delta, theta, sigma )

**Description:** Returns the probability that a Johnson Su distributed random variable is less than q. (Note: see the Johnson Su Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

gamma = 0.5;
delta = 1;
theta = 1;
sigma = 1;
New Window( "Example: Johnson Su Distribution",
    jsuc = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -2, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Johnson Su Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 0.9},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsuc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, jsuc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 2, theta, jsuc << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 2, sigma, jsuc << reshow ), Text Box( " \!U03C3" ) )
);


```

### [Johnson Su Quantile](#johnson-su-quantile)

**Syntax:** q = Johnson Su Quantile( p, gamma, delta, theta, sigma )

**Description:** Returns the quantile from a Johnson Su distribution, the value for which the probability is p that a random value would be lower. (Note: p is the first parameter. See the Johnson Su Density() function for parameter descriptions.)

**JMP Version Added:** Before version 14

```

Johnson Su Quantile( 0.5, 0.5, 1, 1, 1 );


```

### [LEV Density](#lev-density)

**Syntax:** y = LEV Density( x, mu, sigma )

**Description:** Returns the density at x of a largest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 10;
sig = 5;
New Window( "Example: LEV Density",
    y = Graph Box(
        Y Scale( 0, .08 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( LEV Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [LEV Distribution](#lev-distribution)

**Syntax:** p = LEV Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a largest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 10;
sig = 5;
New Window( "Example: LEV Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( LEV Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [LEV Quantile](#lev-quantile)

**Syntax:** q = LEV Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a largest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 10;
sig = 5;
qq = .5;
New Window( "Example: LEV Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( LEV Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( LEV Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 80, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [LogGenGamma Density](#loggengamma-density)

**Syntax:** y = LogGenGamma Density( x, mu, sigma, lambda )

**Description:** Returns the density at x of a log generalized gamma probability distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: LogGenGamma Density",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( LogGenGamma Density( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [LogGenGamma Distribution](#loggengamma-distribution)

**Syntax:** p = LogGenGamma Distribution( x, mu, sigma, lambda )

**Description:** Returns the probability that a log generalized gamma distributed random variable (with parameters mu, sigma, and lambda) is less than x.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
New Window( "Example: LogGenGamma Distribution",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( LogGenGamma Distribution( y, mu, sigma, lambda ), y );
        Text( {-9, 0.9}, "\!U03BC=", Round( mu, 4 ), " \!U03C3=", Round( sigma, 4 ) );
        Text( {-9, 0.8}, "\!U03BB=", Round( lambda, 4 ) );
    ),
    H List Box( Slider Box( -5, 5, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) )
);


```

### [LogGenGamma Quantile](#loggengamma-quantile)

**Syntax:** q = LogGenGamma Quantile( p, mu, sigma, lambda )

**Description:** Returns the quantile from a log generalized gamma distribution (with parameters mu, sigma, and lambda), the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

mu = 0;
sigma = 1;
lambda = 1;
p = 0.4;
New Window( "Example: LogGenGamma Quantile",
    gdey = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -20, 20 ),
        XName( "y" ),
        Pen Color( "red" );
        Y Function( LogGenGamma Distribution( x, mu, sigma, lambda ), x );
        Pen Color( "Blue" );
        V Line( LogGenGamma Quantile( p, mu, sigma, lambda ), 0, 1 );
        Text(
            {-19, 0.9},
            "\!U03BC=",
            Round( mu, 4 ),
            " \!U03C3=",
            Round( sigma, 4 ),
            " \!U03BB=",
            Round( lambda, 4 )
        );
        Text( {-19, 0.8}, "p=", Round( p, 3 ) );
        Text(
            {-19, 0.7},
            "quantile= ",
            Round( LogGenGamma Quantile( p, mu, sigma, lambda ), 2 )
        );
    ),
    H List Box( Slider Box( -2, 2, mu, gdey << reshow ), Text Box( "\!U03BC" ) ),
    H List Box( Slider Box( 0, 4, sigma, gdey << reshow ), Text Box( "\!U03C3" ) ),
    H List Box( Slider Box( 0, 10, lambda, gdey << reshow ), Text Box( "\!U03BB" ) ),
    H List Box( Slider Box( 0.01, 0.99, p, gdey << reshow ), Text Box( " p" ) )
);


```

### [Logistic Density](#logistic-density)

**Syntax:** y = Logistic Density( x, mu, sigma )

**Description:** Returns the density at x of a logistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Logistic Density",
    y = Graph Box(
        Y Scale( 0, 2 ),
        X Scale( -10, 10 ),
        Pen Color( "red" );
        Y Function( Logistic Density( x, mu, sig ), x );
        Text( {0, 1.8}, "mu=", Round( mu, 2 ) );
        Text( {0, 1.6}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( -4, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0.01, 2, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Logistic Distribution](#logistic-distribution)

**Syntax:** p = Logistic Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a logistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Logistic Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        Pen Color( "red" );
        Y Function( Logistic Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( -4, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0.01, 2, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Logistic Quantile](#logistic-quantile)

**Syntax:** q = Logistic Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a logistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
qq = .5;
New Window( "Example: Logistic Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -10, 10 ),
        Pen Color( "red" );
        Y Function( Logistic Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Logistic Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( -4, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0.01, 2, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Loglogistic Density](#loglogistic-density)

**Syntax:** y = Loglogistic Density( x, mu, sigma )

**Description:** Returns the density at x of a loglogistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Loglogistic Density",
    y = Graph Box(
        Y Scale( 0, .06 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Loglogistic Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Loglogistic Distribution](#loglogistic-distribution)

**Syntax:** p = Loglogistic Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a loglogistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
New Window( "Example: Loglogistic Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Loglogistic Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Loglogistic Quantile](#loglogistic-quantile)

**Syntax:** q = Loglogistic Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a loglogistic distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = .2;
qq = .5;
New Window( "Example: Loglogistic Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Loglogistic Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Loglogistic Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Lognormal Density](#lognormal-density)

**Syntax:** y = Lognormal Density( x, mu, sigma )

**Description:** Returns the density at x of a lognormal distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = 1;
New Window( "Example: Lognormal Density",
    y = Graph Box(
        Y Scale( 0, .15 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Lognormal Density( x, mu, sig ), x );
        Text( {0, .14}, "mu=", Round( mu, 2 ) );
        Text( {0, .12}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 2, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [Lognormal Distribution](#lognormal-distribution)

**Syntax:** p = Lognormal Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a lognormal distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = 1;
New Window( "Example: Lognormal Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Lognormal Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 2, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [Lognormal Quantile](#lognormal-quantile)

**Syntax:** q = Lognormal Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a lognormal distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 0;
sig = 1;
qq = .5;
New Window( "Example: Lognormal Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( Lognormal Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( Lognormal Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 4, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 3, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [Normal Biv Distribution](#normal-biv-distribution)

**Syntax:** y = Normal Biv Distribution( x, y, r, \<mu1=0>, \<s1=1>, \<mu2=0>, \<s2=1> )

**Description:** Computes the probability that an observation (X, Y) is less than or equal to (x, y) with correlation coefficient r where X is marginally normally distributed with mean mu1 and standard deviation s1 and Y is marginally normally distributed with mean mu2 and standard deviation s2. If mu1, s1, mu2, and s2 are not given, the function assumes the standard normal bivariate distribution with mu1=0, s1=1, mu2=0, and s2=1.

**JMP Version Added:** Before version 14

```

Normal Biv Distribution( -2, -2, .5, 1, 1.5, -1, 2 );


```

### [Normal Density](#normal-density)

**Syntax:** y = Normal Density( q, \<mu=0>, \<sigma=1> )

**Description:** Returns the density at q of a Normal distribution with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Density",
    y = Graph Box(
        Y Scale( 0, 0.45 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Density( q ), q );
    )
);


```

### [Normal Distribution](#normal-distribution)

**Syntax:** p = Normal Distribution( q, \<mu=0>, \<sigma=1> )

**Description:** Returns the probability that a normally distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Distribution( q ), q );
    )
);


```

### [Normal Log CDistribution](#normal-log-cdistribution)

**Syntax:** y = Normal Log CDistribution( x, \<mean=0>, <std dev=1> )

**Description:** Returns the log of 1 - Normal distribution at x with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Log CDistribution",
    nlcdiy = Graph Box(
        Y Scale( -10, 0.05 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Log CDistribution( q ), q );
    )
);


```

### [Normal Log Density](#normal-log-density)

**Syntax:** y = Normal Log Density( x, \<mu=0>, \<sigma=1>)

**Description:** Returns the log of the Normal probability density at x with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Log Density",
    nldey = Graph Box(
        Y Scale( -9, 0.05 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Log Density( q ), q );
    )
);


```

### [Normal Log Distribution](#normal-log-distribution)

**Syntax:** y = Normal Log Distribution( x, \<mean=0>, <std dev=1> )

**Description:** Returns the log of the Normal distribution at x with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

```

New Window( "Example: Normal Log Distribution",
    nldiy = Graph Box(
        Y Scale( -10, 0.05 ),
        X Scale( -4, 4 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Normal Log Distribution( q ), q );
    )
);


```

### [Normal Mixture Density](#normal-mixture-density)

**Syntax:** y = Normal Mixture Density(q, meanvec, sdvec, probvec)

**Description:** Returns the density at q of a normal mixture distribution with group means meanvec, group standard deviations sdvec, and group probabilities probvec. Here meanvec, sdvec, and probvec are all vectors of the same size.

**JMP Version Added:** Before version 14

```

mu1 = -2;
mu2 = 2;
sigma1 = 1;
sigma2 = 4;
p1 = .5;
t1 = mu1 |/ mu2;
t2 = sigma1 |/ sigma2;
t3 = p1 |/ (1 - p1);
New Window( "Univariate Normal Mixture Density",
    clty = Graph Box(
        Y Scale( 0, 0.4 ),
        X Scale( -8, 8 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        t1 = mu1 |/ mu2;
        t2 = sigma1 |/ sigma2;
        t3 = p1 |/ (1 - p1);
        Y Function(
            Normal Mixture Density( y, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            y
        );
        Text( {-7, .37}, "Mean1=", Round( mu1, 2 ) );
        Text( {-2, .37}, "Mean2=", Round( mu2, 2 ) );
        Text( {-7, .34}, "SD1=", Round( sigma1, 2 ) );
        Text( {-2, .34}, "SD2=", Round( sigma2, 2 ) );
        Text( {-7, .31}, "P1=", Round( p1, 2 ) );
        Text( {-2, .31}, "P2=", Round( 1 - p1, 2 ) );
    ),
    H List Box( Slider Box( -3, 3, mu1, clty << reshow ), Text Box( " Mean 1" ) ),
    H List Box( Slider Box( -3, 3, mu2, clty << reshow ), Text Box( " Mean 2" ) ),
    H List Box( Slider Box( .1, 9, sigma1, clty << reshow ), Text Box( " Std Dev 1" ) ),
    H List Box( Slider Box( .1, 9, sigma2, clty << reshow ), Text Box( " Std Dev 2" ) ),
    H List Box( Slider Box( 0, 1, p1, clty << reshow ), Text Box( " P 1" ) ), 

);


```

### [Normal Mixture Distribution](#normal-mixture-distribution)

**Syntax:** y = Normal Mixture Distribution(q, meanvec, sdvec, probvec)

**Description:** Returns the probability that a normal mixture distributed variable with group means meanvec, group standard deviations sdvec, and group probabilities probvec is less than q. Here meanvec, sdvec, and probvec are all vectors of the same size.

**JMP Version Added:** Before version 14

```

mu1 = -2;
mu2 = 2;
sigma1 = 1;
sigma2 = 4;
p1 = .5;
New Window( "Univariate Normal Mixture Distribution",
    clty = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -8, 8 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        Y Function(
            Normal Mixture Distribution( y, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            y
        );
        Text( {-7, .95}, "Mean1=", Round( mu1, 2 ) );
        Text( {-2, .95}, "Mean2=", Round( mu2, 2 ) );
        Text( {-7, .85}, "SD1=", Round( sigma1, 2 ) );
        Text( {-2, .85}, "SD2=", Round( sigma2, 2 ) );
        Text( {-7, .75}, "P1=", Round( p1, 2 ) );
        Text( {-2, .75}, "P2=", Round( 1 - p1, 2 ) );
    ),
    H List Box( Slider Box( -3, 3, mu1, clty << reshow ), Text Box( " Mean 1" ) ),
    H List Box( Slider Box( -3, 3, mu2, clty << reshow ), Text Box( " Mean 2" ) ),
    H List Box( Slider Box( .1, 9, sigma1, clty << reshow ), Text Box( " Std Dev 1" ) ),
    H List Box( Slider Box( .1, 9, sigma2, clty << reshow ), Text Box( " Std Dev 2" ) ),
    H List Box( Slider Box( 0, 1, p1, clty << reshow ), Text Box( " P 1" ) ), 

);


```

### [Normal Mixture Quantile](#normal-mixture-quantile)

**Syntax:** q = Normal Mixture Quantile(p, meanvec, sdvec, probvec)

**Description:** Returns the quantile from a normal mixture distribution, the values for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

extqdf = 1;
extqqq = 0.5;
mu1 = -1;
mu2 = 1;
sigma1 = 1;
sigma2 = 4;
p1 = .3;
New Window( "Example: Normal Mixture Quantile",
    extqgr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Pen Size( 2 );
        Y Function(
            Normal Mixture Distribution( q, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            q
        );
        Pen Color( "blue" );
        V Line(
            Normal Mixture Quantile( extqqq, mu1 |/ mu2, sigma1 |/ sigma2, p1 |/ (1 - p1) ),
            0,
            1
        );
        Text( {-4.5, 0.9}, " quantile=", Round( extqqq, 2 ) );
    ),
    H List Box( Slider Box( 0.01, 0.99, extqqq, extqgr << reshow ), Text Box( " quantile" ) ),
    H List Box( Slider Box( -3, 3, mu1, extqgr << reshow ), Text Box( " Mean 1" ) ),
    H List Box( Slider Box( -3, 3, mu2, extqgr << reshow ), Text Box( " Mean 2" ) ),
    H List Box( Slider Box( .1, 9, sigma1, extqgr << reshow ), Text Box( " Std Dev 1" ) ),
    H List Box( Slider Box( .1, 9, sigma2, extqgr << reshow ), Text Box( " Std Dev 2" ) ),
    H List Box( Slider Box( 0, 1, p1, extqgr << reshow ), Text Box( " P 1" ) ), 

);


```

### [Normal Quantile](#normal-quantile)

**Syntax:** q = Normal Quantile( p, \<mu=0>, \<sigma=1> ); q = Probit( p )

**Description:** Returns the quantile from a Normal distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

Normal Quantile( 0.9 );


```

### [Probit](#probit)

**Syntax:** q = Normal Quantile( p, \<mu=0>, \<sigma=1> ); q = Probit( p )

**Description:** Returns the quantile from a Normal distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

Normal Quantile( 0.9 );


```

### [SEV Density](#sev-density)

**Syntax:** y = SEV Density( x, mu, sigma )

**Description:** Returns the density at x of a smallest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 50;
sig = 5;
New Window( "Example: SEV Density",
    y = Graph Box(
        Y Scale( 0, .06 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( SEV Density( x, mu, sig ), x );
        Text( {0, .055}, "mu=", Round( mu, 2 ) );
        Text( {0, .045}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( "mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( "sig" ) ), 

);


```

### [SEV Distribution](#sev-distribution)

**Syntax:** p = SEV Distribution( x, mu, sigma )

**Description:** Returns the probability at x of a smallest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 50;
sig = 5;
New Window( "Example: SEV Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( SEV Distribution( x, mu, sig ), x );
        Text( {0.1, 0.9}, "mu=", Round( mu, 2 ) );
        Text( {0.1, 0.8}, "sig=", Round( sig, 2 ) );
    ),
    H List Box( Slider Box( 0, 100, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) )
);


```

### [SEV Quantile](#sev-quantile)

**Syntax:** q = SEV Quantile( p, mu, sigma )

**Description:** Returns the quantile at p of a smallest extreme distribution with location mu and scale sigma.

**JMP Version Added:** Before version 14

```

mu = 50;
sig = 5;
qq = .5;
New Window( "Example: SEV Quantile",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 60 ),
        Pen Color( "red" );
        Y Function( SEV Distribution( qq, mu, sig ), qq );
        Pen Color( "blue" );
        V Line( SEV Quantile( qq, mu, sig ), 0, 1 );
        Text(
            {0.1, 0.9},
            " mu=",
            Round( mu, 2 ),
            " sig=",
            Round( sig, 2 ),
            " quantile=",
            Round( qq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 80, mu, y << reshow ), Text Box( " mu" ) ),
    H List Box( Slider Box( 0, 10, sig, y << reshow ), Text Box( " sig" ) ),
    H List Box( Slider Box( 0.01, 0.99, qq, y << reshow ), Text Box( " quantile" ) )
);


```

### [SHASH Density](#shash-density)

**Syntax:** d = SHASH Density( x, gamma, delta, theta, sigma )

**Description:** Returns the density at x of a sinh-arcsinh (SHASH) distribution. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

**Example 1**

```

SHASH Density( 0, -1, 2, -2, 3 );


```

#### [SHASH Transformation](#shash-transformation)

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [SHASH Distribution](#shash-distribution)

**Syntax:** p = SHASH Distribution( q, gamma, delta, theta, sigma )

**Description:** Returns the probability that a sinh-arcsinh (SHASH) distributed random variable is less than q. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

**Example 1**

```

gamma = 0.5;
delta = 1;
theta = 1;
sigma = 1;
New Window( "Example: SHASH Distribution",
    jsuc = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -2, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( SHASH Distribution( q, gamma, delta, theta, sigma ), q );
        Text(
            {-1, 0.9},
            "\!U03B3=",
            Round( gamma, 2 ),
            " \!U03B4=",
            Round( delta, 2 ),
            " \!U03B8=",
            Round( theta, 2 ),
            " \!U03C3=",
            Round( sigma, 2 )
        );
    ),
    H List Box( Slider Box( 0, 1, gamma, jsuc << reshow ), Text Box( " \!U03B3" ) ),
    H List Box( Slider Box( 0, 2, delta, jsuc << reshow ), Text Box( " \!U03B4" ) ),
    H List Box( Slider Box( 0, 2, theta, jsuc << reshow ), Text Box( " \!U03B8" ) ),
    H List Box( Slider Box( 0, 2, sigma, jsuc << reshow ), Text Box( " \!U03C3" ) )
);


```

#### [SHASH Transformation](#shash-transformation_1)

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [SHASH Quantile](#shash-quantile)

**Syntax:** q = SHASH Quantile( p, gamma, delta, theta, sigma )

**Description:** Returns the quantile from a sinh-arcsinh (SHASH) distribution, the value for which the probability is p that a random value would be lower. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

**Example 1**

```

SHASH Quantile( .5, 1, 2, 3, 1 );


```

#### [SHASH Transformation](#shash-transformation_2)

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [Students t Density](#students-t-density)

**Syntax:** p = t Density( q, df, \<nonCentrality=0> )

**Description:** Returns the density function of Student's t.

**JMP Version Added:** Before version 14

```

tdedf = 1;
New Window( "Example: Students t Density",
    tdegr = Graph Box(
        Y Scale( -.05, 0.45 ),
        X Scale( -8, 8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Density( tdeq, Exp( tdedf ) ), tdeq );
        H Line( 2, 3, 0.3 );
        Pen Color( "blue" );
        Y Function( Normal Density( tdeq ), tdeq );
        H Line( 2, 3, 0.25 );
        Text( {2, 0.35}, "df=", Round( Exp( tdedf ), 2 ) );
        Text( {3.5, 0.3}, "Student t" );
        Text( {3.5, 0.25}, "Normal" );
    ),
    H List Box(
        Text Box( "df " ),
        Slider Box( Log( 0.1 ), Log( 1000 ), tdedf, tdegr << reshow )
    )
);


```

### [Students t Distribution](#students-t-distribution)

**Syntax:** p = t Distribution( q, df, \<nonCentrality=0> )

**Description:** Returns the probability that a Student's t distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

tdidf = 1;
New Window( "Example: Students t Distribution",
    tdigr = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( tdiq, tdidf ), tdiq );
        Text( {-4.5, 0.9}, "df=", Round( tdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tdidf, tdigr << reshow ) )
);


```

### [Students t Quantile](#students-t-quantile)

**Syntax:** q = t Quantile( p, df, \<nonCentrality=0> )

**Description:** Returns the quantile from a Student's t distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

extqdf = 1;
extqqq = 0.5;
New Window( "Example: Students t Quantile",
    extqgr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( q, Round( extqdf ) ), q );
        Pen Color( "blue" );
        V Line( t Quantile( extqqq, Round( extqdf ) ), 0, 1 );
        Text( {-4.5, 0.9}, "df=", Round( extqdf, 2 ), " quantile=", Round( extqqq, 2 ) );
    ),
    H List Box( Slider Box( 1, 30, extqdf, extqgr << reshow ), Text Box( " df" ) ),
    H List Box( Slider Box( 0.01, 0.99, extqqq, extqgr << reshow ), Text Box( " quantile" ) ), 

);


```

### [Tukey HSD P value](#tukey-hsd-p-value)

**Syntax:** p = Tukey HSD P value( q, nGroups, dfe )

**Description:** Returns the p-value from Tukey's HSD multiple comparisons test, where q is the test statistic, nGroups is the number of groups in the study, and dfe is the error degrees of freedom (based on the total study sample).

Note that q is Tukey's adjusted critical value, which is the quantile of Tukey's studentized range distribution divided by the sqrt(2).

**JMP Version Added:** Before version 14

```

Tukey HSD P value( 3.73, 6, 34 );


```

### [Tukey HSD Quantile](#tukey-hsd-quantile)

**Syntax:** q = Tukey HSD Quantile( 1-alpha, nGroups, dfe )

**Description:** Returns the quantile needed in Tukey's HSD multiple comparisons test, where 1-alpha is the confidence level, nGroups is the number of groups in the study, and dfe is the error degrees of freedom (based on the total study sample).

Note that q is Tukey's adjusted critical value, which is the quantile of Tukey's studentized range distribution divided by the sqrt(2).

**JMP Version Added:** Before version 14

```

alpha = 0.05;
dfe = 5;
Tukey HSD Quantile( 1 - alpha, 20, dfe );
New Window( "Example: Tukey HSD Quantile",
    tdigr = Graph Box(
        Y Scale( 2, 8 ),
        X Scale( 2.5, 15.5 ),
        YName( "Tukey HSD Quantile" ),
        XName( "Groups" ),
        Pen Color( "red" );
        For( i = 3, i <= 15, i++,
            V Line( i, 0, Tukey HSD Quantile( 1 - alpha, i, dfe ) )
        );
        Text( {3, 7}, "dfe=", Round( dfe, 2 ) );
    ),
    H List Box( Text Box( "dfe" ), Slider Box( 3, 10, dfe, tdigr << reshow ) )
);


```

### [Weibull Density](#weibull-density)

**Syntax:** y = Weibull Density( x, shape, \<scale=1>, \<threshold=0> )

**Description:** Returns the density at x of a Weibull probability distribution with a shape parameter and optional scale parameter.

**JMP Version Added:** Before version 14

```

shape = 0.5;
New Window( "Example: Weibull Density",
    y = Graph Box(
        Y Scale( 0, 2 ),
        X Scale( 0, 1.5 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Weibull Density( x, shape ), x );
        Text( {1.1, 1.8}, " shape=", Round( shape, 2 ) );
    ),
    H List Box( Slider Box( 0, 5, shape, y << reshow ), Text Box( " shape" ) )
);


```

### [Weibull Distribution](#weibull-distribution)

**Syntax:** p = Weibull Distribution( x, shape, \<scale=1>, \<threshold=0> )

**Description:** Returns the probability that a Weibull distributed random variable (with a shape parameter and optional scale parameter) is less than x.

**JMP Version Added:** Before version 14

```

shape = 2;
New Window( "Example: Weibull Distribution",
    y = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( 0, 2 ),
        XName( "x" ),
        Pen Color( "red" );
        Y Function( Weibull Distribution( x, shape ), x );
        Text( {0.1, 0.9}, " shape=", Round( shape, 2 ) );
    ),
    H List Box( Slider Box( 0, 5, shape, y << reshow ), Text Box( " shape" ) )
);


```

### [Weibull Quantile](#weibull-quantile)

**Syntax:** q = Weibull Quantile( p, beta, \<alpha=1>, \<threshold=0> )

**Description:** Returns the quantile from a Weibull distribution, the value for which the probability is p that a random value would be lower, where beta and alpha are the shape and scale parameters, respectively.

**JMP Version Added:** Before version 14

```

exwqbeta = 2;
exwqqq = 0.5;
New Window( "Example: Weibull Quantile",
    exwqy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( 0, 2 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( Weibull Distribution( exwqq, exwqbeta ), exwqq );
        Pen Color( "blue" );
        V Line( Weibull Quantile( exwqqq, exwqbeta ), 0, 1 );
        Text(
            {0.1, 0.9},
            " \!U03B2=",
            Round( exwqbeta, 2 ),
            " quantile=",
            Round( exwqqq, 2 )
        );
    ),
    H List Box( Slider Box( 0, 5, exwqbeta, exwqy << reshow ), Text Box( " \!U03B2" ) ),
    H List Box( Slider Box( 0.01, 0.99, exwqqq, exwqy << reshow ), Text Box( " quantile" ) )
);


```

### [t Density](#t-density)

**Syntax:** p = t Density( q, df, \<nonCentrality=0> )

**Description:** Returns the density function of Student's t.

**JMP Version Added:** Before version 14

```

tdedf = 1;
New Window( "Example: Students t Density",
    tdegr = Graph Box(
        Y Scale( -.05, 0.45 ),
        X Scale( -8, 8 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Density( tdeq, Exp( tdedf ) ), tdeq );
        H Line( 2, 3, 0.3 );
        Pen Color( "blue" );
        Y Function( Normal Density( tdeq ), tdeq );
        H Line( 2, 3, 0.25 );
        Text( {2, 0.35}, "df=", Round( Exp( tdedf ), 2 ) );
        Text( {3.5, 0.3}, "Student t" );
        Text( {3.5, 0.25}, "Normal" );
    ),
    H List Box(
        Text Box( "df " ),
        Slider Box( Log( 0.1 ), Log( 1000 ), tdedf, tdegr << reshow )
    )
);


```

### [t Distribution](#t-distribution)

**Syntax:** p = t Distribution( q, df, \<nonCentrality=0> )

**Description:** Returns the probability that a Student's t distributed random variable is less than q.

**JMP Version Added:** Before version 14

```

tdidf = 1;
New Window( "Example: Students t Distribution",
    tdigr = Graph Box(
        Y Scale( 0, 1 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( tdiq, tdidf ), tdiq );
        Text( {-4.5, 0.9}, "df=", Round( tdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tdidf, tdigr << reshow ) )
);


```

### [t Log CDistribution](#t-log-cdistribution)

**Syntax:** y = t Log CDistribution( x, df, <nc> )

**Description:** Returns the log of 1 - t distribution.

**JMP Version Added:** Before version 14

```

tlcdidf = 1;
New Window( "Example: Students t Log CDistribution",
    tlcdigr = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Log CDistribution( tlcdiq, tlcdidf ), tlcdiq );
        Text( {-4.5, -0.9}, "df=", Round( tlcdidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tlcdidf, tlcdigr << reshow ) )
);


```

### [t Log Density](#t-log-density)

**Syntax:** y = t Log Density( x, df, <nc> )

**Description:** Returns the log of the t probability density.

**JMP Version Added:** Before version 14

```

tldedf = 1;
New Window( "Example: Students t Log Density",
    tldegr = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Log Density( tldeq, tldedf ), tldeq );
        Text( {2.5, -0.35}, "df=", Round( tldedf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 0.5, 10, tldedf, tldegr << reshow ) )
);


```

### [t Log Distribution](#t-log-distribution)

**Syntax:** y = t Log Distribution( x, df, <nc> )

**Description:** Returns the log of the t distribution.

**JMP Version Added:** Before version 14

```

tldidf = 1;
New Window( "Example: Students t Log Distribution",
    tldigr = Graph Box(
        Y Scale( -4, 0.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Log Distribution( tldiq, tldidf ), tldiq );
        Text( {-4.5, -0.9}, "df=", Round( tldidf, 2 ) );
    ),
    H List Box( Text Box( "df " ), Slider Box( 1, 10, tldidf, tldigr << reshow ) )
);


```

### [t Noncentrality](#t-noncentrality)

**Syntax:** nc = t Noncentrality( x, df, prob )

**Description:** Solves for the noncentrality parameter of a Student's t distribution such that prob = t Distribution( x, df, nc ).

**JMP Version Added:** Before version 14

```

New Window( "Example: t Noncentrality",
    tncgr = Graph Box(
        Y Scale( 0.01, 0.99 ),
        X Scale( 0.01, 0.99 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( 3, 2, t Noncentrality( 3, 2, q ) ), q );
    )
);
t Distribution( 3, 2, t Noncentrality( 3, 2, 0.5 ) );


```

### [t Quantile](#t-quantile)

**Syntax:** q = t Quantile( p, df, \<nonCentrality=0> )

**Description:** Returns the quantile from a Student's t distribution, the value for which the probability is p that a random value would be lower.

**JMP Version Added:** Before version 14

```

extqdf = 1;
extqqq = 0.5;
New Window( "Example: Students t Quantile",
    extqgr = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -5, 5 ),
        XName( "q" ),
        Pen Color( "red" );
        Y Function( t Distribution( q, Round( extqdf ) ), q );
        Pen Color( "blue" );
        V Line( t Quantile( extqqq, Round( extqdf ) ), 0, 1 );
        Text( {-4.5, 0.9}, "df=", Round( extqdf, 2 ), " quantile=", Round( extqqq, 2 ) );
    ),
    H List Box( Slider Box( 1, 30, extqdf, extqgr << reshow ), Text Box( " df" ) ),
    H List Box( Slider Box( 0.01, 0.99, extqqq, extqgr << reshow ), Text Box( " quantile" ) ), 

);


```

# [Programming](#programming)

### [Add Custom Functions](#add-custom-functions)

**Syntax:** Add Custom Functions({f1, f2, ...} | f)

**Description:** Defines a list of custom functions for use in scripting and the Formula Editor. The command also adds the list to the environment.

**JMP Version Added:** 14

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y}, x + y - 1 ) );
mySub = New Custom Function( "custom", "Sub", Function( {x, y}, x - y + 1 ) );
Add Custom Functions( {myAdd, mySub} );


```

### [As Boolean](#as-boolean)

**Syntax:** b = As Boolean( x )

**Description:** Evaluates an expression and returns a Boolean value.

**JMP Version Added:** 14

```

x = 45;
b = As Boolean( x > 2 );
Show( b );


```

### [As Column](#as-column)

**Syntax:** y = :name; y = dataTable:name; y = As Column( name ); y = As Column( dataTable, name )

**Description:** Accesses the specified column in the specified or current data table. An error is thrown if no such column or data table is found.

**JMP Version Added:** Before version 14

```

exdt = Open( "$SAMPLE_DATA/Big Class.jmp" );
exdt:height[1] + :height[2] + As Column( "height" )[3];


```

### [As Constant](#as-constant)

**Syntax:** y = As Constant( x )

**Description:** Evaluates an expression to create a constant value that does not change after it has been computed

**JMP Version Added:** Before version 14

**Example 1**

```

New Table( "As Constant Demo Table 1",
    Add Rows( 10 ),
    New Column( "Non-Constant", Formula( Random Uniform() ) ),
    New Column( "Constant", Formula( As Constant( Random Uniform() ) ) )
);


```

**Example 2**

```

New Table( "As Constant Demo Table 2",
    Add Rows( 1000 ),
    New Column( "What's on Your Desktop?",
        "character",
        Formula(
            As Constant( xFiles = Files In Directory( "$Desktop" ) );
            iR = Row();
            If( iR <= N Items( xFiles ),
                xFiles[iR],
                "---"
            );
        )
    )
);


```

**Example 3**

```

For( i = 1, i <= 10, i++,
    x = 2;
    y = 100;
    z = As Constant( x + y );
    x *= i;
    y /= i;
    Show( i, x + y, z );
);


```

### [As Global](#as-global)

**Syntax:** y = ::name; y = As Global( name )

**Description:** Accesses the specified global variable or throws an error if no such global variable exists.

**JMP Version Added:** Before version 14

```

::ex = 23;
Local( {ex = 12}, Eval List( {ex, ::ex, As Global( "ex" )} ) );


```

### [As List](#as-list)

**Syntax:** y = As List( matrix )

**Description:** Returns a list representation of a matrix. Multi-column matrices are converted to a list of lists, one per row, as would be expected by the Matrix operator.

**JMP Version Added:** Before version 14

```

As List( [11 22 33, 44 55 66] );


```

### [As Name](#as-name)

**Syntax:** y = As Name( s )

**Description:** Converts a string into a name or a list of strings into a list of names.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:(As Name( "height" ))[3];


```

### [As Namespace](#as-namespace)

**Syntax:** asns = As Namespace( ns )

**Description:** Accesses the specified Namespace or throws an error if no such namespace exists.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex"
);
As Namespace( ns );


```

### [As Root](#as-root)

**Syntax:** y = :::name; y = As Root( name )

**Description:** Accesses the specified root-scoped variable or throws an error if no such root-scoped variable exists.

**JMP Version Added:** 15

```

::: ex = 23;
Local( {ex = 12}, Eval List( {ex, ::: ex, As Global( "ex" )} ) );


```

### [As Scoped](#as-scoped)

**Syntax:** y = namespace:variable; y = As Scoped( namespace, variable )

**Description:** Accesses the specified scoped variable or throws an error if no such scoped variable exists.

**JMP Version Added:** Before version 14

```

Here:z = 23.5;
As Scoped( Here, z );


```

### [Associative Array](#associative-array)

**Syntax:** y = Associative Array( {{key1, value1}, ...} ); y = Associative Array( keys, values )

**Description:** Creates an associative array, which is also known as a dictionary or a hash map. In the two-argument form, keys and values can be a list, matrix, or data table column.

**JMP Version Added:** Before version 14

```

ex = Associative Array( {"red", "blue"}, {1, 2} );
ex["green"] = 3;
ex << get contents;


```

### [Choose Closest](#choose-closest)

**Syntax:** Choose Closest(source string, {canonical strings...}, \<Ignore Case(ignore=1|0)>, \<Ignore Nonprintable(ignore=1|0)>, \<Ignore Whitespace(ignore=1|0)>, \<Max Edit Count(count)>, \<Max Edit Ratio([0..1])>, \<Min String Length(\<count=3>)>, \<Replace Unmatched(replace=0|1)>, \<Unmatched Value(\<value="">)>)

**Description:** Pick the closest string within the given rules and return it.

By default character case is ignored; use Ignore Case to specify.

By default non-printable characters are ignored; Use Ignore Nonprintable to specify.

By default, whitespace is ignored; use Ignore Whitespace to specify.

By default, character changes are not allowed to find a match.

```
Use Max Edit Count to control how many edits may be made.

Use Max Edit Ratio to control the percent change (in terms of characters in the original string) that is allowed.

Both of these settings are applied if specified.

```

By default, strings shorter than 3 characters will not be matched; use Min String Length to specify a different length.

Unmatched strings

```
By default, if no canonical string matches within the given rules, the source string is returned.

Use Replace Unmatched to specify whether the source string will be returned.

Use Unmatched to specify the value to be returned.

```

**JMP Version Added:** 15

#### [Allow edits](#allow-edits)

```

Choose Closest( "MARTA", {"MARTHA"}, Max Edit Count( 2 ) );


```

#### [Choose among strings, no edits](#choose-among-strings-no-edits)

```

Choose Closest( "MARTHA_", {"Martha", "MARY"} );


```

#### [Keep punctuation](#keep-punctuation)

```

Choose Closest( "MARTHA_", {"MARTHA"}, Ignore Punctuation( 0 ) );


```

#### [Unmatched](#unmatched)

```

Choose Closest( "MARTHA", {"Martha"}, Ignore Case( 0 ), Unmatched() );


```

### [Class Exists](#class-exists)

**Syntax:** nsexists = Class Exists( class name )

**Description:** Returns 1 if the class specified by the name argument exists. Otherwise, a 0 is returned.

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
clexists = Class Exists( cl );
Show( clexists );
cl << Delete;
Delete Classes( "complex" );


```

### [Clear Globals](#clear-globals)

**Syntax:** Clear Globals( < varname, ... > )

**Description:** Clears the values of all currently defined global symbols.

**JMP Version Added:** Before version 14

```

Clear Globals();


```

### [Clear Log](#clear-log)

**Syntax:** Clear Log()

**Description:** Makes the log empty.

**JMP Version Added:** Before version 14

```

Clear Log();


```

### [Clear Symbols](#clear-symbols)

**Syntax:** Clear Symbols( < varname, ... > )

**Description:** Clears the values of all currently defined symbols.

**JMP Version Added:** Before version 14

```

Clear Symbols();


```

### [Close Log](#close-log)

**Syntax:** Close Log()

**Description:** Close the log window

**JMP Version Added:** Before version 14

```

Close Log();
Show( Is Log Open() );


```

### [Define Class](#define-class)

**Syntax:** Define Class("class name", \<Base Class{ "base class name", ... }>, \<Show( All( boolean ) | ( Members( boolean ) | Methods( boolean ) | Functions( boolean ) )+ )>, { method *| member* | function\* } )

**Description:** Define a New Class

**JMP Version Added:** 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
cl << Delete;
Delete Classes( complex );


```

### [Delete Classes](#delete-classes)

**Syntax:** Delete Classes( \<Force( boolean )>, \<class reference, ...> )

**Description:** Deletes all class definitions or one or more specific class definitions.

**JMP Version Added:** Before version 14

```

Define Class(
    "aa",
    {_init_ = Method( {} ), x = 1, m1 = Method( {a, b}, a * b )}
);
Define Class(
    "bb",
    {_init_ = Method( {} ), y = 1, m2 = Method( {a, b}, a / b )}
);
lcaa = New Object( aa() );
lcbb = New Object( bb() );
lcl = Get Classes();
Show( lcl );
Show Classes();
Clear Symbols( lcl );
lcaa << Delete;
lcbb << Delete;
Delete Classes( "aa", "bb" );
Show Classes();


```

### [Delete Globals](#delete-globals)

**Syntax:** Delete Globals( < varname, ... > )

**Description:** Deletes all the currently defined global symbols and their values.

**JMP Version Added:** Before version 14

```

Delete Globals();


```

### [Delete Namespaces](#delete-namespaces)

**Syntax:** Delete Namespaces( \<Force( boolean )>, \<namespace reference, ...> )

**Description:** Deletes all namespaces or one or more specific namespaces.

**JMP Version Added:** Before version 14

```


nsaa = New Namespace(
    "aa",
    {
        x = 1
    }
);
nsbb = New Namespace(
    "bb",
    {
        y = 1
    }
);
Show Namespaces();
Delete Namespaces( nsaa, nsbb );
Show Namespaces();


```

### [Delete Symbols](#delete-symbols)

**Syntax:** Delete Symbols( < varname, ... > )

**Description:** Deletes all the currently defined symbols and their values.

**JMP Version Added:** Before version 14

```

Delete Symbols();


```

### [Eval](#eval)

**Syntax:** y = Eval( x )

**Description:** Evaluates the argument and returns the result.

**JMP Version Added:** Before version 14

```

Eval( Expr( 1 + 2 ) );


```

### [Eval Insert](#eval-insert)

**Syntax:** y = Eval Insert( string, \<startChar="^">, \<endChar=startChar> )

**Description:** Looks for substrings enclosed by the startChar/endChar pair and replaces them with the evaluated expression within.

**JMP Version Added:** Before version 14

```

Eval Insert( "Today is ^As Date( Today())^" );


```

### [Eval Insert Into](#eval-insert-into)

**Syntax:** Eval Insert Into( l_string, \<startChar="^">, \<endChar=startChar> )

**Description:** Looks for substrings enclosed by the startChar/endChar pair and replaces them with the evaluated expression within, replacing l_string.

**JMP Version Added:** Before version 14

```

ex = "Today is ^As Date( Today())^";
Eval Insert Into( ex );
ex;


```

### [Eval List](#eval-list)

**Syntax:** y = Eval List( list )

**Description:** Returns a list where every item in the list has been evaluated.

**JMP Version Added:** Before version 14

**Example 1**

```

Eval List( {1 + 2, 3 + 4} );


```

**Example 2**

```

x = 5;
y = 10;
Eval List( {x, y} );


```

### [Exit](#exit)

**Syntax:** Quit(\<"No Save">); Exit(\<"No Save">)

**Description:** Exits JMP.

**JMP Version Added:** Before version 14

```

If(
    New Window( "Exit() example",
        <<Type( "Modal" ),
        Text Box( "Shut down JMP?" ),
        H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
    )["Button"] == 1, /*OK==1*/Exit(), /*cancel==-1*/"Good choice."
);


```

### [First](#first)

**Syntax:** y = First( x1, x2, ... )

**Description:** Evaluates each argument and returns the value of the first argument.

**JMP Version Added:** Before version 14

```

First( 11, 22 );


```

### [Function](#function)

**Syntax:** y = Function( {arg1=val1, ...}, \<{local1=val1, ...}>, expr )

**Description:** Defines a function with the specified arguments, default values, and optional local variables. Arguments with default values are optional on invocation of the function. If Return() is used within the function's script, the expression within is returned.

**JMP Version Added:** Before version 14

**Example 1**

```

exsqr = Function( {x}, x * x );
exsqr( 5 );


```

**Example 2**

```

// y is an optional argument
exmul = Function( {x, y = 3}, x * y );
a = exmul( 5 );
b = exmul( 5, 10 );
Show( a, b );


```

**Example 3**

```

posorneg = Function( {x},
    {},
    If(
        x > 0, Return( "positive" ),
        x == 0, Return( "zero" ),
        Return( "negative" )
    )
);
posorneg( -5.5 );


```

### [Get Class Names](#get-class-names)

**Syntax:** Get Class Names( < <class reference>, ... > )

**Description:** Returns a list of names of all currently defined classes.

**JMP Version Added:** 14

```

Define Class(
    "aa",
    {_init_ = Method( {} ), x = 1, m1 = Method( {a, b}, a * b )}
);
Define Class(
    "bb",
    {_init_ = Method( {} ), y = 1, m2 = Method( {a, b}, a / b )}
);
lcaa = New Object( aa() );
lcbb = New Object( bb() );
lcl = Get Class Names();
Show( lcl );
lcaa << Delete;
lcbb << Delete;
Delete Classes( "aa", "bb" );


```

### [Get Classes](#get-classes)

**Syntax:** Get Classes( < <class reference>, ... > )

**Description:** Returns a list of references to all currently defined classes

**JMP Version Added:** Before version 14

```

Define Class(
    "aa",
    {_init_ = Method( {} ), x = 1, m1 = Method( {a, b}, a * b )}
);
Define Class(
    "bb",
    {_init_ = Method( {} ), y = 1, m2 = Method( {a, b}, a / b )}
);
lcaa = New Object( aa() );
lcbb = New Object( bb() );
lcl = Get Classes();
Show( lcl );
Clear Symbols( lcl );
lcaa << Delete;
lcbb << Delete;
Delete Classes( "aa", "bb" );


```

### [Get Custom Functions](#get-custom-functions)

**Syntax:** Get Custom Functions(\<{function 1 full name, function 2 full name, ...} | function full name>)

**Description:** Get a list of custom functions

**JMP Version Added:** 14

**Example 1**

```

Get Custom Functions();


```

**Example 2**

```

Get Custom Functions( {"custom:Add", "custom:Sub"} );


```

### [Get Environment Variable](#get-environment-variable)

**Syntax:** value = Get Environment Variable( string )

**Description:** Returns the value of the specified environment variable from the operating system.

NOTE: On the Macintosh operating system, the variable name is case-sensitive.

**JMP Version Added:** Before version 14

```

Get Environment Variable( "PATH" );


```

### [Get Locale Setting](#get-locale-setting)

**Syntax:** value = Get Locale Setting( settingName )

**Description:** Retrieves a locale setting such as decimal separator

**JMP Version Added:** 16

```

Get Locale Setting( "Decimal Separator" );


```

### [Get Log](#get-log)

**Syntax:** list = Get Log( <N> )

**Description:** Returns a list of lines from the log. If no argument is specified, all the lines from the log are returned. If the numeric argument N is positive, the first N lines from the log are returned. If N is negative, the last N lines from the log are returned. If N is zero, no lines are returned.

**JMP Version Added:** Before version 14

```

all contents = Get Log();
headcontents = Get Log( 10 );
tailcontents = Get Log( -5 );


```

### [Get Namespace Names](#get-namespace-names)

**Syntax:** Get Namespace Names( < <namespace reference>, ... > )

**Description:** Returns a list of names of all currently defined namespaces.

**JMP Version Added:** 14

```

nsaa = New Namespace(
    "aa",
    {
        x = 1
    }
);
nsbb = New Namespace(
    "bb",
    {
        y = 1
    }
);
lns = Get Namespace Names();
Show( lns );
nsaa << Delete;
nsbb << Delete;


```

### [Get Namespaces](#get-namespaces)

**Syntax:** Get Namespaces( < <namespace reference>, ... > )

**Description:** Returns a list of references to all currently defined namespaces

**JMP Version Added:** Before version 14

```

nsaa = New Namespace(
    "aa",
    {
        x = 1
    }
);
nsbb = New Namespace(
    "bb",
    {
        y = 1
    }
);
lns = Get Namespaces();
Show( lns );
Clear Symbols( lns );
nsaa << Delete;
nsbb << Delete;


```

### [Get Punctuation Characters](#get-punctuation-characters)

**Syntax:** Get Punctuation Characters(\<Exclude Chars(chars) | Include Chars(chars)>)

**Description:** Returns a string containing the punctuation characters that are typically used for delimiting words. These include ,:;.?!/#@&~()[]\<>"\*\`%$+=^|{} and some common Unicode punctuation.

**JMP Version Added:** 15

**Example 1**

```

Get Punctuation Characters();


```

**Example 2**

```

Get Punctuation Characters( Include Chars( "_" ) );


```

**Example 3**

```

Get Punctuation Characters( Exclude Chars( "$[]" ) );


```

**Example 4**

```

Collapse Whitespace(
    Substitute( "This...string..has..dots", Items( Get Punctuation Characters(), "" ), " " )
);


```

### [Get Session Script](#get-session-script)

**Syntax:** Get Session Script( win1, ... )

**Description:** Returns the session script for the specified windows. The session script is a JSL expression that will recreate the given windows, including data tables, script windows, journals, and reports. Reports created via JSL scripts have limited support, and will only attempt to recreate the display layout.

**JMP Version Added:** 17

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << RunScript( "Bivariate" );
Get Session Script( Report( biv ) );


```

### [Get Whitespace Characters](#get-whitespace-characters)

**Syntax:** Get Whitespace Characters()

**Description:** Returns a string containing all of the whitespace characters that are typically used.

**JMP Version Added:** Before version 14

```

Get Whitespace Characters();


```

### [Include](#include)

**Syntax:** y = Include( filepath, < \<<Parse Only>, < \<<New Context>, < \<<Names Default to Here> )

**Description:** Executes the JSL in the specified file. If Parse Only is specified, the script is parsed rather than executed. If New Context is specified, the included JSL is executed in its own unique namespace. If both the parent and included scripts use the global namespace, then specify both New Context and Names Default to Here to avoid name collisions.

**JMP Version Added:** Before version 14

```

Include( "$SAMPLE_SCRIPTS/chaosGame.jsl" );


```

### [Include File List](#include-file-list)

**Syntax:** y = Include File List()

**Description:** Returns a list of included files at the point of execution.

**JMP Version Added:** Before version 14

```

y = Include File List();


```

### [Is Log Open](#is-log-open)

**Syntax:** Is Log Open()

**Description:** Return result to indicate whether the log window is open

**JMP Version Added:** Before version 14

**Example 1**

```

If( Is Log Open(),
    Close Log()
);


```

**Example 2**

```

If( !Is Log Open(),
    Open Log()
);


```

### [Length](#length)

**Syntax:** l = Length( x )

**Description:** Returns the length of the given string (in characters), list (in items), associative array (in number of keys), blob (in bytes), matrix (in elements), or namespace/class (in number of functions and variables).

**JMP Version Added:** Before version 14

**Example 1**

```

Length( "Café" );


```

**Example 2**

```

Length( {1, 2 + 3, [11 22]} );


```

**Example 3**

```

Length( ["a" => 10, "b" => 3, => 0] );


```

**Example 4**

```

Length( Char To Blob( "Café" ) );


```

### [List](#list)

**Syntax:** y = {a, b, ...}; y = List( a, b, ... )

**Description:** Creates a list of items without evaluating them.

**JMP Version Added:** Before version 14

```

{1, 2 + 3, [11 22]};


```

### [Local](#local)

**Syntax:** y = Local( {name=value, ...}, expression )

**Description:** Resolves names to local variables.

**JMP Version Added:** Before version 14

```

Local( {a = 1, b},
    b = 2;
    a + b;
);


```

### [Local Here](#local-here)

**Syntax:** y = Local Here( expression )

**Description:** Executes expression with local Names Default To Here(1)

**JMP Version Added:** Before version 14

```

y = Local Here(
    a = 1;
    b = 2;
    c = a + b;
    c;
);


```

### [Lock Globals](#lock-globals)

**Syntax:** Lock Globals( name, ... )

**Description:** Locks specified global names, preventing them from being modified or being cleared by the Clear Globals function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Lock Symbols](#lock-symbols)

**Syntax:** Lock Symbols( name, ... )

**Description:** Locks specified global names, preventing them from being modified or being cleared by the Clear Symbols function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Log Capture](#log-capture)

**Syntax:** string = Log Capture( expr )

**Description:** Evaluates the expr argument and captures the output that would have appeared in the JMP log window and returns it in a string instead.

**JMP Version Added:** Before version 14

```

"captured:" || Log Capture(
    For( i = 1, i <= 3, i++,
        Write( Char( i ) );
        Write( " " );
    )
);


```

### [Map Value](#map-value)

**Syntax:** Map Value(string | number, {key1, value1...|{key1...},{value1...}}, \<Unmatched(value)>)

**Description:** Evaluate the initial value and return the mapped result or a default.

**JMP Version Added:** 15

**Example 1**

```

Map Value( "celry", {"celry", "celery"} );


```

**Example 2**

```

Map Value( "carrot", {"celry", "celery"}, Unmatched( "not found" ) );


```

**Example 3**

```

Map Value( 10, {10, "celery", 11, "banana"} );


```

**Example 4**

```

Map Value( 10, {{1, 2, 3}, {100, 200, 300}} );


```

### [Method](#method)

**Syntax:** m = Method( { arg1 = val1, ... }, expression\* )

**Description:** Create a Method within a Class

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
cl << Delete;
Delete Classes( "complex" );


```

### [N Items](#n-items)

**Syntax:** y = N Items( x )

**Description:** Returns the number of items in a list, the number of elements in a matrix, the number of keys in an associative array, the number of functions and variables in a namespace, the number of methods and variables in a class object, or the number of children of a display box.

**JMP Version Added:** Before version 14

**Example 1**

```

N Items( {1, 2 + 3, [11 22]} );


```

**Example 2**

```

N Items( ["a" => 10, "b" => 3, => 0] );


```

**Example 3**

```

New Window( "boxes", hlist = H List Box( Button Box( "a" ), Button Box( "b" ) ) );
N Items( hlist );


```

### [Names Default To Here](#names-default-to-here)

**Syntax:** Names Default To Here( boolean )

**Description:** Determines where unresolved names are stored, either as a global/local ( 0 ) or in the Here: namespace ( 1 ).

**JMP Version Added:** Before version 14

```

/* Variable x will be stored in the Here: namespace by default */x = 1;
Show( x );


```

### [Namespace](#namespace)

**Syntax:** ns = Namespace( namespace reference )

**Description:** Return a reference to the namespace specified by the name argument.

**JMP Version Added:** Before version 14

```

New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
ns = Namespace( "complex" );
Show( ns );
ns << Delete;


```

### [Namespace Exists](#namespace-exists)

**Syntax:** nsexists = Namespace Exists( namespace reference )

**Description:** Returns 1 if the namespace specified by the name argument exists; otherwise a 0 is returned.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
nsexists = Namespace Exists( ns );
Show( nsexists );
ns << Delete;


```

### [New Custom Function](#new-custom-function)

**Syntax:** f=New Custom Function(namespace, name, function definition)

**Description:** Create a new custom function object. A custom function will be colorized in the script editor and show up in the Scripting Index. The required information for a custom user function are a namespace (to prevent collisions with global functions), a name, and a function definition. Other help information can be added using messages. Use the Add Custom Functions command to publish the new function into the JMP environment.

**JMP Version Added:** 14

**Example 1**

```

myAdd = New Custom Function( "custom", "Add", Function( {x, y = 1}, x + y - 1 ) );


```

**Example 2**

```

/*Create a custom function that can be used as a format*/
Add Custom Functions(
    {New Custom Function(
        "custom",
        "User Defined Format Function",
        Function( {inches},
            Char( inches ) || " in"
        ),
        <<Custom Format Category( "Custom" ), 

    )}
);


```

**Example 3**

```

/*Create a custom function that can be used as a transform*/
Add Custom Functions(
    {New Custom Function(
        "custom",
        "User Defined Transform Function",
        Function( {inches},
            inches * 2.54
        ),
        <<Transform Category( "Custom" ), 

    )}
);


```

### [New Namespace](#new-namespace)

**Syntax:** ns = New Namespace( <name>, <list of expressions> )

**Description:** Create a new namespace with the name specified by the name argument or with an anonymous name if name is not specified.

**JMP Version Added:** Before version 14

```

ns = New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
Show( ns );
ns << Delete;


```

### [New Object](#new-object)

**Syntax:** New Object( "class name" | class name | class reference( constructor arguments\* ) )

**Description:** Creates an instance object of a class.

**JMP Version Added:** 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
cl = New Object( complex( 1, 2 ) );
cl << Delete;
Delete Classes( "complex" );


```

### [Open Log](#open-log)

**Syntax:** Open Log( <bring window to top> )

**Description:** Open the log window

**JMP Version Added:** Before version 14

**Example 1**

```

Open Log();
Show( Is Log Open() );


```

**Example 2**

```

/* Bring Log Windows to the Top */
Open Log( 1 );
Show( Is Log Open() );


```

### [Parameter](#parameter)

**Syntax:** y = Parameter( {name=value, ...}, model expression )

**Description:** Defines formula parameters for models for the Nonlinear platform.

**JMP Version Added:** Before version 14

```

Parameter( {a = 1}, a + 1 );


```

### [Parse](#parse)

**Syntax:** y = Parse( s )

**Description:** Parses the string and returns the resulting JSL expression.

**JMP Version Added:** Before version 14

```

Parse( "x+y" );


```

### [Print](#print)

**Syntax:** Print( x, ... )

**Description:** Displays values of the arguments in the log, one per line.

**JMP Version Added:** Before version 14

```

Print( 355 / 113, Pi() );


```

### [Quit](#quit)

**Syntax:** Quit(\<"No Save">); Exit(\<"No Save">)

**Description:** Exits JMP.

**JMP Version Added:** Before version 14

```

If(
    New Window( "Quit() example",
        <<Type( "Modal" ),
        Text Box( "Shut down JMP?" ),
        H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
    )["Button"] == 1, /*OK==1*/Quit(), /*cancel==-1*/"Good choice."
);


```

### [Recode](#recode)

**Syntax:** recode(string|number|list, {<transform>, ...}, \<Multiple Response (Separator(sepChar))>, \<By Word(Delimiters(<chars>)>)

**Description:** Apply the listed transformations to the input value(s) and return the result. The Multiple Response and By Word options split supplied character data into smaller input values. Once the input values are determined, the transformations are applied to those values separately.

Special JSL variables are populated during the execution of the command:

```
_rcNow is the current value of the input after the previous transformation(s).

_rcOrig is the original value of the input.

```

**JMP Version Added:** 15

**Example 1**

```

Recode(
    "27513-0000",
    {Regex( _rcNow, "(\d\d\d\d\d)-\d+", "\1", GLOBALREPLACE ), Num( _rcNow )}
);


```

**Example 2**

```

Recode(
    "A B C",
    {Map Value( _rcNow, {"A", "Apple", "B", "Banana"}, Unmatched( "Unknown fruit" ) )},
    By Word
);


```

### [Recurse](#recurse)

**Syntax:** y = Recurse( x1, ... )

**Description:** Calls the containing function.

**JMP Version Added:** Before version 14

```

ex rev = Function( {s},
    If( Length( s ) <= 1,
        s,
        Recurse( Substr( s, 2 ) ) || Left( s, 1 )
    )
);
ex rev( "abcd" );


```

### [Remove Custom Functions](#remove-custom-functions)

**Syntax:** Remove Custom Functions({function 1 full name, function 2 full name, ...} | function full name)

**Description:** Removes a list of custom functions from the environment.

**JMP Version Added:** 14

```

Remove Custom Functions( {"custom:Add", "custom:Sub"} );


```

### [Save Log](#save-log)

**Syntax:** f = Save Log( <path> )

**Description:** Writes the contents of the log to the specified file location. If the write is successful, this function returns the name of the created file.

**JMP Version Added:** Before version 14

```

Save Log( "$TEMP/log.txt" );
exlogText = Load Text File( "$TEMP/log.txt" );
Substr( exlogText, 1, 30 );


```

### [Send](#send)

**Syntax:** r = obj \<< msg( args ); r = obj \<< msg; r = Send( obj, msg )

**Description:** Sends a message (in the form of an expression) to an object.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Bivariate( Y( :weight ), X( :height ) ) << Fit Line;


```

### [Set Environment Variable](#set-environment-variable)

**Syntax:** value = Set Environment Variable( string, < string> )

**Description:** Sets the value of the specified environment variable in the operating system. If the second argument is either missing or is an empty string then the environment variable is deleted.

NOTE: On the Macintosh operating system, the variable name is case-sensitive.

**JMP Version Added:** Before version 14

```

Set Environment Variable( "PATH", "some path to a directory" );


```

### [Show](#show)

**Syntax:** Show( x, ... )

**Description:** Displays the name and value of the arguments in the log, one per line.

**JMP Version Added:** Before version 14

```

Show( 355 / 113, Pi() );


```

### [Show Classes](#show-classes)

**Syntax:** Show Classes( < \<class name | class reference>, ... > )

**Description:** Show the contents of all user-defined classes.

**JMP Version Added:** Before version 14

```

Define Class(
    "complex",
    real = 0;
    imag = 0;
    _init_ = Method( {a, b},
        real = a;
        imag = b;
    );
    Add = Method( {y},
        New Object( complex( real + y:real, imag + y:imag ) )
    );
    Sub = Method( {y},
        New Object( complex( real - y:real, imag - y:imag ) )
    );
    Mul = Method( {y},
        New Object( complex( real * y:real - imag * y:imag, imag * y:real + real * y:imag ) )
    );
    Div = Method( {y},
        t = New Object( complex( 0, 0 ) );
        mag2 = y:Magsq();
        t:real = real * y:real + imag * y:imag;
        t:imag = imag * y:real + real * y:imag;
        t:real = t:real / mag2;
        t:imag = t:imag / mag2;
        t;
    );
    Magsq = Method( {},
        real * real + imag * imag
    );
    Mag = Method( {},
        Sqrt( real * real + imag * imag )
    );
    _to string_ = Method( {},
        Char( real ) || " + " || Char( imag ) || "i"
    );
    _show_ = _to string_;
);
Show Classes();


```

### [Show Globals](#show-globals)

**Syntax:** Show Globals()

**Description:** Lists all the currently defined global symbols and their values.

**JMP Version Added:** Before version 14

```

Show Globals();


```

### [Show Namespaces](#show-namespaces)

**Syntax:** Show Namespaces( < <namespace reference>, ... > )

**Description:** Show the contents of all user defined namespaces, both named and anonymous.

**JMP Version Added:** Before version 14

```

New Namespace(
    "complex",
    {
        make = Function( {a, b},
            Index( a, b, b - a )
        ),
        add = Function( {x, y}, x + y ),
        sub = Function( {x, y}, x - y ),
        mul = Function( {x, y},
            local:z = J( 1, 2 );
            local:z[1] = x[1] * y[1] - x[2] * y[2];
            local:z[2] = x[1] * y[2] + x[2] * y[1];
            local:z;
        ),
        div = Function( {x, y},
            local:z = J( 1, 2 );
            local:d = (y[1] ^ 2 + y[2] ^ 2);
            local:z[1] = (x[1] * y[1] + x[2] * y[2]) / local:d;
            local:z[2] = (x[2] * y[1] - x[1] * y[2]) / local:d;
            local:z;
        ),
        write = Function( {x},
            Write( x[1], " + ", x[2], "i\!n" )
        )
    }
);
Show Namespaces( "complex" );
Delete Namespaces( "complex" );


```

### [Show Symbols](#show-symbols)

**Syntax:** Show Symbols()

**Description:** Lists all the currently defined symbols and their values.

**JMP Version Added:** Before version 14

```

Show Symbols();


```

### [Sort List](#sort-list)

**Syntax:** y = Sort List( x )

**Description:** Returns a copy of list x with the items in ascending order.

**JMP Version Added:** Before version 14

```

Sort List( {111, 212, 133, 114, 55} );


```

### [Sort List Into](#sort-list-into)

**Syntax:** Sort List Into( x )

**Description:** Modifies list x with the items in ascending order. Note that the x argument must be a variable.

**JMP Version Added:** Before version 14

```

ex = {111, 212, 133, 114, 55};
Sort List Into( ex );
ex;


```

### [Throw](#throw)

**Syntax:** Throw(<message>, <Boolean>)

**Description:** Diverts execution to the enclosing Try(). Otherwise, script execution is stopped. If message begins with an exclamation point, the error will be fatal and cannot be caught by Try(). The second argument is an optional boolean for including a traceback.

**JMP Version Added:** Before version 14

#### [Fatal Throw](#fatal-throw)

```


Try( Throw( "!This is a fatal error" ), Print( "CATCH message not reached" ) );
Print( "AFTER TRY message not reached" );


```

#### [Traceback](#traceback)

```

Throw( "A line number is included in this error", 1 );


```

#### [Try-Catch](#try-catch)

```

Try( If( Random Uniform() < 0.5, 1, Throw() ), "thrown" );


```

### [Try](#try)

**Syntax:** y = Try( expr, <catchExpr> )

**Description:** Evaluates and returns the expr argument, unless the evaluation causes a Throw() or internal exception. In that case, the evaluation of catchExpr is returned. If you use exception_msg as the catchExpr, a list containing more information about the error is returned.

**JMP Version Added:** Before version 14

**Example 1**

```

Try( Sqrt( "s" ), "invalid" );


```

**Example 2**

```

Try( Sqrt( "s" ), exception_msg );


```

### [Type](#type)

**Syntax:** y = Type( x )

**Description:** Returns a string naming the type of the value of the argument x.

**JMP Version Added:** Before version 14

```

Type( [1 2 3] );


```

### [Unlock Globals](#unlock-globals)

**Syntax:** Unlock Globals( name, ... )

**Description:** Unlocks specified global names, allowing them to be modified and to be cleared by the Clear Globals function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Globals( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Unlock Symbols](#unlock-symbols)

**Syntax:** Unlock Symbols( name, ... )

**Description:** Unlocks specified global names, allowing them to be modified and to be cleared by the Clear Symbols function.

**JMP Version Added:** Before version 14

```

exalpha = 0.05;
exdelta = 0.5;
Watch( exalpha, exdelta );
Wait( 3 );
Lock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );
Try( exdelta = 0.6, Show( "invalid - exdelta is locked" ) );
Wait( 3 );
Unlock Symbols( exalpha );
Wait( 3 );
Try( exalpha = 0.06, Show( "invalid - exalpha is locked" ) );


```

### [Wait](#wait)

**Syntax:** Wait( <x> )

**Description:** Waits for x seconds before proceeding with execution. The default value for x is 3 seconds. If x is 0 or greater, JMP will complete any operating system events (e.g. screen drawing) as well as any pending callbacks (e.g. formula evaluation) in addition to the wait. If x is less than 0, only the screen drawing and pending OS events are confirmed to be completed before proceeding.

**JMP Version Added:** Before version 14

#### [Callbacks](#callbacks)

```

Wait( 0 ); // Wait for OS events and callbacks


```

#### [OS Events](#os-events)

```

Wait( -1 ); // Wait for OS events


```

#### [Simple](#simple)

```

Wait( 1.5 );


```

### [Watch](#watch)

**Syntax:** w = Watch( all|name1, ... )

**Description:** Creates a window showing variables from Global, Here, and Local namespaces and their values.

**JMP Version Added:** Before version 14

```

x = 1;
y = 2;
z = "abc";
w = Watch( all );
Wait( 5 );
x = x * 5;
y = y / 25;
z = z || "def";
Wait( 5 );
w << close Window();


```

### [Where](#where)

**Syntax:** Where( <dt>, clause )

**Description:** Returns indices (usually row numbers) matching the given where clause. The optional dt changes the Current Data Table during the evaluation. These clauses are often written by JMP using the Data Filter. This will often by faster than using Loc, \<<Get Rows Where or \<<Select Where. The behavior is undefined if the clause modifies the sequences or any symbols during evaluation.

**JMP Version Added:** 18

#### [Column Functions](#column-functions)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Select << Select Rows( Where( Col Max( :height, :age ) >= 68 ) );
dt << Clear Select << Select Rows( Where( :height == Col Max( :height, :age ) ) );


```

#### [Columns](#columns)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Get Rows Where( :sex == "M" );
Where( :sex == "M" );
Where( dt, :sex == "M" );


```

#### [Matrix/List](#matrixlist)

```

xs = [10 20 30 . 50];
xs[Where( xs >= 20 )];
xs[Where( !Is Missing( xs ) )];
ys = {10, 20, "30", ., 50};
ys[Where( ys >= 20 )];


```

#### [Other](#other)

```

xs = [10 20 30 . 50];
ys = [0 0 0 1 1];
Where( xs > 20 & ys );

xs = {{10}, {20}, {15}};
Where( xs[1] < 18 );


```

#### [Row States](#row-states)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Select Rows( [2 4 6] ) << Exclude( 1 );
Where( Excluded() );
Where( !Excluded() );


```

### [Wild](#wild)

**Syntax:** Wild()

**Description:** Denotes a wildcard position that matches any expression (only used in expression patterns).

**JMP Version Added:** Before version 14

```

extestexpr = Expr(
    For( i = 1, i <= 14, i++, Print( "YES!!!" ) );
    Show( "END" );
);
Extract Expr( extestexpr, For( i = 1, Wild(), i++, Print( "YES!!!" ) ) );


```

### [Wild List](#wild-list)

**Syntax:** Wild List()

**Description:** Denotes a series of wildcard arguments that match anything (only used in expression patterns).

**JMP Version Added:** Before version 14

```

extestexpr = Expr(
    For( i = 1, i <= 14, i++, Print( "YES!!!" ) );
    Show( "END" );
);
Extract Expr( extestexpr, For( i = 1, Wild List(), Print( "YES!!!" ) ) );


```

### [Write](#write)

**Syntax:** Write( x, ... )

**Description:** Displays the specified values in the log without adding quotation marks, spaces, or line breaks (as Print() does).

**JMP Version Added:** Before version 14

```

Write( "fraction = ", 355 / 113, "\!N", "pi       = ", Pi() );


```

# [Python](#python)

### [Python Connect](#python-connect)

**Syntax:** PythonConnection = Python Connect ()

**Description:** Returns a Python connection scriptable object.

**JMP Version Added:** 14

```

PythonConnection = Python Connect();
version = PythonConnection << Get Version;
Show( version );


```

### [Python Create JPIP CMD](#python-create-jpip-cmd)

**Syntax:** Python Create JPIP CMD()

**Description:** Triggers the creation of a jpip command line wrapper script for Python's pip command. A directory picker dialog will ask for the directory location to save the generated script. This script then provides the full capabilities of pip, while correctly establishing the necessary environment variables for JMP's isolated Python environment.

**JMP Version Added:** 18

**Example 1**

```

Python Create JPIP CMD();


```

**Example 2**

```


conn = Python Connect();
conn << Create JPIP CMD();


```

### [Python Execute](#python-execute)

**Syntax:** Python Execute( { list of Inputs }, { list of Outputs }, statements < , echo( 1 | 0 ) > )

**Description:** Sends a list of inputs, executes statements, and returns a list of outputs. Optional echo() parameter defaults to True. The echo parameter controls echoing the Python source to the log. Logical True (1) enables echo of source while 0 suppresses the echo to the log.

**JMP Version Added:** 14

**Example 1**

```


a = "abcdef";
d = 3.141;
x = 0;
z = 0;
v = [1 0 0, 0 1 0, 0 0 1];
// pi, e, phi, c, Plank's, Faraday, 345 triangle
m = [3.141 2.718 1.618,
2.997 6.626 9.648,
3 4 5];
ml = Python Execute(
    {v, m, a, d},
    {x, z, a, d},
    "\[
import numpy as np
a = np.multiply(v, m) # matrix product
d = np.divide(v, m) # matrix division
z = np.multiply(m, np.linalg.inv(v)) # m * inv(v) called Left division
x = np.multiply(np.linalg.inv(m), v) # inv(m) * v called right division
]\"
);
Show( v, m, ml, x, z, a, d );


```

**Example 2**

```


x1 = 1;
x2 = 2;
y1 = 1;
y2 = 2;
z1 = 1;
z2 = 2;
v = [1 0 0, 0 1 0, 0 0 1];
// pi, e, phi, c, Plank's, Faraday, 345 triangle
m = [3.141 2.718 1.618,
2.997 6.626 9.648,
3 4 5];
ml = Python Execute(
    {v, m},
    {x1, x2, y1, y2, z1, z2},
    "\[
import numpy as np
x1 = np.multiply(v, m) # matrix product
print('x1=', x1)
x2 = np.divide(v, m) # matrix division
print('x2=', x2)
y1 = np.dot(v, m) # dot product of v and m
print('y1=', y1)
y2 = np.dot(m, v) # dot product of m and v
print('y2=', y2)
z1 = np.inner(v, m) # inner product of v and m
print('z1=', z1)
z2 = np.inner(m, v) # innder product of m and v
print('z2=', z2)
]\"
);
Show( v, m, ml, x1, x2, y1, y2, z1, z2 );


```

### [Python Get](#python-get)

**Syntax:** y = Python Get( name )

**Description:** Returns data from Python, where the name argument can represent any of the following Python data types ( numeric | string | matrix | list | dict | data table | data frame | datetime | numpy.datetime64 ).

**JMP Version Added:** 14

#### [Datetime](#datetime)

```


date1 = As Date( Today() );
Python Send( date1 );
date2 = Python Get( date1 );
Show( date1, date2 );


```

**Example 1**

```


x1 = {1, 2, 3};
Python Send( x1 );
x2 = Python Get( x1 );
Show( x1, x2 );


```

#### [numpy.datetime64](#numpydatetime64)

```


Python Install Packages( "numpy" );
Python Submit( "import numpy as np" );
Python Submit( "datetime64 = np.datetime64('1989-10-05')" );
numpy_datetime = Python Get( datetime64 );
Show( numpy_datetime );


```

### [Python Get Version](#python-get-version)

**Syntax:** version = Python Get Version()

**Description:** Returns the version number of Python being used with the JMP Python interfaces.

**JMP Version Added:** 14

```

version = Python Get Version();
Show( version );


```

### [Python Init](#python-init)

**Syntax:** PythonConnection = Python Init( )

**Description:** Note: This function is deprecated as of JMP 18 and is equivalent to Python Connect().

**JMP Version Added:** 14

**Example 1**

```


Python Init();
Python Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = Python Get( str );
Show( getStr );


```

**Example 2**

```


PythonConnection = Python Init();
PythonConnection << Submit( "\[
str = 'The quick brown fox jumps over the lazy dog';
]\" );
getStr = Python Get( str );
Show( getStr );


```

### [Python Install Packages](#python-install-packages)

**Syntax:** Python Install Packages( packages )

**Description:** This wrappers the install of Python packages into the JMP site-packages directory. For operations beyond simple package installation, see Python Create JPIP CMD() to create a command line pip wrapper script in a directory chosen with Directory Pick(). Alternatively, to run the install from a JMP Python script window look at jmputils.jpip under the Python category here in the Scripting Index.

**JMP Version Added:** 18

**Example 1**

```

// install numpy and pandas packages
Python Install Packages( "numpy pandas" );


```

**Example 2**

```

// install numpy and pandas packages
Python Install Packages( {"numpy", "pandas"} );


```

**Example 3**

```

// install numpy and pandas packages
conn = Python Connect();
conn << Install Packages( "numpy pandas" );


```

### [Python Is Connected](#python-is-connected)

**Syntax:** connected = Python Is Connected()

**Description:** Note: This function is deprecated as of JMP 18 and always returns 1.

**JMP Version Added:** 14

```

x = Python Is Connected();
Show( x );


```

### [Python JMP Name to Python Name](#python-jmp-name-to-python-name)

**Syntax:** Python name = Python JMP Name To Python Name( JMP name )

**Description:** Maps a JMP variable name to a Python variable name using Python variable naming rules.

**JMP Version Added:** 14

```

Python name = Python JMP Name to Python Name( a b c );
Show( Python name );


```

### [Python Reset](#python-reset)

**Syntax:** Python Reset()

**Description:** Resets the shared Python environment, primarily clearing all references to objects. This does not change the import cache of imported modules. This is a limitation of the Python environment itself. Modules that load shared libraries cannot be unloaded by the running process. To reload pure Python code, see the Python.org documentation on importlib reload().

**JMP Version Added:** 19

```

pi = 3.1415927;
Python Send( pi );
Python Submit( "print(pi)" );
Python Reset();
// will show error, pi not defined
Python Submit( "print(pi)" );


```

### [Python Send](#python-send)

**Syntax:** Python Send( name, \<Python Name( name )> )

**Description:** Sends data to Python, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table | data table column | date ).

**JMP Version Added:** 14

#### [Column](#column)

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Python Send( dt:weight );
Python Submit( "print(dt_weight)" );


```

#### [Data Table](#data-table)

```


x = {1, 2, 3};
Python Send( x );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Python Send( dt );
Python Submit( "print(x)" );
Python Submit( "print(dt)" );


```

#### [Date](#date)

```


date = As Date( Today() );
Python Send( date );
Python Submit( "print(date)" );


```

### [Python Send File](#python-send-file)

**Syntax:** Python Send File( filename, \<Python Name( name )> )

**Description:** Sends a data file to Python, where the filename argument is a string specifying a pathname to the file to be sent to Python.

**JMP Version Added:** 14

```


Python Send File( "$SAMPLE_DATA/Big Class.jmp" );
Python Send File( "$SAMPLE_DATA/Baseball.jmp" );
Python Submit( "print(Big_Class)" );
Python Submit( "print(Baseball)" );


```

### [Python Submit](#python-submit)

**Syntax:** Python Submit( statements < , echo( 1 | 0 ) > )

**Description:** Submits statements to Python. Statements can be in the form of a string value or list of string values. Optional echo() parameter defaults to 1. The echo parameter controls echoing the Python source to the log. Logical True (1) enables echo of source while 0 suppresses the echo to the log.

**JMP Version Added:** 14

```

Python Submit( "\[
str = 'The quick brown fox jumps over the lazy dog'
a = 200]\" );
getStr = Python Get( str );
getNum = Python Get( a );
Show( getStr, getNum );


```

### [Python Submit File](#python-submit-file)

**Syntax:** Python Submit File( path )

**Description:** Submits statements to Python using a file specified by the path argument.

**JMP Version Added:** 14

```

Python Submit File( "some_Python_source.py" );


```

### [Python Term](#python-term)

**Syntax:** Python Term()

**Description:** Note: This function is deprecated as of JMP 18 and has no effect.

**JMP Version Added:** 14

# [R](#r)

### [R Connect](#r-connect)

**Syntax:** RConnection = R Connect()

**Description:** Returns an R connection scriptable object.

**JMP Version Added:** Before version 14

```

RConnection = R Connect();


```

### [R Control](#r-control)

**Syntax:** R Control( Interrupt | Async( bool ) | Echo( bool ) )

**Description:** Changes the control options for R

**JMP Version Added:** Before version 14

```

R Init( Echo( true ) );
R Control( Echo( false ) );
R Submit( "Add R code" );


```

### [R Execute](#r-execute)

**Syntax:** R Execute( { list of Inputs }, { list of Outputs }, statements )

**Description:** Sends a list of inputs, executes statements and returns a list of outputs.

**JMP Version Added:** Before version 14

```

R Init();
a = "abcdef";
d = 3.141;
x = 0;
z = 0;
v = [9 8 7, 6 5 4, 3 2 1];
m = [1 2 3, 4 5 6, 7 8 9];
rc = R Execute( {v, m, a, d}, {x, z, a, d}, "\[
x <- rnorm(5)
z <- v * m
]\" );
Show( v, m, rc, x, z, a, d );


```

### [R Get](#r-get)

**Syntax:** y = R Get( name )

**Description:** Returns data from R, where the name argument can represent any of the following R data types ( numeric | string | matrix | list | data frame).

**JMP Version Added:** Before version 14

```

R Init();
x1 = [1, 2, 3];
R Send( x1 );
x2 = R Get( x1 );
Show( x1, x2 );
dt1 = New Table( "Test", New Column( "Col", Values( [10, 20, 30] ) ) );
R Send( dt1 );
dt2 = R Get( dt1 );
Close( dt1, No Save );


```

### [R Get Graphics](#r-get-graphics)

**Syntax:** R graphics = R Get Graphics( format )

**Description:** DEPRECATED in JMP 19 and has no effect. As a replacement, set device to a file name such as png("r_plot.png"), and then open the file to retrieve the image. This option will be removed from JMP 20. Code below shows workaround.

**JMP Version Added:** Before version 14

```

R Init();
img_path = Get Path Variable( "TEMP" ) || "r_plot.png";
R Execute( {img_path}, {}, "\[
png(img_path)
plot(1:10)
dev.off()
]\" );
plot = Open( img_path );
rc = Delete File( img_path );


```

### [R Get Version](#r-get-version)

**Syntax:** version = R Get Version()

**Description:** Returns the version number of R being used with the JMP R interfaces.

**JMP Version Added:** 14

```

R Init();
version = R Get Version();
Show( version );


```

### [R Init](#r-init)

**Syntax:** R Init()

**Description:** Initializes the R Interfaces.

**JMP Version Added:** Before version 14

```

R Init();


```

### [R Is Connected](#r-is-connected)

**Syntax:** connected = R Is Connected()

**Description:** Returns 1 if there is an active R connection; otherwise, returns 0.

**JMP Version Added:** Before version 14

```

R Init();
connected = R Is Connected();


```

### [R JMP Name to R Name](#r-jmp-name-to-r-name)

**Syntax:** R name = R JMP Name To R Name( JMP name )

**Description:** Maps a JMP variable name to an R variable name using R variable naming rules.

**JMP Version Added:** Before version 14

```

R name = R JMP Name to R Name( a b c );


```

### [R Send](#r-send)

**Syntax:** R Send( name, \<R Name( as_name ) | "as_name"> )

**Description:** Sends data to R, where the name argument can represent any of the following JMP data types ( numeric | string | matrix | list | data table | data table column).

**JMP Version Added:** Before version 14

#### [Column](#column)

```

R Init();
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
R Send( dt:weight );
Close( dt );
w = R Get( "dt.weight" );


```

#### [Data Table](#data-table)

```

R Init();
x = [1, 2, 3];
R Send( x, "x1" );
rx = R Get( "x1" );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
R Send( dt );
Close( dt );
R Submit( "dt" );


```

### [R Send File](#r-send-file)

**Syntax:** R Send File( filename, \<R Name( name )> )

**Description:** Sends a data file to R, where the filename argument is a string specifying a pathname to the file to be sent to R.

**JMP Version Added:** Before version 14

```

R Init();
R Send File( "$SAMPLE_DATA/Big Class.jmp" );
R Send File( "$SAMPLE_DATA/Baseball.jmp" );
R Submit( "Big.Class" );
R Submit( "Baseball" );


```

### [R Submit](#r-submit)

**Syntax:** R Submit( statements )

**Description:** Submit statements to R. Statements can be in the form of a string value or list of string values.

**JMP Version Added:** Before version 14

```


R Init();
img_path = Get Path Variable( "TEMP" ) || "r_plot.png";
code =
"\[
x <- rnorm(1000)
hx <- hist(x, breaks=100, plot=FALSE)
png("IMG_PATH")
plot(hx, col=ifelse(abs(hx$breaks) < 1.669, 4, 2))
dev.off()
x <- rnorm (100)
y <- x**2 + rnorm (100)
summary(y)
]\";
// substitue portable path into R code
r_code = Substitute( code, "IMG_PATH", img_path );
R Submit( r_code );
Wait( 3 );
plot = Open( img_path );
rc = Delete File( img_path );


```

### [R Submit File](#r-submit-file)

**Syntax:** R Submit File( path )

**Description:** Submits statements to R using a file specified by the path argument.

**JMP Version Added:** Before version 14

```


R Init();
file_path = Get Path Variable( "SAMPLE_SCRIPTS" ) || "R/SI_example.R";
R Submit File( file_path );


```

### [R Term](#r-term)

**Syntax:** R Term()

**Description:** Deprecated in JMP 19 and has no effect.

**JMP Version Added:** Before version 14

```

R Init();
R Term();


```

# [Random](#random)

### [Col Shuffle](#col-shuffle)

**Syntax:** y = Col Shuffle(\<byVar, \<Excluded( Row State() )>, ...>)

**Description:** Returns a random integer between 1 and the number of rows of the current data table. When used in a column formula, Col Shuffle() creates a random ordering of row numbers with each row number appearing only once. The ordering is cached internally so that multiple evaluations are efficient.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Shuffle 1", Numeric, Continuous, Set Formula( Col Shuffle() ) );
dt << New Column( "Shuffle 2", Numeric, Continuous, Set Formula( Col Shuffle() ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Shuffle", Numeric, Continuous, Set Formula( Col Shuffle( :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Shuffle for each Sex", Formula( Col Shuffle( :height, :sex ) ) );
dt << New Column( "Col Shuffle for each Sex grouped by Excluded",
    Formula( Col Shuffle( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Make KFold Formula](#make-kfold-formula)

**Syntax:** y = Make KFold Formula( folds, Y Columns( cols ), \<<Stratification Columns( cols ), \<<Grouping Columns( cols ) )

**Description:** Generates a validation column with folds levels when used in a column formula. This JSL function is primarily used by the Make Validation Column platform to generate formula columns.

**JMP Version Added:** 17

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "KFold Validation",
    "Numeric",
    "Nominal",
    Formula( Make KFold Formula( 5, <<Y Columns( :height ) ) )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Stratified KFold",
    "Numeric",
    "Nominal",
    Formula(
        Make KFold Formula( 4, <<Y Columns( :height ), <<Stratification Columns( :sex ) )
    )
);


```

### [Make Validation Formula](#make-validation-formula)

**Syntax:** y = Make Validation Formula( rates, \<<Stratification Columns( cols ), \<<Grouping Columns( cols ), \<<Cutpoint Column ( col ), \<<Cutpoint Batch ID( col ), \<<Determine cutpoints using( "Proportions"|"Numbers of Rows"|"Fixed Time or Date"|"Elapsed Time" ), \<<Assign Extra Rows( "To Training"|"To Validation"|"To Test" ) )

**Description:** Generates a two-level or three-level validation column when used in a column formula. The rates argument is a 3 by 1 matrix that contains the training, validation, and test rates, respectively. This JSL function is primarily used by the Make Validation Column platform to generate formula columns.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Validation",
    "Numeric",
    "Nominal",
    Formula( Make Validation Formula( [.6, .4, 0] ) ),
    Set Property( "Value Labels", {0 = "Training", 1 = "Validation"} )
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Validation",
    "Numeric",
    "Nominal",
    Formula( Make Validation Formula( [.6, .2, .2], <<Stratification Columns( :age ) ) ),
    Set Property( "Value Labels", {0 = "Training", 1 = "Validation", 2 = "Test"} )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Functional Data/Weekly Weather Data.jmp" );
dt << New Column( "Validation",
    "Numeric",
    "Nominal",
    Formula(
        Make Validation Formula(
            [20, 10, 4],
            <<Cutpoint Column( :Week of Year ),
            <<Cutpoint Batch ID( :ID ),
            <<Determine cutpoints using( "Numbers of Rows" )
        )
    ),
    Set Property( "Value Labels", {0 = "Training", 1 = "Validation", 2 = "Test"} )
);


```

### [Polytope Uniform Random](#polytope-uniform-random)

**Syntax:** points = Random Linearly Constrained Uniform( numSamples, A, b, L, U, neq, nle, nge, \<nwarm=200>, \<nstride=25>, \<tol=1e-8>, <G>, <LC>, <UC> )

**Description:** Generates a random sample subject to linear constraints, variable bound constraints, and cardinality constraints on specified component subgroup variables. The numSamples argument specifies the number of random points to be generated. The A argument is the linear constraint coefficient matrix. The b argument is the vector of right hand side values of the linear constraints. The L and U arguments are vectors of the lower and upper bounds for the variables, respectively. The neq, nle, and nge arguments are the number of equality constraints, the number of less than or equal constraints, and the number of greater than or equal constraints, respectively. The nwarm argument is the number of warm-up repetitions before points are written to the output matrix. The nstride argument is the number of repetitions between each point that is written to the output matrix. The tol argument is the tolerance. The G argument is a vector of indices that assigns the variables to constrained component subgroups where missing or zero values do not belong to a constrained subgroup. The LC and UC arguments are the lower and upper cardinality constraints for the constrained component subgroups, respectively. Note that the constraints must be listed as equality first, less than or equal next, and greater than or equal last.

**JMP Version Added:** Before version 14

**Example 1**

```

A = [1 1 1, 1 2 0];
b = [1, 0.5];
L = [0, 0, 0.1];
U = [1, 1, 1];
points = Random Linearly Constrained Uniform( 2000, A, b, L, U, 1, 0, 1, 300, 50 );
dt = As Table( points );
tobj = Report( Ternary Plot( X( :Col1, :Col2, :Col3 ) ) );
tfr = tobj[scalebox( 1 )] << clone box;
New Window( "Example: Random Linearly Constrained Uniform",
    Outline Box( "Points on a Ternary Plot", tfr ),
    Outline Box( "Constraints",
        Text Box( "X1 + x2 + x3 = 1" ),
        Text Box( "X2 + 2*x2 >= 0.5" )
    ),
    Outline Box( "Variable Bounds",
        Text Box( "0 <= x1 <= 1" ),
        Text Box( "0 <= x2 <= 1" ),
        Text Box( ".1 < x3 <= 1" )
    )
);
Close( dt, no save );
Show( "see new window for example output" );


```

**Example 2**

```


A = [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1];
b = [100];
L = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
U = [100 100 95 90 100 85 100 90 60 70 75 70 75 100 95 60 80 95 100 100];
nwarm = 100;
nstride = 100;
tol = 1e-8;
// Index the constrained subgroups.  Index = 0 is not in a constrained subgroup.
G = [0 0 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 0 0];
// Lower cardinality constraints for the constrained subgroups
LC = [1 1];
// Upper cardinality constraints for the constrained subgroups
UC = [3 5];
points = Random Linearly Constrained Uniform(
    100,
    A,
    b,
    L,
    U,
    1,
    0,
    0,
    nwarm,
    nstride,
    tol,
    G,
    LC,
    UC
);
dt = As Table( points );


```

### [Random Beta](#random-beta)

**Syntax:** y = Random Beta( alpha, beta, \<theta=0>, \<sigma=1> )

**Description:** Returns a random number from a beta distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Beta( 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Beta( 1, 1 ) );
//show results
Show( x, v );


```

### [Random Beta Binomial](#random-beta-binomial)

**Syntax:** y = Random Beta Binomial( n, p, \<delta=0> )

**Description:** Returns a random number from a beta binomial distribution for n trials with probability p and correlation delta.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Beta Binomial( 14, .5, .2 );
//produce a vector of random numbers
v = J( 1, 10, Random Beta Binomial( 14, .5, .2 ) );
//show results
Show( x, v );


```

### [Random Binomial](#random-binomial)

**Syntax:** y = Random Binomial( n, p )

**Description:** Returns a random number from a binomial distribution with n trials and event probability p.

**JMP Version Added:** Before version 14

```

exrbinp = 0.5;
exrbinn = 40;
exrbinlsz = Log( 1000 );
New Window( "Example: Random Binomial and Empirical Distribution",
    exrbiny = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( 0, 40 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        exrbinsz = Round( Exp( exrbinlsz ) );
        exrbinsamp = J( Round( exrbinsz ), 1, . );
        exrbinfreq = J( Round( exrbinn + 1 ), 1, . );
        For( exrbink = 1, exrbink <= Round( exrbinsz ), exrbink++,
            exrbinsamp[exrbink] = Random Binomial( exrbinn, exrbinp )
        );
        For( exrbink = 0, exrbink <= Round( exrbinn ), exrbink++,
            exrbinfreq[exrbink + 1] = Sum( exrbinsamp <= exrbink ) / Round( exrbinsz )
        );
        For( exrbink = 0, exrbink < Round( exrbinn ), exrbink++,
            H Line(
                exrbink,
                exrbink + 1,
                Binomial Distribution( exrbinp, Round( exrbinn ), exrbink )
            );
            V Line(
                exrbink + 1,
                Binomial Distribution( exrbinp, Round( exrbinn ), exrbink ),
                Binomial Distribution( exrbinp, Round( exrbinn ), exrbink + 1 )
            );
        );
        Pen Color( "blue" );
        For( exrbink = 1, exrbink <= Round( exrbinn ), exrbink++,
            H Line( exrbink - 1, exrbink, exrbinfreq[exrbink] );
            V Line( exrbink, exrbinfreq[exrbink], exrbinfreq[exrbink + 1] );
        );
        Text(
            {0.5, 0.9},
            "n=",
            Round( exrbinn ),
            " p=",
            Round( exrbinp, 2 ),
            " size=",
            Round( exrbinsz )
        );
    ),
    H List Box(
        Slider Box( Log( 10 ), Log( 5000 ), exrbinlsz, exrbiny << reshow ),
        Text Box( " random sample size" )
    )
);


```

### [Random Category](#random-category)

**Syntax:** y = Random Category( probabilityA, resultA, probabilityB, resultB, resultElse )

**Description:** Returns a random category given pairs of probability and result expressions. A random uniform number is generated and compared to the probability arguments to determine which result argument is returned.

**JMP Version Added:** Before version 14

```

Random Category( .2, "A", .3, "B", .4, "C", "D" );


```

### [Random Cauchy](#random-cauchy)

**Syntax:** y = Random Cauchy()

**Description:** Returns a random number from a Cauchy distribution with a median of zero.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Cauchy();
//produce a vector of random numbers
v = J( 1, 10, Random Cauchy() );
//show results
Show( x, v );


```

### [Random ChiSquare](#random-chisquare)

**Syntax:** y = Random ChiSquare( df, \<nonCentrality=0> )

**Description:** Returns a random number from a Chi-Square distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random ChiSquare( 2 );
//produce a vector of random numbers
v = J( 1, 10, Random ChiSquare( 2 ) );
//show results
Show( x, v );


```

### [Random ExGaussian](#random-exgaussian)

**Syntax:** y = Random ExGaussian( location, scale, shape)

**Description:** Returns a random number from an ExGaussian distribution.

**JMP Version Added:** 18

```


//produce a single random number
x = Random ExGaussian( 0, .5, .25 );
//produce a vector of random numbers
v = J( 1, 10, Random ExGaussian( 0, .5, .25 ) );
//show results
Show( x, v );


```

### [Random Exp](#random-exp)

**Syntax:** y = Random Exp()

**Description:** Returns a random number from an exponential distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Exp();
//produce a vector of random numbers
v = J( 1, 10, Random Exp() );
//show results
Show( x, v );


```

### [Random F](#random-f)

**Syntax:** y = Random F( dfnum, dfden, \<nonCentrality=0> )

**Description:** Returns a random number from an F distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random F( 2, 2 );
//produce a vector of random numbers
v = J( 1, 10, Random F( 2, 2 ) );
//show results
Show( x, v );


```

### [Random Frechet](#random-frechet)

**Syntax:** y = Random Frechet( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a Fréchet distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Frechet( 10, 5 );
//produce a vector of random numbers
v = J( 1, 10, Random Frechet( 10, 5 ) );
//show results
Show( x, v );


```

### [Random GLog](#random-glog)

**Syntax:** y = Random GLog( mu, sigma, lambda )

**Description:** Returns a random number from a generalized logarithm distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random GLog( 4, 1, 0.1 );
//produce a vector of random numbers
v = J( 1, 10, Random GLog( 4, 1, 0.1 ) );
//show results
Show( x, v );


```

### [Random Gamma](#random-gamma)

**Syntax:** y = Random Gamma( alpha, \<scale=1> )

**Description:** Returns a random number from a gamma distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Gamma( 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Gamma( 1 ) );
//show results
Show( x, v );


```

### [Random Gamma Poisson](#random-gamma-poisson)

**Syntax:** y = Random Gamma Poisson( lambda, \<sigma=1> )

**Description:** Returns a random number from a gamma Poisson distribution with parameters lambda and sigma.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Gamma Poisson( 3, 2 );
//produce a vector of random numbers
v = J( 1, 10, Random Gamma Poisson( 3, 2 ) );
//show results
Show( x, v );


```

### [Random GenGamma](#random-gengamma)

**Syntax:** y = Random GenGamma( \<mu=0>, \<sigma=1>, \<lambda=0> )

**Description:** Returns a random number from an extended generalized gamma distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random GenGamma( 2, 1.25 );
//produce a vector of random numbers
v = J( 1, 10, Random GenGamma( 2, 1.25 ) );
//show results
Show( x, v );


```

### [Random Geometric](#random-geometric)

**Syntax:** y = Random Geometric( p )

**Description:** Returns a random number of non-events until an event occurs, for events with probability p.

**JMP Version Added:** Before version 14

```

exrgeop = 0.1;
exrgeolsz = Log( 300 );
New Window( "Example: Random Geometric and Empirical Distribution",
    exrgeoy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 50 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        exrgeosz = Round( Exp( exrgeolsz ) );
        exrgeosamp = J( Round( exrgeosz ), 1, . );
        exrgeofreq = J( Round( 50 + 1 ), 1, . );
        For( exrgeok = 1, exrgeok <= Round( exrgeosz ), exrgeok++,
            exrgeosamp[exrgeok] = Random Geometric( exrgeop )
        );
        For( exrgeok = 0, exrgeok <= 50, exrgeok++,
            exrgeofreq[exrgeok + 1] = Sum( exrgeosamp <= exrgeok ) / Round( exrgeosz )
        );
        exrgeotmp1 = 0;
        exrgeotmp2 = 0;
        For( exrgeok = 0, exrgeok < 50, exrgeok++,
            exrgeotmp2 = exrgeotmp2 + (1 - exrgeop) ^ exrgeok * exrgeop;
            H Line( exrgeok, exrgeok + 1, exrgeotmp2 );
            V Line( exrgeok, exrgeotmp1, exrgeotmp2 );
            exrgeotmp1 = exrgeotmp2;
        );
        Pen Color( "blue" );
        For( exrgeok = 0, exrgeok < 50, exrgeok++,
            H Line( exrgeok, exrgeok + 1, exrgeofreq[exrgeok + 1] );
            V Line( exrgeok + 1, exrgeofreq[exrgeok + 1], exrgeofreq[exrgeok + 2] );
        );
        Text( {10, 0.2}, " p=", Round( exrgeop, 2 ), " sample size=", Round( exrgeosz ) );
    ),
    H List Box(
        Slider Box( Log( 10 ), Log( 5000 ), exrgeolsz, exrgeoy << reshow ),
        Text Box( " random sample size" )
    )
);


```

### [Random Index](#random-index)

**Syntax:** x = Random Index( n, k )

**Description:** Returns a k by 1 matrix of random integers between 1 and n with no duplicates.

**JMP Version Added:** Before version 14

```

Random Index( 100, 5 );


```

### [Random Integer](#random-integer)

**Syntax:** y = Random Integer( n ); Random Integer( k, n )

**Description:** Returns a random integer between 1 and n (or between k and n) inclusive.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Integer( 1, 10 );
//produce a vector of random numbers
v = J( 1, 10, Random Integer( 1, 10 ) );
//show results
Show( x, v );


```

### [Random Johnson Sb](#random-johnson-sb)

**Syntax:** y = Random Johnson Sb( gamma, delta, theta, sigma )

**Description:** Returns a random number from a Johnson Sb distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Johnson Sb( 0.5, 1, 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Johnson Sb( 0.5, 1, 1, 1 ) );
//show results
Show( x, v );


```

### [Random Johnson Sl](#random-johnson-sl)

**Syntax:** y = Random Johnson Sl( gamma, delta, theta, \<sigma=1> )

**Description:** Returns a random number from a Johnson Sl distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Johnson Sl( 0.5, 1, 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Johnson Sl( 0.5, 1, 1, 1 ) );
//show results
Show( x, v );


```

### [Random Johnson Su](#random-johnson-su)

**Syntax:** y = Random Johnson Su( gamma, delta, theta, sigma )

**Description:** Returns a random number from a Johnson Su distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Johnson Su( 0.5, 1, 1, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Johnson Su( 0.5, 1, 1, 1 ) );
//show results
Show( x, v );


```

### [Random LEV](#random-lev)

**Syntax:** y = Random LEV( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a LEV distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random LEV( 10, 5 );
//produce a vector of random numbers
v = J( 1, 10, Random LEV( 10, 5 ) );
//show results
Show( x, v );


```

### [Random Linearly Constrained Uniform](#random-linearly-constrained-uniform)

**Syntax:** points = Random Linearly Constrained Uniform( numSamples, A, b, L, U, neq, nle, nge, \<nwarm=200>, \<nstride=25>, \<tol=1e-8>, <G>, <LC>, <UC> )

**Description:** Generates a random sample subject to linear constraints, variable bound constraints, and cardinality constraints on specified component subgroup variables. The numSamples argument specifies the number of random points to be generated. The A argument is the linear constraint coefficient matrix. The b argument is the vector of right hand side values of the linear constraints. The L and U arguments are vectors of the lower and upper bounds for the variables, respectively. The neq, nle, and nge arguments are the number of equality constraints, the number of less than or equal constraints, and the number of greater than or equal constraints, respectively. The nwarm argument is the number of warm-up repetitions before points are written to the output matrix. The nstride argument is the number of repetitions between each point that is written to the output matrix. The tol argument is the tolerance. The G argument is a vector of indices that assigns the variables to constrained component subgroups where missing or zero values do not belong to a constrained subgroup. The LC and UC arguments are the lower and upper cardinality constraints for the constrained component subgroups, respectively. Note that the constraints must be listed as equality first, less than or equal next, and greater than or equal last.

**JMP Version Added:** 20

**Example 1**

```

A = [1 1 1, 1 2 0];
b = [1, 0.5];
L = [0, 0, 0.1];
U = [1, 1, 1];
points = Random Linearly Constrained Uniform( 2000, A, b, L, U, 1, 0, 1, 300, 50 );
dt = As Table( points );
tobj = Report( Ternary Plot( X( :Col1, :Col2, :Col3 ) ) );
tfr = tobj[scalebox( 1 )] << clone box;
New Window( "Example: Random Linearly Constrained Uniform",
    Outline Box( "Points on a Ternary Plot", tfr ),
    Outline Box( "Constraints",
        Text Box( "X1 + x2 + x3 = 1" ),
        Text Box( "X2 + 2*x2 >= 0.5" )
    ),
    Outline Box( "Variable Bounds",
        Text Box( "0 <= x1 <= 1" ),
        Text Box( "0 <= x2 <= 1" ),
        Text Box( ".1 < x3 <= 1" )
    )
);
Close( dt, no save );
Show( "see new window for example output" );


```

**Example 2**

```


A = [1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1];
b = [100];
L = [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0];
U = [100 100 95 90 100 85 100 90 60 70 75 70 75 100 95 60 80 95 100 100];
nwarm = 100;
nstride = 100;
tol = 1e-8;
// Index the constrained subgroups.  Index = 0 is not in a constrained subgroup.
G = [0 0 1 1 1 1 1 1 2 2 2 2 2 2 2 2 2 2 0 0];
// Lower cardinality constraints for the constrained subgroups
LC = [1 1];
// Upper cardinality constraints for the constrained subgroups
UC = [3 5];
points = Random Linearly Constrained Uniform(
    100,
    A,
    b,
    L,
    U,
    1,
    0,
    0,
    nwarm,
    nstride,
    tol,
    G,
    LC,
    UC
);
dt = As Table( points );


```

### [Random LogGenGamma](#random-loggengamma)

**Syntax:** y = Random LogGenGamma( \<mu=0>, \<sigma=1>, \<lambda=0> )

**Description:** Returns a random number from a log generalized gamma distribution with parameters mu, sigma, and lambda.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random LogGenGamma( 2, 1.25 );
//produce a vector of random numbers
v = J( 1, 10, Random LogGenGamma( 2, 1.25 ) );
//show results
Show( x, v );


```

### [Random Logistic](#random-logistic)

**Syntax:** y = Random Logistic( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a logistic distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Logistic( 15, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Logistic( 15, 1 ) );
//show results
Show( x, v );


```

### [Random Loglogistic](#random-loglogistic)

**Syntax:** y = Random Loglogistic( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a loglogistic distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Loglogistic( 15, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random Loglogistic( 15, 1 ) );
//show results
Show( x, v );


```

### [Random Lognormal](#random-lognormal)

**Syntax:** y = Random Lognormal( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a lognormal distribution with location parameter mu and scale parameter sigma.

**JMP Version Added:** Before version 14

**Example 1**

```


//produce a single random number
x = Random Lognormal( -1, 1.5 );
//produce a vector of random numbers
v = J( 1, 10, Random Lognormal( -1, 1.5 ) );
//show results
Show( x, v );


```

**Example 2**

```

exrlnn = 30;
New Window( "Example: Random Lognormal and Empirical Distribution",
    exrlny = Graph Box(
        Y Scale( -0.05, 1.05 ),
        X Scale( -.05, 10 ),
        Pen Color( "red" );
        exranlnorm = J( Round( exrlnn ), 1, . );
        For( k = 1, k <= Round( exrlnn ), k++,
            exranlnorm[k] = Random Lognormal( -1, 1.5 )
        );
        exranlnorm = Sort Ascending( exranlnorm );
        H Line( 0, exranlnorm[1], 0 );
        For( k = 2, k <= Round( exrlnn ), k++,
            H Line( exranlnorm[k - 1], exranlnorm[k], (k - 1) / Round( exrlnn ) )
        );
        H Line( exranlnorm[Round( exrlnn )], 10, 1.0 );
        Pen Color( "blue" );
        Y Function( Normal Distribution( Log( tdeq ), -1, 1.5 ), tdeq );
        Text( {-4, 0.8}, " n=", Round( exrlnn ) );
    ),
    H List Box( Slider Box( 10, 2000, exrlnn, exrlny << reshow ), Text Box( " n" ) )
);


```

### [Random Multivariate Normal](#random-multivariate-normal)

**Syntax:** y = Random Multivariate Normal( mean, covar, \<nrows=1>)

**Description:** Returns a random nrows by p matrix from a multivariate normal distribution with mean vector mean and (positive semi-definite) covariance matrix covar, where p is defined as the number of rows of covar.

**JMP Version Added:** 15

```

meanvec = 1 :: 3;
covar = [1 .6 .6, .6 1 .6, .6 .6 1];
randmvnRow = Random Multivariate Normal( meanvec, covar );
randmvnMat = Random Multivariate Normal( meanvec, covar, 10 );


```

### [Random Negative Binomial](#random-negative-binomial)

**Syntax:** y = Random Negative Binomial( r, p )

**Description:** Returns a random number of non-events until r events occur, for events with probability p.

**JMP Version Added:** Before version 14

```

exnbpp = 0.3;
exnbpn = 20;
exnbrn = Random Negative Binomial( 20, 0.3 );
New Window( "Example: Neg Binomial Probability",
    exnbpy = Graph Box(
        Y Scale( 0, 0.04 ),
        X Scale( -1, 100 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( exnbpk = 0, exnbpk < 1000, exnbpk++,
            V Line( exnbpk, 0, Neg Binomial Probability( exnbpp, exnbpn, exnbpk ) )
        );
        Pen Color( "blue" );,
        Pen Size( 4 ),
        V Line( exnbrn, 0, Neg Binomial Probability( exnbpp, exnbpn, exnbrn ) );
        Text( {1, 0.035}, "n=", Round( exnbpn ), " p=", Round( exnbpp, 2 ) );
        Text(
            {1, 0.030},
            "x=",
            Round( exnbrn, 2 ),
            " Prob=",
            Round( Neg Binomial Probability( exnbpp, exnbpn, exnbrn ), 2 )
        );
    ),
    H List Box(
        Button Box( "Generate a Random Negative Binomial Number",
            exnbrn = Random Negative Binomial( 20, 0.3 );
            exnbpy << reshow;
        )
    )
);


```

### [Random Normal](#random-normal)

**Syntax:** y = Random Normal( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a normal distribution with mean mu and standard deviation sigma.

**JMP Version Added:** Before version 14

**Example 1**

```


//produce a single random number
x = Random Normal();
//produce a vector of random numbers
v = J( 1, 10, Random Normal() );
//show results
Show( x, v );


```

**Example 2**

```

exGcoordX = J( 50, 1, . );
exGcoordY = J( 50, 1, . );
For( k = 1, k <= 50, k++,
    exGcoordX[k] = Random Uniform( -5, 5 )
);
For( k = 1, k <= 50, k++,
    exGcoordY[k] = exGcoordX[k] + Random Normal()
);
New Window( "Random Normal, Linear Regression, and Outlier",
    V List Box(
        Graph Box(
            framesize( 600, 300 ),
            X Scale( -10, 10 ),
            Y Scale( 1.5 * Min( exGcoordY ), 1.5 * Max( exGcoordY ) ),
            double buffer,
            exsx = Sum( exGcoordX ),
            exsy = Sum( exGcoordY ),
            exsxx = Sum( (exGcoordX) ^ 2 );
            exsxy = Sum( exGcoordX :* exGcoordY );
            exbeta1 = (100 * exsxy - exsx * exsy) / (100 * exsxx - exsx * exsx);
            exbeta0 = (exsy - exbeta1 * exsx) / 100;
            exx1 = Min( exGcoordX );
            exy1 = exbeta0 + exbeta1 * Min( exGcoordX );
            exx2 = Max( exGcoordX );
            exy2 = exbeta0 + exbeta1 * Max( exGcoordX );
            Line( {exx1, exy1}, {exx2, exy2} );
            Marker Size( 5 );
            Drag Marker( exGcoordX, exGcoordY );
            Drag Text( [-7], [-5], "drag any marker" );
        )
    )
);


```

### [Random Normal Mixture](#random-normal-mixture)

**Syntax:** y = Random Normal Mixture( meanvec, sdvec, probvec )

**Description:** Returns a random number from a normal mixture distribution with group means meanvec, group standard deviations sdvec, and group probabilities probvec.

**JMP Version Added:** Before version 14

```

dt = New Table( "Example",
    New Column( "Rand NM",
        set formula( Random Normal Mixture( [-3, 3], [1, 1], [.3, .7] ) )
    )
);
dt << add rows( 1000 );
Distribution( Continuous Distribution( Column( :Rand NM ), Vertical( 0 ) ) );


```

### [Random Poisson](#random-poisson)

**Syntax:** y = Random Poisson( lambda )

**Description:** Returns a random number from a Poisson distribution.

**JMP Version Added:** Before version 14

```

exrpoilambda = 20;
exrpoilsz = Log( 300 );
New Window( "Example: Random Poisson and Empirical Distribution",
    exrpoiy = Graph Box(
        Y Scale( 0, 1.05 ),
        X Scale( -1, 50 ),
        Pen Color( "red" ),
        Pen Size( 1 );
        exrpoisz = Round( Exp( exrpoilsz ) );
        exrpoisamp = J( Round( exrpoisz ), 1, . );
        exrpoifreq = J( Round( 50 + 1 ), 1, . );
        For( exrpoik = 1, exrpoik <= Round( exrpoisz ), exrpoik++,
            exrpoisamp[exrpoik] = Random Poisson( exrpoilambda )
        );
        For( exrpoik = 0, exrpoik <= 50, exrpoik++,
            exrpoifreq[exrpoik + 1] = Sum( exrpoisamp <= exrpoik ) / Round( exrpoisz )
        );
        exrpoitmp1 = 0;
        exrpoitmp2 = 0;
        For( exrpoik = 0, exrpoik < 50, exrpoik++,
            H Line( exrpoik, exrpoik + 1, Poisson Distribution( exrpoilambda, exrpoik ) );
            V Line(
                exrpoik + 1,
                Poisson Distribution( exrpoilambda, exrpoik ),
                Poisson Distribution( exrpoilambda, exrpoik + 1 )
            );
        );
        Pen Color( "blue" );
        For( exrpoik = 0, exrpoik < 50, exrpoik++,
            H Line( exrpoik, exrpoik + 1, exrpoifreq[exrpoik + 1] );
            V Line( exrpoik + 1, exrpoifreq[exrpoik + 1], exrpoifreq[exrpoik + 2] );
        );
        Text(
            {10, 0.2},
            " \!U03BB=",
            Round( exrpoilambda, 2 ),
            " sample size=",
            Round( exrpoisz )
        );
    ),
    H List Box(
        Slider Box( Log( 10 ), Log( 5000 ), exrpoilsz, exrpoiy << reshow ),
        Text Box( " random sample size" )
    )
);


```

### [Random Reset](#random-reset)

**Syntax:** Random Reset( seed number )

**Description:** Restarts the random sequences with a new seed.

**JMP Version Added:** Before version 14

```

Random Reset( 1 );
Random Normal();


```

### [Random SEV](#random-sev)

**Syntax:** y = Random SEV( \<mu=0>, \<sigma=1> )

**Description:** Returns a random number from a SEV distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random SEV( 50, 5 );
//produce a vector of random numbers
v = J( 1, 10, Random SEV( 50, 5 ) );
//show results
Show( x, v );


```

### [Random SHASH](#random-shash)

**Syntax:** y = Random SHASH( gamma, delta, theta, sigma )

**Description:** Returns a random number from the sinh-arcsinh (SHASH) distribution.

**JMP Version Added:** 14

**Example 1**

```


//produce a single random number
x = Random SHASH( 0, 1, 0, 1 );
//produce a vector of random numbers
v = J( 1, 10, Random SHASH( 0, 1, 0, 1 ) );
//show results
Show( x, v );


```

#### [SHASH Transformation](#shash-transformation)

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [Random Seed State](#random-seed-state)

**Syntax:** Random Seed State( <seed state> )

**Description:** Retrieves or restores the random seed state to or from a blob object.

**JMP Version Added:** Before version 14

```

r = Random Seed State();
Random Seed State( r );


```

### [Random Shuffle](#random-shuffle)

**Syntax:** y = Random Shuffle( matrix )

**Description:** Returns the matrix with the elements shuffled into a random order.

**JMP Version Added:** Before version 14

```

exA = [1 2 6, 3 5 8];
Random Shuffle( exA );


```

### [Random Triangular](#random-triangular)

**Syntax:** y = Random Triangular( a, b, c ); y = Random Triangular( b, c ); y = Random Triangular( b )

**Description:** Returns a random number from a triangular distribution with lower limit a, mode b, and upper limit c. Random Triangular(b,c) is equivalent to Random Triangular(0,b,c). Random Triangular(b) is equivalent to Random Triangular(0,b,1).

**JMP Version Added:** Before version 14

```

Random Reset( 13579 );
x = Random Triangular( 0.8 );
Random Reset( 13579 );
y = Random Triangular( 0, 0.8, 1 );
Show( x, y );


```

### [Random Uniform](#random-uniform)

**Syntax:** y = Random Uniform( <min>, <max> )

**Description:** Returns a random number from a uniform distribution between min and max, exclusive.

**JMP Version Added:** Before version 14

**Example 1**

```


//produce a single random number
x = Random Uniform( 1, 10 );
//produce a vector of random numbers
v = J( 1, 10, Random Uniform( 1, 10 ) );
//show results
Show( x, v );


```

**Example 2**

```

Random Uniform( 1, 10 );


```

### [Random Weibull](#random-weibull)

**Syntax:** y = Random Weibull( beta, \<alpha=1> )

**Description:** Returns a random number from a Weibull distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random Weibull( 3, 20 );
//produce a vector of random numbers
v = J( 1, 10, Random Weibull( 3, 20 ) );
//show results
Show( x, v );


```

### [Random ZI Negative Binomial](#random-zi-negative-binomial)

**Syntax:** y = Random ZI Negative Binomial( lambda, sigma, pi )

**Description:** Returns a random number from a zero-inflated Negative Binomial distribution with location parameter lambda, scale parameter sigma, and zero inflation parameter pi.

**JMP Version Added:** 19

**Example 1**

```

exnbpp = 0.3;
exnbpn = 20;
rnb = Random ZI Negative Binomial( 25, .5, .05 );
New Window( "Example: Zero Inflated Negative Binomial",
    exnbpy = Graph Box(
        Y Scale( 0, 0.075 ),
        X Scale( -1, 100 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( i = 0, i < 100, i++,
            V Line( i, 0, ZI Negative Binomial Probability( i, 25, .5, .05 ) )
        );
        Pen Color( "blue" );,
        Pen Size( 4 ),
        V Line( rnb, 0, ZI Negative Binomial Probability( rnb, 25, .5, .05 ) );
        Text(
            {25, 0.06},
            "lambda=",
            Round( 25 ),
            ", sigma=",
            Round( .5, 2 ),
            ", pi=",
            Round( .05, 2 )
        );
        Text(
            {25, 0.05},
            "x=",
            Round( rnb, 2 ),
            ", Prob=",
            Round( ZI Negative Binomial Probability( rnb, 25, .5, .05 ), 4 )
        );
    ),
    H List Box(
        Button Box( "Generate a Random Zero Inflated Negative Binomial Number",
            rnb = Random ZI Negative Binomial( 25, .5, .05 );
            exnbpy << reshow;
        )
    )
);


```

**Example 2**

```

Random Reset( 19 );
dt = As Table( J( 1000, 1, Random ZI Negative Binomial( 5, 2, .2 ) ) );
Column( 1 ) << set name( "Random ZiNB" );
dt << Distribution(
    Continuous Distribution(
        Column( :Random ZiNB ),
        Vertical( 0 ),
        Fit ZI Negative Binomial,
        CDF Plot( 1 )
    )
);


```

### [Random ZI Poisson](#random-zi-poisson)

**Syntax:** y = Random ZI Poisson Binomial( lambda, pi )

**Description:** Returns a random number from a zero-inflated Poisson distribution with location parameter lambda and zero inflation parameter pi.

**JMP Version Added:** 19

**Example 1**

```

exnbpp = 0.3;
exnbpn = 20;
rp = Random ZI Poisson( 20, .05 );
New Window( "Example: Zero Inflated Poisson",
    exnbpy = Graph Box(
        Y Scale( 0, 0.1 ),
        X Scale( -1, 60 ),
        Pen Color( "red" ),
        Pen Size( 2 );
        For( i = 0, i < 100, i++,
            V Line( i, 0, ZI Poisson Probability( i, 20, .05 ) )
        );
        Pen Color( "blue" );,
        Pen Size( 4 ),
        V Line( rp, 0, ZI Poisson Probability( rp, 20, .05 ) );
        Text( {30, 0.06}, "lambda=", Round( 20 ), ", pi=", Round( .05, 2 ) );
        Text(
            {30, 0.05},
            "x=",
            Round( rp, 2 ),
            ", Prob=",
            Round( ZI Poisson Probability( rp, 20, .05 ), 4 )
        );
    ),
    H List Box(
        Button Box( "Generate a Random Zero Inflated Poisson Number",
            rp = Random ZI Poisson( 20, .05 );
            exnbpy << reshow;
        )
    )
);


```

**Example 2**

```

Random Reset( 19 );
dt = As Table( J( 1000, 1, Random ZI Poisson( 5, .2 ) ) );
Column( 1 ) << set name( "Random ZIP" );
dt << Distribution(
    Continuous Distribution(
        Column( :Random ZIP ),
        Vertical( 0 ),
        Fit ZI Poisson,
        CDF Plot( 1 )
    )
);


```

### [Random t](#random-t)

**Syntax:** y = Random t( df, \<nonCentrality=0> )

**Description:** Returns a random number from an t distribution.

**JMP Version Added:** Before version 14

```


//produce a single random number
x = Random t( 2 );
//produce a vector of random numbers
v = J( 1, 10, Random t( 2 ) );
//show results
Show( x, v );


```

### [Resample Freq](#resample-freq)

**Syntax:** Resample Freq( \<rate=1>, <column> )

**Description:** Generates a frequency count for sampling with replacement, useful for bootstrap samples. With no arguments, the function generates a 100% resample. The rate argument specifies the rate of resampling. If the column argument is specified, the sample size chosen is rate multiplied by the sum of the specified column. A negative rate signals that fractional frequencies are allowed.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Freq", numeric, formula( Resample Freq() ) );
New Window( "w", theBox = V List Box() );
For( i = 1, i <= 30, i++,
    Column( "Freq" ) << EvalFormula;
    theBox << append(
        V List Box( Bivariate( Y( :height ), X( :weight ), Freq( :Freq ), Fit Line( 1 ) ) )
    );
);
newDt = theBox["Parameter Estimates", Table Box( 1 )] << MakeCombinedDataTable;
newDt << Distribution( Y( :Estimate ), By( :Term ), Horizontal Layout( 1 ) );
theBox << CloseWindow;


```

# [Row State](#row-state)

### [As Row State](#as-row-state)

**Syntax:** rs = As Row State( x )

**Description:** Converts a number into a row state value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row(
    Row State() = As Row State(
        (:sex == "F") * 2 + (:sex == "M") * 4 + ((:sex == "F") * 2 + (:sex == "M") * 6) * 16
         + (:age - 11) * 256
    )
);


```

### [Color Of](#color-of)

**Syntax:** y = Color Of( <rs> ); Color Of( \<Row State( <r> )> ) = y

**Description:** Returns the color component of the specified row state value, either a positive JMP color palette index or a negative RGB-encoded value. If Color Of is used as an L-value, it changes the color of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" ) << Color By Column( :height );
Color To RGB( Color Of( Row State( 3 ) ) );
Row() = 3;
Color To RGB( Color Of() );


```

### [Color State](#color-state)

**Syntax:** rs = Color State( color )

**Description:** Returns a row state value with the color component set to the specified value. The color argument can be any valid JSL color.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Color State( {1, 0.5, 1} );
Color To RGB( Color Of( Row State( 3 ) ) );


```

### [Combine States](#combine-states)

**Syntax:** rs = Combine States( rs1, ... )

**Description:** Combines several row state values into one.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Combine States( Hue State( 5 ), Shade State( 1 ) );


```

### [Excluded](#excluded)

**Syntax:** y = Excluded( <rs> ); Excluded( \<Row State( <r> )> ) = y

**Description:** Returns the excluded component of the specified row state value, 0 or 1. If the Excluded() function is used as an L-value, it changes the excluded state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Excluded State( 1 );
Excluded( Row State( 3 ) );
Row() = 3;
Excluded();


```

### [Excluded State](#excluded-state)

**Syntax:** rs = Excluded State( x )

**Description:** Returns a row state value with the excluded component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Excluded State( 1 );
Excluded( Row State( 3 ) );


```

### [Hidden](#hidden)

**Syntax:** y = Hidden( <rs> ); Hidden( \<Row State( <r> )> ) = y

**Description:** Returns the hidden component of the specified row state value, 0 or 1. If Hidden is used as an L-value, it changes the hidden state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Hidden State( 1 );
Hidden( Row State( 3 ) );
Row() = 3;
Hidden();


```

### [Hidden State](#hidden-state)

**Syntax:** rs = Hidden State( x )

**Description:** Returns a row state value with the hidden component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Hidden State( 1 );
Hidden( Row State( 3 ) );


```

### [Hue State](#hue-state)

**Syntax:** rs = Hue State( x )

**Description:** Returns a row state value with the color hue component set to the specified value. Needs to be combined with a Shade State() value to produce a valid color.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Combine States( Hue State( 5 ), Shade State( 1 ) );


```

### [Labeled](#labeled)

**Syntax:** y = Labeled( <rs> ); Labeled( \<Row State( <r> )> ) = y

**Description:** Returns the labeled component of the specified row state value, 0 or 1. If Labeled is used as an L-value, it changes the labeled state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Labeled State( 1 );
Labeled( Row State( 3 ) );
Row() = 3;
Labeled();


```

### [Labeled State](#labeled-state)

**Syntax:** rs = Labeled State( x )

**Description:** Returns a row state value with the labeled component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Labeled State( 1 );
Labeled( Row State( 3 ) );


```

### [Marker Of](#marker-of)

**Syntax:** y = Marker Of( <rs> ); Marker Of( \<Row State( <r> )> ) = y

**Description:** Returns the marker component of the specified row state value. If Marker Of is used as an L-value, it changes the marker of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Marker State( 5 );
Marker Of( Row State( 3 ) );
Row() = 3;
Marker Of();


```

### [Marker State](#marker-state)

**Syntax:** rs = Marker State( marker )

**Description:** Returns a row state value with the marker component set to the specified value. The marker argument specifies a marker and can be a positive integer, a character, a positive integer for Unicode character, or a hex character for Unicode character.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Marker State( 5 );
Marker Of( Row State( 3 ) );


```

### [Row State](#row-state_1)

**Syntax:** y = Row State( <dt>, <r> ); Row State( <dt>, <r> ) = y

**Description:** Returns the row state of the current (or rth) row in the current data table. If the Row State() function is used as an L-value, it changes the row state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Color State( {1, .5, 1} );
Color To RGB( Color Of( Row State( 3 ) ) );


```

### [Selected](#selected)

**Syntax:** y = Selected( <rs> );Selected( \<Row State( <r> )> ) = y

**Description:** Returns the selected component of the specified row state value, 0 or 1. If Selected is used as an L-value, it changes the selected state of the current (or rth) row in the current data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Selected State( 1 );
Selected( Row State( 3 ) );
Row() = 3;
Selected();


```

### [Selected State](#selected-state)

**Syntax:** rs = Selected State( x )

**Description:** Returns a row state value with the selected component set to the specified value.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Selected State( 1 );
Selected( Row State( 3 ) );


```

### [Shade State](#shade-state)

**Syntax:** rs = Shade State( x )

**Description:** Returns a row state value with the color shade component set to the specified value. Needs to be combined with a Hue State() value to produce a valid color.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row State( 3 ) = Combine States( Hue State( 5 ), Shade State( 1 ) );


```

# [Row](#row)

### [As Table](#as-table)

**Syntax:** dt = As Table( matrix, \<matrix2,...> < \<<invisible/private>, < \<<Column Names(name list) > )

**Description:** Converts a matrix into a data table. The invisible option can be used to avoid displaying the table.

**JMP Version Added:** Before version 14

```

As Table( [1 2 3, 4 5 6] );


```

### [Col Stored Value](#col-stored-value)

**Syntax:** y = Col Stored Value( <dt>, xCol, \<row=Row()> )

**Description:** Returns column value that has not had column properties applied to it. If row option is not specified, then the current row is assumed.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Equity.jmp" );
:JOB << Set Property( "Missing Value Codes", {"Other"} );
y1 = Col Stored Value( :JOB, 10 );
y2 = Col Stored Value( :JOB, 11 );
y3 = Col Stored Value( :JOB, 14 );
y4 = Col Stored Value( :JOB, 15 );
Show( y1, y2, y3, y4 );


```

### [Column](#column)

**Syntax:** y = Column( name|number ); y = Column( dataTable, name|number, \<"formatted"> )

**Description:** Returns a reference to the specified data table column. The keyword "formatted" allows accessing formatted data, like the value label.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
col4 = Column( 4 );
ht = Column( "height" );
col4[1] + ht[2];


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << run script( "Set Sex Value Labels" );
col = Column( dt, "sex", "formatted" );
Write( "\!n", col[5] );
Write( "\!nData value returned is the formatted value of row 5." );


```

### [Column Name](#column-name)

**Syntax:** name = Column Name( n )

**Description:** Returns the name of the nth column of the current data table.

**JMP Version Added:** Before version 14

```

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


```

### [Count](#count)

**Syntax:** y = Count( start, end, s, \<n=1> )

**Description:** Returns the ith value in the sequence of numbers from start to end taking s steps and repeating each number n times, where i is determined by the value of the Row() function. Being dependent on the Row() function, the Count() function is generally used in column formulas.

**JMP Version Added:** Before version 14

```

New Table( "Count Example",
    Add Rows( 12 ),
    New Column( "Count1" ),
    New Column( "Count2" ),
    New Column( "Count3", Set Formula( Count( 0, 6, 4, 1 ) ) )
);
For Each Row(
    :Count1[Row()] = Count( 0, 6, 4, 1 );
    :Count2[Row()] = Count( 0, 6, 3, 2 );
);


```

### [Current Data Table](#current-data-table)

**Syntax:** dt = Current Data Table( \<Project(title|index|box|window)> ); Current Data Table( dt )

**Description:** Returns the current data table or makes the specified data table current if there is one specified.

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Current Data Table() << Get Column Names;


```

### [Data Table](#data-table)

**Syntax:** dt = Data Table( name|number )

**Description:** Returns a reference to the specified data table.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Data Table( 1 );


```

### [Dif](#dif)

**Syntax:** y = Dif( x, \<n=1> )

**Description:** Returns x - Lag( x, n ), also known as the "first difference". Being dependent on Row(), Dif() is mainly useful in column formulas.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 3;
Dif( :height, 2 );


```

### [Dim](#dim)

**Syntax:** y = Dim(); y = Dim( dt ); y = Dim( matrix )

**Description:** Returns a row vector with the dimensions of the current data table, a specified data table, or a matrix. The dimensions are the number of rows and the number of columns and are listed in that order.

**JMP Version Added:** 14

```

Dim( [11 22, 33 44, 55 66] );


```

### [Get Data Table](#get-data-table)

**Syntax:** dt = Get Data Table( \<Project(title|index|box|window)>, name|index )

**Description:** Returns a reference to the specified data table.

The search is limited to tables in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Get Data Table( 1 );


```

### [Get Data Table List](#get-data-table-list)

**Syntax:** tableList = Get Data Table List( \<Project(title|index|box|window)> )

**Description:** Returns a list of all open data tables.

The list is limited to tables in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

**JMP Version Added:** 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Get Data Table List();


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );
Get Data Table List( Project( project ) );


```

### [Lag](#lag)

**Syntax:** y = Lag( <x>, \<n=1> )

**Description:** Returns the value of the x argument with the current row set to Row() - n. Being dependent on Row(), Lag() is mainly useful in column formulas.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 3;
Lag( :height, 2 );


```

### [N Row](#n-row)

**Syntax:** y = N Row(); y = N Row( dt ); y = N Row( matrix )

**Description:** Returns the number of rows in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Row( [11 22, 33 44] );


```

### [N Rows](#n-rows)

**Syntax:** y = N Rows(); y = N Rows( dt ); y = N Rows( matrix )

**Description:** Returns the number of rows in the current data table, a specified data table, or a matrix.

**JMP Version Added:** Before version 14

```

N Rows( [11 22, 33 44] );


```

### [N Table](#n-table)

**Syntax:** n = N Table()

**Description:** Returns the number of currently open data tables.

**JMP Version Added:** Before version 14

**Example 1**

```

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


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Open( "$SAMPLE_DATA/Cars.jmp" );
Open( "$SAMPLE_DATA/Solubility.jmp" );
d = {};
For( i = 1, i <= N Table(), i++,
    d[i] = Data Table( i ) << GetName
);
d;


```

### [New Column](#new-column)

**Syntax:** dc = New Column( name, \<"Numeric"|"Character"|"RowState"|"Expression">, \<"Continuous"|"Ordinal"|"Nominal"|"Multiple Response"|"Unstructured Text"|"Vector"|"None">, \<Width( n )|Format(format name, width, precision)>, \<Like(:other column)>, <actions> )

**Description:** Creates a new column in the current data table. The optional actions arguments are any messages that data columns support.

**JMP Version Added:** Before version 14

#### [Like](#like)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "like name", Like( :name ) );


```

#### [Simple](#simple)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "example", "Numeric", "Continuous", Width( 5 ), <<Set Each Value( 100 ) );


```

### [New Column by Text Matching](#new-column-by-text-matching)

**Syntax:** dc = New Column by Text Matching( Column(:name), Set Regex(), \<Output Column Name("Name")>, \<Use Result(0 | 1)> )

**Description:** Creates a new column by performing a regular expression pattern match on an existing column.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Aircraft Incidents.jmp" );
New Column by Text Matching(
    Column( :Narrative Cause ),
    Set Regex( Library( "Words" ), Library( "Time" ), Library( "Units" ) ),
    Output Column Name( "Match Output" ),
    Use Result( 1 )
);


```

### [New Table](#new-table)

**Syntax:** dt = New Table( name, \<visibility("private"|"invisible"|"visible")>, \<Enable Filter Views(bool)>, <actions> )

**Description:** Creates a new data table. "Invisible" hides the data table from view but lists it in the JMP Home Window. "Private" hides the table completely. "Visible" is the default, and creates a normal table that is visible and listed in the JMP Home Window. The optional actions arguments are any messages that data tables support.

**JMP Version Added:** Before version 14

```

New Table( "Little Class",
    Add Rows( 3 ),
    New Column( "name", Character, Nominal, Set Values( {"KATIE", "LOUISE", "JANE"} ) ),
    New Column( "age", Nominal, Set Values( [12, 13, 13] ) ),
    New Column( "weight", Continuous, Set Values( [95, 123, 74] ) )
);


```

### [Row](#row_1)

**Syntax:** y = Row(); Row() = y

**Description:** Returns the current row in a data table. Can be set as an L-value. Reset the current row by assigning value of 0.

**JMP Version Added:** Before version 14

#### [Reset Row](#reset-row)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Add Rows( 5 );
Show( Row() );
Row() = 0;


```

#### [Set Row](#set-row)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 3;
:height * :weight;


```

### [Sequence](#sequence)

**Syntax:** y = Sequence( start, end, \<incr=1>, \<n=1> )

**Description:** Returns the Row()th item in the sequence of numbers from start to end incremented by incr. Each number in the sequence is repeated n times. Because of its dependence on Row(), the Sequence() function is mainly useful in column formulas. To create sequences as JSL matrices, see Index().

**JMP Version Added:** Before version 14

```

Row() = 3;
Sequence( 1, 9, 2 );


```

### [Subscribe to Data Table List](#subscribe-to-data-table-list)

**Syntax:** aSub = Subscribe to Data Table List( \<subscriber name | "">, \<OnOpen(fn) | OnClose(fn) | On Rename(fn)>)

**Description:** Subscribe to the data table list to be notified when a new data table has been added or closed.

**JMP Version Added:** Before version 14

**Example 1**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "closing" );
    Print( dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnClose( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );


```

**Example 2**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab, b},
    dtname = (dtab << getname());
    Print( "renaming ", b, " to ", dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnRename( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
dt << setname( "xxx" );


```

### [Subscript](#subscript)

**Syntax:** y = x[i]; y = m[row, col]; y = Subscript( x, i )

**Description:** Returns the ith value of a subscriptable object, which can be a column of a data table, a matrix, a list, or a report display element.

**JMP Version Added:** Before version 14

```

{11, 12, 13}[2];


```

### [Suppress Formula Eval](#suppress-formula-eval)

**Syntax:** Suppress Formula Eval( \<suppress=1> )

**Description:** Suppresses the evaluation of formulas in all data tables if the argument if nonzero.

**JMP Version Added:** Before version 14

```

Suppress Formula Eval( 1 );


```

### [Unsubscribe to Data Table List](#unsubscribe-to-data-table-list)

**Syntax:** aSub = Unsubscribe to Data Table List(<subscriber name>, \<"OnOpen" | "OnClose" | "OnRename" | "ALL">)

**Description:** Remove a subscription to the data table list that had been added thru the command "subscribe to data table list".

**JMP Version Added:** Before version 14

**Example 1**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "closing" );
    Print( dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnClose( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );
Unsubscribe to Data Table List( aSub, "on close" );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );


```

**Example 2**

```

f1 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "opening" );
    Print( dtname );
);
f2 = Function( {dtab},
    dtname = (dtab << getname());
    Print( "closing" );
    Print( dtname );
);
aSub = Subscribe to Data Table List( , OnOpen( f1 ) );
Subscribe to Data Table List( aSub, OnClose( f2 ) );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );
Unsubscribe to Data Table List( aSub, "all" );
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
Close( dt );


```

# [SAS](#sas)

### [As C Expr](#as-c-expr)

**Syntax:** y = As C Expr( x )

**Description:** Returns an equivalent expression in the C programming language.

**JMP Version Added:** Before version 14

```

As C Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As JSON Expr](#as-json-expr)

**Syntax:** y = As JSON Expr( x )

**Description:** Returns a JSON (JavaScript Object Notation) representation of the expression.

**JMP Version Added:** Before version 14

```

As JSON Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As JavaScript Expr](#as-javascript-expr)

**Syntax:** y = As JavaScript Expr( x )

**Description:** Returns an equivalent expression in the JavaScript programming language.

**JMP Version Added:** Before version 14

```

As JavaScript Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As Python Expr](#as-python-expr)

**Syntax:** y = As Python Expr( x )

**Description:** Returns an equivalent expression in the Python programming language.

**JMP Version Added:** Before version 14

```

As Python Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [As SAS Expr](#as-sas-expr)

**Syntax:** y = As SAS Expr( x )

**Description:** Returns a version of the expression more suitable for a SAS DATA step. The code must be wrapped in a PROC DS2 call.

**JMP Version Added:** Before version 14

```

As SAS Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ) );


```

### [SAS Name](#sas-name)

**Syntax:** sasName = SAS Name( string|namelist )

**Description:** Converts JMP variable names to a string containing valid SAS variable names by changing special characters and blanks to underscores. The argument can be specified as a string or a list of strings.

**JMP Version Added:** Before version 14

```

SAS Name( {"x 1", "x 2"} );


```

### [SAS Open For Var Names](#sas-open-for-var-names)

**Syntax:** nameList = SAS Open For Var Names( path )

**Description:** Returns a list of variable names from a SAS data set.

**JMP Version Added:** Before version 14

```

SAS Open For Var Names( "C:\my data\somedata.sas7bdat" );


```

# [SQL](#sql)

## [Associated Constructors](#associated-constructors)

### [New SQL Query](#new-sql-query)

**Syntax:** obj = New SQL Query( Connection( "ODBC:DSN=SampleDSN" ), Select( Column( "mycolumn", "t1" ) ), From( Table( "my_table", Schema( "my_schema" ), Alias( "t1" ) ) ) ); obj = New SQL Query( Connection( "ODBC:DSN=SampleDSN;" ), Custom SQL( "SELECT c1, c2, c3 FROM my_table;" ) )

**Description:** Creates an SQL Query object for the connection, columns and table specified, or for the custom SQL query specified. Use Query Builder to generate scripts that create queries.

```

obj = New SQL Query(
    Connection( "ODBC:DSN=mydsn" ),
    Select(),
    From( Table( "my_table", Schema( "my_schema" ), Alias( "t1" ) ) )
);


```

### [As SQL Expr](#as-sql-expr)

**Syntax:** y = As SQL Expr( x, <style> )

**Description:** Returns a string that contains the expression converted to valid SQL syntax for use in an SQL Select statement.

**JMP Version Added:** Before version 14

```

As SQL Expr( Expr( Match( sex, 1, "Male", 2, "Female", "Other" ) ), "MySQL" );


```

### [Close Database Connection](#close-database-connection)

**Syntax:** Close Database Connection(databaseConnectionHandle)

**Description:** Closes a database connection returned from Create Database Connection

**JMP Version Added:** Before version 14

```

Close Database Connection( databaseConnectionHandle );


```

### [Create Database Connection](#create-database-connection)

**Syntax:** dbc = Create Database Connection( dataSourceName|"Connect Dialog", \<DriverPrompt(true|false)> )

**Description:** Creates a database connection and returns a handle to the connection. If DriverPrompt is true, the user will be prompted using the ODBC driver's prompt to supply credentials if necessary.

**JMP Version Added:** Before version 14

```

dbc = Create Database Connection(
    "DSN=dBASE Files;DBQ=C:/Program Files/JMP/JMPPRO/19/Samples/Import Data/;"
);


```

### [Execute SQL](#execute-sql)

**Syntax:** dt = Execute SQL(databaseConnectionHandle|dataConnector, "SELECT ..."|"SQLFILE=..."|tableName, \<invisible(0|1)>, <outputTableName>, \<Batch Submit(0|1)> )

**Description:** Executes SQL against a database connection returned from Create Database Connection or a Data Connector. Enabling Batch Submit allows for receiving multiple results from multiple SQL statements, returning a list with the results (supporting drivers only).

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Execute SQL(
    databaseConnectionHandle,
    "SELECT HEIGHT, WEIGHT FROM Bigclass",
    "NewTable"
);


```

**Example 2**

```

dc = Data Connector Registry() << Get( "com.jmp.sql_server" );
dt = Execute SQL( dc, "SELECT HEIGHT, WEIGHT FROM Bigclass" );


```

**Example 3**

```

dc = Data Connector Registry() << Get( "com.jmp.sql_server" );
resultList = Execute SQL(
    dc,
    "SELECT HEIGHT, WEIGHT FROM Bigclass; SELECT AGE, WEIGHT FROM BigClass;",
    Batch Submit( 1 )
);


```

### [New Data Connector](#new-data-connector)

**Syntax:** result = New Data Connector( Type( type ) | ID( id ) | File( path ) | Spec( string ) | Base( data connector ), < Option1( value1 ) >, ..., < OptionN( valueN ) > )

**Description:** Create a data connector configuration object.

**JMP Version Added:** 18

**Example 1**

```


// Create a data connector from scratch
dc = New Data Connector( Type( "ODBC" ), Database( "foo" ), Server( "bar.example.com" ) );
Show( dc << Get( Database ) );  // Overridden database value "foo"
Show( dc << Get( Driver ) );  // Default driver value . (missing)
dc << Set( Database( "foo2" ), Driver( "SQL Server" ) );
Show( dc << Get( Database ) );  // New database value "foo2"
Show( dc << Get( Driver ) );  // New driver value "SQL Server"


```

**Example 2**

```


// Launch Query Builder from a SQL Server data source
dc = New Data Connector(
    ID( "com.jmp.sql_server" ), 
    // All these example values need to be replaced with real ones
    Server( "database.example.com" ),
    Database( "MainDatabase" ),
    User( "username" ),
    Password( "password" )
);
New SQL Query( Connection( dc ) ) << Modify;


```

### [New SQL Query](#new-sql-query_1)

**Syntax:** obj = New SQL Query( Connection( "ODBC:my_connection_string" ), Select( Column( "mycolumn", "t1" ) ), From( Table( "my_table", Schema( "my_schema" ), Alias( "t1" ) ) ) ); obj = New SQL Query( Connection( "ODBC:my_connection_string;" ), CustomSQL( "SELECT c1, c2, c3 FROM my_table;" ) )

**Description:** Creates an SQL Query object for the connection, columns and table specified, or for the custom SQL query specified. Use Query Builder to generate scripts that create queries.

**JMP Version Added:** Before version 14

```


obj = New SQL Query(
    Connection( "ODBC:DSN=mydsn" ),
    Select(),
    From( Table( "my_table", Schema( "my_schema" ), Alias( "t1" ) ) )
);


```

### [Open Database](#open-database)

**Syntax:** dt = Open Database( dataSourceName|"Connect Dialog", "SELECT ..."|"SQLFILE=..."|tableName, \<invisible | private>, <outputTableName> )

**Description:** Opens a database using ODBC, runs the given SQL, and puts data into a data table with the given output table name.

**JMP Version Added:** Before version 14

```

Open Database(
    "DSN=dBASE Files;DBQ=C:/Program Files/JMP/JMPPRO/19/Samples/Import Data/;",
    "SELECT HEIGHT, WEIGHT FROM Bigclass",
    "hw"
);


```

### [Query](#query)

**Syntax:** result = Query( < < dt1 | Table( dt1, alias1 ) >, ..., < dtN | Table( dtN, aliasN ) > >, \<Private|Invisible>, <Scalar>, sqlStatement )

**Description:** Perform an SQL query on JMP data tables. sqlStatement (the SQL query, most likely a SELECT statement) is required and must be the last argument. JMP data tables referenced by the SQL statement must be passed in as arguments to Query(), using Table(dt, "alias") to create an alias for the table that the SQL can use if desired. Invisible or Private can be passed in to control the visibility of the resulting data table. If the SQL statement returns a single value, pass in Scalar, which will cause the single value to be returned instead of a data table.

**JMP Version Added:** Before version 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
Query( dt, "SELECT name, age, height FROM 'Big Class'
         WHERE age > 14; " );

        // Using aliases, performing a join
dtSAT = Open( "$SAMPLE_DATA/SATByYear.jmp", Invisible );
dtUS = Open( "$SAMPLE_DATA/US Demographics.jmp", Invisible );
Query(
    Table( dtSAT, "t1" ),
    Table( dtUS, "t2" ), 

    "\[SELECT t1.State, t1."SAT Math", t2."College Degrees",
            t2."Eighth Grade Math"
       FROM t1
       LEFT OUTER JOIN t2
           ON t1.State = t2.State
       WHERE t1.'SAT Math' > 550;
      ]\"
);

        // Query that returns a scalar value
retval = Query( Scalar, dt, "SELECT AVG(height) from 'Big Class';" );
// Query with no tables
retval = Query( Scalar, "SELECT SQRT(152399025);" );


```

## [SQL Query](#sql-query)

### [Item Messages](#item-messages)

#### [CustomSQL](#customsql)

**Syntax:** obj \<< Custom SQL( sql )

**Description:** Changes the query to a custom SQL query and sets the SQL.

```

obj = New SQL Query(
    Connection( "ODBC:DSN=SampleDSN;" ),
    Custom SQL( "SELECT c1, c2, c3 FROM my_table;" )
);
obj << Custom SQL( "SELECT c4, c5, c6 FROM my_table;" );


```

#### [GenerateSQL](#generatesql)

**Syntax:** sql = obj \<< Generate SQL

**Description:** Generates and returns the SQL statement for the query.

```

obj = New SQL Query(
    Connection( "ODBC:DSN=SampleDSN;" ),
    Custom SQL( "SELECT c1, c2, c3 FROM my_table;" )
);
sql = obj << Generate SQL;


```

#### [Modify](#modify)

**Syntax:** obj \<< Modify

**Description:** Opens the query in Query Builder.

```

query << Modify;


```

#### [PostQueryScript](#postqueryscript)

**Syntax:** obj \<< Post Query Script( script_as_text )

**Description:** Sets the JSL script that will run after the query runs each time.

```

obj = New SQL Query(
    Connection( "ODBC:DSN=SampleDSN;" ),
    Custom SQL( "SELECT c1, c2, c3 FROM my_table;" )
);
obj << Post Query Script( "show( queryResult << Get As Matrix );" );


```

#### [QueryName](#queryname)

**Syntax:** obj \<< Query Name( <newName> )

**Description:** Gets or sets the name of the query. The name of the query will be used as the name of the data table that results from running the query.

```

obj = New SQL Query(
    Connection( "ODBC:DSN=SampleDSN;" ),
    Custom SQL( "SELECT c1, c2, c3 FROM my_table;" )
);
obj << Query Name( "New Name" );
name = obj << Query Name;
Show( name );


```

#### [Run](#run)

**Syntax:** result = obj \<< Run( \<Private|Invisible>, \<UpdateTable(table)>, \<OnRunComplete(script)>, \<OnRunCanceled(script)>, \<OnError(script)> )

**Description:** Run the query. The query might run in the foreground or in the background, depending on the Query Builder preference. If UpdateTable is specified, the query will run in the foreground. If the query runs in the foreground, the return value from Run will be the data table resulting from the query. If the query runs in the background or has an error, Run does not return a value. Use the OnRunComplete, OnRunCanceled, and OnError arguments to run a script when the query finishes.

```

query << Run;


```

#### [Run Background](#run-background)

**Syntax:** result = obj \<< Run Background( \<OnRunComplete(script), \<Private|Invisible>>, \<OnRunCanceled(script)>, \<OnError(script)> )

**Description:** Run the query in the background. The data table resulting from the query will open when the query finishes. Use the OnRunComplete, OnRunCanceled, and OnError arguments to run a script when the query finishes. Private can be specified only if an OnRunComplete script is also specified. Run Background does not return a value.

```


query << Run Background(
    OnRunComplete( Write( "Number of rows in query result: ", N Rows( queryResult ) ) )
);

MyRunCompleteFunc = Function( {dt},
    {Default Local},
    Write( "Number of rows in query result: ", N Rows( dt ) )
);
query << Run Background( OnRunComplete( MyRunCompleteFunc ) );


```

#### [Run Foreground](#run-foreground)

**Syntax:** result = obj \<< Run Foreground( \<Private|Invisible>, \<UpdateTable(table)>, \<OnRunComplete(script)>, \<OnRunCanceled(script)>, \<OnError(script)> )

**Description:** Run the query in the foreground. If the query succeeds or is canceled with a partial result, Run Foreground returns the data table resulting from the query. If the query fails, Run Foreground does not return a value. Use the OnRunComplete, OnRunCanceled, and OnError arguments to run a script when the query finishes.

```


query << Run Foreground(
    OnRunComplete( Write( "Number of rows in query result: ", N Rows( queryResult ) ) )
);

MyRunCompleteFunc = Function( {dt},
    {Default Local},
    Write( "Number of rows in query result: ", N Rows( dt ) )
);
query << Run Foreground( OnRunComplete( MyRunCompleteFunc ) );


```

#### [Save](#save)

**Syntax:** obj \<< Save

**Description:** Saves the query to its associated file. The save fails if the query does not yet have an associated file.

```

obj = Open( "my_query.jmpquery" );
obj << Query Name( "New Name" );
obj << Save;


```

#### [Save As](#save-as)

**Syntax:** obj \<< Save As( path, \<ReplaceExisting(0|1)> )

**Description:** Saves the query to the specified file. If the file already exists, the save will fail unless Replace Existing is true.

```

obj = New SQL Query(
    Connection( "ODBC:DSN=SampleDSN;" ),
    Custom SQL( "SELECT c1, c2, c3 FROM my_table;" )
);
obj << Save As( "c:\users\public\temp.jmpquery" );


```

# [Statistical](#statistical)

### [ARIMA Forecast](#arima-forecast)

**Syntax:** x = ARIMA Forecast( dtcol, length, model, estimates, from, to )

**Description:** Returns a vector of forecasted values for the dtcol column in the range determined by the from and to arguments. The length argument specifies a portion of the column for the function to use. The model argument matches messages that are sent to the Time Series platform to fit a model. The estimates argument matches the child of a Get Models message result of a single model. Typically, the from value is between 1 and the to value, inclusive. However, if from\<=0 and from\<=to, part of the results are filtered predictions.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Time Series/Steel Shipments.jmp" );
ARIMA Forecast(
    :Steel Shipments,
    96,
    ARIMA( 1, 0, 1 ),
    {AR Coefficients( {0.900397691783565} ), MA Coefficients( {0.483316746530245} ),
    Intercept( 6466.03264802329 )},
    1,
    2
);


```

### [Arc Finder](#arc-finder)

**Syntax:** Arc Finder( Group( lot, wafer ), X( col ), Y( col ), <optional arguments> )

**Description:** Finds the arcs in the point data and creates a new column identifying the arcs.

**JMP Version Added:** 14

```


dt = Open( "$SAMPLE_DATA/Wafer Stacked.jmp" );
Arc Finder(
    Group( :Lot, :Wafer ),
    X( :X_Die ),
    Y( :Y_Die ),
    Min Distance( 12 ), // minimum distance among 3 points to seed an arc
    Min Radius( 15 ), // minimum radius of the acceptable arc
    Max Radius( 2000 ), // maximum radius of acceptable arc
    Max Radius Error( 2 ), // how close a point needs to be added
    Min Arc Points( 5 ), // how many points to define an arc
    Number of Searches( 500 ), // how many random probes of data
    Max Number Arcs( 3 ) // number of arcs searched for
);
dt << Color or Mark by Column( :Arc Number );
dt << Graph Builder(
    Size( 1539, 921 ),
    Variables( X( :X_Die ), Y( :Y_Die ), Wrap( :Lot_Wafer Label ), Color( :Arc Number ) ),
    Elements( Points( X, Y, Legend( 6 ) ) )
);


```

### [Best Partition](#best-partition)

**Syntax:** {c1, c2, g2} = Best Partition( xIndices, yIndices, \<<Ordered, \<<ContinuousY, \<<ContinuousX )

**Description:** Determines the optimal grouping (experimental function).

**JMP Version Added:** Before version 14

```

/*Example for Continuous X and Continuous Y*/Best Partition(
    [1.2, 2.2, 3.5, 4.4, 5.6, 7.8],
    [11.2, 11.5, 11.8, 100.5, 100.7, 100.8],
    <<ContinuousX,
    <<ContinuousY
);


```

### [Col At](#col-at)

**Syntax:** y = Col At( col, index, \<byVar, ...>, < \<<relative(bool)>, < \<<skip missing(expr)> )

**Description:** Returns the value of col at row position index within its byVar group. Rows where the skip missing expression evaluates to a missing value are not included in the indexing.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Lag Height by Sex", Formula( Col At( :height, -1, :sex, <<relative( 1 ) ) ) );
New Column( "Relative to First Height", Formula( :height / Col At( :height, 1, :sex ) ) );
New Column( "Relative to Last Height", Formula( :height / Col At( :height, -1, :sex ) ) );


```

### [Col Cumulative Sum](#col-cumulative-sum)

**Syntax:** y = Col Cumulative Sum( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the cumulative sum for the current row. By variables do not need to be presorted.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 40;
Col Cumulative Sum( :height, :sex );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Cumulative Sum for each Sex",
    Formula( Col Cumulative Sum( :height, :sex ) )
);
dt << New Column( "Col Cumulative Sum for each Sex grouped by Excluded",
    Formula( Col Cumulative Sum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Interpolate](#col-interpolate)

**Syntax:** y = Col Interpolate( v, xCol, yCol, \<byVar, ...>, < \<<method(linear|nearest|previous|next)>, < \<<extrapolate(bool)> )

**Description:** Returns an interpolated value within yCol, corresponding to the position of v with xCol. Values outside the range of xCol will be missing unless extrapolate is on, in which case the nearest yCol value will be returned.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Time Series/GNP.jmp" );
dt << New Column( "date30", Formula( :date + 30 ) );
dt << New Column( "gnp30",
    Formula( Col Interpolate( :date30, :date, :"gross national product ($billions)"n ) )
);


```

### [Col Max](#col-max)

**Syntax:** y = Col Maximum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the maximum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Maximum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Maximum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Maximum Value for Each Age and Sex Group",
    Formula( Col Maximum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Max for each Sex", Formula( Col Maximum( :height, :sex ) ) );
dt << New Column( "Col Max for each Sex grouped by Excluded",
    Formula( Col Maximum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Maximum](#col-maximum)

**Syntax:** y = Col Maximum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the maximum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Maximum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Maximum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Maximum Value for Each Age and Sex Group",
    Formula( Col Maximum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Max for each Sex", Formula( Col Maximum( :height, :sex ) ) );
dt << New Column( "Col Max for each Sex grouped by Excluded",
    Formula( Col Maximum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Mean](#col-mean)

**Syntax:** y = Col Mean( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sample mean across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Mean( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Mean( :height, <<Freq( :weight ) );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Mean( :height, :age ) ) );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Mean for Each Age and Sex Group",
    Formula( Col Mean( :height, :age, :sex ) )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Mean for each Sex", Formula( Col Mean( :height, :sex ) ) );
dt << New Column( "Col Mean for each Sex grouped by Excluded",
    Formula( Col Mean( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Median](#col-median)

**Syntax:** y = Col Median( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the specified median across rows in a column. The ordering is cached internally so that multiple evaluations will be efficient.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Col Median Height",
    numeric,
    continuous,
    formula( Col Median( :height ) )
);
dt << New Column( "Col Median Height by Age",
    numeric,
    continuous,
    formula( Col Median( :height, :age ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 1;
Show( Col Median( :height ) );
Row() = 1;
Show( Col Median( :height, :age ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Median for each Sex", Formula( Col Median( :height, :sex ) ) );
dt << New Column( "Col Median for each Sex grouped by Excluded",
    Formula( Col Median( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Min](#col-min)

**Syntax:** y = Col Minimum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the minimum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Minimum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Minimum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Minimum Value for Each Age and Sex Group",
    Formula( Col Minimum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Min for each Sex", Formula( Col Minimum( :height, :sex ) ) );
dt << New Column( "Col Min for each Sex grouped by Excluded",
    Formula( Col Minimum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Minimum](#col-minimum)

**Syntax:** y = Col Minimum( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the minimum value across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Minimum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Minimum( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Minimum Value for Each Age and Sex Group",
    Formula( Col Minimum( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Min for each Sex", Formula( Col Minimum( :height, :sex ) ) );
dt << New Column( "Col Min for each Sex grouped by Excluded",
    Formula( Col Minimum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Mode](#col-mode)

**Syntax:** y = Col Mode( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sample mode across rows in a column, selecting the smallest in the case of multiple modes. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** 17

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Mode( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Mode( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Mode for Each Age and Sex Group",
    Formula( Col Mode( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Mode for each Sex", Formula( Col Mode( :height, :sex ) ) );
dt << New Column( "Col Mode for each Sex grouped by Excluded",
    Formula( Col Mode( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Moving Average](#col-moving-average)

**Syntax:** y = Col Moving Average( xCol, \<weighting=0.25>, \<before=-1>, \<after=0>, <partial window is missing=1>, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the moving average over a given interval based at the current row. For the weight multiplier, 1 means equal weighting, 0 means linear weighting, and other values act as an exponential weighting multiplier. By variables do not need to be presorted.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 40;
Col Moving Average( :height, 1, 5, 0, :sex );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Moving Average for each Sex",
    Formula( Col Moving Average( :height, :sex ) )
);
dt << New Column( "Col Moving Average for each Sex grouped by Excluded",
    Formula( Col Moving Average( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col N Missing](#col-n-missing)

**Syntax:** y = Col N Missing( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the number of missing values across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col N Missing( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col N Missing( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Number of Missing Values for Each Age and Sex Group",
    Formula( Col N Missing( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:height[10] = .;
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col N Missing for each Sex", Formula( Col N Missing( :height, :sex ) ) );
dt << New Column( "Col N Missing for each Sex grouped by Excluded",
    Formula( Col N Missing( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col N Unique](#col-n-unique)

**Syntax:** y = Col N Unique( xCol, \<byVar, ...>, < \<<score missing(bool)> )

**Description:** Returns the number of unique values in a column. If missing values are requested, all missing value codes are counted as a single value.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "N unique age by sex", Formula( Col N Unique( :age, :sex ) ) );
New Column( "N unique height by age", Formula( Col N Unique( :height, :age ) ) );


```

### [Col Number](#col-number)

**Syntax:** y = Col Number( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the number of nonmissing values across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Number( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Number( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Number of Nonmissing Values for Each Age and Sex Group",
    Formula( Col Number( :height, :age, :sex ) )
);


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt:height[10] = .;
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Number for each Sex", Formula( Col Number( :height, :sex ) ) );
dt << New Column( "Col Number for each Sex grouped by Excluded",
    Formula( Col Number( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Quantile](#col-quantile)

**Syntax:** y = Col Quantile( xCol, p, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the specified quantile across rows in a column. The ordering is cached internally so that multiple evaluations will be efficient.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Col Quantile Height",
    numeric,
    continuous,
    formula( Col Quantile( :height, 0.5 ) )
);
dt << New Column( "Col Quantile Height by Age",
    numeric,
    continuous,
    formula( Col Quantile( :height, 0.5, :age ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 1;
Show( Col Quantile( :height, 0.5 ) );
Row() = 1;
Show( Col Quantile( :height, 0.5, :age ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Quantile for each Sex",
    Formula( Col Quantile( :height, 0.5, :sex ) )
);
dt << New Column( "Col Quantile for each Sex grouped by Excluded",
    Formula( Col Quantile( :height, 0.5, :sex, Excluded( Row State() ) ) )
);


```

### [Col Rank](#col-rank)

**Syntax:** y = Col Rank( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<<tie("average"|"row"|"minimum"|"maximum"|"arbitrary")> )

**Description:** Returns the rank, ranging from 1 as the lowest, with row-order tie-breaking unless specified by the \<<Tie argument. "average" produces the average for tied ranks, and "minimum" produces the lowest of tied ranks. For "row" and "arbitrary" each row has a unique rank.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Rank Height", Formula( Col Rank( :height, <<tie( "average" ) ) ) );
New Column( "Rank Height by age", Formula( Col Rank( :height, :age ) ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Rank for each Sex", Formula( Col Rank( :height, :sex ) ) );
dt << New Column( "Col Rank for each Sex grouped by Excluded",
    Formula( Col Rank( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Score](#col-score)

**Syntax:** y = Col Score( xCol, \<byVar, ...>, < \<<score missing(bool)> )

**Description:** Returns an integer score for each unique value, ordering according to any relevant column properties.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Score Height", Formula( Col Score( :height ) ) );
New Column( "Score Height by age", Formula( Col Score( :height, :age ) ) );


```

### [Col Sequence](#col-sequence)

**Syntax:** y = Col Sequence( \<byVar, ...>, < \<<skip missing(expr)>, < \<<sequence(start=1, end=unbounded, incr=1, repeat=1)>)

**Description:** Returns the position of this row within its byVar group, adjusted by skip missing and any sequence parameters.

**JMP Version Added:** 19

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Column( "Row within sex", Formula( Col Sequence( :sex ) ) );
New Column( "Alternate within sex", Formula( Col Sequence( :sex, <<Sequence( 1, 2 ) ) ) );
New Column( "Row within sex, 60+",
    Formula( Col Sequence( :sex, <<skip missing( Sqrt( :height - 60 ) ) ) )
);


```

### [Col Simple Exponential Smoothing](#col-simple-exponential-smoothing)

**Syntax:** y = Col Simple Exponential Smoothing( xCol, alpha, \<byVar, ...> )

**Description:** Returns the simple exponential smoothing prediction for the current row, using smoothing weight alpha. By variables do not need to be presorted. Formula is Predicted Value[t]=alpha * Observed Value[t-1] + (1-alpha) * Predicted Value[t-1], with Predicted Value[1] = Observed Value[1].

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Time Series/Seriesa.jmp" );
Row() = 40;
Col Simple Exponential Smoothing( :Column1, .7 );


```

### [Col Standardize](#col-standardize)

**Syntax:** y = Col Standardize( xCol, \<byVar, \<Excluded( Row State() )>, ...> )

**Description:** Returns the value minus the column mean divided by the column standard deviation across rows in a column. If by-group columns are specified, the value is standardized against the mean and standard deviation of the by-group.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Row() = 1;
Col Standardize( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Standardize( :height, :age ) ) );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Standardize for each Sex",
    Formula( Col Standardize( :height, :sex ) )
);
dt << New Column( "Col Standardize for each Sex grouped by Excluded",
    Formula( Col Standardize( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Std Dev](#col-std-dev)

**Syntax:** y = Col Std Dev( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sample standard deviation across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Std Dev( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Std Dev( :height, :age ) ) );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Std Dev( :height, :age, <<Freq( :weight ) ) ) );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Standard Deviation for Each Age and Sex Group",
    Formula( Col Std Dev( :height, :age, :sex ) )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Standard Deviation for each Sex",
    Formula( Col Std Dev( :height, :sex ) )
);
dt << New Column( "Col Standard Deviation for each Sex grouped by Excluded",
    Formula( Col Std Dev( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Col Sum](#col-sum)

**Syntax:** y = Col Sum( xCol, \<byVar, \<Excluded( Row State() )>, ...>, < \<< Freq( freqCol ) > )

**Description:** Returns the sum across rows in a column. The result is cached internally so that multiple evaluations will be efficient. The optional byVar arguments specify by groups for the calculation. Note that byVar arguments should be used in a column formula or in a For Each Row() function.

**JMP Version Added:** Before version 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Sum( :height );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Col Sum( :height, <<Freq( :weight ) );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For Each Row( Show( Col Sum( :height, :age ) ) );


```

**Example 4**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << New Column( "Sum for Each Age and Sex Group",
    Formula( Col Sum( :height, :age, :sex ) )
);


```

**Example 5**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Clear Row States << Select Rows( Index( 1, 10 ) ) << Exclude;
dt << New Column( "Col Sum for each Sex", Formula( Col Sum( :height, :sex ) ) );
dt << New Column( "Col Sum for each Sex grouped by Excluded",
    Formula( Col Sum( :height, :sex, Excluded( Row State() ) ) )
);


```

### [Cumulative Sum](#cumulative-sum)

**Syntax:** y = Cumulative Sum( x )

**Description:** Returns a matrix of partial sums for the input matrix.

**JMP Version Added:** Before version 14

```

Cumulative Sum( [1 1 1 1 . 10 20] );


```

### [Fit Censored](#fit-censored)

**Syntax:** result = FitCensored( Distribution(name), YLow(vector) | Y(vector), \<YHigh(vector)>, \<Weight(vector)>, \<X(matrix)>, \<Z(matrix)>, \<HoldParm(vector)>, \<Use random sample to compute initial values(percent)>, \<Use first N observations to compute initial values(nobs)> )

**Description:** Fits a distribution using censored data. The required arguments are Distribution and either YLow or Y. The function returns a list that contains parameter estimates, covariance matrix, log-likelihood, AICc, BIC, and a convergence message. The X and Z arguments specify regression design matrices for location and scale, respectively. When the data vector is large, two optional arguments can be used to specify a sample to compute the initial values. You can specify a percent of the observations or the first nobs observations, but the total sample size must be greater than 100.

**JMP Version Added:** Before version 14

```

result = Fit Censored(
    Distribution( "Weibull" ),
    Y( [142, 156, 163, 198, 204, 205, 232, 239, 240, 261, 280, 296, 323, 344] )
);
Show( result );


```

### [Fit Circle](#fit-circle)

**Syntax:** {xCenter, yCenter, radius, sse} = Fit Circle( Xvec, Yvec )

**Description:** Fits the circle that best goes through three or more points that are defined by two vectors of coordinates. The result is a list that contains the X and Y coordinates of the center point of the circle, the length of the radius, and the sum of squared errors.

**JMP Version Added:** 14

```

x = [68, 77, 85, 88, 93, 93, 95, 98];
y = [1, 9, 18, 94, 35, 82, 40, 59];
result = Fit Circle( x, y );
New Window( "Fit Circle",
    Graph Box(
        X Scale( -50, 100 ),
        Y Scale( -20, 130 ),
        FrameSize( 300, 300 ),
        Marker( x, y );
        Circle( {result[1], result[2]}, result[3] );
    )
);


```

### [Hier Clust](#hier-clust)

**Syntax:** {c1, c2, c3, c4, c5} = Hier Clust( x )

**Description:** Returns the clustering history for a hierarchical clustering using Ward's method (without standardizing data), where x is a data matrix.

**JMP Version Added:** Before version 14

```

exdt = Open( "$SAMPLE_DATA/Body Measurements.jmp" );
ex = exdt << get as matrix();
exhc = Hierarchical Cluster(
    Y( Eval( exdt << Get Column Names ) ),
    Method( Ward ),
    Standardize( 0 ),
    Dendrogram Scale( Even Spacing ),
    Number of Clusters( 3 )
);
Report( exhc )["Dendrogram"] << Close( 1 );
Report( exhc )["Clustering History"] << Close( 0 );
exhistory = Hier Clust( ex );
exhistory[3, 1];


```

### [IRT Ability](#irt-ability)

**Syntax:** y = IRT Ability( Q1, ..., Qn, parmMatrix )

**Description:** Produces scores for the latent variable in an item response theory model with n binary items and a matrix of known parameters, specified by parmMatrix. The parameter matrix should contain as many rows as there are parameters in the model and as many columns as there are items in the analysis.

**JMP Version Added:** Before version 14

**Example 1**

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
obj = dt << Item Analysis( Y( :Q1, :Q2, :Q3, :Q4, :Q5 ), Model( "Logistic 2PL" ) );
obj << Save Ability Formula;
Column( dt, N Cols( dt ) ) << Get Formula;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/MathScienceTest.jmp" );
mth = (dt << get as matrix)[0, Index( 2, 6 )];
mthlst = {};
i = Floor( Random Uniform( 1, N Rows( mth ) ) );
mthlst[1] = mth[i, 1] |/ mth[i, 2] |/ mth[i, 3] |/ mth[i, 4] |/ mth[i, 5];
mthlst[2] = IRT Ability(
    mth[i, 1],
    mth[i, 2],
    mth[i, 3],
    mth[i, 4],
    mth[i, 5],
    [0.28 1.93 1.9 1.67 1, -0.06 -0.55 0.5 -1.89 0.04]
);
mthlst;


```

### [KDE](#kde)

**Syntax:** {Estimates, Bins, Counts, ActualBandwidth, Error} = KDE( Vector, \<<weights, \<<bandwidth( 0 ), \<<bandwidth scale( 1 ), \<<bandwidth selection( 0 ), \<<kernel )

**Description:** Returns a kernel density estimator with automatic bandwidth selection. The optional weights argument must be a vector of the same length as the Vector argument. The optional bandwidth argument must be a nonnegative real number or zero, which forces the use of the value of the bandwidth selection argument. The optional bandwidth scale argument must be a positive real number. The optional bandwidth selection argument must be either 0, 1, 2, or 3, corresponding to Sheather and Jones, Normal Reference, Silverman rule of thumb, or Oversmoother, respectively. The optional kernel argument accepts the values 0, 1, 2, 3, or 4, corresponding to Gaussian, Epanechnikov, Biweight, Triangular, or Rectangular, respectively.

**JMP Version Added:** Before version 14

```

// generate sample dataset from a mixture of 3 normal distributions
ndata3 = 25;
Random Reset( 113 );
channel = J( 1, ndata3 * 3, 0 );
For( i = 1, i <= ndata3, i++,
    channel[1, i] = Random Normal() - 3;
    channel[1, ndata3 + i] = Random Normal() / 2;
    channel[1, ndata3 + ndata3 + i] = Random Normal() + 3;
);

// use kernel density estimator to estimate the underlying distribution
bw = .; // automatic bandwidth
bscl = 1; // bandwidth multiplier
bsel = 0; // Sheather and Jones bandwith selection

// Create data table with estimates from all smoothing KDEs and Bins
dt = New Table( "KDE Smoothing",
    New Column( "Kernel", "Character" ),
    New Column( "Bin" ),
    New Column( "Density Estimate" ),
    New Column( "Counts" )
);

kernels = {"Gaussian", "Epanechnikov", "Biweight", "Triangular", "Rectangular"};
For( kernel = 0, kernel < N Items( kernels ), kernel++,
    res = KDE(
        channel,
        <<bandwidth( bw ),
        <<bandwidth scale( bscl ),
        <<bandwidth selection( bsel ),
        <<kernel( kernel )
    );
    nbin = N Items( res["Bins"] );
    rows = (N Rows( dt ) + 1) :: (N Rows( dt ) + nbin);
    dt << Add Rows( nbin );
    dt[rows, "Kernel"] = kernels[kernel + 1];
    dt[rows, "Bin"] = res["Bins"]`;
    dt[rows, "Density Estimate"] = res["Estimates"]`;
    dt[rows, "Counts"] = res["Counts"]`;
);

dt << Graph Builder(
    Size( 1000, 376 ),
    Show Control Panel( 0 ),
    Legend Position( "Bottom" ),
    Variables(
        X( :Bin ),
        Y( :Density Estimate, Side( "Right" ) ),
        Y( :Counts, Position( 1 ) ),
        Overlay( :Kernel )
    ),
    Elements(
        Bar( X, Y( 2 ), Overlay( 0 ), Legend( 2 ), Bar Style( "Needle" ) ),
        Line( X, Y( 1 ), Legend( 3 ) )
    )
);


```

### [LenthPSE](#lenthpse)

**Syntax:** y = LenthPSE( x )

**Description:** Returns Lenth's pseudo-standard error of the values within a single vector x.

**JMP Version Added:** Before version 14

```

Eval List( {LenthPSE( [1, 2, 3, 4, 5] ), Std Dev( [1, 2, 3, 4, 5] )} );


```

### [Max](#max)

**Syntax:** y = Max( x1, ... ); y = Maximum( x1, ... )

**Description:** Returns the maximum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Max( Pi(), e() ), Max( [33 44 22] )} );


```

### [Maximum](#maximum)

**Syntax:** y = Max( x1, ... ); y = Maximum( x1, ... )

**Description:** Returns the maximum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Max( Pi(), e() ), Max( [33 44 22] )} );


```

### [Mean](#mean)

**Syntax:** y = Mean( x1, ... )

**Description:** Returns the arithmetic mean of the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Mean( Pi(), e() ), Mean( [33 44 22 20 30] )} );


```

### [Median](#median)

**Syntax:** y = Median( x1, ... )

**Description:** Returns the median of the combined arguments, which can be scalar, matrix or list arguments.

**JMP Version Added:** 15

```

Median( [1.2, 1.5, 10, 25, 31, 40, 50, 99, 1000, 5000, 25000, 100000] );


```

### [Min](#min)

**Syntax:** y = Min( x1, ... ); y = Minimum( x1, ... )

**Description:** Returns the minimum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Min( Pi(), e() ), Min( [33 44 22] )} );


```

### [Minimum](#minimum)

**Syntax:** y = Min( x1, ... ); y = Minimum( x1, ... )

**Description:** Returns the minimum value among the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Min( Pi(), e() ), Min( [33 44 22] )} );


```

### [Moving Average](#moving-average)

**Syntax:** y = Moving Average( x, weighting, \<before=-1>, \<after=0>, <partial window is missing=0> )

**Description:** Returns a matrix of moving averages for the input matrix. before and after determine the range ("window") of items to average, where before can be -1 to indicate all prior items. If weighting is 1, all items have equal weight. If weighting is 0, items have linearly incremental weights. Otherwise, weighting is the parameter for exponential weighting (EWMA). partial window is missing indicates whether averages are reported when not all neighbors are present, which can occur at the ends or near missing values. If partial window is missing is nonzero, missing values are reported instead for such partial windows.

**JMP Version Added:** Before version 14

```

Eval List(
    {Moving Average( [1 2 1 2 3 4 9 9 9 9 9], 1, 3 ),
    Moving Average( [1 2 1 2 3 4 9 9 9 9 9], 0, 2, 2 ),
    Moving Average( [1 2 1 2 . 4 9 9 9 9 9], 1, 1, 1, 1 ),
    Moving Average( [1 2 1 2 3 4 9 9 9 9 9], 0.5 )}
);


```

### [N Missing](#n-missing)

**Syntax:** y = N Missing( x1, x2, ... )

**Description:** Returns the number of missing values among arguments.

**JMP Version Added:** Before version 14

```

N Missing( 1, 2, ., 3, [11 22 . .], 4 );


```

### [Normal Tolerance Factor](#normal-tolerance-factor)

**Syntax:** q = Normal Tolerance Factor( 1-alpha, p, n, <One Sided> )

**Description:** Computes the tolerance factor for constructing a 1-alpha confidence interval to contain proportion p of the means with sample size n from the normal distribution. There is an option to request the factor for a one-sided tolerance interval.

**JMP Version Added:** 19

```

n = 15;
New Window( "Example: Tolerance Factor()",
    tdig = Graph Box(
        Y Scale( 0, 5 ),
        X Scale( 0.05, 0.95 ),
        Yname( "Tolerance Factor" ),
        Xname( "p" ),
        Pen Color( "red" );
        Y Function( Normal Tolerance Factor( 0.95, p, n ), p );
        Text( {0.1, 4}, "n=", Round( n ) );
    ),
    H List Box( Text Box( "n" ), Slider Box( 5, 25, n, tdig << reshow ) )
);


```

### [Number](#number)

**Syntax:** y = Number( x1, ... )

**Description:** Returns the number of non-missing arguments or values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Number( 12, ., 11, 0, -42 ), Number( [33 . -42 . 0 . -30] )} );


```

### [Product](#product)

**Syntax:** y = Product( assignExpr, limit, bodyExpr )

**Description:** Returns the product of evaluations of the bodyExpr arguments, each time incrementing the variable from the assignExpr argument until it is greater than or equal to the limit argument.

**JMP Version Added:** Before version 14

```

2 * Product( i = 1, 10000, 4 * i * i / (2 * i - 1) / (2 * i + 1) );


```

### [Quantile](#quantile)

**Syntax:** y = Quantile( p, x1, ... )

**Description:** Returns the specified quantile p of the x arguments. The quantile argument can be a scalar or a matrix. The x values can also be specified as values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List(
    {Quantile( 0.75, 0, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000 ),
    Quantile( 0.5, [1.2, 1.5, 10, 25, 31, 40, 50, 99, 1000, 5000, 25000, 100000] )}
);


```

### [Range](#range)

**Syntax:** y = Range( x1, ... )

**Description:** Returns the minimum and maximum values among the combined arguments, which can be scalar, matrix or list arguments.

**JMP Version Added:** 15

```

Eval List( {Range( Pi(), e() ), Range( [33 44 22] )} );


```

### [SSQ](#ssq)

**Syntax:** y = SSQ( x1, ... )

**Description:** Returns the sum of squares of all elements

**JMP Version Added:** Before version 14

```

Eval List( {SSQ( Pi(), e() ), SSQ( [33 44 22 20 30] )} );


```

### [Std Dev](#std-dev)

**Syntax:** y = Std Dev( x1, ... )

**Description:** Returns the standard deviation of the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Std Dev( Pi(), e() ), Std Dev( [33 44 22 20 30] )} );


```

### [Sum](#sum)

**Syntax:** y = Sum( x1, ... )

**Description:** Returns the sum of the arguments or of the values within a single matrix or list argument.

**JMP Version Added:** Before version 14

```

Eval List( {Sum( Pi(), e() ), Sum( [33 44 22 20 30] )} );


```

### [Summarize](#summarize)

**Syntax:** Summarize( <dt>, nameBy=By( colBy ), name1=statName1( col1 ), ... )

**Description:** Calculates various summary statistics across a By column. The statistic names are Count, Sum, Mean, Max or Maximum, Min or Minimum, StdDev, Corr, Quantile, First. The statistics can be calculated only for numeric columns. The results are stored as matrices in variables with the specified names.

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( exg = By( :sex ), exm = Mean( :height ) );
Eval List( {exg, Round( exm, 1 )} );


```

### [Summarize YByX](#summarize-ybyx)

**Syntax:** Summarize YByX( X(x columns),Y(y columns), Group(grouping columns), Freq(freq column), Weight(Weight column))

**Description:** Calculates all Fit Y by X combinations

**JMP Version Added:** Before version 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize YByX( X( :age, :height ), Y( :sex, :weight ) );


```

### [Summation](#summation)

**Syntax:** y = Summation( assignExpr, limit, bodyExpr )

**Description:** Returns the sum of evaluations of the bodyExpr arguments, each time incrementing the variable from the assignExpr argument until it is greater than or equal to the limit argument.

**JMP Version Added:** Before version 14

```

Summation( i = 0, 10, 1 / Factorial( i ) );


```

# [Transcendental](#transcendental)

### [Arrhenius](#arrhenius)

**Syntax:** y = Arrhenius( tempC )

**Description:** Returns the non-specific component of the Arrhenius relationship that is then multiplied by the activation energy in the Arrhenius equation. Returns 11604.5181215503 / (tempC + 273.15).

**JMP Version Added:** Before version 14

```

Arrhenius( 100 );


```

### [Arrhenius Inv](#arrhenius-inv)

**Syntax:** tempC = Arrhenius Inv( y )

**Description:** Returns the inverse of the Arrhenius function, which is (11604.5181215503 / y) - 273.15.

**JMP Version Added:** Before version 14

```

Arrhenius Inv( 100 );


```

### [Beta](#beta)

**Syntax:** z = Beta( x, y )

**Description:** Returns Beta function of x and y, defined as Gamma( x ) * Gamma( y ) / Gamma( x + y ).

**JMP Version Added:** Before version 14

```

Beta( 5, 4 );


```

### [Box Cox Inverse Transform](#box-cox-inverse-transform)

**Syntax:** x = Box Cox Inverse Transform( y, lambda )

**Description:** Returns the inverse Box-Cox transformation of the argument.

**JMP Version Added:** 19

```

Box Cox Inverse Transform( 3, 2 );


```

### [Box Cox Transform](#box-cox-transform)

**Syntax:** y = Box Cox Transform( x, lambda )

**Description:** Returns the Box-Cox transformation of the argument.

**JMP Version Added:** 19

```

Box Cox Transform( 3, 2 );


```

### [Cytometry Logicle](#cytometry-logicle)

**Syntax:** y = Cytometry Logicle( x, T, W, M, A )

**Description:** Compute cytometry logicle transformation.

**JMP Version Added:** Before version 14

```

Cytometry Logicle( 100, 10000, .15, .45, 0 );


```

### [Cytometry Logicle Inverse](#cytometry-logicle-inverse)

**Syntax:** x = Cytometry Logicle Inverse( y, T, W, M, A )

**Description:** Compute inverse cytometry logicle transformation.

**JMP Version Added:** Before version 14

```

Cytometry Logicle Inverse( 100, 10000, .15, .45, 0 );


```

### [Digamma](#digamma)

**Syntax:** y = Digamma( x )

**Description:** Returns the digamma function evaluated at x, where the digamma function is the derivative of the logarithm of the gamma function.

**JMP Version Added:** Before version 14

```

Digamma( 5 );


```

### [Exp](#exp)

**Syntax:** y = Exp( \<x=1> )

**Description:** Returns e raised to the x power. Argument can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Round( Exp( 1 ), 5 );


```

### [ExpM1](#expm1)

**Syntax:** y = ExpM1( x )

**Description:** Returns a more accurate calculation of Exp(x)-1 when x is very small.

**JMP Version Added:** Before version 14

```

Show( ExpM1( 1.1e-18 ), Exp( 1.1e-18 ) - 1 );


```

### [FFT](#fft)

**Syntax:** ret = FFT( L, \<<inverse( 0 ), \<<multivariate( 0 ), \<<scale( 1.0 ) )

**Description:** Conducts Fast Fourier Transformation (FFT) on argument L, a required list consisting of real and imaginary parts of the data in matrix forms. If L consists of only one matrix, the matrix is considered to be the real part. If L consists of two matrices, the first is the real part, and the second is the imaginary part. The two matrices must have the same dimensions and must have more than one row. There are three optional arguments. The inverse argument determines whether to conduct inverse FFT. The multivariate argument determines whether to conduct spatial or multivariate FFT. The scale argument determines the constant by which the return values should be multiplied. Return value is a list of two matrices with the same dimensions as the first input argument.

**JMP Version Added:** Before version 14

```

FFT( {[1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3]} );
A = [1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3];
res = FFT( {A} );
res = FFT( {A}, <<Inverse( 1 ) );
res = FFT( {A}, <<multivariate( 1 ) );
res = FFT( FFT( {A} ), <<Inverse( 1 ), <<scale( 1 / 20 ) );
B = FFT( {A} );
FFT( B, <<Inverse( 1 ), <<scale( 1 / 20 ) );
Afun = Function( {},
    [1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3]
);
FFT( FFT( {Afun()} ), <<Inverse( 1 ), <<scale( 1 / 20 ) );
Afun = Function( {},
    {[1, 2, 3, 4, 4, 5, 5, 6, 7, 7, 2, 3, 6, 6, 2, 2, 2, 3, 3, 3]}
);
FFT( FFT( Afun() ), <<Inverse( 1 ), <<scale( 1 / 20 ) );
A = [1 3, 2 4, 3 1, 4 3, 4 5, 5 2, 5 7, 6 9, 7 5, 7 3, 2 7, 3 4, 6 7, 6 4, 2 7, 2 4, 2 6, 3 5,
3 6, 3 1];
res = FFT( {A} );
res = FFT( {A}, <<multivariate( 1 ) );
res = FFT( FFT( {A} ), <<Inverse( 1 ), <<scale( 1 / 40 ) );
res = FFT(
    FFT( {A}, <<multivariate( 1 ) ),
    <<multivariate( 1 ),
    <<Inverse( 1 ),
    <<scale( 1 / 20 )
);
A = [1 3 1,
2 4 3,
3 1 2,
4 3 3,
4 5 9,
5 2 8,
5 7 6,
6 9 5,
7 5 3,
7 3 2,
2 7 1,
3 4 3,
6 7 3,
6 4 2,
2 7 4,
2 4 1,
2 6 5,
3 5 1,
3 6 2,
3 1 9];
res = FFT( {A} );
res = FFT( {A}, <<multivariate( 1 ) );
FFT( FFT( {A} ), <<Inverse( 1 ), <<scale( 1 / 60 ) );
fin = FFT(
    FFT( {A}, <<multivariate( 1 ) ),
    <<Inverse( 1 ),
    <<multivariate( 1 ),
    <<scale( 1 / 20 )
);
Show( fin );


```

### [Factorial](#factorial)

**Syntax:** y = Factorial( x )

**Description:** Returns the factorial of x, which is the same as Gamma( x + 1 ). If x is an integer, the result is the product 1 * 2 * ... * x.

**JMP Version Added:** Before version 14

```

Factorial( 5 );


```

### [Fit Transform To Normal](#fit-transform-to-normal)

**Syntax:** result = Fit Transform To Normal( Distribution(name), Y(vector), \<Freq(vector)> )

**Description:** Fits a transformation to normality for a vector of data. This includes the Johnson Sl, Johnson Sb, Johnson Su, and GLog distributions. The function returns a list containing parameter estimates, covariance matrix, log-likelihood, AICc, a convergence message, and transformed values.

**JMP Version Added:** Before version 14

```

datavec = [-3.7975076, 0.48221038, -1.3082712, -1.860647, -6.9470789, -17.237024, -19.470857,
-6.1855986, 2.16525629, -30.990061];
freqvec = [1, 1, 1, 1, 1, 2, 2, 2, 2, 2];
As Table( datavec || freqvec );
Column( 1 ) << set name( "x" );
Column( 2 ) << set name( "freq vec" );
Distribution(
    Freq( :freq vec ),
    Continuous Distribution( Column( :x ), Fit Distribution( GLog ) )
);
results = Fit Transform To Normal( Distribution( "glog" ), Y( datavec ), freq( freqvec ) );
Show( results );


```

### [Gamma](#gamma)

**Syntax:** y = Gamma( x, <limit> )

**Description:** Returns Gamma function of x, defined as the integral of z^(x-1)\*exp(-z) dz from 0 to ∞. If limit is present, an incomplete Gamma is computed using that limit of integration.

**JMP Version Added:** Before version 14

```

Gamma( 5 );


```

### [LGamma](#lgamma)

**Syntax:** y = LGamma( x )

**Description:** Returns the natural logarithm of the Gamma function of x. Useful when Gamma(x) is too large to use directly.

**JMP Version Added:** Before version 14

```

LGamma( 5 );


```

### [Ln](#ln)

**Syntax:** y = Ln( x )

**Description:** Returns the natural logarithm of x.

**JMP Version Added:** Before version 14

```

Ln( Exp( 2 ) );


```

### [Log](#log)

**Syntax:** y = Log( x, <b> )

**Description:** Returns the base-b logarithm of x or the natural logarithm of x if b is not specified.

**JMP Version Added:** Before version 14

```

Log( 256, 2 );


```

### [Log10](#log10)

**Syntax:** y = Log10( x )

**Description:** Returns the base 10 logarithm of x.

**JMP Version Added:** Before version 14

```

Log10( 100 );


```

### [Log1P](#log1p)

**Syntax:** y = Log1P( x )

**Description:** Returns a more accurate calculation of Log(1 + x) when x is very small.

**JMP Version Added:** Before version 14

```

Log1P( 1e-6 );


```

### [Logist](#logist)

**Syntax:** y = Logist( x )

**Description:** Returns 1 / (1 + Exp( -x )), which converts a number in the domain -∞...+∞ into range 0...1. The Logist() function is useful in logistic regression.

**JMP Version Added:** Before version 14

```

Logist( 2 );


```

### [Logist Percent](#logist-percent)

**Syntax:** y = Logist Percent( x )

**Description:** Logist function with result scaled 0 to 100.

**JMP Version Added:** Before version 14

```

Logist Percent( 10 );


```

### [Logit](#logit)

**Syntax:** y = Logit( p )

**Description:** Returns the logit of p, which is defined as log(p / (1 - p)).

**JMP Version Added:** Before version 14

```

Logit( 0.95 );


```

### [Logit Percent](#logit-percent)

**Syntax:** y = Logit Percent( p )

**Description:** Logit function with argument 0 to 100, rather than 0 to 1.

**JMP Version Added:** Before version 14

```

Logit Percent( 95.0 );


```

### [N Choose K](#n-choose-k)

**Syntax:** m = N Choose K( n, k )

**Description:** Returns n! / (k! * (n - k)!), which is the number of ways to choose k items out of n, ignoring order.

**JMP Version Added:** Before version 14

```

N Choose K( 5, 3 );


```

### [Power](#power)

**Syntax:** z = x ^ y; z = Power( x, \<y=2> )

**Description:** Returns x raised to the y power. If x is negative, y must be an integer.

**JMP Version Added:** Before version 14

```

Power( 2, 5 );


```

### [Root](#root)

**Syntax:** y = Root( x, \<n=2> )

**Description:** Returns the nth root of x.

**JMP Version Added:** Before version 14

```

Round( Root( 2, 3 ), 4 ) /* cube root */;


```

### [SHASHInv](#shashinv)

**Syntax:** x = SHASHInv( z, gamma, delta, theta, sigma )

**Description:** Transforms a standard normal variable to a sinh-arcsinh (SHASH) distributed variable.

**JMP Version Added:** 14

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
x1 = SHASHInv( result1, gamma, delta, theta, sigma );
x2 = SinH( (ArcSinH( result1 ) - gamma) / delta ) * sigma + theta;
Show( x1, x2 );


```

### [SHASHTrans](#shashtrans)

**Syntax:** z = SHASHTrans( x, gamma, delta, theta, sigma )

**Description:** Transforms a sinh-arcsinh (SHASH) distributed variable to a standard normal distributed variable. The SHASH transformation can be used to create more normally distributed data.

**JMP Version Added:** 14

```

gamma = 1;
delta = .5;
theta = -1;
sigma = 2;
x = 3;
result1 = SHASHTrans( x, gamma, delta, theta, sigma );
result2 = SinH( gamma + delta * ArcSinH( (x - theta) / sigma ) );
Show( result1, result2 );


```

### [SbInv](#sbinv)

**Syntax:** x = SbInv( z, gamma, delta, theta, sigma )

**Description:** Transforms a standard normal variable to a double bounded Johnson variable.

**JMP Version Added:** Before version 14

```

SbInv( 1.96, 1.5, 2, 1, 2 );


```

### [SbTrans](#sbtrans)

**Syntax:** z = SbTrans( x, gamma, delta, theta, sigma )

**Description:** Transforms a double bounded Johnson variable to a standard normal variable.

**JMP Version Added:** Before version 14

```

Round( SbTrans( 2.114, 1.5, 2, 1, 2 ), 2 );


```

### [Scheffe Cubic](#scheffe-cubic)

**Syntax:** y = Scheffe Cubic( x1, x2 )

**Description:** Evaluates as x1\*x2\*(x1-x2); used to support modeling notation for cubic mixture models.

**JMP Version Added:** Before version 14

```

Scheffe Cubic( [1, -1, 1, -1, 1], [-1, -1, 1, 1, -1] );


```

### [SlInv](#slinv)

**Syntax:** x = SlInv( z, gamma, delta, theta, \<sigma=1> )

**Description:** Transforms a standard normal variable to a Johnson SL variable.

**JMP Version Added:** Before version 14

```

SlInv( 1.96, 1.5, 2, 1 );


```

### [SlTrans](#sltrans)

**Syntax:** z = SlTrans( x, gamma, delta, theta, \<sigma=1> )

**Description:** Transforms a Johnson SL variable to a standard normal variable.

**JMP Version Added:** Before version 14

```

Round( SlTrans( 2.259, 1.5, 2, 1 ), 2 );


```

### [Sqrt](#sqrt)

**Syntax:** y = Sqrt( x )

**Description:** Returns the positive square root of the x argument, which can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

Round( Sqrt( 2 ), 4 );


```

### [Squash](#squash)

**Syntax:** y = Squash( x )

**Description:** Returns 1 / (1 + Exp( x )), which converts a number in the domain -∞...+∞ into range 1...0. The Squash() function is useful in logistic regression.

**JMP Version Added:** Before version 14

```

Squash( 10 );


```

### [Squish](#squish)

**Syntax:** y = Logist( x )

**Description:** Returns 1 / (1 + Exp( -x )), which converts a number in the domain -∞...+∞ into range 0...1. The Logist() function is useful in logistic regression.

**JMP Version Added:** Before version 14

```

Logist( 2 );


```

### [SuInv](#suinv)

**Syntax:** x = SuInv( z, gamma, delta, theta, sigma )

**Description:** Transforms a standard normal variable to an unbounded Johnson variable.

**JMP Version Added:** Before version 14

```

SuInv( 1.96, 1.5, 2, 1, 2 );


```

### [SuTrans](#sutrans)

**Syntax:** z = SuTrans( x, gamma, delta, theta, sigma )

**Description:** Transforms an unbounded Johnson variable to a standard normal variable.

**JMP Version Added:** Before version 14

```

Round( SuTrans( 1.46, 1.5, 2, 1, 2 ), 2 );


```

### [Trigamma](#trigamma)

**Syntax:** y = Trigamma( x )

**Description:** Returns the trigamma function evaluated at x, where the trigamma function is the derivative of the digamma function.

**JMP Version Added:** Before version 14

```

Trigamma( 5 );


```

# [Trigonometric](#trigonometric)

### [ATan](#atan)

**Syntax:** y = ArcTangent( x1, \<x2=1> )

**Description:** Returns the inverse trigonometric tangent of x1/x2, where the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

4 * ArcTangent( 1 );


```

### [ArCos](#arcos)

**Syntax:** y = ArcCosine( x )

**Description:** Returns the inverse trigonometric cosine of x, where x is in the range [-1, 1] and the result is in the range [0, Pi()].

**JMP Version Added:** Before version 14

```

ArcCosine( 0.5 );


```

### [ArSin](#arsin)

**Syntax:** y = ArcSine( x )

**Description:** Returns the inverse trigonometric sine of x, where x is in the range [-1, 1] and the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

ArcSine( 0.5 );


```

### [ArcCosH](#arccosh)

**Syntax:** y = ArcCosH( x )

**Description:** Returns the inverse hyperbolic cosine of x.

**JMP Version Added:** Before version 14

```

ArcCosH( 1 );


```

### [ArcCosine](#arccosine)

**Syntax:** y = ArcCosine( x )

**Description:** Returns the inverse trigonometric cosine of x, where x is in the range [-1, 1] and the result is in the range [0, Pi()].

**JMP Version Added:** Before version 14

```

ArcCosine( 0.5 );


```

### [ArcSinH](#arcsinh)

**Syntax:** y = ArcSinH( x )

**Description:** Returns the inverse hyperbolic sine of x.

**JMP Version Added:** Before version 14

```

ArcSinH( 1 );


```

### [ArcSine](#arcsine)

**Syntax:** y = ArcSine( x )

**Description:** Returns the inverse trigonometric sine of x, where x is in the range [-1, 1] and the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

ArcSine( 0.5 );


```

### [ArcTan](#arctan)

**Syntax:** y = ArcTangent( x1, \<x2=1> )

**Description:** Returns the inverse trigonometric tangent of x1/x2, where the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

4 * ArcTangent( 1 );


```

### [ArcTanH](#arctanh)

**Syntax:** y = ArcTanH( x )

**Description:** Returns the inverse hyperbolic tangent of x.

**JMP Version Added:** Before version 14

```

ArcTanH( 0.5 );


```

### [ArcTangent](#arctangent)

**Syntax:** y = ArcTangent( x1, \<x2=1> )

**Description:** Returns the inverse trigonometric tangent of x1/x2, where the result is in the range [-Pi()/2, Pi()/2].

**JMP Version Added:** Before version 14

```

4 * ArcTangent( 1 );


```

### [Cos](#cos)

**Syntax:** y = Cosine( x )

**Description:** Returns the trigonometric cosine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Cosine( Pi() / 2 );


```

### [CosH](#cosh)

**Syntax:** y = CosH( x )

**Description:** Returns the hyperbolic cosine of x.

**JMP Version Added:** Before version 14

```

CosH( 1 );


```

### [Cosine](#cosine)

**Syntax:** y = Cosine( x )

**Description:** Returns the trigonometric cosine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Cosine( Pi() / 2 );


```

### [Sin](#sin)

**Syntax:** y = Sine( x )

**Description:** Returns the trigonometric sine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Sine( Pi() / 6 );


```

### [SinH](#sinh)

**Syntax:** y = SinH( x )

**Description:** Returns the hyperbolic sine of x.

**JMP Version Added:** Before version 14

```

SinH( 1 );


```

### [Sine](#sine)

**Syntax:** y = Sine( x )

**Description:** Returns the trigonometric sine of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Sine( Pi() / 6 );


```

### [Tan](#tan)

**Syntax:** y = Tangent( x )

**Description:** Returns the trigonometric tangent of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Tangent( Pi() / 4 );


```

### [TanH](#tanh)

**Syntax:** y = TanH( x )

**Description:** Returns the hyperbolic tangent of x.

**JMP Version Added:** Before version 14

```

TanH( 1 );


```

### [Tangent](#tangent)

**Syntax:** y = Tangent( x )

**Description:** Returns the trigonometric tangent of x, where x is an angle in radians.

**JMP Version Added:** Before version 14

```

Tangent( Pi() / 4 );


```

# [Utility](#utility)

### [Add](#add)

**Syntax:** y = x0 + x1; y = Add( x0, x1, ... )

**Description:** Adds all arguments, which can be numbers, matrices, or lists of numbers.

**JMP Version Added:** Before version 14

```

Pi() + 10;


```

### [Beep](#beep)

**Syntax:** Beep()

**Description:** Makes an alert sound.

**JMP Version Added:** Before version 14

```

Beep();


```

### [Blob MD5](#blob-md5)

**Syntax:** blobResult = Blob MD5( blob )

**Description:** Makes a 16-byte result BLOB from a source BLOB (Binary Large OBject). The 16 byte BLOB is the MD5 checksum (or the hash) of the source BLOB.

**JMP Version Added:** Before version 14

```

Hex(/* make it printable */ Blob MD5(/* get the hash */
        Load Text File(/* a file from the samples */ "$SAMPLE_IMPORT_DATA/animals.txt",
            BLOB/* the result is a BLOB, not a string */
        )
    )
) == "763D3C9F5F3E92951B3A3DC965084DAC" /* benchmark hash value */ /* the result is 1 if the benchmark matches */
;


```

### [Blob Peek](#blob-peek)

**Syntax:** blobResult = Blob Peek( blob, offset, <length> )

**Description:** Makes a new blob from a subrange of bytes of the given blob. The offset argument is zero-based, so the first byte is at offset zero.

**JMP Version Added:** Before version 14

```

Blob Peek( Char To Blob( "Quick Bob, eat your lunch!" ), 6 /*Zero based!*/, 3 );


```

### [Build Information](#build-information)

**Syntax:** y = Build Information()

**Description:** Returns the build date and time, release or debug build, and product name.

**JMP Version Added:** Before version 14

```

Build Information();


```

### [Caption](#caption)

**Syntax:** y = Caption( \<{h, v}>, text | remove, \<Delayed( seconds )>, \<Font(font)>, \<Font Size(size)>, \<Text Color(color)>, \<Back Color(color)>, \<Spoken(bool)> )

**Description:** Shows a caption window at the location specified by {h, v} and containing the text specified by the text argument. The Delayed( seconds ) argument sets the waiting time in seconds before each caption.

**JMP Version Added:** Before version 14

#### [Formatted Caption](#formatted-caption)

```

Caption(
    {100, 200},
    "explanation",
    Font( "Arial Black" ),
    Font Size( 16 ),
    Text Color( "blue" ),
    Back Color( "yellow" ),
    Spoken( 1 )
);


```

#### [Remove Caption](#remove-caption)

```

Caption( "explanation" );
Wait( 2 );
Caption( remove );


```

### [Current Journal](#current-journal)

**Syntax:** y = Current Journal( \<Project(title|index|box|window)> )

**Description:** Returns a reference to the current journal in the current project (or no project when not running the script in a project).

To specify a project, use the optional Project() argument with a title, index, display box, or window object. Use Project(0) to specify no project when running the script in a project.

If no current journal exists in the given project, one will be created automatically.

**JMP Version Added:** Before version 14

```

Current Journal();


```

### [Data Connector Registry](#data-connector-registry)

**Syntax:** Data Connector Registry()

**Description:** The collection of data connectors for JMP.

**JMP Version Added:** 18

```


dc = Data Connector Registry() << Get( "com.jmp.sql_server" );


```

### [Datafeed](#datafeed)

**Syntax:** y = Open Datafeed( ... )

**Description:** Creates an object and window you can send messages to manage real-time data feeds.

**JMP Version Added:** Before version 14

```

exfeed = Open Datafeed(/*Connect( Port( "com3" ), Baud( 4800 ), DataBits( 8 ) ),*/
    Set Script(
        ex = exfeed << getLine;
        Show( ex );
    )
);
For( exi = 0, exi < 5, exi++, /* this is just a way to test a feed when the real data source is not available...*/
    exfeed << Queue Line( Char( exi ) );
    Wait( .5 );
);


```

### [Debug Break](#debug-break)

**Syntax:** Debug Break()

**Description:** When this expression is evaluated within the JSL Debugger, the Debugger stops executing the script.

**JMP Version Added:** Before version 14

```

// Right-click and select Debug.
// In the JSL Debugger, click Run.
x = 5;
y = 8;
Debug Break();
z = x + yy;
Show( z );


```

### [Decode URI](#decode-uri)

**Syntax:** Decode URI( value )

**Description:** Encode the string using URI encoding

**JMP Version Added:** 14

```


Decode URI( "Foo%20Bar" );


```

### [Decode64 Blob](#decode64-blob)

**Syntax:** y = Decode64 Blob( base64String )

**Description:** Decodes a printable string of base 64 text into a blob.

**JMP Version Added:** 14

```

Decode64 Blob( "dGhlIHF1aWNrIGJyb3duIGZveA==" );


```

### [Decode64 Double](#decode64-double)

**Syntax:** y = Decode64 Double( base64String )

**Description:** Returns the double-precision floating point number from the Base64 encoded string.

**JMP Version Added:** Before version 14

```

Decode64 Double( "P/lUWYIBG9Q=" );


```

### [Disable JMP Live URL](#disable-jmp-live-url)

**Syntax:** Disable JMP Live URL(url)

**Description:** Disables a JMP Live URL. This method is available only during jmpStartAdmin.jsl. An asterisk * can be used a wildcard to specify URLs as * (any URL), \*.jmp.com (a URL ending in .jmp.com), http://public.\* (a URL starting with http://public.), or \*public\* (a URL that contains public).

**JMP Version Added:** 15

```


Disable JMP Live URL( "*public.jmp.com" );


```

### [Disable Proxy Settings](#disable-proxy-settings)

**Syntax:** Disable Proxy Settings( 1|0 )

**Description:** Disables or enables proxy settings during jmpStartAdmin.jsl execution. Proxy settings are enabled by default.

**JMP Version Added:** 15

```


Disable Proxy Settings( 1 );


```

### [Divide](#divide)

**Syntax:** y = x0 / x1; y = Divide( x0, <x1>, ... )

**Description:** Divides all subsequent arguments from the first argument. Arguments can be numbers, matrices, or lists of numbers. When called with only one argument, the result will be the reciprocal.

**JMP Version Added:** Before version 14

#### [Reciprocal](#reciprocal)

```

x = Divide( 5 );
y = 1 / 5;
Show( x, y );


```

#### [Simple](#simple)

```

6 / 3 / 2;


```

### [Empty](#empty)

**Syntax:** y = Empty()

**Description:** Returns an empty value. Used in formula editor for unspecified arguments.

**JMP Version Added:** Before version 14

```

Empty();


```

### [Enable JMP Live URL](#enable-jmp-live-url)

**Syntax:** Enable JMP Live URL(url)

**Description:** Enables a JMP Live URL. This method is available only during jmpStartAdmin.jsl. An asterisk * can be used a wildcard to specify URLs as * (any URL), \*.jmp.com (a URL ending in .jmp.com), http://public.\* (a URL starting with http://public.), or \*public\* (a URL that contains public).

**JMP Version Added:** 15

```


Enable JMP Live URL( "https://public.jmp.com" );


```

### [Enable Proxy Settings](#enable-proxy-settings)

**Syntax:** Enable Proxy Settings( 1|0 )

**Description:** Enables or disables proxy settings during jmpStartAdmin.jsl execution. Proxy settings are enabled by default.

**JMP Version Added:** 15

```


Enable Proxy Settings( 0 );


```

### [Encode URI](#encode-uri)

**Syntax:** Encode URI( value )

**Description:** Encode the string using URI encoding

**JMP Version Added:** 14

```


Encode URI( "Foo Bar" );


```

### [Encode64 Blob](#encode64-blob)

**Syntax:** s = Encode64 Blob( x )

**Description:** Encodes a blob into a printable string of base 64 text.

**JMP Version Added:** 14

```

Encode64 Blob( Char To Blob( "the quick brown fox" ) );


```

### [Encode64 Double](#encode64-double)

**Syntax:** s = Encode64 Double( x )

**Description:** Returns a Base64 string encoding of the floating point number.

**JMP Version Added:** Before version 14

```

Encode64 Double( -1.5831 );


```

### [Faure Quasi Random Sequence](#faure-quasi-random-sequence)

**Syntax:** points = Faure Quasi Random Sequence(nDim, nRow)

**Description:** Generate a sequence of space filling quasi-random numbers using the Faure sequence.

**JMP Version Added:** Before version 14

```

A = Faure Quasi Random Sequence( 3, 100 );
As Table( A );
Scatterplot 3D( Y( :Col1, :Col2, :Col3 ) );


```

### [Format Pattern](#format-pattern)

**Syntax:** s = Format( x, "Format Pattern", pattern, <width>, <dec>) x = In Format( s, "Format Pattern", pattern, < \<<Use Locale(b=1)> ) obj = Format("Format Pattern", pattern, <width>, <dec>)

**Description:** Format Patterns are strings that define a date-time format, such as " \<:>\<:>". The parts of the pattern in angle brackets are called field descriptors. The field descriptors represent a value (such as "", which is a four-digit year) or other date-time text (such as "", which is a locale-specific date separator). A format pattern enables you to build formats that aren't provided in JMP. These formats can be used for both formatting and inputting data.

**JMP Version Added:** 16

```

s = Format( Today(), "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm>" );
x = Informat( "2020/02/10 14:54", "Format Pattern", "<YYYY></><MM></><DD> <hh24><:><mm>" );
Show( s, x );
                                                /*
Field Descriptors

Dates
(cannot be used with Duration field descriptors)
================================================================================
<YYYY>        Four-digit year. (Accepts 1-4 digits on input.)
<YY>          Two-digit year
<yyyy>        Four digit ISO year; corresponds to ISO weeks. (Accepts 1-4 digits
              on input.)
<yy>          Two digit ISO year; corresponds to ISO weeks.
<YYYY.>       Year with fractional year. Completely describes the date and time.
<M>           Month number (1..12)
<MM>          Month number, zero-padded (01..12)
<Month>       Long month name
<Mmm>         Abbreviated month name
<MMM>         "In-line" month name. Always three letters.
<WW1>         Two digit week number, zero-padded. Week 2 begins on first Sunday
              of year. Week 1 is partial week before first Sunday. (01..54)
<WW2>         Two digit week number, zero-padded. Week 1 begins on first Sunday
              of year. Week 0 is partial week before first Sunday. (00..53)
<ww>          Two digit ISO week number, zero-padded. Weeks begin on Monday.
              Week 1 is first week in that year with 4 or more days. There are
              no partial weeks, instead the first or last week can extend into
              the previous or next year, respectively. (01..53)
<D>           Day of the month (1..31)
<DD>          Day of the month, zero-padded (01..31)
<Q>           Quarter of the year (1..4)
<Q#>          "Q" followed by quarter of the year (1..4)
<DayOfWeek>   Name of the day of the week
<DW>          Day of week as a number. 1 = Sunday, 7 = Saturday
<dw>          Day of week as a number. 1 = Monday, 7 = Sunday
</>           The locale date separator. (Accepts most common separators on
              input.)
<->           The ISO date separator '-'. (Accepts most common separators on
              input.)
</?>          Optional date separator on the date input. The separator is never
              written on output.
<'T'>         The 'T' in ISO dates

Times
(some can be used with Duration field descriptors)
================================================================================
<hh>          Hour formatted according to the current locale. If a <ampm>
              descriptor is present, will use a 12 or 24 hour clock depending on
              locale. If a <AMPM> descriptor is present, will use a 12 hour
              clock. Otherwise, will use a 24 hour clock. (Cannot be used with
              duration field descriptors.)
<zhh>         Hour formatted according to the current locale and zero-padded. If
              a <ampm> descriptor is present, will use a 12 or 24 hour clock
              depending on locale. If a <AMPM> descriptor is present, will use a
              12 hour clock. Otherwise, will use a 24 hour clock. (Cannot be
              used with duration field descriptors.)
<hh24>        Hour in 24-hour format and zero-padded (00..23)
<mm>          Minute, zero-padded (00..59)
<ss>          Second, zero-padded (00..59)
<ampm>        AM/PM symbol for the current locale. (Cannot be used with duration
              field descriptors.)
<AMPM>        Locale-independent AM/PM symbol "AM" or "PM". (Cannot be used with
              duration field descriptors.)
<:>           The locale time separator.
<::>          The ISO time separator ':'. (Also accepts locale time separator on
              input.)
<:?>          Optional time separator on the date input. The separator is never
              written on output.

Durations
(cannot be used with Date field descriptors)
================================================================================
<Day>         Day count. Used as most significant field in durations. Cannot be
              used with any other "count".
<Hour>        Hour count. Used as most significant field in durations. Cannot be
              used with any other "count".
<Minute>      Minute count. Used as most significant field in durations. Cannot
              be used with any other "count".

Other
================================================================================
<<>           Replaced with a "<"
*/


```

### [Get Addin](#get-addin)

**Syntax:** Get Addin( ID )

**Description:** Retrieves a registered add-in specified by its ID.

**JMP Version Added:** Before version 14

```

addin = Get Addin( "com.mycompany.myaddin" );


```

### [Get Addins](#get-addins)

**Syntax:** Get Addins( )

**Description:** Returns a list of all registered add-ins.

**JMP Version Added:** Before version 14

```

addins = Get Addins();
addin ids = Get Addins() << id;
Show( addins, addin ids );


```

### [Get Addr Info](#get-addr-info)

**Syntax:** Get Addr Info( string )

**Description:** Looks up the numeric address for a name. In most cases the name should be used for future IPV6 compatibility.

**JMP Version Added:** Before version 14

```

Get Addr Info( "www.jmp.com" )[3][4];


```

### [Get Clipboard](#get-clipboard)

**Syntax:** Get Clipboard()

**Description:** Get the current contents of the clipboard

**JMP Version Added:** Before version 14

```

Get Clipboard();


```

### [Get Name Info](#get-name-info)

**Syntax:** Get Name Info( string )

**Description:** Looks up the name for a numeric address. In most cases the name should be used for future IPV6 compatibility.

**JMP Version Added:** Before version 14

```

Get Name Info( "149.173.5.120" )[3][4];


```

### [Get Notebook List](#get-notebook-list)

**Syntax:** notebookList = Get Notebook List()

**Description:** Returns a list of all open notebooks.

**JMP Version Added:** 19

### [Get OAuth2 Grant Types](#get-oauth2-grant-types)

**Syntax:** Get OAuth2 Grant Types

**Description:** Gets the supported JMP OAuth2 grant types.

**JMP Version Added:** 15

```


/*
https://oauth.net/2/grant-types/
*/
grant_types = Get OAuth2 Grant Types();
Show( grant_types );


```

### [Get OpenID Connect Discovery](#get-openid-connect-discovery)

**JMP Version Added:** 15

```


url = "https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration";
aa = Get OpenID Connect Discovery( url );
Show( aa );


```

### [Get OpenIDC Discovery](#get-openidc-discovery)

**JMP Version Added:** 15

### [Get Platform Preference](#get-platform-preference)

**Syntax:** Get Platform Preferences( < platformName < ( optionName, ... ) > ... > )

**Description:** Gets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Get Platform Preferences( Bivariate( Fit Line ), DOE );


```

### [Get Platform Preferences](#get-platform-preferences)

**Syntax:** Get Platform Preferences( < platformName < ( optionName, ... ) > ... > )

**Description:** Gets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Get Platform Preferences( Bivariate( Fit Line ), DOE );


```

### [Get Policies](#get-policies)

**Syntax:** Get Policies( \<Machine|User|Both> )

**Description:** Returns an associative array containing the current policy names and values.

**JMP Version Added:** 18

```

Get Policies();


```

### [Get Preference](#get-preference)

**Syntax:** Get Preferences( pref1, ... )

**Description:** Gets preferences as specified.

**JMP Version Added:** Before version 14

```

Get Preferences( Graph marker size );


```

### [Get Preferences](#get-preferences)

**Syntax:** Get Preferences( pref1, ... )

**Description:** Gets preferences as specified.

**JMP Version Added:** Before version 14

```

Get Preferences( Graph marker size );


```

### [Glue](#glue)

**Syntax:** y = ( expr1; expr2; ... ); y = Glue( expr1, expr2, ... )

**Description:** Evaluates each argument and returns the last result.

**JMP Version Added:** Before version 14

```

ex1 = 1;
ex2 = 2;


```

### [Gzip Compress](#gzip-compress)

**Syntax:** blob = Gzip Compress( blob )

**Description:** Compresses a blob of data into a gzip blob.

**JMP Version Added:** 14

```

Gzip Compress(
    Char To Blob( "random data does not usually compress well and may get larger" )
);


```

### [Gzip Uncompress](#gzip-uncompress)

**Syntax:** blob = Gzip Uncompress( blob )

**Description:** Uncompresses a blob of gzip data into a blob.

**JMP Version Added:** 14

```

Gzip Uncompress(/*typically this data might come from GzipCompress() but might also come from a .gz file using loadTextFile with the blob option*/
    Char To Blob(
        "~1F~8B~08~00~00~00~00~00~00~0A~0D~CA~C1~0D~00~21~08~04~C0V~B6~B5~CDA~FC~80~5C~00c~EC^~E7=~C9)~E1~106~21~A1~85~19~8DU~8Bf~07_~F8~9FZ~85~ADfx~13~CE~83~A1~0Dc~0E~CD~0B~94*~16~1E=~00~00~00",
        "ascii~hex"
    )
);


```

### [Host is](#host-is)

**Syntax:** y = Host is( "Mac"|"Windows"|"Bits32"|"Bits64"|"x86_64"|"arm64" )

**Description:** Returns 1 if the JMP application matches the argument; returns 0 otherwise. The arguments Windows or Mac test for the specified operating system, and the arguments Bits32 or Bits64 test for the specified 32-bit or 64-bit JMP application. Only one argument can be tested at a time.

**JMP Version Added:** Before version 14

```

If( Host is( "Mac" ),
    Show( "On Mac" ),
    Show( "Not on Mac" )
);
If( Host is( "Bits64" ),
    Show( "64 bit" )
);
If(
    Host is( "x86_64" ), Show( "On x86_64" ),
    Host is( "arm64" ), Show( "On arm64" )
);


```

### [Is Alt Key](#is-alt-key)

**Syntax:** y = Is Alt Key()

**Description:** Returns 1 if the Alt key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts. On the Mac, Alt means Option key.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Control Key(),
            Text( {60, 50}, "Control Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Command Key](#is-command-key)

**Syntax:** y = Is Command Key()

**Description:** Returns 1 if the Command key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Command Key(),
            Text( {60, 50}, "Command Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Context Key](#is-context-key)

**Syntax:** y = Is Context Key()

**Description:** Returns 1 if the Context key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Context Key(),
            Text( {60, 50}, "Context Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Control Key](#is-control-key)

**Syntax:** y = Is Control Key()

**Description:** Returns 1 if the Control key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts. On the Mac, Control means Command key.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Control Key(),
            Text( {60, 50}, "Control Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is JMP Live URL Enabled](#is-jmp-live-url-enabled)

**Syntax:** Is JMP Live URL Enabled(url)

**Description:** Determines if the specified URL can be used in this JMP session. URLs can be enabled and/or disabled using the jmpStartAdmin.jsl script. This does not determine if it is a valid URL, nor if the user is able to login. It only determines if the URL is blocked by JMP.

**JMP Version Added:** 15

```


url = "http://public.jmp.com";
Show( Is JMP Live URL Enabled( url ) );


```

### [Is Option Key](#is-option-key)

**Syntax:** y = Is Option Key()

**Description:** Returns 1 if the Option key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Option Key(),
            Text( {60, 50}, "Option Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [Is Shift Key](#is-shift-key)

**Syntax:** y = Is Shift Key()

**Description:** Returns 1 if the Shift key is being pressed; returns 0 otherwise. Intended to be used in graphics callback scripts.

**JMP Version Added:** Before version 14

```

New Window( "Show me the key",
    Graph Box(
        Rect( 45, 55, 55, 45, 1 );
        If( Is Shift Key(),
            Text( {50, 60}, "Shift Key" )
        );
        If( Is Control Key(),
            Text( {60, 50}, "Control Key" )
        );
        If( Is Alt Key(),
            Text( {50, 35}, "Alt Key" )
        );
        Mousetrap( {} );
    )
);


```

### [JMP Product Name](#jmp-product-name)

**Syntax:** y = JMP Product Name()

**Description:** Returns "Standard" or "Pro" based on the version of the product that has been licensed.

**JMP Version Added:** Before version 14

```

JMP Product Name();


```

### [JMP Version](#jmp-version)

**Syntax:** y = JMP Version()

**Description:** Returns the JMP version (release.revision{.fix}); not available before 6.0.

**JMP Version Added:** Before version 14

```

JMP Version();


```

### [JSL Encrypted](#jsl-encrypted)

**Syntax:** y = JSL Encrypted(script)

**Description:** Embeds an encrypted script within another script. Create an encrypted script by selecting Edit > Encrypt Script from the main menu of a script editor. Enter your passwords and the encrypted text will appear in a new window. Copy this text into a JSL Encrypted("") command to embed the encrypted script in another script.

**JMP Version Added:** Before version 14

```

JSL Encrypted(
    "//-e6.0.2\!NWUSXEHSB?SRAMXPSY?;KDGMNGPQFZP;?><JLEXCQZYIGWSI@<FOPBLDKJ?HEUPTOGSZDYWFDMB;NEVB;HFP=VQ@N;LCVQPWRHIXEIPFKGO=H?DWS?KFQRIPBEPSAE<AM?YG=C@VFRENPEW>@;ND=JA<?=WOZZOG>FZBZKZLMFOX?YF@LWA=B=SJXDGVW>VYLBRJT<I<MFE<Q??QCUOZM?RY>RXLBJRH=BH<EGVSEMABSS<IE=CAPID;XM;;?XIU<FA=SCE<CB;AGOCZWHZXK;*"
);


```

### [JSL Quote](#jsl-quote)

**Syntax:** y = JSL Quote(script)

**Description:** Store a JSL script in a variable, including all comments and formatting.

**JMP Version Added:** Before version 14

```


x = JSL Quote(/* Begin quote. */
    For (i = 1, i <= 5, i++,
        // Print the value of i.
        Print(i);
    );
    // End expression.
);
New Window( "editor", Script Box( x ) );


```

### [Load DLL](#load-dll)

**Syntax:** dll = Load DLL( file path | Base Name( file path without extension ), < AutoDeclare( bool | Quiet | Verbose) | Quiet | Verbose )> )

**Description:** Loads a DLL pointed to by the specified path.

**JMP Version Added:** Before version 14

#### [Cross platform using Base Name()](#cross-platform-using-base-name)

```

dll = Load DLL( Base Name( "/path/to/dll/financial" ) );
// Loads "financial.dll" on Windows and "libfinancial.dylib" on Mac
// Declarations for "irr" and "npv" are auto-loaded
myirr = dll << irr( 0.1, -51000, 1000, 900, 950 );
mynpv = dll << npv( 0.05, -51000, 1000, 900, 9500 );
dll << UnloadDLL();


```

#### [Windows only](#windows-only)

```

If( Host is( "Windows" ),
    dll = Load DLL( "C:/Windows/System32/User32.DLL" );
    dll << CallDLL( "MessageBeep", "n", 0 );
    Wait( 1 );
    dll << CallDLL( "MessageBeep", "n", 0 );
    dll << UnloadDLL();
);


```

### [Mail](#mail)

**Syntax:** Mail( "address", "subject", "message", \<"attachment filepath"> | { "attachment filepath", ...} )

**Description:** Creates an outgoing e-mail message as specified if the operating system allows doing so. Not all options will work on all operating system versions. See Help for details.

**JMP Version Added:** Before version 14

```

Mail( "test@example.com", "revelation", "JMP is great.", "$SAMPLE_DATA/Big Class.jmp" );


```

### [Main Menu](#main-menu)

**Syntax:** menu = Main Menu( command, <window name> )

**Description:** Executes the specified main menu command.

**JMP Version Added:** Before version 14

**Example 1**

```

Main Menu( "Sample Index" );


```

**Example 2**

```

Main Menu( "Help:Sample Index" );


```

### [Minus](#minus)

**Syntax:** y = -x; y = Minus( x )

**Description:** Negates x, which can be a number, matrix, or list of numbers.

**JMP Version Added:** Before version 14

```

-Pi();


```

### [Multiple File Import](#multiple-file-import)

**Syntax:** mfiObj = Multiple File Import();

**Description:** Creates a Multiple File Import object; the object accepts messages to set a folder, filter files, and import. To bring up a dialog use the "Create Window" message. To immediately import use the "Import Data" message which will return a list of the tables that were created.

**JMP Version Added:** 14

#### [Interactive example](#interactive-example)

```

// use the save-script-to-script-window button 
// in the MFI dialog to see more messages
// for filtering files and controlling the import
Multiple File Import(
    <<Set Folder( "$DESKTOP" ),
    <<Set Name Filter( "*.csv;" ),
    <<Set Name Enable( 1 )
) << Create Window;


```

#### [Scripting example](#scripting-example)

```


mfi = Multiple File Import();
mfi << Set Folder( "$SAMPLE_IMPORT_DATA" );
mfi << Set Name Filter( "*.txt" );
mfi << Set Name Enable( 1 );
tables = mfi << Import Data();


```

### [Multiply](#multiply)

**Syntax:** y = x0 * x1; y = Multiply( x0, x1, ... )

**Description:** Multiplies all arguments, which can be numbers, matrices, or lists of numbers.

**JMP Version Added:** Before version 14

```

2 * Pi();


```

### [Name](#name)

**Syntax:** Name(string)

**Description:** A name is simply something to call an item. Names are used for both variables and functions, and can be used directly in scripts as long as certain rules are followed. If the name begins with an alphabetic character or underscore, and continues with alphanumeric characters, whitespace, Unicode mathematical symbols and certain punctuation (apostrophes (’), percent signs (%), periods (.), backslashes (), and underscores (\_)), then the name can be used directly in scripts. Names that do not follow these rules can be used by using the Name() keyword.

**JMP Version Added:** 14

```

Name( "taxable income(2011)" ) = 456000;
tax = .25;
Print( tax * Name( "taxable income(2011)" ) );


```

### [New HTTP Request](#new-http-request)

**Syntax:** obj = New HTTP Request(URL(...), Method(...), \<Form(\<Fields(...)>, \<Files(...)>)> | \<File(...)> | \<Blob(...)> | \<JSON(...)>, \<QueryString(...)>, \<Headers(...)>, \<Username(...)>, \<Password(...)>)

**Description:** Creates a request to send to a web service.

**JMP Version Added:** 14

```


getSentiment = Function( {text},
    {Default Local},
    fields = Associative Array();
    fields["text"] = text;
    s = New HTTP Request(
        URL( "http://text-processing.com/api/sentiment/" ),
        Method( "POST" ),
        Form( Fields( fields ) ),
        Headers( {"Accept: application/json"} )
    ) << Send;
    sAsList = Parse JSON( s );
    retval = Associative Array();
    retval["pos"] = sAsList["probability"]["pos"];
    retval["neg"] = sAsList["probability"]["neg"];
    retval["neutral"] = sAsList["probability"]["neutral"];
    retval["label"] = sAsList["label"];
    retval;
);

addSentimentColumns = Function( {dt, colname, bLabel, bValues},
    {Default Local},
    col = Column( dt, colname );
    colLabel = "Sentiment_Label(" || colname || ")";
    colValPos = "Sentiment_Pos(" || colname || ")";
    colValNeg = "Sentiment_Neg(" || colname || ")";
    colValNeutral = "Sentiment_Neutral(" || colname || ")";
    If( bLabel,
        dt << New Column( colLabel, Character )
    );
    If( bValues,
        dt << New Column( colValPos, Numeric );
        dt << New Column( colValNeg, Numeric );
        dt << New Column( colValNeutral, Numeric );
    );
    For( i = 1, i <= N Rows( dt ), i++,
        sentiment = getSentiment( col[i] );
        If( bLabel,
            Column( dt, colLabel )[i] = sentiment["label"]
        );
        If( bValues,
            Column( dt, colValPos )[i] = sentiment["pos"];
            Column( dt, colValNeg )[i] = sentiment["neg"];
            Column( dt, colValNeutral )[i] = sentiment["neutral"];
        );
    );
);

dt2 = Open( "$SAMPLE_DATA\Cereal.jmp" );
addSentimentColumns( dt2, "Name", 1, 1 );


```

### [New Multi HTTP Request](#new-multi-http-request)

**Syntax:** multi_request = New Multi HTTP Request()

**Description:** Sends or downloads multiple HTTP requests in parallel.

**JMP Version Added:** 17

```


requests = New Multi HTTP Request();
requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://cdimage.ubuntu.com/lubuntu/releases/20.04.3/release/lubuntu-20.04.3-desktop-amd64.iso"
        )
    )
);

requests << Add(
    New HTTP Request(
        Method( "GET" ),
        URL(
            "http://downloads.sourceforge.net/clonezilla/clonezilla-live-2.7.3-19-amd64.iso"
        )
    )
);

data = requests << Download( "show progress", "detailed" );
http_requests = requests << Get Requests();
For( i = 1, i <= N Items( http_requests ), i++,
    Show( http_requests[i] << Get Mime Type() )
);


```

### [New OAuth2](#new-oauth2)

**Syntax:** oauth2 = New OAuth2()

**Description:** Creates a new OAuth2 authorization.

**JMP Version Added:** 15

```


/*
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-auth-code-flow
*/

/*
Note: the "code" parameter is set automatically after the redirect occurs
*/
auth_url = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize";
token_url = "https://login.microsoftonline.com/common/oauth2/v2.0/token";
redirect_url = "http://localhost/myapp/";
client_id = "6731de76-14a6-49ae-97bc-6eba6914391e";
client_secret = "JqQX2PNo9bpM0uEihUPzyrh";
scope = "openid offline_access https://graph.microsoft.com/user.read";
auth_fields = [=> ];
token_fields = [=> ];

oauth2 = New OAuth2();
oauth2 << Grant Type( "Authorization Code" );
oauth2 << Auth URL( auth_url );
oauth2 << Token URL( token_url );
oauth2 << Redirect URL( redirect_url );

auth_fields["scope"] = scope;
auth_fields["client_id"] = client_id;
token_fields["client_secret"] = client_secret;

oauth2 << Auth Fields( auth_fields );
oauth2 << Token Fields( token_fields );

auth_header = oauth2 << Get Auth Header();
request = New HTTP Request(
    URL( "https://graph.microsoft.com/v1.0/me" ),
    Headers( {auth_header} ),
    Method( "GET" )
);
data = request << Send;


```

### [New OAuth2 Token](#new-oauth2-token)

**Syntax:** token = New OAuth2 Token( Account("jmpgoogldev@gmail.com"), Client ID("test"), Client Secret("test 2"), Refresh Token(""), Token URL(""))

**Description:** Creates an OAuth2 Token for securely accessing data across many different web APIs.

**JMP Version Added:** 15

```

token = New OAuth2 Token(
    Account( "jmpgoogldev@gmail.com" ),
    Client ID( "test" ),
    Client Secret( "test 2" ),
    Refresh Token( "" ),
    Token URL( "" )
);


```

### [New Web Report](#new-web-report)

**Syntax:** obj = New Web Report(...)

**Description:** Creates an interactive HTML report.

**JMP Version Added:** 14

```


Open( "$SAMPLE_DATA/Big Class.jmp", Invisible );
webreport = New Web Report(
    Add Report(
        Distribution(
            Continuous Distribution( Column( :weight ) ),
            Nominal Distribution( Column( :age ) )
        ),
        Title( "Distribution Web Report" ),
        Description( "This report was created with the sample found in the Scripting Index" )
    ),
    Add Report(
        Bivariate(
            Y( :weight ),
            X( :height ),
            Automatic Recalc( 1 ),
            Fit Line( {Line Color( {213, 72, 87} )} ),
            Local Data Filter( Add Filter( columns( :sex ) ) )
        )
    )
);
webreport << Index( Title( "Big Class Report" ) );
file = webreport << Save( "$TEMP" );
If( !Is Empty( file ),
    Web( file )
);


```

### [Notebook](#notebook)

**Syntax:** nb = Notebook( name|number )

**Description:** Returns a reference to the specified notebook.

**JMP Version Added:** 19

### [Open Datafeed](#open-datafeed)

**Syntax:** y = Open Datafeed( ... )

**Description:** Creates an object and window you can send messages to manage real-time data feeds.

**JMP Version Added:** Before version 14

```

exfeed = Open Datafeed(/*Connect( Port( "com3" ), Baud( 4800 ), DataBits( 8 ) ),*/
    Set Script(
        ex = exfeed << getLine;
        Show( ex );
    )
);
For( exi = 0, exi < 5, exi++, /* this is just a way to test a feed when the real data source is not available...*/
    exfeed << Queue Line( Char( exi ) );
    Wait( .5 );
);


```

### [Open Help](#open-help)

**Syntax:** w = Open Help( "Help" | "Scripting Index", ... )

**Description:** Opens the online JMP help or the Scripting Index.

**JMP Version Added:** Before version 14

**Example 1**

```

Open Help( "Help" );


```

**Example 2**

```

Open Help(
    "Scripting Index",
    Search( Term( "Open" ), Match( {"Contains Terms", "Match All Terms", "Ignore Case"} ) ),
    IndexContext( Category( "Functions" ) )
);


```

**Example 3**

```

Open Help(
    "Scripting Index",
    Search( Term( "alpha" ), Match( {"Contains Terms", "Match All Terms", "Ignore Case"} ) ),
    IndexContext(
        Category( "All Categories" ),
        Object( "Search results" ),
        Method( "Get Alpha" )
    )
);


```

### [Parse XML](#parse-xml)

**Syntax:** Parse XML( string, OnElement( tagname, StartTag( expr ), EndTag( expr ) ), ... )

**Description:** Parses an XML expression using the OnElement expressions for specified XML tags.

**JMP Version Added:** Before version 14

**Example 1**

```

/*See example two for more details*/
ex =
"<table name='fromxml'><col name='x'>[1 2 3]</col><col name='y'>[11 22 33]</col></table>";
Parse XML( ex,
    On Element( "table", Start Tag( New Table( XML Attr( "name" ) ) ) ),
    On Element(
        "col",
        End Tag( New Column( XML Attr( "name" ), Set Values( Parse( XML Text() ) ) ) )
    )
);


```

**Example 2**

```


doc =
"
<a title='one'>
    WWWa
    <b>BB<c>ZZZ</c>B1</b>
    XXXa
    <b>BBB2</b>
    YYYa
    <c>CCC</c>
</a>";
// doc, above, has tags a, b, and c. The c tags are not handled by the parser, below,
// to show why text should be collected by Text(...) and then processed by EndTag(...)
// Text(...) captures the BB ZZZ B1 while using EndTag(...) only captures the final snippet.
docname = "undefined";
doctext = "";
recordtext = "";
records = {};
NestLevel = 0; // not really used here, but shows how to use Start/End Tag to track nesting level
Parse XML( doc,
    On Element(
        "a",
        Start Tag(
            docname = XML Attr( "title" );
            NestLevel++;
        ), 
        // decide here to trim the CRLF and blanks and use a single blank
        Text( doctext = doctext || Trim( XML Text() ) || " " ),
        End Tag( NestLevel-- )
    ),
    On Element(
        "b",
        Start Tag( NestLevel++ ), 
        // comment out the next line and...
        Text( recordtext = recordtext || Trim( XML Text() ) || " " ),
        End Tag(
            // ...uncomment the next line and observe the "B1" vs "BB ZZZ B1 " value in records
            // recordtext = XMLText();
            Insert Into( records, recordtext );
            recordtext = "";
            NestLevel--;
        )
    )
);

Show( docname, doctext, records, NestLevel );


```

### [Pdf Page Count](#pdf-page-count)

**Syntax:** Pdf Page Count( file name)

**Description:** Returns the number of pages in a PDF file.

**JMP Version Added:** Before version 14

```

pageCount = Pdf Page Count( "$documents\myfile.pdf" );


```

### [Platform Preference](#platform-preference)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Platform Preferences](#platform-preferences)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Pref](#pref)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Preference](#preference)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Preferences](#preferences)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Prefs](#prefs)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Register Addin](#register-addin)

**Syntax:** Register Addin( uniqueId, homeFolder, \<displayName(name)>, \<MinJMPVersion(version)>, \<MaxJMPVersion(version)>, \<AutoLoad(0|1)> )

**Description:** Register an add-in. An Autoload value of 1 forces the add-in to load when registered. A value of 0 leaves the add-in unloaded. If AutoLoad is not specified the addin.def setting will be used if found otherwise the default will be for the add-in to be loaded.

**JMP Version Added:** Before version 14

```

Register Addin(
    "com.mycompany.myaddin",
    "$DOCUMENTS/myaddin",
    displayname( "Sample Addin" )
);


```

### [Revert Menu](#revert-menu)

**Syntax:** Revert Menu()

**Description:** Reverts to factory default menus.

**JMP Version Added:** Before version 14

```

/* Reverts menus back to factory default settings. */


```

### [Run Program](#run-program)

**Syntax:** obj = Run Program( Executable( "path/etc.exe" ), < Options( {"/a", "/b etc" } ) >, < Parameter( optParm ) >, < Read Function( Function( {this, optParm}, etc ) | "text" | "blob" ) >, < Write Function( Function( {this, optParm}, etc ) ) > )

**Description:** Control an external program using stdin and stdout.

**JMP Version Added:** Before version 14

**Example 1**

```

RP = Run Program(
    Executable( "PING.EXE"/*path probably not needed*/ ),
    Options( {"-n 5", "localhost"} ),
    ReadFunction( Function( {this}, Write( this << read ) ) )
);


```

**Example 2**

```

RP = Run Program(
    Executable( "CMD.EXE"/*path probably not needed*/ ),
    Options( {"/a", "/q", "/c dir"} ),
    ReadFunction( Function( {this}, Write( this << read ) ) )
);


```

**Example 3**

```

commands = {"echo this is a test\!n", "ping -n 1 localhost\!n", "exit\!n"};
icommand = 0;
RP = Run Program(
    Executable( "CMD.EXE" ),
    Options( {"/a", "/q"} ),
    ReadFunction( Function( {this}, Write( this << Read ) ) ),
    WriteFunction(
        Function( {this},
            icommand++;
            If( icommand <= N Items( commands ),
                this << Write( commands[icommand] );
                Show( commands[icommand] );
            ,
                this << WriteEOF;
                Show( this << CanRead, this << CanWrite, this << isReadEOF );
            );
        )
    )
);


```

### [Schedule](#schedule)

**Syntax:** Schedule( sec, scpt )

**Description:** Schedules an event that runs the scpt script argument after sec seconds have elapsed.

**JMP Version Added:** Before version 14

```

Schedule(
    10,
    Beep();
    Print( "Time's up!" );
);


```

### [Set Clipboard](#set-clipboard)

**Syntax:** Set Clipboard( text )

**Description:** Puts the specified text onto the system clipboard used by the Edit menu.

**JMP Version Added:** Before version 14

```

Set Clipboard( "example" );


```

### [Set Platform Preference](#set-platform-preference)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Set Platform Preferences](#set-platform-preferences)

**Syntax:** Platform Preferences( platformName( optionName( value ), ... ) ... )

**Description:** Sets platform preferences as specified.

**JMP Version Added:** Before version 14

```

Platform Preferences( Bivariate( Fit Line( 1 ) ) );


```

### [Set Preference](#set-preference)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Set Preferences](#set-preferences)

**Syntax:** Preferences( pref1( value1 ), ... )

**Description:** Sets preferences as specified.

**JMP Version Added:** Before version 14

```

Preferences( Graph marker size( "Large" ) );


```

### [Set Toolbar Visibility](#set-toolbar-visibility)

**Syntax:** rc = Set Toolbar Visibility( "toolbar-name" | Default | All, \<window-class-name | All>, \<True | False> )

**Description:** Sets the visibility of a given toolbar for a given class of windows. toolbar-name is the internal name of the toolbar. If Default is passed in as the toolbar name, the specified window class is restored to the default toolbar set for that class of windows. Examples of window-class-name are Data Table, Script, Report, and Journal. If window-class-name is All, then visibility for the specified toolbar is set for all classes of windows.

Returns 1 if successful, 0 if unsuccessful.

**JMP Version Added:** Before version 14

```


// Make the Analyze toolbar visible in Script windows
Set Toolbar Visibility( "Analyze", Script, true );

// Make the Analyze toolbar visible in all classes of windows
Set Toolbar Visibility( "Analyze", All, true );

// Revert Script windows to the default toolbar set for Script windows
Set Toolbar Visibility( Default, Script );

// Revert all windows to their default toolbar set
Set Toolbar Visibility( Default, All );


```

### [Shortest Edit Script](#shortest-edit-script)

**Syntax:** list = Shortest Edit Script(A,B); matrix = Shortest Edit Script( strings( A, B, matrix(1), limit(9999) ) ); list = Shortest Edit Script( lines( A, B, separators("defaults to newline"), ignore("defaults to none")|ignoreWhiteSpace(), matrix(0), limit(9999) ) ); matrix = Shortest Edit Script( sequences(nA, nB, Function({iA,iB}, adata[iA] == bdata[ib] ) ) )

**Description:** Returns one of the shortest edit scripts to convert string A into string B. The simple form only returns a list. strings() and lines() have an option to return a matrix or a list. sequences() only returns a matrix. The optional limit() will stop the function early if the edit list has more than limit inserts and deletes. lines() compares lines rather than characters; the optional ignore("characters") or ignoreWhiteSpace() defaults to no ignored characters. ESC will stop the function if needed.

**JMP Version Added:** Before version 14

```

editList = Shortest Edit Script( "time flies like an arrow", "fruit flies like a banana" );
common = "";/* assemble a longest common subsequence */For( i = 1, i <= N Items( editList ),
    i++,
    If( editList[i][1] == "Common", /* or Insert or Remove */common = common || editList[i][2
        ] /* the snippet */
    )
);
common;


```

### [Show Addin Builder Dialog](#show-addin-builder-dialog)

**Syntax:** Show Addin Builder Dialog()

**Description:** Brings up a dialog that can be used to make custom add-ins.

**JMP Version Added:** Before version 14

```

Show Addin Builder Dialog();


```

### [Show Addins Dialog](#show-addins-dialog)

**Syntax:** Show Addins Dialog()

**Description:** Brings up a dialog that shows the status of all registered add-ins.

**JMP Version Added:** Before version 14

```

Show Addins Dialog();


```

### [Show Commands](#show-commands)

**Syntax:** Show Commands( \<keyword=Builtins> )

**Description:** Creates one or more data tables that contain information about various JSL components. The keyword argument determines the content of the output table. Specify Builtins (the default) for built-in operators and functions. Specify Scriptables for all the scriptable commands for objects. Specify Translations for English and localized versions of the scriptable commands. Specify Display Boxes for scriptable commands related to display boxes and display segs. Specify Scriptable Names for the names of scriptable objects. Specify Platform Names for names of platforms.

**JMP Version Added:** Before version 14

```

Show Commands();


```

### [Show Preferences](#show-preferences)

**Syntax:** Show Preferences()

**Description:** Shows the current preference settings in the log.

**JMP Version Added:** Before version 14

```

Show Preferences();


```

### [Show Properties](#show-properties)

**Syntax:** Show Properties( object )

**Description:** Shows in the log the messages that an object responds to.

**JMP Version Added:** Before version 14

```

Show Properties( Current Data Table() );


```

### [Sobol Quasi Random Sequence](#sobol-quasi-random-sequence)

**Syntax:** points = Sobol Quasi Random Sequence(nDim, nRow)

**Description:** Generate a sequence of space filling quasi-random numbers using the Sobol sequence in up to 4000 dimensions.

**JMP Version Added:** Before version 14

```

A = Sobol Quasi Random Sequence( 3, 100 );
As Table( A );
Scatterplot 3D( Y( :Col1, :Col2, :Col3 ) );


```

### [Socket](#socket)

**Syntax:** socketHandle = Socket( \<STREAM | DGRAM> )

**Description:** Creates a socket variable that can communicate with sockets on this or another networked computer. The default argument is STREAM. Try your own company's website.

**JMP Version Added:** Before version 14

```


// see the socket's OBJECT messages in the scripting index for better examples
tCall = Socket();
tcall << Ioctl( FIONBIO, 1 );
rc = tCall << connect( "www.jmp.com", "80" );
If( rc[2] == "ok",
    tCall << <<Char To Blob(
        "GET /en_us/home.html HTTP/1.1~0d~0aHost: www.jmp.com~0d~0aConnection: Close~0d~0a~0d~0a",
        "ASCII~HEX"
    );
    While( 1,
        tMessage = tCall << Recv( 100000 );
        If(
            tMessage[2] == "ok",
                Show( Length( tMessage[3] ) ); //typically about six chunks of around 5-20K bytes
        ,
            Starts With( tMessage[2], "WOULDBLOCK" ),
                Show( "waiting" ) // sometimes data might not be available yet
        ,
            Starts With( tMessage[2], "CLOSED" ),
                Break(); // this is the desired result
        , // else
            Show( tMessage );
            Stop();
        );
    );
    tCall << Close();// done
, // else
    Show( rc );
    Stop();
);


```

### [Speak](#speak)

**Syntax:** Speak( text, \<Wait( sync )> )

**Description:** Speaks the text if supported by the operating system. Specifying the optional Wait(true) argument delays script execution until speech has finished.

**JMP Version Added:** Before version 14

```

Speak( "Hello" );


```

### [Status Msg](#status-msg)

**Syntax:** Status Msg( message )

**Description:** Displays the specified message in the status bar.

**JMP Version Added:** Before version 14

```

Status Msg( "calculating..." );


```

### [Subtract](#subtract)

**Syntax:** y = x0 - x1; y = Subtract( x0, x1, ... )

**Description:** Subtracts all subsequent arguments from the first argument. Arguments can be numbers, matrices, or lists of numbers.

**JMP Version Added:** Before version 14

```

6 - 2 - 1;


```

### [Unregister Addin](#unregister-addin)

**Syntax:** Unregister Addin( uniqueId)

**Description:** Unregister an add-in

**JMP Version Added:** Before version 14

```

Unregister Addin( "com.mycompany.myaddin" );


```

### [Web](#web)

**Syntax:** Web( string, <JMP Window> )

**Description:** Opens the URL or file stored in string in the default web browser. The optional second argument specifies that the HTML open in a JMP browser window.

**JMP Version Added:** Before version 14

#### [Event Handler](#event-handler)

```

//Making a clickable link show up in a formula column
New Table( "Example",
    Add Rows( 2 ),
    New Column( "URL",
        "Character",
        "Nominal",
        Formula( "https://www.jmp.com/" || :Page ),
        Set Property(
            "Event Handler",
            Event Handler(
                Click( JSL Quote( Function( {dt, col, row}, Web( dt:col[row] ) ) ) )
            )
        )
    ),
    New Column( "Page",
        "Character",
        "Nominal",
        Set Values( {"support/knowledge_base.shtml", "en_us/about.html"} )
    )
);


```

#### [Simple](#simple_1)

```

Web( "http://www.jmp.com/" );


```

### [XML Attr](#xml-attr)

**Syntax:** value = XML Attr( attr name ); aa = XML Attr()

**Description:** Extracts the string value of an XML attribute in the context of being evaluating in a Parse XML() command. If no name if given, an associative array of all attribute name/value pairs is returned.

**JMP Version Added:** Before version 14

```

ex =
"<table name='fromxml'><col name='x'>[1 2 3]</col><col name='y'>[11 22 33]</col></table>";
Parse XML( ex,
    On Element( "table", Start Tag( New Table( XML Attr( "name" ) ) ) ),
    On Element(
        "col",
        End Tag( New Column( XML Attr( "name" ), Set Values( Parse( XML Text() ) ) ) )
    )
);


```

### [XML Decode](#xml-decode)

**Syntax:** text = XML Decode( textxml )

**Description:** Decodes symbols in XML to ordinary text, changes " to ", < to \<, &gt to >; & to &.

**JMP Version Added:** Before version 14

```

text = XML Decode( "isSmallAlpha = letter&gt;=&quot;a&quot; &amp; letter&lt;=&quot;z&quot;" );


```

### [XML Encode](#xml-encode)

**Syntax:** textxml = XML Encode( text )

**Description:** Prepares text for embedding in XML, changes " to ", < to \<, > to > & to &.

**JMP Version Added:** Before version 14

```

textxml = XML Encode( "\[isSmallAlpha = letter>="a" & letter<="z"]\" );


```

### [XML Text](#xml-text)

**Syntax:** value = XML Text()

**Description:** Extracts the string text of the body of an XML tag in the context of being evaluating in a Parse XML() command.

**JMP Version Added:** Before version 14

```

ex =
"<table name='fromxml'><col name='x'>[1 2 3]</col><col name='y'>[11 22 33]</col></table>";
Parse XML( ex,
    On Element( "table", Start Tag( New Table( XML Attr( "name" ) ) ) ),
    On Element(
        "col",
        End Tag( New Column( XML Attr( "name" ), Set Values( Parse( XML Text() ) ) ) )
    )
);


```

### \[[...]\](#\_1)

**Syntax:** y = [string]\\

**Description:** Passages requiring many escape characters can use the delimiter [...].

**JMP Version Added:** Before version 14

```


jslPhrase =
"The JSL to do this is :\[
a = "hello";
b = a|| " world.";
show(b);
]\ and you use the Submit command to run it.";
Show( jslPhrase );


```
# JSL Display Boxes Usage Documentation

# [AlignmentGridBox](#alignmentgridbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [AxisBox](#axisbox)

## [Item Messages](#item-messages)

### [Add Axis Label](#add-axis-label)

**Syntax:** obj \<< Add Axis Label( label )

**Description:** Adds an axis label with the string given.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << RemoveAxisLabel();
axisbox << AddAxisLabel( "pounds" );


```

### [Add Ref Line](#add-ref-line)

**Syntax:** obj \<< Add Ref Line( value, \<"Solid|Dashed|Double">, <Color>, \<"label">, <line width>, <transparency> )

**Description:** Adds a reference line to the grid at value.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Add Ref Line( 108.3182, "Dashed", blue, "M mean", 2 );
axisbox << Add Ref Line( 100.9444, "Dotted", red, "F mean", 2 );


```

### [Axis Settings](#axis-settings)

**Syntax:** obj \<< Axis Settings

**Description:** Provides a way to bring up the axis dialog or set configurable axis options for a given axis.

**Example 1**

```

//Open the axis setting dialog:
Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Axis Settings();


```

**Example 2**

```

//Configure settings for horizontal and vertical axes:
Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
vaxisbox = rbiv[axis box( 1 )];
haxisbox = rbiv[axis box( 2 )];
vaxisbox << Axis Settings( Decimal( 10, 3 ), Show Major Grid( 1 ) );
haxisbox << Axis Settings( Min( 10 ), Max( 100 ) );


```

### [Copy Axis Settings](#copy-axis-settings)

**Syntax:** obj \<< Copy Axis Settings

**Description:** Make a script containing the current axis settings and place it on the clipboard.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv1 = Bivariate( Y( :weight ), X( :height ), FitLine );
biv2 = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv1 = biv1 << report;
axisbox1 = rbiv1[axis box( 1 )];
axisbox1 << Scale( "Log" );
axissettings = axisbox1 << Copy Axis Settings;
rbiv2 = biv2 << report;
axisbox2 = rbiv2[axis box( 1 )];
axisbox2 << Paste Axis Settings;


```

### [Custom Scale Name](#custom-scale-name)

**Syntax:** obj \<< Custom Scale Name

**Description:** Name of the scale.

```

Open( "$sample_data/big class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 2 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
gbr = Report( gb );
gbr[axisbox( 1 )] << scale( custom scale, custom scale name( "log2" ) ) << Min( 32 ) <<
Max( 100 );


```

### [Decimal](#decimal)

**Syntax:** obj \<< Decimal( number )

**Description:** Sets the number of digits after the decimal point of the numeric labels.

```

Open( "$SAMPLE_DATA/SATByYear.jmp" );
biv = Bivariate( Y( :Population ), X( :"Salary (1997)"n ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisbox << decimal( 1 );


```

### [Edit Value Order](#edit-value-order)

**Syntax:** obj \<< Edit Value Order

**Description:** Open the Value Order column property for editing.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
o = Oneway( Y( :weight ), X( :sex ) );
ro = o << report;
axisbox = ro[axis box( 2 )];
axisbox << Edit Value Order();


```

### [Edit Value Order Mode](#edit-value-order-mode)

**Syntax:** obj \<< Edit Value Order Mode

**JMP Version Added:** 16

### [Format](#format)

**Syntax:** obj \<< Format( "Best"|"Fixed Dec"|"Percent"|"PValue"|"Scientific"|"Engineering"|"Engineering SI"|"Precision"|"Currency"|"m#d#y"|"mmddyyyy"|"m#y"|"yyyyQq"|"d#m#y"|"ddmmyyyy"|"ddMonyyyy"|"Monddyyyy"|"y#m#d"|"yyyymmdd"|"yyyy-mm-dd"|"m#d#y h:m"|"m#d#y h:m:s"|"d#m#y h:m"|"d#m#y h:m:s"|"y#m#d h:m"|"y#m#d h:m:s"|"ddMonyyyy h:m"|"ddMonyyyy h:m:s"|"ddMonyyyy:h:m"|"ddMonyyyy:h:m:s"|"Monddyyyy h:m"|"Monddyyyy h:m:s"|"yyyy-mm-ddThh:mm"|"yyyy-mm-ddThh:mm:ss"|":day:hr:m"|":day:hr:m:s"|"hr:m"|"hr:m:s"|"min:s"|"h:m:s"|"h:m"|"Date Long"|"Date Abbrev"|"Locale Date"|"Locale Date Time h:m"|"Locale Date Time h:m:s" )

**Description:** Sets the format of the labels.

```

Open( "$SAMPLE_DATA/Financial.jmp" );
biv = Bivariate( Y( :"Profit($M)"n ), X( :"Sales($M)"n ), FitLine );
rbiv = biv << report;
profitaxis = rbiv[axis box( 1 )];
profitaxis << Format( currency );
salesaxis = rbiv[axis box( 2 )];
salesaxis << Format( currency );


```

### [Get Format](#get-format)

**Syntax:** obj \<< Get Format

**Description:** Returns the format specification for axis values.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Financial.jmp" );
biv = Bivariate( Y( :"Profit($M)"n ), X( :"Sales($M)"n ), FitLine );
rbiv = biv << report;
profitaxis = rbiv[axis box( 1 )];
profitaxis << Format( currency );
salesaxis = rbiv[axis box( 2 )];
salesaxis << Format( currency );
salesaxis << get format;


```

### [Get Inc](#get-inc)

**Syntax:** obj \<< Get Inc( number )

**Description:** Gets the increment value of the axis

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Get Inc;


```

### [Get Max](#get-max)

**Syntax:** obj \<< Get Max( number )

**Description:** Gets the maximum value of the axis

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Get Max;


```

### [Get Min](#get-min)

**Syntax:** obj \<< Get Min( number )

**Description:** Gets the minimum values of the axis

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Get Min;


```

### [Get Minor Ticks](#get-minor-ticks)

**Syntax:** obj \<< Get Minor Ticks( number )

**Description:** Gets the number of minor ticks.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
n = axisbox << Get Minor Ticks;


```

### [Get Script](#get-script)

**Syntax:** obj \<< Get Script

**Description:** Returns the script for recreating the axis box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
Print( axisbox << Get Script() );


```

### [Inc](#inc)

**Syntax:** obj \<< Inc( number )

**Description:** Sets the increment value of the axis.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Inc( 5 );


```

### [Inside Ticks](#inside-ticks)

**Syntax:** obj \<< Inside Ticks( state=0|1 )

**Description:** Shows axis tick marks inside the graph frame

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisbox << Inside Ticks( 1 );


```

### [Interval](#interval)

**Syntax:** obj \<< Interval( "Numeric"|"Year"|"Quarter"|"Month"|"Week"|"Day"|"Hour"|"Minute"|"Second" )

**Description:** Sets the format of the numeric labels.

```

Open( "$SAMPLE_DATA/TechStock.jmp" );
plot = Overlay Plot(
    X( :Date ),
    Y( :High, :Low, :Close, :Volume ),
    Y Scale( Left, Left, Left, Right ),
    Left Axis << {{Format( "Best", 9 ), Min( 0 ), Max( 60 ), Inc( 10 ), Minor Ticks( 0 )}},
    Right Axis << {{Format( "Best", 9 ), Min( 0 ), Max( 800000000 ), Inc( 100000000 ),
    Minor Ticks( 0 )}},

);
rplot = plot << Report();
axisbox = rplot[axis box( 3 )];
axisbox << Format( "y/m/d" );
axisbox << Interval( Week );


```

### [Label Row](#label-row)

**Syntax:** obj \<< Label Row

### [Label Row Nesting](#label-row-nesting)

**Syntax:** obj \<< Label Row Nesting( number )

**Description:** Sets the number of label rows for date format axes

```

Open( "$SAMPLE_DATA/TechStock.jmp" );
biv = Bivariate( Y( :Open ), X( :Date ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisbox << Label Row Nesting( 3 );


```

### [Major Grid Line Color](#major-grid-line-color)

**Syntax:** obj \<< Major Grid Line Color( color )

**Description:** Sets the major grid line color

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisbox << Major Grid Line Color( "Blue" );


```

### [Max](#max)

**Syntax:** obj \<< Max( number )

**Description:** Sets the maximum value of the axis.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Max( 120 );


```

### [Min](#min)

**Syntax:** obj \<< Min( number )

**Description:** Sets the minimum value of the axis.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Min( 100 );


```

### [Minor Grid Line Color](#minor-grid-line-color)

**Syntax:** obj \<< Minor Grid Line Color( color )

**Description:** Sets the minor grid line color

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisbox << Minor Grid Line Color( "Blue" );


```

### [Minor Ticks](#minor-ticks)

**Syntax:** obj \<< Minor Ticks( number )

**Description:** Sets the number of ticks that should be placed between the labels.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Minor Ticks( 5 );


```

### [Paste Axis Settings](#paste-axis-settings)

**Syntax:** obj \<< Paste Axis Settings

**Description:** The clipboard contains a script appropriate to Axis settings, apply it.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv1 = Bivariate( Y( :weight ), X( :height ), FitLine );
biv2 = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv1 = biv1 << report;
axisbox1 = rbiv1[axis box( 1 )];
axisbox1 << Scale( "Log" );
axissettings = axisbox1 << Copy Axis Settings;
rbiv2 = biv2 << report;
axisbox2 = rbiv2[axis box( 1 )];
axisbox2 << Paste Axis Settings;


```

### [Remove Axis Label](#remove-axis-label)

**Syntax:** obj \<< Remove Axis Label

**Description:** Removes all labels added with Add Axis Label.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << RemoveAxisLabel( "weight" );
axisbox << AddAxisLabel( "pounds" );


```

### [Remove Ref Line](#remove-ref-line)

**Syntax:** obj \<< Remove Ref Line( number )

**Description:** Removes the given reference line.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Add Ref Line( 90, "Dashed", blue );
axisbox << Remove Ref Line( 90 );


```

### [Reversed Scale](#reversed-scale)

**Syntax:** obj \<< Reversed Scale

**Description:** Reverses the normal scale direction so that the highest value is on the left or bottom.

```

Open( "$sample_data/big class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gbr = Report( gb );
gbr[axisbox( 1 )] << Reversed Scale( 1 );


```

### [Revert Axis](#revert-axis)

**Syntax:** obj \<< Revert Axis

**Description:** Restores the axis' original settings (from time of creation).

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Max( 120 );
axisbox << Revert Axis;


```

### [Revert Scale](#revert-scale)

**Syntax:** obj \<< Revert Scale

**Description:** Restore the scale of the axis without altering other customizations

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Max( 120 );
axisbox << Revert Scale;


```

### [Save To Column Property](#save-to-column-property)

**Syntax:** obj \<< Save To Column Property

**Description:** Save the Axis settings as an Axis property in the data column associated with this axis.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Save To Column Property();


```

### [Scale](#scale)

**Syntax:** obj \<< Scale( "Linear"|"Log"|"Exponential Probability"|"Weibull Probability"|"Logistic Probability"|"Frechet Probability"|"Normal Probability"|"Cube Root"|"Johnson Su"|"Geodesic"|"Geodesic US"|"Power"|"Gamma Probability"|"Beta Probability"|"Mixture of 2 Normals Probability"|"Mixture of 3 Normals Probability"|"Custom Scale" )

**Description:** Specifies the type of scaling that should be applied to the axis. If the type is Custom Scale, this message expects two additional clauses; see Scale To Internal and Scale To External.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Scale( "Log" );


```

### [Scale ID](#scale-id)

**Syntax:** obj \<< Scale ID( number )

**Description:** Add a specific ID to the axis for use with several axes.

**JMP Version Added:** 16

```

gbox = Graph Box(
    Frame Size( 300, 300 ),
    X Axis( Scale ID( 1 ), Side( 1 ), Min( 1 ), Max( 100 ), Inc( 5 ) ),
    X Axis( Scale ID( 2 ), Side( 2 ), Min( 4 ), Max( 50 ), Inc( 3 ) ),
    X Axis( Min( 8 ), Max( 700 ) ), //assigned scale ID 3
    X Axis( Scale ID( 7 ), Side( 2 ), Min( -100 ), Max( 200 ) ),
    Y Axis( Min( 1 ), Max( 100 ) ), //assigned scale ID 4
    Y Axis( Side( 2 ), Min( 1 ), Max( 10 ), Inc( 1 ) ), //assigned scale ID 5
    Y Axis( Scale ID( 6 ), Min( -100 ), Max( 200 ) )
);
gbox << Set Y Name( "Test", 5 ); //set y name of axis with ID 5

fbox = gbox[frame box( 1 )];
fbox << Add Graphics Script(
    Scale IDs( 1, 5 ), //use scale ID's 1 and 5 for this graphics script
    Pen Color( "Purple" );
    Line( [20 50 80], [4 3 6] );
);
New Window( "Example", gbox );


```

### [Scale To External](#scale-to-external)

**Syntax:** obj \<< Scale To External

**Description:** Scales the external coordinate system according to the given custom formula.

```

Open( "$sample_data/big class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 2 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
gbr = Report( gb );
gbr[axisbox( 1 )] << scale(
    custom scale,
    Scale To Internal( Function( {x}, If( x > 0, Log( x, 2 ), . ) ) ),
    Scale To External( Function( {x}, Power( 2, x ) ) )
) << Min( 32 ) << Max( 100 );


```

### [Scale To Internal](#scale-to-internal)

**Syntax:** obj \<< Scale To Internal

**Description:** Scales the internal coordinate system according to the given custom formula.

```

Open( "$sample_data/big class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 2 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
gbr = Report( gb );
gbr[axisbox( 1 )] << scale(
    custom scale,
    Scale To Internal( Function( {x}, If( x > 0, Log( x, 2 ), . ) ) ),
    Scale To External( Function( {x}, Power( 2, x ) ) )
) << Min( 32 ) << Max( 100 );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( number )

**Description:** Sets the width of the axis.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << SetWidth( 100 );


```

### [Show Labels](#show-labels)

**Syntax:** obj \<< Show Labels( state=0|1 )

**Description:** Shows(1) or hides (0) the axis labels for major tick marks. On by default.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Show Major Labels( 0 );


```

### [Show Major Grid](#show-major-grid)

**Syntax:** obj \<< Show Major Grid( state=0|1 )

**Description:** Shows (1) or hides (0) the grid that is placed in the same location as the numeric labels.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Show Major Grid( 1 );


```

### [Show Major Labels](#show-major-labels)

**Syntax:** obj \<< Show Major Labels( state=0|1 )

**Description:** Shows(1) or hides (0) the axis labels for major tick marks. On by default.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Show Major Labels( 0 );


```

### [Show Major Ticks](#show-major-ticks)

**Syntax:** obj \<< Show Major Ticks( state=0|1 )

**Description:** Shows (1) or hides (0) the tick marks that are placed at the same location as the numeric labels. On by default.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Show Major Ticks( 0 );


```

### [Show Minor Grid](#show-minor-grid)

**Syntax:** obj \<< Show Minor Grid( state=0|1 )

**Description:** Shows (1) or hides (0) the grid that is placed between the numeric labels.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisbox << Show Minor Grid( 1 );


```

### [Show Minor Labels](#show-minor-labels)

**Syntax:** obj \<< Show Minor Labels( state=0|1 )

**Description:** Shows(1) or hides (0) the axis labels for minor tick marks.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Show Minor Labels( 1 );


```

### [Show Minor Ticks](#show-minor-ticks)

**Syntax:** obj \<< Show Minor Ticks( state=0|1 )

**Description:** Shows (1) or hides (0) the tick marks that are placed in between the numeric labels. On by default.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisbox << Show Minor Ticks( 1 );


```

### [Side](#side)

**Syntax:** \<X / Y> Axis( Side ( \<1/2> ) )

**Description:** Change the side (primary (1) or secondary (2)) of the axis

**JMP Version Added:** 16

```

gbox = Graph Box(
    Frame Size( 300, 300 ),
    X Axis( Scale ID( 1 ), Side( 1 ), Min( 1 ), Max( 100 ), Inc( 5 ) ),
    X Axis( Scale ID( 2 ), Side( 2 ), Min( 4 ), Max( 50 ), Inc( 3 ) ),
    X Axis( Min( 8 ), Max( 700 ) ), //assigned scale ID 3
    X Axis( Scale ID( 7 ), Side( 2 ), Min( -100 ), Max( 200 ) ),
    Y Axis( Min( 1 ), Max( 100 ) ), //assigned scale ID 4
    Y Axis( Side( 2 ), Min( 1 ), Max( 10 ), Inc( 1 ) ), //assigned scale ID 5
    Y Axis( Scale ID( 6 ), Min( -100 ), Max( 200 ) )
);
New Window( "Example", gbox );


```

### [Tick Font](#tick-font)

**Syntax:** obj \<< Tick Font

**Description:** Sets the font of the tick marks.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Tick Font( "Arial", 14, "Italic Underline" );


```

### [Tick Label List](#tick-label-list)

**Syntax:** obj \<< Tick Label List

**Description:** Sets the values and positions of the axis tick labels

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << {Min( 0 ), Max( 5 ), Inc( 1 )};
axisbox << Tick Label List( {"sqrt2", "sqrt3", "e", "pi"}, {1.41, 1.73, 2.72, 3.14} );


```

### [Update Ref Line](#update-ref-line)

**Syntax:** obj \<< Update Ref Line( ID, index, value, \<"Solid|Dashed|Double">, <Color>, \<"label">, <line width>, <transparency> )

**Description:** Modifies an existing reference line.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Add Ref Line( 108.3182, "Dashed", blue, "M mean", 2 );
axisbox << Add Ref Line( 100.9444, "Dotted", red, "F mean", 2 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_2)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [BarSeg](#barseg)

## [Associated Constructors](#associated-constructors)

### [Bar Seg](#bar-seg)

**Syntax:** Bar Seg( x, y, < Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) >, < Sizes( s ) > )

**Description:** Returns a seg representing summarized data as bars.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Fill Color( "Green" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Frame;


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Get Base Font;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fill Color](#get-fill-color)

**Syntax:** color = obj \<< Get Fill Color

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Fill Color;


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Fill Pattern;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Gradient Transparency;


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Line Width;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Marker Size;


```

### [Get Side by Side Overlap](#get-side-by-side-overlap)

**Syntax:** proportion = obj \<< Get Side by Side Overlap

**Description:** Returns the amount of overlap for subitems in "side by side" bar styles.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ), Overlay( :sex ) ),
    Elements( Bar( X, Y ) )
);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Side by Side Overlap();


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Get Text Color

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Text Color;


```

### [Get Text Style](#get-text-style)

**Syntax:** obj \<< Get Text Style

**Description:** Gets how the text is drawn with respect to the cursor pen.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Get Text Style;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 (clear) and 1 (opaque).

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Transparency;


```

### [Get Width Proportion](#get-width-proportion)

**Syntax:** proportion = obj \<< Get Width Proportion

**Description:** Returns the proportion of the available bar width to use for drawing. 0 means automatic sizes. 1 means no gap.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder( Variables( X( :age ), Y( :weight ) ), Elements( Bar( X, Y ) ) );
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Width Proportion();


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Gradient Transparency( "None" );


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Parent;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Revert;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Label Offset](#set-label-offset)

**Syntax:** Set Label Offset {Bar Index, X Scale Coordinate, Y Scale Coordinate}

**Description:** Sets the offset of a bar's value label to a coordinate in the graph

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 9 ), Label( "Label by Value" ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {DispatchSeg(
                BarSeg( 1 ),
                {Set Label Offset( {0, 0.394409937888199, 112.5685} ),
                Set Label Offset( {1, 1.2639751552795, 110.634333333333} ),
                Set Label Offset( {2, 2.14596273291925, 111.794833333333} ),
                Set Label Offset( {3, 3.12732919254658, 116.05} ),
                Set Label Offset( {4, 4.17080745341615, 127.268166666667} )}
            )}
        )
    )
);


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Line Width( 3 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Side by Side Overlap](#set-side-by-side-overlap)

**Syntax:** obj \<< Set Side by Side Overlap( proportion or missing )

**Description:** Sets the amount of overlap for subitems in "side by side" bar styles, 0 (no overlap) to 1 (full overlap).

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ), Overlay( :sex ) ),
    Elements( Bar( X, Y ) )
);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Side by Side Overlap( 0.5 );


```

### [Set Text Color](#set-text-color)

**Syntax:** obj \<< Set Text Color( color )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Text Color( "Green" );


```

### [Set Text Style](#set-text-style)

**Syntax:** obj \<< Set Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Transparency( .3 );


```

### [Set Width Proportion](#set-width-proportion)

**Syntax:** obj \<< Set Width Proportion( proportion )

**Description:** Sets the proportion of the available bar width to use for drawing. 0 means automatic sizes. 1 means no gap.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder( Variables( X( :age ), Y( :weight ) ), Elements( Bar( X, Y ) ) );
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Width Proportion( 1 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Text Color( "Green" );


```

### [Text Style](#text-style)

**Syntax:** obj \<< Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Label( "Label by Value" ) ) )
);
frame = Report( obj )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [BorderBox](#borderbox)

## [Associated Constructors](#associated-constructors)

### [Border Box](#border-box)

**Syntax:** y = Border Box( \<Left( pix )>, \<Right( pix )>, \<Top( pix )>, \<Bottom( pix )>, \<Sides( 0 )>, displayBoxArg )

**Description:** Returns a display box that has a border around the display boxes within it.

```

New Window( "Example",
    Border Box( Left( 10 ), Right( 10 ), Top( 10 ), Bottom( 10 ), Sides( 15 ),
        Text Box( "Hello World!" )
    )
);


```

## [Item Messages](#item-messages)

### [Bottom](#bottom)

**Syntax:** obj \<< Bottom( pixels )

**Description:** Adds space between the bottom of the border box and the contents of the border box.

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << bottom( 100 );


```

### [Get Background Fill](#get-background-fill)

**Syntax:** obj \<< Get Background Fill

**Description:** Returns 0 if background fill is off or 1 if background fill is on.

```

New Window( "Example",
    bb = Border Box( Left( 10 ), Right( 10 ), Top( 10 ), Bottom( 10 ), Sides( 15 ),
        Text Box( "Hello World!" )
    )
);
Wait( .5 );
bb << SetBackgroundColor( "Red" );/*setting the color forces Fill to be on*/before = bb <<
GetBackgroundFill();
Wait( .5 );
bb << SetBackgroundFill( 0 );
after = bb << GetBackgroundFill();
"before=" || Char( before ) || "  after=" || Char( after );


```

### [Get Style](#get-style)

**Syntax:** obj \<< Get Style

**Description:** Returns the number code for the line style of the border.

```

New Window( "Example",
    bb = Border Box( Left( 10 ), Right( 10 ), Top( 10 ), Bottom( 10 ), Sides( 15 ),
        Text Box( "Hello World!" )
    )
);
style = bb << Get Style();


```

### [GetBottom](#getbottom)

**Syntax:** pixels = obj \<< GetBottom

**Description:** returns the bottom border

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << bottom( 100 );
bb << get bottom;


```

### [GetLeft](#getleft)

**Syntax:** pixels = obj \<< GetLeft

**Description:** returns the left border

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << Left( 20 );
bb << get left;


```

### [GetRight](#getright)

**Syntax:** pixels = obj \<< GetRight

**Description:** returns the right border

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << Right( 100 );
bb << get right;


```

### [GetSides](#getsides)

**Syntax:** value = obj \<< GetSides

**Description:** returns which sides are drawn

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << Sides( 15 );
bb << Get Sides();


```

### [GetTop](#gettop)

**Syntax:** pixels = obj \<< GetTop

**Description:** returns the top border

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << top( 20 );
bb << get top;


```

### [Left](#left)

**Syntax:** obj \<< Left( pixels )

**Description:** Adds space between the left of the border box and the contents of the border box.

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << Left( 20 );


```

### [Right](#right)

**Syntax:** obj \<< Right( pixels )

**Description:** Adds space between the right of the border box and the contents of the border box.

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << Right( 100 );


```

### [Set Background Fill](#set-background-fill)

**Syntax:** obj \<< Set Background Fill( state=0|1 )

**Description:** Enables or disables filling the background of the border box with the background color.

```

New Window( "Example",
    bb = Border Box( Left( 10 ), Right( 10 ), Top( 10 ), Bottom( 10 ), Sides( 15 ),
        Text Box( "Hello World!" )
    )
);
Wait( 1 );
bb << SetBackgroundColor( "Red" );/*setting the color forces Fill to be on*/Wait( 1 );
bb << SetBackgroundFill( 0 );


```

### [Set Style](#set-style)

**Syntax:** obj \<< Set Style( pen style )

**Description:** Sets the line style for the border. Pen style can be either the number or the quoted string: 0 (Solid), 1 (Dotted), 2 (Dashed), 3 (DashDot), 4 (DashDotDot)

```

New Window( "Example",
    bb = Border Box( Left( 10 ), Right( 10 ), Top( 10 ), Bottom( 10 ), Sides( 15 ),
        Text Box( "Hello World!" )
    )
);
bb << Set Style( "Dotted" );


```

### [Sides](#sides)

**Syntax:** obj \<< Sides( value )

**Description:** An integer that maps to settings for the display box.

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << Sides( 15 );


```

### [Top](#top)

**Syntax:** obj \<< Top( pixels )

**Description:** Adds space between the top of the border box and the contents of the border box.

```

New Window( "Example", bb = Border Box( Text Box( "Hello World!" ) ) );
bb << top( 20 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [BoxPlotSeg](#boxplotseg)

## [Associated Constructors](#associated-constructors)

### [Box Plot Seg](#box-plot-seg)

**Syntax:** b = Box Plot Seg(<data>, <frequency>, <weight>, \<vertical=0|1>)

**Description:** Returns a display seg representing a box plot based on the passed in x and y values.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));


```

## [Item Messages](#item-messages)

### [Box Style](#box-style)

**Syntax:** obj \<< Box Style( "Normal"|"Solid"|"Thin" )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Box Style( "Solid" );


```

### [Box Type](#box-type)

**Syntax:** obj \<< Box Type( "Quantile"|"Outlier" )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Box Type( "Outlier" );


```

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Confidence Diamond](#confidence-diamond)

**Syntax:** obj \<< Confidence Diamond( state=0|1 )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Confidence Diamond( 0 );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fences](#fences)

**Syntax:** obj \<< Fences( state=0|1 )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Fences( 0 );


```

### [Fill](#fill)

**Syntax:** obj \<< Fill( state = 0|1 )

**JMP Version Added:** 15

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Fill( 0 );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Fill Color( "Green" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Frame;


```

### [Get Box Style](#get-box-style)

**Syntax:** obj \<< Get Box Style

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Box Style();


```

### [Get Box Type](#get-box-type)

**Syntax:** obj \<< Get Box Type

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Box Type();


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Confidence Diamond](#get-confidence-diamond)

**Syntax:** obj \<< Get Confidence Diamond

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Confidence Diamond();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fences](#get-fences)

**Syntax:** obj \<< Get Fences

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Fences();


```

### [Get Fill](#get-fill)

**Syntax:** obj \<< Get Fill

**JMP Version Added:** 15

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Fill;


```

### [Get Fill Color](#get-fill-color)

**Syntax:** obj \<< Get Fill Color

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Fill Color();


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Fill Pattern;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Gradient Transparency;


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Line Width;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Marker Size;


```

### [Get Median Line Style](#get-median-line-style)

**Syntax:** obj \<< Get Median Line Style

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Median Line Style();


```

### [Get Moment](#get-moment)

**Syntax:** obj \<< Get Moment( "Mean"|"Std Dev"|"Std Err Mean"|"Upper Mean"|"Lower Mean"|"N"|"Sum Wgt"|"Sum"|"Variance"|"Skewness"|"Kurtosis"|"CV"|"N Missing"|"N Zero"|"N Unique"|"Uncorrected SS"|"Corrected SS"|"Autocorrelation"|"Minimum"|"Maximum"|"Median"|"Mode"|"Trimmed Mean"|"Geometric Mean"|"Range"|"Interquartile Range"|"Median Absolute Deviation"|"Proportion Zero"|"Proportion Nonzero"|"K*Std Dev"|"K*Std Dev Above Mean"|"K\*Std Dev Below Mean"|"Robust Mean"|"Robust Standard Deviation"|"N Modes"|"Mode Count" )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Moment( "Std Dev" );


```

### [Get Notched](#get-notched)

**Syntax:** obj \<< Get Notched

**JMP Version Added:** 16

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Notched();


```

### [Get Quantiles](#get-quantiles)

**Syntax:** Matrix = obj \<< Get Quantiles( number )

**Description:** Returns a matrix representing the computed quantiles. The first column lists the quantiles that are computed and the second column contains the values for those quantiles.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Quantiles;


```

### [Get Shortest Half Bracket](#get-shortest-half-bracket)

**Syntax:** obj \<< Get Shortest Half Bracket

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Shortest Half Bracket();


```

### [Get Shortest Half Color](#get-shortest-half-color)

**Syntax:** obj \<< Get Shortest Half Color

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Shortest Half Color();


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 (clear) and 1 (opaque).

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Get Transparency;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Gradient Transparency( "None" );


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Median Line Style](#median-line-style)

**Syntax:** obj \<< Median Line Style( pen style )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Median Line Style( "Dotted" );


```

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Notched](#notched)

**Syntax:** obj \<< Notched( state=0|1 )

**JMP Version Added:** 16

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Notched( 1 );


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Parent;


```

### [Set Box Style](#set-box-style)

**Syntax:** obj \<< Set Box Style( "Normal"|"Solid"|"Thin" )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Box Style( "Solid" );


```

### [Set Box Type](#set-box-type)

**Syntax:** obj \<< Set Box Type( "Quantile"|"Outlier" )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Box Type( "Outlier" );


```

### [Set Confidence Diamond](#set-confidence-diamond)

**Syntax:** obj \<< Set Confidence Diamond( state=0|1 )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Confidence Diamond( 0 );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Fences](#set-fences)

**Syntax:** obj \<< Set Fences( state=0|1 )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Fences( 0 );


```

### [Set Fill](#set-fill)

**Syntax:** obj \<< Set Fill( state = 0|1 )

**JMP Version Added:** 15

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Fill( 0 );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Line Width( 3 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Median Line Style](#set-median-line-style)

**Syntax:** obj \<< Set Median Line Style( pen style )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Median Line Style( "Dotted" );


```

### [Set Notched](#set-notched)

**Syntax:** obj \<< Set Notched( state=0|1 )

**JMP Version Added:** 16

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Notched( 1 );


```

### [Set Shortest Half Bracket](#set-shortest-half-bracket)

**Syntax:** obj \<< Set Shortest Half Bracket( state = 0|1 )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Shortest Half Bracket( 0 );


```

### [Set Shortest Half Color](#set-shortest-half-color)

**Syntax:** obj \<< Set Shortest Half Color( color )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Shortest Half Color( "Green" );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Transparency( .3 );


```

### [Shortest Half Bracket](#shortest-half-bracket)

**Syntax:** obj \<< Shortest Half Bracket( state = 0|1 )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Shortest Half Bracket( 0 );


```

### [Shortest Half Color](#shortest-half-color)

**Syntax:** obj \<< Shortest Half Color( color )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Shortest Half Color( "Green" );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

```

New Window( "Box Plot Seg Example",
    g = Graph Box(
        Frame Size( 40, 180 ),
        Y Scale( 0, 100 ),
        Box Plot Seg( [20, 30, 50, 90] )
    )
);
g[AxisBox( 2 )] << delete;
seg = (g[FrameBox( 1 )] << Find Seg( "Box Plot Seg" ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [BusyLightBox](#busylightbox)

## [Associated Constructors](#associated-constructors)

### [Busy Light](#busy-light)

**Syntax:** y = Busy Light( < \<<Automatic(0|1)>, \<Size(x, y)>, < \<<Disable> )

**Description:** Creates a rotating image to indicate a busy process.

```

New Window( "Example", blb = Busy Light( <<Automatic( 1 ) ) );


```

## [Item Messages](#item-messages)

### [Advance](#advance)

**Syntax:** obj \<< Advance

**Description:** Moves the busy light ahead.

```

New Window( "Example", blb = Busy Light() );
For( i = 1, i <= 5, i++,
    Wait( 1 );
    blb << Advance;
);


```

### [Automatic](#automatic)

**Syntax:** obj \<< Automatic

**Description:** Causes the busy light box to spin.

```

New Window( "Example", blb = Busy Light( <<Automatic( 1 ) ) );
Wait( 1 );
blb << Automatic( 0 );
Wait( 1 );
blb << Automatic( 1 );


```

### [Disable](#disable)

**Syntax:** obj \<< Disable

**Description:** Disables and hides the busy light box. Automatic must be turned off for Disable to work. Turning Automatic on, or sending the box an Advance message re-enables and displays the busy light box.

```

New Window( "Example", blb = Busy Light( <<Automatic( 1 ) ) );
Wait( 1 );
blb << Automatic( 0 );
blb << Disable;


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [RPM](#rpm)

**Syntax:** obj \<< RPM

**Description:** Sets the speed that the busy light box moves when Automatic is turned on.

```

New Window( "Example", blb = Busy Light( <<Automatic( 1 ) ) );
Wait( 1 );
blb << RPM( 50 );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Size](#size)

**Syntax:** obj \<< Size

**Description:** Sets the size of the busy light box in pixels.

```

New Window( "Example", blb = Busy Light( <<Automatic( 1 ) ) );
Wait( 1 );
blb << Size( 50, 50 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ButtonBox](#buttonbox)

## [Associated Constructors](#associated-constructors)

### [Button Box](#button-box)

**Syntax:** y = Button Box( title, script )

**Description:** Returns a display box to show a titled button. The script argument is run when the button is clicked.

```

New Window( "Example", Button Box( "Press Me", Print( "Pressed." ) ) );


```

## [Item Messages](#item-messages)

### [Click](#click)

**Syntax:** obj \<< Click

**Description:** Simulates a click on the button, running any callbacks if appropriate. A toggle button will change state prior to the callback being invoked. A menu button requires an argument to specify which item to click.

#### [Menu](#menu)

```

New Window( "Example",
    ex = Button Box( "State",
        actiontext << Set Text( Char( ex << Get Menu Choice() ) ),
        <<Set Menu Items( {"Start", "Stop"} )
    ),
    H List Box( Text Box( "Last action: " ), actiontext = Text Box( "" ) )
);
Wait( 1 );
ex << Click( "Stop" );


```

#### [Normal](#normal)

```

New Window( "Example", ex = Button Box( "Start", ex << Set Button Name( "Stop" ) ) );
Wait( 1 );
ex << Click();


```

#### [Toggle](#toggle)

```

New Window( "Example",
    ex = Button Box( "Run",
        actiontext << Set Text( If( ex << Get(), "Start", "Stop" ) ),
        <<Style( "Toggle" )
    ),
    H List Box( Text Box( "Last action: " ), actiontext = Text Box( "" ) )
);
Wait( 1 );
ex << Click();


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get](#get)

**Syntax:** pressed = obj \<< Get

**Description:** Returns 1 if the toggle button is pressed, 0 if not pressed. Only applies to buttons which have Style("Toggle").

**JMP Version Added:** 14

```

New Window( "Toggle Button Example",
    ex = Button Box( "Toggle",
        If( ex << Get,
            Print( "Button is down" ),
            Print( "Button is up" )
        )
    )
);
ex << Style( "Toggle" );


```

### [Get Button Name](#get-button-name)

**Syntax:** name = obj \<< Get Button Name

**Description:** Returns the button name.

```

New Window( "Example", ex = Button Box( "Start" ) );
ex << Get Button Name();


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Icon](#get-icon)

**Syntax:** icon = obj \<< Get Icon

**Description:** Returns the icon for the button.

```

New Window( "Example", ex = Button Box( "" ) );
ex << Set Icon( "Go" );
ex << Get Icon();


```

### [Get Icon Location](#get-icon-location)

**Syntax:** left|right = obj \<< Get Icon Location

**Description:** Returns the location of an icon in a Button Box. Icon can be displayed to the left or right side of the button text.

```

New Window( "Example", ex = Button Box( "Pi" ) );
ex << Set Icon( "$SAMPLE_IMAGES/pi.gif" );
ex << Get Icon Location();


```

### [Get Menu Choice](#get-menu-choice)

**Syntax:** obj \<< Get Menu Choice

**Description:** Gets the index of the last user menu selection

```

New Window( "Example", b = Button Box( "Popup Menu", Print( b << Get Menu Choice ) ) );
b << set menu items( {"a", "b", "c"} );


```

### [Get Menu Item State](#get-menu-item-state)

**Syntax:** 0|1|-1 = obj \<< Get Menu Item State( index )

**Description:** Gets the popup menu item state of index menu item. The state will be normal (0), checked (1), or disabled (-1)

```

New Window( "Example", b = Button Box( "Popup Menu", Print( b << Get Menu Choice ) ) );
b << set menu items( {"a", "b", "c"} );
b << set menu item state( 1, -1 );
b << get menu item state( 1 );


```

### [Get Menu Items](#get-menu-items)

**Syntax:** list of menu items = obj \<< Get Menu Items

**Description:** Gets the menu items used for popup menu when the button is clicked

```

New Window( "Example", b = Button Box( "Popup Menu", Print( b << Get Menu Choice ) ) );
b << set menu items( {"a", "b", "c"} );
b << get menu items();


```

### [Get Style](#get-style)

**Syntax:** style = obj \<< Get Style

**Description:** Returns the current style of the button.

**JMP Version Added:** 14

```

New Window( "Example", ex = Button Box( "Click Me" ) );
ex << Style( "Toggle" );
Print( ex << Get Style() );


```

### [Get Underline Style](#get-underline-style)

**Syntax:** style = obj \<< Get Underline Style

**Description:** Returns the current underline style of the button.

```

New Window( "Example", ex = Button Box( "Start", ex << Set Button Name( "Stop" ) ) );
Print( ex << Get Underline Style() );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Open Next Outline](#open-next-outline)

**Syntax:** obj \<< Open Next Outline

**Description:** Closes the containing outline box and opens the next one.

```

New Window( "Example",
    Outline Box( "First", ex = Button Box( "Next", ex << Open Next Outline ) ),
    Outline Box( "Second", Text Box( "Last" ), <<Close )
);


```

### [Restore Focus After Click](#restore-focus-after-click)

**Syntax:** obj \<< Restore Focus After Click( state=0|1 )

**Description:** Sets the button to preserve the edit focus after being clicked. The default on Windows is to take the focus. The default on Macintosh is to preserve the focus.

```

New Window( "Example",
    Script Box( "" ),
    ex = Button Box( "Leave Focus", 0 ),
    Button Box( "Take Focus", 0 )
);
ex << Restore Focus After Click( 1 );


```

### [Set](#set)

**Syntax:** obj \<< Set( pressed, \<run script(0|1)> )

**Description:** Set the toggle state of a toggle button to pressed (1) or not pressed (0). Only applies to buttons which have Style("Toggle").

**JMP Version Added:** 14

```

New Window( "Toggle Button Example", ex = Button Box( "Toggle" ) );
ex << Style( "Toggle" );
ex << Set( 1 );


```

### [Set Button Name](#set-button-name)

**Syntax:** obj \<< Set Button Name( name )

**Description:** Sets the button name to the given text.

```

New Window( "Example", ex = Button Box( "Start", ex << Set Button Name( "Stop" ) ) );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox}, <script> ) | Method({thisBox}, <script>) | <symbol> )

**Description:** Sets the given function for the control. The function's script is run when the button is pressed.

**JMP Version Added:** 14

#### [Class method](#class-method)

```

Define Class(
    "MyDialog",
    _init_ = Method( {},
        New Window( "MyDialog",
            <<Type( "Dialog" ),
            Button Box( "press me", <<SetFunction( clickCallback ) )
        )
    );
    clickCallback = Method( {buttonBox},
        buttonBox << SetButtonName( "thanks" )
    );
);
obj = New Object( "MyDialog" );


```

#### [Inline function](#inline-function)

```

New Window( "Example",
    Button Box( "press me",
        <<setFunction( Function( {thisBox}, thisBox << setButtonName( "thanks" ) ) )
    )
);


```

### [Set Icon](#set-icon)

**Syntax:** obj \<< Set Icon( icon name|image filepath )

**Description:** Displays a JMP icon or an image on the button. Use a JMP icon name or the filepath to an image.

**Example 1**

```

New Window( "Example", ex = Button Box( "" ) );
ex << Set Icon( "Go" );


```

**Example 2**

```

New Window( "Example", ex = Button Box( "" ) );
ex << Set Icon( "$SAMPLE_IMAGES/pi.gif" );


```

### [Set Icon Location](#set-icon-location)

**Syntax:** obj \<< Set Icon Location( left,right )

**Description:** Sets the location of the icon to the left or right side of the button text

**Example 1**

```

New Window( "Example", ex = Button Box( "Go" ) );
ex << Set Icon( "Go" );
ex << Set Icon Location( "left" );


```

**Example 2**

```

New Window( "Example", ex = Button Box( "Pi" ) );
ex << Set Icon( "$SAMPLE_IMAGES/pi.gif" );
ex << Set Icon Location( "left" );


```

### [Set Menu Choice](#set-menu-choice)

**Syntax:** obj \<< Set Menu Choice( index )

**Description:** Sets the index of the user menu selection

```

New Window( "Example", b = Button Box( "Popup Menu", Print( b << Get Menu Choice ) ) );
b << set menu items( {"a", "b", "c"} );
b << Set Menu Choice( 2 );
b << Get Menu Choice;


```

### [Set Menu Item State](#set-menu-item-state)

**Syntax:** obj \<< Set Menu Item State( index, 0|1|-1 )

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

```

New Window( "Example", b = Button Box( "Popup Menu", Print( b << Get Menu Choice ) ) );
b << set menu items( {"a", "b", "c"} );
b << set menu item state( 1, -1 );


```

### [Set Menu Items](#set-menu-items)

**Syntax:** obj \<< Set Menu Items( list of menu items )

**Description:** Sets the menu items to be used for popup menu when the button is clicked

```

New Window( "Example", b = Button Box( "Popup Menu", Print( b << Get Menu Choice ) ) );
b << set menu items( {"a", "b", "c"} );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Style](#style)

**Syntax:** obj \<< Style( "Normal"|"Underline"|"Toggle" )

**Description:** Sets the style of the button.

**JMP Version Added:** 14

**Example 1**

```

New Window( "Toggle Button Example",
    ex = Button Box( "Start",
        If( ex << Get,
            ex << Set Button Name( "Stop" ),
            ex << Set Button Name( "Start" )
        )
    )
);
ex << Style( "Toggle" );


```

**Example 2**

```

New Window( "Underline Button Example",
    ex = Button Box( "Start", ex << Set Button Name( "Stop" ) )
);
ex << Underline Style( 1 );


```

### [Underline Style](#underline-style)

**Syntax:** obj \<< Underline Style( state=0|1 )

**Description:** Sets the button to use underline drawing style instead of standard button style.

```

New Window( "Example", ex = Button Box( "Start", ex << Set Button Name( "Stop" ) ) );
ex << Underline Style( 1 );


```

### [Unhide Next Item](#unhide-next-item)

**Syntax:** obj \<< Unhide Next Item

**Description:** Reveals hidden items in the containing outline box.

```

New Window( "Example",
    Outline Box( "Question",
        ex = Button Box( "See Answer", ex << Unhide Next Item ),
        Text Box( "42", <<hide )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [CalendarBox](#calendarbox)

## [Associated Constructors](#associated-constructors)

### [Calendar Box](#calendar-box)

**Syntax:** y = Calendar Box()

**Description:** Returns a display box containing a calendar control. The calendar supports single-selection of a date and optional time.

```

New Window( "Calendar Box Example", cal = Calendar Box() );


```

## [Item Messages](#item-messages)

### [Date](#date)

**Syntax:** obj \<< Date( number ); number = obj \<< Get Date

**Description:** The current selected date in the calendar.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) );
Show( Abbrev Date( cal << Get Date ) );


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Date](#get-date)

**Syntax:** obj \<< Date( number ); number = obj \<< Get Date

**Description:** The current selected date in the calendar.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) );
Show( Abbrev Date( cal << Get Date ) );


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Max Date](#get-max-date)

**Syntax:** obj \<< Max Date( number ); number = obj \<< Get Max Date

**Description:** Set the maximum date. The calendar control will be limited to selections in the correct range.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) ) << Min Date( Date MDY( 10, 3, 1989 ) ) <<
Max Date( Date MDY( 10, 7, 1989 ) );
Show( Abbrev Date( cal << Get Max Date ) );


```

### [Get Min Date](#get-min-date)

**Syntax:** obj \<< Min Date( number ); number = obj \<< Get Min Date

**Description:** Set the minimum date. The calendar control will be limited to selections in the correct range.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) ) << Min Date( Date MDY( 10, 3, 1989 ) ) <<
Max Date( Date MDY( 10, 7, 1989 ) );
Show( Abbrev Date( cal << Get Min Date ) );


```

### [Get Show Time](#get-show-time)

**Syntax:** obj \<< Show Time( state=0|1 ); state = obj \<< Get Show Time

**Description:** Select a time in addition to a date.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) ) << Show Time( 0 );
Show( cal << Get Show Time );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Max Date](#max-date)

**Syntax:** obj \<< Max Date( number ); number = obj \<< Get Max Date

**Description:** Set the maximum date. The calendar control will be limited to selections in the correct range.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) ) << Min Date( Date MDY( 10, 3, 1989 ) ) <<
Max Date( Date MDY( 10, 7, 1989 ) );
Show( Abbrev Date( cal << Get Max Date ) );


```

### [Min Date](#min-date)

**Syntax:** obj \<< Min Date( number ); number = obj \<< Get Min Date

**Description:** Set the minimum date. The calendar control will be limited to selections in the correct range.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) ) << Min Date( Date MDY( 10, 3, 1989 ) ) <<
Max Date( Date MDY( 10, 7, 1989 ) );
Show( Abbrev Date( cal << Get Min Date ) );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, date}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when a date is clicked. date is the current selected date.

**JMP Version Added:** 14

```

New Window( "Calendar Box Example", cal = Calendar Box() );
cal << Set Function( Function( {thisBox, date}, Show( As Date( date ) ) ) );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Show Time](#show-time)

**Syntax:** obj \<< Show Time( state=0|1 ); state = obj \<< Get Show Time

**Description:** Select a time in addition to a date.

```

New Window( "Calendar Box Example", cal = Calendar Box() );
Wait( 1 );
cal << Date( Date MDY( 10, 5, 1989 ) ) << Show Time( 0 );
Show( cal << Get Show Time );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [CellPlotBox](#cellplotbox)

## [Item Messages](#item-messages)

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme( Green to Black to Red|Green to White to Red|White to Black|Blue to Gray to Red|Blue to Green to Red|Spectral|Jet|White to Blue|White to Green|White to Red )

**Description:** Specifies the range of colors to use when displaying the cell plot.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Color Theme( "Jet" );


```

### [Frame Size](#frame-size)

**Syntax:** obj \<< Frame Size( width,height )

**Description:** Change the frame size.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Frame Size( 400, 500 );


```

### [Graph Type](#graph-type)

**Syntax:** obj \<< Graph Type( "Color Map"|"Dot Plot"|"VLine Plot"|"HLine Plot"|"HBar Plot" )

**Description:** Specifies the visual style of the cell plot.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Graph Type( "Dot Plot" );


```

### [No separator lines](#no-separator-lines)

**Syntax:** obj \<< No separator lines( state=0|1 )

**Description:** Removes the lines that are drawn around each column in the cell plot.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << No Separator Lines( 1 );


```

### [Row Colors](#row-colors)

**Syntax:** obj \<< Row Colors( color )

**Description:** Sets the color of the selected rows.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
dt << Select Where( dt:population < 10000000 );
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Colors( "Red" );


```

### [Row Editor](#row-editor)

**Syntax:** obj \<< Row Editor

**Description:** Bring up the Row Editor window, starting with the first selected point.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;


```

### [Row Exclude](#row-exclude)

**Syntax:** obj \<< Row Exclude

**Description:** Excludes (or unexcludes) the corresponding rows in the data table

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
dt << Select Where( dt:population < 10000000 );
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Exclude;


```

### [Row Hide](#row-hide)

**Syntax:** obj \<< Row Hide

**Description:** Hides (or unhides) the corresponding rows in the data table

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
dt << Select Where( dt:population < 10000000 );
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Hide;


```

### [Row Hide and Exclude](#row-hide-and-exclude)

**Syntax:** obj \<< Row Hide and Exclude

**Description:** Hides and excludes (or unhide or unexcludes) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
dt << Select Where( dt:population < 10000000 );
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Hide and Exclude;


```

### [Row Label](#row-label)

**Syntax:** obj \<< Row Label

**Description:** Labels (or unlabels) the corresponding rows in the data table

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
dt << Select Where( dt:population < 10000000 );
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Label;


```

### [Row Markers](#row-markers)

**Syntax:** obj \<< Row Markers( marker )

**Description:** Sets the marker of the selected rows.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
dt << Select Where( dt:population < 10000000 );
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Markers( 2 );


```

### [Sort Ascending](#sort-ascending)

**Syntax:** obj \<< Sort Ascending

**Description:** Sorts the values in ascending order.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Sort Ascending;


```

### [Sort Descending](#sort-descending)

**Syntax:** obj \<< Sort Descending

**Description:** Sorts the values in descending order.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Sort Descending;


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [CenterBox](#centerbox)

## [Associated Constructors](#associated-constructors)

### [H Center Box](#h-center-box)

**Syntax:** y = H Center Box( <childbox> )

**Description:** Returns a display box with the childbox display box argument centered in the horizontal space defined by the maximum size of that child and all the other siblings of the center box.

```

New Window( "test",
    H List Box(
        V Center Box( Text Box( "V+V" ) ),
        V List Box(
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            H Center Box( Text Box( "H+H" ) ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" )
        )
    )
);


```

### [V Center Box](#v-center-box)

**Syntax:** y = V Center Box( <childbox> )

**Description:** Returns a display box with the childbox display box argument centered in the vertical space defined by the maximum size of that child and all the other siblings of the center box.

```

New Window( "test",
    H List Box(
        V Center Box( Text Box( "V+V" ) ),
        V List Box(
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            H Center Box( Text Box( "H+H" ) ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" ),
            Text Box( "mmmmmmmmmmmmmmmmmmmmmmmmmmmmmm" )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Get Horizontal](#get-horizontal)

**Syntax:** state=0|1 = obj \<< Get Horizontal

**Description:** Returns if the Center Box is horizontal (1) or vertical (0).

```

New Window( "Example",
    Outline Box( "Outline Box",
        vlb = V List Box(
            hcb = H Center Box( Text Edit Box( "Centered" ) ),
            H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
        )
    )
);
Print( "Horizontal Center Box:", hcb << Get Horizontal );


```

### [Set Horizontal](#set-horizontal)

**Syntax:** obj \<< Set Horizontal( state=0|1 )

**Description:** Sets the Center Box to horizontal (1) or vertical (0).

```

New Window( "Example",
    Outline Box( "Outline Box",
        vlb = V List Box(
            hcb = H Center Box( Text Edit Box( "Centered" ) ),
            H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
        )
    )
);
Wait( 1 );
hcb << Set Horizontal( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [CheckBoxBox](#checkboxbox)

## [Associated Constructors](#associated-constructors)

### [Check Box](#check-box)

**Syntax:** y = Check Box( {item, ...}, <script> )

**Description:** Returns a display box that displays a CheckBox for each item in the inputted list.

```

New Window( "Example",
    cb = Check Box(
        {"One", "Two", "Three"},
        Print( "Selected: " || Concat Items( cb << Get Selected(), ", " ) )
    )
);


```

## [Item Messages](#item-messages)

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Enable Item](#enable-item)

**Syntax:** obj \<< Enable Item( index, 0|1 )

**Description:** Sets the item at the index to be enabled (1) or disabled (0).

```

New Window( "Example", cb = Check Box( {"One", "Two", "Three"} ) );
cb << Set( 1, 1 );
cb << Enable Item( 3, 0 );


```

### [Get](#get)

**Syntax:** 0|1 = obj \<< Get( <index> )

**Description:** Returns if the check box is checked (1), unchecked (0), or indeterminate (empty()) for Three State checkboxes.

```

New Window( "Example", cb = Check Box( {"One", "Two", "Three"} ) );
cb << Set( 3, 1 );
Print( cb << Get( 3 ) );


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} ),
        cb = Check Box( {"A", "B", "C", "D"} )
    )
);
cb << Set Heading( "Climbed" );
cb << Get Heading;


```

### [Get Items](#get-items)

**Syntax:** list = obj \<< Get Items

**Description:** Returns a list of all of the items.

**Example 1**

```

New Window( "Example",
    cb = Check Box(
        {"One", "Two", "Three"},
        Print( "Selected: " || Char( cb << Get Selected() ) )
    )
);
Wait( 1 );
cb << Set Items( {"Four", "Five", "Six"} );
cb << Get Items;


```

**Example 2**

```

New Window( "Example",
    Check Box(
        {"a", "b", "c"},
        <<setfunction(/*anonymous function...*/Function(
                {thisBox, iCheck/*optional parameter for check box tells which box changed*/},
                irow << SetText( Char( iCheck ) );
                iname << SetText(
                    (thisBox << GetItems)[iCheck]/*index the list of check box names from <<GetItems*/
                );
                ivalue << SetText(
                    Char(
                        thisBox << Get( iCheck )/*<<Get returns the value of the iCheck box*/
                    )
                );
            )
        )
    ),
    H List Box(/*irow,iname,ivalue are the text boxes that are updated when a check box changes*/
        Text Box( "row: " ),
        irow = Text Box( "" ),
        Text Box( " " ),
        iname = Text Box( "" ),
        Text Box( " = " ),
        ivalue = Text Box( "" )
    )
);


```

### [Get Selected](#get-selected)

**Syntax:** obj \<< Get Selected

**Description:** Returns a list of strings of checked items.

```

New Window( "Example", cb = Check Box( {"One", "Two", "Three"} ) );
cb << Set( 1, 1 );
cb << Set( 3, 1 );
Print( cb << Get Selected() );


```

### [Get Selected Indices](#get-selected-indices)

**Syntax:** obj \<< Get Selected Indices

**Description:** Returns a list of all of the selected indices.

**JMP Version Added:** 15

```

New Window( "Example", cb = Check Box( {"One", "Two", "Three"} ) );
cb << Set( 1, 1 );
cb << Set( 3, 1 );
Print( cb << Get Selected Indices() );


```

### [Get Selected Indices As Matrix](#get-selected-indices-as-matrix)

**Syntax:** indices = obj \<< Get Selected Indices As Matrix

**Description:** Returns a list of all of the selected indices as a matrix

**JMP Version Added:** 16

```

New Window( "Example", cb = Check Box( {"One", "Two", "Three"} ) );
cb << Set( 1, 1 );
cb << Set( 3, 1 );
Print( cb << Get Selected Indices As Matrix() );


```

### [Get Three State](#get-three-state)

**Syntax:** obj \<< Get Three State( <Boolean> )

**Description:** Creates a three state checkbox. All items are either 0, 1, or empty().

**JMP Version Added:** 17

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} ),
        cb = Check Box( {"A", "B", "C", "D"} )
    )
);
cb << Set Three State( 1 );
cb << Set( 2, Empty() );
Print( cb << Get Three State() );
Print( cb << Get( 2 ) );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Item Enabled](#item-enabled)

**Syntax:** 0|1 = obj \<< Item Enabled( index )

**Description:** Returns if the item at the index is enabled (1) or disabled (0).

```

New Window( "Example", cb = Check Box( {"One", "Two", "Three"} ) );
cb << Set( 1, 1 );
cb << Enable Item( 3, 0 );
Print( cb << Item Enabled( 3 ) );


```

### [Set](#set)

**Syntax:** obj \<< Set( <index>,\<Boolean|empty()>,\<Run Script(0|1)> )

**Description:** Sets the check box to be checked (1) or unchecked (0). Using the RunScript option also requires specifying the Boolean argument, as the arguments are positional.

```

New Window( "Example",
    H List Box(
        cb = Check Box( {"One", "Two", "Three"} ),
        cb2 = Check Box( {"Option 1", "Option 2", "Option 3"} )
    )
);
cb << Set( 3, 1 );
cb2 << Set Three State( 1 );
cb2 << Set( 3, Empty() );


```

### [Set All](#set-all)

**Syntax:** obj \<< Set All( \<Boolean|empty()>,\<Run Script(0|1)> )

**Description:** Sets all the check boxes to be checked (1) or unchecked (0). Using the RunScript option also requires specifying the Boolean argument, as the arguments are positional.

```

New Window( "Example", cb = Check Box( {"One", "Two", "Three"} ) );
cb << setFunction( Function( {this, button}, Show( button, this << get( button ) ) ) );
cb << Set All( 1, run script( 1 ) );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, index}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when a check box is clicked.

**JMP Version Added:** 14

```

New Window( "Example",
    cb = Check Box(
        {"One", "Two", "Three"},
        <<SetFunction(
            Function( {thisBox, index},
                (thisBox << sib) << settext( "Clicked: " || Char( index ) );
                ((thisBox << sib) << sib) << settext(
                    "Selected: " || Char( thisBox << Get Selected )
                );
            )
        )
    ),
    Text Box( "" ),
    Text Box( "" )
);


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} ),
        cb = Check Box( {"A", "B", "C", "D"} )
    )
);
cb << Set Heading( "Climbed" );


```

### [Set Items](#set-items)

**Syntax:** obj \<< Set Items( list )

**Description:** Sets the list of all of the items.

```

New Window( "Example",
    cb = Check Box(
        {"One", "Two", "Three"},
        Print( "Selected: " || Concat Items( cb << Get Selected(), ", " ) )
    )
);
Wait( 2 );
cb << Set Items( {"Four", "Five", "Six"} );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Three State](#set-three-state)

**Syntax:** obj \<< Set Three State( <Boolean> )

**Description:** Creates a three state checkbox. All items are either 0, 1, or empty().

**JMP Version Added:** 17

```

states = {1, 1, 1};
cbstates = {0, Empty(), 1};
// clicking on a three state checkbox cycles between checked and unchecked
// indeterminate must be set explicitly
New Window( "Example",
    Check Box(
        {"One", "Two", "Three"},
        <<Set Three State( 1 ),
        <<SetFunction(
            Function( {thisBox, index},
                states[index] = Mod( states[index], 3 ) + 1;
                thisBox << set( index, cbstates[states[index]] );
            )
        )
    )
);


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ColBox](#colbox)

## [Associated Constructors](#associated-constructors)

### [Col Box](#col-box)

**Syntax:** y = Col Box( title, boxes )

**Description:** Returns a column box made up of the given display boxes.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
Print( col << Get );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Get Font;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
Print( col << Get Heading() );


```

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Example",
    exx = 1;
    exy = 4;
    exz = 8;
    Table Box(
        String Col Box( "strings", {"x", "y", "z"} ),
        col = Col Box(
            "boxes",
            Slider Box( 0, 10, exx, Show( exx ) ),
            Slider Box( 0, 10, exy, Show( exy ) ),
            Slider Box( 0, 10, exz, Show( exz ) )
        )
    );
);
col << Set Heading( "New Column Header" );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( <list> )

**Description:** Sets the values from a list.

```

New Window( "Example", scb = String Col Box( "Associated Text", {"a", "b", "c", "d", "e"} ) );
scb << Set Values( {"A", "B", "C", "D", "E"} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ColListBox](#collistbox)

## [Associated Constructors](#associated-constructors)

### [Col List Box](#col-list-box)

**Syntax:** y = Col List Box( \<Data Table( name )>, <all>|\<character|numeric>, \<width( pix )>, <grouped>, \<maxSelected( n )>, \<nlines( n )>, \<MaxItems( n )>, \<MinItems( n )>, \<onChange( expr )>, < \<<Modeling Type({"Any","Continuous","Nominal","Ordinal","Multiple Response","Unstructured Text","Vector","None","Row State"}) >, < \<< Set Data Type(Any|Numeric|Character)>, <script> )

**Description:** Returns a display box to show list box to select data table columns. Use the \<<Modeling Type message to allow specialty modeling types or to restrict the types allowed. The default value of "Any" will allow any column with a classic modeling type ("Continuous", "Nominal", "Ordinal").

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 2",
    Col List Box( all, <<Set Data Type( "numeric" ), width( 250 ), maxSelected( 1 ) )
);


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example 3",
    H List Box(
        ll1 = Col List Box( all ),
        Button Box( "Add", ll2 << append( ll1 << get selected ) ),
        ll2 = Col List Box( "numeric", MaxItems( 1 ), nlines( 1 ) ),
        Button Box( "Remove", ll2 << remove selected )
    )
);


```

## [Item Messages](#item-messages)

### [Append](#append)

**Syntax:** obj \<< Append( "string" | {"string", ...} )

**Description:** Appends the new string or list of strings to the last position.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Append( "name" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Append( {"weight", "height", "name"} );


```

### [Clear selection](#clear-selection)

**Syntax:** obj \<< Clear selection

**Description:** Clears the current selection; the items are still there, but are no longer selected.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Selected( 1 );
lb << Set Selected( 2 );
Wait( 1 );
lb << Clear Selection;


```

**Example 2**

```

New Window( "Each box clears the other box",
    window:la = List Box(
        {"broccoli", "spinach", "kale", "beet", "turnip"},
        <<setscript( window:lb << clearselection )
    ),
    window:lb = List Box(
        {"pepper", "avocado", "pumpkin", "tomato", "zucchini"},
        <<setscript( window:la << clearselection )
    )
);


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Get Base Font;


```

### [Get Case Sensitive](#get-case-sensitive)

**Syntax:** "bool" = obj \<< Get Case Sensitive

**Description:** Returns true if items added to the list can match except for the case

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Append( "first item" );
slb << Get Case Sensitive();


```

### [Get Context Menu Script](#get-context-menu-script)

**Syntax:** list = obj \<< Get Context Menu Script

**Description:** Returns the context menu script attached to the calling object.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Context Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; ,
    "Get Context Menu Script", Print( lb << Get Context Menu Script )}
);


```

### [Get Data Type](#get-data-type)

**Syntax:** obj \<< Get Data Type

**Description:** returns the data type of a column list box

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Get Data Type();


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Item Padding](#get-item-padding)

**Syntax:** obj \<< Item Padding( sides ); sides = obj \<< Get Item Padding

**Description:** Padding adds space between listbox item text

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Item Padding( Left( 10 ), Top( 5 ), Right( 20 ), Bottom( 10 ) );


```

### [Get Items](#get-items)

**Syntax:** list = obj \<< Get Items( \<"Column Reference">)

**Description:** Returns a list of all of the items.

**JMP Version Added:** 15

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Append( "height" );
slb << Get Items();


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Append( "height" );
slb << Get Items( "Column Reference" );


```

### [Get Max Items](#get-max-items)

**Syntax:** obj \<< Get Max Items

**Description:** Returns the maximum number of items that are allowed for the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Get Max Items();


```

### [Get Max Selected](#get-max-selected)

**Syntax:** max = obj \<< Get Max Selected

**Description:** Returns the maximum number of items that can be selected in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Get Max Selected();


```

### [Get Menu Item State](#get-menu-item-state)

**Syntax:** 0|1|-1 = obj \<< Get Menu Item State( index )

**Description:** Gets the context menu item state of index menu item. The state will be normal (0), checked (1), or disabled (-1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Context Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
lb << Set Menu Item State( 2, -1 );
lb << Get Menu Item State( 2 );


```

### [Get Min Items](#get-min-items)

**Syntax:** obj \<< Get Min Items

**Description:** Returns the minimum number of items that are required for the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Get Min Items();


```

### [Get Modeling Type](#get-modeling-type)

**Syntax:** obj \<< Get Modeling Type

**Description:** Returns a list of modeling types for a column list box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Get Modeling Type();


```

### [Get N Lines](#get-n-lines)

**Syntax:** nlines = obj \<< Get N Lines

**Description:** Returns the number of visible lines in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Get N Lines();


```

### [Get Selected](#get-selected)

**Syntax:** list = obj \<< Get Selected(\<"Column Reference">)

**Description:** Returns a list of the selected items.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Items( {"age", "height"} );
lb << Set Selected( 2 );
Print( lb << Get Selected );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Items( {"age", "height"} );
lb << Set Selected( 2 );
Print( lb << Get Selected( "Column Reference" ) );


```

### [Get Selected Indices](#get-selected-indices)

**Syntax:** indices = obj \<< Get Selected Indices

**Description:** Returns a list of all of the selected indices.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Selected( 2 );
Print( lb << Get Selected Indices );


```

### [Get Submenu](#get-submenu)

**Syntax:** obj \<< Get Submenu( index )

**Description:** Returns the number of submenus under the given menu item

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Context Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
lb << Set Submenu( 2, 3 );
lb << Get Submenu( 2 );


```

### [Insert](#insert)

**Syntax:** obj \<< Insert( "string",index )

**Description:** Adds the specified item or list of items to the list box after the specified index.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Insert( "name", 2 );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Item Padding](#item-padding)

**Syntax:** obj \<< Item Padding( sides ); sides = obj \<< Get Item Padding

**Description:** Padding adds space between listbox item text

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Item Padding( Left( 10 ), Top( 5 ), Right( 20 ), Bottom( 10 ) );


```

### [Locate Item](#locate-item)

**Syntax:** obj \<< Locate Item

**JMP Version Added:** 14

### [Menus Enabled](#menus-enabled)

**Syntax:** obj \<< Menus Enabled( state=0|1 )

**Description:** Enables or disables the ListBoxBox menu from appearing when you right-click.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Menus Enabled( 0 );


```

### [Modeling Type](#modeling-type)

**Syntax:** obj \<< Modeling Type( {"Any","Continuous","Nominal","Ordinal","Multiple Response","Unstructured Text","Vector","None","Row State"}) > )

**Description:** Sets the accepted modeling types of columns for a column list box. The default value of "Any" will allow any column with a classic modeling type ("Continuous", "Nominal", "Ordinal").

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Modeling Type( {"Continuous"} );


```

### [On Change](#on-change)

**Syntax:** obj \<< On Change( script )

**Description:** Executes the script when the selection in the list changes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example", clb = Col List Box( all, On Change( Show( clb << Get Items ) ) ) );
Wait( 1 );
dt << Delete Column( "height" );


```

### [Remove All](#remove-all)

**Syntax:** obj \<< Remove All

**Description:** Removes all of the items.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Remove All;


```

### [Remove Item](#remove-item)

**Syntax:** obj \<< Remove Item( index )

**Description:** Removes the item specified at index.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Append( {"weight", "height", "name"} );
Wait( 1 );
lb << Remove Item( 2 );


```

### [Remove Selected](#remove-selected)

**Syntax:** obj \<< Remove Selected

**Description:** Removes the selected items.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Selected( 2 );
lb << Remove Selected();


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Case Sensitive](#set-case-sensitive)

**Syntax:** obj \<< Set Case Sensitive( "bool" )

**Description:** Determines if items added to the list box should be compared against existing items with or without respect to case

```

New Window( "Example",
    lb1 = List Box( {"First Item", "Second Item", "Third Item"}, nlines( 6 ) ),
    lb2 = List Box( {"First Item", "Second Item", "Third Item"}, nlines( 6 ) )
);
lb1 << Set Case Sensitive( 0 );
lb1 << Append( "first item" );
lb2 << Append( "first item" );


```

### [Set Context Menu Script](#set-context-menu-script)

**Syntax:** obj \<< Set Context Menu Script( {"string",script,"string",script, ...} )

**Description:** Adds a context menu with the specified options and scripts to the box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Context Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; ,
    "Get Context Menu Script", Print( lb << Get Context Menu Script )}
);


```

### [Set Data Type](#set-data-type)

**Syntax:** obj \<< Set Data Type( "Any"|"Numeric"|"Character" )

**Description:** sets the type of columns a column list box will accept to Any, Character, or Numeric

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Set Data Type( "Numeric" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when one or more items are selected.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example", lb = Col List Box( all, width( 250 ), ), Text Box( "" ) );
lb << Set Function(
    Function( {thisBox},
        (thisBox << sib) << Set Text( Char( thisBox << get selected ) )
    )
);


```

### [Set Items](#set-items)

**Syntax:** obj \<< Set Items( list )

**Description:** Sets the list of all of the items.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
Wait( 1 );
lb << Set Items( {"age", "height"} );
lb << Get Items;


```

### [Set Max Items](#set-max-items)

**Syntax:** obj \<< Set Max Items( number )

**Description:** Sets the maximum number of items that are allowed for the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Set Max Items( 4 );


```

### [Set Max Selected](#set-max-selected)

**Syntax:** obj \<< Set Max Selected( max )

**Description:** Set the maximum number of items that can be selected in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Max Selected( 1 );


```

### [Set Menu Item State](#set-menu-item-state)

**Syntax:** obj \<< Set Menu Item State( index, 0|1|-1 )

**Description:** Sets the context menu item at index to be normal (0), checked (1), or disabled (-1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Context Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
lb << Set Menu Item State( 2, -1 );


```

### [Set Min Items](#set-min-items)

**Syntax:** obj \<< Set Min Items( number )

**Description:** Sets the minimum number of items that are required for the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
slb << Set Min Items( 2 );


```

### [Set N Lines](#set-n-lines)

**Syntax:** obj \<< Set N Lines( nlines )

**Description:** Set the number of visible lines in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set N Lines( 4 );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Selected](#set-selected)

**Syntax:** obj \<< Set Selected( index|{index1, index2, ...}|"All",<selected>,\<Run Script(0|1)> )

**Description:** Sets the item at index to be selected (1) or deselected (0). By default, this message runs the script for its ListBoxBox. Use RunScript(0) to suppress running the script. Using the RunScript option also requires specifying the selected argument, as the arguments are positional.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Selected( 2, 1 );
Print( lb << Get Selected );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Max Selected( -1 );
lb << Set Selected( "All", 1 );
Print( lb << Get Selected );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Max Selected( -1 );
selList = {3, 1};
lb << Set Selected( selList, 1 );
Print( lb << Get Selected );


```

### [Set Size](#set-size)

**Syntax:** obj \<< Set Size( width,height )

**Description:** Sets the width and height of the ListBoxBox.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Size( 150, 400 );


```

### [Set Submenu](#set-submenu)

**Syntax:** obj \<< Set Submenu( index, submenu count )

**Description:** Turns the "index" menu item into a submenu with "submenu count" menu items

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Context Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
lb << Set Submenu( 2, 3 );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Set Tips](#set-tips)

**Syntax:** obj \<< Set Tips( List of tips )

**Description:** Sets tips for individual items in the listbox.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Col List Box Example",
    lb = fontobj = Col List Box( all, width( 250 ), maxSelected( 1 ) ),
    slb = Col List Box()
);
lb << Set Tips( {"Tip 1", "Tip 2", "Tip 3"} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ColSpanBox](#colspanbox)

## [Associated Constructors](#associated-constructors)

### [Col Span Box](#col-span-box)

**Syntax:** y = Col Span Box( title, children )

**Description:** Creates a column that places a single header over one or more child columns within a Table Box.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
Print( col << Get );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Get Font;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
Print( col << Get Heading() );


```

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "test",
    Table Box(
        col = Col Span Box(
            "Col Span",
            String Col Box( "col 1", {"A", "B", "C"} ),
            Number Col Box( "col2", {1, 2, 3} )
        )
    )
);
col << Set Heading( "New Column Header" );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( <list> )

**Description:** Sets the values from a list.

```

New Window( "Example", scb = String Col Box( "Associated Text", {"a", "b", "c", "d", "e"} ) );
scb << Set Values( {"A", "B", "C", "D", "E"} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ColStackBox](#colstackbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ColorBox](#colorbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ColumnFieldBox](#columnfieldbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ComboBox](#combobox)

## [Associated Constructors](#associated-constructors)

### [Combo Box](#combo-box)

**Syntax:** y = Combo Box( {item \<( tipstr )>, ...}, <script> )

**Description:** Returns a display box showing a drop down list of text items. Each item in the combo box can have an optional tooltip that is specified as a string inside of parentheses following the item text string. The optional Editable argument allows editing the combo text.

**Example 1**

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);


```

**Example 2**

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        Editable,
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);


```

## [Item Messages](#item-messages)

### [Append Item](#append-item)

**Syntax:** obj \<< Append Item( string )

**Description:** Adds a new string to the end of the list of combo box items

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
Wait( 2 );
cb << Append Item( "Four" );


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Enable Item](#enable-item)

**Syntax:** obj \<< Enable Item( index, 0|1 )

**Description:** Sets the item at the index to be selectable (1) or unselectable (0).

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
cb << Enable Item( 2, 0 );


```

### [Get](#get)

**Syntax:** index = obj \<< Get

**Description:** Returns the index of the selected item.

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
cb << Set( 2 );
Print( cb << Get );


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Items](#get-items)

**Syntax:** list = obj \<< Get Items

**Description:** Returns a list of all of the items.

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
Print( cb << Get Items );


```

### [Get Selected](#get-selected)

**Syntax:** obj \<< Get Selected

**Description:** Returns a string of the selected item.

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
cb << Set( 3 );
Print( cb << Get Selected );


```

### [Insert Item](#insert-item)

**Syntax:** obj \<< Insert Item( string, <position> )

**Description:** Insert a new string at the end of the list, or in the place indicated by the optional position.

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
Wait( 1 );
cb << Insert Item( "Two and a half", 3 );
cb << Insert Item( "Zero", 1 );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Item Enabled](#item-enabled)

**Syntax:** 0|1 = obj \<< Item Enabled( index )

**Description:** Returns if the item at the index is selectable (1) or unselectable(0).

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
cb << Enable Item( 3, 0 );
Print( cb << Item Enabled( 3 ) );


```

### [Remove Item](#remove-item)

**Syntax:** obj \<< Remove Item( index )

**Description:** Removes the item specified at index.

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
Wait( 2 );
cb << Remove Item( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( index,\<run script(0|1)> )

**Description:** Sets the Combo Box to the item at the given index.

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
cb << Set( 2 );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, index}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when a new combo box item is selected.

**JMP Version Added:** 14

```

New Window( "Example",
    Combo Box(
        {"One", "Two", "Three"},
        <<SetFunction(
            Function( {thisBox, index},
                {lb},
                lb = thisBox << sib;
                ((lb << child) << sib) << Set Text( Char( index ) );
                ((((lb << child) << sib) << sib) << sib) <<
                Set Text( Char( thisBox << get selected ) );
            )
        )
    ),
    Lineup Box( N Col( 2 ),
        Text Box( "Index Selected: " ),
        Text Box( "" ),
        Text Box( "Item Selected: " ),
        Text Box( "" )
    )
);


```

### [Set Items](#set-items)

**Syntax:** obj \<< Set Items( list )

**Description:** Sets the list of all of the items.

```

New Window( "Example",
    cb = Combo Box(
        {"One", "Two", "Three"},
        selection = cb << GetSelected();
        Print( "Selected: " || selection );
    )
);
Wait( 2 );
cb << Set Items( {"Four", "Five", "Six"} );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [CompositionBox](#compositionbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ContourSeg](#contourseg)

## [Associated Constructors](#associated-constructors)

### [Contour Seg](#contour-seg)

**Syntax:** me = Contour Seg( Triangulation, [ levels ], < zColor([colors], \<Cycle Colors|Interpolate Colors>) >, \<Fill|Fill Between|Fill Below|Fill Above>, < Transparency([] | t) >

**Description:** Returns a display seg representing contours of a Triangulation. Optional colors can be specified for each level as a matrix or list. The transparency can be specified as a number or matrix.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Fill Color( "Green" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Frame;


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Get Base Font;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fill](#get-fill)

**Syntax:** fill = obj \<< Get Fill

**Description:** Returns the fill option for the contours.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Fill( "Fill Below" );
seg << Get Fill();


```

### [Get Fill Color](#get-fill-color)

**Syntax:** color = obj \<< Get Fill Color

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Fill Color;


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Fill Pattern;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Gradient Transparency;


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Line Width;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Marker Size;


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Get Text Color

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Text Color;


```

### [Get Text Style](#get-text-style)

**Syntax:** obj \<< Get Text Style

**Description:** Gets how the text is drawn with respect to the cursor pen.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Get Text Style;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 (clear) and 1 (opaque).

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Get Transparency;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Gradient Transparency( "None" );


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Parent;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Revert;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Fill](#set-fill)

**Syntax:** obj \<< Set Fill( "Lines"|"Fill Above"|"Fill Between"|"Fill Below" )

**Description:** Set the fill option for the contours.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
Wait( 2 );
seg << Set Fill( "Fill Below" );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Text Color](#set-text-color)

**Syntax:** obj \<< Set Text Color( color )

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Text Color( "Green" );


```

### [Set Text Style](#set-text-style)

**Syntax:** obj \<< Set Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Transparency( .3 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color )

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Text Color( "Green" );


```

### [Text Style](#text-style)

**Syntax:** obj \<< Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Cities.jmp" );
tri = Triangulation( X( :X, :Y ), Y( :POP ) );
{xx, yy} = tri << Get Points();
New Window( "Contour Seg Example",
    g = Graph Box(
        X Scale( Min( xx ) - .1, Max( xx ) + .1 ),
        Y Scale( Min( yy ) - .1, Max( yy ) + .1 ),
        Contour Seg(
            tri,
            [0, 400, 1000, 2000, 9000],
            zColor( 5 + [64 32 0 16 48] ),
            Transparency( [1, 1, 1, 1, 1] )
        ),
        Shape Seg( {Path( tri << Get Hull Path() )}, <<Set Color( "Black" ) )
    )
);
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Contour Seg( 1 ) ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [CrosstabBox](#crosstabbox)

## [Item Messages](#item-messages)

### [Format](#format)

**Syntax:** obj \<< Format( element, Format( format, <options> ) )

**Description:** Sets the format for the given CrossTabBox element

```

Open( "$SAMPLE_DATA/Alcohol.jmp" );
c = Contingency(
    Y( :Relapsed ),
    X( :Alcohol Consumption ),
    Freq( :Count ),
    Contingency Table(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 ),
        Col Cum( 0 ),
        Col Cum %( 0 ),
        Row Cum( 0 ),
        Row Cum %( 0 )
    )
);
cr = c << report;
ctb = cr[CrosstabBox( 1 )];
ctb << Format( "Col %", Format( "Fixed Dec", 7, 1 ) );


```

### [Get As Matrix](#get-as-matrix)

**Syntax:** matrix = obj \<< Get As Matrix

**Description:** Returns a matrix of the values in the CrossTabBox.

```

Open( "$SAMPLE_DATA/Alcohol.jmp" );
c = Contingency(
    Y( :Relapsed ),
    X( :Alcohol Consumption ),
    Freq( :Count ),
    Contingency Table(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 ),
        Col Cum( 0 ),
        Col Cum %( 0 ),
        Row Cum( 0 ),
        Row Cum %( 0 )
    )
);
cr = c << report;
ctb = cr[CrosstabBox( 1 )];
Print( ctb << Get As Matrix );


```

### [Make Into Data Table](#make-into-data-table)

**Syntax:** obj \<< Make Into Data Table( \<Invisible(bool) | Private(bool)> )

**Description:** Creates a new data table that contains the values in the CrossTabBox.

**Example 1**

```

Open( "$SAMPLE_DATA/Alcohol.jmp" );
c = Contingency(
    Y( :Relapsed ),
    X( :Alcohol Consumption ),
    Freq( :Count ),
    Contingency Table(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 ),
        Col Cum( 0 ),
        Col Cum %( 0 ),
        Row Cum( 0 ),
        Row Cum %( 0 )
    )
);
cr = c << report;
ctb = cr[CrosstabBox( 1 )];
ctb << Make Into Data Table;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Alcohol.jmp" );
c = Contingency(
    Y( :Relapsed ),
    X( :Alcohol Consumption ),
    Freq( :Count ),
    Contingency Table(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 ),
        Col Cum( 0 ),
        Col Cum %( 0 ),
        Row Cum( 0 ),
        Row Cum %( 0 )
    )
);
cr = c << report;
ctb = cr[CrosstabBox( 1 )];
ctb << Make Into Data Table( invisible( 1 ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [CustomBox](#custombox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [DFIntMinMaxBox](#dfintminmaxbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [DataBrowserBox](#databrowserbox)

## [Associated Constructors](#associated-constructors)

### [New Data Box](#new-data-box)

**Syntax:** New Data Box

**Description:** Makes a data table view in a display box tree. Changes the current data table to the given data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);


```

## [Item Messages](#item-messages)

### [Close Data Grid](#close-data-grid)

**Syntax:** obj \<< Close Data Grid( state=0|1 )

**Description:** Close or open the data table grid.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Close Data Grid( 1 );


```

### [Close Side Panels](#close-side-panels)

**Syntax:** obj \<< Close Side Panels( state=0|1 )

**Description:** Close or open the data table's side panels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Close Side Panels( 1 );


```

### [Close summary panels](#close-summary-panels)

**Syntax:** obj \<< Close summary panels( state=0|1 )

**Description:** Close or open the data table's summary panels.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Close Summary Panels( 0 );


```

### [Get Cell Height](#get-cell-height)

**Syntax:** obj \<< Get Cell Height

**Description:** Get a row's display height.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Get Cell Height;


```

### [Get Close Data Grid](#get-close-data-grid)

**Syntax:** obj \<< Get Close Data Grid

**Description:** Returns the closed state of the data table grid.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Close Data Grid( 1 );
Show( dg << Get Close Data Grid );


```

### [Get Close Side Panels](#get-close-side-panels)

**Syntax:** obj \<< Get Close Side Panels

**Description:** Returns the closed state of the data tables's side panels.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Close Side Panels( 1 );
Show( dg << Get Close Side Panels );


```

### [Get Close Summary Panels](#get-close-summary-panels)

**Syntax:** obj \<< Get Close Summary Panels

**Description:** Returns the closed state of the data tables's summary panels.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Close Summary Panels( 0 );
Show( dg << Get Close Summary Panels );


```

### [Get Data Table](#get-data-table)

**Syntax:** obj \<< Get Data Table

**Description:** returns the data table for this display box

```


dt1 = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
dt2 = Open( "$SAMPLE_DATA/Animals.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt1 << New Data Box(),
        dt1 << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Get Data Table;


```

### [Get Header Height](#get-header-height)

**Syntax:** obj \<< Get Header Height

**Description:** Get column header's display height

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Get Header Height;


```

### [Get Row ID Width](#get-row-id-width)

**Syntax:** obj \<< Get Row ID Width

**Description:** Get row ID area's display width

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Get Row ID Width;


```

### [Set Cell Height](#set-cell-height)

**Syntax:** obj \<< Set Cell Height( number )

**Description:** Set column header's display height

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Set Cell Height( 20 );


```

### [Set Data Table](#set-data-table)

**Syntax:** obj \<< Set Data Table( dt )

**Description:** sets the data table for this display box

```


dt1 = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
dt2 = Open( "$SAMPLE_DATA/Animals.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt1 << New Data Box(),
        dt1 << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Set Data Table( dt2 );
dg << Get Data Table;


```

### [Set Header Height](#set-header-height)

**Syntax:** obj \<< Set Header Height( number )

**Description:** Set column header's display height

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Set Header Height( 20 );


```

### [Set Row ID Width](#set-row-id-width)

**Syntax:** obj \<< Set Row ID Width( number )

**Description:** Set row ID area's display width

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Set Row ID Width( 80 );


```

### [Show Header Filter Icons](#show-header-filter-icons)

**Syntax:** obj \<< Show Header Filter Icons( state=0|1 )

**Description:** Show or hide the filter icons on columns in the current filter view.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Show Header Filter Icons( 1 );


```

### [Show Header Graphs](#show-header-graphs)

**Syntax:** obj \<< Show Header Graphs( state=0|1 )

**Description:** Show or hide the header graphs in the data table display.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Show Header Graphs( 1 );


```

### [Show Header Groups](#show-header-groups)

**Syntax:** obj \<< Show Header Groups( state=0|1 )

**Description:** Show or hide the column groups in the data table display.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Show Header Groups( 1 );


```

### [Show Header Statistics](#show-header-statistics)

**Syntax:** obj \<< Show Header Statistics( state=0|1 )

**Description:** Show or hide the header statistics in the data table display.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Show Header Statistics( 1 );


```

### [Show Header Tags](#show-header-tags)

**Syntax:** obj \<< Show Header Tags( state=0|1 )

**Description:** Show or hide the column tags in the data table display.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp", invisible );
New Window( "School",
    H List Box(
        dg = dt << New Data Box(),
        Text Box(),
        dt << Distribution( ContinuousDistribution( Column( :weight ) ) )
    )
);
dg << Show Header Tags( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [DataColumnNameBox](#datacolumnnamebox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [DataEditBox](#dataeditbox)

## [Item Messages](#item-messages)

### [Blink](#blink)

**Syntax:** obj \<< Blink

**Description:** Blinks the row displayed in the Data Edit Box.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dataedit = win[Data Edit Box( 1 )];
dataedit << Blink;


```

### [Find](#find)

**Syntax:** obj \<< Find( search term )

**Description:** Shows the row found by the inputted search term.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dataedit = win[Data Edit Box( 1 )];
dataedit << Find( Contains( :State, "North Carolina" ) );


```

### [Go to row](#go-to-row)

**Syntax:** obj \<< Go to row( row )

**Description:** Shows the inputted row in the Data Edit Box.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dataedit = win[Data Edit Box( 1 )];
dataedit << Go To Row( 23 );


```

### [New Row](#new-row)

**Syntax:** obj \<< New Row

**Description:** Creates a new row in the data table and shows that row in the Data Edit Box.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dataedit = win[Data Edit Box( 1 )];
dataedit << New Row;


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Show the next selected row in the Data Edit Box.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dataedit = win[Data Edit Box( 1 )];
dataedit << Next;


```

### [Next Selected](#next-selected)

**Syntax:** obj \<< Next Selected

**Description:** From the rows selected, show the next selected row in the Data Edit Box.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dt << Select Where( dt:population > 10000000 );
dataedit = win[Data Edit Box( 1 )];
dataedit << Next Selected;


```

### [Prev](#prev)

**Syntax:** obj \<< Prev

**Description:** Show the previous selected row in the Data Edit Box.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dataedit = win[Data Edit Box( 1 )];
dataedit << Go To Row( 23 );
dataedit << Prev;


```

### [Prev Selected](#prev-selected)

**Syntax:** obj \<< Prev Selected

**Description:** From the rows selected, show the previous selected row in the Data Edit Box.

```

dt = Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dt << Select Where( dt:population > 10000000 );
dataedit = win[Data Edit Box( 1 )];
dataedit << Prev Selected;


```

### [Save](#save)

**Syntax:** obj \<< Save

**Description:** Saves the row values in the Data Edit Box to the data table.

```


dt = Open( "$SAMPLE_DATA/SAT.jmp" );
dt << Save( "$TEMP/SAT.jmp" );
New Window( "Example",
    cp = dt << Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y( :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Row Editor;
win = Window( "Row Editor for SAT" );
dataedit = win[Data Edit Box( 1 )];
dataedit << New Row;
dataedit << Save;


```

# [DataFilterContextBox](#datafiltercontextbox)

## [Associated Constructors](#associated-constructors)

### [Data Filter Context Box](#data-filter-context-box)

**Syntax:** y = Data Filter Context Box( displayBox )

**Description:** Returns a display box that defines the extent of the local data filters contained in a display tree. Data filters and Data Filter Context Boxes can be arranged in a hierarchy and will be shared among platforms or boxes contained within the Data Filter Context Boxes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Shared Local Filter",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter( Local, Add Filter( columns( :sex ), Where( :sex == "F" ) ) ),
            dt << Bubble Plot(
                X( :weight ),
                Y( :height ),
                Fit To Window( "On" ),
                Sizes( :age ),
                Title Position( 0, 0 )
            ),
            dt << Graph Builder(
                Size( 525, 456 ),
                Show Control Panel( 0 ),
                Fit To Window( "On" ),
                Variables( X( :weight ), Y( :age ) ),
                Elements( Box Plot( X, Y, Legend( 4 ) ) ), 

            )
        )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [DataFilterSourceBox](#datafiltersourcebox)

## [Associated Constructors](#associated-constructors)

### [Data Filter Source Box](#data-filter-source-box)

**Syntax:** y = Data Filter Source Box( displayBox )

**Description:** Returns a display box that defines the source of a selection filter. Selected rows in reports contained by the Data Filter Source Box will be included for analysis in the other reports contained within a common Data Filter Context Box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Selection Filter",
    Data Filter Context Box(
        H List Box(
            dfsb = Data Filter Source Box(
                Graph Builder(
                    Size( 208, 207 ),
                    Show Control Panel( 0 ),
                    Show Legend( 0 ),
                    Variables( X( :age ) ),
                    Elements( Bar( X, Legend( 3 ) ) ),
                    SendToReport(
                        Dispatch( {}, "Graph Builder", OutlineBox, {Set Title( "Filter" )} )
                    )
                )
            ),
            Platform(
                Current Data Table(),
                Bubble Plot(
                    X( :weight ),
                    Y( :height ),
                    Sizes( :age ),
                    Title Position( 0, 0 )
                )
            )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Get Filter](#get-filter)

**Syntax:** obj \<< Get Filter

### [Set Row States](#set-row-states)

**Syntax:** obj \<< Set Row States( dt, rs )

**Description:** Sets the row states for the given data table within the filter. Selections made in this row state will not be linked with the data table, but will be included in the reports linked to the selection filter.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Selection Filter",
    Data Filter Context Box(
        H List Box(
            dfsb = Data Filter Source Box(
                Graph Builder(
                    Size( 208, 207 ),
                    Show Control Panel( 0 ),
                    Show Legend( 0 ),
                    Variables( X( :age ) ),
                    Elements( Bar( X, Legend( 3 ) ) ),
                    SendToReport(
                        Dispatch( {}, "Graph Builder", OutlineBox, {Set Title( "Filter" )} )
                    )
                )
            ),
            Platform(
                Current Data Table(),
                Bubble Plot(
                    X( :weight ),
                    Y( :height ),
                    Sizes( :age ),
                    Title Position( 0, 0 )
                )
            )
        )
    )
);
Wait( 1 );
rs = dt << Get Row States();
rows14 = dt << Get Rows Where( :age == 14 );
rs[rows14] = 1;
dfsb << Set Row States( dt, rs );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [DataTableColBox](#datatablecolbox)

## [Associated Constructors](#associated-constructors)

### [Data Table Col Box](#data-table-col-box)

**Syntax:** y = Data Table Col Box( col )

**Description:** Returns a display box that displays a column from a data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Print( col << Get );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Data Table Column](#get-data-table-column)

**Syntax:** data table column = obj \<< Get Data Table Column

**Description:** Returns a reference to the data table column that corresponds to this table box column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
(nw[Data Table Col Box( 2 )] << Get Data Table Column()) << Get Name();


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Font;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Print( col << Get Heading() );


```

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Data Table Column](#set-data-table-column)

**Syntax:** obj \<< Set Data Table Column( data table column )

**Description:** Sets the data table column that corresponds to this table box column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
nw[Data Table Col Box( 2 )] << Set Data Table Column( :height );


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( col = Data Table Col Box( :name ), Data Table Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Heading( "New Column Header" );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( <list> )

**Description:** Sets the values from a list.

```

New Window( "Example", scb = String Col Box( "Associated Text", {"a", "b", "c", "d", "e"} ) );
scb << Set Values( {"A", "B", "C", "D", "E"} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [DataTablePlotColBox](#datatableplotcolbox)

## [Associated Constructors](#associated-constructors)

### [Data Table Plot Col Box](#data-table-plot-col-box)

**Syntax:** y = Data Table Plot Col Box( col )

**Description:** Returns a display box that displays a column from a data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Dot](#dot)

**Syntax:** obj \<< Dot

**Description:** Shows a dot rather than a bar.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Dot( 1 );


```

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Print( col << Get );


```

### [Get As Matrix](#get-as-matrix)

**Syntax:** matrix = obj \<< Get As Matrix

**Description:** Returns the values in a matrix, specifically a column vector.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Print( pcb << Get As Matrix );


```

### [Get Axis Position](#get-axis-position)

**Syntax:** "Default"|"Top"|"Bottom" = obj \<< Get Axis Position

**Description:** Get the axis position for the plot col. The default is for it to sometimes show on the top depending on the scale and title.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Axis Position( "Bottom" );
pcb << Get Axis Position();


```

### [Get Bar Color](#get-bar-color)

**Syntax:** obj \<< Get Bar Color

**Description:** Get the color of the plot bars

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Bar Color( "White" );
Color To RGB( pcb << Get Bar Color );


```

### [Get Bar Select Color](#get-bar-select-color)

**Syntax:** obj \<< Get Bar Select Color

**Description:** Get the color of the plot bars when in a selected row

```

New Window( "Example",
    tb = Table Box( pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
tb << Set Selectable Rows();
pcb << Set Bar Select Color( "White" );
Color To RGB( pcb << Get Bar Select Color );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Data Table Column](#get-data-table-column)

**Syntax:** data table column = obj \<< Get Data Table Column

**Description:** Returns a reference to the data table column that corresponds to this table box column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
(pcb << Get Data Table Column()) << Get Name();


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Get Font;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Print( col << Get Heading() );


```

### [Get Labels](#get-labels)

**Syntax:** list = obj \<< Get Labels

**Description:** Returns the labels for each row.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Labels( :name );
pcb << Get Labels();


```

### [Get primary interval line properties](#get-primary-interval-line-properties)

**Syntax:** {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } = obj \<< Get primary interval line properties

### [Get secondary interval line properties](#get-secondary-interval-line-properties)

**Syntax:** {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } = obj \<< Get secondary interval line properties

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Lower](#lower)

**Syntax:** obj \<< Lower( data table column )

**Description:** Lower limit draws a curve at the points specified.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
dt << New Column( "Lower", Formula( :height - 5 ) );
pcb << Lower( :Lower );


```

### [Lower2](#lower2)

**Syntax:** obj \<< Lower2( list|matrix )

**Description:** Lower limit draws a curve at the points specified.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
dt << New Column( "Lower", Formula( :height - 5 ) );
dt << New Column( "Lower2", Formula( :height - 10 ) );
pcb << Lower( :Lower );
pcb << Lower2( :Lower2 );


```

### [Marks](#marks)

**Syntax:** obj \<< Marks

**Description:** Shows markers at the limits of each value.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Marks( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Axis](#set-axis)

**Syntax:** obj \<< Set Axis( \<Format(format)>, \<Inc(number)>, \<Max(number)>, \<Min(number)>, \<Minor Grid Line Color(color)>, \<Minor Ticks(number)>, \<Scale(scale type)>, \<Show Labels(state=0|1)>, \<Show Major Grid(state=0|1)>, \<Show Major Grid Labels (state=0|1)>,\<Show Major Grid Ticks (state=0|1)>, , \<Show Minor Grid(state=0|1)>, \<Show Minor Grid Labels (state=0|1)>,\<Show Minor Grid Ticks (state=0|1)>, \<Tick Label List({labels}, {Values})>, \<Tick Font(font)>, \<Add Ref Line\<(value, < "Solid|Dashed|Double">, <Color>, \<"label">, <line width>, <transparency>)> )

**Description:** Configures the PlotColBox's axis. For more details see AxisBox.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Axis( Min( 0 ), Max( 100 ), Scale( "Log", {Log Base( 2 )} ), Minor Ticks( 1 ), );


```

### [Set Axis Position](#set-axis-position)

**Syntax:** obj \<< Set Axis Position( "Default"|"Top"|"Bottom" )

**Description:** Set the axis for the plot col to always be on top or bottom. The default is for it to sometimes show on the top depending on the scale and title.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Axis Position( "Bottom" );
Wait( 1 );
pcb << Set Axis Position( "Top" );
Wait( 1 );
pcb << Set Axis Position( "Default" );


```

### [Set Bar Color](#set-bar-color)

**Syntax:** obj \<< Set Bar Color( color )

**Description:** Set the color of the plot bars

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Bar Color( "White" );


```

### [Set Bar Select Color](#set-bar-select-color)

**Syntax:** obj \<< Set Bar Select Color( color )

**Description:** Set the color of the plot bars when in a selected row

```

New Window( "Example",
    tb = Table Box( pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
tb << Set Selectable Rows();
tb << Set Selected Rows( [1, 4] );
pcb << Set Bar Select Color( "White" );


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Data Table Column](#set-data-table-column)

**Syntax:** obj \<< Set Data Table Column( data table column )

**Description:** Sets the data table column that corresponds to this table box column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Data Table Column( :weight );


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
col << Set Heading( "New Column Header" );


```

### [Set Labels](#set-labels)

**Syntax:** obj \<< Set Labels( data table column )

**Description:** Sets the labels for each row.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Labels( :name );


```

### [Set Plot Style](#set-plot-style)

**Syntax:** obj \<< Set Plot Style( "Default"|"Bar"|"Interval" )

**Description:** Changes the visual representation of the plot column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
dt << New Column( "Lower", Formula( :height - 5 ) );
dt << New Column( "Upper", Formula( :height + 5 ) );
pcb << Lower( :Lower );
pcb << Upper( :Upper );
pcb << Set Plot Style( "Interval" );


```

### [Set Reference Line](#set-reference-line)

**Syntax:** obj \<< Set Reference Line( number )

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
dt << New Column( "Lower", Formula( :height - 5 ) );
dt << New Column( "Upper", Formula( :height + 5 ) );
pcb << Lower( :Lower );
pcb << Upper( :Upper );
pcb << Set Plot Style( "Interval" );
pcb << Set Reference Line( 60 );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Scale](#set-scale)

**Syntax:** obj \<< Set Scale( minimum, maximum, <format name>, <width> | \<width, decimal places>, < "Use thousands separator"> )

**Description:** Sets the minimum and maximum scale of the PlotColBox. The format parameters specify a format that is only used if the first two parameters are 0 and 1.

#### [Format](#format)

```


dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
(obj << xpath( "//PlotColBox" )) << Set Scale( 0, 1, "Percent" );


```

#### [Scale](#scale)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Scale( 0, 100 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( <list> )

**Description:** Sets the values from a list.

```

New Window( "Example", scb = String Col Box( "Associated Text", {"a", "b", "c", "d", "e"} ) );
scb << Set Values( {"A", "B", "C", "D", "E"} );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width (in pixels) of the PlotColBox.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
pcb << Set Width( 300 );


```

### [Set primary interval line properties](#set-primary-interval-line-properties)

**Syntax:** obj \<< Set primary interval line properties( {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } )

### [Set secondary interval line properties](#set-secondary-interval-line-properties)

**Syntax:** obj \<< Set secondary interval line properties( {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } )

### [Significance](#significance)

**Syntax:** obj \<< Significance( data table column )

**Description:** Used to size the marker when the plot col is in interval mode.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
dt << New Column( "Sig", Formula( Row() ) );
pcb << Significance( :Sig );
pcb << Set Plot Style( "Interval" );


```

### [Upper](#upper)

**Syntax:** obj \<< Upper( data table column )

**Description:** Upper limit draws a curve at the points specified. A lower limit must first be specified.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
dt << New Column( "Lower", Formula( :height - 5 ) );
dt << New Column( "Upper", Formula( :height + 5 ) );
pcb << Lower( :Lower );
pcb << Upper( :Upper );


```

### [Upper2](#upper2)

**Syntax:** obj \<< Upper2( list|matrix )

**Description:** Upper limit draws a curve at the points specified. A lower limit must first be specified.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
nw = New Window( "Example",
    Table Box( Data Table Col Box( :name ), col = pcb = Data Table Plot Col Box( :height ) )
);
nw[Table Box( 1 )] << set scrollable( 10, 0 );
dt << New Column( "Lower", Formula( :height - 5 ) );
dt << New Column( "Upper", Formula( :height + 5 ) );
dt << New Column( "Lower2", Formula( :height - 10 ) );
dt << New Column( "Upper2", Formula( :height + 10 ) );
pcb << Lower( :Lower );
pcb << Lower2( :Lower2 );
pcb << Upper( :Upper );
pcb << Upper2( :Upper2 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_2)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Design Box](#design-box)

## [Item Messages](#item-messages)

### [Get Module Type](#get-module-type)

**Syntax:** type = obj \<< Get Module Type

**Description:** Returns the type of the module (Dialog, Dialog with Menu, Launcher).

**JMP Version Added:** 15

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title

**Description:** Sets the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Title( "New Title" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Display3DBox](#display3dbox)

## [Associated Constructors](#associated-constructors)

### [Graph 3D Box](#graph-3d-box)

**Syntax:** y = Graph 3D Box()

**Description:** Sends display commands to the 3D plot.

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );


```

## [Item Messages](#item-messages)

### [Add Ellipsoid](#add-ellipsoid)

**Syntax:** obj \<< Add Ellipsoid( 4x4 matrix ) obj \<< Add Ellipsoid(3x3 cov,3x1 means) obj \<< Add Ellipsoid(3x3 corr,3x1 means,3x1 std dev)

**Description:** Draws an ellipsoid on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D(
    Add Ellipsoid(
        [1 0.42632 0.85183, 0.42632 1 0.34418, 0.85183 0.34418 1],
        [6.55099 2.96919 5.5066],
        [0.57829 0.29087 0.53668]
    )
);


```

### [Add Markers](#add-markers)

**Syntax:** obj \<< Add Markers( [ nx1 X matrix ], [ nx1 Y matrix ], [ nx1 Z matrix ] )

**Description:** Draws n markers on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Add Markers( [2 3 4], [5 6 7], [1 8 9] ) );


```

### [Add Vector](#add-vector)

**Syntax:** obj \<< Add Vector( [ 3xn from matrix ], [ 3xn to matrix ], FromCap( CutOff|Sphere|Point|Feather ), ToCap( CutOff|Sphere|Point|Feather ), Facets( Triangle|Square|Round ), Shaft Color( color ), Shaft Thickness( number ), From Thickness( number ), To Thickness( number ), From Color( number ), To Color( number ) ) )

**Description:** Draws a vector or arrow on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Add Vector( [4.5 2 1], [7.5 4 6], FromCap( "Feather" ), ToCap( "Point" ) ) );


```

### [Get Axes](#get-axes)

**Syntax:** obj \<< Get Axes

**Description:** Returns the state of displaying the axes on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Axes );
Show( s );


```

### [Get Box](#get-box)

**Syntax:** obj \<< Get Box

**Description:** Returns the state of displaying the box frame on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Box );
Show( s );


```

### [Get Grab Handles](#get-grab-handles)

**Syntax:** obj \<< Get Grab Handles

**Description:** Returns the state of displaying the grab handles on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Box );
Show( s );


```

### [Get Graph Size](#get-graph-size)

**Syntax:** obj \<< Get Graph Size

**Description:** Returns the size of the graph.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Graph Size );
Show( s );


```

### [Get Grids](#get-grids)

**Syntax:** obj \<< Get Grids

**Description:** Returns the state of displaying the grids on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Grids );
Show( s );


```

### [Get Hide Lights Border](#get-hide-lights-border)

**Syntax:** obj \<< Get Hide Lights Border

**Description:** Returns the state of the lights border around the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
state = obj << Frame3D( Get Hide Lights Border );
Show( state );


```

### [Get Line Scale](#get-line-scale)

**Syntax:** obj \<< Get Line Scale

**Description:** Returns the line width for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
w = obj << Frame3D( Get Line Scale );
Show( w );


```

### [Get Marker Quality](#get-marker-quality)

**Syntax:** obj \<< Get Marker Quality

**Description:** Returns the marker characteristics such as shape and shade for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
q = obj << Frame3D( Get Marker Quality );
Show( q );


```

### [Get Marker Scale](#get-marker-scale)

**Syntax:** obj \<< Get Marker Scale

**Description:** Returns the marker size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Marker Scale );
Show( s );


```

### [Get Marker Transparency](#get-marker-transparency)

**Syntax:** obj \<< Get Marker Transparency

**Description:** Returns the marker transparency for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
t = obj << Frame3D( Get Marker Transparency );
Show( t );


```

### [Get Rotation](#get-rotation)

**Syntax:** obj \<< Get Rotation

**Description:** Returns the current rotation for the frame.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
r = obj << Frame3D( Get Rotation() );
Show( r );


```

### [Get Text Scale](#get-text-scale)

**Syntax:** obj \<< Get Text Scale

**Description:** Returns the text size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Text Scale );
Show( s );


```

### [Get View Ortho](#get-view-ortho)

**Syntax:** obj \<< Get View Ortho

**Description:** Returns the state of the orthographic view for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
o = obj << Frame3D( Get View Ortho );
Show( o );


```

### [Get View Perspective](#get-view-perspective)

**Syntax:** obj \<< Get View Perspective

**Description:** Returns the view perspective for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
p = obj << Frame3D( Get View Perspective );
Show( p );


```

### [Get View Zoom](#get-view-zoom)

**Syntax:** obj \<< Get View Zoom

**Description:** Returns the current zoom for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
z = obj << Frame3D( Get View Zoom );
Show( z );


```

### [Get Wall Color](#get-wall-color)

**Syntax:** obj \<< Get Wall Color

**Description:** Returns the wall color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get Wall Color );
Show( c );


```

### [Get Walls](#get-walls)

**Syntax:** obj \<< Get Walls

**Description:** Returns the state of displaying the walls on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
s = obj << Frame3D( Get Walls );
Show( s );


```

### [Get X Axis Color](#get-x-axis-color)

**Syntax:** obj \<< Get X Axis Color

**Description:** Returns the x axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get X Axis Color );
Show( c );


```

### [Get X Axis Label](#get-x-axis-label)

**Syntax:** obj \<< Get X Axis Label

**Description:** Returns the label for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
label = obj << Frame3D( Get X Axis Label );
Show( label );


```

### [Get Y Axis Color](#get-y-axis-color)

**Syntax:** obj \<< Get Y Axis Color

**Description:** Returns the y axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get Y Axis Color );
Show( c );


```

### [Get Y Axis Label](#get-y-axis-label)

**Syntax:** obj \<< Get Y Axis Label

**Description:** Returns the label for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
label = obj << Frame3D( Get Y Axis Label );
Show( label );


```

### [Get Z Axis Color](#get-z-axis-color)

**Syntax:** obj \<< Get Z Axis Color

**Description:** Returns the z axis color for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Get Z Axis Color );
Show( c );


```

### [Get Z Axis Label](#get-z-axis-label)

**Syntax:** obj \<< Get Z Axis Label

**Description:** Returns the label for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
label = obj << Frame3D( Get Z Axis Label );
Show( label );


```

### [Set Axes](#set-axes)

**Syntax:** obj \<< Set Axes( state=0|1 )

**Description:** Shows or hides the x, y, and z axes on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Axes( 1 ) );


```

### [Set Box](#set-box)

**Syntax:** obj \<< Set Box( state=0|1 )

**Description:** Shows or hides the box frame on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Box( 1 ) );


```

### [Set Graph Size](#set-graph-size)

**Syntax:** obj \<< Set Graph Size( x, y )

**Description:** Sets the size of the graph.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Graph Size( 700, 800 ) );


```

### [Set Grids](#set-grids)

**Syntax:** obj \<< Set Grids( state=0|1 )

**Description:** Shows or hides the grids on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Grids( 1 ) );


```

### [Set Hide Lights Border](#set-hide-lights-border)

**Syntax:** obj \<< Set Hide Lights Border( state=0|1 )

**Description:** Hides or displays the lights border around the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ) );


```

### [Set Line Scale](#set-line-scale)

**Syntax:** obj \<< Set Line Scale( number )

**Description:** Sets the line width for the grid on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Line Scale( 6.5 ) );


```

### [Set Marker Quality](#set-marker-quality)

**Syntax:** obj \<< Set Marker Quality( number )

**Description:** Sets the marker characteristics such as shape and shade for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Marker Scale( 3 ), Set Marker Quality( 0.2625 ) );


```

### [Set Marker Scale](#set-marker-scale)

**Syntax:** obj \<< Set Marker Scale( number )

**Description:** Sets the marker size for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Marker Scale( 3.5 ) );


```

### [Set Marker Transparency](#set-marker-transparency)

**Syntax:** obj \<< Set Marker Transparency( fraction )

**Description:** Sets the marker transparency for the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Marker Transparency( 0.4125 ) );


```

### [Set Oscillation](#set-oscillation)

**Syntax:** obj \<< Set Oscillation( X, Y, Z, duration )

**Description:** Sets oscillation rate on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Rotation( -60, -3, 35 ), Set Oscillation( -54, 0, 38, 100 ) );


```

### [Set Rotation](#set-rotation)

**Syntax:** obj \<< Set Rotation( X, Y, Z )

**Description:** Rotates the frame to the specified coordinates.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Rotation( -60, -3, 35 ) );


```

### [Set Spin](#set-spin)

**Syntax:** obj \<< Set Spin( dx, dy, sx, sy )

**Description:** Spins the graph on a specified axis. The values dx and dy are a delta motion of the mouse from the point, (sx, sy).

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Spin( .01, .01, 0, 0 ) );


```

### [Set Text Scale](#set-text-scale)

**Syntax:** obj \<< Set Text Scale( number )

**Description:** Sets the text size for the axis text on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Text Scale( 1.4 ) );


```

### [Set View Ortho](#set-view-ortho)

**Syntax:** obj \<< Set View Ortho( state=0|1 )

**Description:** Displays the plot orthographically or linearly.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set View Ortho( 1 ) );


```

### [Set View Perspective](#set-view-perspective)

**Syntax:** obj \<< Set View Perspective( fraction )

**Description:** Sets the view perspective on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set View Perspective( 0.275 ) );


```

### [Set View Zoom](#set-view-zoom)

**Syntax:** obj \<< Set View Zoom( number )

**Description:** Sets the zoom on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set View Zoom( 0.5 ) );
Wait( 2 );
obj << Frame3D( Set View Zoom( 2 ) );


```

### [Set Wall Color](#set-wall-color)

**Syntax:** obj \<< Set Wall Color( number )

**Description:** Sets the wall color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Wall Color( -16775543 ) );


```

### [Set Walls](#set-walls)

**Syntax:** obj \<< Set Walls( state=0|1 )

**Description:** Shows or hides the walls on the plot. On by default.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Walls( 1 ) );


```

### [Set X Axis Color](#set-x-axis-color)

**Syntax:** obj \<< Set X Axis Color( color )

**Description:** Sets the x axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set X Axis Color( 5 ) );


```

### [Set X Axis Label](#set-x-axis-label)

**Syntax:** obj \<< Set X Axis Label( string )

**Description:** Sets the label for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set X Axis Label( "Iris Sepal Length" ) );


```

### [Set Y Axis Color](#set-y-axis-color)

**Syntax:** obj \<< Set Y Axis Color( color )

**Description:** Sets the y axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Y Axis Color( 11 ) );


```

### [Set Y Axis Label](#set-y-axis-label)

**Syntax:** obj \<< Set Y Axis Label( string )

**Description:** Sets the label for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Y Axis Label( "Iris Petal Length" ) );


```

### [Set Z Axis Color](#set-z-axis-color)

**Syntax:** obj \<< Set Z Axis Color( color )

**Description:** Sets the z axis color on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Z Axis Color( "Green" ) );


```

### [Set Z Axis Label](#set-z-axis-label)

**Syntax:** obj \<< Set Z Axis Label( string )

**Description:** Sets the label for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Z Axis Label( "Iris Sepal Width" ) );


```

### [XAxis](#xaxis)

**Syntax:** obj \<< XAxis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the X Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( XAxis( Min( 3 ), Max( 10 ) ) );


```

### [YAxis](#yaxis)

**Syntax:** obj \<< YAxis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the Y Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( YAxis( Min( 1 ), Max( 10 ), Inc( 0.5 ) ) );


```

### [Z Axis](#z-axis)

**Syntax:** obj \<< Z Axis( Min( number ), Max( number ), Inc( number ), Format( ) )

**Description:** Sets the values for the Z Axis on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( ZAxis( Min( 1 ), Max( 5 ), Inc( 0.25 ) ) );


```

### [get light active](#get-light-active)

**Syntax:** obj \<< get light active( light number )

**Description:** Returns the specified light activation shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
p = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Active( 2 ) );
Show( p );


```

### [get light color](#get-light-color)

**Syntax:** obj \<< get light color( light number )

**Description:** Returns the specified light color shining on the plot as a list {red, green, blue}.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
c = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Color( 1 ) );
Show( c );


```

### [get light position](#get-light-position)

**Syntax:** obj \<< get light position( light number )

**Description:** Returns the specified light position shining on the plot as a list {x, y, z}.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
p = obj << Frame3D( Set Hide Lights Border( 0 ), Get Light Position( 2 ) );
Show( p );


```

### [set light active](#set-light-active)

**Syntax:** obj \<< set light active( light number, state=0|1 )

**Description:** Turns on the specified light shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Active( 4, 1 ) );


```

### [set light color](#set-light-color)

**Syntax:** obj \<< set light color( light number, red value, green value, blue value )

**Description:** Sets the color of the light shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Color( 2, 240, 50, 70 ) );


```

### [set light position](#set-light-position)

**Syntax:** obj \<< set light position( light number, X, Y, Z )

**Description:** Sets the light position shining on the plot.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
obj = Scatterplot 3D( Y( :Sepal length, :Sepal width, :Petal length, :Petal width ) );
obj << Frame3D( Set Hide Lights Border( 0 ), Set Light Position( 2, -1.5833, 10, 0 ) );


```

# [DropBox](#dropbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [EvalContextBox](#evalcontextbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ExcerptBox](#excerptbox)

## [Associated Constructors](#associated-constructors)

### [Excerpt Box](#excerpt-box)

**Syntax:** y = Excerpt Box( rptnum, lstSubscripts )

**Description:** Returns a display box containing the excerpt designated by the report held at number rptnum and the list of display subscripts lstSubscripts. The subscripts reflect the current state of the report, after previous excerpts have been removed.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), Fit Line() ) ),
        <<Hold(
            Distribution(
                Automatic Recalc( 1 ),
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Vertical( 0 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "weight by height", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "height", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "height by weight", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [FilterColSelector](#filtercolselector)

## [Associated Constructors](#associated-constructors)

### [Filter Col Selector](#filter-col-selector)

**Syntax:** y = Filter Col Selector(\<Data Table(name)>, \<width(pixels)>, \<nlines(n)>, <script>, \<onchange(expr)>)

**Description:** Returns a display box that contains a list of items. Control allows column filtering.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);


```

## [Item Messages](#item-messages)

### 

**Syntax:** obj \<< None( (0 | 1) )

**Description:** Include or exclude columns with modeling type 'none' from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << none( 0 );


```

### [Character](#character)

**Syntax:** obj \<< Character( (0 | 1) )

**Description:** Include or exclude character columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << character( 0 );


```

### [Clear selection](#clear-selection)

**Syntax:** obj \<< Clear selection

**Description:** Clears the current selection; the items are still there, but are no longer selected.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Set Selected( 2 );
lb << Clear selection;


```

### [Continuous](#continuous)

**Syntax:** obj \<< Continuous( (0 | 1) )

**Description:** Include or exclude continuous columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << continuous( 0 );
Wait( 1 );
lb << continuous( 1 );


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Expression](#expression)

**Syntax:** obj \<< Expression( (0 | 1) )

**Description:** Include or exclude expression columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << expression( 0 );


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Get Base Font;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Items](#get-items)

**Syntax:** list = obj \<< Get Items

**Description:** Returns a list of all of the items.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
Print( lb << Get Items );


```

### [Get Max Selected](#get-max-selected)

**Syntax:** max = obj \<< Get Max Selected

**Description:** Returns the maximum number of items that can be selected in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Get Max Selected();


```

### [Get N Lines](#get-n-lines)

**Syntax:** nlines = obj \<< Get N Lines

**Description:** Returns the number of visible lines in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Get N Lines();


```

### [Get Selected](#get-selected)

**Syntax:** list = obj \<< Get Selected

**Description:** Returns a list of the selected items.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Set Selected( 2 );
Print( lb << Get Selected );


```

### [Get Selected Indices](#get-selected-indices)

**Syntax:** indices = obj \<< Get Selected Indices

**Description:** Returns a list of all of the selected indices.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Set Selected( 2 );
Print( lb << Get Selected Indices );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Locate Item](#locate-item)

**Syntax:** obj \<< Locate Item

**JMP Version Added:** 14

### [Match case](#match-case)

**Syntax:** obj \<< Match case( (0 | 1) )

**Description:** Column search is case sensitive or not.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Match case( 0 );


```

### [Multiple Response](#multiple-response)

**Syntax:** obj \<< Multiple Response( (0 | 1) )

**Description:** Include or exclude multiple response columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << multiple response( 0 );
Wait( 1 );
lb << multiple response( 1 );


```

### [Name contains](#name-contains)

**Syntax:** obj \<< Name contains( Name contains( s ) )

**Description:** List only the columns whose names contain the given text.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Name contains( "a" );


```

### [Name ends with](#name-ends-with)

**Syntax:** obj \<< Name ends with( Name ends with ( text ) )

**Description:** List only the columns whose names end with the given text.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Name ends with( "ht" );


```

### [Name starts with](#name-starts-with)

**Syntax:** obj \<< Name starts with( Name starts with ( text ) )

**Description:** List only the columns whose names start with the given text.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Name starts with( "s" );


```

### [Nominal](#nominal)

**Syntax:** obj \<< Nominal( (0 | 1) )

**Description:** Include or exclude nominal columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << nominal( 0 );


```

### [Numeric](#numeric)

**Syntax:** obj \<< Numeric( (0 | 1) )

**Description:** Include or exclude numeric columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << numeric( 0 );


```

### [Ordinal](#ordinal)

**Syntax:** obj \<< Ordinal( (0 | 1) )

**Description:** Include or exclude ordinal columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << ordinal( 0 );


```

### [Reset](#reset)

**Syntax:** obj \<< Reset

**Description:** Reset the columns list to the entire list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << continuous( 0 );
Wait( 1 );
lb << reset;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when one or more items are selected.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) ),
    Text Box( "" )
);
lb << Set Function(
    Function( {thisBox},
        (thisBox << topparent)[Text Box( 2 )] << Set Text( Char( thisBox << Get Selected ) )
    )
);


```

### [Set Max Selected](#set-max-selected)

**Syntax:** obj \<< Set Max Selected( max )

**Description:** Set the maximum number of items that can be selected in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Set Max Selected( 1 );


```

### [Set N Lines](#set-n-lines)

**Syntax:** obj \<< Set N Lines( nlines )

**Description:** Set the number of visible lines in the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Set N Lines( 4 );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Selected](#set-selected)

**Syntax:** obj \<< Set Selected( index,<selected> )

**Description:** Sets the item at index to be selected (1) or deselected (0).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Set Selected( 2 );
Print( lb << Get Selected );


```

### [Set Size](#set-size)

**Syntax:** obj \<< Set Size( width,height )

**Description:** Sets the width and height of the ListBoxBox.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Set Size( 150, 400 );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Sort by name](#sort-by-name)

**Syntax:** obj \<< Sort by name

**Description:** Sort the column list by name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << Sort by name;


```

### [Unstructured Text](#unstructured-text)

**Syntax:** obj \<< Unstructured Text( (0 | 1) )

**Description:** Include or exclude unstructured text columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << unstructured text( 0 );


```

### [Vector](#vector)

**Syntax:** obj \<< Vector( (0 | 1) )

**Description:** Include or exclude vector columns from the list.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Filter Col Selector Example",
    fontobj = lb = Filter Col Selector( width( 250 ) )
);
lb << vector( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [FilterFieldBox](#filterfieldbox)

## [Item Messages](#item-messages)

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [FrameBox](#framebox)

## [Item Messages](#item-messages)

### [Add Graphics Script](#add-graphics-script)

**Syntax:** obj \<< Add Graphics Script( \<"Back" | "Front" | position>, \<Description("name")>, \<"Selected Layer">, \<Scale IDs(XID, YID)>, script )

**Description:** Enter a script that will draw inside this frame. Selected elements are always above unselected elements. If you specify a selected layer, this script is called during the second drawing pass, when selected elements are drawn.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[frame box( 1 )];
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {1.0, 0.5, 0.0} );
    Polygon( [60, 72, 57], [75, 120, 120] );
);


```

**Example 2**

```


gbox = Graph Box(
    Frame Size( 300, 300 ),
    X Axis( Scale ID( 1 ), Side( 1 ), Min( 1 ), Max( 100 ), Inc( 5 ) ),
    X Axis( Scale ID( 2 ), Side( 2 ), Min( 4 ), Max( 50 ), Inc( 3 ) ),
    Y Axis( Scale ID( 3 ), Min( -100 ), Max( 200 ) ),
    Y Axis( Scale ID( 4 ), Side( 2 ), Min( 1 ), Max( 10 ), Inc( 1 ) ), 

);

fbox = gbox[frame box( 1 )];

fbox << Add Graphics Script(
    Scale IDs( 1, 4 ), //use scale ID's 1 and 4 for this graphics script
    Pen Color( "Green" );
    Line( [20 50 80], [4 3 6] );
);
New Window( "Example", gbox );


```

**Example 3**

```

table = New Table( "test table",
    Add Rows( 150000 ),
    <<New Column( "X", "Numeric", <<Set Each Value( Random Normal() ) ),
    <<New Column( "Y", "Numeric", <<Set Each Value( Random Normal() ) )
);
b = Bivariate( X( :x ), Y( :y ) );
table << select rows( 1 :: 10000 );
Report( b )[Frame Box( 1 )] << Add Graphics Script(
    Description( "Red Line Above Selected" ),
    "selected layer",
    Pen Color( "Red" );
    Pen Size( 5 );
    Line( [-5, 5], [-5, 5] );
);
Report( b )[Frame Box( 1 )] << Add Graphics Script(
    Description( "Green Line Below Selected Above Unselected" ),
    Pen Color( "Green" );
    Pen Size( 3 );
    Line( [5, -5], [-5, 5] );
);


```

### [Add Image](#add-image)

**Syntax:** obj \<< Add Image( image | open("image filename"), \<bounds( left(value), top(value), bottom(value), right(value) ) | move(centerX, centerY)> )

**Description:**

Adds an image to the frame.

You can reference an existing image (already created via a new image() or open() command) or you can specify an image file directly with the open() parameter. The image can be positioned in the frame by the move() command, which specifies where to place the center of the image based on the axes units. Or the image can be sized and placed in the frame by specifying the bounds().

```

img = Open( "$SAMPLE_IMAGES/windmap.png", "png" );
w = New Window( "View Image",
    Graph Box(
        FrameSize( 500, 500 ),
        X Scale( 0, 100 ),
        Y Scale( 0, 100 ),
        <<Add Image(
            image( img ),
            bounds( top( 90 ), Left( 10 ), bottom( 10 ), Right( 90 ) )
        )
    )
);


```

### [Append Seg](#append-seg)

**Syntax:** obj \<< Append Seg( display seg )

**Description:** Adds a display seg to the FrameBox

```

x = [20, 40, 60, 80];
New Window( "Example",
    Graph Box( Frame Size( 300, 120 ), Append Seg( Marker Seg( x, x ), Line Seg( x, x ) ) ),
    Graph Box( Frame Size( 300, 120 ) )
);
gb2 = Current Report()[FrameBox( 2 )];
gb2 << append seg( Current Report()[FrameBox( 1 )] << find seg( Marker Seg( 1 ) ) );


```

### [Background Map](#background-map)

**Syntax:** obj \<< Background Map( \<Images("None" | "Simple Earth" | "Detailed Earth" | "Nasa Server" | ("Web Map Service", url, layer) , \<Transparency(0-1)> )> | \<Boundaries("None" | Shape File)> )

**Description:**

Adds a background map to the frame.

Images are rasterized maps and support transparency. Boundaries are vector maps, defined by a shape file, and can be created by a user. You can specify either an image or a boundary or both.

```

dt = Open( "$SAMPLE_DATA/Hurricanes.jmp" );
plot = Bubble Plot(
    X( :Longitude ),
    Y( :Latitude ),
    Sizes( :"Wind (Knots)"n ),
    Time( :Date ),
    Coloring( :Landfall in USA ),
    ID( :Name and ID ),
    Speed( 1 ),
    Time Index( 2117.70195 ),
    Trail Bubbles( 1 ),
    All Labels( 0 ),
    No Labels( 0 ),
    Title Position( -88.679, 59.73 )
);
rplot = plot << report;
framebox = rplot[Frame Box( 1 )];
framebox << Background Map(
    Images( "Simple Earth", Transparency( 0.7 ) ),
    Boundaries( "World" )
);


```

### [Bottom](#bottom)

**Syntax:** obj \<< Bottom( state=0|1 )

**Description:** Shows or hides a border on the bottom of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Bottom( 0 );


```

### [Child Seg](#child-seg)

**Syntax:** obj \<< Child Seg

**Description:** Returns the display seg child of the Framebox

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[Frame Box( 1 )] << Child Seg();


```

### [Copy Customizations](#copy-customizations)

**Syntax:** obj \<< Copy Customizations

**Description:** Copy a script that contains graph customizations.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Marker Drawing Mode( outlined );
framebox1 << Copy Customizations;
framebox2 << Paste Customizations;


```

### [Copy Frame Contents](#copy-frame-contents)

**Syntax:** obj \<< Copy Frame Contents

**Description:** Create Journal text containing settings for this frame and copy it to the clipboard.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
biv << Fit Line;
framebox1 << Copy Frame Contents;
framebox2 << Paste Frame Contents;


```

### [Copy Frame Settings](#copy-frame-settings)

**Syntax:** obj \<< Copy Frame Settings

**Description:** Create a script containing settings for this frame, and copy it to the clipboard.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Background Color( "Green" );
framebox1 << Copy Frame Settings;
framebox2 << Paste Frame Settings;


```

### [Copy Polygons](#copy-polygons)

**Syntax:** obj \<< Copy Polygons

**Description:** Saves a copy of the polygons located on the frame to the clipboard.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
pa = framebox << Add Polygon Annotation(
    Points( {144, 53}, {182, 30}, {213, 80}, {181, 95} )
);
pa << Closed( 1 );
framebox << Copy Polygons;


```

### [Customize](#customize)

**Syntax:** obj \<< Customize

**Description:** Change the properties of the graph contents.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Customize;


```

### [Dispatch Segs](#dispatch-segs)

**Syntax:** obj \<< Dispatch Segs( command )

**Description:** Sends command to all visual elements ('segs') in the display box.

**JMP Version Added:** 15

### [DispatchSeg](#dispatchseg)

**Syntax:** obj \<< DispatchSeg( command )

**Description:** Sends command to the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Distribution(
    Continuous Distribution( Column( :weight ), Fit Distribution( Normal ) ),
    Nominal Distribution( Column( :age ) ),
    SendToReport(
        Dispatch( {"weight"}, "Distrib Histogram", FrameBox,
            {DispatchSeg(
                Hist Seg( 1 ),
                {Line Style( "Dotted" ), Fill Color( {0, 128, 0} ), Histogram Color( -32768 )
                }
            ), DispatchSeg( Line Seg( 1 ), {Line Color( {0, 0, 255} ), Line Width( 5 )} )}
        )
    )
);


```

### [Edit Graphics Script](#edit-graphics-script)

**Syntax:** obj \<< Edit Graphics Script

**Description:** Edit scripts already installed in this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[frame box( 1 )];
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {1.0, 0.5, 0.0} );
    Polygon( [60, 72, 57], [75, 120, 120] );
);
framebox << Edit Graphics Script;


```

### [Fill Selection Mode](#fill-selection-mode)

**Syntax:** obj \<< Fill Selection Mode( "Preferred Mode"|"Selected Patterned"|"Selected Darker"|"Selected Outlined"|"Selected Same Color"|"Unselected Faded" )

**Description:** Sets the selection style for fills.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = Distribution( Continuous Distribution( Column( :height ) ), Histograms Only );
rdist = dist << report;
dt << Select Where( dt:age == 12 );
framebox = rdist[Frame Box( 1 )];
framebox << Fill Selection Mode( "Selected Darker" );


```

### [Find Seg](#find-seg)

**Syntax:** obj \<< Find Seg( display seg )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
ms = rbiv[Frame Box( 1 )] << Find Seg( Marker Seg( 1 ) );
ms << delete;


```

### [Find Segs](#find-segs)

**Syntax:** obj \<< Find Segs

**JMP Version Added:** 15

### [Frame Size](#frame-size)

**Syntax:** obj \<< Frame Size

**Description:** Change the frame size.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Frame Size( 300, 300 );


```

### [Get Background Fill](#get-background-fill)

**Syntax:** obj \<< Get Background Fill

**Description:** Returns the state (0|1) of the background fill color of graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( weight ), x( height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
//Set background color
framebox << Background Color( "red" );
//Wait to see the color change
Wait( 1 );
//Turn off background fill color
framebox << Set Background Fill( 0 );
val1 = framebox << Get Background Fill;


```

### [Get Fill Selection Mode](#get-fill-selection-mode)

**Syntax:** obj \<< Get Fill Selection Mode

**Description:** Returns the selection style for fills.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = Distribution( Continuous Distribution( Column( :height ) ), Histograms Only );
rdist = dist << report;
dt << Select Where( dt:age == 12 );
framebox = rdist[Frame Box( 1 )];
framebox << Fill Selection Mode( "Selected Darker" );
framebox << Get Fill Selection Mode;


```

### [Get Image](#get-image)

**Syntax:** image = obj \<< Get Image

**Description:** Returns a reference to the background image.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
op = Overlay Plot( X( :subject ), Y( :miles ), Separate Axes( 1 ) );
opr = op << report;
fb = opr[Frame Box( 1 )];
fb << Add Image(
    Open( Convert File Path( "$SAMPLE_IMAGES/black rhino footprint.jpg" ) ),
    Transparency( 0.9 ),
    Rotate( 90 ),
    Bounds(
        Left( 0.135416666666667 ),
        Right( 3.26041666666667 ),
        Top( 11.8333333333333 ),
        Bottom( -1 )
    ),
    SetSize( {300, 210} )
);
fb << Marker Size( 8 );
Print( fb << Get Image );


```

### [Get Marker Selection Mode](#get-marker-selection-mode)

**Syntax:** obj \<< Get Marker Selection Mode

**Description:** Returns the marker selection style.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Selection Mode( "Selected Haloed" );
framebox << Get Marker Selection Mode;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** obj \<< Get Marker Size

**Description:** Returns the graph marker size.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Size( 4 );
Print( framebox << Get Marker Size() );


```

### [Get Polygons](#get-polygons)

**Syntax:** obj \<< Get Polygons

**Description:** Returns a list of polygons located on the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
pa = framebox << Add Polygon Annotation(
    Points( {144, 53}, {182, 30}, {213, 80}, {181, 95} )
);
pa << Closed( 1 );
Print( framebox << Get Polygons );


```

### [Grid Line Order](#grid-line-order)

**Syntax:** obj \<< Grid Line Order( position )

**Description:** Draw the grid lines in front of or behind other objects in the graph

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[axis box( 1 )] << Add Ref Line( 90, "Solid", blue );
rbiv[axis box( 2 )] << Show Major Grid( 1 );
framebox = rbiv[frame box( 1 )];
framebox << Grid Line Order( 1 );


```

### [Hover Label Editor](#hover-label-editor)

**Syntax:** obj \<< Hover Label Editor

**Description:** Displays the Hover Label Editor window.

**JMP Version Added:** 15

### [Left](#left)

**Syntax:** obj \<< Left( state=0|1 )

**Description:** Shows or hides a border on the left of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Left( 0 );


```

### [Line Width Scale](#line-width-scale)

**Syntax:** obj \<< Line Width Scale( 0|scale )

**Description:** Sets the width of the line to the inputted value. A value of 0 means the line width scale is determined by the font size scale.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Line Width Scale( 2.0 );


```

### [Make table of graphs like this](#make-table-of-graphs-like-this)

**Syntax:** obj \<< Make table of graphs like this

**Description:** create a data table of graphs

### [Marker Drawing Mode](#marker-drawing-mode)

**Syntax:** obj \<< Marker Drawing Mode( "Normal"|"Fast"|"Outlined" )

**Description:** Sets the style of the marker.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Drawing Mode( "outlined" );


```

### [Marker Label Color Style](#marker-label-color-style)

**Syntax:** obj \<< Marker Label Color Style( "Preferred Mode"|"Marker Color"|"Marker Color Faded"|"Fixed Color" )

**Description:** Changes the color of marker labels

### [Marker Selection Mode](#marker-selection-mode)

**Syntax:** obj \<< Marker Selection Mode( "Preferred Mode"|"Unselected Faded"|"Selected Larger"|"Selected Haloed"|"Selected Outlined"|"Selected Same Color" )

**Description:** Sets the selection style of the marker.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Selection Mode( "Selected Haloed" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( 0=dot/1=small/2=medium/... )

**Description:** Sets the size of the marker.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Size( 4 );


```

### [Name Selection in Column](#name-selection-in-column)

**Syntax:** obj \<< Name Selection in Column

**Description:** Label the currently selected rows and save the value(label) in a column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Rows( 1 );
dt:(Column( 2 )) << Set Selected( 1 );
framebox = rbiv[Frame Box( 1 )];
framebox << Select Matching Cells;
framebox << Name Selection in Column;


```

### [Paste Background Image](#paste-background-image)

**Syntax:** obj \<< Paste Background Image

**Description:** Paste the background image that is saved in memory on the clipboard.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
op = Overlay Plot( X( :subject ), Y( :miles ), Separate Axes( 1 ) );
opr1 = op << report;
opr2 = opr1 << Clone Box;
opr1 << append( opr2 );
fb1 = opr1[Frame Box( 1 )];
fb1 << Add Image(
    Open( Convert File Path( "$SAMPLE_IMAGES/black rhino footprint.jpg" ) ),
    Transparency( 0.9 ),
    Rotate( 90 ),
    Bounds(
        Left( 0.135416666666667 ),
        Right( 3.26041666666667 ),
        Top( 11.8333333333333 ),
        Bottom( -1 )
    ),
    SetSize( {300, 210} )
);
fb1 << Copy Picture;
fb2 = opr2[Frame Box( 1 )];
fb2 << Paste Background Image;


```

### [Paste Customizations](#paste-customizations)

**Syntax:** obj \<< Paste Customizations

**Description:** Paste a script that contains graph customizations.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Marker Drawing Mode( outlined );
framebox1 << Copy Customizations;
framebox2 << Paste Customizations;


```

### [Paste Frame Contents](#paste-frame-contents)

**Syntax:** obj \<< Paste Frame Contents

**Description:** The clipboard contains journal text for Frame contents. Parse it and install it in this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
biv << Fit Line;
framebox1 << Copy Frame Contents;
framebox2 << Paste Frame Contents;


```

### [Paste Frame Settings](#paste-frame-settings)

**Syntax:** obj \<< Paste Frame Settings

**Description:** Paste the clipboard's contents into this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Background Color( "Green" );
framebox1 << Copy Frame Settings;
framebox2 << Paste Frame Settings;


```

### [Paste Graphlet](#paste-graphlet)

**Syntax:** obj \<< Paste Graphlet

**Description:** Adds a Graphlet customization based on the clipboard contents.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
Set Clipboard(JSLQuote(Bivariate(
                             Y( :height ),
                             X( :weight ),
                             Histogram Borders( 1 ),
                             Fit Robust( {Line Color( {212, 73, 88} )} ),
                             Fit Cauchy( {Line Color( {61, 174, 70} )} ),
                             SendToReport(
                                 Dispatch(
                                     {},
                                     "Bivar Plot",
                                     FrameBox,
                                     {Grid Line Order( 1 ), Reference Line Order( 2 )}
                                 )
                             )
                         )));
frame = (gb << report)[FrameBox( 1 )];
frame << Paste Graphlet();
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
gpin << Launch Graphlet;


```

### [Reference Line Order](#reference-line-order)

**Syntax:** obj \<< Reference Line Order( position )

**Description:** Draw the reference lines in front of or behind other objects in the graph

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[axis box( 1 )] << Add Ref Line( 90, "Solid", blue );
rbiv[axis box( 2 )] << Show Major Grid( 1 );
framebox = rbiv[frame box( 1 )];
framebox << Reference Line Order( 1 );


```

### [Remove Graphics Script](#remove-graphics-script)

**Syntax:** obj \<< Remove Graphics Script( position )

**Description:** Removes the graphics script attached to the frame at the given position.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[frame box( 1 )];
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {1.0, 0.5, 0.0} );
    Polygon( [60, 72, 57], [75, 120, 120] );
);
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {0.0, 0.5, 1.0} );
    Polygon( [60, 72, 57], [150, 120, 120] );
);
Wait( 2 );
framebox << Remove Graphics Script( 2 );


```

### [Reorder Segs](#reorder-segs)

**Syntax:** obj \<< Reorder Segs( List of integers representing the current segs in the new order. )

**Description:** Reorders segs that are in a graph.

**JMP Version Added:** 16

```

Open( "$sample_data\big class.jmp" );
gb = Graph Builder(
    Size( 534, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 6 ) ), Bar( X, Y, Legend( 7 ) ) ),
    SendToReport(
        Dispatch( {}, "weight", ScaleBox,
            {Label Row( {Show Major Grid( 1 ), Show Minor Grid( 1 )} )}
        )
    )
);
For( blink = 1, blink < 4, blink++,
    Wait( .5 );
    (gb << report)[FrameBox( 1 )] << reorder segs( {4, 3, 2, 1} );
);


```

### [Right](#right)

**Syntax:** obj \<< Right( state=0|1 )

**Description:** Shows or hides a border on the right of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Right( 0 );


```

### [Right Y Axis](#right-y-axis)

**Syntax:** obj \<< Right Y Axis( < Min( min ) >, < Max( max ) >, < Inc( n ) >, ... )

**Description:** Applies one or more right Y axis changes in a single message. Opens the right Y Axis Settings window if no arguments are given.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ), Y( :weight, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
gbr = gb << report;
fb = gbr[Frame Box( 1 )];
fb << Right Y Axis;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 23 ) ),
        Y( :height, Size( 37 ) ),
        Y( :weight, Position( 1 ), Size( 37 ), Side( "Right" ) )
    ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
framebox = Report( gb )[framebox( 1 )];
framebox << Right Y Axis(
    Rotated Labels( "Angled" ),
    Scale( "Log" ),
    Add Ref Line( 125, dashed, "red" )
);


```

### [Row Colors](#row-colors)

**Syntax:** obj \<< Row Colors( color )

**Description:** Sets the color of the selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Colors( "Red" );


```

### [Row Editor](#row-editor)

**Syntax:** obj \<< Row Editor

**Description:** Bring up the Row Editor window, starting on the first selected point.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Row Editor;


```

### [Row Exclude](#row-exclude)

**Syntax:** obj \<< Row Exclude

**Description:** Excludes (or unexcludes) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Exclude( 1 );


```

### [Row Hide](#row-hide)

**Syntax:** obj \<< Row Hide

**Description:** Hides (or unhides) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Hide( 1 );


```

### [Row Hide and Exclude](#row-hide-and-exclude)

**Syntax:** obj \<< Row Hide and Exclude

**Description:** Hides and excludes (or unhide or unexcludes) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Hide and Exclude( 1 );


```

### [Row Label](#row-label)

**Syntax:** obj \<< Row Label

**Description:** Labels (or unlabels) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Label( 1 );


```

### [Row Legend](#row-legend)

**Syntax:** obj \<< Row Legend( Color( 0|1), Marker( 0|1 ), \<Color theme( string )>, \<Marker theme( string )>, < Continuous scale(0|1)>, \<Reverse scale(0|1)>, \<Excluded Row( 0|1 ), <Make window with legend> )

**Description:** Color the rows according to a data column, and insert a legend to the right of this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Row Legend( "age", color( 1 ), Marker( 1 ) );


```

### [Row Markers](#row-markers)

**Syntax:** obj \<< Row Markers( marker )

**Description:** Sets the marker of the selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Markers( 3 );


```

### [Scale with Font](#scale-with-font)

**Syntax:** obj \<< Scale with Font

**Description:** Sets the line width to scale with the font size scale. Equivalent to \<<Line Width Scale(0).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( weight ), x( height ), FitLine );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Scale with Font;


```

### [Seg Count](#seg-count)

**Syntax:** obj \<< Seg Count( <seg type> )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[Frame Box( 1 )] << Seg Count( MarkerSeg );


```

### [Select Matching Cells](#select-matching-cells)

**Syntax:** obj \<< Select Matching Cells

**Description:** Select points that have similar labels to the selected rows

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Rows( 1 );
dt:(Column( 2 )) << Set Selected( 1 );
framebox = rbiv[Frame Box( 1 )];
framebox << Select Matching Cells;


```

### [Select Similar](#select-similar)

**Syntax:** obj \<< Select Similar

**Description:** Selects the rows that have similar data values as the selected column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Rows( 1 );
dt:(Column( 3 )) << Set Selected( 1 );
framebox = rbiv[Frame Box( 1 )];
framebox << Select Similar;


```

### [Set Background Fill](#set-background-fill)

**Syntax:** obj \<< Set Background Fill( state=0|1 )

**Description:** Enables or disables filling the graph background with the background color.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( weight ), x( height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
//Set background color
framebox << Background Color( "red" );
//Wait to see the color change
Wait( 1 );
//Turn off background fill color
framebox << Set Background Fill( 0 );


```

### [Set Graphlet](#set-graphlet)

**Syntax:** obj \<< Set Graphlet

**Description:** Defines the hover label embedded visualization (graphlet) for this graph.

**JMP Version Added:** 15

#### [External image](#external-image)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        local:img_url = "https://upload.wikimedia.org/wikipedia/commons/thumb/" ||
        Match( local:_Species,
            "versicolor", "2/27/Blue_Flag%2C_Ottawa.jpg/240px-Blue_Flag%2C_Ottawa.jpg",
            "virginica", "f/f8/Iris_virginica_2.jpg/240px-Iris_virginica_2.jpg",
            "setosa",
                "5/56/Kosaciec_szczecinkowaty_Iris_setosa.jpg/180px-Kosaciec_szczecinkowaty_Iris_setosa.jpg"
        );
        Open( local:img_url );
    ),
    Click( Web( "https://en.wikipedia.org/wiki/Iris_" || local:_Species ) ),
    Title( "External Image" ),
    Reapply( 1 )
);
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 18 ),
    Index Row( 18 ),
    UniqueID( 1441114818 ),
    FoundPt( {123, 293} ),
    Origin( {1.70752129817444, 5.66359183673469} ),
    Tag Line( 1 )
);
gpin << Launch Graphlet;


```

#### [Preset](#preset)

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
gpin << Launch Graphlet;


```

### [Set Gridlet](#set-gridlet)

**Syntax:** obj \<< Set Gridlet

**Description:** Defines the hover label content grid (gridlet) for this graph.

**JMP Version Added:** 15

#### [Append](#append)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet(
    Expunge( {{Matcher( "Species" )}} ),
    Annex(
        {{Matcher( "Species@Wikipedia" ), value( local:_Species ),
        click( Web( "https://wikipedia.com/wiki/Iris_" || local:_Species ) )}}
    )
);
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Delete](#delete)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet( Expunge( {{Matcher( "Row" )}} ) );
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Reformat](#reformat)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet(
    Reformat(
        {{Matcher( "Petal length" ), Format( "Scientific", 80 ), 80},
        {Matcher( "Sepal length" ), Format( "Scientific", 80 ), 80}}
    )
);
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Rename](#rename)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet( Rename( {{Matcher( "Row" ), value( "Observation" )}} ) );
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Style](#style)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet(
    Style(
        {{Matcher( "Species" ), Text Color( "Red" ), Background Color( "Light Yellow" ),
        Justification( "Center" ), "Font"("Times New Roman", 14, "Italic")}}
    )
);
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

### [Set Textlet](#set-textlet)

**Syntax:** obj \<< Set Textlet

**Description:** Defines the hover label rich text content (textlet) for this graph.

**JMP Version Added:** 15

```

//This example uses hardcoded content from Wikipedia
// For a complete example that uses dynamic, data-driven content, please see
// https://community.jmp.com/t5/JMP-Scripts/WikiReader-Augmenting-Hover-Labels-with-web-data-and-images/ta-p/237488
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Textlet(
    Setup(
        local:description =
        "Iris virginica, with the common name Virginia iris, is a perennial species of flowering plant, native to eastern North America.";
        local:text = Substr( local:description, 1, 140 ) || "...";
    ),
    Markup(
        "<background color='white'><i><font family='Arial' size='12'>{local:text}</font></i></background>"
    ),
    Width( 320 )
);
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

### [Size to Isometric](#size-to-isometric)

**Syntax:** obj \<< Size to Isometric

**Description:** Resize the frame so that the number of real units per pixel is the same in X and Y directions.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Size To Isometric;


```

### [Ternary X Title](#ternary-x-title)

**Syntax:** obj \<< Ternary X Title( text )

**Description:** Sets the X-axis title for a ternary frame.

**JMP Version Added:** 15

### [Ternary Y Title](#ternary-y-title)

**Syntax:** obj \<< Ternary Y Title( text )

**Description:** Sets the Y-axis title for a ternary frame.

**JMP Version Added:** 15

### [Ternary Y1 Title](#ternary-y1-title)

**Syntax:** obj \<< Ternary Y1 Title( text )

**Description:** Sets the Y1-axis title for a ternary frame.

**JMP Version Added:** 15

### [Top](#top)

**Syntax:** obj \<< Top( state=0|1 )

**Description:** Shows or hides a border on the top of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Top( 0 );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency

**Description:** Sets the transparency of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Transparency( 0.5 );


```

### [X Axis](#x-axis)

**Syntax:** obj \<< X Axis( < Min( min ) >, < Max( max ) >, < Inc( n ) >, ... )

**Description:** Applies one or more X axis changes in a single message. Opens the X Axis Settings window if no arguments are given.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ), Y( :weight, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
gbr = gb << report;
fb = gbr[Frame Box( 1 )];
fb << X Axis;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 23 ) ),
        Y( :height, Size( 37 ) ),
        Y( :weight, Position( 1 ), Size( 37 ), Side( "Right" ) )
    ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
framebox = Report( gb )[framebox( 1 )];
framebox << X Axis(
    Min( -2 ),
    Max( 7 ),
    Inc( 1 ),
    Add Ref Line( 5, "Solid", "Blue" ),
    Rotated Labels( "Vertical" )
);


```

### [Y Axis](#y-axis)

**Syntax:** obj \<< Y Axis( < Min( min ) >, < Max( max ) >, < Inc( n ) >, ... )

**Description:** Applies one or more Y axis changes in a single message. Opens the Y Axis Settings window if no arguments are given.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ), Y( :weight, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
gbr = gb << report;
fb = gbr[Frame Box( 1 )];
fb << Y Axis;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 23 ) ),
        Y( :height, Size( 37 ) ),
        Y( :weight, Position( 1 ), Size( 37 ), Side( "Right" ) )
    ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
framebox = Report( gb )[framebox( 1 )];
framebox << Y Axis(
    Add Ref Line( 61.25, "Solid", "Medium Dark Green" ),
    Show Major Grid( 1 ),
    Show Minor Grid( 1 ),
    Format( "Fixed Dec", 5, 2 ),
    Rotated Labels( "Perpendicular" )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append_1)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [GlobalBox](#globalbox)

## [Associated Constructors](#associated-constructors)

### [Global Box](#global-box)

**Syntax:** box = Global Box( name )

**Description:** Creates a display box showing the value of a global variable.

```

ex = .6;
New Window( "Example", Global Box( ex ) );


```

## [Item Messages](#item-messages)

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [GraphBuilderBox](#graphbuilderbox)

## [Associated Constructors](#associated-constructors)

### [Graph Builder](#graph-builder)

**Syntax:** Graph Builder

**Description:** Internal component of Graph Builder.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( xposition, yposition, {Type(element name), X(i=1), Y(i=1), options...} )

**Description:** Adds a new graph element at the given X and Y positions. The element specification includes the element name, which data roles it uses its option values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
Wait( 0.5 );
gb << Add Element( 1, 1, {Type( "Line Of Fit" ), X, Y, Degree( "Quadratic" )} );


```

### [Add Variable](#add-variable)

**Syntax:** obj \<< Add Variable( {column, Role(role), Position(p=1), Inner Position(i=1)}, < \<<Method("insert"|"merge"|"replace")> )

**Description:** Adds a new variable to the Graph Builder model, with a given role and position.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
Wait( 0.5 );
gb << Add Variable( {:age, Role( "Wrap" )} );


```

### [Get Element](#get-element)

**Syntax:** obj \<< Get Element( xposition, yposition, i )

**Description:** Returns a graph element specifications for the given x and y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Get Element( 1, 1, 1 );


```

### [Get Elements](#get-elements)

**Syntax:** obj \<< Get Elements( xposition, yposition )

**Description:** Returns a list of element specifications for the given x and y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Get Elements( 1, 1 );


```

### [Get Graph Margin](#get-graph-margin)

**Syntax:** obj \<< Graph Margin( sides ); sides = obj \<< Get Graph Margin

**Description:** The minimum margin around the graph area, which might be superseded by any surrounding axis, legend, or title.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
ob << Graph Margin( 0, 0, 0, 0 );


```

### [Get N Elements](#get-n-elements)

**Syntax:** obj \<< Get N Elements( xposition, yposition )

**Description:** Returns the number of graph elements for the given x and y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Get N Elements( 1, 1 );


```

### [Get N Positions](#get-n-positions)

**Syntax:** nrole

**Description:** Returns the number of positions in use for a given role.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Get N Positions( "X" );


```

### [Get N Variables](#get-n-variables)

**Syntax:** n = obj \<< Get N Variables

**Description:** Returns the number of variables in use.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Get N Variables();


```

### [Get Scale Graph Margin](#get-scale-graph-margin)

**Syntax:** obj \<< Scale Graph Margin( state=0|1 ); state = obj \<< Get Scale Graph Margin

**Description:** Specifies whether the Graph Margin properties should scale with the graph size when applied.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
ob << Scale Graph Margin( 0 );


```

### [Get Variable](#get-variable)

**Syntax:** obj \<< Get Variable( index )

**Description:** Returns a variable specification.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Get Variable( 1 );


```

### [Get Variables](#get-variables)

**Syntax:** list = obj \<< Get Variables

**Description:** Returns a list of variable specification lists for the variables in use.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Get Variables();


```

### [Graph Borders](#graph-borders)

**Syntax:** obj \<< Graph Borders( color )

**Description:** Shows or hides the internal graph panel borders.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Add Variable( {:age, Role( "Wrap" )} );
Wait( 0.5 );
gb << Graph Spacing( 5 );
gb << Graph Transparency( 0 );
gb << Graph Borders( 1 );


```

### [Graph Margin](#graph-margin)

**Syntax:** obj \<< Graph Margin( sides ); sides = obj \<< Get Graph Margin

**Description:** The minimum margin around the graph area, which might be superseded by any surrounding axis, legend, or title.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
ob << Graph Margin( 0, 0, 0, 0 );


```

### [Graph Spacing](#graph-spacing)

**Syntax:** obj \<< Graph Spacing( color )

**Description:** Sets the amount of spacing between graph panels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Add Variable( {:age, Role( "Wrap" )} );
Wait( 0.5 );
gb << Graph Spacing( 10 );


```

### [Graph Spacing Color](#graph-spacing-color)

**Syntax:** obj \<< Graph Spacing Color( color )

**Description:** Sets the color of the spacing between graph panels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Add Variable( {:age, Role( "Wrap" )} );
Wait( 0.5 );
gb << Graph Spacing Color( "Blue" );


```

### [Graph Spacing Transparency](#graph-spacing-transparency)

**Syntax:** obj \<< Graph Spacing Transparency( color )

**Description:** Sets the transparency of the spacing between graph panels.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
gb << Add Variable( {:age, Role( "Wrap" )} );
Wait( 0.5 );
gb << Graph Spacing Transparency( 0.3 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( xposition, yposition, i )

**Description:** Removes a graph element at the given X and Y positions.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
Wait( 0.5 );
gb << Remove Element( 1, 1, 2 );


```

### [Remove Variable](#remove-variable)

**Syntax:** obj \<< Remove Variable( index | {column, Role(role), Position(p=1), Inner Position(i=1)} )

**Description:** Removes a variable from the Graph Builder model, specified by either the index or a given column name, role, and position.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
Wait( 0.5 );
gb << Add Variable( {:age, Role( "Wrap" )} );
Wait( 0.5 );
gb << Remove Variable( 3 );


```

### [Scale Graph Margin](#scale-graph-margin)

**Syntax:** obj \<< Scale Graph Margin( state=0|1 ); state = obj \<< Get Scale Graph Margin

**Description:** Specifies whether the Graph Margin properties should scale with the graph size when applied.

**JMP Version Added:** 19

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
ob << Scale Graph Margin( 0 );


```

### [Update Element](#update-element)

**Syntax:** obj \<< Update Element( xposition, yposition, i, {options} )

**Description:** Modifies the properties of an existing element.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gbp = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
gb = Report( gbp )[Graph Builder Box( 1 )];
Wait( 0.5 );
gb << Update Element( 1, 1, 1, {Summary Statistic( "Mean" ), Error Bars( "Range" )} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [GridCellBox](#gridcellbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [GridMultiCellBox](#gridmulticellbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [HelpBox](#helpbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [HierBox](#hierbox)

## [Associated Constructors](#associated-constructors)

### [Hier Box](#hier-box)

**Syntax:** y = Hier Box( text, Hier Box( ... ), Hier Box( ... ), ... )

**Description:** Returns a display box that contains a hierarchy of strings.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Above](#above)

**Syntax:** obj \<< Above( "string" )

**Description:** Inserts a new string above the calling HierBox.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
parent4 << Above( "New Parent" );


```

### [After](#after)

**Syntax:** obj \<< After( "string" )

**Description:** Inserts a new string after the calling HierBox.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
parent4 << After( "New Parent" );


```

### [Before](#before)

**Syntax:** obj \<< Before( "string" )

**Description:** Inserts a new string before the calling HierBox.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
parent4 << Before( "New Parent" );


```

### [Below](#below)

**Syntax:** obj \<< Below( "string" )

**Description:** Inserts a new string below the calling HierBox.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
parent4 << Below( "New Child" );


```

### [Change Type](#change-type)

**Syntax:** obj \<< Change Type( "Fishbone"|"Hierarchy"|"Nested" )

**Description:** Sets the style of the Hier Box.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Change Type( "hierarchy" );


```

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Hide all of the children under the given Hier Box.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Close();


```

### [Color](#color)

**Syntax:** obj \<< Color( color )

**Description:** Sets the color of the text.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent2 << Color( "Red" );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Remove the Hier Box.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
parent3 << Delete();


```

### [Direction](#direction)

**Syntax:** obj \<< Direction( 0|1 )

**Description:** Sets if the strings in the HierBox should point right (1) or left (0).

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
parent1 << Direction( 1 );


```

### [First](#first)

**Syntax:** obj \<< First

**Description:** Move the calling HierBox to be the first HierBox.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent2 << First;


```

### [Force Alternate](#force-alternate)

**Syntax:** obj \<< Force Alternate

**Description:** Moves the calling HierBox to be alternating with the sibling HierBox.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Force Alternate;


```

### [Force Down](#force-down)

**Syntax:** obj \<< Force Down

**Description:** Moves the calling HierBox down.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Force Up;
ggparent << Force Down;


```

### [Force Left](#force-left)

**Syntax:** obj \<< Force Left

**Description:** Moves the calling HierBox to the left.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Force Up;
ggparent << Force Right;
ggparent << Force Left;


```

### [Force Right](#force-right)

**Syntax:** obj \<< Force Right

**Description:** Moves the calling HierBox to the right.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Force Up;
ggparent << Force Right;


```

### [Force Up](#force-up)

**Syntax:** obj \<< Force Up

**Description:** Moves the calling HierBox up.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Force Up;


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Get Base Font;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Horizontal](#horizontal)

**Syntax:** obj \<< Horizontal

**Description:** Rotate the text to be horizontal that starts on the left.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent1 << Rotate Right;
gparent1 << Horizontal;


```

### [Last](#last)

**Syntax:** obj \<< Last

**Description:** Move the calling HierBox to be the last HierBox.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent1 << Last;


```

### [Lean](#lean)

**Syntax:** obj \<< Lean( 0|1 )

**Description:** Sets if the strings in the HierBox should lean right (1) or left (0).

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent1 << Lean( 1 );


```

### [Make Into Data Table](#make-into-data-table)

**Syntax:** obj \<< Make Into Data Table( \<Invisible(bool) | Private(bool)> )

**Description:** Creates a new data table that contains the strings in the HierBox.

**Example 1**

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Make Into Data Table();


```

**Example 2**

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Make into Data Table( invisible( 1 ) );


```

### [Other Side](#other-side)

**Syntax:** obj \<< Other Side

**Description:** Move the calling HierBox to the other side of the other HierBoxs.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent1 << Other Side;


```

### [Override Descendant Padding](#override-descendant-padding)

**Syntax:** obj \<< Override Descendant Padding( state=0|1 )

**Description:** This is true if all descendants adopt the same padding setup prescribed.

**JMP Version Added:** 17

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Override Descendant Padding( false );


```

### [Pad Current Node](#pad-current-node)

**Syntax:** obj \<< Pad Current Node( state=0|1 )

**Description:** This is true if we apply the prescribed padding setup to the current node.

**JMP Version Added:** 17

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Pad Current Node( false );


```

### [Rotate Left](#rotate-left)

**Syntax:** obj \<< Rotate Left

**Description:** Rotate the text to be vertical that starts at the bottom.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent1 << Rotate Left;


```

### [Rotate Right](#rotate-right)

**Syntax:** obj \<< Rotate Right

**Description:** Rotate the text to be vertical that starts at the top.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
gparent1 << Rotate Right;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Siblings Horizontal Pad](#siblings-horizontal-pad)

**Syntax:** obj \<< Siblings Horizontal Pad( number )

**Description:** This is the usual padding between hierboxes.

**JMP Version Added:** 17

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Siblings Horizontal Pad( 4 );


```

### [Siblings Total Pad](#siblings-total-pad)

**Syntax:** obj \<< Siblings Total Pad( number )

**Description:** This is the vertical padding between sibling hierboxes and their parent box.

**JMP Version Added:** 17

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Siblings Total Pad( 15 );


```

### [Siblings Vertical Pad](#siblings-vertical-pad)

**Syntax:** obj \<< Siblings Vertical Pad( number )

**Description:** This is the padding between hierboxes when rotated 90 degrees.

**JMP Version Added:** 17

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Siblings Vertical Pad( 4 );


```

### [Text Wrap Width](#text-wrap-width)

**Syntax:** obj \<< Text Wrap Width( width )

**Description:** Specifies the width each string can be before the string starts a new line.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Text Wrap Width( 60 );


```

### [Uneditable](#uneditable)

**Syntax:** obj \<< Uneditable( state=0|1 )

**Description:** If enabled (1), strings can be clicked on with a mouse to be edited.

```

New Window( "Example",
    ggparent = Hier Box(
        "Great Grand Parent",
        gparent1 = Hier Box(
            "Grand Parent 1",
            parent1 = Hier Box( "Parent 1" ),
            parent2 = Hier Box( "Parent 2" )
        ),
        fontobj = gparent2 = Hier Box(
            "Grand Parent 2",
            parent3 = Hier Box(
                "Parent 3",
                child1 = Hier Box( "Child 1" ),
                child2 = Hier Box( "Child 2" )
            ),
            parent4 = Hier Box( "Parent 4" )
        )
    )
);
ggparent << Uneditable( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [HistSeg](#histseg)

## [Associated Constructors](#associated-constructors)

### [Hist Seg](#hist-seg)

**Syntax:** b = Hist Seg([data], \<[freq data]>,\<[weight data]>, \<vertical=0|1>, \<Row States()>)

**Description:** Returns a hist seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Delete;


```

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Frame;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << get description();


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Get Fill Pattern;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color( color )

**Description:** Gets the color of the bar outlines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** linestyle = obj \<< Get Line Style( pen style )

**Description:** Gets the line style of the bar outlines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** integer = obj \<< Get Line Width( number )

**Description:** Gets the width of the bar outlines

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Get Line Width;


```

### [Get Transparency](#get-transparency)

**Syntax:** 0.0 to 1.0 = obj \<< Get Transparency( number )

**Description:** Gets the transparency for the hist seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Get Transparency;


```

### [Histogram Color](#histogram-color)

**Syntax:** obj \<< Histogram Color( color )

**Description:** Sets the color of the histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Histogram Color( "Red" );


```

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Sets the color of the bar outlines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( linestyle )

**Description:** Sets the line style of the bar outlines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Line Style( "dashed" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( integer )

**Description:** Sets the width of the bar outlines

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Parent;


```

### [Save Color Preference](#save-color-preference)

**Syntax:** obj \<< Save Color Preference

**Description:** Sets the current bar color as the default color for histogram bars.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Save Color Preference;


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Sets the color of the bar outlines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( linestyle )

**Description:** Sets the line style of the bar outlines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Line Style( "dashed" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( integer )

**Description:** Sets the width of the bar outlines

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( 0.0 to 1.0 )

**Description:** Sets the transparency for the hist seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Transparency( .5 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Subset](#subset)

**Syntax:** obj \<< Subset

**Description:** Creates a subset data table based on the current selection.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Subset;


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( 0.0 to 1.0 )

**Description:** Sets the transparency for the hist seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
rows = N Row( xx );
New Window( "Hist Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Hist Seg( xx, J( rows, 1 ), J( rows, 1 ), 1, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Hist Seg( 1 ) ));
seg << Set Transparency( .5 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [IconBox](#iconbox)

## [Associated Constructors](#associated-constructors)

### [Icon Box](#icon-box)

**Syntax:** Box = Icon Box( "Name" )

**Description:** Constructs a display box containing an icon, where the name argument can be a JMP icon name or a path to a an image.

**Example 1**

```

New Window( "Example",
    ex1 = Icon Box( "Popup" ),
    ex2 = Icon Box( "Locked" ),
    ex3 = Icon Box( "Labeled" ),
    ex4 = Icon Box( "Sub" ),
    ex5 = Icon Box( "Excluded" ),
    ex6 = Icon Box( "Hidden" ),
    ex7 = Icon Box( "Continuous" ),
    ex8 = Icon Box( "Nominal" ),
    ex9 = Icon Box( "Ordinal" )
);


```

**Example 2**

```

New Window( "Example with Path", ex = Icon Box( "$SAMPLE_IMAGES/pi.gif" ) );


```

## [Item Messages](#item-messages)

### [Get Title](#get-title)

**Syntax:** Continuous|Nominal|Ordinal|<path to file> = obj \<< Get Title

**Description:** Returns the current icon.

```

New Window( "Example", ex = Icon Box( "Nominal" ) );
Print( ex << get title() );


```

### [Title](#title)

**Syntax:** obj \<< Title( Continuous|Nominal|Ordinal )

**Description:** Sets a new icon.

```

New Window( "Example", ex = Icon Box( "Nominal" ) );
Wait( 2 );
ex << title( "$SAMPLE_IMAGES/pi.gif" );
Wait( 2 );
ex << title( "Ordinal" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [IconStringColBox](#iconstringcolbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [IfBox](#ifbox)

## [Associated Constructors](#associated-constructors)

### [If Box](#if-box)

**Syntax:** box = If Box( 0|1, displayBoxArgs )

**Description:** Returns a display box that conditionally displays the specified display box arguments.

```

New Window( "Example",
    H List Box(
        englishBox = If Box( 1, Text Box( "Good day" ) ),
        frenchBox = If Box( 0, Text Box( "Bon Jour" ) )
    )
);
Wait( 5 );
englishBox << Set( 0 );
frenchBox << Set( 1 );


```

## [Item Messages](#item-messages)

### [Get](#get)

**Syntax:** 0|1 = obj \<< Get

**Description:** Returns the state of the IfBox.

```

New Window( "Example",
    Border Box( top( 9 ), bottom( 9 ), Left( 50 ),
        Button Box( "switch", /* this button controls two mutually exclusive If Box displays */
            diagBox << set( !(diagBox << get()) );/* use the opposite of the old value */
            surfBox << set( !(surfBox << get()) );
        )
    ),
    H List Box(
        surfBox = If Box(
            0, /* this one is OFF at first */SurfacePlot(
                ControlPanel( 0 ),
                Frame3D( SetGraphSize( 200, 200 ), SetSpin( -0.01, 0, 0.03, 0.1 ), )
            )
        ),
        diagBox = If Box(
            1, /* this one is ON at first */Diagram(
                hierarchy(
                    Hier Box(
                        Text Edit Box( "Yield" ),
                        Hier Box( Text Edit Box( "Pressure" ), <<direction( 1 ) ),
                        Hier Box( Text Edit Box( "Temperature" ) )
                    )
                )
            )
        )
    )
);


```

### [Set](#set)

**Syntax:** obj \<< Set( state=0|1 )

**Description:** Shows or hides the display boxes within the IfBox.

```

orangeStatus = 1;
greenStatus = 0;
orangeSpot = Spacer Box( size( 9, 9 ), color( "orange" ) );
greenSpot = Spacer Box( size( 9, 9 ), color( "green" ) );
New Window( "Example",
    orangeIf = If Box( orangeStatus, orangeSpot ),
    greenIf = If Box( greenStatus, greenSpot ),
    Button Box( "orange",
        orangeStatus = !orangeStatus;
        orangeIf << set( orangeStatus );
    ),
    Button Box( "green",
        greenStatus = !greenStatus;
        greenIf << set( greenStatus );
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [IfSeg](#ifseg)

## [Associated Constructors](#associated-constructors)

### [If Seg](#if-seg)

**Syntax:** seg = If Seg(\<state=0|1>)

**Description:** Creates a seg that shows or hides display seg children.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Append](#append)

**Syntax:** obj \<< Append( seg2 )

**Description:** Adds the segment as the last child of the current seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << Append( Lines Seg( [5 50 95 50] ) );


```

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << Delete;


```

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << Frame;


```

### [Get](#get)

**Syntax:** 0|1 = obj \<< Get

**Description:** Returns the state of the IfSeg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << get;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << get description();


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << Parent;


```

### [Set](#set)

**Syntax:** obj \<< Set( state=0|1 )

**Description:** Shows or hides the display segs within the IfSeg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
Wait( .5 );
seg << set( 0 );
Wait( .5 );
seg << set( 1 );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example",
    g = Graph Box( If Seg( true, <<append( Lines Seg( lines ) ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( If Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [LabelBox](#labelbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [LegendBox](#legendbox)

## [Item Messages](#item-messages)

### [Get Item](#get-item)

**Syntax:** LegendBox \<< Get Item(Model ID, Model Index)

**Description:** Returns a Legend Item that can be queried or have its visible properties changed.

**JMP Version Added:** 16

**Example 1**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 2, 1 );
Print( item << Get Type );


```

**Example 2**

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
item = lgnd << Get Item( 1, 4 );
item << Set Label( "test" );


```

### [Get Items](#get-items)

**Syntax:** obj \<< Get Items

**Description:** Returns a list of all Legend Items that can be queried or have their visible properties changed.

**JMP Version Added:** 16

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Variables( X( :height ), Y( :weight ), Overlay( :sex ), Color( :age ) ),
    Elements( Points( X, Y, Legend( 1 ) ), Smoother( X, Y, Legend( 2 ) ) )
);
lgnd = gb << Get Legend Display;
items = lgnd << Get Items;
For Each( {item}, items, If( item << Get Type == "Marker", item << Set Visible( 0 ) ) );


```

### [Get Model](#get-model)

**Syntax:** obj \<< Get Model

**JMP Version Added:** 16

### [Get Models](#get-models)

**Syntax:** obj \<< Get Models

**JMP Version Added:** 16

### [Legend Position](#legend-position)

**Syntax:** obj \<< Legend Position( list )

**Description:** Rearranges the items within the LegendBox according to the inputted list.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Smoother( X, Y, Legend( 4 ) ) )
);
Report( gb )[LegendBox( 1 )] << Legend Position( {3, [4, 3], 4, [2, 1]} );


```

### [Legend Settings](#legend-settings)

**Syntax:** obj \<< Legend Settings

**Description:** Bring up the Legend window to change various settings.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 0 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
Report( gb )[LegendBox( 1 )] << Legend Settings;


```

### [Orientation](#orientation)

**Syntax:** obj \<< Orientation( vertical|horizontal )

**Description:** Sets the direction that the items within the LegendBox should face.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 0 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
Report( gb )[LegendBox( 1 )] << Orientation( "horizontal" );


```

### [Revert Legend](#revert-legend)

**Syntax:** obj \<< Revert Legend

**Description:** Reverts any changes made to the LegendBox.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 0 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
Report( gb )[LegendBox( 1 )] << Set Title( "Gender" );
Report( gb )[LegendBox( 1 )] << Revert Legend;


```

### [Set Max Items](#set-max-items)

**Syntax:** obj \<< Set Max Items( number )

**Description:** Specifies the maximum number of items to display in the legend. This setting prevents a noisy legend from overwhelming the graph.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :age ) ),
    Elements( Points( X, Y ), Smoother( X, Y ) )
);
Report( gb )[LegendBox( 1 )] << Set Max Items( 3 );


```

### [Set Title](#set-title)

**Syntax:** obj \<< Set Title( "string" )

**Description:** Sets the title of the LegendBox.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 0 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
Report( gb )[LegendBox( 1 )] << Set Title( "Gender" );


```

### [Set Wrap](#set-wrap)

**Syntax:** obj \<< Set Wrap( number )

**Description:** Specifies the number of lines the legend items should appear on; 0 indicates no wrapping (i.e., a single-wide column)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 0 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
Report( gb )[LegendBox( 1 )] << Set Wrap( 1 );


```

### [Sides](#sides)

**Syntax:** obj \<< Sides( top|left )

**Description:** Sets the position of the LegendBox.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 0 ) ), Smoother( X, Y, Legend( 1 ) ) )
);
Report( gb )[LegendBox( 1 )] << Sides( "left" );


```

### [font](#font)

**Syntax:** obj \<< font( fontname, <fontsize>, <fontstyle> )

**Description:** Specify the font to be used for text in the legend.

**JMP Version Added:** 14

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Smoother( X, Y, Legend( 4 ) ) )
);
Report( gb )[LegendBox( 1 )] << Legend Position( {3, [4, 3], 4, [2, 1]} );
Report( gb )[LegendBox( 1 )] << Font( "Arial", 12, "Bold Italic Underline" );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ), Overlay( :sex ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Smoother( X, Y, Legend( 4 ) ) )
);
Report( gb )[LegendBox( 1 )] << Legend Position( {3, [4, 3], 4, [2, 1]} );
Report( gb )[LegendBox( 1 )] << Font( "Arial", 12, 7 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [LineSeg](#lineseg)

## [Associated Constructors](#associated-constructors)

### [Line Seg](#line-seg)

**Syntax:** ls = Line Seg(x values, y values, \<Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) >, < Sizes( s ) > )>)

**Description:** Creates a display seg of connected line segments. The optional third argument enables row state assignments, from either a data table (dt) or independently.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Arrowhead](#arrowhead)

**Syntax:** obj \<< Arrowhead( "None"|"Start"|"End"|"Both" )

**Description:** Specifies when to draw arrowheads on the ends of a line segment.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Arrowhead( "Both" );


```

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Frame;


```

### [Get Arrowhead](#get-arrowhead)

**Syntax:** obj \<< Get Arrowhead

**Description:** The current value for specifying when arrowheads will be drawn on a line segment.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Arrowhead( "Both" );
Show( seg << Get Arrowhead );


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Connect Missing](#get-connect-missing)

**Syntax:** obj \<< Get Connect Missing

**Description:** Gets the missing value connection mode. One of "Connect Through","Connect Faded", "Connect Dashed" or "No Connection".

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
Show( seg << Get Connect Missing() );


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Gradient Transparency;


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Line Width;


```

### [Get Log Curve](#get-log-curve)

**Syntax:** 0|1 = obj \<< Get Log Curve

**Description:** Gets the Log Curve setting. If a graph has an axis that is using a log scale, the line will curve so that all points along the line have the same x and y values that they would have if the axis was linear.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));

// Change Y Axis scale to Log
g[AxisBox( 1 )] << Scale( "Log" );

seg << Set Log Curve( 1 );
seg << Get Log Curve;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Marker Size;


```

### [Get Point](#get-point)

**Syntax:** point = obj \<< Get Point( index )

**Description:** Returns the X and Y coordinates of the specified point.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Point( 2 );


```

### [Get Point Count](#get-point-count)

**Syntax:** Number = obj \<< Get Point Count

**Description:** Returns the number of points in the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Point Count;


```

### [Get Row Numbers](#get-row-numbers)

**Syntax:** matrix = obj \<< Get Row Numbers

**Description:** Returns a vector of marker row numbers.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Row Numbers;


```

### [Get Smooth](#get-smooth)

**Syntax:** 0|1 = obj \<< Get Smooth

**Description:** Returns smoother curve setting.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Smooth( 1 );
seg << Get Smooth;


```

### [Get Smoothness](#get-smoothness)

**Syntax:** 0..1 = obj \<< Get Smoothness

**Description:** Returns smoother curve setting.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Smoothness( 0.5 );
seg << Get Smoothness;


```

### [Get Unconnected Marker](#get-unconnected-marker)

**Syntax:** obj \<< Get Unconnected Marker

**Description:** Gets the marker to be used to represent line segments with a single endpoint.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
Show( seg << Get Unconnected Marker() );


```

### [Get X Values](#get-x-values)

**Syntax:** matrix = obj \<< Get X Values

**Description:** Returns a vector of the X coordinate values.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get X Values;


```

### [Get Y Values](#get-y-values)

**Syntax:** matrix = obj \<< Get Y Values

**Description:** Returns a vector of the Y coordinate values.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get Y Values;


```

### [Get halfpoint is unbounded line](#get-halfpoint-is-unbounded-line)

**Syntax:** 0|1 = obj \<< Get halfpoint is unbounded line

**Description:** Returns whether a single point with one missing coordinate is treated as an unbounded line.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Get halfpoint is unbounded line;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Gradient Transparency( "None" );


```

### [Label Offset](#label-offset)

**Syntax:** obj \<< Label Offset

**JMP Version Added:** 16

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Parent;


```

### [Set Arrowhead](#set-arrowhead)

**Syntax:** obj \<< Set Arrowhead( "None"|"Start"|"End"|"Both" )

**Description:** Specifies when to draw arrowheads on the ends of a line segment.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Arrowhead( "Both" );


```

### [Set Connect Missing](#set-connect-missing)

**Syntax:** obj \<< Set Connect Missing( "Connect Through"|"Connect Faded"|"Connect Dashed"|"No Connection" )

**Description:** Sets the missing value connection mode. One of "Connect Through","Connect Faded", "Connect Dashed" or "No Connection".

```

x = (1 :: 9) * 10;
y = [10, 20, ., 60, ., 40, 30, ., 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Connect Missing( "Connect Faded" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Set Log Curve](#set-log-curve)

**Syntax:** obj \<< Set Log Curve( state=0|1 )

**Description:** Sets the Log Curve setting. If a graph has an axis that is using a log scale, the line will curve so that all points along the line have the same x and y values that they would have if the axis was linear.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));

// Change Y Axis scale to Log
g[AxisBox( 1 )] << Scale( "Log" );

seg << Set Log Curve( 1 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Smooth](#set-smooth)

**Syntax:** obj \<< Set Smooth( state=0|1 )

**Description:** Sets the state for a smoother curve.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Smooth( 1 );


```

### [Set Smoothness](#set-smoothness)

**Syntax:** obj \<< Set Smoothness( number )

**Description:** Sets the state for a smoother curve.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Smoothness( 0.5 );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Transparency( .3 );


```

### [Set Unconnected Marker](#set-unconnected-marker)

**Syntax:** obj \<< Set Unconnected Marker( marker )

**Description:** Sets the marker to be used to represent line segments with a single endpoint. Use " " for no representation.

```

x = (1 :: 9) * 10;
y = [10, 20, ., 60, ., 40, 30, ., 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Unconnected Marker( "diamond" );


```

### [Set halfpoint is unbounded line](#set-halfpoint-is-unbounded-line)

**Syntax:** obj \<< Set halfpoint is unbounded line( state=0|1 )

**Description:** Sets whether a single point with one missing coordinate is treated as an unbounded line.

```

x = [.];
y = [30];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set halfpoint is unbounded line( 1 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Line Seg Example", g = Graph Box( Line Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Line Seg( 1 ) ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [LineUpBox](#lineupbox)

## [Associated Constructors](#associated-constructors)

### [Line Up Box](#line-up-box)

**Syntax:** y = Lineup Box( \<NCol( nc )>, \<Spacing( pixels, <vspace> )>, displayBoxArgs, ... )

**Description:** Returns a display box that neatly arranges the display boxes that it contains.

```

New Window( "Enter Numbers",
    <<Modal,
    <<Return Result,
    V List Box(
        lineup = Lineup Box( N Col( 2 ),
            Text Box( "Set this value" ),
            var1 = Number Edit Box( 42 ),
            Text Box( "Set another value" ),
            var2 = Number Edit Box( 86 )
        ),
        H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
    )
);


```

## [Item Messages](#item-messages)

### [Get N Col](#get-n-col)

**Syntax:** obj \<< Get N Col

**Description:** Gets the number of columns.

```

New Window( "Example",
    lb = Lineup Box( N Col( 2 ),
        Text Box( "Set this value" ),
        Text Edit Box( "42" ),
        Text Box( "Set another value" ),
        Text Edit Box( "86" )
    )
);
lb << Get N Col;


```

### [Get Spacing](#get-spacing)

**Syntax:** pixels = obj \<< Get Spacing( number )

**Description:** Gets the number of pixels that should separate the display boxes.

```

lineupbox = Lineup Box(
    Text Box( "Set this value" ),
    Text Edit Box( "42" ),
    Text Box( "Set another value" ),
    Text Edit Box( "83" )
);
New Window( "Example", V List Box( lineupbox ) );
lineupbox << get spacing();


```

### [NCol](#ncol)

**Syntax:** obj \<< NCol( number )

**Description:** Sets the number of columns.

```

lineupbox = Lineup Box(
    Text Box( "Set this value" ),
    Text Edit Box( "42" ),
    Text Box( "Set another value" ),
    Text Edit Box( "86" )
);
New Window( "Example", V List Box( lineupbox ) );
lineupbox << N Col( 1 );


```

### [Spacing](#spacing)

**Syntax:** obj \<< Spacing( pixels )

**Description:** Sets the number of pixels that should separate the display boxes.

```

lineupbox = Lineup Box(
    Text Box( "Set this value" ),
    Text Edit Box( "42" ),
    Text Box( "Set another value" ),
    Text Edit Box( "83" )
);
New Window( "Example", V List Box( lineupbox ) );
lineupbox << spacing( 20 );


```

### [Wrap When Printing](#wrap-when-printing)

**Syntax:** obj \<< Wrap When Printing

**Description:** Lineup will wrap as needed when printing.

```

Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
dist = Distribution(
    Arrange in Rows( 4 ),
    Continuous Distribution( Column( :Pop ) ),
    Continuous Distribution( Column( :"Pop Age 0-19"n ) ),
    Continuous Distribution( Column( :"Pop Age 20-59"n ) ),
    Continuous Distribution( Column( :"Pop Age 60+"n ) ),
    Continuous Distribution( Column( :"Portion 0-19"n ) ),
    Continuous Distribution( Column( :"Portion20-59"n ) ),
    Continuous Distribution( Column( :"Portion60+"n ) ),
    Continuous Distribution( Column( :"F Rate 0-19"n ) ),
    Continuous Distribution( Column( :"F Rate 20-59"n ) ),
    Continuous Distribution( Column( :"F Rate 60+"n ) )
);
(dist << Report)[Lineup Box( 1 )] << Wrap When Printing( 1 );
(dist << Report) << Save PDF( "$TEMP/JMPExample.pdf" );
Open( "$TEMP/JMPExample.pdf" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [LineUpRulerBox](#lineuprulerbox)

## [Associated Constructors](#associated-constructors)

### [Lineup Ruler Box](#lineup-ruler-box)

**Syntax:** y = Lineup Box( \<Widths( {width1, width2, ...} )>, displayBoxArgs, ... )

**Description:** Returns a display box that sets the column widths of the Lineup Boxes that it contains.

```


New Window( "Lineup Ruler",
    lrb = Lineup Ruler Box(
        Widths( {120, 200} ),
        Outline Box( "Customer 1",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(),

            )
        ),
        Outline Box( "Customer 2",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(),

            )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Get Widths](#get-widths)

**Syntax:** list = obj \<< Get Widths

**Description:** Returns the widths of the columns for the contained Lineup Boxes.

**JMP Version Added:** 16

```


New Window( "Lineup Ruler",
    lrb = Lineup Ruler Box(
        Widths( {120, 200} ),
        Outline Box( "Customer 1",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(),

            )
        ),
        Outline Box( "Customer 2",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(),

            )
        )
    )
);
lrb << Get Widths();


```

### [Widths](#widths)

**Syntax:** obj \<< Widths( list )

**Description:** Sets the widths of the columns for the contained Lineup Boxes.

**JMP Version Added:** 16

```


New Window( "Lineup Ruler",
    lrb = Lineup Ruler Box(
        Widths( {120, 200} ),
        Outline Box( "Customer 1",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(),

            )
        ),
        Outline Box( "Customer 2",
            Lineup Box( N Col( 2 ),
                Text Box( "First Name:" ),
                Text Edit Box(),
                Text Box( "Last Name:" ),
                Text Edit Box(),

            )
        )
    )
);
Wait( 2 );
lrb << Widths( {100, 150} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [LinesSeg](#linesseg)

## [Associated Constructors](#associated-constructors)

### [Lines Seg](#lines-seg)

**Syntax:** ls = Lines Seg([x1 y1 x2 y2,...])

**Description:** Creates a display seg with a sequence of line segments for the given x and y values. The optional second argument enables row state assignments, from either a data table (dt) or independently.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Delete;


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Frame;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Connected](#get-connected)

**Syntax:** 0|1 = obj \<< Get Connected

**Description:** Returns the connection state of all line segments in the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Get Connected;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << get description();


```

### [Get Line](#get-line)

**Syntax:** [x1 y1 x2 y2] = obj \<< Get Line( index )

**Description:** Returns the X and Y coordinates of the specified line.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Get Line( 2 );


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Get Line Color;


```

### [Get Line Count](#get-line-count)

**Syntax:** Number = obj \<< Get Line Count

**Description:** Returns the number of lines in the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Get Line Count;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Get Line Width;


```

### [Get Lines](#get-lines)

**Syntax:** [x1 y1 x2 y2, ...] = obj \<< Get Lines

**Description:** Returns the X and Y coordinate values for all lines.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Get Lines;


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Parent;


```

### [Set Connected](#set-connected)

**Syntax:** obj \<< Set Connected( state=0|1 )

**Description:** Sets the connection state for all line segments in the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Set Connected( 1 );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

lines = [30 20 80 70, 10 90 90 10, 40 20 60 30];
New Window( "Lines Seg Example", g = Graph Box( Lines Seg( lines ) ) );
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Lines Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [ListBox](#listbox)

## [Associated Constructors](#associated-constructors)

### [H List Box](#h-list-box)

**Syntax:** y = H List Box( \<Align( center|bottom )>, displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for bottom or center alignment of the contents inside the display box.

```

New Window( "Example",
    Outline Box( "Picker", H List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ) )
);


```

### [V List Box](#v-list-box)

**Syntax:** y = V List Box( \<Align( center|right )>, displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a vertical layout. The \<<Hold message tells the sheet to own the report(s) that will be excerpted. The optional Align argument allows for right or center alignment of the contents inside the display box.

```

New Window( "Example",
    Outline Box( "Picker", V List Box( Text Box( "Label:" ), Text Edit Box( Char( 213 ) ) ) )
);


```

## [Item Messages](#item-messages)

### [get horizontal](#get-horizontal)

**Syntax:** state=0|1 = obj \<< get horizontal

**Description:** Returns if the List Box is horizontal (1) or vertical (0).

```

New Window( "Example",
    Outline Box( "Outline Box",
        vlb = V List Box(
            hlb = H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) ),
            H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
        )
    )
);
Print( "Vertical List Box:", vlb << Get Horizontal );
Print( "Horizontal List Box:", hlb << Get Horizontal );


```

### [set horizontal](#set-horizontal)

**Syntax:** obj \<< set horizontal( state=0|1 )

**Description:** Sets the List Box to horizontal (1) or vertical (0).

```

New Window( "Example",
    Outline Box( "Outline Box",
        vlb = V List Box(
            hlb = H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) ),
            H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
        )
    )
);
hlb << Set Horizontal( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ListBoxBox](#listboxbox)

## [Associated Constructors](#associated-constructors)

### [List Box](#list-box)

**Syntax:** y = List Box( {item, ...}, \<width( pixels )>, \<maxSelected( 9999 )>, \<nlines( 12 )>, <script> )

**Description:** Returns a display box to show a list box of selection items. If item itself is a two-item list containing the item name and a string specifying a modeling type or sorting order, such as "Ordinal" or "Ascending", the appropriate icon will show up next to that item in the list box.

**Example 1**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);


```

**Example 2**

```

New Window( "Example",
    lb = List Box(
        {{"First Item", "continuous"}, {"Second Item", "ordinal"}, {"Third Item", "nominal"}},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);


```

## [Item Messages](#item-messages)

### [Append](#append)

**Syntax:** obj \<< Append( "string" | {"string", ...} )

**Description:** Appends the new string or list of strings to the last position.

**Example 1**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
slb << Append( "name" );


```

**Example 2**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
slb << Append( {"weight", "height", "name"} );


```

### [Clear selection](#clear-selection)

**Syntax:** obj \<< Clear selection

**Description:** Clears the current selection; the items are still there, but are no longer selected.

**Example 1**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Selected( 1 );
lb << Set Selected( 2 );
Wait( 1 );
lb << Clear Selection;


```

**Example 2**

```

New Window( "Each box clears the other box",
    window:la = List Box(
        {"broccoli", "spinach", "kale", "beet", "turnip"},
        <<setscript( window:lb << clearselection )
    ),
    window:lb = List Box(
        {"pepper", "avocado", "pumpkin", "tomato", "zucchini"},
        <<setscript( window:la << clearselection )
    )
);


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Enable Item](#enable-item)

**Syntax:** obj \<< Enable Item( index,enable )

**Description:** Allows the item at index to be enabled (1) or disabled (0).

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Enable Item( 2, 0 );


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Get Base Font;


```

### [Get Case Sensitive](#get-case-sensitive)

**Syntax:** "bool" = obj \<< Get Case Sensitive

**Description:** Returns true if items added to the list can match except for the case

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
slb << Append( "first item" );
slb << Get Case Sensitive();


```

### [Get Context Menu Script](#get-context-menu-script)

**Syntax:** list = obj \<< Get Context Menu Script

**Description:** Returns the context menu script attached to the calling object.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Context Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; ,
    "Get Context Menu Script", Print( lb << Get Context Menu Script )}
);


```

### [Get First Visible Item](#get-first-visible-item)

**Syntax:** index = obj \<< Get First Visible Item

**Description:** Returns the index of the first visible item.

**JMP Version Added:** 16

```

dt = Open( "$sample_data\big class.jmp" );
New Window( "test", lb = List Box( dt:name << get values ) );
lb << Set First Visible Item( 25 );
Print( lb << Get First Visible Item() );


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Item Padding](#get-item-padding)

**Syntax:** obj \<< Item Padding( sides ); sides = obj \<< Get Item Padding

**Description:** Padding adds space between listbox item text

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Item Padding( Left( 10 ), Top( 5 ), Right( 20 ), Bottom( 10 ) );


```

### [Get Items](#get-items)

**Syntax:** list = obj \<< Get Items

**Description:** Returns a list of all of the items.

**JMP Version Added:** 15

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Get Items;


```

### [Get Max Selected](#get-max-selected)

**Syntax:** max = obj \<< Get Max Selected

**Description:** Returns the maximum number of items that can be selected in the list.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Get Max Selected();


```

### [Get Menu Item State](#get-menu-item-state)

**Syntax:** 0|1|-1 = obj \<< Get Menu Item State( index )

**Description:** Gets the context menu item state of index menu item. The state will be normal (0), checked (1), or disabled (-1)

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Context Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
lb << Set Menu Item State( 2, -1 );
lb << Get Menu Item State( 2 );


```

### [Get N Lines](#get-n-lines)

**Syntax:** nlines = obj \<< Get N Lines

**Description:** Returns the number of visible lines in the list.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Get N Lines();


```

### [Get Selected](#get-selected)

**Syntax:** list = obj \<< Get Selected(\<"Column Reference">)

**Description:** Returns a list of the selected items.

**Example 1**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Items( {"age", "height"} );
lb << Set Selected( 2 );
Print( lb << Get Selected );


```

**Example 2**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Items( {"age", "height"} );
lb << Set Selected( 2 );
Print( lb << Get Selected( "Column Reference" ) );


```

### [Get Selected Indices](#get-selected-indices)

**Syntax:** indices = obj \<< Get Selected Indices

**Description:** Returns a list of all of the selected indices.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Selected( 2 );
Print( lb << Get Selected Indices );


```

### [Get Submenu](#get-submenu)

**Syntax:** obj \<< Get Submenu( index )

**Description:** Returns the number of submenus under the given menu item

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Context Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
lb << Set Submenu( 2, 3 );
lb << Get Submenu( 2 );


```

### [Insert](#insert)

**Syntax:** obj \<< Insert( "string",index )

**Description:** Adds the specified item or list of items to the list box after the specified index.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
slb << Insert( "name", 2 );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Item Enabled](#item-enabled)

**Syntax:** 0|1 = obj \<< Item Enabled( index )

**Description:** Returns if the item at index is enabled (1) or disabled (0).

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Enable Item( 2, 0 );
Print( lb << Item Enabled( 2 ) );


```

### [Item Padding](#item-padding)

**Syntax:** obj \<< Item Padding( sides ); sides = obj \<< Get Item Padding

**Description:** Padding adds space between listbox item text

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Item Padding( Left( 10 ), Top( 5 ), Right( 20 ), Bottom( 10 ) );


```

### [Locate Item](#locate-item)

**Syntax:** obj \<< Locate Item

**JMP Version Added:** 14

### [Menus Enabled](#menus-enabled)

**Syntax:** obj \<< Menus Enabled( state=0|1 )

**Description:** Enables or disables the ListBoxBox menu from appearing when you right-click.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Menus Enabled( 0 );


```

### [On Change](#on-change)

**Syntax:** obj \<< On Change( script )

**Description:** Executes the script when the selection in the list changes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example", clb = Col List Box( all, On Change( Show( clb << Get Items ) ) ) );
Wait( 1 );
dt << Delete Column( "height" );


```

### [Remove All](#remove-all)

**Syntax:** obj \<< Remove All

**Description:** Removes all of the items.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Remove All;


```

### [Remove Item](#remove-item)

**Syntax:** obj \<< Remove Item( index )

**Description:** Removes the item specified at index.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Append( {"weight", "height", "name"} );
Wait( 1 );
lb << Remove Item( 2 );


```

### [Remove Selected](#remove-selected)

**Syntax:** obj \<< Remove Selected

**Description:** Removes the selected items.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Selected( 2 );
lb << Remove Selected();


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Case Sensitive](#set-case-sensitive)

**Syntax:** obj \<< Set Case Sensitive( "bool" )

**Description:** Determines if items added to the list box should be compared against existing items with or without respect to case

```

New Window( "Example",
    lb1 = List Box( {"First Item", "Second Item", "Third Item"}, nlines( 6 ) ),
    lb2 = List Box( {"First Item", "Second Item", "Third Item"}, nlines( 6 ) )
);
lb1 << Set Case Sensitive( 0 );
lb1 << Append( "first item" );
lb2 << Append( "first item" );


```

### [Set Context Menu Script](#set-context-menu-script)

**Syntax:** obj \<< Set Context Menu Script( {"string",script,"string",script, ...} )

**Description:** Adds a context menu with the specified options and scripts to the box.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Context Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; ,
    "Get Context Menu Script", Print( lb << Get Context Menu Script )}
);


```

### [Set First Visible Item](#set-first-visible-item)

**Syntax:** obj \<< Set First Visible Item( index )

**Description:** Scrolls the list box so the requested item is the first visible item.

**JMP Version Added:** 16

```

dt = Open( "$sample_data\big class.jmp" );
New Window( "test", lb = List Box( dt:name << get values ) );
lb << Set First Visible Item( 25 );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when one or more items are selected.

**JMP Version Added:** 15

```

New Window( "Example",
    lb = List Box(
        {"First Item", "Second Item", "Third Item", "Fourth Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 5 )
    ),
    Text Box( "" )
);
lb << Set Function(
    Function( {thisBox},
        (thisBox << sib) << Set Text( Char( thisBox << get selected ) )
    )
);


```

### [Set Items](#set-items)

**Syntax:** obj \<< Set Items( list )

**Description:** Sets the list of all of the items.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
Wait( 1 );
lb << Set Items( {"age", "height"} );
lb << Get Items;


```

### [Set Max Selected](#set-max-selected)

**Syntax:** obj \<< Set Max Selected( max )

**Description:** Set the maximum number of items that can be selected in the list.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Max Selected( 1 );


```

### [Set Menu Item State](#set-menu-item-state)

**Syntax:** obj \<< Set Menu Item State( index, 0|1|-1 )

**Description:** Sets the context menu item at index to be normal (0), checked (1), or disabled (-1)

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Context Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
lb << Set Menu Item State( 2, -1 );


```

### [Set N Lines](#set-n-lines)

**Syntax:** obj \<< Set N Lines( nlines )

**Description:** Set the number of visible lines in the list.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set N Lines( 4 );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Selected](#set-selected)

**Syntax:** obj \<< Set Selected( index|{index1, index2, ...}|"All",<selected>,\<Run Script(0|1)> )

**Description:** Sets the item at index to be selected (1) or deselected (0). By default, this message runs the script for its ListBoxBox. Use RunScript(0) to suppress running the script. Using the RunScript option also requires specifying the selected argument, as the arguments are positional.

**Example 1**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Selected( 2, 1 );
Print( lb << Get Selected );


```

**Example 2**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Max Selected( -1 );
lb << Set Selected( "All", 1 );
Print( lb << Get Selected );


```

**Example 3**

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Max Selected( -1 );
selList = {3, 1};
lb << Set Selected( selList, 1 );
Print( lb << Get Selected );


```

### [Set Size](#set-size)

**Syntax:** obj \<< Set Size( width,height )

**Description:** Sets the width and height of the ListBoxBox.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Size( 150, 400 );


```

### [Set Submenu](#set-submenu)

**Syntax:** obj \<< Set Submenu( index, submenu count )

**Description:** Turns the "index" menu item into a submenu with "submenu count" menu items

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Context Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
lb << Set Submenu( 2, 3 );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Set Tips](#set-tips)

**Syntax:** obj \<< Set Tips( List of tips )

**Description:** Sets tips for individual items in the listbox.

```

New Window( "Example",
    slb = lb = fontobj = List Box(
        {"First Item", "Second Item", "Third Item"},
        width( 200 ),
        max selected( 2 ),
        nlines( 6 )
    )
);
lb << Set Tips( {"Tip 1", "Tip 2", "Tip 3"} );


```

### [Show Item](#show-item)

**Syntax:** obj \<< Show Item( index )

**Description:** Scrolls the listbox to make sure the requested item is visible in the list box.

**JMP Version Added:** 16

```

dt = Open( "$sample_data\big class.jmp" );
New Window( "test", lb = List Box( dt:name << get values ) );
lb << show item( 25 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [MapSeg](#mapseg)

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << Delete;


```

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << Frame;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << get description();


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << Parent;


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << set description( "my seg" );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( transparency )

**Description:** Sets the transparency for the map where 0.0 is completely transparent and 1.0 is completely opaque.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [MarkerSeg](#markerseg)

## [Associated Constructors](#associated-constructors)

### [Marker Seg](#marker-seg)

**Syntax:** me = Marker Seg( x, y, < Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) >, < Sizes( s ) > )

**Description:** Returns a display seg with markers for all of the X and Y values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Always Show Label](#always-show-label)

**Syntax:** obj \<< Always Show Label( {pt, state=0|1}, ... )

**Description:** Always show the marker label even if it being hidden by an overlapping label

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
For( i = 1, i <= 40, i++,
    Labeled( Row State( i ) ) = 1
);
r = Bivariate( Y( :weight ), X( :height ) ) << Report();
frame = r[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << always show label( {0, 1}, {1, 1}, {2, 1}, {3, 1}, {4, 1}, {5, 1} );


```

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color](#color)

**Syntax:** obj \<< Color( color )

**Description:** Sets the color for all markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Color( "Green" );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Density Gradient( "Fade to Gray" );


```

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Frame;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Color](#get-color)

**Syntax:** color = obj \<< Get Color

**Description:** Returns the marker color.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Color;


```

### [Get Colors](#get-colors)

**Syntax:** list = obj \<< Get Colors

**Description:** Returns a list of marker colors based on the row states for the markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Colors;


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << get description();


```

### [Get Force Labels](#get-force-labels)

**Syntax:** obj \<< Get Force Labels( "No Labels"|"Label by Value"|"Label by Row"|"Label by Row and Value" )

**Description:** Label every marker regardless of the data table row state flags.

**JMP Version Added:** 18

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Gradient Transparency;


```

### [Get Hide Missing Color](#get-hide-missing-color)

**Syntax:** true/false = obj \<< Get Hide Missing Color

```

Random Reset( 1111111 );
n = 1000;
T1 = J( n, 1, Random Normal() );
T1[Loc( J( n, 1, Random Integer( 0, 1 ) ) )] = .;
dt = New Table( "Test",
    New Column( "X", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "Y", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "T1", Values( T1 ) ),

);
obj = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :X ), Y( :Y ), Color( :T1 ) ),
    Elements( Points( X, Y, Legend( 16 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Hide Missing Color;


```

### [Get Hide Missing Size](#get-hide-missing-size)

**Syntax:** true/false = obj \<< Get Hide Missing Size

```

Random Reset( 1111111 );
n = 1000;
T1 = J( n, 1, Random Normal() );
T1[Loc( J( n, 1, Random Integer( 0, 1 ) ) )] = .;
dt = New Table( "Test",
    New Column( "X", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "Y", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "T1", Values( T1 ) ),

);
obj = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :X ), Y( :Y ), Size( :T1 ) ),
    Elements( Points( X, Y, Legend( 16 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Hide Missing Size;


```

### [Get Jitter](#get-jitter)

**Syntax:** {method, axis, limit, spacing, seed, side, overlap, grid offset, smoothing, max error, bandwidth} = obj \<< Get Jitter

**Description:** Returns settings used to offset marker positions for collision reduction. method is none|random uniform|random normal|centered|centered grid|positive grid. axis is X|Y|XY. limit is the width of the jitter, adjusted for the method. spacing is the percentage of the marker size using for jittering or 0 for auto-adjustment.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
r = Oneway( Y( :height ), X( :sex ), Means( 1 ), MeanDiamonds( 1 ), XAxisProportional( 0 ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
{method, axis, limit, spacing, seed, side, overlap, grid offset, smoothing, max error,
bandwidth} = seg << Get Jitter();


```

### [Get Jitter Offsets](#get-jitter-offsets)

**Syntax:** matrix = obj \<< Get Jitter Offsets

**Description:** Returns an N by 2 matrix of X and Y jitter offsets.

```

x = J( 1, 100, Random Normal() );
y = J( 1, 100, 0 );
New Window( "Marker Seg Example",
    g = Graph Box(
        X Scale( -4, 4 ),
        Y Scale( -0.5, 0.5 ),
        Frame Size( 300, 200 ),
        Marker Seg( x, y, <<Set Marker Size( 5 ), <<Set Jitter( {"Grid", "Y"} ) )
    )
);
seg = (g[FrameBox( 1 )] << Find Seg( Marker Seg( 1 ) ));
jitter = seg << Get Jitter Offsets;
avg = Mean( jitter[0, 1] );


```

### [Get Label Value Axis](#get-label-value-axis)

**Syntax:** obj \<< Get Label Value Axis( "X"|"Y" )

**Description:** Whether forced labels show the X or Y value.

**JMP Version Added:** 18

### [Get Label Value Format](#get-label-value-format)

**Syntax:** obj \<< Get Label Value Format

**Description:** How to format the X or Y value; Auto means use axis format.

**JMP Version Added:** 18

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Marker;


```

### [Get Marker Draw Column](#get-marker-draw-column)

**Syntax:** column = obj \<< Get Marker Draw Column

**Description:** Returns any custom marker drawing data table column.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class Families.jmp" );
r = Bivariate( Y( :height ), X( :weight ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
seg << Set Marker Draw Column( :picture );
ex = seg << Get Marker Draw Column();


```

### [Get Marker Draw Expr](#get-marker-draw-expr)

**Syntax:** expr = obj \<< Get Marker Draw Expr

**Description:** Returns the custom marker drawing expression.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
r = Bivariate( Y( :height ), X( :weight ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
seg << Set Marker Draw Expr( [-1 0, 0 2, 1 0, 0 1, -1 0] );
ex = seg << Get Marker Draw Expr();


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the marker size.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Marker Size;


```

### [Get Markers](#get-markers)

**Syntax:** list = obj \<< Get Markers

**Description:** Returns a list of markers based on the row states.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Markers;


```

### [Get Overlay Color](#get-overlay-color)

**Syntax:** color = obj \<< Get Overlay Color( marker index )

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
op = dt << Overlay Plot( X( :age ), Y( :height, :weight ) );
rep = op << report;
frame = rep[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Overlay Color( 1 );


```

### [Get Overlay Count](#get-overlay-count)

**Syntax:** number = obj \<< Get Overlay Count

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
op = dt << Overlay Plot( X( :age ), Y( :height, :weight ) );
rep = op << report;
frame = rep[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Overlay Count;


```

### [Get Overlay Marker](#get-overlay-marker)

**Syntax:** marker = obj \<< Get Overlay Marker( marker index )

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
op = dt << Overlay Plot( X( :age ), Y( :height, :weight ) );
rep = op << report;
frame = rep[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Overlay Marker( 1 );


```

### [Get Point](#get-point)

**Syntax:** point = obj \<< Get Point( index )

**Description:** Returns the X and Y coordinates of the specified point.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Point( 2 );


```

### [Get Point Count](#get-point-count)

**Syntax:** Number = obj \<< Get Point Count

**Description:** Returns the number of points in the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Point Count;


```

### [Get Row Numbers](#get-row-numbers)

**Syntax:** matrix = obj \<< Get Row Numbers

**Description:** Returns a vector of marker row numbers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
x = [10 50 70];
y = [60 50 10];
New Window( "Marker Seg Example",
    g = Graph Box( Marker Seg( x, y, Row States( dt, [5 7 9] ) ) )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Row Numbers;


```

### [Get Sizes](#get-sizes)

**Syntax:** matrix = obj \<< Get Sizes

**Description:** Returns a vector of marker sizes.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Sizes;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 and 1.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Transparency;


```

### [Get Value Label Width](#get-value-label-width)

**Syntax:** obj \<< Get Value Label Width( number )

**Description:** Maximum width for a formatted label value.

**JMP Version Added:** 18

### [Get X Values](#get-x-values)

**Syntax:** matrix = obj \<< Get X Values

**Description:** Returns a list of X values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get X Values;


```

### [Get Y Values](#get-y-values)

**Syntax:** matrix = obj \<< Get Y Values

**Description:** Returns a list of Y values.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Get Y Values;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Gradient Transparency( "None" );


```

### [Label Offset](#label-offset)

**Syntax:** obj \<< Label Offset( {pt, x offset, y offset}, ... )

**Description:** Positions row labels according to the given coordinates.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Labeled( Row State( 5 ) ) = 1;
Labeled( Row State( 8 ) ) = 1;
dist = Distribution( Continuous Distribution( Column( :height ) ) );
frame = (dist << report)[FrameBox( 2 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << label offset( {0, -20, -10}, {1, -20, -30} );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Marker Size( "XL" );
Wait( 1 );
seg << Set Marker Size( "dot" );


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Parent;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

**Description:** Changes the seg back to its original state.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
Wait( 1 );
seg << Set Color( "Red" );
Wait( 1 );
seg << Revert;


```

### [Set Color](#set-color)

**Syntax:** obj \<< Set Color( color )

**Description:** Sets the color for all markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Color( "Green" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Set Force Labels](#set-force-labels)

**Syntax:** obj \<< Set Force Labels( "No Labels"|"Label by Value"|"Label by Row"|"Label by Row and Value" )

**Description:** Label every marker regardless of the data table row state flags.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            {DispatchSeg(
                Marker Seg( 1 ),
                Set Force Labels( "Label by Value" ),
                Set Label Value Axis( "X" ),
                Set Label Value Format( "Fixed", 1 )
            )}
        )
    )
);


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Hide Missing Color](#set-hide-missing-color)

**Syntax:** obj \<< Set Hide Missing Color( true/false )

```

Random Reset( 1111111 );
n = 1000;
T1 = J( n, 1, Random Normal() );
T1[Loc( J( n, 1, Random Integer( 0, 1 ) ) )] = .;
dt = New Table( "Test",
    New Column( "X", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "Y", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "T1", Values( T1 ) ),

);
obj = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :X ), Y( :Y ), Color( :T1 ) ),
    Elements( Points( X, Y, Legend( 16 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Hide Missing Color( true );


```

### [Set Hide Missing Size](#set-hide-missing-size)

**Syntax:** obj \<< Set Hide Missing Size( true/false )

```

Random Reset( 1111111 );
n = 1000;
T1 = J( n, 1, Random Normal() );
T1[Loc( J( n, 1, Random Integer( 0, 1 ) ) )] = .;
dt = New Table( "Test",
    New Column( "X", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "Y", Values( J( n, 1, Random Uniform() ) ) ),
    New Column( "T1", Values( T1 ) ),

);
obj = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :X ), Y( :Y ), Size( :T1 ) ),
    Elements( Points( X, Y, Legend( 16 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Hide Missing Size( true );


```

### [Set Jitter](#set-jitter)

**Syntax:** obj \<< Set Jitter( {method, axis, limit, spacing, seed, side, overlap, grid offset, smooth, max error, bandwidth} )

**Description:** Applies an offset to marker positions for collision reduction. method is none|random uniform|random normal|centered|centered grid|positive grid. axis is X|Y|XY. limit is the width of the jitter, adjusted for the method. spacing is the percentage of the marker size using for jittering or 0 for auto-adjustment.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
r = Oneway( Y( :height ), X( :sex ), Means( 1 ), MeanDiamonds( 1 ), XAxisProportional( 0 ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
seg << Set Jitter( {"Grid", "X", 1, 0, 0, "Centered"} );


```

### [Set Label Value Axis](#set-label-value-axis)

**Syntax:** obj \<< Set Label Value Axis( "X"|"Y" )

**Description:** Whether forced labels show the X or Y value.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            {DispatchSeg(
                Marker Seg( 1 ),
                Set Force Labels( "Label by Value" ),
                Set Label Value Axis( "X" ),
                Set Label Value Format( "Fixed", 1 )
            )}
        )
    )
);


```

### [Set Label Value Format](#set-label-value-format)

**Syntax:** obj \<< Set Label Value Format

**Description:** How to format the X or Y value; Auto means use axis format.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            {DispatchSeg(
                Marker Seg( 1 ),
                Set Force Labels( "Label by Value" ),
                Set Label Value Axis( "X" ),
                Set Label Value Format( "Fixed", 1 )
            )}
        )
    )
);


```

### [Set Label Value Width](#set-label-value-width)

**Syntax:** obj \<< Set Label Value Width( number )

**Description:** Maximum width for a formatted label value.

**JMP Version Added:** 18

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Set Marker Draw Column](#set-marker-draw-column)

**Syntax:** obj \<< Set Marker Draw Column( column )

**Description:** Sets a custom marker drawing data table column, which could be a picture, matrix of points, text, drawing code or a function.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Big Class Families.jmp" );
r = Bivariate( Y( :height ), X( :weight ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
Wait( 2 );
seg << Set Marker Draw Column( :sex );
Wait( 2 );
seg << Set Marker Draw Column( :picture );


```

### [Set Marker Draw Expr](#set-marker-draw-expr)

**Syntax:** obj \<< Set Marker Draw Expr( expr )

**Description:** Sets a custom marker drawing expression, which could be a matrix of points, text, drawing code or a function.

**JMP Version Added:** 16

#### [Drawing function](#drawing-function)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
r = Bivariate( Y( :height ), X( :weight ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
seg << Set Marker Draw Expr(
    Function( {this seg, this row, x, y, size, row state},
        If( Mod( this row, 2 ) == 1,
            Line(
                Eval List( {x, y} ),
                Eval List( {:weight[this row + 1], :height[this row + 1]} )
            );
            "A";
        ,
            "B"
        )
    )
);


```

#### [Drawing script](#drawing-script)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
r = Bivariate( Y( :height ), X( :weight ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
seg << Set Marker Draw Expr( Expr( Arc( -2, -:age / 3, 2, :age / 3, -90, 90 ) ) );


```

#### [Matrix polyline](#matrix-polyline)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
r = Bivariate( Y( :height ), X( :weight ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
seg << Set Marker Draw Expr( [-1 0, 0 2, 1 0, 0 1, -1 0] );


```

#### [Text](#text)

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
r = Bivariate( Y( :height ), X( :weight ) );
frame = (r << report)[FrameBox( 1 )];
seg = (frame << FindSeg( Marker Seg( 1 ) ));
seg << Set Marker Draw Expr( Expr( :sex || Char( :age ) ) );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Marker Size( "XL" );
Wait( 1 );
seg << Set Marker Size( "dot" );


```

### [Set Overlay Color](#set-overlay-color)

**Syntax:** obj \<< Set Overlay Color( marker index, color )

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
op = dt << Overlay Plot( X( :age ), Y( :height, :weight ) );
rep = op << report;
frame = rep[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Overlay Color( 1, "Green" );


```

### [Set Overlay Marker](#set-overlay-marker)

**Syntax:** obj \<< Set Overlay Marker( marker index, marker )

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
op = dt << Overlay Plot( X( :age ), Y( :height, :weight ) );
rep = op << report;
frame = rep[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Overlay Marker( 1, "Star" );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the marker transparency. The argument should be a numeric value between 0 and 1.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Transparency( .3 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the marker transparency. The argument should be a numeric value between 0 and 1.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
xx = Column( "height" ) << Get Values;
aa = [=> 0];
sz = Column( "age" ) << get values;
yy = J( N Rows( xx ), 1, 0 );
For( ii = 1, ii <= N Rows( xx ), ii++,
    aa[xx[ii]]++;
    yy[ii] = aa[xx[ii]];
);
New Window( "Marker Seg Example",
    g = Graph Box(
        Frame Size( 300, 120 ),
        X Scale( Min( xx ) - 5, Max( xx ) + 5 ),
        Y Scale( 0, 10 ),
        Marker Seg( xx, yy, Row States( dt ) )
    )
);
frame = g[FrameBox( 1 )];
seg = (frame << Find Seg( Marker Seg( 1 ) ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [MatrixBox](#matrixbox)

## [Associated Constructors](#associated-constructors)

### [Matrix Box](#matrix-box)

**Syntax:** y = Matrix Box( matrix, < \<<Column Names( "c1", "c2", ... )>, < \<<Row Names( "r1", "r2", ... )> )

**Description:** Returns a display box that contains a matrix.

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );


```

## [Item Messages](#item-messages)

### [Align Decimal Separator](#align-decimal-separator)

**Syntax:** obj \<< Align Decimal Separator( state=0|1 )

**Description:** Specifies that the values in the column are vertically aligned using the decimal separator.

**JMP Version Added:** 17

```

New Window( "Example", mb = Matrix Box( [1.2, 3.14, 45.6789] ) );
mb << Align Decimal Separator( 1 );


```

### [Column Names](#column-names)

**Syntax:** obj \<< Column Names( strings or list of strings )

**JMP Version Added:** 15

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Column Names( "A", "B", "C" );


```

### [Enable Semantic Formats](#enable-semantic-formats)

**Syntax:** obj \<< Enable Semantic Formats( state=0|1 )

**Description:** Controls whether semantic formats are applied to the matrix. Semantic formats can also be controlled via preferences.

**JMP Version Added:** 17

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Enable Semantic Formats( 0 );
Show( mb << Get Enable Semantic Formats );


```

### [Get](#get)

**Syntax:** matrix = obj \<< Get

**Description:** Returns a list representing the matrix.

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
Print( mb << Get );


```

### [Get Align Decimal Separator](#get-align-decimal-separator)

**Syntax:** obj \<< Get Align Decimal Separator

**Description:** Returns 1 if the columns align values on the decimal separator, 0 otherwise.

**JMP Version Added:** 17

```

New Window( "Example", mb = Matrix Box( [1.2, 3.14, 45.6789] ) );
mb << Get Align Decimal Separator;


```

### [Get Effective Format](#get-effective-format)

**Syntax:** obj \<< Get Effective Format( col, <row> )

**Description:** Returns a column's effective format, that is the format after applying any matching semantic format. If row is given, returns the effective format for just that row.

**JMP Version Added:** 17

```

New Window( "Example MB",
    mb = Matrix Box(
        [0.123 0.123, 3.1415 3.1415, 45.6789 45.6789],
        Column Names( "Column1", "Column2" )
    )
);
mb << Set Format( "Fixed Dec", 10, 2 );

// Create a semantic format
Preferences(
    Semantic formatting(
        Add Semantic Format(
            Format Name( "Example MB Format" ),
            Semantic Format( Format( "Scientific", 20, 2 ) ),
            Criteria( Object Name( "Column1" ), Platform Name( "Example MB" ) )
        )
    )
);

Show( mb << Get Effective Format( 1 ), mb << Get Effective Format( 2 ), mb << Get Format );


```

### [Get Enable Semantic Formats](#get-enable-semantic-formats)

**Syntax:** obj \<< Get Enable Semantic Formats

**Description:** Get the matrix's Enable Semantic Formats setting. Semantic formats can also be controlled via preferences.

**JMP Version Added:** 17

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Enable Semantic Formats( 0 );
Show( mb << Get Enable Semantic Formats );


```

### [Get Format](#get-format)

**Syntax:** obj \<< Get Format( width, decimalplaces )

**Description:** Returns the current format specification.

**JMP Version Added:** 14

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Set Format( 5, 1 );
mb << Get Format;


```

### [Make Combined Data Table](#make-combined-data-table)

**Syntax:** obj \<< Make Combined Data Table( \<Invisible(bool)> )

**Description:** Makes a data table from all similar matrices.

**Example 1**

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Make Combined Data Table;


```

**Example 2**

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Make Combined Data Table( invisible( 1 ) );


```

### [Make into Data Table](#make-into-data-table)

**Syntax:** obj \<< Make into Data Table( \<Invisible(bool) | Private(bool)> )

**Description:** Creates a new data table that contains the values in the MatrixBox.

**Example 1**

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Make into Data Table;


```

**Example 2**

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Make into Data Table( invisible( 1 ) );


```

### [Open](#open)

**Syntax:** obj \<< Open( state=0|1 )

**Description:** Shows or hides the values within the MatrixBox.

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Open( 0 );


```

### [Row Names](#row-names)

**Syntax:** obj \<< Row Names( strings or list of strings )

**JMP Version Added:** 15

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Row Names( "First", "Second" );


```

### [Set](#set)

**Syntax:** obj \<< Set( matrix )

**Description:** Set the matrix from a list.

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
Wait( 2 );
mb << Set( [11 22, 33 44, 55 66] );


```

### [Set Conditional Format](#set-conditional-format)

**Syntax:** obj \<< Set Conditional Format( None|Correlation|PValue|Factor Pattern )

**Description:** Sets the data format of the matrix values.

```

Open( "$SAMPLE_DATA/Body Measurements.jmp" );
New Window( "Example",
    multi = Multivariate(
        Y(
            :Mass, :Fore, :Bicep, :Chest, :Neck, :Shoulder, :Waist, :Height, :Calf, :Thigh,
            :Head
        ),
        Estimation Method( "Row-wise" ),
        Scatterplot Matrix( Density Ellipses( 1 ), Shaded Ellipses( 0 ), Ellipse Color( 3 ) )
    )
);
multir = multi << report;
mb = multir[Matrix Box( 1 )];
mb << Set Conditional Format( "Factor Pattern" );


```

### [Set Format](#set-format)

**Syntax:** obj \<< Set Format( "format", \<width, <decimal places>>, \<"Use thousands separator"> )

**Description:** Set the format of the numbers to display.

#### [Fixed](#fixed)

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Set Format( "Fixed", 5, 1 );


```

#### [Scientific](#scientific)

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Set Format( {"Scientific", 8, 2} );


```

### [Sort](#sort)

**Syntax:** obj \<< Sort( column, ascending )

**Description:** Sorts the rows of the matrix based on one of the columns. If 0 is specified for the column, the sort is removed.

```

New Window( "Example", mb = Matrix Box( [1 2 31, 4 3 21] ) );
mb << Sort( 1, true );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [MosaicSeg](#mosaicseg)

## [Item Messages](#item-messages)

### [Add Graphics Script](#add-graphics-script)

**Syntax:** obj \<< Add Graphics Script( \<"Back" | "Front" | position>, \<Description("name")>, \<"Selected Layer">, \<Scale IDs(XID, YID)>, script )

**Description:** Enter a script that will draw inside this frame. Selected elements are always above unselected elements. If you specify a selected layer, this script is called during the second drawing pass, when selected elements are drawn.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[frame box( 1 )];
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {1.0, 0.5, 0.0} );
    Polygon( [60, 72, 57], [75, 120, 120] );
);


```

**Example 2**

```


gbox = Graph Box(
    Frame Size( 300, 300 ),
    X Axis( Scale ID( 1 ), Side( 1 ), Min( 1 ), Max( 100 ), Inc( 5 ) ),
    X Axis( Scale ID( 2 ), Side( 2 ), Min( 4 ), Max( 50 ), Inc( 3 ) ),
    Y Axis( Scale ID( 3 ), Min( -100 ), Max( 200 ) ),
    Y Axis( Scale ID( 4 ), Side( 2 ), Min( 1 ), Max( 10 ), Inc( 1 ) ), 

);

fbox = gbox[frame box( 1 )];

fbox << Add Graphics Script(
    Scale IDs( 1, 4 ), //use scale ID's 1 and 4 for this graphics script
    Pen Color( "Green" );
    Line( [20 50 80], [4 3 6] );
);
New Window( "Example", gbox );


```

**Example 3**

```

table = New Table( "test table",
    Add Rows( 150000 ),
    <<New Column( "X", "Numeric", <<Set Each Value( Random Normal() ) ),
    <<New Column( "Y", "Numeric", <<Set Each Value( Random Normal() ) )
);
b = Bivariate( X( :x ), Y( :y ) );
table << select rows( 1 :: 10000 );
Report( b )[Frame Box( 1 )] << Add Graphics Script(
    Description( "Red Line Above Selected" ),
    "selected layer",
    Pen Color( "Red" );
    Pen Size( 5 );
    Line( [-5, 5], [-5, 5] );
);
Report( b )[Frame Box( 1 )] << Add Graphics Script(
    Description( "Green Line Below Selected Above Unselected" ),
    Pen Color( "Green" );
    Pen Size( 3 );
    Line( [5, -5], [-5, 5] );
);


```

### [Add Image](#add-image)

**Syntax:** obj \<< Add Image( image | open("image filename"), \<bounds( left(value), top(value), bottom(value), right(value) ) | move(centerX, centerY)> )

**Description:**

Adds an image to the frame.

You can reference an existing image (already created via a new image() or open() command) or you can specify an image file directly with the open() parameter. The image can be positioned in the frame by the move() command, which specifies where to place the center of the image based on the axes units. Or the image can be sized and placed in the frame by specifying the bounds().

```

img = Open( "$SAMPLE_IMAGES/windmap.png", "png" );
w = New Window( "View Image",
    Graph Box(
        FrameSize( 500, 500 ),
        X Scale( 0, 100 ),
        Y Scale( 0, 100 ),
        <<Add Image(
            image( img ),
            bounds( top( 90 ), Left( 10 ), bottom( 10 ), Right( 90 ) )
        )
    )
);


```

### [Append Seg](#append-seg)

**Syntax:** obj \<< Append Seg( display seg )

**Description:** Adds a display seg to the FrameBox

```

x = [20, 40, 60, 80];
New Window( "Example",
    Graph Box( Frame Size( 300, 120 ), Append Seg( Marker Seg( x, x ), Line Seg( x, x ) ) ),
    Graph Box( Frame Size( 300, 120 ) )
);
gb2 = Current Report()[FrameBox( 2 )];
gb2 << append seg( Current Report()[FrameBox( 1 )] << find seg( Marker Seg( 1 ) ) );


```

### [Background Map](#background-map)

**Syntax:** obj \<< Background Map( \<Images("None" | "Simple Earth" | "Detailed Earth" | "Nasa Server" | ("Web Map Service", url, layer) , \<Transparency(0-1)> )> | \<Boundaries("None" | Shape File)> )

**Description:**

Adds a background map to the frame.

Images are rasterized maps and support transparency. Boundaries are vector maps, defined by a shape file, and can be created by a user. You can specify either an image or a boundary or both.

```

dt = Open( "$SAMPLE_DATA/Hurricanes.jmp" );
plot = Bubble Plot(
    X( :Longitude ),
    Y( :Latitude ),
    Sizes( :"Wind (Knots)"n ),
    Time( :Date ),
    Coloring( :Landfall in USA ),
    ID( :Name and ID ),
    Speed( 1 ),
    Time Index( 2117.70195 ),
    Trail Bubbles( 1 ),
    All Labels( 0 ),
    No Labels( 0 ),
    Title Position( -88.679, 59.73 )
);
rplot = plot << report;
framebox = rplot[Frame Box( 1 )];
framebox << Background Map(
    Images( "Simple Earth", Transparency( 0.7 ) ),
    Boundaries( "World" )
);


```

### [Bottom](#bottom)

**Syntax:** obj \<< Bottom( state=0|1 )

**Description:** Shows or hides a border on the bottom of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Bottom( 0 );


```

### [Cell Labeling](#cell-labeling)

**Syntax:** obj \<< Cell Labeling( "No Labels"|"Label by Count"|"Label by Percent"|"Label by Value"|"Label by Row" )

**JMP Version Added:** 15

### [Child Seg](#child-seg)

**Syntax:** obj \<< Child Seg

**Description:** Returns the display seg child of the Framebox

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[Frame Box( 1 )] << Child Seg();


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Copy Customizations](#copy-customizations)

**Syntax:** obj \<< Copy Customizations

**Description:** Copy a script that contains graph customizations.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Marker Drawing Mode( outlined );
framebox1 << Copy Customizations;
framebox2 << Paste Customizations;


```

### [Copy Frame Contents](#copy-frame-contents)

**Syntax:** obj \<< Copy Frame Contents

**Description:** Create Journal text containing settings for this frame and copy it to the clipboard.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
biv << Fit Line;
framebox1 << Copy Frame Contents;
framebox2 << Paste Frame Contents;


```

### [Copy Frame Settings](#copy-frame-settings)

**Syntax:** obj \<< Copy Frame Settings

**Description:** Create a script containing settings for this frame, and copy it to the clipboard.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Background Color( "Green" );
framebox1 << Copy Frame Settings;
framebox2 << Paste Frame Settings;


```

### [Copy Polygons](#copy-polygons)

**Syntax:** obj \<< Copy Polygons

**Description:** Saves a copy of the polygons located on the frame to the clipboard.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
pa = framebox << Add Polygon Annotation(
    Points( {144, 53}, {182, 30}, {213, 80}, {181, 95} )
);
pa << Closed( 1 );
framebox << Copy Polygons;


```

### [Customize](#customize)

**Syntax:** obj \<< Customize

**Description:** Change the properties of the graph contents.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Customize;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

seg << Density Gradient( "Fade to Gray" );


```

### [Dispatch Segs](#dispatch-segs)

**Syntax:** obj \<< Dispatch Segs( command )

**Description:** Sends command to all visual elements ('segs') in the display box.

**JMP Version Added:** 15

### [DispatchSeg](#dispatchseg)

**Syntax:** obj \<< DispatchSeg( command )

**Description:** Sends command to the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
Distribution(
    Continuous Distribution( Column( :weight ), Fit Distribution( Normal ) ),
    Nominal Distribution( Column( :age ) ),
    SendToReport(
        Dispatch( {"weight"}, "Distrib Histogram", FrameBox,
            {DispatchSeg(
                Hist Seg( 1 ),
                {Line Style( "Dotted" ), Fill Color( {0, 128, 0} ), Histogram Color( -32768 )
                }
            ), DispatchSeg( Line Seg( 1 ), {Line Color( {0, 0, 255} ), Line Width( 5 )} )}
        )
    )
);


```

### [Edit Graphics Script](#edit-graphics-script)

**Syntax:** obj \<< Edit Graphics Script

**Description:** Edit scripts already installed in this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[frame box( 1 )];
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {1.0, 0.5, 0.0} );
    Polygon( [60, 72, 57], [75, 120, 120] );
);
framebox << Edit Graphics Script;


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fill Selection Mode](#fill-selection-mode)

**Syntax:** obj \<< Fill Selection Mode( "Preferred Mode"|"Selected Patterned"|"Selected Darker"|"Selected Outlined"|"Selected Same Color"|"Unselected Faded" )

**Description:** Sets the selection style for fills.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = Distribution( Continuous Distribution( Column( :height ) ), Histograms Only );
rdist = dist << report;
dt << Select Where( dt:age == 12 );
framebox = rdist[Frame Box( 1 )];
framebox << Fill Selection Mode( "Selected Darker" );


```

### [Find Seg](#find-seg)

**Syntax:** obj \<< Find Seg( display seg )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
ms = rbiv[Frame Box( 1 )] << Find Seg( Marker Seg( 1 ) );
ms << delete;


```

### [Find Segs](#find-segs)

**Syntax:** obj \<< Find Segs

**JMP Version Added:** 15

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame Size](#frame-size)

**Syntax:** obj \<< Frame Size

**Description:** Change the frame size.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Frame Size( 300, 300 );


```

### [Get Background Fill](#get-background-fill)

**Syntax:** obj \<< Get Background Fill

**Description:** Returns the state (0|1) of the background fill color of graph.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( weight ), x( height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
//Set background color
framebox << Background Color( "red" );
//Wait to see the color change
Wait( 1 );
//Turn off background fill color
framebox << Set Background Fill( 0 );
val1 = framebox << Get Background Fill;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

seg << Get Density Gradient;


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fill Selection Mode](#get-fill-selection-mode)

**Syntax:** obj \<< Get Fill Selection Mode

**Description:** Returns the selection style for fills.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dist = Distribution( Continuous Distribution( Column( :height ) ), Histograms Only );
rdist = dist << report;
dt << Select Where( dt:age == 12 );
framebox = rdist[Frame Box( 1 )];
framebox << Fill Selection Mode( "Selected Darker" );
framebox << Get Fill Selection Mode;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

seg << Get Gradient Transparency;


```

### [Get Image](#get-image)

**Syntax:** image = obj \<< Get Image

**Description:** Returns a reference to the background image.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
op = Overlay Plot( X( :subject ), Y( :miles ), Separate Axes( 1 ) );
opr = op << report;
fb = opr[Frame Box( 1 )];
fb << Add Image(
    Open( Convert File Path( "$SAMPLE_IMAGES/black rhino footprint.jpg" ) ),
    Transparency( 0.9 ),
    Rotate( 90 ),
    Bounds(
        Left( 0.135416666666667 ),
        Right( 3.26041666666667 ),
        Top( 11.8333333333333 ),
        Bottom( -1 )
    ),
    SetSize( {300, 210} )
);
fb << Marker Size( 8 );
Print( fb << Get Image );


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

seg << Get Line Width;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

seg << Get Marker;


```

### [Get Marker Selection Mode](#get-marker-selection-mode)

**Syntax:** obj \<< Get Marker Selection Mode

**Description:** Returns the marker selection style.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Selection Mode( "Selected Haloed" );
framebox << Get Marker Selection Mode;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

seg << Get Marker Size;


```

### [Get Polygons](#get-polygons)

**Syntax:** obj \<< Get Polygons

**Description:** Returns a list of polygons located on the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
pa = framebox << Add Polygon Annotation(
    Points( {144, 53}, {182, 30}, {213, 80}, {181, 95} )
);
pa << Closed( 1 );
Print( framebox << Get Polygons );


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

seg << Gradient Transparency( "None" );


```

### [Grid Line Order](#grid-line-order)

**Syntax:** obj \<< Grid Line Order( position )

**Description:** Draw the grid lines in front of or behind other objects in the graph

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[axis box( 1 )] << Add Ref Line( 90, "Solid", blue );
rbiv[axis box( 2 )] << Show Major Grid( 1 );
framebox = rbiv[frame box( 1 )];
framebox << Grid Line Order( 1 );


```

### [Horizontal Gap](#horizontal-gap)

**Syntax:** obj \<< Horizontal Gap( number )

**JMP Version Added:** 15

### [Hover Label Editor](#hover-label-editor)

**Syntax:** obj \<< Hover Label Editor

**Description:** Displays the Hover Label Editor window.

**JMP Version Added:** 15

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Left](#left)

**Syntax:** obj \<< Left( state=0|1 )

**Description:** Shows or hides a border on the left of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Left( 0 );


```

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

seg << Set Line Width( 3 );


```

### [Line Width Scale](#line-width-scale)

**Syntax:** obj \<< Line Width Scale( 0|scale )

**Description:** Sets the width of the line to the inputted value. A value of 0 means the line width scale is determined by the font size scale.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Line Width Scale( 2.0 );


```

### [Make table of graphs like this](#make-table-of-graphs-like-this)

**Syntax:** obj \<< Make table of graphs like this

**Description:** create a data table of graphs

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

seg << Set Marker( "Square" );


```

### [Marker Drawing Mode](#marker-drawing-mode)

**Syntax:** obj \<< Marker Drawing Mode( "Normal"|"Fast"|"Outlined" )

**Description:** Sets the style of the marker.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Drawing Mode( "outlined" );


```

### [Marker Label Color Style](#marker-label-color-style)

**Syntax:** obj \<< Marker Label Color Style( "Preferred Mode"|"Marker Color"|"Marker Color Faded"|"Fixed Color" )

**Description:** Changes the color of marker labels

### [Marker Selection Mode](#marker-selection-mode)

**Syntax:** obj \<< Marker Selection Mode( "Preferred Mode"|"Unselected Faded"|"Selected Larger"|"Selected Haloed"|"Selected Outlined"|"Selected Same Color" )

**Description:** Sets the selection style of the marker.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Marker Selection Mode( "Selected Haloed" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Name Selection in Column](#name-selection-in-column)

**Syntax:** obj \<< Name Selection in Column

**Description:** Label the currently selected rows and save the value(label) in a column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Rows( 1 );
dt:(Column( 2 )) << Set Selected( 1 );
framebox = rbiv[Frame Box( 1 )];
framebox << Select Matching Cells;
framebox << Name Selection in Column;


```

### [Paste Background Image](#paste-background-image)

**Syntax:** obj \<< Paste Background Image

**Description:** Paste the background image that is saved in memory on the clipboard.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
op = Overlay Plot( X( :subject ), Y( :miles ), Separate Axes( 1 ) );
opr1 = op << report;
opr2 = opr1 << Clone Box;
opr1 << append( opr2 );
fb1 = opr1[Frame Box( 1 )];
fb1 << Add Image(
    Open( Convert File Path( "$SAMPLE_IMAGES/black rhino footprint.jpg" ) ),
    Transparency( 0.9 ),
    Rotate( 90 ),
    Bounds(
        Left( 0.135416666666667 ),
        Right( 3.26041666666667 ),
        Top( 11.8333333333333 ),
        Bottom( -1 )
    ),
    SetSize( {300, 210} )
);
fb1 << Copy Picture;
fb2 = opr2[Frame Box( 1 )];
fb2 << Paste Background Image;


```

### [Paste Customizations](#paste-customizations)

**Syntax:** obj \<< Paste Customizations

**Description:** Paste a script that contains graph customizations.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Marker Drawing Mode( outlined );
framebox1 << Copy Customizations;
framebox2 << Paste Customizations;


```

### [Paste Frame Contents](#paste-frame-contents)

**Syntax:** obj \<< Paste Frame Contents

**Description:** The clipboard contains journal text for Frame contents. Parse it and install it in this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
biv << Fit Line;
framebox1 << Copy Frame Contents;
framebox2 << Paste Frame Contents;


```

### [Paste Frame Settings](#paste-frame-settings)

**Syntax:** obj \<< Paste Frame Settings

**Description:** Paste the clipboard's contents into this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv1 = biv << report;
rbiv2 = rbiv1 << Clone Box;
rbiv1 << append( rbiv2 );
framebox1 = rbiv1[Frame Box( 1 )];
framebox2 = rbiv2[Frame Box( 1 )];
framebox1 << Background Color( "Green" );
framebox1 << Copy Frame Settings;
framebox2 << Paste Frame Settings;


```

### [Paste Graphlet](#paste-graphlet)

**Syntax:** obj \<< Paste Graphlet

**Description:** Adds a Graphlet customization based on the clipboard contents.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
Set Clipboard(JSLQuote(Bivariate(
                             Y( :height ),
                             X( :weight ),
                             Histogram Borders( 1 ),
                             Fit Robust( {Line Color( {212, 73, 88} )} ),
                             Fit Cauchy( {Line Color( {61, 174, 70} )} ),
                             SendToReport(
                                 Dispatch(
                                     {},
                                     "Bivar Plot",
                                     FrameBox,
                                     {Grid Line Order( 1 ), Reference Line Order( 2 )}
                                 )
                             )
                         )));
frame = (gb << report)[FrameBox( 1 )];
frame << Paste Graphlet();
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
gpin << Launch Graphlet;


```

### [Reference Line Order](#reference-line-order)

**Syntax:** obj \<< Reference Line Order( position )

**Description:** Draw the reference lines in front of or behind other objects in the graph

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[axis box( 1 )] << Add Ref Line( 90, "Solid", blue );
rbiv[axis box( 2 )] << Show Major Grid( 1 );
framebox = rbiv[frame box( 1 )];
framebox << Reference Line Order( 1 );


```

### [Remove Graphics Script](#remove-graphics-script)

**Syntax:** obj \<< Remove Graphics Script( position )

**Description:** Removes the graphics script attached to the frame at the given position.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
framebox = rbiv[frame box( 1 )];
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {1.0, 0.5, 0.0} );
    Polygon( [60, 72, 57], [75, 120, 120] );
);
framebox << Add Graphics Script(
    Transparency( 0.5 );
    Fill Color( {0.0, 0.5, 1.0} );
    Polygon( [60, 72, 57], [150, 120, 120] );
);
Wait( 2 );
framebox << Remove Graphics Script( 2 );


```

### [Reorder Segs](#reorder-segs)

**Syntax:** obj \<< Reorder Segs( List of integers representing the current segs in the new order. )

**Description:** Reorders segs that are in a graph.

**JMP Version Added:** 16

```

Open( "$sample_data\big class.jmp" );
gb = Graph Builder(
    Size( 534, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 6 ) ), Bar( X, Y, Legend( 7 ) ) ),
    SendToReport(
        Dispatch( {}, "weight", ScaleBox,
            {Label Row( {Show Major Grid( 1 ), Show Minor Grid( 1 )} )}
        )
    )
);
For( blink = 1, blink < 4, blink++,
    Wait( .5 );
    (gb << report)[FrameBox( 1 )] << reorder segs( {4, 3, 2, 1} );
);


```

### [Right](#right)

**Syntax:** obj \<< Right( state=0|1 )

**Description:** Shows or hides a border on the right of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Right( 0 );


```

### [Right Y Axis](#right-y-axis)

**Syntax:** obj \<< Right Y Axis( < Min( min ) >, < Max( max ) >, < Inc( n ) >, ... )

**Description:** Applies one or more right Y axis changes in a single message. Opens the right Y Axis Settings window if no arguments are given.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ), Y( :weight, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
gbr = gb << report;
fb = gbr[Frame Box( 1 )];
fb << Right Y Axis;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 23 ) ),
        Y( :height, Size( 37 ) ),
        Y( :weight, Position( 1 ), Size( 37 ), Side( "Right" ) )
    ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
framebox = Report( gb )[framebox( 1 )];
framebox << Right Y Axis(
    Rotated Labels( "Angled" ),
    Scale( "Log" ),
    Add Ref Line( 125, dashed, "red" )
);


```

### [Row Colors](#row-colors)

**Syntax:** obj \<< Row Colors( color )

**Description:** Sets the color of the selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Colors( "Red" );


```

### [Row Editor](#row-editor)

**Syntax:** obj \<< Row Editor

**Description:** Bring up the Row Editor window, starting on the first selected point.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Row Editor;


```

### [Row Exclude](#row-exclude)

**Syntax:** obj \<< Row Exclude

**Description:** Excludes (or unexcludes) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Exclude( 1 );


```

### [Row Hide](#row-hide)

**Syntax:** obj \<< Row Hide

**Description:** Hides (or unhides) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Hide( 1 );


```

### [Row Hide and Exclude](#row-hide-and-exclude)

**Syntax:** obj \<< Row Hide and Exclude

**Description:** Hides and excludes (or unhide or unexcludes) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Hide and Exclude( 1 );


```

### [Row Label](#row-label)

**Syntax:** obj \<< Row Label

**Description:** Labels (or unlabels) the corresponding rows in the data table.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Label( 1 );


```

### [Row Legend](#row-legend)

**Syntax:** obj \<< Row Legend( Color( 0|1), Marker( 0|1 ), \<Color theme( string )>, \<Marker theme( string )>, < Continuous scale(0|1)>, \<Reverse scale(0|1)>, \<Excluded Row( 0|1 ), <Make window with legend> )

**Description:** Color the rows according to a data column, and insert a legend to the right of this frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Row Legend( "age", color( 1 ), Marker( 1 ) );


```

### [Row Markers](#row-markers)

**Syntax:** obj \<< Row Markers( marker )

**Description:** Sets the marker of the selected rows.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Where( dt:age == 12 );
framebox = rbiv[Frame Box( 1 )];
framebox << Row Markers( 3 );


```

### [Scale with Font](#scale-with-font)

**Syntax:** obj \<< Scale with Font

**Description:** Sets the line width to scale with the font size scale. Equivalent to \<<Line Width Scale(0).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( weight ), x( height ), FitLine );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Scale with Font;


```

### [Seg Count](#seg-count)

**Syntax:** obj \<< Seg Count( <seg type> )

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = Bivariate( Y( :weight ), X( :height ), FitLine );
rbiv = biv << report;
rbiv[Frame Box( 1 )] << Seg Count( MarkerSeg );


```

### [Select Matching Cells](#select-matching-cells)

**Syntax:** obj \<< Select Matching Cells

**Description:** Select points that have similar labels to the selected rows

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Rows( 1 );
dt:(Column( 2 )) << Set Selected( 1 );
framebox = rbiv[Frame Box( 1 )];
framebox << Select Matching Cells;


```

### [Select Similar](#select-similar)

**Syntax:** obj \<< Select Similar

**Description:** Selects the rows that have similar data values as the selected column.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
dt << Select Rows( 1 );
dt:(Column( 3 )) << Set Selected( 1 );
framebox = rbiv[Frame Box( 1 )];
framebox << Select Similar;


```

### [Set Background Fill](#set-background-fill)

**Syntax:** obj \<< Set Background Fill( state=0|1 )

**Description:** Enables or disables filling the graph background with the background color.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( weight ), x( height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
//Set background color
framebox << Background Color( "red" );
//Wait to see the color change
Wait( 1 );
//Turn off background fill color
framebox << Set Background Fill( 0 );


```

### [Set Colors](#set-colors)

**Syntax:** obj \<< Set Colors

**JMP Version Added:** 15

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Graphlet](#set-graphlet)

**Syntax:** obj \<< Set Graphlet

**Description:** Defines the hover label embedded visualization (graphlet) for this graph.

**JMP Version Added:** 15

#### [External image](#external-image)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        local:img_url = "https://upload.wikimedia.org/wikipedia/commons/thumb/" ||
        Match( local:_Species,
            "versicolor", "2/27/Blue_Flag%2C_Ottawa.jpg/240px-Blue_Flag%2C_Ottawa.jpg",
            "virginica", "f/f8/Iris_virginica_2.jpg/240px-Iris_virginica_2.jpg",
            "setosa",
                "5/56/Kosaciec_szczecinkowaty_Iris_setosa.jpg/180px-Kosaciec_szczecinkowaty_Iris_setosa.jpg"
        );
        Open( local:img_url );
    ),
    Click( Web( "https://en.wikipedia.org/wiki/Iris_" || local:_Species ) ),
    Title( "External Image" ),
    Reapply( 1 )
);
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 18 ),
    Index Row( 18 ),
    UniqueID( 1441114818 ),
    FoundPt( {123, 293} ),
    Origin( {1.70752129817444, 5.66359183673469} ),
    Tag Line( 1 )
);
gpin << Launch Graphlet;


```

#### [Preset](#preset)

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
gpin << Launch Graphlet;


```

### [Set Gridlet](#set-gridlet)

**Syntax:** obj \<< Set Gridlet

**Description:** Defines the hover label content grid (gridlet) for this graph.

**JMP Version Added:** 15

#### [Append](#append)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet(
    Expunge( {{Matcher( "Species" )}} ),
    Annex(
        {{Matcher( "Species@Wikipedia" ), value( local:_Species ),
        click( Web( "https://wikipedia.com/wiki/Iris_" || local:_Species ) )}}
    )
);
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Delete](#delete)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet( Expunge( {{Matcher( "Row" )}} ) );
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Reformat](#reformat)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet(
    Reformat(
        {{Matcher( "Petal length" ), Format( "Scientific", 80 ), 80},
        {Matcher( "Sepal length" ), Format( "Scientific", 80 ), 80}}
    )
);
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Rename](#rename)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet( Rename( {{Matcher( "Row" ), value( "Observation" )}} ) );
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

#### [Style](#style)

```

dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Gridlet(
    Style(
        {{Matcher( "Species" ), Text Color( "Red" ), Background Color( "Light Yellow" ),
        Justification( "Center" ), "Font"("Times New Roman", 14, "Italic")}}
    )
);
frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

seg << Set Line Width( 3 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Textlet](#set-textlet)

**Syntax:** obj \<< Set Textlet

**Description:** Defines the hover label rich text content (textlet) for this graph.

**JMP Version Added:** 15

```

//This example uses hardcoded content from Wikipedia
// For a complete example that uses dynamic, data-driven content, please see
// https://community.jmp.com/t5/JMP-Scripts/WikiReader-Augmenting-Hover-Labels-with-web-data-and-images/ta-p/237488
dt = Open( "$SAMPLE_DATA/Iris.jmp" );
gb = dt << Graph Builder(
    Size( 531, 456 ),
    Show Control Panel( 0 ),
    Variables( X( :Petal length ), Y( :Sepal length ), Color( :Species ) ),
    Elements( Points( X, Y, Legend( 2 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Textlet(
    Setup(
        local:description =
        "Iris virginica, with the common name Virginia iris, is a perennial species of flowering plant, native to eastern North America.";
        local:text = Substr( local:description, 1, 140 ) || "...";
    ),
    Markup(
        "<background color='white'><i><font family='Arial' size='12'>{local:text}</font></i></background>"
    ),
    Width( 320 )
);
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 133 ),
    Index Row( 133 ),
    UniqueID( 1441114933 ),
    FoundPt( {384, 228} ),
    Origin( {5.08093306288033, 6.30828571428571} ),
    Tag Line( 1 )
);


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

seg << Set Transparency( .3 );


```

### [Size to Isometric](#size-to-isometric)

**Syntax:** obj \<< Size to Isometric

**Description:** Resize the frame so that the number of real units per pixel is the same in X and Y directions.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Size To Isometric;


```

### [Ternary X Title](#ternary-x-title)

**Syntax:** obj \<< Ternary X Title( text )

**Description:** Sets the X-axis title for a ternary frame.

**JMP Version Added:** 15

### [Ternary Y Title](#ternary-y-title)

**Syntax:** obj \<< Ternary Y Title( text )

**Description:** Sets the Y-axis title for a ternary frame.

**JMP Version Added:** 15

### [Ternary Y1 Title](#ternary-y1-title)

**Syntax:** obj \<< Ternary Y1 Title( text )

**Description:** Sets the Y1-axis title for a ternary frame.

**JMP Version Added:** 15

### [Top](#top)

**Syntax:** obj \<< Top( state=0|1 )

**Description:** Shows or hides a border on the top of the frame.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
framebox = rbiv[Frame Box( 1 )];
framebox << Top( 0 );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

seg << Set Transparency( .3 );


```

### [Vertical Gap](#vertical-gap)

**Syntax:** obj \<< Vertical Gap( number )

**JMP Version Added:** 15

### [X Axis](#x-axis)

**Syntax:** obj \<< X Axis( < Min( min ) >, < Max( max ) >, < Inc( n ) >, ... )

**Description:** Applies one or more X axis changes in a single message. Opens the X Axis Settings window if no arguments are given.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ), Y( :weight, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
gbr = gb << report;
fb = gbr[Frame Box( 1 )];
fb << X Axis;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 23 ) ),
        Y( :height, Size( 37 ) ),
        Y( :weight, Position( 1 ), Size( 37 ), Side( "Right" ) )
    ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
framebox = Report( gb )[framebox( 1 )];
framebox << X Axis(
    Min( -2 ),
    Max( 7 ),
    Inc( 1 ),
    Add Ref Line( 5, "Solid", "Blue" ),
    Rotated Labels( "Vertical" )
);


```

### [Y Axis](#y-axis)

**Syntax:** obj \<< Y Axis( < Min( min ) >, < Max( max ) >, < Inc( n ) >, ... )

**Description:** Applies one or more Y axis changes in a single message. Opens the Y Axis Settings window if no arguments are given.

**Example 1**

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :height ), Y( :weight, Position( 1 ), Side( "Right" ) ) ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
gbr = gb << report;
fb = gbr[Frame Box( 1 )];
fb << Y Axis;


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 23 ) ),
        Y( :height, Size( 37 ) ),
        Y( :weight, Position( 1 ), Size( 37 ), Side( "Right" ) )
    ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ), Jitter( 1 ) ),
        Points( X, Y( 2 ), Legend( 3 ), Jitter( 1 ) )
    )
);
framebox = Report( gb )[framebox( 1 )];
framebox << Y Axis(
    Add Ref Line( 61.25, "Solid", "Medium Dark Green" ),
    Show Major Grid( 1 ),
    Show Minor Grid( 1 ),
    Format( "Fixed Dec", 5, 2 ),
    Rotated Labels( "Perpendicular" )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append_1)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [MouseBox](#mousebox)

## [Associated Constructors](#associated-constructors)

### [Mouse Box](#mouse-box)

**Syntax:** box = MouseBox( displayBoxArgs )

**Description:** Returns a box that can make JSL callbacks for mouse actions

```

New Window( "Example",
    MouseBox(/*first sibling*/Text Box( "drag from here" ),
        <<setDragText( "hello" ),
        <<setTooltip( "source" ),
        <<setDragEnable( 1 ),
        <<setDragBegin(/* decide if a drag is allowed */
            Function( {this, clickpt},
                "magic text";/* 0.0 to prevent the drag.  1.0 is the same as 'this<<getDragText' */
            )
        ),
        <<setDragEnd(/* clean up after a drag finishes or cancels */
            Function( {this, clickpt, how}, /* how=move,copy,ignore */
                If(
                    how != "ignore" & !Is Empty( this << getDestBox ) & this << getDestBox
                     == this << sib, /* the getDestBox check makes sure the destination of the drag-and-drop was my sibling and not some other program beyond our control */
                    (this << child) << setText(
                        "done!" /* 'move' suggests clearing the source */
                    )
                )
            )
        )
    ),
    MouseBox(/*second sibling*/Text Box( "drag to here" ),
        <<setTooltip( "destination" ),
        <<setDropEnable( 1 ),
        <<setDropTrack(/* decide if dropping is allowed, before the drop.  The getSourceBox check makes sure the source of the drag-and-drop is my sibling, and not some other program */
            Function( {this, clickpt},
                If( !Is Empty( this << getSourceBox ) & this == (this << getSourceBox) << sib,
                    1, /*else*/0
                )
            )
        ),
        <<setDropCommit(/* accept the drop */Function( {this, clickpt, text},
                (this << child) << setText( text )
            )
        )
    )
);


```

## [Item Messages](#item-messages)

### [GetChildBox](#getchildbox)

**Syntax:** GetChildBox( { x, y } | [ x y ] | x, y )

**Description:** returns a list of zero or more nested display boxes: { child, grand-child, great-grand-child, ... } at the specified coordinates within this mouse box. In many cases it might be simpler to use a separate mouse box around each child.

```

New Window( "MouseBox",
    Text Box( "Move the mouse around" ),
    MouseBox(
        Lineup Box( N Col( 2 ), 
            /*pre-load the spacer boxes with a color, but make them transparent as well so the color won't show*/
            s1 = Spacer Box( size( 50, 50 ), <<Color( "red" ), <<SetFill( 0 ) ),
            s2 = Spacer Box( size( 50, 50 ), <<Color( "green" ), <<SetFill( 0 ) ),
            s3 = Spacer Box( size( 50, 50 ), <<Color( "blue" ), <<SetFill( 0 ) ),
            Lineup Box( N Col( 2 ), 
                /*demonstrate nested boxes*/
                s4 = Spacer Box( size( 24, 24 ), <<Color( "red" ), <<SetFill( 0 ) ),
                s5 = Spacer Box( size( 24, 24 ), <<Color( "green" ), <<SetFill( 0 ) ),
                s6 = Spacer Box( size( 24, 24 ), <<Color( "blue" ), <<SetFill( 0 ) ),
                s7 = Spacer Box( size( 24, 24 ), <<Color( "yellow" ), <<SetFill( 0 ) )
            )
        ), 
        /*set up a callback function to track the mouse movements*/
        <<SetTrackEnable( 1 ),
        <<SetTrack(
            Function( {this, clickpt}, /*clickpt is really the move point*/
/*on each mouse move, make children transparent*/
                s1 << setfill( 0 );
                s2 << setfill( 0 );
                s3 << setfill( 0 );
                s4 << setfill( 0 );
                s5 << setfill( 0 );
                s6 << setfill( 0 );
                s7 << setfill( 0 );
                /*retrieve a list of boxes under the clickpt (which is a mouse coordinate within the mouse box like {10,20})*/
                childBoxList = this << GetChildBox( clickpt );
                /* child 1 is the LineupBox.  child 2, if present, is one of the Spacer Boxes */
                If(
                    N Items( childBoxList ) > 0 & (childBoxList[N Items( childBoxList )]) <<
                    className == "SpacerBox", 
                    /*if a SpacerBox is under the mouse, make it opaque*/
                    childBoxList[N Items( childBoxList )] << SetFill( 1 )
                );
            )
        )
    )
);


```

### [GetClick](#getclick)

**Syntax:** obj \<< GetClick

**Description:** returns the function from \<<SetClick

```

mb = MouseBox();
mb << setClick( Function( {this, clickPt, event}, Print( 42 ) ) );
mb << getClick();


```

### [GetClickEnable](#getclickenable)

**Syntax:** obj \<< GetClickEnable

**Description:** report the value set by SetClickEnable

```

mb = MouseBox();
mb << setClickEnable( 1 );
mb << getClickEnable();


```

### [GetDefaultCursor](#getdefaultcursor)

**Syntax:** obj \<< GetDefaultCursor

**Description:** retrieves the value specified by SetDefaultCursor

### [GetDefaultCursorEnable](#getdefaultcursorenable)

**Syntax:** obj \<< GetDefaultCursorEnable

**Description:** retrieves the value specified by SetDefaultCursorEnable

### [GetDestBox](#getdestbox)

**Syntax:** obj \<< GetDestBox

### [GetDragBegin](#getdragbegin)

**Syntax:** obj \<< GetDragBegin

**Description:** returns the function specified by \<<SetDragBegin

### [GetDragEnable](#getdragenable)

**Syntax:** obj \<< GetDragEnable

**Description:** ask if the MouseBox is currently allowed to source drag-and-drop operations

```

mb = MouseBox();
mb << GetDragEnable;


```

### [GetDragEnd](#getdragend)

**Syntax:** obj \<< GetDragEnd

**Description:** returns the function specified by \<<SetDragEnd

### [GetDragText](#getdragtext)

**Syntax:** obj \<< GetDragText

**Description:** Not normally needed. Returns the text supplied by SetDragText, which might not be the text sent to the drop point.

```

mb = MouseBox();
mb << setDragText( "1000 words" );
mb << getDragText;


```

### [GetDropCommit](#getdropcommit)

**Syntax:** obj \<< GetDropCommit

**Description:** returns the function set by \<<setDropCommit

```

mb = MouseBox();
mb << setDropCommit( Function( {this, clickPt, text}, Print( 42 ) ) );
mb << getDropCommit();


```

### [GetDropEnable](#getdropenable)

**Syntax:** obj \<< GetDropEnable

**Description:** reports the value stored by \<<SetDropEnable

```

mb = MouseBox();
mb << setDropEnable( 1 );
mb << getDropEnable();


```

### [GetDropTrack](#getdroptrack)

**Syntax:** obj \<< GetDropTrack

**Description:** returns the function set by \<<setDropTrack

```

mb = MouseBox();
mb << setDropTrack( Function( {this, clickPt}, Print( 42 ) ) );
mb << getDropTrack();


```

### [GetEdit](#getedit)

**Syntax:** obj \<< GetEdit

### [GetEditClear](#geteditclear)

**Syntax:** obj \<< GetEditClear( state=0|1 )

### [GetEditCopy](#geteditcopy)

**Syntax:** obj \<< GetEditCopy( state=0|1 )

### [GetEditCopyLabel](#geteditcopylabel)

**Syntax:** obj \<< GetEditCopyLabel( state=0|1 )

### [GetEditCopyText](#geteditcopytext)

**Syntax:** obj \<< GetEditCopyText( state=0|1 )

### [GetEditCut](#geteditcut)

**Syntax:** obj \<< GetEditCut( state=0|1 )

### [GetEditEnable](#geteditenable)

**Syntax:** obj \<< GetEditEnable

### [GetEditJournal](#geteditjournal)

**Syntax:** obj \<< GetEditJournal( state=0|1 )

### [GetEditPaste](#geteditpaste)

**Syntax:** obj \<< GetEditPaste( state=0|1 )

### [GetEditPasteJSL](#geteditpastejsl)

**Syntax:** obj \<< GetEditPasteJSL( state=0|1 )

### [GetEditPasteLabel](#geteditpastelabel)

**Syntax:** obj \<< GetEditPasteLabel( state=0|1 )

### [GetEditSaveSelectionAs](#geteditsaveselectionas)

**Syntax:** obj \<< GetEditSaveSelectionAs( state=0|1 )

### [GetEditSubmit](#geteditsubmit)

**Syntax:** obj \<< GetEditSubmit( state=0|1 )

### [GetEditSubmitDebug](#geteditsubmitdebug)

**Syntax:** obj \<< GetEditSubmitDebug( state=0|1 )

### [GetFocus](#getfocus)

**Syntax:** obj \<< GetFocus

### [GetKey](#getkey)

**Syntax:** obj \<< GetKey

**Description:** Returns the function set by Set Key.

```

New Window( "SetKey Example", mb = MouseBox( tb = Text Box( "Press a key." ) ) );
mb << setkey(
    Function( {this, key},
        tb << settext( key );
        1;
    )
);
mb << setkeyenable( 1 );
mb << setfocus;
Show( mb << GetKey );


```

### [GetKeyEnable](#getkeyenable)

**Syntax:** obj \<< GetKeyEnable

### [GetMark](#getmark)

**Syntax:** obj \<< GetMark

**Description:** retrieves the value specified by \<<SetMark

```

New Window( "Mouse Box", mb = MouseBox( Text Box( "Text" ) ) );
mb << setMarkEnable( 1 );
mb << setMark( Function( {this}, this << Set Marked( !(this << Get Marked) ) ) );
mb << GetMark;


```

### [GetMarkEnable](#getmarkenable)

**Syntax:** obj \<< GetMarkEnable

**Description:** retrieves value set by \<<SetMarkEnable

```

New Window( "Mouse Box", mb = MouseBox( Text Box( "Text" ) ) );
mb << setMarkEnable( 1 );
mb << getMarkEnable();


```

### [GetMarked](#getmarked)

**Syntax:** obj \<< GetMarked

**Description:** Returns the current marked flag.

```

New Window( "Mouse Box", mb = MouseBox( Text Box( "Text" ) ) );
mb << setMarkEnable( 1 );
mb << setMarked();
mb << getMarked();


```

### [GetSourceBox](#getsourcebox)

**Syntax:** obj \<< GetSourceBox

### [GetToolTip](#gettooltip)

**Syntax:** obj \<< GetToolTip

**Description:** Not normally needed. Returns the text supplied by SetTooltip. Tooltips are automatic and don't need this message.

```

mb = MouseBox();
mb << setTooltip( "this is your best choice" );
mb << getTooltip;


```

### [GetTrack](#gettrack)

**Syntax:** obj \<< GetTrack

**Description:** retrieves the value specified by \<<SetTrack

```

mb = MouseBox();
mb << setTrack(/*track the button-up mouse movement*/Function( {this, clickPt},
        Print( 42 )
    )
);
mb << getTrack();


```

### [GetTrackEnable](#gettrackenable)

**Syntax:** obj \<< GetTrackEnable

**Description:** retrieves value set by \<<SetTrackEnable

```

mb = MouseBox();
mb << setTrackEnable( 1 );
mb << getTrackEnable();


```

### [GetUserData](#getuserdata)

**Syntax:** obj \<< GetUserData

**Description:** retrieves the value stored by \<<SetUserData

```

mb = MouseBox();
mb << setUserData( [1 2, 3 4] );
(mb << getUserData())[2, 1];


```

### [RemoveFocus](#removefocus)

**Syntax:** obj \<< RemoveFocus

### [SetClick](#setclick)

**Syntax:** obj \<< SetClick( Function( {this, clickpt, event}, <script> ) )

**Description:** Supplies a function to handle mouse events when the button is down (or first pressed or released). For button-up, see \<<SetTrack(). clickpt is an {x,y} position within this MouseBox that was clicked. event is the click event. Values are (in the order in which they happen): "Pressed", "Ticked", or "Released".

```

xsize = 300; /* size of the bitmap */
ysize = 200;
backred = .8; /* background color is light gray-green */
backgrn = .9;
backblu = .8;
RED = J( ysize, xsize, backred ); /* matrix where the bitmap is composed */
GRN = J( ysize, xsize, backgrn );
BLU = J( ysize, xsize, backblu );
BITMAP = New Image( xsize, ysize ); /* displaybox that holds the bitmap */
BITMAP << setpixels( "rgb", {RED, GRN, BLU} ); /* initialize bitmap */
drawline = Function( {x0, y0, x1, y1}, /* utility function to draw a line in an array using matrix operations */
    {dx = x1 - x0, dy = y1 - y0, adx = Abs( dx ), ady = Abs( dy ), m, b},
    If( adx > ady,
        xx = Round( x0 ) :: Round( x1 );
        m = dy / dx;
        b = y0 - m * x0;
        yy = Round( xx * m + b );
    ,
        yy = Round( y0 ) :: Round( y1 );
        m = dx / dy;
        b = x0 - m * y0;
        xx = Round( yy * m + b );
    );
    singleindex = (yy - 1) * N Col( GRN ) + xx;
    Try( GRN[singleindex] = .6, 0 ); /* catch indexing errors and ignore the problems */
    Try( RED[singleindex] = .1, 0 ); /* the line is dark green; you could add other */
    Try( BLU[singleindex] = .1, 0 ); /* controls to change the color. */
);
w = New Window( "paint",
    MouseBox( /* <<<<<<<< handler for mouse events */
        BITMAP, /* <<<<<< child box does not receive the mouse events */
        <<setTrackEnable( 1 ),
        <<setTrack(
            Function( {this, clickpt},
                this << setCursor( "Hand" ) /* button-up tracking - use the hand */
            )
        ),
        <<setClickEnable( 1 ),
        <<setClick( /* button-down, move, button-release handler */
            Function( {this, clickpt, event}, /*Is Alt Key(),Is Control Key(),Is Shift Key() should be captured on "Pressed" */
                If( event == "Released" | event == "Canceled",
                    this << setCursor( "Hand" ) /* switch back to hand immediately */
                ,
                    this << setCursor( "Finger" ) /* change cursor during drawing */
                );
                If(
                    event == "Pressed",
                        origin = clickpt; /* capture starting point */
                        Show( event, origin );,
                    event == "Moved", /* else */
                        {x0, y0} = origin;
                        {x1, y1} = clickpt; /* draw to new point */
                        drawline( x0, y0, x1, y1 );
                        drawline( x0 + 1, y0, x1 + 1, y1 ); /* make a thick line */
                        drawline( x0 - 1, y0, x1 - 1, y1 );
                        drawline( x0, y0 + 1, x1, y1 + 1 );
                        drawline( x0, y0 - 1, x1, y1 - 1 );
                        origin = clickpt;
                        BITMAP << setpixels( "rgb", {RED, GRN, BLU} ); /* apply changes to bitmap */
                        w << reshow; /* force screen update */
                ,
                    event == "Ticked", /* else ... while the button is pressed but not moving, the tick event will let you do something...here we fade the drawing... */
                        GRN = (49 * GRN + backgrn) / 50;
                        RED = (49 * RED + backred) / 50;
                        BLU = (49 * BLU + backblu) / 50;
                        BITMAP << setpixels( "rgb", {RED, GRN, BLU} );
                        w << reshow;
                );
            )
        )
    )
);


```

### [SetClickEnable](#setclickenable)

**Syntax:** obj \<< SetClickEnable( state=0|1 )

**Description:** Enable the MouseBox to handle button-pressed, mouse-move, button-released operations via the \<<SetClick function

### [SetCursor](#setcursor)

**Syntax:** obj \<< SetCursor( "Arrow"|"NS"|"EW"|"NWSE"|"NESW"|"Finger"|"Hand" )

**Description:** \<<SetCursor("Hand") (or Finger or Arrow or NS EW NWSE NESW) will set the cursor. Use it from a \<<SetTrack or \<<SetClick function

```

New Window( "roll over demo",
    MouseBox(
        Text Box( "hello" ),
        <<setTrackEnable( 1 ),
        <<settrack(
            Function( {this, pos},
                (this << child) << FontColor( If( pos[1] >= 0, "red", "black" ) )
            )
        ),
        <<setDefaultCursor( "Finger" )
    ),
    MouseBox(
        Text Box( "there" ),
        <<setToolTip( "Special!" ),
        <<setTrackEnable( 1 ),
        <<settrack( Function( {this, pos}, this << setCursor( "Hand" ) ) )
    )
);


```

### [SetDefaultCursor](#setdefaultcursor)

**Syntax:** obj \<< SetDefaultCursor( "Arrow"|"NS"|"EW"|"NWSE"|"NESW"|"Finger"|"Hand" )

**Description:** specifies the default cursor to display if SetDefaultCursorEnable(1) is also specified; use one of "Arrow", "NS", "EW", "NWSE", "NESW", "Finger", or "Hand". Unlike SetCursor, which is used from a SetTrack script, SetDefaultCursor works without a script.

```

clickFunction = Function( {this, pos, action},
    If(
        action == "Pressed", oldPos = pos,
        action == "Moved",
            dx = pos[1] - oldPos[1];
            dy = pos[2] - oldPos[2];
            oldPos = pos;
            {tops, lefts, rights, bottoms} = this << getUserData();
            If(
                N Items( tops ) > 0 & 0 < ((border << getTop()) + dy) & (((boxes[tops[1]] <<
                child) << getTop) - dy) > 0,
                border << top( (border << getTop()) + dy );
                For( i = 1, i <= N Items( tops ), i++,
                    (boxes[tops[i]] << child) << top(
                        ((boxes[tops[i]] << child) << getTop) - dy
                    )
                );
            );
            If(
                N Items( bottoms ) > 0 & 0 < ((border << getBottom()) - dy) & (((boxes[
                bottoms[1]] << child) << getBottom) + dy) > 0,
                border << bottom( (border << getBottom()) - dy );
                For( i = 1, i <= N Items( bottoms ), i++,
                    (boxes[bottoms[i]] << child) << bottom(
                        ((boxes[bottoms[i]] << child) << getBottom) + dy
                    )
                );
            );
            If(
                N Items( lefts ) > 0 & 0 < ((border << getLeft()) + dx) & (((boxes[lefts[1]]
                 << child) << getLeft) - dx) > 0,
                border << Left( (border << getLeft()) + dx );
                For( i = 1, i <= N Items( lefts ), i++,
                    (boxes[lefts[i]] << child) << Left(
                        ((boxes[lefts[i]] << child) << getLeft) - dx
                    )
                );
            );
            If(
                N Items( rights ) > 0 & 0 < ((border << getRight()) - dx) & (((boxes[rights[1
                ]] << child) << getRight) + dx) > 0,
                border << Right( (border << getRight()) - dx );
                For( i = 1, i <= N Items( rights ), i++,
                    (boxes[rights[i]] << child) << Right(
                        ((boxes[rights[i]] << child) << getRight) + dx
                    )
                );
            );,
        action == "Released", 0,
        action == "Ticked",
            ((this << child) << child) << settext(
                Char( Num( ((this << child) << child) << gettext() ) + 1 )
            )
    )
);
mb = Function( {boxNumber, cursor, TopLeftRightBottom},
    MouseBox(
        Border Box( sides( 15 ), Left( 5 ), Right( 5 ), top( 5 ), bottom( 5 ),
            Text Box( boxNumber )
        ),
        <<setDefaultCursor( Eval( cursor ) ),
        <<setClickEnable( 1 ),
        <<SetClick( clickFunction ),
        <<SetUserData( TopLeftRightBottom )
    )
);
boxes = {};
bigBorder = 50;
New Window( "corner demo",
    border = Border Box( sides( 15 ), Left( bigBorder ), Right( bigBorder ), top( bigBorder ),
        bottom( bigBorder ),
        Lineup Box( N Col( 3 ), spacing( 10, 10 ),
            boxes[1] = mb( "1000", "NWSE", {{1, 2, 3}, {1, 4, 7}, {}, {}} ),
            boxes[2] = mb( "2000", "NS", {{1, 2, 3}, {}, {}, {}} ),
            boxes[3] = mb( "3000", "NESW", {{1, 2, 3}, {}, {3, 6, 9}, {}} ),
            boxes[4] = mb( "4000", "EW", {{}, {1, 4, 7}, {}, {}} ),
            boxes[5] = mb( "5000", "HAND", {{}, {}, {}, {}} ),
            boxes[6] = mb( "6000", "EW", {{}, {}, {3, 6, 9}, {}} ),
            boxes[7] = mb( "7000", "NESW", {{}, {1, 4, 7}, {}, {7, 8, 9}} ),
            boxes[8] = mb( "8000", "NS", {{}, {}, {}, {7, 8, 9}} ),
            boxes[9] = mb( "9000", "NWSE", {{}, {}, {3, 6, 9}, {7, 8, 9}} )
        )
    )
);


```

### [SetDefaultCursorEnable](#setdefaultcursorenable)

**Syntax:** obj \<< SetDefaultCursorEnable( state=0|1 )

**Description:** Enables MouseBox to show the cursor specified by SetDefaultCursor

### [SetDragBegin](#setdragbegin)

**Syntax:** obj \<< SetDragBegin( Function( {this, clickpt}, <script> ) )

**Description:** Supplies a function to call at the beginning of a drag-and-drop operation. The function can prevent the drag by returning 0.0 or allow the drag by either returning a string (instead of using \<<SetDragText) or by returning 1.0 (to use \<<SetDragText). clickpt is an {x,y} position within the MouseBox where the drag began.

```

/* See full example for MouseBox() */
mb = MouseBox();
mb << SetDragBegin( Function( {this, clickpt}, 1.0 /*always allow*/ ) );


```

### [SetDragEnable](#setdragenable)

**Syntax:** obj \<< SetDragEnable( state=0|1 )

**Description:** The MouseBox can source a drag-and-drop operation

```

New Window( "example",
    MouseBox(
        Text Box( "drag me to a text editor" ),
        <<SetDragEnable( 1 ),
        <<SetDragText( "hello" )
    )
);


```

### [SetDragEnd](#setdragend)

**Syntax:** obj \<< SetDragEnd( Function( {this, clickpt, how}, <script> ) )

**Description:** Supplies a function to call at the end of a drag-and-drop operation. how reports how the operation ended, either "move" or "ignore". If the operation ended as a "move" you might use this function to clear the drag source location. clickpt is an {x,y} position within the MouseBox where the drag began.

```

/* See full example for MouseBox() */
mb = MouseBox();
mb << SetDragEnd(
    Function( {this, clickpt, how},
        If( how == "move",
            (this << child) << delete/* example; probably not what you want */
        )
    )
);


```

### [SetDragText](#setdragtext)

**Syntax:** obj \<< SetDragText

**Description:** specify the text the MouseBox will send to the drop point

```

mb = MouseBox();
mb << setDragText( "1000 words" );


```

### [SetDropCommit](#setdropcommit)

**Syntax:** obj \<< SetDropCommit( Function( {this, clickpt, text}, <script> ) )

**Description:** Supplies a function that is called near the end of a drag-and-drop sequence when the button-release event happens. The commit function receives the text supplied by the drag source and can use it as needed, for example, setting the content of a TextBox. clickpt is an {x,y} position within this MouseBox where the drag ended.

```

/* See full example for <<SetDropTrack() */
mb = MouseBox();
mb << setDropCommit(
    Function( {this, clickPt, text},
        ((this << child) << child) << setText( text );
        1;/* return code is ignored */
    )
);


```

### [SetDropEnable](#setdropenable)

**Syntax:** obj \<< SetDropEnable( state=0|1 )

**Description:** enables the MouseBox to accept drops

```

mb = MouseBox();
mb << setDropEnable( 1 );


```

### [SetDropTrack](#setdroptrack)

**Syntax:** obj \<< SetDropTrack( Function( {this, clickpt}, <script> ) )

**Description:** Supplies a function to call when a drag-and-drop operation drags across the MouseBox. The supplied function returns 0.0 to prevent the drop or 1.0 to allow the drop. The actual drop won't happen until the button-release, at which point the SetDropCommit function is called to do something with the dropped text, but only if setDropTrack returned 1.0. clickpt is an {x,y} position within the MouseBox where another MouseBox is being dragged. It is {-1, -1} when the drag is not on this MouseBox.

```

nextToBlank = Function( {x, y}, /* helper function */
    If( /* child is border, grandchild is text */
        (x > 1 & (((puzzle[x - 1][y] << child) << child) << gettext) == " ") | (x < 4 & (((
        puzzle[x + 1][y] << child) << child) << gettext) == " ") | (y > 1 & (((puzzle[x][y
        -1] << child) << child) << gettext) == " ") | (y < 4 & (((puzzle[x][y + 1] << child)
         << child) << gettext) == " ")
    ,
        1,
        0
    )
);/* only allow drag begin if next door to empty cell */
dragBegin = Function( {this, clickPt},
    {x, y} = this << getUserData;
    If( nextToBlank( x, y ),
        ((this << child) << child) << getText/* the message is the textbox content */
    , /* else */
        0 /* suppress the drag */
    );
);/* function to remove the character from the source cell, but only if the drop was successful */
dragEnd = Function( {this, clickPt, how}, /* how is copy/move/ignore */
    destbox = this << getDestBox;
    If( Is Empty( destBox ),
        Show( "unknown destination" );
        0 /* don't know where the dest was, force ignore */
        ;
    ,
        Try(
            {x, y} = destbox << GetUserData,
            x = -1;
            y = -1;
        ); /* the destbox might not have a list in userdata */
        If(
            Try(
                puzzle[x][y] != destbox,
                1 /*throw is same as !=*/
            )
        , /* x,y might not be valid index */
            Show( "not dropped in this puzzle" );
            0 /* not this puzzle instance, force ignore */
            ;
        , /* else */
            If( how == "ignore",
                Show( "drop not completed" );
                0 /* the drop was not completed */
                ;
            , /* else */
                ((this << child) << child) << setText( " " )
            )
        );
    );
    0 /* the return code is ignored */
    ;
);/* function to decide if a drop is allowed.  return codes (0,1) are critical. */
dropTrack = Function( {this, clickPt},
    sourcebox = this << getSourceBox;
    If( Is Empty( sourcebox ),
        Show( "unknown source" );
        0 /* no drop from unknown source box */
        ;
    , /* else */
        Try(
            {x, y} = sourcebox << getUserData,
            x = -1;
            y = -1;
        ); /* the sourcebox mightnot have a list in userdata */
        If(
            Try(
                puzzle[x][y] != sourcebox,
                1 /*throw is same as !=*/
            )
        , /* x,y might not be valid index */
            Show( "not from this puzzle" );
            0 /* not sourced from this puzzle instance, ignore */
            ;
        , /* else */
            If( ((this << child) << child) << getText != " ",
                0 /* no drop on occupied cell */
            , /* else */
                1 /* allow drop on the blank cell */
            )
        );
    );
);/* function to implement the drop */
dropCommit = Function( {this, clickPt, text},
    ((this << child) << child) << setText( text );
    1; /* ignored */
);/* cursor changer for cells that can source a drag */
track = Function( {this, clickPt},
    {x, y} = this << getUserData;
    If( nextToBlank( x, y ),
        this << setCursor( "Hand" ),
        this << setCursor( "Arrow" )
    );
    1; /* ignored */
);/* helper function to construct the displaybox tree */
mb = Function( {letter, x, y},
    MouseBox(
        Border Box( Left( 9 ), Right( 9 ), top( 3 ), bottom( 3 ), sides( 15 ),
            Text Box(
                letter,
                <<setFont( "Courier New" ),
                <<set font size( 15 ),
                <<set font style( "bold" )
            )
        ),
        <<setUserData( Eval List( {x, y} ) ), /* remember my location.  I don't move, but my content changes. */
        <<setDragEnable( 1 ),
        <<setDragBegin( dragBegin ), /* dragFunctions defined below */
        <<setDragEnd( dragEnd ),
        <<setDropEnable( 1 ),
        <<setDropTrack( dropTrack ),
        <<setDropCommit( dropCommit ),
        <<setTrackEnable( 1 ),
        <<setTrack( track )
    )
);
puzzle = Eval List(
    {Eval List( {mb( "b", 1, 1 ), mb( "u", 1, 2 ), mb( "y", 1, 3 ), mb( " ", 1, 4 )} ),
    Eval List( {mb( "t", 2, 1 ), mb( "h", 2, 2 ), mb( "i", 2, 3 ), mb( "s", 2, 4 )} ),
    Eval List( {mb( "w", 3, 1 ), mb( "o", 3, 2 ), mb( "r", 3, 3 ), mb( "d", 3, 4 )} ),
    Eval List( {mb( "g", 4, 1 ), mb( "a", 4, 2 ), mb( "m", 4, 3 ), mb( "e", 4, 4 )} )}
);
New Window( "puzzle",
    Border Box( Left( 5 ), Right( 5 ), top( 5 ), bottom( 5 ), sides( 15 ),
        Lineup Box( N Col( 4 ), spacing( 3, 3 ),
            puzzle[1][1],
            puzzle[1][2],
            puzzle[1][3],
            puzzle[1][4],
            puzzle[2][1],
            puzzle[2][2],
            puzzle[2][3],
            puzzle[2][4],
            puzzle[3][1],
            puzzle[3][2],
            puzzle[3][3],
            puzzle[3][4],
            puzzle[4][1],
            puzzle[4][2],
            puzzle[4][3],
            puzzle[4][4]
        )
    )
);


```

### [SetEdit](#setedit)

**Syntax:** obj \<< SetEdit

### [SetEditClear](#seteditclear)

**Syntax:** obj \<< SetEditClear( state=0|1 )

### [SetEditCopy](#seteditcopy)

**Syntax:** obj \<< SetEditCopy( state=0|1 )

### [SetEditCopyLabel](#seteditcopylabel)

**Syntax:** obj \<< SetEditCopyLabel( state=0|1 )

### [SetEditCopyText](#seteditcopytext)

**Syntax:** obj \<< SetEditCopyText( state=0|1 )

### [SetEditCut](#seteditcut)

**Syntax:** obj \<< SetEditCut( state=0|1 )

### [SetEditEnable](#seteditenable)

**Syntax:** obj \<< SetEditEnable

### [SetEditJournal](#seteditjournal)

**Syntax:** obj \<< SetEditJournal( state=0|1 )

### [SetEditPaste](#seteditpaste)

**Syntax:** obj \<< SetEditPaste( state=0|1 )

### [SetEditPasteJSL](#seteditpastejsl)

**Syntax:** obj \<< SetEditPasteJSL( state=0|1 )

### [SetEditPasteLabel](#seteditpastelabel)

**Syntax:** obj \<< SetEditPasteLabel( state=0|1 )

### [SetEditSaveSelectionAs](#seteditsaveselectionas)

**Syntax:** obj \<< SetEditSaveSelectionAs( state=0|1 )

### [SetEditSubmit](#seteditsubmit)

**Syntax:** obj \<< SetEditSubmit( state=0|1 )

### [SetEditSubmitDebug](#seteditsubmitdebug)

**Syntax:** obj \<< SetEditSubmitDebug( state=0|1 )

### [SetFocus](#setfocus)

**Syntax:** obj \<< SetFocus

### [SetKey](#setkey)

**Syntax:** obj \<< SetKey( Function( {this, key}, <script> ) )

**Description:** Sets the function to be called when a key is pressed while the mouse box has focus. The function should return 1 if the key was handled, or 0 if it was not.

```

New Window( "SetKey Example", mb = MouseBox( tb = Text Box( "Press a key." ) ) );
mb << setkey(
    Function( {this, key},
        tb << settext( key );
        1;
    )
);
mb << setkeyenable( 1 );
mb << setfocus;


```

### [SetKeyEnable](#setkeyenable)

**Syntax:** obj \<< SetKeyEnable

### [SetMark](#setmark)

**Syntax:** obj \<< SetMark( Function( {this}, <script> ) )

**Description:** SetMark specifies a function that will be called when the mouse is clicked or the return key is pressed when the box has focus. Marking can be used to implement a selection state associated with a Mouse Box. To implement clicking actions, use \<<SetClick.

```

New Window( "Mouse Box", mb = MouseBox( Text Box( "Text" ) ) );
mb << setMarkEnable( 1 );
mb << getMarkEnable();
mb << setMark( Function( {this}, this << Set Marked( !(this << Get Marked) ) ) );


```

### [SetMarkEnable](#setmarkenable)

**Syntax:** obj \<< SetMarkEnable( state=0|1 )

**Description:** enables MouseBox to call \<<SetMark function when the mouse is clicked or the return key is pressed when the box has focus.

```

New Window( "Mouse Box", mb = MouseBox( Text Box( "Text" ) ) );
mb << setMarkEnable( 1 );


```

### [SetMarked](#setmarked)

**Syntax:** obj \<< SetMarked( state=0|1 )

**Description:** Set the marked flag for the Mouse Box. A marked box is shown with a highlighted background.

```

New Window( "Mouse Box", mb = MouseBox( Text Box( "Text" ) ) );
mb << setMarkEnable( 1 );
mb << setMarked();


```

### [SetToolTip](#settooltip)

**Syntax:** obj \<< SetToolTip

**Description:** specify the text the MouseBox will use for a tooltip

```

mb = MouseBox();
mb << setTooltip( "this is your best choice" );


```

### [SetTrack](#settrack)

**Syntax:** obj \<< SetTrack( Function( {this, clickpt}, <script> ) )

**Description:** Specifies a function that will be called when the mouse moves over the MouseBox with the button up. For button-down, see \<<SetClick. clickpt is an {x,y} position within this MouseBox that is the cursor's current position.

```

/* See full example for <<SetClick() */
mb = MouseBox();
mb << setTrack(
    Function( {this, clickpt},
        this << setCursor( "Hand" ) /* button-up tracking - use the hand */
    )
);


```

### [SetTrackEnable](#settrackenable)

**Syntax:** obj \<< SetTrackEnable( state=0|1 )

**Description:** enables MouseBox to call \<<SetTrack function when mouse moves with button-up

### [SetUserData](#setuserdata)

**Syntax:** obj \<< SetUserData

**Description:** stores a JSL value in the MouseBox; the value could be a number, string, list, associative array, or other JSL type

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [MultiTblNumColBox](#multitblnumcolbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [MultiTblPackColBox](#multitblpackcolbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [MultiTblPlotColBox](#multitblplotcolbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [MultiTblStrColBox](#multitblstrcolbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [NodeDisplayDragBox](#nodedisplaydragbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [NodeDisplayNewArcBox](#nodedisplaynewarcbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [NomAxisBox](#nomaxisbox)

## [Item Messages](#item-messages)

### [Divider Lines](#divider-lines)

**Syntax:** obj \<< Divider Lines

**Description:** Draws divider-line tick marks on the axis.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
axis = cpr[Nom Axis Box( 1 )];
axis << Divider Lines;


```

### [Inside Ticks](#inside-ticks)

**Syntax:** obj \<< Inside Ticks( state=0|1 )

**Description:** Draws divider-line tick marks on inside of the graph frame

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
axis = cpr[Nom Axis Box( 1 )];
axis << Inside Ticks( 1 );


```

### [Lower Frame](#lower-frame)

**Syntax:** obj \<< Lower Frame( state=0|1 )

**Description:** Enables or disables a lower frame from appearing on the axis.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
axis = cpr[Nom Axis Box( 1 )];
axis << Lower Frame( 1 );


```

### [Off](#off)

**Syntax:** obj \<< Off

**Description:** Removes the tick marks from the axis.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
axis = cpr[Nom Axis Box( 1 )];
axis << Short;
axis << Off;


```

### [Rotated Tick Labels](#rotated-tick-labels)

**Syntax:** obj \<< Rotated Tick Labels( state=0|1 )

**Description:** Rotates the tick labels horizontally (1) or vertically (0).

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n
        )
    )
);
cpr = cp << report;
cpb = cpr[Cell Plot Box( 1 )];
cpb << Frame Size( 600, 500 );
axis = cpr[Nom Axis Box( 1 )];
axis << Rotated Tick Labels( 0 );


```

### [Short](#short)

**Syntax:** obj \<< Short

**Description:** Draws short tick marks on the axis.

```

Open( "$SAMPLE_DATA/SAT.jmp" );
New Window( "Example",
    cp = Cell Plot(
        Scale Uniformly( 0 ),
        Center at zero( 0 ),
        Y(
            :"2004 Verbal"n, :"2004 Math"n, :"2003 Verbal"n, :"2003 Math"n, :"2002 Verbal"n,
            :"2002 Math"n, :"2001 Verbal"n, :"2001 Math"n, :"1999 Verbal"n, :"1999 Math"n,
            :"1994 Verbal"n, :"1994 Math"n, :"1997 Verbal"n, :"1997 Math"n, :"1992 Verbal"n,
            :"1992 Math"n
        )
    )
);
cpr = cp << report;
axis = cpr[Nom Axis Box( 1 )];
axis << Short;


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [NumberBox](#numberbox)

## [Item Messages](#item-messages)

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Get Base Font;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Format](#get-format)

**Syntax:** format = obj \<< Get Format

**Description:** Returns the format of the number to display.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Get Format();


```

### [Get Tip](#get-tip)

**Syntax:** "string" = obj \<< Get Tip

**Description:** Returns the tooltip of the Number Box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Set Tip( "Example Tooltip" );
numbox << Get Tip();


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns how many characters wide the number edit box is.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Get Width;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Format](#set-format)

**Syntax:** obj \<< Set Format( "format", \<width, <decimal places>>, \<"Use thousands separator"> )

**Description:** Set the format of the number to display.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( text )

**Description:** Sets the tooltip of the Number Box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Set Tip( "Example Tooltip" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the number edit box to be n characters wide.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
Wait( 1 );
numbox << Set Width( 10 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [NumberColBox](#numbercolbox)

## [Associated Constructors](#associated-constructors)

### [Number Col Box](#number-col-box)

**Syntax:** y = Number Col Box( title, numbers )

**Description:** Returns a display box that displays numbers in a column.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Align Decimal Separator](#align-decimal-separator)

**Syntax:** obj \<< Align Decimal Separator( state=0|1 )

**Description:** Specifies that the values in the column are vertically aligned using the decimal separator.

**JMP Version Added:** 17

```

New Window( "Example", ncb = Number Col Box( "Column1", {1.2, 3.14, 45.6789} ) );
ncb << Align Decimal Separator( 1 );


```

### [Bootstrap](#bootstrap)

**Syntax:** obj \<< Bootstrap( nsample, Random Seed(number), Fractional Weights(0|1), Split Selected Column(0|1), Discard Stacked Table if Split Works(0|1) )

**Description:** Bootstraps this analysis: repeating it many times with different resampling weights and collecting tables as selected.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line;
(obj << Report)[Number Col Box( 1 )] << Bootstrap(
    50,
    Fractional Weights( 1 ),
    Split Selected Column( 1 )
);


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Enable Semantic Formats](#enable-semantic-formats)

**Syntax:** obj \<< Enable Semantic Formats( state=0|1 )

**Description:** Controls whether semantic formats are applied to the column. Semantic formats can also be controlled via preferences.

**JMP Version Added:** 17

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Enable Semantic Formats( 0 );
Show( col << Get Enable Semantic Formats );


```

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get );


```

### [Get Align Decimal Separator](#get-align-decimal-separator)

**Syntax:** obj \<< Get Align Decimal Separator

**Description:** Returns 1 if the column aligns values on the decimal separator, 0 otherwise.

**JMP Version Added:** 17

```

New Window( "Example", ncb = Number Col Box( "Column1", {1.2, 3.14, 45.6789} ) );
ncb << Get Align Decimal Separator;


```

### [Get As Matrix](#get-as-matrix)

**Syntax:** matrix = obj \<< Get As Matrix

**Description:** Returns the values in a matrix, specifically a column vector.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get As Matrix );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Conditional Format](#get-conditional-format)

**Syntax:** format = obj \<< Get Conditional Format

**Description:** Returns the conditional format.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Time Series/Oil.jmp" );
ts = Time Series( X( :Depth ), Y( :Response ) );
tsr = ts << report;
ncb = tsr[Number Col Box( 5 )];
ncb << Set Conditional Format( "PValue" );
ncb << Get Conditional Format();


```

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Effective Format](#get-effective-format)

**Syntax:** obj \<< Get Effective Format( <row> )

**Description:** Returns the column's effective format, that is the format after applying any matching semantic format. If row is given, returns the effective format for just that row.

**JMP Version Added:** 17

```

New Window( "Example NCB",
    ncb1 = Number Col Box( "Column1", {0.123, 3.1415, 45.6789} ),
    ncb2 = Number Col Box( "Column2", {0.123, 3.1415, 45.6789} )
);
ncb1 << Set Format( "Fixed Dec", 10, 2 );
ncb2 << Set Format( "Fixed Dec", 10, 2 );

// Create a semantic format
Preferences(
    Semantic formatting(
        Add Semantic Format(
            Format Name( "Example NCB Format" ),
            Semantic Format( Format( "Scientific", 20, 2 ) ),
            Criteria( Object Name( "Column1" ), Platform Name( "Example NCB" ) )
        )
    )
);

Show(
    ncb1 << Get Effective Format,
    ncb1 << Get Format,
    ncb2 << Get Effective Format,
    ncb2 << Get Format
);


```

### [Get Enable Semantic Formats](#get-enable-semantic-formats)

**Syntax:** obj \<< Get Enable Semantic Formats

**Description:** Returns the Enable Semantic Formats setting for the column. Semantic formats can also be controlled via preferences.

**JMP Version Added:** 17

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Enable Semantic Formats( 0 );
Show( col << Get Enable Semantic Formats );


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Font;


```

### [Get Format](#get-format)

**Syntax:** width,<decimalplaces> = obj \<< Get Format

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

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get Format );


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get Heading() );


```

### [Hide Missing Values](#hide-missing-values)

**Syntax:** obj \<< Hide Missing Values( state=0|1 )

**Description:** Missing values will not be shown when set to 1

**JMP Version Added:** 17

```

New Window( "Example",
    Table Box(
        ncb = Number Col Box( "Hide Missing", {1.2, ., 45.6789} ),
        Number Col Box( "Show Missing", {1.2, ., 45.6789} )
    )
);
ncb << Hide Missing Values( 1 );


```

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Conditional Format](#set-conditional-format)

**Syntax:** obj \<< Set Conditional Format( "Correlation"|"PValue"|"Factor Pattern" )

**Description:** Sets the conditional format.

```

Open( "$SAMPLE_DATA/Time Series/Oil.jmp" );
ts = Time Series( X( :Depth ), Y( :Response ) );
tsr = ts << report;
ncb = tsr[Number Col Box( 5 )];
ncb << Set Conditional Format( "PValue" );


```

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Format](#set-format)

**Syntax:** obj \<< Set Format( "format", \<width, <decimal places>>, \<"Use thousands separator"> )

**Description:** Set the format of the numbers to display.

#### [Currency](#currency)

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Format( Format( "Currency", "USD" ) );


```

#### [Duration](#duration)

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Format( {"hr:m:s", 11, 2} );


```

#### [Fixed](#fixed)

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Format( "Fixed", 8, 3 );


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Heading( "New Column Header" );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( matrix )

**Description:** Updates the NumberColBox to the values provided.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Values( [1, 2, 3, 4] );


```

### [Simulate](#simulate)

**Syntax:** obj \<< Simulate( nsample, Random Seed(number), Out(column), In(column), Update(<columns>) )

**Description:** Performs a simulation by switching out a column with one that has a simulation formula.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Fit Model(
    Y( :weight ),
    Effects( :age, :sex, :height ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( Adaptive ) ), Validation Method( AICc ) ) )
);
obj << (fit[1] << Save Simulation Formula);
rpt = Report( obj );
dtlst = rpt["Parameter Estimates for Original Predictors"][
Number Col Box( "Prob > ChiSquare" )] << Simulate(
    10,
    Out( :weight ),
    In( :weight Simulation Formula )
);
dtlst[2] << Distribution( Y( :height ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [NumberColEditBox](#numbercoleditbox)

## [Associated Constructors](#associated-constructors)

### [Number Col Edit Box](#number-col-edit-box)

**Syntax:** y = Number Col Edit Box( title, numbers )

**Description:** Returns a display box that displays editable numbers in a column.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Align Decimal Separator](#align-decimal-separator)

**Syntax:** obj \<< Align Decimal Separator( state=0|1 )

**Description:** Specifies that the values in the column are vertically aligned using the decimal separator.

**JMP Version Added:** 17

```

New Window( "Example", ncb = Number Col Box( "Column1", {1.2, 3.14, 45.6789} ) );
ncb << Align Decimal Separator( 1 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Enable Semantic Formats](#enable-semantic-formats)

**Syntax:** obj \<< Enable Semantic Formats( state=0|1 )

**Description:** Controls whether semantic formats are applied to the column. Semantic formats can also be controlled via preferences.

**JMP Version Added:** 17

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Enable Semantic Formats( 0 );
Show( col << Get Enable Semantic Formats );


```

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get );


```

### [Get Align Decimal Separator](#get-align-decimal-separator)

**Syntax:** obj \<< Get Align Decimal Separator

**Description:** Returns 1 if the column aligns values on the decimal separator, 0 otherwise.

**JMP Version Added:** 17

```

New Window( "Example", ncb = Number Col Box( "Column1", {1.2, 3.14, 45.6789} ) );
ncb << Get Align Decimal Separator;


```

### [Get As Matrix](#get-as-matrix)

**Syntax:** matrix = obj \<< Get As Matrix

**Description:** Returns the values in a matrix, specifically a column vector.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get As Matrix );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Conditional Format](#get-conditional-format)

**Syntax:** format = obj \<< Get Conditional Format

**Description:** Returns the conditional format.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Time Series/Oil.jmp" );
ts = Time Series( X( :Depth ), Y( :Response ) );
tsr = ts << report;
ncb = tsr[Number Col Box( 5 )];
ncb << Set Conditional Format( "PValue" );
ncb << Get Conditional Format();


```

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Effective Format](#get-effective-format)

**Syntax:** obj \<< Get Effective Format( <row> )

**Description:** Returns the column's effective format, that is the format after applying any matching semantic format. If row is given, returns the effective format for just that row.

**JMP Version Added:** 17

```

New Window( "Example NCB",
    ncb1 = Number Col Box( "Column1", {0.123, 3.1415, 45.6789} ),
    ncb2 = Number Col Box( "Column2", {0.123, 3.1415, 45.6789} )
);
ncb1 << Set Format( "Fixed Dec", 10, 2 );
ncb2 << Set Format( "Fixed Dec", 10, 2 );

// Create a semantic format
Preferences(
    Semantic formatting(
        Add Semantic Format(
            Format Name( "Example NCB Format" ),
            Semantic Format( Format( "Scientific", 20, 2 ) ),
            Criteria( Object Name( "Column1" ), Platform Name( "Example NCB" ) )
        )
    )
);

Show(
    ncb1 << Get Effective Format,
    ncb1 << Get Format,
    ncb2 << Get Effective Format,
    ncb2 << Get Format
);


```

### [Get Enable Semantic Formats](#get-enable-semantic-formats)

**Syntax:** obj \<< Get Enable Semantic Formats

**Description:** Returns the Enable Semantic Formats setting for the column. Semantic formats can also be controlled via preferences.

**JMP Version Added:** 17

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Enable Semantic Formats( 0 );
Show( col << Get Enable Semantic Formats );


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Get Font;


```

### [Get Format](#get-format)

**Syntax:** width,<decimalplaces> = obj \<< Get Format

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

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get Format );


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Function(
    Function( {this, which},
        Print( "row " || Char( which ) || " changed to " || Char( col << Get( which ) ) )
    )
);
col << Get Function;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Print( col << Get Heading() );


```

### [Hide Missing Values](#hide-missing-values)

**Syntax:** obj \<< Hide Missing Values( state=0|1 )

**Description:** Missing values will not be shown when set to 1

**JMP Version Added:** 17

```

New Window( "Example",
    Table Box(
        ncb = Number Col Box( "Hide Missing", {1.2, ., 45.6789} ),
        Number Col Box( "Show Missing", {1.2, ., 45.6789} )
    )
);
ncb << Hide Missing Values( 1 );


```

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Conditional Format](#set-conditional-format)

**Syntax:** obj \<< Set Conditional Format( "Correlation"|"PValue"|"Factor Pattern" )

**Description:** Sets the conditional format.

```

Open( "$SAMPLE_DATA/Time Series/Oil.jmp" );
ts = Time Series( X( :Depth ), Y( :Response ) );
tsr = ts << report;
ncb = tsr[Number Col Box( 5 )];
ncb << Set Conditional Format( "PValue" );


```

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Format](#set-format)

**Syntax:** obj \<< Set Format( "format", \<width, <decimal places>>, \<"Use thousands separator"> )

**Description:** Set the format of the numbers to display.

#### [Currency](#currency)

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Format( Format( "Currency", "USD" ) );


```

#### [Duration](#duration)

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Format( {"hr:m:s", 11, 2} );


```

#### [Fixed](#fixed)

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Format( "Fixed", 8, 3 );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, which}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when a change is committed. which is the row number of the cell that changed.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Function(
    Function( {thisBox, which},
        Print( "row " || Char( which ) || " changed to " || Char( thisBox << Get( which ) ) )
    )
);


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Heading( "New Column Header" );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( matrix )

**Description:** Updates the NumberColBox to the values provided.

```

New Window( "Example",
    col = Number Col Edit Box(
        "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Set Values( [1, 2, 3, 4] );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [NumberEditBox](#numbereditbox)

## [Associated Constructors](#associated-constructors)

### [Number Edit Box](#number-edit-box)

**Syntax:** y = Number Edit Box( initValue, <width> )

**Description:** Returns an edit box that accepts only numeric input. Specify the optional width argument to set the width of the box in characters.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );


```

## [Item Messages](#item-messages)

### [Decrement](#decrement)

**Syntax:** obj \<< Decrement

**Description:** Decrements the value by the current setting.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Increment( 1 );
numbox << Set( 0 );
Wait( 2 );
numbox << Decrement;


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

New Window( "Example", numbox = Number Edit Box( 0 ) );
numbox << Enable( 0 );


```

### [Get](#get)

**Syntax:** obj \<< Get

**Description:** Returns the number currently entered in the edit box

```

New Window( "Example", numbox = Number Edit Box( 0 ) );
Print( numbox << Get );


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Get Base Font;


```

### [Get Exclude Maximum](#get-exclude-maximum)

**Syntax:** obj \<< Get Exclude Maximum

**Description:** If set, the maximum value is excluded from the valid range of numbers.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Maximum( 100 );
numbox << Set Exclude Maximum( 1 );
numbox << Set( 100 );
numbox << Get Exclude Maximum;


```

### [Get Exclude Minimum](#get-exclude-minimum)

**Syntax:** obj \<< Get Exclude Minimum

**Description:** If set, the minimum value is excluded from the valid range of numbers.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Minimum( 0 );
numbox << Set Exclude Minimum( 1 );
numbox << Set( 0 );
numbox << Get Exclude Minimum;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Format](#get-format)

**Syntax:** format = obj \<< Get Format

**Description:** Returns the format of the number to display.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Get Format();


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

```

New Window( "Example",
    numbox = Number Edit Box(
        42,
        10,
        <<SetFunction(
            Function( {this}, /* put my value into my sibling's display */(this << sib) <<
                settext( this << getText )
            )
        )
    ),
    Text Box( "" )/* here's the sibling box, waiting to show the pw */
);
numbox << Get Function();


```

### [Get Increment](#get-increment)

**Syntax:** inc = obj \<< Get Increment

**Description:** Returns the increment value to be used for stepping control. This value will be used when the up or down arrow keys are pressed during editing or when the \<<Increment or \<<Decrement messages are sent.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Increment( 1 );
numbox << Get Increment;


```

### [Get Integer Only](#get-integer-only)

**Syntax:** obj \<< Get Integer Only

**Description:** If set, only integer values will be allowed.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Integer Only( 1 );
numbox << Set( 1.5 );
numbox << Get Integer Only;


```

### [Get Maximum](#get-maximum)

**Syntax:** max = obj \<< Get Maximum

**Description:** Returns the maximum value. A value of missing indicates that there is no maximum value.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Maximum( 100 );
numbox << Get Maximum();


```

### [Get Minimum](#get-minimum)

**Syntax:** min = obj \<< Get Minimum

**Description:** Returns the minimum value. A value of missing indicates that there is no minimum value.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Minimum( 0 );
numbox << Get Minimum();


```

### [Get Number Changed](#get-number-changed)

**Syntax:** function = obj \<< Get Number Changed

**Description:** Returns the function that is executed each time a change is made to the number.

```

New Window( "Example",
    numbox = Number Edit Box(
        42,
        10,
        <<Set Number Changed(
            Function( {thisBox, value}, /* put my value into my sibling's display */(thisBox
                 << sib) << settext( Char( value ) )
            )
        )
    ),
    Text Box( "" )
);
numbox << Get Number Changed();


```

### [Get Show Spin Box](#get-show-spin-box)

**Syntax:** obj \<< Get Show Spin Box

**Description:** Returns the Spin Box setting.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Increment( 1 );
numbox << Set Show Spin Box( 1 );
numbox << Get Show Spin Box;


```

### [Get Tip](#get-tip)

**Syntax:** "string" = obj \<< Get Tip

**Description:** Returns the tooltip of the Number Box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Set Tip( "Example Tooltip" );
numbox << Get Tip();


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns how many characters wide the number edit box is.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Get Width;


```

### [Increment](#increment)

**Syntax:** obj \<< Increment

**Description:** Sets the increment value to be used for stepping control. This value will be used when the up or down arrow keys are pressed during editing or when the \<<Increment or \<<Decrement messages are sent.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Increment( 1 );
numbox << Set( 0 );
Wait( 2 );
numbox << Increment;


```

### [Is Enabled](#is-enabled)

**Syntax:** obj \<< Is Enabled( state=0|1 )

**Description:** Sets if the TextEditBox can be edited.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Enable( 0 );
numbox << Is Enabled();


```

### [Set](#set)

**Syntax:** obj \<< Set( numeric value,\<run script(0|1)> )

**Description:** Sets the contents of the edit box to the number that is passed in

```

New Window( "Example", numbox = Number Edit Box( 0 ) );
numbox << Set( 2.5 );


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Exclude Maximum](#set-exclude-maximum)

**Syntax:** obj \<< Set Exclude Maximum( state=0|1 )

**Description:** If set, the maximum value is excluded from the valid range of numbers.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Maximum( 100 );
numbox << Set Exclude Maximum( 1 );
numbox << Set( 100 );
numbox << Get;


```

### [Set Exclude Minimum](#set-exclude-minimum)

**Syntax:** obj \<< Set Exclude Minimum( state=0|1 )

**Description:** If set, the minimum value is excluded from the valid range of numbers.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Minimum( 0 );
numbox << Set Exclude Minimum( 1 );
numbox << Set( 0 );
numbox << Get;


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Format](#set-format)

**Syntax:** obj \<< Set Format( "format", \<width, <decimal places>>, \<"Use thousands separator"> )

**Description:** Set the format of the number to display.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
fontobj = numbox = rbiv[NumberBox( 1 )];
numbox << Set Format( Format( Fixed, 7, 3 ) );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when the change to the Number Edit Box is committed.

```

New Window( "Example",
    Number Edit Box(
        42,
        10,
        <<SetFunction(
            Function( {thisBox}, /* put my value into my sibling's display */(thisBox << sib)
                 << settext( thisBox << getText )
            )
        )
    ),
    Text Box( "" )/* here's the sibling box, waiting to show the pw */
);


```

### [Set Increment](#set-increment)

**Syntax:** obj \<< Set Increment( inc )

**Description:** Sets the increment value to be used for stepping control. This value will be used when the up/down keys are pressed during editing or when the \<<Increment or \<<Decrement messages are sent.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Increment( 1 );
numbox << Set( 0 );
Wait( 2 );
numbox << Increment;


```

### [Set Integer Only](#set-integer-only)

**Syntax:** obj \<< Set Integer Only( state=0|1 )

**Description:** If set, only integer values will be allowed.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Integer Only( 1 );
numbox << Set( 1.5 );
numbox << Get;


```

### [Set Maximum](#set-maximum)

**Syntax:** obj \<< Set Maximum( max )

**Description:** Sets the maximum value. A value of missing indicates that there is no maximum value.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Maximum( 100 );
numbox << Set( 101 );
numbox << Get;


```

### [Set Minimum](#set-minimum)

**Syntax:** obj \<< Set Minimum( min )

**Description:** Sets the minimum value. A value of missing indicates that there is no minimum value.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Minimum( 0 );
numbox << Set( -1 );
numbox << Get;


```

### [Set Number Changed](#set-number-changed)

**Syntax:** obj \<< Set Number Changed( Function( {thisBox, value}, <script> ) )

**Description:** Sets the function that is executed each time a change is made to the number. This callback is called during editing before the change is committed. In the case of a canceled Edit operation, an additional callback is generated to provide the original value.

```

New Window( "Example",
    Number Edit Box(
        42,
        10,
        <<Set Number Changed(
            Function( {thisBox, value}, /* put my value into my sibling's display */(thisBox
                 << sib) << settext( Char( value ) )
            )
        )
    ),
    Text Box( "" )
);


```

### [Set Show Spin Box](#set-show-spin-box)

**Syntax:** obj \<< Set Show Spin Box( state=0|1 )

**Description:** Show a Spin Box to increment the value.

```

New Window( "Example", fontobj = numbox = Number Edit Box( 0 ) );
numbox << Set Increment( 1 );
numbox << Set Show Spin Box( 1 );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( text )

**Description:** Sets the tooltip of the Number Box.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
numbox << Set Tip( "Example Tooltip" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the number edit box to be n characters wide.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( Y( :weight ), X( :height ), Kernel Smoother( 1, 1, 0.5, 0 ) );
rbiv = biv << report;
numbox = rbiv[NumberBox( 1 )];
Wait( 1 );
numbox << Set Width( 10 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [OutlineBox](#outlinebox)

## [Associated Constructors](#associated-constructors)

### [Outline Box](#outline-box)

**Syntax:** y = Outline Box( title, <command script pairs list>, displayBox, ... )

**Description:** Returns a display box that groups other display boxes.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Add All Open Files](#add-all-open-files)

**Syntax:** obj \<< Add All Open Files( \<Menu(0,1)> )

**Description:** Brings up the menu to add all of the open files to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Open( "$SAMPLE_DATA/Big Class.jmp" );
ob3 << Add All Open Files;


```

### [Add Context](#add-context)

**Syntax:** obj \<< Add Context

**Description:** Key-Value pair for OutlineBoxes that adds a column for Make Combined Data Table command for TableBoxes

**JMP Version Added:** 16

### [Add Directory of Files](#add-directory-of-files)

**Syntax:** obj \<< Add Directory of Files

**Description:** Brings up the menu to add a directory of files to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Add Directory of Files;


```

### [Add File Reference](#add-file-reference)

**Syntax:** obj \<< Add File Reference

**Description:** Brings up the menu to add a file reference to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Add File Reference;


```

### [Add Open Files](#add-open-files)

**Syntax:** obj \<< Add Open Files( \<Menu(0,1)> )

**Description:** Brings up the menu to add all of the open files to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Open( "$SAMPLE_DATA/Big Class.jmp" );
ob3 << Add All Open Files;


```

### [Add Outline Item](#add-outline-item)

**Syntax:** obj \<< Add Outline Item

**Description:** Brings up the menu to add an outline item to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Add Outline Item;


```

### [Add Script Button](#add-script-button)

**Syntax:** obj \<< Add Script Button

**Description:** Brings up the menu to add a script button to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Add Script Button;


```

### [Add Text Item](#add-text-item)

**Syntax:** obj \<< Add Text Item

**Description:** Brings up the menu to add text to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Add Text Item;


```

### [Add URL Reference](#add-url-reference)

**Syntax:** obj \<< Add URL Reference

**Description:** Brings up the menu to add a URL to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Add URL Reference;


```

### [Add Window Reference](#add-window-reference)

**Syntax:** obj \<< Add Window Reference

**Description:** Brings up the menu to add a window reference to the OutlineBox.

**JMP Version Added:** 16

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Add Window Reference;


```

### [Close](#close)

**Syntax:** obj \<< Close( bool )

**Description:** Closes the outline box.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Close( 1 );


```

### [Close All Below](#close-all-below)

**Syntax:** obj \<< Close All Below

**Description:** Closes this Outline Box and all child Outline Boxes below this node.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Wait( 2 );
ob << Close All Below( 1 );


```

### [Close All Like This](#close-all-like-this)

**Syntax:** obj \<< Close All Like This

**Description:** Closes this Outline Box and all Outline Boxes in the display tree with the same original title or help key.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
fm = dt << Run Script( "Fit Model" );
r = fm << Report;
Wait( 2 );
r["Least Squares Means Table"] << Close All Like This;


```

### [Close Where No Outlines](#close-where-no-outlines)

**Syntax:** obj \<< Close Where No Outlines

**Description:** Closes all nodes that do not have children.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Close Where No Outlines( 1 );


```

### [Edit Links](#edit-links)

**Syntax:** obj \<< Edit Links

**Description:** Finds all the file links in button scripts to edit them.

**JMP Version Added:** 16

### [Get Allow Title Wrapping](#get-allow-title-wrapping)

**Syntax:** 0|1 = obj \<< Get Allow Title Wrapping( state=0|1 )

**Description:** Allows long titles to be wrapped

**JMP Version Added:** 16

```


New Window( "test",
    Outline Box( Repeat( "abc ", 15 ), Text Box( "def" ) ),
    ob = Outline Box( Repeat( "abc ", 15 ),
        Text Box( "def" ),
        <<set allow title wrapping( 0 )
    )
);
Print( ob << get allow title wrapping() );


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Get Base Font;


```

### [Get Close Orientation](#get-close-orientation)

**Syntax:** obj \<< Get Close Orientation

**Description:** Returns setting for Outline Boxes to collapse vertically to save horizontal space.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << outline close orientation( "Vertical" );
ob << Get Close Orientation;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Image Export Display](#get-image-export-display)

**Syntax:** obj \<< Get Image Export Display

**Description:** Get the option for suppressing outline text when saving images

**JMP Version Added:** 15

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Get Image Export Display();


```

### [Get Menu Item State](#get-menu-item-state)

**Syntax:** 0|1|-1 = obj \<< Get Menu Item State( index )

**Description:** Gets the popup menu item state of index menu item. The state will be normal (0), checked (1), or disabled (-1)

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
ob << Set Menu Item State( 2, -1 );
ob << Get Menu Item State( 2 );


```

### [Get Menu Script](#get-menu-script)

**Syntax:** list = obj \<< Get Menu Script

**Description:** Returns the menu script attached to the calling object.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; , "Get Menu Script",
    Print( ob << Get Menu Script )}
);
ob << Get Menu Script;


```

### [Get Scriptable Object](#get-scriptable-object)

**Syntax:** scriptable object = obj \<< Get Scriptable Object

**Description:** Returns a reference to the scriptable object associated with the Outline Box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
bivobj = rbiv << Get Scriptable Object();
Print( bivobj << Class Name );


```

### [Get Submenu](#get-submenu)

**Syntax:** obj \<< Get Submenu( index )

**Description:** Returns the number of submenus under the given menu item

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
ob << Set Submenu( 2, 3 );
ob << Get Submenu( 2 );


```

### [Get Title](#get-title)

**Syntax:** "string" = obj \<< Get Title

**Description:** Gets the title of the outline box.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Print( ob << Get Title );


```

### [Get Title Background Color](#get-title-background-color)

**Syntax:** obj \<< Title Background Color( color ); color = obj \<< Get Title Background Color

**Description:** If the background color is set, the outline title is filled with the background color prior to drawing the title content. If the background color is set to "None", the background and content of the containing boxes show through.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Background Color( "Light Red" );


```

### [Get Title Border](#get-title-border)

**Syntax:** obj \<< Title Border( sides ); sides = obj \<< Get Title Border

**Description:** Title borders are solid lines drawn around the outside of the outline title. If a single value is provided, it is applied to all sides. If two values are specified, they are applied to horizontal and vertical borders. Title borders are relative to the orientation of the title. An outline that is closed vertically rotates the border and the content.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Border( 0 );


```

### [Get Title Border Color](#get-title-border-color)

**Syntax:** obj \<< Title Border Color( color ); color = obj \<< Get Title Border Color

**Description:** Optional color to override the default color for outline title borders.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Border Color( "Black" );


```

### [Get Title Padding](#get-title-padding)

**Syntax:** obj \<< Title Padding( sides ); sides = obj \<< Get Title Padding

**Description:** Title padding adds space between the title content and the border of the title. If a single value is provided, it is applied to all sides. If two values are specified, they are applied to horizontal and vertical padding. Title padding is relative to the orientation of the title. An outline that is closed vertically rotates the padding and the content.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Padding( Top( 5 ), Bottom( 5 ) );


```

### [Get Title Text Color](#get-title-text-color)

**Syntax:** obj \<< Title Text Color( color ); color = obj \<< Get Title Text Color

**Description:** Outline title text is drawn using the given color if it has been set. If the property has not been set, the title inherits the text color of the containing box.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Text Color( "Dark Green" );


```

### [GetHorizontal](#gethorizontal)

**Syntax:** obj \<< GetHorizontal

**Description:** Returns 1 if the outline box's children are oriented horizontally or 0 if not.

```

New Window( "Example",
    ob = Outline Box( "Outline Box", Text Box( "Horizontally " ), Text Box( "Aligned" ) )
);
ob << GetHorizontal;


```

### [GetOpen](#getopen)

**Syntax:** obj \<< GetOpen

**Description:** Returns 1 if the outline box is open or 0 if closed.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Show( ob << Get Open );
Wait( 1 );
ob << Close;
Show( ob << Get Open );


```

### [Horizontal](#horizontal)

**Syntax:** obj \<< Horizontal( bool )

**Description:** Horizontally aligns the outline box's children.

```

New Window( "Example",
    ob = Outline Box( "Outline Box", Text Box( "Horizontally " ), Text Box( "Aligned" ) )
);
ob << horizontal( 1 );


```

### [Image Export Display](#image-export-display)

**Syntax:** obj \<< Image Export Display( "Normal"|"Text Only"|"None" )

**Description:** Option for suppressing outline text when saving images

**JMP Version Added:** 15

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Image Export Display( "None" );
ob << Save Picture( "$TEMP/test.png" );


```

### [Lock](#lock)

**Syntax:** obj \<< Lock

**Description:** If the Outline Box is part of a Journal, unlocks the Journal to allow further modification. Journals can be locked by right-clicking in the margin area.

**JMP Version Added:** 16

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( state=0|1 )

**Description:** Lock the outline title to prevent interactive changes.

**JMP Version Added:** 17

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Lock Title( 1 );


```

### [Open All Below](#open-all-below)

**Syntax:** obj \<< Open All Below

**Description:** Opens this Outline Box and all child Outline Boxes below this node.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Wait( 2 );
ob << Close All Below( 1 );
Wait( 2 );
ob2 << Open All Below( 1 );
Wait( 2 );
ob << Close( 0 );


```

### [Open All Like This](#open-all-like-this)

**Syntax:** obj \<< Open All Like This

**Description:** Opens this Outline Box and all Outline Boxes in the display tree with the same original title or help key.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
fm = dt << Run Script( "Fit Model" );
r = fm << Report;
Wait( 2 );
r["Least Squares Means Table"] << Close All Like This;
Wait( 2 );
r["Least Squares Means Table"] << Open All Like This;


```

### [Outline Close Orientation](#outline-close-orientation)

**Syntax:** obj \<< Outline Close Orientation( "Auto"|"Horizontal"|"Vertical" )

**Description:** Option for Outline Boxes to collapse vertically to save horizontal space

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << outlinecloseorientation( "Vertical" );
ob3 << Close;


```

### [Set Allow Title Wrapping](#set-allow-title-wrapping)

**Syntax:** obj \<< Set Allow Title Wrapping( 0|1 )

**Description:** Allows long titles to be wrapped

**JMP Version Added:** 16

```


New Window( "test",
    Outline Box( Repeat( "abc ", 15 ), Text Box( "def" ) ),
    ob = Outline Box( Repeat( "abc ", 15 ),
        Text Box( "def" ),
        <<set allow title wrapping( 0 )
    )
);


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Menu Item State](#set-menu-item-state)

**Syntax:** obj \<< Set Menu Item State( index, 0|1|-1 )

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

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
ob << Set Menu Item State( 2, -1 );


```

### [Set Menu Script](#set-menu-script)

**Syntax:** obj \<< Set Menu Script( {"string",script,"string",script, ...} )

**Description:** Adds an entry to the menu when you click on the red triangle.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; , "", 0, "Get Menu Script",
    Print( ob << Get Menu Script )}
);


```

### [Set Scriptable Object](#set-scriptable-object)

**Syntax:** obj \<< Set Scriptable Object( <scriptable object> )

**Description:** Sets the scriptable object associated with the Outline Box. Outline Box will show a red triangle menu of messages that can be sent to the scriptable object. If no argument is provided, the scriptable object will be cleared.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Scriptable Object( ob );


```

### [Set Submenu](#set-submenu)

**Syntax:** obj \<< Set Submenu( index, submenu count )

**Description:** Turns the "index" menu item into a submenu with "submenu count" menu items

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
ob << Set Submenu( 2, 3 );


```

### [Set Title](#set-title)

**Syntax:** obj \<< Set Title( "string", \<Run Script(0 | 1)> )

**Description:** Changes the title of the outline box.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Title( "New Outline Box Title" );


```

### [Set Title Changed](#set-title-changed)

**Syntax:** obj \<< Set Title Changed

**Description:** Set a script that runs when the outline title is changed.

**JMP Version Added:** 17

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Set Title Changed(
    Function( {this, oldtitle},
        Print(
            "title changed: old (" || oldtitle || ") new (" || (this << Get Title()) || ")"
        )
    )
);


```

### [SetHorizontal](#sethorizontal)

**Syntax:** obj \<< SetHorizontal( state=0|1 )

**Description:** Horizontally aligns the outline box's children.

```

New Window( "Example",
    ob = Outline Box( "Outline Box", Text Box( "Horizontally " ), Text Box( "Aligned" ) )
);
ob << SetHorizontal( 1 );


```

### [SetOpen](#setopen)

**Syntax:** obj \<< SetOpen( state=0|1 )

**Description:** Opens or closes the outline.

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << SetOpen( 0 );


```

### [Size to Fit](#size-to-fit)

**Syntax:** obj \<< Size to Fit

**Description:** Keep the window sized to fit the content.

**JMP Version Added:** 16

### [Title Background Color](#title-background-color)

**Syntax:** obj \<< Title Background Color( color ); color = obj \<< Get Title Background Color

**Description:** If the background color is set, the outline title is filled with the background color prior to drawing the title content. If the background color is set to "None", the background and content of the containing boxes show through.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Background Color( "Light Red" );


```

### [Title Border](#title-border)

**Syntax:** obj \<< Title Border( sides ); sides = obj \<< Get Title Border

**Description:** Title borders are solid lines drawn around the outside of the outline title. If a single value is provided, it is applied to all sides. If two values are specified, they are applied to horizontal and vertical borders. Title borders are relative to the orientation of the title. An outline that is closed vertically rotates the border and the content.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Border( 0 );


```

### [Title Border Color](#title-border-color)

**Syntax:** obj \<< Title Border Color( color ); color = obj \<< Get Title Border Color

**Description:** Optional color to override the default color for outline title borders.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Border Color( "Black" );


```

### [Title Padding](#title-padding)

**Syntax:** obj \<< Title Padding( sides ); sides = obj \<< Get Title Padding

**Description:** Title padding adds space between the title content and the border of the title. If a single value is provided, it is applied to all sides. If two values are specified, they are applied to horizontal and vertical padding. Title padding is relative to the orientation of the title. An outline that is closed vertically rotates the padding and the content.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Padding( Top( 5 ), Bottom( 5 ) );


```

### [Title Text Color](#title-text-color)

**Syntax:** obj \<< Title Text Color( color ); color = obj \<< Get Title Text Color

**Description:** Outline title text is drawn using the given color if it has been set. If the property has not been set, the title inherits the text color of the containing box.

**JMP Version Added:** 19

```

New Window( "Example",
    fontobj = ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box 3",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob << Title Text Color( "Dark Green" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [OverlayListBox](#overlaylistbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [OwnerBox](#ownerbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [PageBreakBox](#pagebreakbox)

## [Associated Constructors](#associated-constructors)

### [Page Break Box](#page-break-box)

**Syntax:** Page Break Box()

**Description:** Creates a display box that forces a page break.

```

New Window( "Example",
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [11 44 77], [75 25 50] );
        Pen Color( "Blue" );
        Line( [10 30 70], [88 22 44] );
    ),
    Page Break Box(),
    Graph Box(
        Frame Size( 300, 300 ),
        Marker( Marker State( 3 ), [77 44 11], [75 25 50] );
        Pen Color( "Red" );
        Line( [70 30 10], [88 22 44] );
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [PanelBox](#panelbox)

## [Associated Constructors](#associated-constructors)

### [Panel Box](#panel-box)

**Syntax:** y = Panel Box( title, displayBoxArgs )

**Description:** Returns a display box that has a title and contains other display boxes.

```

New Window( "Example", Panel Box( "A Panel Box", Text Box( "Text inside" ) ) );


```

## [Item Messages](#item-messages)

### [Get Title](#get-title)

**Syntax:** "string" = obj \<< Get Title

**Description:** Returns the title of the PanelBox.

```

New Window( "Example", pb = Panel Box( "A Panel Box", Text Box( "Text inside" ) ) );
Print( pb << Get Title() );


```

### [Set Title](#set-title)

**Syntax:** obj \<< Set Title( "string" )

**Description:** Sets the title of the PanelBox.

```

New Window( "Example", pb = Panel Box( "A Panel Box", Text Box( "Text inside" ) ) );
pb << Set Title( "A New Title" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ParallelScaleBox](#parallelscalebox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [PictBox](#pictbox)

## [Associated Constructors](#associated-constructors)

### [Picture Box](#picture-box)

**Syntax:** pict = Picture Box( Picture Object )

**Description:** Returns a display box that contains an image.

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );


```

## [Item Messages](#item-messages)

### [Flip both](#flip-both)

**Syntax:** obj \<< flip both

**Description:** Flips the image in both a vertical and horizontal direction.

**JMP Version Added:** 16

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );
image = pb << Get Image();
image << flip both;


```

### [Flip horizontal](#flip-horizontal)

**Syntax:** obj \<< flip horizontal

**Description:** Flips the image in a horizontal direction.

**JMP Version Added:** 16

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );
image = pb << Get Image();
image << flip horizontal;


```

### [Flip vertical](#flip-vertical)

**Syntax:** obj \<< flip vertical

**Description:** Flips the image in a vertical direction.

**JMP Version Added:** 16

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );
image = pb << Get Image();
image << flip vertical;


```

### [Get Image](#get-image)

**Syntax:** image = obj \<< Get Image

**Description:** Get the image contained by the box.

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );
image = pb << Get Image();
Print( image << Get Size() );


```

### [Rotate Left](#rotate-left)

**Syntax:** obj \<< Rotate Left

**Description:** Rotates the image 90 degrees counterclockwise.

**JMP Version Added:** 16

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );
pb << Rotate Left;


```

### [Rotate Right](#rotate-right)

**Syntax:** obj \<< Rotate Right

**Description:** Rotates the image 90 degrees clockwise.

**JMP Version Added:** 16

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );
pb << Rotate Right;


```

### [Set Image](#set-image)

**Syntax:** obj \<< Set Image( image )

**Description:** Set the image contained by the box

```

New Window( "Example", pb = Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) ) );
Wait( 2 );
pb << Set Image( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [PictSeg](#pictseg)

## [Item Messages](#item-messages)

### [Bounds](#bounds)

**Syntax:** obj \<< Bounds( left(value), right(value), top(value), bottom(value) )

**Description:** Sets the boundaries of the PictSeg in axes coordinates.

```

imgBox = Graph Box( frameSize( 150, 150 ) );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage( Image( img ) );
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) );
{l, r, t, b} = imgSeg << getBounds;


```

### [Contrast](#contrast)

**Syntax:** obj \<< filter("contrast")

**Description:** Applies contrast to the image in the PictSeg. A positive value makes the image brighter, a negative value makes the image darker. Useful value is -10 to 10.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "contrast", 3 );


```

### [Crop](#crop)

**Syntax:** obj \<< Crop

**Description:** Crops the PictSeg to the specified size, removing any portion of the image outside the specified bounds. The order is implied as left, top, right, bottom. This might cause the image to be distorted as the aspect ratio is not preserved.

```

imgBox = Graph Box( frameSize( 451, 451 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
Wait( 1 );
imgSeg << Crop( 10, 90, 90, 10 );


```

### [Despeckle](#despeckle)

**Syntax:** obj \<< filter("despeckle")

**Description:** Applies a despeckling filter to the image in the PictSeg, to remove noise.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "despeckle" );


```

### [Edge](#edge)

**Syntax:** obj \<< filter("edge")

**Description:** Applies an edge detection filter to the image in the PictSeg. Edges are drawn as black, everything else becomes white.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "edge" );


```

### [Enhance](#enhance)

**Syntax:** obj \<< filter("enhance")

**Description:** Applies an enhancement filter to the image in the PictSeg, making the image appear crisper.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "enhance" );


```

### [Fill Graph](#fill-graph)

**Syntax:** obj \<< Fill Graph

**Description:** Sets the bounds to be the extents of the axes, causing the PictSeg to fill the graph. This might cause the image to be distorted as the aspect ratio is not preserved.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage( Image( img ), bounds( Left( 0 ), Right( 50 ), top( 50 ), bottom( 0 ) ) );
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
Wait( 1 );
imgSeg << fill graph;


```

### [Flip both](#flip-both)

**Syntax:** obj \<< flip both

**Description:** Flips the image in the PictSeg in both a vertical and horizontal direction.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << flip both;


```

### [Flip horizontal](#flip-horizontal)

**Syntax:** obj \<< flip horizontal

**Description:** Flips the image in the PictSeg in a horizontal direction.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << flip horizontal;


```

### [Flip vertical](#flip-vertical)

**Syntax:** obj \<< flip vertical

**Description:** Flips the image in the PictSeg in a vertical direction.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << flip vertical;


```

### [Gamma](#gamma)

**Syntax:** obj \<< filter("gamma")

**Description:** Adjusts the gamma in the image in the PictSeg. Useful range is 0 to 10. A value of 0 to 1, decreases the gamma. A value greater than 1 increases the gamma.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "gamma", 1.5 );


```

### [Gaussian Blur](#gaussian-blur)

**Syntax:** obj \<< filter("gaussian blur", radius, sigma)

**Description:** Applies a blur to the image in the PictSeg. Useful range for radius is 0 to 5.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "gaussian blur", 0.0, 1.0 );


```

### [Get Bounds](#get-bounds)

**Syntax:** {left, right, top, bottom} = obj \<< Get Bounds

**Description:** Returns the boundaries of the PictSeg in axes coordinates in the order of left, right, top and bottom.

```

imgBox = Graph Box( frameSize( 150, 150 ) );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
{l, r, t, b} = imgSeg << getBounds;


```

### [Get Size](#get-size)

**Syntax:** {width, height} = obj \<< Get Size

**Description:** Returns the size of the PictSeg in pixel coordinates as width and height.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
{w, h} = imgSeg << getSize;


```

### [Lock](#lock)

**Syntax:** obj \<< Lock( state=0|1 )

**Description:** Locks the image in the PictSeg in place, preventing it from being moved, resized or rotated interactively.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << lock( 1 );


```

### [Median](#median)

**Syntax:** obj \<< filter("median")

**Description:** Applies a median filter to the image in the PictSeg. This replaces each pixel value with the median average of the surrounding pixels.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "median" );


```

### [Move](#move)

**Syntax:** obj \<< Move( xcenter, ycenter )

**Description:** Moves the center of the image to the specified x,y location, where xcenter and ycenter are expressed in axes coordinates.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
imgBox = win[framebox( 1 )];
imgBox << AddImage( Open( "$SAMPLE_IMAGES/tile.jpg" ) );
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Move( 75, 75 );


```

### [Negate](#negate)

**Syntax:** obj \<< filter("negate")

**Description:** Applies a filter to the image in the PictSeg which reverses the colors. Red, green, blue becomes cyan, yellow magenta, white becomes black, etc.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "negate" );


```

### [Normalize](#normalize)

**Syntax:** obj \<< filter("normalize")

**Description:** Applies a normalization filter to the image in the PictSeg. This takes the range of the pixel values in the image and stretches them out across the color range, creating a wider contrast of colors.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "normalize" );


```

### [Open](#open)

**Syntax:** obj \<< Open( filename )

**Description:** Opens an image file and adds the image to the PictSeg.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Open( "$SAMPLE_IMAGES/tile.jpg" ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);


```

### [Reduce Noise](#reduce-noise)

**Syntax:** obj \<< filter("reduce noise", radius)

**Description:** Applies a noise reduction filter to the image in the PictSeg. This averages a pixel with its neighbors, based on the radius. Useful range is 0 to 5.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "reduce noise", 2.0 );


```

### [Remove](#remove)

**Syntax:** obj \<< Remove

**Description:** Removes the PictSeg from the display box.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
Wait( 1 );
imgSeg << remove;


```

### [Rotate](#rotate)

**Syntax:** obj \<< Rotate( degrees )

**Description:** Rotates the PictSeg in a clockwise direction by the specified number of degrees.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << rotate( 45 );


```

### [SetSize](#setsize)

**Syntax:** obj \<< SetSize( {width, height} )

**Description:** Sets the size of the PictSeg in pixel coordinates as width and height.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << setSize( {300, 500} );
{w, h} = imgSeg << getSize;


```

### [Sharpen](#sharpen)

**Syntax:** obj \<< filter("sharpen")

**Description:** Applies a sharpening filter to the image in the PictSeg, making the image appear crisper.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Filter( "sharpen" );


```

### [Specify Size](#specify-size)

**Syntax:** obj \<< Specify Size

**Description:** Sets the bounds of the PictSeg. Similar to set bounds except the order is implied as left, top, right, bottom. This might cause the image to be distorted as the aspect ratio is not preserved.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage( Image( img ) );
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
Wait( 1 );
imgSeg << Specify Size( 0, 100, 100, 0 );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( transparency )

**Description:** Sets the transparency for the PictSeg where 0.0 is completely transparent and 1.0 is completely opaque.

```

imgBox = Graph Box( frameSize( 150, 150 ), SuppressAxes );
win = New Window( "Image", imgBox );
img = New Image( "$SAMPLE_IMAGES/tile.jpg" );
imgBox = win[framebox( 1 )];
imgBox << AddImage(
    Image( img ),
    bounds( Left( 0 ), Right( 100 ), top( 100 ), bottom( 0 ) )
);
imgSeg = imgBox << FindSeg( PictSeg( 1 ) );
imgSeg << Transparency( 0.5 );


```

# [PieSeg](#pieseg)

## [Associated Constructors](#associated-constructors)

### [Pie Seg](#pie-seg)

**Syntax:** ps = Pie Seg(\<{ xorigin, yorigin }>, <radius>, \<style("pie", "ring", "coxcomb")>, values)

**Description:** Creates a Pie Seg at the specified origin, with the specified radius, based on values specified in matrix format.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Fill Color( "Green" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Frame;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fill Color](#get-fill-color)

**Syntax:** color = obj \<< Get Fill Color

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Fill Color;


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Fill Pattern;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Gradient Transparency;


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Line Width;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Marker Size;


```

### [Get Origin](#get-origin)

**Syntax:** obj \<< Get Origin

**Description:** Gets the origin of the Pie.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
nw = New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);
frame = nw[framebox( 1 )];
seg = frame << Find Seg( "Pie Seg" );
Wait( 2 );
{ox, oy} = seg << getOrigin;


```

### [Get Radius](#get-radius)

**Syntax:** obj \<< Get Radius

**Description:** Gets the radius of the Pie.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
nw = New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);
frame = nw[framebox( 1 )];
seg = frame << Find Seg( "Pie Seg" );
Wait( 2 );
rad = seg << getRadius;


```

### [Get Style](#get-style)

**Syntax:** obj \<< Get Style

**Description:** Gets the style of the Pie, which is either Pie, Ring or Coxcomb.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
nw = New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);
frame = nw[framebox( 1 )];
seg = frame << Find Seg( "Pie Seg" );
Wait( 2 );
style = seg << getStyle;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 (clear) and 1 (opaque).

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Get Transparency;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Gradient Transparency( "None" );


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Origin](#origin)

**Syntax:** obj \<< Origin( Xorigin, Yorigin )

**Description:** Set the origin of the Pie.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
nw = New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);
frame = nw[framebox( 1 )];
seg = frame << Find Seg( "Pie Seg" );
Wait( 2 );
seg << origin( 35, 25 );


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Parent;


```

### [Radius](#radius)

**Syntax:** obj \<< Radius( radius )

**Description:** Set the radius of the Pie.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
nw = New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);
frame = nw[framebox( 1 )];
seg = frame << Find Seg( "Pie Seg" );
Wait( 2 );
seg << radius( 0.5 );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Label Offset](#set-label-offset)

**Syntax:** Set Label Offset {Wedge Index, X Scale Coordinate (0-1), Y Scale Coordinate (0-1)}

**Description:** Set the offset of a pie wedge's value label to a coordinate in the graph

**JMP Version Added:** 16

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Line Width( 3 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Transparency( .3 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Style](#style)

**Syntax:** obj \<< Style( "pie", "ring", "coxcomb" )

**Description:** Set the style of the Pie as either Pie, Ring or Coxcomb.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
nw = New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        Pie Seg( {75, 50}, .25, sumWt )
    )
);
frame = nw[framebox( 1 )];
seg = frame << Find Seg( "Pie Seg" );
Wait( 2 );
seg << Style( "Coxcomb" );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
Summarize( a = by( :age ), c = count, sumHt = Sum( :height ), sumWt = Sum( :weight ) );
New Window( "Pie Seg",
    Graph Box(
        Pie Seg( style( "ring" ), {25, 50}, .25, sumHt ),
        seg = Pie Seg( {75, 50}, .25, sumWt )
    )
);
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [PlatformContainerBox](#platformcontainerbox)

## [Item Messages](#item-messages)

### [Get Scriptable Object](#get-scriptable-object)

**Syntax:** scriptable object = obj \<< Get Scriptable Object

**Description:** Returns a reference to the scriptable object associated with the container.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
(Report( obj ) << XPath( "//PlatformContainerBox" )) << Get Scriptable Object;


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [PlotColBox](#plotcolbox)

## [Associated Constructors](#associated-constructors)

### [Plot Col Box](#plot-col-box)

**Syntax:** y = Plot Col Box( title, numbers )

**Description:** Returns a display box labeled with string as the title to graph the numbers.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Dot](#dot)

**Syntax:** obj \<< Dot

**Description:** Shows a dot rather than a bar.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Dot( 1 );


```

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
Print( col << Get );


```

### [Get As Matrix](#get-as-matrix)

**Syntax:** matrix = obj \<< Get As Matrix

**Description:** Returns the values in a matrix, specifically a column vector.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
Print( pcb << Get As Matrix );


```

### [Get Axis Position](#get-axis-position)

**Syntax:** Default|Top|Bottom = obj \<< Get Axis Position

**Description:** Get the axis position for the plot col. The default is for it to sometimes show on the top depending on the scale and title.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Axis Position( "Bottom" );
pcb << Get Axis Position();


```

### [Get Bar Color](#get-bar-color)

**Syntax:** obj \<< Get Bar Color

**Description:** Get the color of the plot bars

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Bar Color( "White" );
Color To RGB( pcb << Get Bar Color );


```

### [Get Bar Select Color](#get-bar-select-color)

**Syntax:** obj \<< Get Bar Select Color

**Description:** Get the color of the plot bars when in a selected row

```

New Window( "Example",
    tb = Table Box( pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
tb << Set Selectable Rows();
pcb << Set Bar Select Color( "White" );
Color To RGB( pcb << Get Bar Select Color );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Get Font;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
Print( col << Get Heading() );


```

### [Get Labels](#get-labels)

**Syntax:** list = obj \<< Get Labels

**Description:** Returns the labels for each row.

**JMP Version Added:** 16

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Labels( {"A", "B", "C", "D", "E", "F"} );
pcb << Get Labels();


```

### [Get primary interval line properties](#get-primary-interval-line-properties)

**Syntax:** {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } = obj \<< Get primary interval line properties

### [Get secondary interval line properties](#get-secondary-interval-line-properties)

**Syntax:** {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } = obj \<< Get secondary interval line properties

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Lower](#lower)

**Syntax:** obj \<< Lower( list|matrix )

**Description:** Lower limit draws a curve at the points specified.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Lower( [20, 30, 10, 15, 5, 0] );


```

### [Lower2](#lower2)

**Syntax:** obj \<< Lower2( list|matrix )

**Description:** Lower limit draws a curve at the points specified.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Lower( [20, 30, 10, 15, 5, 0] );
pcb << Lower2( [15, 25, 5, 10, 0, -5] );


```

### [Marks](#marks)

**Syntax:** obj \<< Marks

**Description:** Shows markers at the limits of each value.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Marks( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Axis](#set-axis)

**Syntax:** obj \<< Set Axis( \<Format(format)>, \<Inc(number)>, \<Max(number)>, \<Min(number)>, \<Minor Grid Line Color(color)>, \<Minor Ticks(number)>, \<Scale(scale type)>, \<Show Labels(state=0|1)>, \<Show Major Grid(state=0|1)>, \<Show Major Grid Labels (state=0|1)>,\<Show Major Grid Ticks (state=0|1)>, , \<Show Minor Grid(state=0|1)>, \<Show Minor Grid Labels (state=0|1)>,\<Show Minor Grid Ticks (state=0|1)>, \<Tick Label List({labels}, {Values})>, \<Tick Font(font)>, \<Add Ref Line\<(value, < "Solid|Dashed|Double">, <Color>, \<"label">, <line width>, <transparency>)> )

**Description:** Configures the PlotColBox's axis. For more details see AxisBox.

```

dt = Open( "$sample_data\World Demographics.jmp" );
New Window( "World Population",
    Table Box(
        "test",
        String Col Box( "Territory", :Territory << get values ),
        pcb = Plot Col Box( "Population", dt:Name( "Population (1000)" ) << get values )
    )
);
pcb << Set Axis( Min( 0 ), scale( "log" ), Format( "Best", 6 ), Inc( 1 ), Minor Ticks( 1 ) );
pcb << set axis position( "Bottom" );
pcb << set width( 300 );
pcb << set plot style( "Interval" );
pcb << set scrollable( 25 );


```

### [Set Axis Position](#set-axis-position)

**Syntax:** obj \<< Set Axis Position( "Default"|"Top"|"Bottom" )

**Description:** Set the axis for the plot col to always be on top or bottom. The default is for it to sometimes show on the top depending on the scale and title.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Axis Position( "Bottom" );
Wait( 1 );
pcb << Set Axis Position( "Top" );
Wait( 1 );
pcb << Set Axis Position( "Default" );


```

### [Set Bar Color](#set-bar-color)

**Syntax:** obj \<< Set Bar Color( color )

**Description:** Set the color of the plot bars

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Bar Color( "White" );


```

### [Set Bar Select Color](#set-bar-select-color)

**Syntax:** obj \<< Set Bar Select Color( color )

**Description:** Set the color of the plot bars when in a selected row

```

New Window( "Example",
    tb = Table Box( pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
tb << Set Selectable Rows();
tb << Set Selected Rows( [1, 4] );
pcb << Set Bar Select Color( "White" );


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
col << Set Heading( "New Column Header" );


```

### [Set Labels](#set-labels)

**Syntax:** obj \<< Set Labels( list )

**Description:** Sets the labels for each row.

**JMP Version Added:** 16

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Labels( {"A", "B", "C", "D", "E", "F"} );


```

### [Set Plot Style](#set-plot-style)

**Syntax:** obj \<< Set Plot Style( "Default"|"Bar"|"Interval" )

**Description:** Changes the visual representation of the plot column.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Lower( [20, 30, 10, 15, 5, 0] );
pcb << Upper( [20, 30, 10, 15, 5, 0] + 10 );
pcb << Set Plot Style( "Interval" );


```

### [Set Reference Line](#set-reference-line)

**Syntax:** obj \<< Set Reference Line( number )

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Lower( [.20, .30, .10, .15, .5, 0] );
pcb << Upper( [.20, .30, .10, .15, .5, 0] + 10 );
pcb << Set Plot Style( "Interval" );
pcb << Set Reference Line( 1 );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Scale](#set-scale)

**Syntax:** obj \<< Set Scale( minimum, maximum, <format name>, <width> | \<width, decimal places>, < "Use thousands separator"> )

**Description:** Sets the minimum and maximum scale of the PlotColBox. The format parameters specify a format that is only used if the first two parameters are 0 and 1.

#### [Format](#format)

```


dt = Open( "$SAMPLE_DATA/Attribute Gauge.jmp" );
obj = dt << Attribute Chart( Y( :A, :B, :C ), X( :Part ), Standard( :Standard ) );
(obj << xpath( "//PlotColBox" )) << Set Scale( 0, 1, "Percent" );


```

#### [Scale](#scale)

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Scale( 0, 100 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( matrix|list )

**Description:** Updates the PlotColBox to the values provided.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Values( [5, 25, 45, 5, 10, 10] );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width (in pixels) of the PlotColBox.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Set Width( 300 );


```

### [Set primary interval line properties](#set-primary-interval-line-properties)

**Syntax:** obj \<< Set primary interval line properties( {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } )

### [Set secondary interval line properties](#set-secondary-interval-line-properties)

**Syntax:** obj \<< Set secondary interval line properties( {color if upper < reference line, color if crosses reference line, color if lower > reference line, alpha, line width, pen style, cap length } )

### [Significance](#significance)

**Syntax:** obj \<< Significance( list|matrix )

**Description:** Used to size the marker when the plot col is in interval mode.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << set plot style( "Interval" );
pcb << Significance( [2, 3, 1, 1.5, 1, 1] );


```

### [Upper](#upper)

**Syntax:** obj \<< Upper( list|matrix )

**Description:** Upper limit draws a curve at the points specified. A lower limit must first be specified.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Lower( [20, 30, 10, 15, 5, 0] );
pcb << Upper( [20, 30, 10, 15, 5, 0] + 10 );


```

### [Upper2](#upper2)

**Syntax:** obj \<< Upper2( list|matrix )

**Description:** Upper limit draws a curve at the points specified. A lower limit must first be specified.

```

New Window( "Example",
    Table Box( col = pcb = Plot Col Box( "Probability", {25, 45, 5, 10, 10, 5} ) )
);
pcb << Lower( [20, 30, 10, 15, 5, 0] );
pcb << Lower2( [20, 30, 10, 15, 5, 0] - 5 );
pcb << Upper( [20, 30, 10, 15, 5, 0] + 5 );
pcb << Upper2( [20, 30, 10, 15, 5, 0] + 10 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_2)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [PolySeg](#polyseg)

## [Associated Constructors](#associated-constructors)

### [Poly Seg](#poly-seg)

**Syntax:** ps = Poly Seg(x values, y values)

**Description:** Returns a display seg that represents a polygon with vertices based on the passed in x and y values.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Fill Color( "Green" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Frame;


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Get Base Font;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fill Color](#get-fill-color)

**Syntax:** color = obj \<< Get Fill Color

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Fill Color;


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Fill Pattern;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Gradient Transparency;


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Line Width;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Marker Size;


```

### [Get Point](#get-point)

**Syntax:** Point = obj \<< Get Point( index )

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Point( 2 );


```

### [Get Point Count](#get-point-count)

**Syntax:** Number = obj \<< Get Point Count

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Point Count;


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Get Text Color

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Text Color;


```

### [Get Text Style](#get-text-style)

**Syntax:** obj \<< Get Text Style

**Description:** Gets how the text is drawn with respect to the cursor pen.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Get Text Style;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 (clear) and 1 (opaque).

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Transparency;


```

### [Get X Values](#get-x-values)

**Syntax:** matrix = obj \<< Get X Values

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get X Values;


```

### [Get Y Values](#get-y-values)

**Syntax:** matrix = obj \<< Get Y Values

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Get Y Values;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Gradient Transparency( "None" );


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Parent;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Revert;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Text Color](#set-text-color)

**Syntax:** obj \<< Set Text Color( color )

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Text Color( "Green" );


```

### [Set Text Style](#set-text-style)

**Syntax:** obj \<< Set Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Transparency( .3 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color )

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Text Color( "Green" );


```

### [Text Style](#text-style)

**Syntax:** obj \<< Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

x = [10, 50, 90];
y = [10, 90, 10];
New Window( "Poly Seg Example", g = Graph Box( Poly Seg( x, y ) ) );
frame = g[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( Poly Seg( 1 ) ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [PopupBox](#popupbox)

## [Associated Constructors](#associated-constructors)

### [Popup Box](#popup-box)

**Syntax:** y = Popup Box( {label1, script1, ...} )

**Description:** Returns a display box with a popup menu defined by label/script pairs.

```

New Window( "Example",
    Tab Box(
        "alpha",
        Popup Box( {"x", ex = 1, "y", ex = 2} ),
        "beta",
        Panel Box( "panel", Text Box( "text" ) )
    )
);


```

## [Item Messages](#item-messages)

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, index}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when a new item is selected from the Popup Box.

**JMP Version Added:** 14

```

New Window( "Example",
    Popup Box(
        {"x", ex = 1, "y", ex = 2},
        <<SetFunction(
            Function( {thisBox, index},
                (thisBox << sib) << settext( Char( index ) )
            )
        )
    ),
    Text Box( "" )
);


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Project](#project)

## [Item Messages](#item-messages)

### [Add Bookmarks](#add-bookmarks)

**Syntax:** project \<< Add Bookmarks( {\<File(path)>, \<Folder( path, \<Expanded(boolean)> )>, \<Group(name, \<Expanded(boolean)>, {contents}>} )

**Description:** Adds a list bookmarks to the project. Existing bookmarks are retained. The argument is a list of bookmark items, each of which is specified using File(), Folder(), or Group(). The Group() type accepts Files, Folders, and Groups as children using the same syntax recursively.

**JMP Version Added:** 14

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );

project << Add Bookmarks( {File( "$SAMPLE_DATA/Big Class Families.jmp" )} );


```

### [Contents](#contents)

**Syntax:** project \<< Contents()

**Description:** Lists all of the files within a project

**JMP Version Added:** 19

```


project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
project << Contents();


```

### [Extract](#extract)

**Syntax:** project \<< Extract("file")

**Description:** Extract a specific file from the project. The JMP Open() command will not extract files from the project which are not directly openable by JMP. One example would be parquet files.

**JMP Version Added:** 19

```


project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
project << Extract( "myFile.data" );


```

### [Extract All](#extract-all)

**Syntax:** project \<< Extract All()

**Description:** Extracts all files from the project into the temporary directory.

**JMP Version Added:** 19

```


project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
project << Extract All();


```

### [Get Bookmarks](#get-bookmarks)

**Syntax:** project \<< Get Bookmarks()

**Description:** Returns the list of bookmarks in the project. The format of the returned list is the same as is used by Add Bookmarks() and Set Bookmarks().

**JMP Version Added:** 14

```

project = Open( "$SAMPLE_PROJECTS/Sports.jmpprj" );

Print( project << Get Bookmarks() );


```

### [Get Layout](#get-layout)

**Syntax:** project \<< Get Layout()

**Description:** Returns the window layout of the project. The format is the same as is used by Set Layout().

**JMP Version Added:** 14

**Example 1**

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );

Print( project << Get Layout() );


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS/Pizza.jmpprj" );

Print( project << Get Layout() );


```

### [Get Temp Dir](#get-temp-dir)

**Syntax:** project \<< Get Temp Dir()

**Description:** Get the path on disk to the project's temporary directory.

**JMP Version Added:** 19

```


project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
path = project << Get Temp Dir();


```

### [Is Extracted](#is-extracted)

**Syntax:** project \<< Is Extracted("file")

**Description:** Checks to see if a specific file in the project has been extracted to the temporary directory. The JMP Open() command will not extract files from the project which are not directly openable by JMP. One example would be parquet files.

**JMP Version Added:** 19

```


project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
project << Is Extracted( "myFile.data" );


```

### [Project File Path](#project-file-path)

**Syntax:** project \<< Project File Path()

**Description:** Get the path on disk of a saved project file

**JMP Version Added:** 18

**Example 1**

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );

project << project file path();


```

**Example 2**

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );

project << Run Script( This Project() << project file path() );


```

### [Reset Layout](#reset-layout)

**Syntax:** project \<< Reset Layout()

**Description:** Sets the project to use the default window layout.

**JMP Version Added:** 14

```

// 1. Create a new project
project = New Project();

// 2. Open some files
project << Run Script(
    Open( "$SAMPLE_DATA/Big Class.jmp", Set Window ID( "dt" ) );
    New Window( "Big Class - Bivariate of weight by height",
        Set Window ID( "report" ),
        Bivariate( Y( :weight ), X( :height ), )
    );
);

// 3. Set a custom layout
Wait( 3 );
project << Set Layout(
    H Splitter Box(
        <<Set Sizes( {0.85, 0.15} ),
        V Splitter Box(
            <<Set Sizes( {0.5, 0.5} ),
            Tab Page Box( Window ID( "report" ) ),
            Tab Page Box( Window ID( "dt" ) )
        ),
        Tab Page Box( Window ID( "Window List" ) ), 

    )
);

// 4. Go back to the default layout
Wait( 3 );
project << Reset Layout();


```

### [Run Script](#run-script)

**Syntax:** project \<< Run Script(script)

**Description:** Runs a script in the context of the project. Particularly, any windows opened by the script will become part of the project. The script will access JSL names in the project's context, not that of the enclosing script.

**JMP Version Added:** 14

**Example 1**

```

project = New Project();

project << Run Script(
    dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
    dt << Bivariate( Y( :weight ), X( :height ) );
);


```

**Example 2**

```

project = New Project();

dt = project << Run Script( Open( "$SAMPLE_DATA/Big Class.jmp" ) );

dt << Bivariate( Y( :weight ), X( :height ) );


```

### [Save](#save)

**Syntax:** project \<< Save Project(<path>)

**Description:** Saves the project. A path and file name can be specified to save the project to a specific location; if the project has already been saved, this argument is optional.

Unsaved documents in the project must be saved before the saving the project itself.

**JMP Version Added:** 14

```

project = New Project(
    Run Script(
        dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
        dt << Run Script( "Bivariate" );
    )
);

project << Save As( "$TEMP/my project.jmpprj" );


project << Run Script( dt << Run Script( "Distribution" ) );

project << Save();


```

### [Save As](#save-as)

**Syntax:** project \<< Save Project(<path>)

**Description:** Saves the project. A path and file name can be specified to save the project to a specific location; if the project has already been saved, this argument is optional.

Unsaved documents in the project must be saved before the saving the project itself.

**JMP Version Added:** 14

```

project = New Project(
    Run Script(
        dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
        dt << Run Script( "Bivariate" );
    )
);

project << Save As( "$TEMP/my project.jmpprj" );


project << Run Script( dt << Run Script( "Distribution" ) );

project << Save();


```

### [Set Bookmarks](#set-bookmarks)

**Syntax:** project \<< Set Bookmarks( {\<File(path)>, \<Folder( path, \<Expanded(boolean)> )>, \<Group(name, \<Expanded(boolean)>, {contents}>} )

**Description:** Sets the bookmarks for the project. Existing bookmarks are removed. The argument is a list of bookmark items, each of which is specified using File(), Folder(), or Group(). The Group() type accepts Files, Folders, and Groups as children using the same syntax recursively.

**JMP Version Added:** 14

```

project = New Project();

project << Set Bookmarks(
    {File( "$SAMPLE_DATA/Big Class.jmp" ), File( "$SAMPLE_DATA/not found.jmp" ),
    Folder( "$SAMPLE_DATA/Variability Data" ), Group(
        "Sample Scripts",
        Expanded( 1 ),
        {File( "$SAMPLE_SCRIPTS/demoCorr.jsl" ), Group(
            "More Sample Scripts",
            {File( "$SAMPLE_SCRIPTS/Scene3D/Teapot.jsl" )}
        )}
    )}
);


```

### [Set Layout](#set-layout)

**Syntax:** obj \<< Set Layout

**Description:** Sets the window layout of the project.

**JMP Version Added:** 14

```

// 1. Create a new project
project = New Project();

// 2. Open some files
project << Run Script(
    Open( "$SAMPLE_DATA/Big Class.jmp", Set Window ID( "dt" ) );
    New Window( "Big Class - Bivariate of weight by height",
        Set Window ID( "report" ),
        Bivariate( Y( :weight ), X( :height ), )
    );
);

// 3. Set a custom layout
project << Set Layout(
    H Splitter Box(
        <<Set Sizes( {0.85, 0.15} ),
        V Splitter Box(
            <<Set Sizes( {0.5, 0.5} ),
            Tab Page Box( Window ID( "report" ) ),
            Tab Page Box( Window ID( "dt" ) )
        ),
        Tab Page Box( Window ID( "Window List" ) ), 

    )
);


```

### [Show Bookmarks](#show-bookmarks)

**Syntax:** project \<< Show Bookmarks(boolean)

**Description:** Shows or hides the Bookmarks pane in the project

**JMP Version Added:** 14

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Wait( 2 );
project << Show Bookmarks( 0 );
Wait( 2 );
project << Show Bookmarks( 1 );


```

### [Show Contents](#show-contents)

**Syntax:** project \<< Show Contents(boolean)

**Description:** Shows or hides the Contents pane in the project

**JMP Version Added:** 16

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Wait( 2 );
project << Show Window List( 0 );
Wait( 2 );
project << Show Internal Files( 1 );


```

### [Show Log](#show-log)

**Syntax:** project \<< Show Log(boolean)

**Description:** Shows or hides the Log pane in the project

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Wait( 2 );
project << Show Log( 1 );
Wait( 2 );
project << Show Log( 0 );


```

### [Show Recent Files](#show-recent-files)

**Syntax:** project \<< Show Recent Files(boolean)

**Description:** Shows or hides the Recent Files pane in the project

**JMP Version Added:** 15

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Wait( 2 );
project << Show Window List( 0 );
Wait( 2 );
project << Show Recent Files( 1 );


```

### [Show Workspace](#show-workspace)

**Syntax:** project \<< Show Workspace(boolean)

**Description:** Shows or hides the Workspace pane in the project

**JMP Version Added:** 16

```

project = Open( "$SAMPLE_PROJECTS/Big Class.jmpprj" );
Wait( 2 );
project << Show Window List( 0 );
Wait( 2 );
project << Show Window List( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [PropertyEditorBox](#propertyeditorbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [RadioBox](#radiobox)

## [Associated Constructors](#associated-constructors)

### [Radio Box](#radio-box)

**Syntax:** y = Radio Box( {item, ...}, <script> )

**Description:** Returns a display box to show a list or radio buttons. The Script is run when a radio button is clicked.

```

New Window( "Example",
    rb = Radio Box( {"True", "False", "None of the above"}, Print( "Selection Changed" ) )
);


```

## [Item Messages](#item-messages)

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Enable Item](#enable-item)

**Syntax:** obj \<< Enable Item( index, 0|1) )

**Description:** Enables or disables an individual item in a radio box

```

New Window( "Example - disable Green", r = Radio Box( {"Red", "Green", "Blue"} ) );
r << enable item( 2, 0 );


```

### [Get](#get)

**Syntax:** obj \<< Get

**Description:** Returns the 1-based index of the selected radio button.

```

New Window( "Example", r1 = Radio Box( {"Red", "Green", "Blue"}, Print( r1 << Get ) ) );


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} ),
        rb = Radio Box( {"A", "B", "C", "D"} )
    )
);
rb << Set Heading( "Climbed" );
rb << Get Heading;


```

### [Get Items](#get-items)

**Syntax:** list = obj \<< Get Items

**Description:** Returns a list of all of the items.

```

New Window( "Example",
    rb = Radio Box( {"True", "False", "None of the above"}, Print( "Selection Changed" ) )
);
Print( rb << Get Items );


```

### [Get Selected](#get-selected)

**Syntax:** selectedText = obj \<< Get Selected

**Description:** Gets the text of the selected radio button

```

New Window( "Example",
    r1 = Radio Box( {"Red", "Green", "Blue"}, Print( r1 << Get Selected ) )
);


```

### [Group](#group)

**Syntax:** obj \<< Group( radiobox )

**Description:** Groups radio boxes together so that only one radio button in the group is selected at a time

```

r1 = Radio Box( {"On"}, Print( r1 << Get ) );
r2 = Radio Box( {"Off"}, Print( r2 << Get ) );
New Window( "Example", H List Box( r1, r2 ) );
r2 << Group( r1 );


```

### [Index Of](#index-of)

**Syntax:** obj \<< Index Of( string )

**Description:** Returns the index of a string, or 0 if not found

```

New Window( "Example", r = Radio Box( {"Red", "Green", "Blue"} ) );
r << Index Of( "Green" );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Item Enabled](#item-enabled)

**Syntax:** obj \<< Item Enabled( index )

**Description:** Checks to determine whether an individual item in a radio box is enabled or disabled

```

New Window( "Example", r = Radio Box( {"Red", "Green", "Blue"} ) );
r << Item Enabled( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( index, \<run script(0|1)> )

**Description:** Sets the selected radio button.

```

New Window( "Example", r1 = Radio Box( {"Red", "Green", "Blue"} ) );
r1 << set( 2 );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, index}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when a radio box is clicked.

**JMP Version Added:** 14

```

New Window( "Example",
    Radio Box(
        {"True", "False", "None of the above"},
        <<SetFunction(
            Function( {thisBox, index},
                {lb},
                lb = thisBox << sib;
                ((lb << child) << sib) << Set Text( Char( index ) );
                ((((lb << child) << sib) << sib) << sib) <<
                Set Text( Char( thisBox << get selected ) );
            )
        )
    ),
    Lineup Box( N Col( 2 ),
        Text Box( "Index Selected: " ),
        Text Box( "" ),
        Text Box( "Item Selected: " ),
        Text Box( "" )
    )
);


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} ),
        rb = Radio Box( {"A", "B", "C", "D"} )
    )
);
rb << Set Heading( "Climbed" );


```

### [Set Items](#set-items)

**Syntax:** obj \<< Set Items( list )

**Description:** Sets the list of all of the items.

```

New Window( "Example",
    rb = Radio Box( {"True", "False", "None of the above"}, Print( "Selection Changed" ) )
);
Wait( 2 );
rb << Set Items( {"Red", "Green", "Blue"} );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Set Tips](#set-tips)

**Syntax:** obj \<< Set Tips( list )

**Description:** Sets the list of all of the items.

```

New Window( "Example",
    rb = Radio Box( {"True", "False", "None of the above"}, Print( "Selection Changed" ) )
);
rb << Set Tips( {"I agree", "I disagree", "No comment"} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [RangeSeg](#rangeseg)

## [Associated Constructors](#associated-constructors)

### [Range Seg](#range-seg)

**Syntax:** Range Seg

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << Delete;


```

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << Frame;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << get description();


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << Parent;


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << set description( "my seg" );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```


dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
filter = dt << Data Filter(
    Add Filter( columns( :height ), Where( :height >= 54 & :height <= 68 ) )
);
frame = (filter << Report)[FrameBox( 1 )];
seg = (frame << Find Seg( "Range Seg" ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [RangeSliderBox](#rangesliderbox)

## [Associated Constructors](#associated-constructors)

### [Range Slider Box](#range-slider-box)

**Syntax:** y = Range Slider Box( minValue, maxValue, lowVariable, highVariable, script )

**Description:** Returns a display box that shows a range slider control that ranges from minValue to maxValue. As the two sliders' positions change, their values are placed into lowVariable and highVariable, and the script is run.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);


```

## [Item Messages](#item-messages)

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Lower](#get-lower)

**Syntax:** float = obj \<< Get Lower( <index> )

**Description:** Returns the floating-point value the slider is currently set to.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Get Lower() );


```

### [Get Lower Var](#get-lower-var)

**Syntax:** string = obj \<< Get Lower Var

**Description:** Returns the variable name associated with the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Get Lower Var );


```

### [Get Max](#get-max)

**Syntax:** float = obj \<< Get Max( <index> )

**Description:** Returns the maximum value the slider can be set to.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Get Max );


```

### [Get Min](#get-min)

**Syntax:** float = obj \<< Get Min( <index> )

**Description:** Returns the minimum value the slider can be set to.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Get Min );


```

### [Get N](#get-n)

**Syntax:** float = obj \<< Get N

**Description:** Returns the number of sliders that are in the SliderBox.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Get N );


```

### [Get Upper](#get-upper)

**Syntax:** float = obj \<< Get Upper( <index> )

**Description:** Returns the floating-point value the slider is currently set to.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Get Upper() );


```

### [Get Upper Var](#get-upper-var)

**Syntax:** string = obj \<< Get Upper Var

**Description:** Returns the variable name associated with the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Get Upper Var );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Gets the width of the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
sb << Get Width();


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Rescale Slider](#rescale-slider)

**Syntax:** obj \<< Rescale Slider( min,max )

**Description:** Sets the minimum and maximum values the slider should accept

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
sb << Rescale Slider( .2, .8 );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when the value of either slider changes.

**JMP Version Added:** 14

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        sb = Range Slider Box( 0, 1, sliderLowerValue, sliderUpperValue, ),
        Lineup Box( N Col( 2 ),
            Text Box( "Lower Value: " ),
            Text Box( sliderLowerValue ),
            Text Box( "Upper Value: " ),
            Text Box( sliderUpperValue )
        )
    )
);
sb << Set Function(
    Function( {thisBox},
        {lowertb = (((thisBox << sib) << child) << sib)},
        lowertb << Set Text( Char( thisBox << Get Lower ) );
        (((lowertb) << sib) << sib) << Set Text( Char( thisBox << Get Upper ) );
    )
);


```

### [Set Lower](#set-lower)

**Syntax:** obj \<< Set Lower( float, <index>, \<run script(0|1)> )

**Description:** Sets the floating point value of the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
sb << Set Lower( 0.4, 1, run script( 1 ) );


```

### [Set Lower Var](#set-lower-var)

**Syntax:** string = obj \<< Set Lower Var

**Description:** Sets the variable name associated with the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Set Lower Var( mySliderVar ) );


```

### [Set Max](#set-max)

**Syntax:** obj \<< Set Max( float, <index> )

**Description:** Set the maximum value the slider can be set to.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Set Max( 2.0 ) );


```

### [Set Min](#set-min)

**Syntax:** obj \<< Set Min( float, <index> )

**Description:** Set the minimum value the slider can be set to.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Set Min( -1.0 ) );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Set Upper](#set-upper)

**Syntax:** obj \<< Set Upper( float, <index>, \<run script(0|1)> )

**Description:** Sets the floating point value of the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
sb << Set Upper( 0.8, 1, run script( 1 ) );


```

### [Set Upper Var](#set-upper-var)

**Syntax:** string = obj \<< Set Upper Var

**Description:** Sets the variable name associated with the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
Print( sb << Set Upper Var( mySliderVar ) );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the slider.

```

sliderLowerValue = .5;
sliderUpperValue = .7;
New Window( "Example",
    Panel Box( "Range Slider",
        tb1 = Text Box( "Low Value: " || Char( sliderLowerValue ) ),
        tb2 = Text Box( "High Value: " || Char( sliderUpperValue ) ),
        sb = Range Slider Box(
            0,
            1,
            sliderLowerValue,
            sliderUpperValue,
            tb1 << Set Text( "Low Value: " || Char( sliderLowerValue ) );
            tb2 << Set Text( "High Value: " || Char( sliderUpperValue ) );
        )
    )
);
sb << Set Width( 300 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ScaleBox](#scalebox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [SceneBox](#scenebox)

## [Associated Constructors](#associated-constructors)

### [Scene Box](#scene-box)

**Syntax:** box = Scene Box( xsize, ysize )

**Description:** Returns a display box that can execute OpenGL commands.

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

## [Item Messages](#item-messages)

### [ArcBall](#arcball)

**Syntax:** obj \<< ArcBall( list,radius )

**Description:** Draws the objects in the specified list which allow rotation by left clicking and dragging.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << color( 0, 0, 1 );
shape << Text( center, baseline, 0.2, "Hello, World." );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 1 );
scene << Update;


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( red, green, blue )

**Description:** Sets the background color of the Scene Box.

**JMP Version Added:** 16

```

scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << color( 0, 0, 1 );
scene << Text( center, baseline, 0.2, "Hello, World." );
scene << Background Color( 0, 0, 0 );


```

### [Begin](#begin)

**Syntax:** obj \<< Begin

**Description:** Specifies the starting point of a primitive. Uses the OpenGL command glBegin.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Begin( POLYGON );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 0.75, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -0.75, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -0.75, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 0.75, 0 );
shape << End();
scene = Scene Box( 200, 200 );
scene << CallList( shape );
New Window( "Example", scene );


```

### [BlendFunc](#blendfunc)

**Syntax:** obj \<< BlendFunc( source factor,destination factor )

**Description:** Sets the functions used for blending. Uses the OpenGL command glBlendFunc.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Enable( Blend );
shape << BlendFunc( SRC_ALPHA, ONE_MINUS_SRC_ALPHA );
shape << Begin( POLYGON );
shape << Color( 1, 0, 0, 0 );
shape << Vertex( -1, 0.75, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -0.75, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -0.75, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 0.75, 0 );
shape << End();
shape << Disable( Blend );
scene = Scene Box( 200, 200 );
scene << CallList( shape );
New Window( "Example", scene );


```

### [CallList](#calllist)

**Syntax:** obj \<< CallList( list )

**Description:** Draws the objects in the specified list. Uses the OpenGL command glCallList.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0.48, 0.72 );
shape << Disk( .5, 1, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << CallList( shape );
scene << update;


```

### [Clear](#clear)

**Syntax:** obj \<< Clear

**Description:** Clears the scene to the background color.

**JMP Version Added:** 16

```

scene = Scene Box( 500, 500 );
fps = Scene Display List();
window = New Window( "Frames Per Second", scene );
lastTime = 0;
frameCount = 0;
framesPerSecond = "Frames Per Second: ";
While( 1,
    time = Today();
    frameCount++;
    If( time != lastTime,
        framesPerSecond = Char( frameCount );
        frameCount = 0;
        lastTime = time;
    );
    fps << Clear;
    fps << Translate( -1, 0, 0 );
    fps << Color( 1, 0, 0 );
    fps << Text( left, baseline, .1, "Frames Per Second: " || framesPerSecond );
    scene << Clear;
    scene << CallList( fps );
    scene << Update;
    Wait( 0 );
);


```

### [ClipPlane](#clipplane)

**Syntax:** obj \<< ClipPlane( clip_plane0|clip_plane1|clip_plane2|clip_plane3|clip_plane4|clip_plane5,x,y,z,d )

**Description:** Creates a clipping plane. Uses the OpenGL command glClipPlane.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Color( 0, 0.48, 0.72 );
shape << Cylinder( 0.5, 0.5, 2, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << enable( CLIP_PLANE0 );
scene << ClipPlane( CLIP_PLANE0, 1, 1, 0, 0 );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 2 );
scene << Disable( CLIP_PLANE0 );
scene << Update;


```

### [Color](#color)

**Syntax:** obj \<< Color( r,g,b,<a> )

**Description:** Sets the color. For the alpha layer to work, blending must be enabled. Uses the OpenGL command glColor.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Enable( Blend );
shape << BlendFunc( SRC_ALPHA, ONE_MINUS_SRC_ALPHA );
shape << Begin( POLYGON );
shape << Color( 1, 0, 0, 0 );
shape << Vertex( -1, 0.75, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -0.75, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -0.75, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 0.75, 0 );
shape << End();
shape << Disable( Blend );
scene = Scene Box( 200, 200 );
scene << CallList( shape );
New Window( "Example", scene );


```

### [ColorMask](#colormask)

**Syntax:** obj \<< ColorMask( red=0|1,green=0|1,blue=0|1,alpha=0|1 )

**Description:** Applies a color mask to the succeeding objects. Uses the OpenGL command glColorMask.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.0, 0.0 );
shape << Material( Front, Ambient, 0, 1, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << ColorMask( 1, 1, 0, 0 );
shape << Begin( POLYGON );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 1.5, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -1.5, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -1.5, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 1.5, 0 );
shape << End();
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 2 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [ColorMaterial](#colormaterial)

**Syntax:** obj \<< ColorMaterial( Front|Back|Front_And_Back,Emission|Ambient|Diffuse|Specular|Ambient_And_Diffuse )

**Description:** Applies a color material to the succeeding objects. Uses the OpenGL command glColorMaterial.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color Material( Front_And_Back, Ambient );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [CullFace](#cullface)

**Syntax:** obj \<< CullFace( front|back|front_and_back )

**Description:** Sets where culling should be enabled. Uses the OpenGL command glCullFace.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( CULL_FACE );
shape << CullFace( Front );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
shape << Disable( CULL_FACE );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [Cylinder](#cylinder)

**Syntax:** obj \<< Cylinder( base radius,top radius,height,slices,stacks )

**Description:** Creates a cylinder. Uses the OpenGL Utility command gluCylinder.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Color( 0, 0.48, 0.72 );
shape << Cylinder( 0.5, 0.5, 2, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 2 );
scene << Update;


```

### [DepthFunc](#depthfunc)

**Syntax:** obj \<< DepthFunc( nevert|lesst|equalt|lequalt|greatert|notequalt|gequalt|always )

**Description:** Sets the depth function to use for depth buffer comparisons. Uses the OpenGL command glDepthFunc.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( DEPTH_TEST );
shape << DepthFunc( never );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
shape << Disable( DEPTH_TEST );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [DepthMask](#depthmask)

**Syntax:** obj \<< DepthMask( state=0|1 )

**Description:** Sets whether or not the depth buffer can be written to. Uses the OpenGL command glDepthMask.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( DEPTH_TEST );
shape << DepthMask( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
shape << Disable( DEPTH_TEST );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [DepthRange](#depthrange)

**Syntax:** obj \<< DepthRange( near,far )

**Description:** Sets the near and far depth range. Anything outside of this range will not be drawn. Uses the OpenGL command glDepthRange.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( DEPTH_TEST );
shape << DepthRange( 1, 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
shape << Disable( DEPTH_TEST );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [Disable](#disable)

**Syntax:** obj \<< Disable

**Description:** Disables various OpenGL capabilities. Uses the OpenGL command glDisable.

**JMP Version Added:** 16

```

showfog = 1;
scene = Scene Box( 600, 600 );
New Window( "Example",
    scene,
    box = Button Box( "Disable Fog",
        showfog = !showfog;
        refresh();
    )
);
refresh = Function( {},
    scene << clear;
    scene << perspective( 50, .5, 5 );
    scene << translate( 0, 0, -2 );
    scene << backgroundcolor( "Black" );
    If( showfog,
        scene << enable( FOG );
        scene << fog( FOG_END, 3 );
        scene << fog( FOG_START, 1 );
        scene << fog( FOG_COLOR, 0, 0, 0 );
        scene << fog( FOG_MODE, LINEAR );
        box << SetButtonName( "Disable Fog" );
    ,
        scene << disable( FOG );
        box << SetButtonName( "Enable Fog" );
    );
    scene << color( 0, 1, 0 );
    scene << rotate( 180, 1, 0, 0 );
    object = Scene Display List();
    object << cylinder( .8, .4, 1, 40, 10 );
    scene << calllist( object );
    scene << update;
);
refresh();


```

### [Disk](#disk)

**Syntax:** obj \<< Disk( inner radius,outer radius,slices,rings )

**Description:** Creates a disk. Uses the OpenGL Utility command gluDisk.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Color( 0, 0.48, 0.72 );
shape << Disk( .5, 1, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 2 );
scene << Update;


```

### [Enable](#enable)

**Syntax:** obj \<< Enable

**Description:** Enables various OpenGL capabilities. Uses the OpenGL command glEnable.

**JMP Version Added:** 16

```

showfog = 1;
scene = Scene Box( 600, 600 );
New Window( "Example",
    scene,
    box = Button Box( "Disable Fog",
        showfog = !showfog;
        refresh();
    )
);
refresh = Function( {},
    scene << clear;
    scene << perspective( 50, .5, 5 );
    scene << translate( 0, 0, -2 );
    scene << backgroundcolor( "Black" );
    If( showfog,
        scene << enable( FOG );
        scene << fog( FOG_END, 3 );
        scene << fog( FOG_START, 1 );
        scene << fog( FOG_COLOR, 0, 0, 0 );
        scene << fog( FOG_MODE, LINEAR );
        box << SetButtonName( "Disable Fog" );
    ,
        scene << disable( FOG );
        box << SetButtonName( "Enable Fog" );
    );
    scene << color( 0, 1, 0 );
    scene << rotate( 180, 1, 0, 0 );
    object = Scene Display List();
    object << cylinder( .8, .4, 1, 40, 10 );
    scene << calllist( object );
    scene << update;
);
refresh();


```

### [End](#end)

**Syntax:** obj \<< End

**Description:** Specifies the ending point of a primitive. Uses the OpenGL command glEnd.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Begin( POLYGON );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 0.75, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -0.75, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -0.75, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 0.75, 0 );
shape << End();
scene = Scene Box( 200, 200 );
scene << CallList( shape );
New Window( "Example", scene );


```

### [EvalCoord1](#evalcoord1)

**Syntax:** obj \<< EvalCoord1( u )

**Description:** Evaluates the one dimensional map. Uses the OpenGL command glEvalCoord1d.

**JMP Version Added:** 16

```

NPOINTS = 4;
points = J( NPOINTS, 3, 0 );
For( x = 1, x <= NPOINTS, x++,
    points[x, 1] = Random Uniform() - .5;
    points[x, 2] = Random Uniform() - .5;
    points[x, 3] = 0;
);
curve = Scene Box( 500, 400 );
curve << Map1( MAP1_VERTEX_3, 0, 1, 3, NPOINTS, points );
curve << Enable( MAP1_VERTEX_3 );
curve << Ortho2D( -.6, .6, -.6, .6 );
curve << Color( 0, 0, 1 );
curve << Begin( line_strip );
For( i = 0, i <= 30, i++,
    curve << EvalCoord1( i / 30 )
);
curve << End();
curve << Disable( MAP1_VERTEX_3 );
New Window( "Example", curve );


```

### [EvalCoord2](#evalcoord2)

**Syntax:** obj \<< EvalCoord2( u,v )

**Description:** Evaluates the two dimensional map. Uses the OpenGL command glEvalCoord2d.

**JMP Version Added:** 16

```

gridsize = 10;
npoints = 16;
imax = 8;
jmax = 20;
points = J( npoints, 3, 0 );
For( i = 0, i < npoints, i++,
    points[i, 1] = Random Uniform() - .5;
    points[i, 2] = Random Uniform() - .5;
    points[i, 3] = Random Uniform() - .5;
);
surface = Scene Display List();
surface << Enable( MAP2_VERTEX_3 );
surface << Enable( Auto_Normal );
surface << Map2( MAP2_VERTEX_3, 0, 1, 3, 4, 0, 1, 12, 4, points );
surface << color( 0, 0, 1 );
For( i = 0, i <= imax, i++,
    surface << begin( LINE_STRIP );
    For( j = 0, j <= jmax, j++,
        surface << EvalCoord2( j / jmax, i / imax )
    );
    surface << End();
    surface << Begin( LINE_STRIP );
    For( j = 0, j < jmax, j++,
        surface << EvalCoord2( i / imax, j / jmax )
    );
    surface << End();
);
sb = Scene Box( 500, 400 );
sb << Ortho( -.75, .75, -.75, .75, -1, 1 );
sb << CallList( surface );
sb << backgroundcolor( "white" );
New Window( "Example", sb );


```

### [EvalMesh1](#evalmesh1)

**Syntax:** obj \<< EvalMesh1( mode,i1,i2 )

**Description:** Evaluates the one dimensional mesh. Uses the OpenGL command glEvalMesh1.

**JMP Version Added:** 16

```

gridsize = 100;
NPOINTS = 4;
points = J( NPOINTS, 3, 0 );
For( x = 1, x <= NPOINTS, x++,
    points[x, 1] = (x - 1) / (NPOINTS - 1) - .5;
    points[x, 2] = Random Uniform() - .5;
    points[x, 3] = 0;
);
spline = Scene Box( 500, 400 );
spline << Ortho2D( -.6, .6, -.6, .6 );
spline << Enable( MAP1_VERTEX_3 );
spline << MapGrid1( gridsize, 0, 1 );
spline << color( .2, .2, 1 );
spline << Map1( MAP1_VERTEX_3, 0, 1, 3, NPOINTS, points );
spline << EvalMesh1( LINE, 0, gridsize );
New Window( "Example", spline );


```

### [EvalMesh2](#evalmesh2)

**Syntax:** obj \<< EvalMesh2( mode,i1,i2,j1,j2 )

**Description:** Evaluates the two dimensional mesh. Uses the OpenGL command glEvalMesh2.

**JMP Version Added:** 16

```

gridsize = 10;
npoints = 32;
points = J( npoints, 3, 0 );
For( i = 0, i < npoints, i++,
    points[i, 1] = Random Uniform() - .5;
    points[i, 2] = Random Uniform() - .5;
    points[i, 3] = Random Uniform() - .5;
);
surface = Scene Display List();
surface << Enable( MAP2_VERTEX_3 );
surface << Enable( Auto_Normal );
surface << MapGrid2( gridsize, 0, 1, gridsize, 0, 1 );
surface << color( 0, 0, 1 );
surface << Map2( MAP2_VERTEX_3, 0, 1, 3, 4, 0, 1, 12, 4, points );
surface << EvalMesh2( LINE, 0, gridsize, 0, gridsize );
sb = Scene Box( 500, 400 );
sb << Ortho( -.75, .75, -.75, .75, -1, 1 );
sb << ArcBall( surface, 1 );
New Window( "Example", sb );


```

### [EvalPoint1](#evalpoint1)

**Syntax:** obj \<< EvalPoint1( i )

**Description:** Evaluates a single point in the one dimensional mesh. Uses the OpenGL command glEvalPoint1.

**JMP Version Added:** 16

```

NPOINTS = 4;
points = J( NPOINTS, 3, 0 );
For( x = 1, x <= NPOINTS, x++,
    points[x, 1] = Random Uniform() - .5;
    points[x, 2] = Random Uniform() - .5;
    points[x, 3] = 0;
);
curve = Scene Box( 500, 400 );
curve << Map1( MAP1_VERTEX_3, 0, 1, 3, NPOINTS, points );
curve << Enable( MAP1_VERTEX_3 );
curve << Ortho2D( -.6, .6, -.6, .6 );
curve << Color( 0, 0, 1 );
curve << Begin( line_strip );
For( i = 0, i <= 60, i++,
    curve << EvalPoint1( i )
);
curve << End();
curve << Disable( MAP1_VERTEX_3 );
New Window( "Example", curve );


```

### [EvalPoint2](#evalpoint2)

**Syntax:** obj \<< EvalPoint2( i,j )

**Description:** Evaluates a single point in the two dimensional mesh. Uses the OpenGL command glEvalPoint2.

**JMP Version Added:** 16

```

gridsize = 10;
npoints = 16;
imax = 8;
jmax = 20;
points = J( npoints, 3, 0 );
For( i = 0, i < npoints, i++,
    points[i, 1] = Random Uniform() - .5;
    points[i, 2] = Random Uniform() - .5;
    points[i, 3] = Random Uniform() - .5;
);
curves = Scene Display List();
curves << Enable( MAP2_VERTEX_3 );
curves << Enable( Auto_Normal );
curves << Map2( MAP2_VERTEX_3, 0, 1, 3, 4, 0, 1, 12, 4, points );
curves << color( 0, 0, 1 );
For( i = 0, i <= imax, i++,
    curves << begin( LINE_STRIP );
    For( j = 0, j <= jmax, j++,
        curves << EvalCoord2( j / jmax, i / imax )
    );
    curves << End();
    curves << Begin( LINE_STRIP );
    For( j = 0, j < jmax, j++,
        curves << EvalPoint2( i, j )
    );
    curves << End();
);
sb = Scene Box( 500, 400 );
sb << Ortho( -.75, .75, -.75, .75, -1, 1 );
sb << CallList( curves );
sb << backgroundcolor( "white" );
New Window( "Example", sb );


```

### [Fog](#fog)

**Syntax:** obj \<< Fog( fog_mode|fog_density|fog_start|fog_end|fog_index|fog_color,p1,<p2>,<p3>,<p4> )

**Description:** Creates fog. Uses the OpenGL command glFog.

**JMP Version Added:** 16

```

showfog = 1;
scene = Scene Box( 600, 600 );
New Window( "Example",
    scene,
    box = Button Box( "Disable Fog",
        showfog = !showfog;
        refresh();
    )
);
refresh = Function( {},
    scene << clear;
    scene << perspective( 50, .5, 5 );
    scene << translate( 0, 0, -2 );
    scene << backgroundcolor( "Black" );
    If( showfog,
        scene << enable( FOG );
        scene << fog( FOG_END, 3 );
        scene << fog( FOG_START, 1 );
        scene << fog( FOG_COLOR, 0, 0, 0 );
        scene << fog( FOG_MODE, LINEAR );
        box << SetButtonName( "Disable Fog" );
    ,
        scene << disable( FOG );
        box << SetButtonName( "Enable Fog" );
    );
    scene << color( 0, 1, 0 );
    scene << rotate( 180, 1, 0, 0 );
    object = Scene Display List();
    object << cylinder( .8, .4, 1, 40, 10 );
    scene << calllist( object );
    scene << update;
);
refresh();


```

### [Frame](#frame)

**Syntax:** obj \<< Frame( x0,x1,y0,y1,z0,z1,farside )

**Description:** Draws a frame.

**JMP Version Added:** 16

```

scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << frame( -0.2, 0.2, -0.2, 0.2, 0.0, 0.0, 1 );
scene << frame( -0.4, 0.4, -0.4, 0.4, 0.0, 0.0, 1 );
scene << frame( -0.6, 0.6, -0.6, 0.6, 0.0, 0.0, 1 );
scene << frame( -0.8, 0.8, -0.8, 0.8, 0.0, 0.0, 1 );


```

### [FrontFace](#frontface)

**Syntax:** obj \<< FrontFace( cw|ccw )

**Description:** Sets which polygons are front or back facing. This is used with object culling. Uses the OpenGL command glFrontFace.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( CULL_FACE );
shape << CullFace( Front );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
shape << Disable( CULL_FACE );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << frontface( cw );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [Frustum](#frustum)

**Syntax:** obj \<< Frustum( left,right,bottom,top,near,far )

**Description:** Sets the parameters used by the camera. Uses the OpenGL command glFrustum.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << Frustum( -3, 1, -1, 1, 2, 9 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [Get Background Color](#get-background-color)

**Syntax:** color = obj \<< Get Background Color

**Description:** Returns the background color of the Scene Box.

**JMP Version Added:** 16

```

scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << color( 0, 0, 1 );
scene << Text( center, baseline, 0.2, "Hello, World." );
scene << Background Color( 0, 0, 0 );
scene << Get Background Color();


```

### [Get Show ArcBall](#get-show-arcball)

**Syntax:** obj \<< Get Show ArcBall

**Description:** Returns the display state of the ArcBall.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << color( 0, 0, 1 );
shape << Text( center, baseline, 0.2, "Hello, World." );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 1 );
scene << Show ArcBall( always );
scene << Update;
scene << Get Show ArcBall();


```

### [Get Width](#get-width)

**Syntax:** pixels = obj \<< Get Width

**Description:** Returns the width of the box.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;
scene << Get Width();


```

### [Height](#height)

**Syntax:** obj \<< Height( pixels )

**Description:** Sets the height of the box.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;
scene << Height( 150 );


```

### [Light](#light)

**Syntax:** obj \<< Light( light0|light1|light2|light3|light4|light5|light6|light7,ambient|diffuse|specular|position,x|r,y|g,z|b,<a> )

**Description:** Creates a light source with the specified parameters. Uses the OpenGL command glLight.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0.48, 0.72 );
shape << Sphere( 1.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << Light( Light0, Ambient, 0, 0, 1, 1 );
scene << Light( Light0, Diffuse, 0, 1, 1, 1 );
scene << Light( Light0, Specular, 1, 1, 0, 1 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [LightModel](#lightmodel)

**Syntax:** obj \<< LightModel( light_model_ambient|light_model_local_viewer|light_model_two_side,r,g,b,a )

**Description:** Sets the parameters used for the light model. Uses the OpenGL command glLightModel.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << Light Model( light_model_ambient, 0.2, 0, 0.5, 1 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [LineStipple](#linestipple)

**Syntax:** obj \<< LineStipple( factor,pattern )

**Description:** Sets the line stipple pattern. Uses the OpenGL command glLineStipple.

**JMP Version Added:** 16

```

scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << LineWidth( 4 );
scene << color( 0, 0, 0 );
scene << Enable( LINE_STIPPLE );
scene << LineStipple( 2, 01101010 );
scene << Begin( LINES );
scene << Vertex( -.8, 0, 0 );
scene << Vertex( .8, 0, 0 );
scene << End();
scene << Disable( LINE_STIPPLE );


```

### [LineWidth](#linewidth)

**Syntax:** obj \<< LineWidth( width )

**Description:** Sets the width of the line. Uses the OpenGL command glLineWidth.

**JMP Version Added:** 16

```

scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << LineWidth( 1 );
scene << Begin( LINES );
scene << color( 0, 0, 0 );
scene << Vertex( -.4, 0.04, 0 );
scene << Vertex( .4, 0.04, 0 );
scene << End();
scene << LineWidth( 4 );
scene << Begin( LINES );
scene << Vertex( -.4, -0.04, 0 );
scene << Vertex( .4, -0.04, 0 );
scene << End();


```

### [LoadIdentity](#loadidentity)

**Syntax:** obj \<< LoadIdentity

**Description:** Sets the current matrix to the identity matrix. Uses the OpenGL command glLoadIdentity.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0.48, 0.72 );
shape << Sphere( 0.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 1.0, 0.0, -5 );
scene << CallList( shape );
scene << LoadIdentity;
scene << Perspective( 90, 1, 10 );
scene << Translate( -1.0, 0.0, -5 );
scene << CallList( shape );
scene << update;


```

### [LoadMatrix](#loadmatrix)

**Syntax:** obj \<< LoadMatrix( matrix )

**Description:** Sets the current matrix to the specified matrix. Uses the OpenGL command glLoadMatrix.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0.48, 0.72 );
shape << Sphere( 0.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 1.0, 0.0, -5 );
scene << CallList( shape );
identitymatrix = [1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1];
scene << LoadMatrix( identitymatrix );
scene << Perspective( 90, 1, 10 );
scene << Translate( -1.0, 0.0, -5 );
scene << CallList( shape );
scene << update;


```

### [LoadName](#loadname)

**Syntax:** obj \<< LoadName( i )

**Description:** Use with picker, load the integer that identifies the succeeding object. Uses the OpenGL command glLoadName.

**JMP Version Added:** 16

```

spheres = Scene Display List();
spheres << Point Size( 50 );
Spheres << PushName( 0 );
For( i = 0, i < 3, i++,
    spheres << LoadName( (i + 1) );
    spheres << PushMatrix;
    spheres << Translate( (i * 0.75 - .75), 0, 0 );
    spheres << color( 1, 0, 0 );
    spheres << Begin( POINTS );
    spheres << Vertex( 0, 0, -.0001 );
    spheres << End;
    spheres << color( 0, 0, 0 );
    spheres << Text( center, middle, 0.2, Char( (i + 1) ) );
    spheres << PopMatrix;
);
spheres << PopName;
view = Scene Box( 500, 400 );
view << Ortho( -1, 1, -1, 1, -2, 2 );
view << CallList( spheres );
view << update;
New Window( "Example", view );
Print( view << Pick( 50, 200, 1, 1, 4, 1 ) );


```

### [LookAt](#lookat)

**Syntax:** obj \<< LookAt( eye x,eye y,eye z,center x,center y,center z,up x,up y,up z )

**Description:** Sets the location that the camera should be looking. Uses the OpenGL Utility command gluLookAt.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Cylinder( 0.5, 0.5, 2, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 20 );
scene << LookAt( 1, 0, 7, 0, 0, 0, 0, 1, 0 );
scene << ArcBall( shape, 2 );
scene << Update;


```

### [Map1](#map1)

**Syntax:** obj \<< Map1( target,u1,u2,stride,order,points )

**Description:** Defines a one dimensional evaluator. Uses the OpenGL command glMap1d.

**JMP Version Added:** 16

```

gridsize = 100;
NPOINTS = 4;
points = J( NPOINTS, 3, 0 );
For( x = 1, x <= NPOINTS, x++,
    points[x, 1] = (x - 1) / (NPOINTS - 1) - .5;
    points[x, 2] = Random Uniform() - .5;
    points[x, 3] = 0;
);
spline = Scene Box( 500, 400 );
spline << Ortho2D( -.6, .6, -.6, .6 );
spline << Enable( MAP1_VERTEX_3 );
spline << MapGrid1( gridsize, 0, 1 );
spline << color( .2, .2, 1 );
spline << Map1( MAP1_VERTEX_3, 0, 1, 3, NPOINTS, points );
spline << EvalMesh1( LINE, 0, gridsize );
New Window( "Example", spline );


```

### [Map2](#map2)

**Syntax:** obj \<< Map2( target,u1,u2,ustride,uorder,v1,v2,vstride,vorder,points )

**Description:** Defines a two dimensional evaluator. Uses the OpenGL command glMap2d.

**JMP Version Added:** 16

```

gridsize = 10;
npoints = 32;
points = J( npoints, 3, 0 );
For( i = 0, i < npoints, i++,
    points[i, 1] = Random Uniform() - .5;
    points[i, 2] = Random Uniform() - .5;
    points[i, 3] = Random Uniform() - .5;
);
surface = Scene Display List();
surface << Enable( MAP2_VERTEX_3 );
surface << Enable( Auto_Normal );
surface << MapGrid2( gridsize, 0, 1, gridsize, 0, 1 );
surface << color( 0, 0, 1 );
surface << Map2( MAP2_VERTEX_3, 0, 1, 3, 4, 0, 1, 12, 4, points );
surface << EvalMesh2( LINE, 0, gridsize, 0, gridsize );
sb = Scene Box( 500, 400 );
sb << Ortho( -.75, .75, -.75, .75, -1, 1 );
sb << ArcBall( surface, 1 );
New Window( "Example", sb );


```

### [MapGrid1](#mapgrid1)

**Syntax:** obj \<< MapGrid1( un,u1,u2 )

**Description:** Defines a one dimensional mesh. Uses the OpenGL command glMapGrid1d.

**JMP Version Added:** 16

```

gridsize = 100;
NPOINTS = 4;
points = J( NPOINTS, 3, 0 );
For( x = 1, x <= NPOINTS, x++,
    points[x, 1] = (x - 1) / (NPOINTS - 1) - .5;
    points[x, 2] = Random Uniform() - .5;
    points[x, 3] = 0;
);
spline = Scene Box( 500, 400 );
spline << Ortho2D( -.6, .6, -.6, .6 );
spline << Enable( MAP1_VERTEX_3 );
spline << MapGrid1( gridsize, 0, 1 );
spline << color( .2, .2, 1 );
spline << Map1( MAP1_VERTEX_3, 0, 1, 3, NPOINTS, points );
spline << EvalMesh1( LINE, 0, gridsize );
New Window( "Example", spline );


```

### [MapGrid2](#mapgrid2)

**Syntax:** obj \<< MapGrid2( un,u1,u2,vn,v1,v2 )

**Description:** Defines a two dimensional mesh. Uses the OpenGL command glMapGrid2d.

**JMP Version Added:** 16

```

gridsize = 10;
npoints = 32;
points = J( npoints, 3, 0 );
For( i = 0, i < npoints, i++,
    points[i, 1] = Random Uniform() - .5;
    points[i, 2] = Random Uniform() - .5;
    points[i, 3] = Random Uniform() - .5;
);
surface = Scene Display List();
surface << Enable( MAP2_VERTEX_3 );
surface << Enable( Auto_Normal );
surface << MapGrid2( gridsize, 0, 1, gridsize, 0, 1 );
surface << color( 0, 0, 1 );
surface << Map2( MAP2_VERTEX_3, 0, 1, 3, 4, 0, 1, 12, 4, points );
surface << EvalMesh2( LINE, 0, gridsize, 0, gridsize );
sb = Scene Box( 500, 400 );
sb << Ortho( -.75, .75, -.75, .75, -1, 1 );
sb << ArcBall( surface, 1 );
New Window( "Example", sb );


```

### [Material](#material)

**Syntax:** obj \<< Material

**Description:** Specifies the type of material to use for the succeeding objects. Uses the OpenGL command glMaterial.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << update;


```

### [MatrixMode](#matrixmode)

**Syntax:** obj \<< MatrixMode( modelview|projection|texture )

**Description:** Sets which matrix to operate on. Uses the OpenGL command glMatrixMode.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0.48, 0.72 );
shape << Sphere( 0.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 1.0, 0.0, -5 );
scene << CallList( shape );
scene << MatrixMode( projection );
scene << LoadIdentity;
scene << Perspective( 90, 1, 10 );
scene << Translate( -1.0, 0.0, -5 );
scene << CallList( shape );
scene << update;


```

### [MultMatrix](#multmatrix)

**Syntax:** obj \<< MultMatrix( matrix )

**Description:** Multiplies the current matrix by the specified matrix. Uses the OpenGL command glMultMatrix.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0.48, 0.72 );
shape << Sphere( 1.0, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
matrix = [1.5 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1];
scene << MultMatrix( matrix );
scene << CallList( shape );
scene << update;


```

### [Normal](#normal)

**Syntax:** obj \<< Normal( x,y,z )

**Description:** Sets the current normal. Uses the OpenGL command glNormal.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << LightModel( LIGHT_MODEL_TWO_SIDE, 1 );
shape << Color( 0, 0.0, 0.0 );
shape << Material( Front_and_back, Ambient, 0, 1, 1, 1 );
shape << Material( Front_and_back, Diffuse, 0, 1, 1, 1 );
shape << Material( Front_and_back, Specular, 0, 1, 0, 1 );
shape << Material( Front_and_back, Emission, 0, 0, 0, 1 );
shape << Material( Front_and_back, Shininess, 100 );
shape << Begin( POLYGON );
shape << Normal( 0, 0, 1 );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 1.5, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -1.5, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -1.5, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 1.5, 0 );
shape << End();
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 2 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [Ortho](#ortho)

**Syntax:** obj \<< Ortho( left,right,bottom,top,near,far )

**Description:** Sets the scene to an orthogonal view. Uses the OpenGL command glOrtho.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Begin( POLYGON );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 1.5, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -1.5, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -1.5, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 1.5, 0 );
shape << End();
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Ortho( -2, 2, -2, 2, -0.5, 0.5 );
scene << ArcBall( shape, 2 );
scene << update;


```

### [Ortho2D](#ortho2d)

**Syntax:** obj \<< Ortho2D( left,right,bottom,top )

**Description:** Sets the scene to a 2D orthogonal view. Uses the OpenGL Utility command gluOrtho2d.

**JMP Version Added:** 16

```

scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << Ortho2D( -1, 1, -1, 1 );
scene << Shade Model( SMOOTH );
scene << Begin( TRIANGLES );
scene << color( 1, 0, 0 );
scene << Vertex( -1, -1, 0 );
scene << Color( 0, 1, 0 );
scene << Vertex( 0, 1, 0 );
scene << Color( 0, 0, 1 );
scene << Vertex( 1, -1, 0 );
scene << End();
scene << Update;


```

### [PartialDisk](#partialdisk)

**Syntax:** obj \<< PartialDisk( inner radius,outer radius,slices,rings,start angle,sweep angle )

**Description:** Creates a partial disk. Uses the OpenGL Utility command gluPartialDisk.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Color( 0, 0.48, 0.72 );
shape << PartialDisk( 0.5, 1, 2, 3, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 2 );
scene << Update;


```

### [Perspective](#perspective)

**Syntax:** obj \<< Perspective( angle,z near,z far )

**Description:** Sets the perspective of the view. Uses the OpenGL Utility command gluPerspective.

**JMP Version Added:** 16

```

scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << color( 0, 0, 1 );
scene << Text( center, baseline, 0.2, "Hello, World." );


```

### [Pick](#pick)

**Syntax:** name = obj \<< Pick( x center,y center,pick width,pick height,buffer size,only return the names=0|1 )

**Description:** Returns the named object that is located under the 2D coordinates of the mouse.

**JMP Version Added:** 16

```

spheres = Scene Display List();
spheres << Point Size( 50 );
Spheres << PushName( 0 );
For( i = 0, i < 3, i++,
    spheres << LoadName( (i + 1) );
    spheres << PushMatrix;
    spheres << Translate( (i * 0.75 - .75), 0, 0 );
    spheres << color( 1, 0, 0 );
    spheres << Begin( POINTS );
    spheres << Vertex( 0, 0, -.0001 );
    spheres << End;
    spheres << color( 0, 0, 0 );
    spheres << Text( center, middle, 0.2, Char( (i + 1) ) );
    spheres << PopMatrix;
);
spheres << PopName;
view = Scene Box( 500, 400 );
view << Ortho( -1, 1, -1, 1, -2, 2 );
view << CallList( spheres );
view << update;
New Window( "Example", view );
Print( view << Pick( 50, 200, 1, 1, 4, 1 ) );


```

### [PointSize](#pointsize)

**Syntax:** obj \<< PointSize( size )

**Description:** Sets the size of a point. Uses the OpenGL command glPointSize.

**JMP Version Added:** 16

```

scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << pointsize( 1 );
scene << Begin( POINTS );
scene << color( 0, 0, 0 );
scene << Vertex( -.08, 0.04, 0 );
scene << Vertex( -.04, 0.04, 0 );
scene << Vertex( 0, 0.04, 0 );
scene << Vertex( .04, 0.04, 0 );
scene << Vertex( .08, 0.04, 0 );
scene << End();
scene << pointsize( 2 );
scene << Begin( POINTS );
scene << Vertex( -.08, -0.04, 0 );
scene << Vertex( -.04, -0.04, 0 );
scene << Vertex( 0, -0.04, 0 );
scene << Vertex( .04, -0.04, 0 );
scene << Vertex( .08, -0.04, 0 );
scene << End();


```

### [PolygonMode](#polygonmode)

**Syntax:** obj \<< PolygonMode( front|back|front_and_back,point|line|fill )

**Description:** Sets the mode used in rasterization. Uses the OpenGL command glPolygonMode.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << PolygonMode( front, line );
shape << Begin( POLYGON );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 1.5, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -1.5, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -1.5, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 1.5, 0 );
shape << End();
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Ortho( -2, 2, -2, 2, -2, 2 );
scene << ArcBall( shape, 2 );
scene << update;


```

### [PolygonOffset](#polygonoffset)

**Syntax:** obj \<< PolygonOffset( factor,units )

**Description:** Sets the offset of the polygon. Uses the OpenGL command glPolygonOffset.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Begin( POLYGON );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 1.5, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -1.5, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -1.5, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 1.5, 1 );
shape << Color( 0, 0, 0 );
shape << Vertex( 1, 1.5, 0 );
shape << End();
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Ortho( -2, 2, -2, 2, -2, 2 );
scene << Enable( Polygon_offset_fill );
scene << PolygonMode( back, point );
scene << ArcBall( shape, 2 );
scene << Disable( Polygon_offset_line );
scene << update;


```

### [PopAttrib](#popattrib)

**Syntax:** obj \<< PopAttrib

**Description:** Pops the current attributes. Uses the OpenGL command glPopAttrib.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0, 1 );
shape << PushAttrib( GL_CURRENT_BIT );
shape << Color( 0, 0, 0 );
shape << Begin( POLYGON );
shape << Vertex( -1, 0, 0 );
shape << Vertex( 1, 0, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -2, 0 );
shape << Vertex( -1, -2, 0 );
shape << End;
shape << PopAttrib;
shape << Begin( TRIANGLES );
shape << Vertex( -1, 0, 0 );
shape << Vertex( 1, 0, 0 );
shape << Color( 1, 0, 0 );
shape << Vertex( 0, 2, 0 );
shape << End();
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0, 0, -5 );
scene << ArcBall( shape, 2 );
scene << update;


```

### [PopMatrix](#popmatrix)

**Syntax:** obj \<< PopMatrix

**Description:** Pops the current matrix. Uses the OpenGL command glPopMatrix.

**JMP Version Added:** 16

```

object = Scene Display List();
object << PushMatrix;
object << Translate( 0, 0, .1 );
object << Color( 1, 0, 0 );
object << Cylinder( 1, .4, .4, 25, 5 );
object << PopMatrix;
object << PushMatrix;
object << Translate( 0, 0, -.1 );
object << Rotate( 180, 1, 0, 0 );
object << Color( 0, 1, 0 );
object << Cylinder( 1, .4, .4, 25, 5 );
object << PopMatrix;
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << Rotate( -85, 1, 0, 0 );
scene << CallList( object );
scene << Update;


```

### [PopName](#popname)

**Syntax:** obj \<< PopName

**Description:** Use with picker, pop the integer that identifies the succeeding object. Uses the OpenGL command glPopName.

**JMP Version Added:** 16

```

spheres = Scene Display List();
spheres << Point Size( 50 );
Spheres << PushName( 0 );
For( i = 0, i < 3, i++,
    spheres << LoadName( (i + 1) );
    spheres << PushMatrix;
    spheres << Translate( (i * 0.75 - .75), 0, 0 );
    spheres << color( 1, 0, 0 );
    spheres << Begin( POINTS );
    spheres << Vertex( 0, 0, -.0001 );
    spheres << End;
    spheres << color( 0, 0, 0 );
    spheres << Text( center, middle, 0.2, Char( (i + 1) ) );
    spheres << PopMatrix;
);
spheres << PopName;
view = Scene Box( 500, 400 );
view << Ortho( -1, 1, -1, 1, -2, 2 );
view << CallList( spheres );
view << update;
New Window( "Example", view );
Print( view << Pick( 50, 200, 1, 1, 4, 1 ) );


```

### [PushAttrib](#pushattrib)

**Syntax:** obj \<< PushAttrib( mask )

**Description:** Pushes the current attributes. Uses the OpenGL command glPushAttrib.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0, 0, 1 );
shape << PushAttrib( GL_CURRENT_BIT );
shape << Color( 0, 0, 0 );
shape << Begin( POLYGON );
shape << Vertex( -1, 0, 0 );
shape << Vertex( 1, 0, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -2, 0 );
shape << Vertex( -1, -2, 0 );
shape << End;
shape << PopAttrib;
shape << Begin( TRIANGLES );
shape << Vertex( -1, 0, 0 );
shape << Vertex( 1, 0, 0 );
shape << Color( 1, 0, 0 );
shape << Vertex( 0, 2, 0 );
shape << End();
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0, 0, -5 );
scene << ArcBall( shape, 2 );
scene << update;


```

### [PushMatrix](#pushmatrix)

**Syntax:** obj \<< PushMatrix

**Description:** Pushes the current matrix. Uses the OpenGL command glPushMatrix.

**JMP Version Added:** 16

```

object = Scene Display List();
object << PushMatrix;
object << Translate( 0, 0, .1 );
object << Color( 1, 0, 0 );
object << Cylinder( 1, .4, .4, 25, 5 );
object << PopMatrix;
object << PushMatrix;
object << Translate( 0, 0, -.1 );
object << Rotate( 180, 1, 0, 0 );
object << Color( 0, 1, 0 );
object << Cylinder( 1, .4, .4, 25, 5 );
object << PopMatrix;
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << Rotate( -85, 1, 0, 0 );
scene << CallList( object );
scene << Update;


```

### [PushName](#pushname)

**Syntax:** obj \<< PushName( i )

**Description:** Use with picker, push the integer that identifies the succeeding object. Uses the OpenGL command glPushName.

**JMP Version Added:** 16

```

spheres = Scene Display List();
spheres << Point Size( 50 );
Spheres << PushName( 0 );
For( i = 0, i < 3, i++,
    spheres << LoadName( (i + 1) );
    spheres << PushMatrix;
    spheres << Translate( (i * 0.75 - .75), 0, 0 );
    spheres << color( 1, 0, 0 );
    spheres << Begin( POINTS );
    spheres << Vertex( 0, 0, -.0001 );
    spheres << End;
    spheres << color( 0, 0, 0 );
    spheres << Text( center, middle, 0.2, Char( (i + 1) ) );
    spheres << PopMatrix;
);
spheres << PopName;
view = Scene Box( 500, 400 );
view << Ortho( -1, 1, -1, 1, -2, 2 );
view << CallList( spheres );
view << update;
New Window( "Example", view );
Print( view << Pick( 50, 200, 1, 1, 4, 1 ) );


```

### [QuadricDrawStyle](#quadricdrawstyle)

**Syntax:** obj \<< QuadricDrawStyle( point|line|silhouette|fill )

**Description:** Sets the type of draw style to use for quadrics. Uses the OpenGL Utility command gluQuadricDrawStyle.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << QuadricDrawStyle( LINE );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << update;


```

### [QuadricNormals](#quadricnormals)

**Syntax:** obj \<< QuadricNormals( none|flat|smooth )

**Description:** Sets the type of normals to use for quadrics. Uses the OpenGL Utility command gluQuadricNormals.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << QuadricNormals( FLAT );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << update;


```

### [QuadricOrientation](#quadricorientation)

**Syntax:** obj \<< QuadricOrientation( outside|inside )

**Description:** Sets the type of orientation to use for quadrics. Uses the OpenGL Utility command gluQuadricOrientation.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << QuadricOrientation( INSIDE );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Ambient, 0, 0, 1, 1 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << update;


```

### [QuadricTexture](#quadrictexture)

**Syntax:** obj \<< QuadricTexture

**JMP Version Added:** 16

### [Rect](#rect)

**Syntax:** obj \<< Rect( x1,y1,x2,y2 )

**Description:** Creates a rectangle. Uses the OpenGL command glRect.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Color( 0.5, 0, 0 );
shape << Rect( -0.75, -0.75, 0.5, 0.75 );
scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << Ortho2D( -1, 1, -1, 1 );
scene << CallList( shape );


```

### [Rotate](#rotate)

**Syntax:** obj \<< Rotate( angle,x,y,z )

**Description:** Multiplies the current matrix by the specified rotation angle in degrees. Uses the OpenGL command glRotate.

**JMP Version Added:** 16

```

scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << color( 0, 0, 1 );
scene << Rotate( 15, 0, 0, 1 );
scene << Text( center, baseline, 0.2, "Hello, World." );


```

### [Scale](#scale)

**Syntax:** obj \<< Scale( x,y,z )

**Description:** Multiplies the current matrix by the specified scale. Uses the OpenGL command glScale.

**JMP Version Added:** 16

```

scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << color( 0, 0, 1 );
scene << Scale( 2, 1, 1 );
scene << Text( center, baseline, 0.2, "Hello, World." );


```

### [Scissor](#scissor)

**Syntax:** obj \<< Scissor( x,y,width,height )

**Description:** Only items that appear within the scissor view will be drawn. Uses the OpenGL command glScissor.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Color( 1, 0, 0 );
shape << Rect( -0.5, -0.5, 0.5, 0.5 );
scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << Scissor( 0, 0, 100, 200 );
scene << Enable( scissor_test );
scene << CallList( shape );
scene << Disable( scissor_test );


```

### [ShadeModel](#shademodel)

**Syntax:** obj \<< ShadeModel( flat|smooth )

**Description:** Specifies the type of shading to use for the succeeding objects. Uses the OpenGL command glShadeModel.

**JMP Version Added:** 16

```

scene = Scene Box( 200, 200 );
New Window( "Example", scene );
scene << Ortho2D( -1, 1, -1, 1 );
scene << Shade Model( SMOOTH );
scene << Begin( TRIANGLES );
scene << color( 1, 0, 0 );
scene << Vertex( -1, -1, 0 );
scene << Color( 0, 1, 0 );
scene << Vertex( 0, 1, 0 );
scene << Color( 0, 0, 1 );
scene << Vertex( 1, -1, 0 );
scene << End();
scene << Update;


```

### [Show ArcBall](#show-arcball)

**Syntax:** obj \<< Show ArcBall( "During Drag"|"Always"|"Never" )

**Description:** Sets the display state of the ArcBall.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << color( 0, 0, 1 );
shape << Text( center, baseline, 0.2, "Hello, World." );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 1 );
scene << Show ArcBall( always );
scene << Update;


```

### [SortList](#sortlist)

**Syntax:** obj \<< SortList

**JMP Version Added:** 16

### [Sphere](#sphere)

**Syntax:** obj \<< Sphere( radius,slices,stacks )

**Description:** Creates a sphere. Uses the OpenGL Utility command gluSphere.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;


```

### [Suppress Context Menu](#suppress-context-menu)

**Syntax:** obj \<< Suppress Context Menu( state=0|1 )

**Description:** Stops the Scene Box context menu from appearing.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << color( 0, 0, 1 );
shape << Text( center, baseline, 0.2, "Hello, World." );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << ArcBall( shape, 1 );
scene << Update;
scene << Suppress Context Menu( 1 );


```

### [Text](#text)

**Syntax:** obj \<< Text( left|center|right,top|middle|baseline|bottom,size,"string" )

**Description:** Creates text that can be shown in a SceneBox.

**JMP Version Added:** 16

```

scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( 0.0, 0.0, -4.5 );
scene << color( 0, 0, 1 );
scene << Text( center, baseline, 0.2, "Hello, World." );


```

### [Translate](#translate)

**Syntax:** obj \<< Translate( x,y,z )

**Description:** Multiplies the current matrix by the specified translation. Uses the OpenGL command glTranslate.

**JMP Version Added:** 16

```

scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << Perspective( 45, 3, 7 );
scene << Translate( -0.9, 1.5, -4.5 );
scene << color( 0, 0, 1 );
scene << Text( center, baseline, 0.2, "Hello, World." );


```

### [Update](#update)

**Syntax:** obj \<< Update

**Description:** Renders the scene.

**JMP Version Added:** 16

```

scene = Scene Box( 500, 500 );
fps = Scene Display List();
window = New Window( "Frames Per Second", scene );
lastTime = 0;
frameCount = 0;
framesPerSecond = "Frames Per Second: ";
While( 1,
    time = Today();
    frameCount++;
    If( time != lastTime,
        framesPerSecond = Char( frameCount );
        frameCount = 0;
        lastTime = time;
    );
    fps << Clear;
    fps << Translate( -1, 0, 0 );
    fps << Color( 1, 0, 0 );
    fps << Text( left, baseline, .1, "Frames Per Second: " || framesPerSecond );
    scene << Clear;
    scene << CallList( fps );
    scene << Update;
    Wait( 0 );
);


```

### [Use Hardware Acceleration](#use-hardware-acceleration)

**Syntax:** obj \<< Use Hardware Acceleration( state=0|1 )

**Description:** Hardware Acceleration might make the display faster. If it looks bad, new graphics drivers (from the hardware vendor) might be needed.

**JMP Version Added:** 16

```

scene = Scene Box( 500, 500 );
fps = Scene Display List();
window = New Window( "Frames Per Second",
    scene,
    accelButton = Button Box( "Turn Hardware Acceleration On", toggleHardwareAccel() )
);
hardwareAccel = 0;
lastTime = 0;
frameCount = 0;
framesPerSecond = "Frames Per Second: ";
toggleHardwareAccel = Function( {},
    hardwareAccel = !hardwareAccel;
    scene << Use Hardware Acceleration( hardwareAccel );
    If( hardwareAccel,
        accelButton << Set Button Name( "Turn Hardware Acceleration Off" ),
        accelButton << Set Button Name( "Turn Hardware Acceleration On" )
    );
);
While( 1,
    time = Today();
    frameCount++;
    If( time != lastTime,
        framesPerSecond = Char( frameCount );
        frameCount = 0;
        lastTime = time;
    );
    fps << Clear;
    fps << Translate( -1, 0, 0 );
    fps << Color( 1, 0, 0 );
    fps << Text( left, baseline, .1, "Frames Per Second: " || framesPerSecond );
    scene << Clear;
    scene << CallList( fps );
    scene << Update;
    Wait( 0 );
);


```

### [Vertex](#vertex)

**Syntax:** obj \<< Vertex( x,y,z )

**Description:** Specifies the vertex of a primitive.

**JMP Version Added:** 16

```

shape = Scene Display List();
shape << Begin( POLYGON );
shape << Color( 1, 0, 0 );
shape << Vertex( -1, 0.75, 0 );
shape << Color( 0, 0, 1 );
shape << Vertex( -1, -0.75, 0 );
shape << Color( 0, 1, 0 );
shape << Vertex( 1, -0.75, 0 );
shape << Color( 1, 1, 0 );
shape << Vertex( 1, 0.75, 0 );
shape << End();
scene = Scene Box( 200, 200 );
scene << CallList( shape );
New Window( "Example", scene );


```

### [Width](#width)

**Syntax:** obj \<< Width( pixels )

**Description:** Sets the width of the box.

**JMP Version Added:** 16

```

shape = Scene Display List( 0 );
shape << Enable( COLOR_MATERIAL );
shape << Color( 0, 0.48, 0.72 );
shape << Material( Front, Diffuse, 0, 1, 1, 1 );
shape << Material( Front, Specular, 0, 1, 0, 1 );
shape << Material( Front, Emission, 0, 0, 0, 1 );
shape << Material( Front, Shininess, 100 );
shape << Sphere( 1.5, 50, 50 );
shape << Disable( COLOR_MATERIAL );
scene = Scene Box( 400, 400 );
New Window( "Example", scene );
scene << clear;
scene << Perspective( 45, 1, 10 );
scene << Translate( 0.0, 0.0, -5 );
scene << Enable( Lighting );
scene << Enable( Light0 );
scene << Light( Light0, Position, 1, 1, 1, 0 );
scene << ArcBall( shape, 3 );
scene << Disable( Light0 );
scene << Disable( Lighting );
scene << update;
scene << Width( 150 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_2)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ScriptBox](#scriptbox)

## [Associated Constructors](#associated-constructors)

### [Script Box](#script-box)

**Syntax:** y = Script Box( <s>, \<"C" | "JavaScript" | "JSL" | "JSON" | "Python" | "R" | "SAS" | "SQL" | "Text" | "XML">, <width>, <height> )

**Description:** Returns a display box that contains an editable scripting box.

#### [JSL](#jsl)

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );


```

#### [Python script](#python-script)

```

pyscript = "\[import numpy as np
a = np.arange(15).reshape(3, 5)]\";
sb = Script Box( pyscript, "Python", 300, 100 );
New Window( "This is a python script box", sb );


```

## [Item Messages](#item-messages)

### [Append Text](#append-text)

**Syntax:** obj \<< Append Text( text )

**Description:** Add the given text to the end of the script.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Append Text( "print(\!" World\!");" );


```

### [Collapse All](#collapse-all)

**Syntax:** obj \<< Collapse All

**Description:** Collapses all foldable sections of the contents of the Script Box.

```

New Window( "Example",
    sb = Script Box(
        "
        f = Function (

        );

        If ( 1,
            Print(\!"Collapsible Block\!");
        );
    "
    )
);
sb << Collapse All;


```

### [Expand All](#expand-all)

**Syntax:** obj \<< Expand All

**Description:** Expands all collapsed sections of the contents of the Script Box.

```

New Window( "Example",
    sb = Script Box(
        "
        f = Function (

        );

        If ( 1,
            Print(\!"Collapsible Block\!");
        );
    "
    )
);
sb << Collapse All;
sb << Expand All;


```

### [Get Cursor Line](#get-cursor-line)

**Syntax:** obj \<< Get Cursor Line

**Description:** Returns the line the cursor is currently in.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Get Cursor Line;


```

### [Get Cursor Position](#get-cursor-position)

**Syntax:** obj \<< Get Cursor Position

**Description:** Returns the current position of the cursor.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Get Cursor Position;


```

### [Get Line Count](#get-line-count)

**Syntax:** obj \<< Get Line Count

**Description:** Returns the line count of the Script Box.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
Print( sb << Get Line Count );


```

### [Get Line Text](#get-line-text)

**Syntax:** obj \<< Get Line Text( line number )

**Description:** Returns the text at the given line number.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
Print( sb << Get Line Text( 1 ) );


```

### [Get Lines](#get-lines)

**Syntax:** obj \<< Get Lines

**Description:** Returns all the text in the script window as a list of strings, one line per string.

```

New Window( "Example",
    sb = Script Box(
        "print(\!"Hello World\!");print(\!"Hello World\!");print(\!"Hello World\!");print(\!"Hello World\!");"
    )
);
sb << Reformat;
Print( sb << Get Lines );


```

### [Get Selection Width](#get-selection-width)

**Syntax:** obj \<< Get Selection Width

**Description:** Returns the current width of the selection.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Get Selection Width;


```

### [Get Show Empty Scrollbars](#get-show-empty-scrollbars)

**Syntax:** obj \<< Get Show Empty Scrollbars( state=0|1 )

**Description:** Returns a Boolean value that indicates whether the horizontal and vertical scrollbars are shown even if they are unnecessary

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Get Show Empty Scrollbars();


```

### [Get Show Scrollbars](#get-show-scrollbars)

**Syntax:** obj \<< Get Show Scrollbars

**Description:** Returns a two element list indicating whether the horizontal and vertical scrollbars are shown

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Get Show Scrollbars();


```

### [Read Only](#read-only)

**Syntax:** obj \<< Read Only( state=0|1 )

**Description:** If true (1), the text within the Script Box cannot be modified.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Read Only( 1 );
sb << Append Text( "print(\!" World\!");" );


```

### [Reformat](#reformat)

**Syntax:** obj \<< Reformat

**Description:** Formats the script to make it easier to read.

```

New Window( "Example",
    sb = Script Box(
        "print(\!"Hello World\!");print(\!"Hello World\!");print(\!"Hello World\!");print(\!"Hello World\!");"
    )
);
sb << Reformat;


```

### [Run](#run)

**Syntax:** obj \<< Run

**Description:** Evaluates the script.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Run;


```

### [Set Cursor Position](#set-cursor-position)

**Syntax:** obj \<< Set Cursor Position( position )

**Description:** Sets the cursor position to the provided position.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Set Cursor Position( 5 );


```

### [Set Line Text](#set-line-text)

**Syntax:** obj \<< Set Line Text( line number, text )

**Description:** Sets the text at the given line number.

```

New Window( "Example",
    sb = Script Box(
        "print(\!"Hello World\!");print(\!"Hello World\!");print(\!"Hello World\!");print(\!"Hello World\!");"
    )
);
sb << Reformat;
sb << Set Line Text( 2, "print(\!"Goodbye\!");" );


```

### [Set Selection Width](#set-selection-width)

**Syntax:** obj \<< Set Selection Width( width )

**Description:** Sets the width of the selection to the provided width.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Set Selection Width( 10 );


```

### [Set Show Empty Scrollbars](#set-show-empty-scrollbars)

**Syntax:** obj \<< Set Show Empty Scrollbars( state=0|1 )

**Description:** If true (1), then the horizontal or vertical scrollbars are shown even if they are unnecessary

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Set Show Empty Scrollbars( 1 );


```

### [Set Show Scrollbars](#set-show-scrollbars)

**Syntax:** obj \<< Set Show Scrollbars( state=0|1 )

**Description:** Specifies whether the horizontal and vertical scrollbars are shown

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Set Show Scrollbars( 0, 0 );


```

### [Set Text](#set-text)

**Syntax:** obj \<< Set Text( text )

**Description:** Replaces the current text in the Script Box to the given text.

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << Set Text( "print(\!"Hello World\!");" );


```

### [Show Embedded Log](#show-embedded-log)

**Syntax:** obj \<< Show Embedded Log( state=0|1 )

**Description:** Enable/disable the embedded log.

```

script = Open( "$SAMPLE_SCRIPTS/Prime Numbers.jsl" );
sb = Get Window( "Prime Numbers" )[Script Box( 1 )];
sb << Show Embedded Log( 1 );


```

### [Show Line Numbers](#show-line-numbers)

**Syntax:** obj \<< Show Line Numbers( state=0|1 )

**Description:** Shows and hides the line numbers on the left side of the script box

**JMP Version Added:** 15

```

sb = Script Box( "print(\!" Hello\!");", 300, 100 );
New Window( "This is a script box", sb );
sb << show line numbers( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ScriptContainerBox](#scriptcontainerbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ScriptableContainerBox](#scriptablecontainerbox)

## [Item Messages](#item-messages)

### [Get Scriptable Object](#get-scriptable-object)

**Syntax:** scriptable object = obj \<< Get Scriptable Object

**Description:** Returns a reference to the scriptable object associated with the container.

```

dt = Open( "$Sample_Data/Diabetes.jmp" );
obj = Model Screening(
    Y( :Y ),
    Validation( :Validation ),
    X( :Age, :Gender, :BMI, :BP, :Total Cholesterol, :LDL, :HDL, :TCH, :LTG, :Glucose )
);
(Report( obj ) << XPath( "//PlatformContainerBox" )) << Get Scriptable Object;


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ScrollBox](#scrollbox)

## [Associated Constructors](#associated-constructors)

### [H Scroll Box](#h-scroll-box)

**Syntax:** y = H Scroll Box( \<Size( x )>, displayBox )

**Description:** Returns a display box that places a scroll bar on the bottom and right if the contents are bigger than the size of the ScrollBox.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );


```

### [Scroll Box](#scroll-box)

**Syntax:** y = Scroll Box( \<Size( x, y )>, displayBox )

**Description:** Returns a display box that places a scroll bar on the bottom and right if the contents are bigger than the size of the ScrollBox.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = Scroll Box(
                dt << Fit Model(
                    Y( :height ),
                    Effects( :age, :sex ),
                    Personality( "Standard Least Squares" ),
                    Emphasis( "Effect Leverage" ),
                    Run(
                        :height << {Summary of Fit( 1 ), Analysis of Variance( 1 ),
                        Parameter Estimates( 1 ), Scaled Estimates( 0 ),
                        Plot Actual by Predicted( 1 ), Plot Regression( 0 ),
                        Plot Residual by Predicted( 1 ), Plot Studentized Residuals( 0 ),
                        Plot Effect Leverage( 1 ), Plot Residual by Normal Quantiles( 0 ),
                        Box Cox Y Transformation( 0 )}
                    )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );


```

### [V Scroll Box](#v-scroll-box)

**Syntax:** y = V Scroll Box( \<Size( y )>, displayBox )

**Description:** Returns a display box that places a scroll bar on the bottom and right if the contents are bigger than the size of the ScrollBox.

```

dt = Open( "$SAMPLE_DATA/PopAgeGroup.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = V Scroll Box(
                dt << Bubble Plot(
                    X( :"Portion 0-19"n ),
                    Y( :"Portion60+"n ),
                    Sizes( :Pop ),
                    ID( :Country ),
                    By( :Region )
                )
            )
        )
    )
);
win << Set Window Size( 1100, 700 );


```

## [Item Messages](#item-messages)

### [Get Auto Scrollable](#get-auto-scrollable)

**Syntax:** obj \<< Get Auto Scrollable

**Description:** Returns the Auto Scrollable setting.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Auto Scrollable( 1 );
sb << Get Auto Scrollable();


```

### [Get Clip Printing](#get-clip-printing)

**Syntax:** obj \<< Get Clip Printing( state=0|1 )

**Description:** Returns the current setting for clipping the scroll box content when printing.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Print Me!",
    s = Scroll Box(
        V List Box(
            Overlay Plot( X( :weight ), Y( :height ), By( :age ) ),
            Overlay Plot( X( :weight ), Y( :height ), By( :Sex ) )
        )
    )
);
Show( s << Get Clip Printing );


```

### [Get Color](#get-color)

**Syntax:** color = obj \<< Get Color

**Description:** Returns the background color.

### [Get Height](#get-height)

**Syntax:** pixels = obj \<< Get Height

**Description:** Returns the height of the scroll area.

### [Get Scroll Extents](#get-scroll-extents)

**Syntax:** {h pixels,v pixels} = obj \<< Get Scroll Extents

**Description:** Returns the maximum positions for horizontal and vertical scrolling.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Get Scroll Extents();


```

### [Get Scroll Position](#get-scroll-position)

**Syntax:** {h,v} = obj \<< Get Scroll Position

**Description:** Returns the current horizontal and vertical scroll positions.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Scroll Position( 0, 20 );
sb << Get Scroll Position();


```

### [Get Scrollers](#get-scrollers)

**Syntax:** {h,v} = obj \<< Get Scrollers

**Description:** Returns the flags for horizontal and vertical scrolling. If scrolling is disabled in a given direction, the Scroll Box will behave as a regular container in that direction.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Scrollers( 0, 1 );
sb << Get Scrollers();


```

### [Get Show Empty](#get-show-empty)

**Syntax:** obj \<< Get Show Empty

**Description:** Returns the current setting for showing scroll bars when they are empty.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Show Empty( 0 );
sb << Get Show Empty();


```

### [Get Width](#get-width)

**Syntax:** pixels = obj \<< Get Width

**Description:** Returns the width of the scroll area.

### [Height](#height)

**Syntax:** obj \<< Height( pixels )

**Description:** Sets the height of the scroll area.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Height( 200 );


```

### [Set Auto Scrollable](#set-auto-scrollable)

**Syntax:** obj \<< Set Auto Scrollable( state=0|1 )

**Description:** Automatically set scrolling parameters based on stretching properties of the child box. The scroll bar in each direction will be active if the box is not stretchable in that direction.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Auto Scrollable( 1 );


```

### [Set Background Color](#set-background-color)

**Syntax:** obj \<< Set Background Color( color )

**Description:** Sets the background of the Scroll Box to the given color.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Background Color( "Red" );


```

### [Set Clip Printing](#set-clip-printing)

**Syntax:** obj \<< Set Clip Printing( state=0|1 )

**Description:** The scroll box content is clipped to the scroll box size when printed, or the entire content is displayed. Clipping is off by default.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Print Me!",
    Scroll Box(
        V List Box(
            Overlay Plot( X( :weight ), Y( :height ), By( :age ) ),
            Overlay Plot( X( :weight ), Y( :height ), By( :Sex ) )
        ),
        <<Set Clip Printing( 1 )
    )
);


```

### [Set Scroll Position](#set-scroll-position)

**Syntax:** obj \<< Set Scroll Position( h,v )

**Description:** Sets the horizontal and vertical scroll positions. Values can be given in pixels, or using the keywords "Start" and "End".

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = Scroll Box(
                dt << Fit Model(
                    Y( :height ),
                    Effects( :age, :sex ),
                    Personality( "Standard Least Squares" ),
                    Emphasis( "Effect Leverage" ),
                    Run(
                        :height << {Summary of Fit( 1 ), Analysis of Variance( 1 ),
                        Parameter Estimates( 1 ), Scaled Estimates( 0 ),
                        Plot Actual by Predicted( 1 ), Plot Regression( 0 ),
                        Plot Residual by Predicted( 1 ), Plot Studentized Residuals( 0 ),
                        Plot Effect Leverage( 1 ), Plot Residual by Normal Quantiles( 0 ),
                        Box Cox Y Transformation( 0 )}
                    )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
Wait( 1 );
// scroll to given position
sb << Set Scroll Position( 0, 200 );
Wait( 1 );
// scroll to lower-right corner
sb << Set Scroll Position( "End", "End" );
Wait( 1 );
// scroll to upper-left corner
sb << Set Scroll Position( "Start", "Start" );


```

### [Set Scrollers](#set-scrollers)

**Syntax:** obj \<< Set Scrollers( h,v )

**Description:** Sets the flags for horizontal and vertical scrolling. If scrolling is disabled in a given direction, the Scroll Box will behave as a regular container in that direction.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Scrollers( 0, 1 );


```

### [Set Show Empty](#set-show-empty)

**Syntax:** obj \<< Set Show Empty( state=0|1 )

**Description:** Show the scroll bars even if they are empty.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Set Show Empty( 0 );


```

### [Width](#width)

**Syntax:** obj \<< Width( pixels )

**Description:** Sets the width of the scroll area.

```

dt = Open( "$SAMPLE_DATA/Car Poll.jmp" );
win = New Window( "Report window",
    Outline Box( "Report",
        H List Box(
            dt << New Data Box,
            sb = H Scroll Box(
                dt << Categorical(
                    X( :sex, :marital status ),
                    Responses( :country ),
                    Responses( :size ),
                    Responses( :type ),
                    Legend( 0 ),
                    Arrange in Rows( 3 )
                )
            )
        )
    )
);
win << Set Window Size( 1000, 700 );
sb << Width( 200 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ShapeBorderBox](#shapeborderbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [ShapeSeg](#shapeseg)

## [Associated Constructors](#associated-constructors)

### [Shape Seg](#shape-seg)

**Syntax:** ss = Shape Seg( {Path(<path>), ...}, < Row States( dt | dt,[rows] | dt,{{rows}, ...} | {states} ) > )

**Description:** Returns a display seg with a collection of shapes. Each shape draws a stroke along the given path if fill is 0, or paints the interior of the given path if fill is not 0. The path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**Example 1**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));


```

**Example 2**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )},
            Row States( {Selected State( 1 ), Color State( "red" )} )
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color](#color)

**Syntax:** obj \<< Color( color )

**Description:** Sets the color for all shapes.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Color( "Green" );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Density Gradient( "Fade to Gray" );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

**Description:** Sets the fill color for all shapes.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Fill Color( "Green" );


```

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Frame;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Color](#get-color)

**Syntax:** color = obj \<< Get Color

**Description:** Returns the shape color.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Color;


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << get description();


```

### [Get Fill Color](#get-fill-color)

**Syntax:** obj \<< Get Fill Color

**Description:** Returns the fill color of the shapes.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Fill Color;


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Fill Pattern;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Gradient Transparency;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Line Width;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 and 1.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Get Transparency;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Gradient Transparency( "None" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Parent;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

**Description:** Changes the seg back to its original state.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
Wait( 1 );
seg << Set Color( "Red" );
Wait( 1 );
seg << Revert;


```

### [Set Color](#set-color)

**Syntax:** obj \<< Set Color( color )

**Description:** Sets the color for all shapes.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Color( "Green" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << set description( "my seg" );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

**Description:** Sets the fill color for all shapes.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Fill Color( "Blue" );
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Label Offset](#set-label-offset)

**Syntax:** obj \<< Set Label Offset {Index, Longitude, Latitude}, ...

**Description:** Positions row labels according to the given coordinates.

**JMP Version Added:** 16

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Line Width( 3 );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Transparency( .3 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

```

New Window( "Shape Seg Example",
    g = Graph Box(
        Shape Seg(
            {Path( [10 10 1, 10 70 0, 70 70 0, 70 10 -3] ),
            Path( "M20,20 C20,60 60,60 60,20 Z" )}
        )
    )
);
frame = g[Frame Box( 1 )];
seg = (frame << Find Seg( Shape Seg( 1 ) ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [SheetBox](#sheetbox)

## [Associated Constructors](#associated-constructors)

### [H Sheet Box](#h-sheet-box)

**Syntax:** y = H Sheet Box( \<<Hold( rpt ), displayBox, ... )

**Description:** Returns a display box that can organize other display boxes horizontally or vertically.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [V Sheet Box](#v-sheet-box)

**Syntax:** y = V Sheet Box( \<<Hold( rpt ), displayBox, ... )

**Description:** Returns a display box that can organize other display boxes horizontally or vertically.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Hold](#hold)

**Syntax:** obj \<< Hold( element )

**Description:** Specifies what element the SheetBox should hold.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [Size](#size)

**Syntax:** obj \<< Size( size )

**Description:** Sets the width if the SheetBox is horizontal, otherwise it sets the height.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            <<Size( 0.33 ),
            Sheet Part( "", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

### [Sizes](#sizes)

**Syntax:** obj \<< Sizes( {width,height} )

**Description:** Sets the width and height of the SheetBox.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        <<Hold( Treemap( Categories( :age ) ) ),
        <<Hold(
            Bubble Plot(
                X( :height ),
                Y( :weight ),
                Sizes( :age ),
                Coloring( :sex ),
                Circle Size( 6.226 ),
                All Labels( 0 )
            )
        ),
        <<Sizes( {0.35, 0.65} ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        ),
        H Sheet Box(
            Sheet Part( "", Excerpt Box( 3, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 4, {Picture Box( 1 )} ) )
        )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [SheetPanelBox](#sheetpanelbox)

## [Associated Constructors](#associated-constructors)

### [Sheet Part](#sheet-part)

**Syntax:** y = Sheet Part( title, childbox )

**Description:** A sheet part specifies if the SheetBox should be horizontal or vertical.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        H Sheet Box(
            sp = Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Get Title](#get-title)

**Syntax:** obj \<< Get Title( "string" )

**Description:** Returns the title of the Tab Page Box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        H Sheet Box(
            sp = Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        )
    )
);
sp << Title( "Fit Line" );
sp << Get Title();


```

### [Title](#title)

**Syntax:** obj \<< Title( "string" )

**Description:** Sets the title of the Sheet Part.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    V Sheet Box(
        <<Hold( Bivariate( Y( :weight ), X( :height ), FitLine() ) ),
        <<Hold(
            Distribution(
                Continuous Distribution(
                    Column( :height ),
                    Horizontal Layout( 1 ),
                    Outlier Box Plot( 0 )
                )
            )
        ),
        H Sheet Box(
            sp = Sheet Part( "", Excerpt Box( 1, {Picture Box( 1 )} ) ),
            Sheet Part( "", Excerpt Box( 2, {Picture Box( 1 )} ) )
        )
    )
);
Wait( 1 );
sp << title( "Fit Line" );
sp << inval();


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [SliderBox](#sliderbox)

## [Associated Constructors](#associated-constructors)

### [Slider Box](#slider-box)

**Syntax:** box = Slider Box(minValue, maxValue, variable, script, \<set width(n)>, \<rescale slider(minValue, maxValue)>)

**Description:** Returns a display box that shows a slider control that ranges from minValue to maxValue. As the slider's position changes, its value is placed into variable and the script is run.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get](#get)

**Syntax:** float = obj \<< Get( <index> )

**Description:** Returns the floating-point value the slider is currently set to.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Get() );


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Log Scale](#get-log-scale)

**Syntax:** bool = obj \<< Get Log Scale

**Description:** Returns if the slider is in a log scale (1) or linear scale (0)

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
sb << Rescale Slider( 1, 100 );
sb << Set Log Scale( 1 );
Print( sb << Get Log Scale );


```

### [Get Max](#get-max)

**Syntax:** float = obj \<< Get Max( <index> )

**Description:** Returns the maximum value the slider can be set to.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Get Max );


```

### [Get Min](#get-min)

**Syntax:** float = obj \<< Get Min( <index> )

**Description:** Returns the minimum value the slider can be set to.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Get Min );


```

### [Get N](#get-n)

**Syntax:** float = obj \<< Get N

**Description:** Returns the number of sliders that are in the SliderBox.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Get N );


```

### [Get Var](#get-var)

**Syntax:** string = obj \<< Get Var

**Description:** Returns the variable name associated with the slider.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Get Var );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Gets the width of the slider.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
sb << Get Width();


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Rescale Slider](#rescale-slider)

**Syntax:** obj \<< Rescale Slider( min,max )

**Description:** Sets the minimum and maximum values the slider should accept

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
sb << Rescale Slider( .2, .8 );


```

### [Set](#set)

**Syntax:** obj \<< Set( float, <index>,\<run script(0|1)> )

**Description:** Sets the floating point value of the slider.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
sb << Set( 0.4 );
tb << Set Text( "Value: " || Char( sliderValue ) );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, index}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when the slider changes.

**JMP Version Added:** 14

```

sliderValue = .5;
New Window( "Example",
    Panel Box( "Slider",
        sb = Slider Box( 0, 1, sliderValue ),
        Lineup Box( N Col( 2 ), Text Box( "Slider Value: " ), Text Box( sliderValue ) )
    )
);
sb << Set Function(
    Function( {thisBox},
        ((((thisBox) << sib) << child) << sib) << Set Text( Char( thisBox << Get ) )
    )
);


```

### [Set Log Scale](#set-log-scale)

**Syntax:** obj \<< Set Log Scale( 0|1 )

**Description:** Sets the slider to a log scale (1) or linear scale (0)

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
sb << Rescale Slider( 1, 100 );
sb << Set Log Scale( 1 );
Print( sb << Get Log Scale );


```

### [Set Max](#set-max)

**Syntax:** obj \<< Set Max( float, <index> )

**Description:** Set the maximum value the slider can be set to.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Set Max( 2.0 ) );


```

### [Set Min](#set-min)

**Syntax:** obj \<< Set Min( float, <index> )

**Description:** Set the minimum value the slider can be set to.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Set Min( -1.0 ) );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

### [Set Var](#set-var)

**Syntax:** string = obj \<< Set Var

**Description:** Sets the variable name associated with the slider.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
Print( sb << Set Var( mySliderVar ) );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the slider.

```

sliderValue = .6;
New Window( "Example",
    Panel Box( "Slider Box",
        tb = Text Box( "Value: " || Char( sliderValue ) ),
        sb = Slider Box(
            0,
            1,
            sliderValue,
            tb << Set Text( "Value: " || Char( sliderValue ) )
        )
    )
);
sb << Set Width( 300 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [SpacerBox](#spacerbox)

## [Associated Constructors](#associated-constructors)

### [Spacer Box](#spacer-box)

**Syntax:** y = Spacer Box( \<Size( x, y )>, \<Color( c )>)

**Description:** Returns a display box which can be given an arbitrary size and color.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);


```

## [Item Messages](#item-messages)

### [Color](#color)

**Syntax:** obj \<< Color( color )

**Description:** Sets the spacer's color to the given color

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb2 << color( "blue" );


```

### [Get Color](#get-color)

**Syntax:** color = obj \<< Get Color

**Description:** Returns the color of the spacer.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb2 << Get Color();


```

### [Get Fill](#get-fill)

**Syntax:** boolean = obj \<< Get Fill

**Description:** Returns whether the background is painted or not.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb2 << Get Fill();


```

### [Get Height](#get-height)

**Syntax:** pixels = obj \<< Get Height

**Description:** Returns the height of the spacer.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb2 << Get Height();


```

### [Get Transparency](#get-transparency)

**Syntax:** alpha = obj \<< Get Transparency

**Description:** Returns the transparency value, 0..1.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb2 << Get Transparency();


```

### [Get Width](#get-width)

**Syntax:** pixels = obj \<< Get Width

**Description:** Returns the width of the spacer.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb2 << Get Width();


```

### [Height](#height)

**Syntax:** obj \<< Height( pixels )

**Description:** Sets the height of the spacer.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb1 << height( 150 );


```

### [Set Fill](#set-fill)

**Syntax:** obj \<< Set Fill( state=0|1 )

**Description:** Sets whether the background is painted or not.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
/*make the red spacer flash by setting the fill status to the opposite value several times*/
For( i = 1, i <= 14, i++,
    sb2 << Set Fill( !(sb2 << Get Fill()) );
    Wait( .2 );
);


```

### [Size](#size)

**Syntax:** obj \<< Size( width, height,\<min width, min height>,\<max width, max height> )

**Description:** Sets the width and height of the spacer.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb1 << size( 150, 150 );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( alpha )

**Description:** Sets the transparency value, 0..1.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb2 << Transparency( 0.5 );


```

### [Width](#width)

**Syntax:** obj \<< Width( pixels )

**Description:** Sets the width of the spacer.

```

New Window( "Example",
    H List Box(
        Text Box( "A" ),
        sb1 = Spacer Box(),
        Text Box( "B" ),
        sb2 = Spacer Box( size( 20, 10 ), color( "red" ) ),
        Text Box( "C" )
    )
);
sb1 << width( 150 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [SpinBox](#spinbox)

## [Associated Constructors](#associated-constructors)

### [Spin Box](#spin-box)

**Syntax:** y = Spin Box( <script> )

**Description:** Returns a display box to show a button with up and down controls. The script argument is invoked with an argument indicating the direction of the arrow clicked (negative is down, positive is up). A magnitude of 1 indicates a single click. Larger values might be used to indicate a repeating action.

```

New Window( "Example",
    Lineup Box(
        2,
        nb = Number Edit Box( 3 ),
        sb = Spin Box( Function( {value}, nb << Increment( value ) ) )
    )
);
nb << Set Increment( 1 );


```

## [Item Messages](#item-messages)

### [Click](#click)

**Syntax:** obj \<< Click( <value> )

**Description:** Simulates a click on the button, running any attached script.

```

New Window( "Example",
    Lineup Box(
        2,
        nb = Number Edit Box( 3 ),
        sb = Spin Box( Function( {value}, nb << Increment( value ) ) )
    )
);
nb << Set Increment( 1 );
Wait( 2 );
sb << Click( 1 );


```

### [Decrement](#decrement)

**Syntax:** obj \<< Decrement( <value> )

**Description:** Simulates a click on the down arrow, running any attached script.

```

New Window( "Example",
    Lineup Box(
        2,
        nb = Number Edit Box( 3 ),
        sb = Spin Box( Function( {value}, nb << Increment( value ) ) )
    )
);
nb << Set Increment( 1 );
Wait( 2 );
sb << Decrement;


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Increment](#increment)

**Syntax:** obj \<< Increment( <value> )

**Description:** Simulates a click on the up arrow, running any attached script.

```

New Window( "Example",
    Lineup Box(
        2,
        nb = Number Edit Box( 3 ),
        sb = Spin Box( Function( {value}, nb << Increment( value ) ) )
    )
);
nb << Set Increment( 1 );
Wait( 2 );
sb << Increment;


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, increment}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when the spin box's buttons are pressed. [increment] is the increment set for the number box.

**JMP Version Added:** 14

```

New Window( "Example", Lineup Box( 2, nb = Number Edit Box( 0 ), sb = Spin Box() ) );
nb << Set Increment( 5 );
sb << Set Function(
    Function( {thisBox, increment},
        ((thisBox << parent) << child) << increment( increment )
    )
);


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [SplitterBox](#splitterbox)

## [Associated Constructors](#associated-constructors)

### [H Splitter Box](#h-splitter-box)

**Syntax:** y = H Splitter Box( \<Size(x,y)>, displayBox, ... )

**Description:** Returns a display box that can organize other display boxes horizontally or vertically, with interactive control of sizes. Child sizes are specified as a proportion of the width or height of the Splitter Box. The optional Size argument is only used for the top-most Splitter Box; lower level boxes are sized like any other child box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);


```

### [V Splitter Box](#v-splitter-box)

**Syntax:** y = V Splitter Box( \<Size(x,y)>, displayBox, ... )

**Description:** Returns a display box that can organize other display boxes horizontally or vertically, with interactive control of sizes. Child sizes are specified as a proportion of the width or height of the Splitter Box. The optional Size argument is only used for the top-most Splitter Box; lower level boxes are sized like any other child box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);


```

## [Item Messages](#item-messages)

### [Close Panel](#close-panel)

**Syntax:** obj \<< Close Panel( index,<previous> )

**Description:** Close the panel at the given index. If the previous argument is 1 the space will be allocated to the previous box in the list, otherwise it will be allocated to the next box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
Wait( 2 );
box << Close Panel( 2, 1 );


```

### [Divider Color](#divider-color)

**Syntax:** obj \<< Divider Color( color ); color = obj \<< Get Divider Color

**Description:** Specifies or returns the color for each split divider. If unset, a color based on the background color is used.

**JMP Version Added:** 19

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Divider Color( "Red" );
Show( box << Get Divider Color );


```

### [Divider Length](#divider-length)

**Syntax:** obj \<< Divider Length( number ); number = obj \<< Get Divider Length

**Description:** Specifies or returns the length as a percentage for each split divider. A value of 0.0 results in an invisible divider. A value of 1.0 results in the (default) full length divider line.

**JMP Version Added:** 19

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Divider Length( 0.8 );
Show( box << Get Divider Length );


```

### [Divider Thickness](#divider-thickness)

**Syntax:** obj \<< Divider Thickness( number ); number = obj \<< Get Divider Thickness

**Description:** Specifies or returns the line thickness for each split divider. This value must be non-zero.

**JMP Version Added:** 19

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Divider Thickness( 10 );
Show( box << Get Divider Thickness );


```

### [DockName](#dockname)

**Syntax:** obj \<< DockName( text )

### [Dockable](#dockable)

**Syntax:** obj \<< Dockable( bool )

**Description:** If a container is dockable, children that are moveable can be rearranged using drag-and-drop.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    H Splitter Box(
        Size( 800, 600 ),
        Tab Page Box( "Data Table", dt << New Data Box, <<Moveable( 1 ) ),
        V Splitter Box(
            Tab Page Box(
                "Logistic",
                log = Logistic(
                    Y( :age ),
                    X( :weight ),
                    SendToReport(
                        Dispatch( {}, "Whole Model Test", OutlineBox, {Close( 1 )} ),
                        Dispatch( {}, "Parameter Estimates", OutlineBox, {Close( 1 )} )
                    )
                ),
                <<Moveable( 1 )
            ),
            Tab Page Box(
                "Bivariate",
                biv = Bivariate(
                    Y( :weight ),
                    X( :height ),
                    Fit Line( {Line Color( {213, 72, 87} )} ),
                    SendToReport( Dispatch( {}, "Linear Fit", OutlineBox, {Close( 1 )} ) )
                ),
                <<Moveable( 1 )
            ),
            <<Dockable( 1 )
        ),
        <<Dockable( 1 )
    )
);
(log << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );
(biv << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    H Splitter Box(
        Size( 800, 600 ),
        Tab Page Box( "Data Table", dt << New Data Box, <<Moveable( 1 ) ),
        Tab Box(
            Tab Page Box(
                "Logistic",
                Moveable( 1 ),
                log = Logistic(
                    Y( :age ),
                    X( :weight ),
                    SendToReport(
                        Dispatch( {}, "Whole Model Test", OutlineBox, {Close( 1 )} ),
                        Dispatch( {}, "Parameter Estimates", OutlineBox, {Close( 1 )} )
                    )
                )
            ),
            Tab Page Box(
                "Bivariate",
                Moveable( 1 ),
                biv = Bivariate(
                    Y( :weight ),
                    X( :height ),
                    Fit Line( {Line Color( {213, 72, 87} )} ),
                    SendToReport( Dispatch( {}, "Linear Fit", OutlineBox, {Close( 1 )} ) )
                )
            ),
            <<Dockable( 1 )
        ),
        <<Dockable( 1 )
    )
);
(log << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );
(biv << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );


```

### [Get Divider Color](#get-divider-color)

**Syntax:** obj \<< Divider Color( color ); color = obj \<< Get Divider Color

**Description:** Specifies or returns the color for each split divider. If unset, a color based on the background color is used.

**JMP Version Added:** 19

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Divider Color( "Red" );
Show( box << Get Divider Color );


```

### [Get Divider Length](#get-divider-length)

**Syntax:** obj \<< Divider Length( number ); number = obj \<< Get Divider Length

**Description:** Specifies or returns the length as a percentage for each split divider. A value of 0.0 results in an invisible divider. A value of 1.0 results in the (default) full length divider line.

**JMP Version Added:** 19

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Divider Length( 0.8 );
Show( box << Get Divider Length );


```

### [Get Divider Thickness](#get-divider-thickness)

**Syntax:** obj \<< Divider Thickness( number ); number = obj \<< Get Divider Thickness

**Description:** Specifies or returns the line thickness for each split divider. This value must be non-zero.

**JMP Version Added:** 19

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Divider Thickness( 10 );
Show( box << Get Divider Thickness );


```

### [Get DockName](#get-dockname)

**Syntax:** obj \<< Get DockName

### [Get Dockable](#get-dockable)

**Syntax:** bool = obj \<< Get Dockable

**Description:** Return the dockable setting for the container box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);


```

### [Get Sizes](#get-sizes)

**Syntax:** {size1,...} = obj \<< Get Sizes

**Description:** Returns the proportions for each panel of the Splitter Box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Get Sizes();


```

### [Open Panel](#open-panel)

**Syntax:** obj \<< Open Panel( index,<previous> )

**Description:** Open the panel at the given index. If the previous argument is 1 the space will be taken from the previous box in the list, otherwise it will be taken from the next box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
Wait( 2 );
box << Close Panel( 2, 1 );
Wait( 2 );
box << Open Panel( 2, 1 );


```

### [Set Sizes](#set-sizes)

**Syntax:** obj \<< Set Sizes( {size1,...} )

**Description:** Sets the proportions for each panel of the Splitter Box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Set Sizes( {0.6, 0.4} );


```

### [Size](#size)

**Syntax:** obj \<< Size( size )

**Description:** Sets the proportion for the last panel of the Splitter Box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Size( 0.2 );


```

### [Sizes](#sizes)

**Syntax:** obj \<< Sizes( {size1,...} )

**Description:** Sets the proportions for each panel of the Splitter Box.

```

New Window( "Splitter Example",
    box = V Splitter Box(
        Size( 640, 480 ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 9, 112, 84 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 222, 0 ) );
            )
        ),
        H Splitter Box(
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 101, 153, 255 ) );
            ),
            Spacer Box(
                <<Set Fill( 1 );
                <<Color( RGB Color( 255, 153, 0 ) );
            )
        )
    )
);
box << Set Sizes( {0.6, 0.4} );


```

### [get horizontal](#get-horizontal)

**Syntax:** state=0|1 = obj \<< get horizontal

**Description:** Returns if the List Box is horizontal (1) or vertical (0).

```

New Window( "Example",
    Outline Box( "Outline Box",
        vlb = V List Box(
            hlb = H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) ),
            H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
        )
    )
);
Print( "Vertical List Box:", vlb << Get Horizontal );
Print( "Horizontal List Box:", hlb << Get Horizontal );


```

### [set horizontal](#set-horizontal)

**Syntax:** obj \<< set horizontal( state=0|1 )

**Description:** Sets the List Box to horizontal (1) or vertical (0).

```

New Window( "Example",
    Outline Box( "Outline Box",
        vlb = V List Box(
            hlb = H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) ),
            H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
        )
    )
);
hlb << Set Horizontal( 0 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [StemLeafBox](#stemleafbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [StickyListBox](#stickylistbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [StringColBox](#stringcolbox)

## [Associated Constructors](#associated-constructors)

### [String Col Box](#string-col-box)

**Syntax:** y = String Col Box( title, {strings} )

**Description:** Returns a display box that displays strings in a column.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Print( col << Get );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Font;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Print( col << Get Heading() );


```

### [Get Justify](#get-justify)

**Syntax:** "left"|"right"|"center" = obj \<< Get Justify

**Description:** Gets the horizontal justification for the column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
sb << get justify();


```

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Numerical Order](#numerical-order)

**Syntax:** obj \<< Numerical Order( \<0 | 1> )

**Description:** Text containing numbers will be sorted in numerical order.

**JMP Version Added:** 15

```


New Window( "Mountains",
    Text Box( "Numerical order = 0", <<Margin( 5, 5, 5, 10 ) ),
    Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        sb1 = String Col Box( "Elevation (meters)", {"8611", "681", "5895", "4199"} ),
        <<sort by column( 2, 1 )
    ),
    Text Box( "Numerical order = 1", <<Margin( 5, 20, 5, 10 ) ),
    Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        sb2 = String Col Box( "Elevation (meters)", {"8611", "681", "5895", "4199"} ),
        <<sort by column( 2, 1 )
    )
);
sb1 << numerical order( 0 );
sb2 << numerical order( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Allow Text Search](#set-allow-text-search)

**Syntax:** obj \<< Set Allow Text Search( \<0 | 1> )

**Description:** In table boxes with selectable rows, this command allows a string column that has focus to respond to keyboard input to change the selected row.

```

//Run the example.
//Select K2.
//Type the letter g. Notice the last row is selected.
//Type the letters ki. Notice the third row is selected. 
New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << set selectable rows( 1 );
sb << set allow text search( 1 );


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Example",
    col = String Col Box( "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Heading( "New Column Header" );


```

### [Set Justify](#set-justify)

**Syntax:** obj \<< Set Justify( "left","right","center" )

**Description:** Sets the horizontal justification for the column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
sb << set justify( "center" );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( <list> )

**Description:** Sets the values from a list.

```

New Window( "Example", scb = String Col Box( "Associated Text", {"a", "b", "c", "d", "e"} ) );
scb << Set Values( {"A", "B", "C", "D", "E"} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [StringColEditBox](#stringcoleditbox)

## [Associated Constructors](#associated-constructors)

### [String Col Edit Box](#string-col-edit-box)

**Syntax:** y = String Col Edit Box( title, {strings} )

**Description:** Returns a display box that displays editable strings in a column.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);


```

## [Item Messages](#item-messages)

### [Add Element](#add-element)

**Syntax:** obj \<< Add Element( number|string|list|matrix )

**Description:** Appends a new value to the display box.

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Add Element( Random Uniform() * 100000 );


```

### [Col ID](#col-id)

**Syntax:** obj \<< Col ID( state=0|1 )

**JMP Version Added:** 17

### [Copy Column](#copy-column)

**Syntax:** obj \<< Copy Column

**Description:** Copy contents of the column to the clipboard

**JMP Version Added:** 15

### [Copy Selected Column Rows](#copy-selected-column-rows)

**Syntax:** obj \<< Copy Selected Column Rows

**Description:** Copy column data from the selected rows to the clipboard

**JMP Version Added:** 15

### [Get](#get)

**Syntax:** list or matrix = obj \<< Get( <i>, \<"Unsorted"> )

**Description:** Returns the values in a list, or the ith value. By default the values are returned in the order they are shown in the table. If Unsorted is specified the values are always in the same order regardless of how the table is sorted.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Print( col << Get );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Base Data Font;


```

### [Get Col ID](#get-col-id)

**Syntax:** obj \<< Get Col ID( state=0|1 )

**JMP Version Added:** 17

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Name( "Times New Roman" );
col << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Name( "Arial" );
col << Set Data Font Style( "Italic" );
col << Get Data Font Style;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Get Font;


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Function(
    Function( {this, which},
        Print( "row " || Char( which ) || " changed to " || (col << Get( which )) )
    )
);
col << Get Function;


```

### [Get Heading](#get-heading)

**Syntax:** obj \<< Get Heading

**Description:** Returns the column heading text.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Print( col << Get Heading() );


```

### [Hide/Unhide](#hideunhide)

**Syntax:** obj \<< Hide/Unhide( state=0|1 )

**Description:** Hides or unhides the display box.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Hide( 1 );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( boolean )

**Description:** Enables or disables editing column headers

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Lock Title( 1 );


```

### [Remove Element](#remove-element)

**Syntax:** obj \<< Remove Element( row number )

**Description:** Removes an element from the column.

**JMP Version Added:** 14

```

New Window( "Example",
    col = Number Col Box( "Random Numbers",
        {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() *
        1000, Random Uniform() * 10000}
    )
);
col << Remove Element( 2 );


```

### [Set](#set)

**Syntax:** obj \<< Set( <list>, \<"Presorted"> )

**Description:** Sets the values from a list. If Presorted is specified the values will appear in the same order as the list that is passed in, otherwise the values will be sorted based on the current table sort order.

```

New Window( "Example", col = Number Col Box( "Random Numbers", {} ) );
col << Set(
    {Random Uniform(), Random Uniform() * 10, Random Uniform() * 100, Random Uniform() * 1000,
    Random Uniform() * 10000}
);


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Wait( 2 );
col << Set Base Data Font( "Data" );


```

### [Set Col ID](#set-col-id)

**Syntax:** obj \<< Set Col ID( state=0|1 )

**JMP Version Added:** 17

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
Wait( 2 );
col << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox, which}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when a change is committed. which is the row number of the cell that changed.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Function(
    Function( {thisBox, which},
        Print( "row " || Char( which ) || " changed to " || (thisBox << Get( which )) )
    )
);


```

### [Set Heading](#set-heading)

**Syntax:** obj \<< Set Heading( "string" )

**Description:** Changes the column heading text.

```

New Window( "Example",
    col = String Col Edit Box(
        "Strings",
        {"The", "quick", "brown", "fox", "jumps", "over", "the", "lazy", "dog"}
    )
);
col << Set Heading( "New Column Header" );


```

### [Set Resizable](#set-resizable)

**Syntax:** obj \<< Set Resizable( boolean )

**Description:** Turns on or off the ability to interactively resize a column

```

New Window( "Mountains",
    tb = Table Box(
        sb = String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        nb = Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        pb = Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
nb << Set Resizable( 1 );


```

### [Set Smart Shrinking](#set-smart-shrinking)

**Syntax:** obj \<< Set Smart Shrinking( boolean )

**Description:** When enabled, automatically sized columns will wait to shrink until their widest element is less than 2/3 of the current width.

```

New Window( "Smart Shrinking",
    Table Box(
        String Col Edit Box( "Regular", {"I change my size every time you edit"} ),
        c = String Col Edit Box(
            "Smart",
            {"I only get smaller when my text is less than 2/3 my width"}
        )
    )
);
c << Set Smart Shrinking( true );


```

### [Set Values](#set-values)

**Syntax:** obj \<< Set Values( <list> )

**Description:** Sets the values from a list.

```

New Window( "Example", scb = String Col Box( "Associated Text", {"a", "b", "c", "d", "e"} ) );
scb << Set Values( {"A", "B", "C", "D", "E"} );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TabListBox](#tablistbox)

## [Associated Constructors](#associated-constructors)

### [Tab Box](#tab-box)

**Syntax:** y = Tab Box( Tab Page Box(...), TabPageBox(...), ... )

**Description:** Returns a display box that has pages containing other display boxes.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);


```

## [Item Messages](#item-messages)

### [Add](#add)

**Syntax:** obj \<< Add(<index>,"title",contents); obj \<< Add(<index>,tabPageBox)

**Description:** Adds a new tab. If no index is specified, the tab is appended after the current tabs. If the content to be added is not a Tab Page Box, then a new Tab Page Box will be added to hold the content.

**Example 1**

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Add( "Fourth Tab", Button Box( "Press Four" ) );


```

**Example 2**

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Add( Tab Page Box( Title( "Fourth Tab" ), Button Box( "Press Four" ) ) );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete( <index> )

**Description:** Removes the tab at index. If no index is specified, the selected tab is removed.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Delete( 2 );


```

### [DockName](#dockname)

**Syntax:** obj \<< DockName( text )

### [Dockable](#dockable)

**Syntax:** obj \<< Dockable( bool )

**Description:** If a container is dockable, children that are moveable can be rearranged using drag-and-drop.

**Example 1**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    H Splitter Box(
        Size( 800, 600 ),
        Tab Page Box( "Data Table", dt << New Data Box, <<Moveable( 1 ) ),
        V Splitter Box(
            Tab Page Box(
                "Logistic",
                log = Logistic(
                    Y( :age ),
                    X( :weight ),
                    SendToReport(
                        Dispatch( {}, "Whole Model Test", OutlineBox, {Close( 1 )} ),
                        Dispatch( {}, "Parameter Estimates", OutlineBox, {Close( 1 )} )
                    )
                ),
                <<Moveable( 1 )
            ),
            Tab Page Box(
                "Bivariate",
                biv = Bivariate(
                    Y( :weight ),
                    X( :height ),
                    Fit Line( {Line Color( {213, 72, 87} )} ),
                    SendToReport( Dispatch( {}, "Linear Fit", OutlineBox, {Close( 1 )} ) )
                ),
                <<Moveable( 1 )
            ),
            <<Dockable( 1 )
        ),
        <<Dockable( 1 )
    )
);
(log << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );
(biv << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );


```

**Example 2**

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "Example",
    H Splitter Box(
        Size( 800, 600 ),
        Tab Page Box( "Data Table", dt << New Data Box, <<Moveable( 1 ) ),
        Tab Box(
            Tab Page Box(
                "Logistic",
                Moveable( 1 ),
                log = Logistic(
                    Y( :age ),
                    X( :weight ),
                    SendToReport(
                        Dispatch( {}, "Whole Model Test", OutlineBox, {Close( 1 )} ),
                        Dispatch( {}, "Parameter Estimates", OutlineBox, {Close( 1 )} )
                    )
                )
            ),
            Tab Page Box(
                "Bivariate",
                Moveable( 1 ),
                biv = Bivariate(
                    Y( :weight ),
                    X( :height ),
                    Fit Line( {Line Color( {213, 72, 87} )} ),
                    SendToReport( Dispatch( {}, "Linear Fit", OutlineBox, {Close( 1 )} ) )
                )
            ),
            <<Dockable( 1 )
        ),
        <<Dockable( 1 )
    )
);
(log << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );
(biv << Report)[Frame Box( 1 )] << Set Stretch( "Window", "Window" ) <<
Set Max Size( 1000, 1000 ) << Set Min Size( 20, 20 );


```

### [Get DockName](#get-dockname)

**Syntax:** obj \<< Get DockName

### [Get Dockable](#get-dockable)

**Syntax:** bool = obj \<< Get Dockable

**Description:** Return the dockable setting for the container box.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);


```

### [Get Min Title Width](#get-min-title-width)

**Syntax:** obj \<< Get Min Title Width

**Description:** Get the minimum width of the truncated tab titles when Overflow Enabled is set. The default setting of 0 will apply a default minimum width.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 2 );
tb << Set Overflow Enabled( 1 );
tb << Set Min Title Width( 200 );
tb << Get Min Title Width();


```

### [Get Overflow Enabled](#get-overflow-enabled)

**Syntax:** obj \<< Get Overflow Enabled

**Description:** When Overflow Enabled is 1, the tab list will not be forced to the width of the tab titles. If the tab list is not wide enough for all titles, an overflow menu will be shown to allow selection of a new tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 2 );
tb << Set Overflow Enabled( 1 );
Show( tb << Get Overflow Enabled() );


```

### [Get Selected](#get-selected)

**Syntax:** index = obj \<< Get Selected

**Description:** Returns the currently selected tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Selected( 2 );
Print( tb << Get Selected );


```

### [Get Show Tabs](#get-show-tabs)

**Syntax:** obj \<< Get Show Tabs

**Description:** Get the current status of the Tab visibility

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Print( tb << Get Show Tabs() );


```

### [Get Style](#get-style)

**Syntax:** style = obj \<< Get Style

**Description:** Get the current visual appearance of the tab control.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Print( tb << Get Style() );


```

### [Get Tab Changed](#get-tab-changed)

**Syntax:** obj \<< Get Tab Changed

**Description:** Returns the script that is run when a different tab is selected.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << SetTabChanged( Function( {this}, Print( this << Get Title ) ) );
tb << GetTabChanged;


```

### [Get Tab Close](#get-tab-close)

**Syntax:** obj \<< Get Tab Close

**Description:** Returns the script that is run when a tab is closed from a script or through the close icon. The script should return 1 to allow the close, or 0 to cancel the close.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << SetTabClose( Function( {this}, 1 ) );
tb << Get Tab Close;


```

### [Get Tab Close Tip](#get-tab-close-tip)

**Syntax:** "string" = obj \<< Get Tab Close Tip

**Description:** Returns the tooltip of the Close Tab icon.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Closeable( 2, 1 );
tb << Set Tab Close( Function( {this}, 1 ) );
tb << Set Tab Close Tip( "Close Tab" );
Print( tb << Get Tab Close Tip() );


```

### [Get Tab Count](#get-tab-count)

**Syntax:** count = obj \<< Get Tab Count

**Description:** Returns the number of tabs.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Print( tb << Get Tab Count );


```

### [Get Tab Margin](#get-tab-margin)

**Syntax:** all | horizontal,vertical | left,top,right,bottom = obj \<< Get Tab Margin

**Description:** Returns the margin of the tabs.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab Margin( 50, 40 );
Print( tb << Get Tab Margin );


```

### [Get Tab New](#get-tab-new)

**Syntax:** obj \<< Get Tab New

**Description:** Returns the script that is run when the New tab is clicked. The script is responsible for creating the new tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab New( Function( {this}, this << Add( "New Tab", Button Box( "Press" ) ) ) );
tb << Get Tab New();


```

### [Get Tab New Icon](#get-tab-new-icon)

**Syntax:** "string" = obj \<< Get Tab New Icon

**Description:** Returns the icon of the New tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab New( Function( {this}, this << Add( "New Tab", Button Box( "Press" ) ) ) );
tb << Set Tab New Icon( "NewTable" );
Print( tb << Get Tab New Icon() );


```

### [Get Tab New Tip](#get-tab-new-tip)

**Syntax:** "string" = obj \<< Get Tab New Tip

**Description:** Returns the tooltip of the New tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab New( Function( {this}, this << Add( "New Tab", Button Box( "Press" ) ) ) );
tb << Set Tab New Tip( "Create New" );
Print( tb << Get Tab New Tip() );


```

### [Get Title Location](#get-title-location)

**Syntax:** style = obj \<< Get Title Location

**Description:** Get the current title location setting.

**JMP Version Added:** 16

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Print( tb << Get Title Location() );


```

### [Index of Tab](#index-of-tab)

**Syntax:** index = obj \<< Index of Tab( "string" )

**Description:** Returns the index of the tab with the specified title.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Print( tb << Index of Tab( "Third Tab" ) );


```

### [Insert](#insert)

**Syntax:** obj \<< Insert(<index>,"title",contents); obj \<< Insert(<index>,tabPageBox)

**Description:** Inserts a new tab. If no index is specified, the new tab is appended after the current tabs. If the content to be added is not a Tab Page Box, then a new Tab Page Box will be added to hold the content.

**Example 1**

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Insert( "Fourth Tab", Button Box( "Press Four" ) );


```

**Example 2**

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Insert( Tab Page Box( Title( "Fourth Tab" ), Button Box( "Press Four" ) ) );


```

### [Move Tab](#move-tab)

**Syntax:** obj \<< Move Tab( fromIndex, toIndex )

**Description:** Move the tab at position fromIndex to position toIndex.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Move Tab( 1, 2 );


```

### [Replace](#replace)

**Syntax:** obj \<< Replace(<index>,"title",contents); obj \<< Replace(<index>,tabPageBox)

**Description:** Replaces the tab. If no index is specified, the selected tab is replaced. If the content to be added is not a Tab Page Box, then a new Tab Page Box will be added to hold the content.

**Example 1**

```

title = 1;
nw = New Window( "Test",
    tb = Tab Box(),
    Global Box( title ),
    titlebox = Text Box( "" ),
    Lineup Box( N Col( 4 ),
        Button Box( "add 1",
            tb << Add( 1, "created " || Char( title++ ), Text Box( "content" ) )
        ),
        Button Box( "add 2",
            tb << Add( 2, "created " || Char( title++ ), Text Box( "content" ) )
        ),
        Button Box( "add 3",
            tb << Add( 3, "created " || Char( title++ ), Text Box( "content" ) )
        ),
        Button Box( "add 4",
            tb << Add( 4, "created " || Char( title++ ), Text Box( "content" ) )
        ),
        Button Box( "remove 1", tb << delete( 1 ) ),
        Button Box( "remove 2", tb << delete( 2 ) ),
        Button Box( "remove 3", tb << delete( 3 ) ),
        Button Box( "remove 4", tb << delete( 4 ) ),
        Button Box( "select 1", tb << Set Selected( 1 ) ),
        Button Box( "select 2", tb << Set Selected( 2 ) ),
        Button Box( "select 3", tb << Set Selected( 3 ) ),
        Button Box( "select 4", tb << Set Selected( 4 ) ),
        Button Box( "replace 1",
            tb << replace( 1, "replaced " || Char( title++ ), Text Box( "replaced" ) )
        ),
        Button Box( "replace 2",
            tb << replace( 2, "replaced " || Char( title++ ), Text Box( "replaced" ) )
        ),
        Button Box( "replace 3",
            tb << replace( 3, "replaced " || Char( title++ ), Text Box( "replaced" ) )
        ),
        Button Box( "replace 4",
            tb << replace( 4, "replaced " || Char( title++ ), Text Box( "replaced" ) )
        ),
        Button Box( "gettitle 1", titlebox << settext( tb << gettitle( 1 ) ) ),
        Button Box( "gettitle 2", titlebox << settext( tb << gettitle( 2 ) ) ),
        Button Box( "gettitle 3", titlebox << settext( tb << gettitle( 3 ) ) ),
        Button Box( "gettitle 4", titlebox << settext( tb << gettitle( 4 ) ) ),
        Button Box( "settitle 1", (tb << settitle( 1, "set " || Char( title++ ) )) ),
        Button Box( "settitle 2", (tb << settitle( 2, "set " || Char( title++ ) )) ),
        Button Box( "settitle 3", (tb << settitle( 3, "set " || Char( title++ ) )) ),
        Button Box( "settitle 4", (tb << settitle( 4, "set " || Char( title++ ) )) ),
        Button Box( "enable 1", (tb << enable( 1, 1 )) ),
        Button Box( "enable 2", (tb << enable( 2, 1 )) ),
        Button Box( "enable 3", (tb << enable( 3, 1 )) ),
        Button Box( "enable 4", (tb << enable( 4, 1 )) ),
        Button Box( "disable 1", (tb << enable( 1, 0 )) ),
        Button Box( "disable 2", (tb << enable( 2, 0 )) ),
        Button Box( "disable 3", (tb << enable( 3, 0 )) ),
        Button Box( "disable 4", (tb << enable( 4, 0 )) ),

    )
);


```

**Example 2**

```

title = 1;
nw = New Window( "Test",
    tb = Tab Box(),
    Global Box( title ),
    titlebox = Text Box( "" ),
    Lineup Box( N Col( 4 ),
        Button Box( "add 1",
            tb << Add(
                1,
                Tab Page Box( Title( "created " || Char( title++ ) ), Text Box( "content" ) )
            )
        ),
        Button Box( "add 2",
            tb << Add(
                2,
                Tab Page Box( Title( "created " || Char( title++ ) ), Text Box( "content" ) )
            )
        ),
        Button Box( "add 3",
            tb << Add(
                3,
                Tab Page Box( Title( "created " || Char( title++ ) ), Text Box( "content" ) )
            )
        ),
        Button Box( "add 4",
            tb << Add(
                4,
                Tab Page Box( Title( "created " || Char( title++ ) ), Text Box( "content" ) )
            )
        ),
        Button Box( "remove 1", tb << delete( 1 ) ),
        Button Box( "remove 2", tb << delete( 2 ) ),
        Button Box( "remove 3", tb << delete( 3 ) ),
        Button Box( "remove 4", tb << delete( 4 ) ),
        Button Box( "select 1", tb << Set Selected( 1 ) ),
        Button Box( "select 2", tb << Set Selected( 2 ) ),
        Button Box( "select 3", tb << Set Selected( 3 ) ),
        Button Box( "select 4", tb << Set Selected( 4 ) ),
        Button Box( "replace 1",
            tb << replace(
                1,
                Tab Page Box(
                    Title( "replaced " || Char( title++ ) ),
                    Text Box( "replaced" )
                )
            )
        ),
        Button Box( "replace 2",
            tb << replace(
                2,
                Tab Page Box(
                    Title( "replaced " || Char( title++ ) ),
                    Text Box( "replaced" )
                )
            )
        ),
        Button Box( "replace 3",
            Tab Page Box(
                Title(
                    tb << replace( 3, "replaced " || Char( title++ ) ),
                    Text Box( "replaced" )
                )
            )
        ),
        Button Box( "replace 4",
            tb << replace(
                4,
                Tab Page Box(
                    Title( "replaced " || Char( title++ ) ),
                    Text Box( "replaced" )
                )
            )
        ),
        Button Box( "gettitle 1", titlebox << settext( tb << gettitle( 1 ) ) ),
        Button Box( "gettitle 2", titlebox << settext( tb << gettitle( 2 ) ) ),
        Button Box( "gettitle 3", titlebox << settext( tb << gettitle( 3 ) ) ),
        Button Box( "gettitle 4", titlebox << settext( tb << gettitle( 4 ) ) ),
        Button Box( "settitle 1", (tb << settitle( 1, "set " || Char( title++ ) )) ),
        Button Box( "settitle 2", (tb << settitle( 2, "set " || Char( title++ ) )) ),
        Button Box( "settitle 3", (tb << settitle( 3, "set " || Char( title++ ) )) ),
        Button Box( "settitle 4", (tb << settitle( 4, "set " || Char( title++ ) )) ),
        Button Box( "enable 1", (tb << enable( 1, 1 )) ),
        Button Box( "enable 2", (tb << enable( 2, 1 )) ),
        Button Box( "enable 3", (tb << enable( 3, 1 )) ),
        Button Box( "enable 4", (tb << enable( 4, 1 )) ),
        Button Box( "disable 1", (tb << enable( 1, 0 )) ),
        Button Box( "disable 2", (tb << enable( 2, 0 )) ),
        Button Box( "disable 3", (tb << enable( 3, 0 )) ),
        Button Box( "disable 4", (tb << enable( 4, 0 )) ),

    )
);


```

### [Set Min Title Width](#set-min-title-width)

**Syntax:** obj \<< Set Min Title Width( number )

**Description:** Set the minimum width of the truncated tab titles when Overflow Enabled is set. The default setting of 0 will apply a default minimum width.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 2 );
tb << Set Overflow Enabled( 1 );
tb << Set Min Title Width( 200 );


```

### [Set Overflow Enabled](#set-overflow-enabled)

**Syntax:** obj \<< Set Overflow Enabled( state=0|1 )

**Description:** When Overflow Enabled is true, the tab list will not be forced to the width of the tab titles. If the tab list is not wide enough for all titles, an overflow menu will be shown to allow selection of a new tab. This option only applies if the style is set to Tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 2 );
tb << Set Overflow Enabled( 1 );


```

### [Set Selected](#set-selected)

**Syntax:** obj \<< Set Selected( index )

**Description:** Brings focus to the tab at index.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Set Selected( 2 );


```

### [Set Style](#set-style)

**Syntax:** obj \<< Set Style( "Tab"|"Combo"|"Outline"|"Vertical Spread"|"Horizontal Spread"|"Minimize Size" )

**Description:** Changes the visual appearance of the tab control.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Style( "combo" );


```

### [Set Tab Changed](#set-tab-changed)

**Syntax:** obj \<< Set Tab Changed( script|Function( {this}, <script> ) )

**Description:** After a change is made (such as a new tab selection), the specified script or function is run.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << SetTabChanged( Function( {this}, Print( this << Get Title ) ) );


```

### [Set Tab Close](#set-tab-close)

**Syntax:** obj \<< Set Tab Close( script|Function )

**Description:** Set the script or Function to run when a tab is closed from a script or through the close icon. The script or Function should return 1 to allow the close, or 0 to cancel the close.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Closeable( 2, 1 );
tb << Set Tab Close( Function( {this}, 1 ) );


```

### [Set Tab Close Tip](#set-tab-close-tip)

**Syntax:** obj \<< Set Tab Close Tip( "string" )

**Description:** Sets the tooltip of the Close Tab icon.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Closeable( 2, 1 );
tb << Set Tab Close( Function( {this}, 1 ) );
tb << Set Tab Close Tip( "Close Tab" );


```

### [Set Tab Margin](#set-tab-margin)

**Syntax:** obj \<< Set Tab Margin( all | horizontal,vertical | left,top,right,bottom )

**Description:** Sets the margin for the tabs. Inputted parameters can be applied to all sides, the horizontal and vertical sizes, or different values for each side.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab Margin( 50, 40 );


```

### [Set Tab New](#set-tab-new)

**Syntax:** obj \<< Set Tab New( script|Function( {this}, <script> ) )

**Description:** Sets the script or Function to run when the New tab is clicked. The script or function is responsible for creating the new tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab New( Function( {this}, this << Add( "New Tab", Button Box( "Press" ) ) ) );


```

### [Set Tab New Icon](#set-tab-new-icon)

**Syntax:** obj \<< Set Tab New Icon( "string" )

**Description:** Sets the icon of the New tab.

**Example 1**

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab New( Function( {this}, this << Add( "New Tab", Button Box( "Press" ) ) ) );
tb << Set Tab New Icon( "NewTable" );


```

**Example 2**

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab New( Function( {this}, this << Add( "New Tab", Button Box( "Press" ) ) ) );
pict = New Image( "$SAMPLE_IMAGES/pi.gif" );
tb << Set Tab New Icon( pict );


```

### [Set Tab New Tip](#set-tab-new-tip)

**Syntax:** obj \<< Set Tab New Tip( "string" )

**Description:** Sets the tooltip of the New tab.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Tab New( Function( {this}, this << Add( "New Tab", Button Box( "Press" ) ) ) );
tb << Set Tab New Tip( "Create New" );


```

### [Set Title Location](#set-title-location)

**Syntax:** obj \<< Set Title Location( "Auto"|"Top"|"Bottom"|"Left"|"Right" )

**Description:** Set the location of the tab page titles. With a setting of "Auto", the location is chosen automatically depending on the size of the content. This option only applies if the style is set to Tabbed.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
tb << Set Title Location( "Bottom" );


```

### [Show Tabs](#show-tabs)

**Syntax:** obj \<< Show Tabs( state=0|1 )

**Description:** Shows or hides the tabs.

```

New Window( "Example",
    tb = Tab Box(
        Tab Page Box( "First Tab", Tip( "First Tab Tooltip" ), Button Box( "Press One" ) ),
        Tab Page Box( "Second Tab", Closeable( 1 ), Button Box( "Press Two" ) ),
        Tab Page Box( "Third Tab", Icon( "Nominal" ), Button Box( "Press Three" ) )
    )
);
Wait( 1 );
tb << Show Tabs( 0 );
Wait( 1 );
tb << Show Tabs( 1 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TabPageBox](#tabpagebox)

## [Associated Constructors](#associated-constructors)

### [Tab Page Box](#tab-page-box)

**Syntax:** y = Tab Page Box( \<Title("string")>, \<Tip(0|1)>, \<Closeable(0|1)>, \<Icon("string")>, \<Moveable(0|1)>, contents)

**Description:** Returns a display box that that can be used in a Tab Box or as a stand-alone container with title. Recognized options include Title(string) to specify a title, Tip(string) to specify a tooltip, Closeable(0|1) to specify whether the page can be closed, Icon(string) to specify the icon, and Moveable(0|1) to specify whether the page can be moved.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);


```

## [Item Messages](#item-messages)

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Closes the tab, if it is closeable.

**JMP Version Added:** 14

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Closeable( 1 );
Wait( 1 );
tp << Close();


```

### [Closeable](#closeable)

**Syntax:** obj \<< Closeable( state=0|1 )

**Description:** Sets the closeable status of the tab.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Closeable( 1 );


```

### [Focus Color](#focus-color)

**Syntax:** obj \<< Focus Color( color ); color = obj \<< Get Focus Color

**Description:** If the focus color is set, it is used for the focus bar on the tab title when the tab or a box within it has focus.

**JMP Version Added:** 19

```

New Window( "Example",
    V List Box(
        Tab Box(
            tp = Tab Page Box(
                Title( "alpha" ),
                Text Edit Box( "text" ),
                <<Focus Color( "Cyan" )
            ),
            Tab Page Box(
                Title( "beta" ),
                Text Edit Box( "more text" ),
                <<Focus Color( "Fuchsia" )
            ),
            Tab Page Box( Title( "gamma" ), Text Edit Box( "still more text" ) ),
            <<Margin( 20 ),
            <<Padding( 20 )
        ),
        Text Edit Box( "outside text", <<Margin( 20 ) )
    )
);
Show( tp << Get Focus Color );
tp << Focus Color( "Blue" );


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Get Base Font;


```

### [Get Close](#get-close)

**Syntax:** obj \<< Get Close

**Description:** Returns the script that is run when the tab is closed from a script or through the close icon. The script should return 1 to allow the close, or 0 to cancel the close.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Set Close( Function( {this}, 1 ) );
tp << Get Close;


```

### [Get Close Tip](#get-close-tip)

**Syntax:** "string" = obj \<< Get Close Tip

**Description:** Returns the tooltip of the Close Tab icon.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Closeable( 1 );
tp << Set Close( Function( {this}, 1 ) );
tp << Set Close Tip( "Close Tab" );
Print( tp << Get Close Tip() );


```

### [Get Closeable](#get-closeable)

**Syntax:** "bool" = obj \<< Get Closeable

**Description:** Returns the closeable status of the tab.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Closeable( 1 );
Print( tp << Get Closeable( 2 ) );


```

### [Get Focus Color](#get-focus-color)

**Syntax:** obj \<< Focus Color( color ); color = obj \<< Get Focus Color

**Description:** If the focus color is set, it is used for the focus bar on the tab title when the tab or a box within it has focus.

**JMP Version Added:** 19

```

New Window( "Example",
    V List Box(
        Tab Box(
            tp = Tab Page Box(
                Title( "alpha" ),
                Text Edit Box( "text" ),
                <<Focus Color( "Cyan" )
            ),
            Tab Page Box(
                Title( "beta" ),
                Text Edit Box( "more text" ),
                <<Focus Color( "Fuchsia" )
            ),
            Tab Page Box( Title( "gamma" ), Text Edit Box( "still more text" ) ),
            <<Margin( 20 ),
            <<Padding( 20 )
        ),
        Text Edit Box( "outside text", <<Margin( 20 ) )
    )
);
Show( tp << Get Focus Color );
tp << Focus Color( "Blue" );


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Icon](#get-icon)

**Syntax:** "string" = obj \<< Get Icon

**Description:** Returns the icon of the tab.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Icon( "Diagram" );
Print( tp << Get Icon( 2 ) );


```

### [Get Moveable](#get-moveable)

**Syntax:** obj \<< Get Moveable

**Description:** Returns the moveable setting of the box.

### [Get Scriptable Object](#get-scriptable-object)

**Syntax:** scriptable object = obj \<< Get Scriptable Object

**Description:** Returns a reference to the scriptable object associated with the Tab Page Box.

```

New Window( "Example",
    H List Box(
        Tab Box(
            tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
            Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
        ),
        tp3 = Tab Page Box(
            Title( "gamma" ),
            tb = Table Box(
                String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
                Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
                Plot Col Box( "", {8611, 681, 5895, 4199} )
            ),

        )
    )
);
tp3 << Set Scriptable Object( tb );
Wait( 2 );
tp3 << Get Scriptable Object();


```

### [Get Tip](#get-tip)

**Syntax:** "string" = obj \<< Get Tip

**Description:** Returns the tooltip of the tab

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Tip( "Alpha Tab" );
Print( tp << Get Tip() );


```

### [Get Title](#get-title)

**Syntax:** "string" = obj \<< Get Title

**Description:** Returns the title of the Tab Page Box.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Title( "Fit Line" );
tp << Get Title();


```

### [Icon](#icon)

**Syntax:** obj \<< Icon( "string" )

**Description:** Sets the icon of the tab.

**Example 1**

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Icon( "Diagram" );


```

**Example 2**

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
pict = New Image( "$SAMPLE_IMAGES/pi.gif" );
tp << Icon( pict );


```

### [Lock Title](#lock-title)

**Syntax:** obj \<< Lock Title( state=0|1 )

**Description:** Lock the tab page title to prevent interactive changes.

**JMP Version Added:** 16

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Lock Title( 1 );


```

### [Moveable](#moveable)

**Syntax:** obj \<< Moveable( state=0|1 )

**Description:** Moveable boxes can be rearranged within a dockable box using drag-and-drop.

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Close](#set-close)

**Syntax:** obj \<< Set Close( script|Function( {this}, <script> ) )

**Description:** Set the script or Function to run when the tab is closed from a script or through the close icon. The script or Function should return 1 to allow the close, or 0 to cancel the close.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Closeable( 1 );
tp << Set Close( Function( {this}, 1 ) );


```

### [Set Close Tip](#set-close-tip)

**Syntax:** obj \<< Set Close Tip( "string" )

**Description:** Sets the tooltip of the Close Tab icon.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Closeable( 1 );
tp << Set Close( Function( {this}, 1 ) );
tp << Set Close Tip( "Close Tab" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Scriptable Object](#set-scriptable-object)

**Syntax:** obj \<< Set Scriptable Object( <scriptable object> )

**Description:** Sets the scriptable object associated with the Tab Page Box. Tab Page Box will show a red triangle menu of messages that can be sent to the scriptable object. If no argument is provided, the scriptable object will be cleared.

```

New Window( "Example",
    H List Box(
        Tab Box(
            tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
            Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
        ),
        tp3 = Tab Page Box(
            Title( "gamma" ),
            tb = Table Box(
                String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
                Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
                Plot Col Box( "", {8611, 681, 5895, 4199} )
            ),

        )
    )
);
tp3 << Set Scriptable Object( tb );


```

### [Set Title Changed](#set-title-changed)

**Syntax:** obj \<< Set Title Changed

**Description:** Set a function that runs when the tab page title is changed.

**JMP Version Added:** 16

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Set Title Changed(
    Function( {this, oldtitle},
        Print(
            "title changed: old (" || oldtitle || ") new (" || (this << Get Title()) || ")"
        )
    )
);


```

### [Tip](#tip)

**Syntax:** obj \<< Tip( "string" )

**Description:** Sets the tooltip of the tab.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
tp << Tip( "Alpha Tab" );


```

### [Title](#title)

**Syntax:** obj \<< Title( "string", \<Run Script(0 | 1)> )

**Description:** Sets the title of the Tab Page Box.

```

New Window( "Example",
    Tab Box(
        tp = Tab Page Box( Title( "alpha" ), Panel Box( "panel", Text Box( "text" ) ) ),
        Tab Page Box( Title( "beta" ), Popup Box( {"x", ex = 1, "y", ex = 2} ) )
    )
);
Wait( 1 );
tp << title( "Fit Line" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TableBox](#tablebox)

## [Associated Constructors](#associated-constructors)

### [Table Box](#table-box)

**Syntax:** y = Table Box( displayBox, ... )

**Description:** Returns a display box for a table consisting of one or more columns.

**Example 1**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Baltic.jmp" );
d = Distribution( Continuous Distribution( Column( :ls ) ) );
rpt = d << report;
tb = rpt[Table Box( 1 )];
tb << Select;


```

## [Item Messages](#item-messages)

### [Add Row](#add-row)

**Syntax:** obj \<< Add Row( {values,...} )

**Description:** Adds a row of data to the table

```

New Window( "test",
    tb = Table Box(
        String Col Box( "string col", {"a"} ),
        Number Col Box( "number col", {1} )
    )
);
tb << add row( {"b", 2} );


```

### [Bootstrap](#bootstrap)

**Syntax:** obj \<< Bootstrap( nsample, Random Seed(number), Fractional Weights(0|1), Split Selected Column(0|1), Discard Stacked Table if Split Works(0|1) )

**Description:** Bootstraps this analysis: repeating it many times with different resampling weights and collecting tables as selected.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
obj << Fit Line;
(obj << Report)[Table Box( 1 )] << Bootstrap(
    50,
    Fractional Weights( 1 ),
    Split Selected Column( 1 )
);


```

### [Copy Selected Table Rows](#copy-selected-table-rows)

**Syntax:** obj \<< Copy Selected Table Rows

**Description:** Copy the contents of the selected rows to the clipboard

**JMP Version Added:** 15

### [Copy Table](#copy-table)

**Syntax:** obj \<< Copy Table

**Description:** Copy the contents of the table to the clipboard

**JMP Version Added:** 15

### [Delete Row](#delete-row)

**Syntax:** obj \<< Delete Row( row number )

**Description:** Deletes a row of data to the table

```

New Window( "test",
    tb = Table Box(
        String Col Box( "string col", {"a", "b"} ),
        Number Col Box( "number col", {1, 2} )
    )
);
tb << delete row( 1 );


```

### [Filter Where](#filter-where)

**Syntax:** obj \<< Filter Where

**Description:** Filters rows in the table based on the values in that row.

**JMP Version Added:** 17

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << set selectable rows( 1 );
tb << filter where( "Elevation (meters)"n < 4000 | Mountain == "K2" );


```

### [Get](#get)

**Syntax:** obj \<< Get

**Description:** Returns the entries of the table in list form.

```

Open( "$SAMPLE_DATA/Baltic.jmp" );
d = Distribution( Continuous Distribution( Column( :ls ) ) );
rpt = d << report;
tb = rpt[Table Box( 1 )];
Print( tb << Get );


```

### [Get As Matrix](#get-as-matrix)

**Syntax:** obj \<< Get As Matrix( \<"Visible"> )

**Description:** Returns the numeric entries of the table in matrix form. If the Visible option is specified, only visible columns will be included.

```

Open( "$SAMPLE_DATA/Baltic.jmp" );
d = Distribution( Continuous Distribution( Column( :ls ) ) );
rpt = d << report;
tb = rpt[Table Box( 1 )];
Print( tb << Get As Matrix );


```

### [Get Base Data Font](#get-base-data-font)

**Syntax:** font = obj \<< Get Base Data Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Base Data Font;


```

### [Get Base Title Font](#get-base-title-font)

**Syntax:** font = obj \<< Get Base Title Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Base Title Font;


```

### [Get Click Sort](#get-click-sort)

**Syntax:** 0|1 = obj \<< Get Click Sort

**Description:** 1 if the table can be sorted by single clicking on a column header, otherwise 0

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Click Sort;


```

### [Get Column Borders](#get-column-borders)

**Syntax:** obj \<< Get Column Borders( state=0|1 )

**Description:** Returns 1 if columns borders are currently being drawn

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Column Borders;


```

### [Get Column Group Borders](#get-column-group-borders)

**Syntax:** obj \<< Get Column Group Borders( state=0|1 )

```

New Window( "Mountains",
    tb = Table Box(
        Col Span Box(
            "Column Span",
            String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} )
        ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Column Group Borders;


```

### [Get Context Menu Item State](#get-context-menu-item-state)

**Syntax:** 0|1|-1 = obj \<< Get Context Menu Item State( index )

**Description:** Gets the context menu item state of index menu item. The state will be normal (0), checked (1), or disabled (-1)

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Context Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
tb << Set Context Menu Item State( 2, -1 );
tb << Get Context Menu Item State( 2 );


```

### [Get Context Menu Script](#get-context-menu-script)

**Syntax:** list = obj \<< Get Context Menu Script

**Description:** Returns the context menu script attached to the calling object.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Context Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; ,
    "Get Context Menu Script", Print( tb << Get Context Menu Script )}
);


```

### [Get Context Menu Submenu](#get-context-menu-submenu)

**Syntax:** obj \<< Get Context Menu Submenu( index )

**Description:** Returns the number of submenus under the given menu item

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Context Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
tb << Set Context Menu Submenu( 2, 3 );
tb << Get Context Menu Submenu( 2 );


```

### [Get Data Font Name](#get-data-font-name)

**Syntax:** obj \<< Get Data Font Name

**Description:** Returns the name of the font.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font Name( "Times New Roman" );
tb << Get Data Font Name;


```

### [Get Data Font Scale](#get-data-font-scale)

**Syntax:** obj \<< Get Data Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Data Font Scale;


```

### [Get Data Font Size](#get-data-font-size)

**Syntax:** obj \<< Get Data Font Size

**Description:** Returns the size of the font.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Data Font Size;


```

### [Get Data Font Style](#get-data-font-style)

**Syntax:** obj \<< Get Data Font Style

**Description:** Returns the font style name.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font Name( "Arial" );
tb << Set Data Font Style( "Italic" );
tb << Get Data Font Style;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Font;


```

### [Get Heading Column Borders](#get-heading-column-borders)

**Syntax:** obj \<< Get Heading Column Borders( state=0|1 )

**Description:** Returns 1 if the column headers for the table currently have borders

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Heading Column Borders;


```

### [Get Heading Underline Color](#get-heading-underline-color)

**Syntax:** obj \<< Heading Underline Color( color ); color = obj \<< Get Heading Underline Color

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Underline Headings( 1 );
tb << Heading Underline Color( "Black" );
Show( tb << Get Heading Underline Color );


```

### [Get Locked Columns](#get-locked-columns)

**Syntax:** obj \<< Get Locked Columns

**Description:** The number of columns that cannot be dragged with the hand cursor or have any columns dropped before them.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << set locked columns( 1 );
tb << get locked columns();


```

### [Get Names](#get-names)

**Syntax:** obj \<< Get Names

**Description:** Returns a list of the column names

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Names();


```

### [Get Row Border Color](#get-row-border-color)

**Syntax:** obj \<< Row Border Color( color ); color = obj \<< Get Row Border Color

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Row Borders( 1 );
tb << Row Border Color( "Black" );
Show( tb << Get Row Border Color );


```

### [Get Row Borders](#get-row-borders)

**Syntax:** obj \<< Get Row Borders( state=0|1 )

**Description:** Returns 1 if lines are drawn above and below each row

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Row Borders;


```

### [Get Row Change Function](#get-row-change-function)

**Syntax:** obj \<< Get Row Change Function

**Description:** Returns the expression that is evaluated when a row is selected.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Selectable Rows();
tb << set row change function( Function( {this}, Print( this << get selected rows ) ) );
tb << get row change function;


```

### [Get Row Height Scale](#get-row-height-scale)

**Syntax:** obj \<< Row Height Scale( number ); number = obj \<< Get Row Height Scale

**Description:** Scales the default height or the rows of a table. The default value is 1.

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Row Height Scale( 3 );
tb << Get Row Height Scale();


```

### [Get Row Vertical Alignment](#get-row-vertical-alignment)

**Syntax:** obj \<< Row Vertical Alignment( "Top"|"Center"|"Baseline"|"Bottom" ); "Top"|"Center"|"Baseline"|"Bottom" = obj \<< Get Row Vertical Alignment

**Description:** Sets the vertical alignment of the text or numbers in the rows of a table

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Row Vertical Alignment( "Bottom" );
tb << Get Row Vertical Alignment();
tb << Row Height Scale( 3 );


```

### [Get Selectable Rows](#get-selectable-rows)

**Syntax:** obj \<< Get Selectable Rows

**Description:** Returns true if the table box currently allows row selection

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Selectable Rows();


```

### [Get Selected Row Color](#get-selected-row-color)

**Syntax:** obj \<< Get Selected Row Color

**Description:** Gets the background color for selected rows

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Selectable Rows();
tb << Set Selected Row Color( "Red" );
Color To RGB( tb << Get Selected Row Color );


```

### [Get Selected Rows](#get-selected-rows)

**Syntax:** obj \<< Get Selected Rows

**Description:** Returns a matrix of row numbers that are selected.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Selected Rows( [1, 4] );
Print( tb << Get Selected Rows() );


```

### [Get Shade Alternate Rows](#get-shade-alternate-rows)

**Syntax:** obj \<< Get Shade Alternate Rows( state=0|1 )

**Description:** Returns 1 if every other row is shaded

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Shade Alternate Rows;


```

### [Get Shade Cells](#get-shade-cells)

**Syntax:** obj \<< Get Shade Cells( state=0|1 )

**Description:** Returns 1 if the cell area of the table has a shaded background

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Shade Cells;


```

### [Get Shade Headings](#get-shade-headings)

**Syntax:** obj \<< Get Shade Headings( state=0|1 )

**Description:** Returns 1 if the column headers for the table are currently shaded

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Shade Headings;


```

### [Get Title Font](#get-title-font)

**Syntax:** obj \<< Get Title Font

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Title Font;


```

### [Get Title Font Name](#get-title-font-name)

**Syntax:** obj \<< Get Title Font Name

**Description:** Returns the name of the font.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font Name( "Times New Roman" );
tb << Get Title Font Name;


```

### [Get Title Font Scale](#get-title-font-scale)

**Syntax:** obj \<< Get Title Font Scale

**Description:** Returns the current scale factor for font.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Title Font Scale;


```

### [Get Title Font Size](#get-title-font-size)

**Syntax:** obj \<< Get Title Font Size

**Description:** Returns the size of the font.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Title Font Size;


```

### [Get Title Font Style](#get-title-font-style)

**Syntax:** obj \<< Get Title Font Style

**Description:** Returns the font style name.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font Name( "Arial" );
tb << Set Title Font Style( "Italic" );
tb << Get Title Font Style;


```

### [Get Underline Headings](#get-underline-headings)

**Syntax:** obj \<< Get Underline Headings( state=0|1 )

**Description:** Returns 1 if column headings are underlined

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Get Underline Headings;


```

### [Group By Column](#group-by-column)

**Syntax:** obj \<< Group By Column( <column index or title>, \<ascending=0|1> )

**Description:** Groups all rows with the same value together and sorts the table based on the those groups. Default sort order is descending.

**JMP Version Added:** 19

```

dt = Open( "$sample_data\big class.jmp" );
New Window( "Test", dtb = Data Table Box( dt ) );
dtb << sort by column( 4 );
dtb << group by column( 3 );
dtb << set click sort( 1 );


```

### [Heading Underline Color](#heading-underline-color)

**Syntax:** obj \<< Heading Underline Color( color ); color = obj \<< Get Heading Underline Color

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Underline Headings( 1 );
tb << Heading Underline Color( "Black" );
Show( tb << Get Heading Underline Color );


```

### [Insert Row](#insert-row)

**Syntax:** obj \<< Insert Row( row number, {values,...} )

**Description:** Inserts a row of data to the table

```

New Window( "test",
    tb = Table Box(
        String Col Box( "string col", {"a"} ),
        Number Col Box( "number col", {1} )
    )
);
tb << insert row( 1, {"b", 2} );


```

### [Make Combined Data Table](#make-combined-data-table)

**Syntax:** obj \<< Make Combined Data Table

**Description:** Makes a data table that also searches the report for report tables with the same columns and combine all of these into the new data table.

```

Open( "$SAMPLE_DATA/Baltic.jmp" );
d = Distribution(
    Continuous Distribution( Column( :ls ) ),
    Continuous Distribution( Column( :ha ) )
);
rpt = d << report;
tb = rpt[Table Box( 1 )];
tb << Make Combined Data Table;


```

### [Make Into Data Table](#make-into-data-table)

**Syntax:** obj \<< Make Into Data Table( \<Invisible(bool) | Private(bool)> )

**Description:** Creates a new data table that contains the values in the TableBox.

**Example 1**

```

Open( "$SAMPLE_DATA/Baltic.jmp" );
d = Distribution( Continuous Distribution( Column( :ls ) ) );
rpt = d << report;
tb = rpt[Table Box( 1 )];
tb << Make Into Data Table;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Baltic.jmp" );
d = Distribution( Continuous Distribution( Column( :ls ) ) );
rpt = d << report;
tb = rpt[Table Box( 1 )];
tb << Make Into Data Table( invisible( 1 ) );


```

### [Reorder Columns](#reorder-columns)

**Syntax:** obj \<< Reorder Columns( from column index,to column index )

**Description:** Reorders the column that positions from column index in the place of to column index.

```

Open( "$SAMPLE_DATA/Baltic.jmp" );
d = Distribution( Continuous Distribution( Column( :ls ) ) );
rpt = d << report;
tb = rpt[Table Box( 1 )];
Wait( 1 );
tb << Reorder Columns( 1, 3 );


```

### [Reset Filter](#reset-filter)

**Syntax:** obj \<< Reset Filter

**Description:** Clears an existing "filter where" message and shows all the rows in the table.

**JMP Version Added:** 17

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << set selectable rows( 1 );
tb << filter where( "Elevation (meters)"n < 4000 | Mountain == "K2" );
Wait( 2 );
tb << Reset Filter;


```

### [Reset Style](#reset-style)

**Syntax:** obj \<< Reset Style

**Description:** Resets the table style based on preference settings

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Shade Cells( 1 );
tb << Reset Style;


```

### [Row Border Color](#row-border-color)

**Syntax:** obj \<< Row Border Color( color ); color = obj \<< Get Row Border Color

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Row Borders( 1 );
tb << Row Border Color( "Black" );
Show( tb << Get Row Border Color );


```

### [Row Height Scale](#row-height-scale)

**Syntax:** obj \<< Row Height Scale( number ); number = obj \<< Get Row Height Scale

**Description:** Scales the default height or the rows of a table. The default value is 1.

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Row Height Scale( 3 );
tb << Get Row Height Scale();


```

### [Row Vertical Alignment](#row-vertical-alignment)

**Syntax:** obj \<< Row Vertical Alignment( "Top"|"Center"|"Baseline"|"Bottom" ); "Top"|"Center"|"Baseline"|"Bottom" = obj \<< Get Row Vertical Alignment

**Description:** Sets the vertical alignment of the text or numbers in the rows of a table

**JMP Version Added:** 19

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Row Vertical Alignment( "Bottom" );
tb << Get Row Vertical Alignment();
tb << Row Height Scale( 3 );


```

### [Select Where](#select-where)

**Syntax:** obj \<< Select Where

**Description:** Selects rows in the table based on the values in that row.

**JMP Version Added:** 15

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << set selectable rows( 1 );
tb << select where( "Elevation (meters)"n < 4000 | Mountain == "K2" );


```

### [Set Base Data Font](#set-base-data-font)

**Syntax:** obj \<< Set Base Data Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
Wait( 2 );
tb << Set Base Data Font( "Data" );


```

### [Set Base Title Font](#set-base-title-font)

**Syntax:** obj \<< Set Base Title Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
Wait( 2 );
tb << Set Base Title Font( "Title" );


```

### [Set Cell Changed Function](#set-cell-changed-function)

**Syntax:** obj \<< Set Cell Changed Function( Function({thisBox, col box, row}, <script>;) )

**Description:** Sets a function that will be called whenever the user edits a cell in a column in the table

```

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( {thisBox, col, row},
        Print(
            (col << get heading) || ": row:" || Char( row ) || " is now " ||
            Char( col << get( row ) )
        )
    )
);


```

### [Set Click Sort](#set-click-sort)

**Syntax:** obj \<< Set Click Sort( \<state=0|1> )

**Description:** Allows the table so be sorted by single clicking on a column header

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Click Sort( 1 );


```

### [Set Column Borders](#set-column-borders)

**Syntax:** obj \<< Set Column Borders( state=0|1 )

**Description:** Draw a line on each side of every column

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Column Borders( 1 );


```

### [Set Column Group Borders](#set-column-group-borders)

**Syntax:** obj \<< Set Column Group Borders( state=0|1 )

```

New Window( "Mountains",
    tb = Table Box(
        Col Span Box(
            "Column Span",
            String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} )
        ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Column Group Borders( 1 );


```

### [Set Context Menu Item State](#set-context-menu-item-state)

**Syntax:** obj \<< Set Context Menu Item State( index, 0|1|-1 )

**Description:** Sets the context menu item at index to be normal (0), checked (1), or disabled (-1)

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Context Menu Script( {"A", Print( "A" ), "B", Print( "B" ), "C", Print( "C" )} );
tb << Set Context Menu Item State( 2, -1 );


```

### [Set Context Menu Script](#set-context-menu-script)

**Syntax:** obj \<< Set Context Menu Script( {"string",script,"string",script, ...} )

**Description:** Adds a context menu with the specified options and scripts to the box.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Context Menu Script(
    {"Beep", Beep(), "Beep Twice", Beep() ; Wait( 1.0 ) ; Beep() ; ,
    "Get Context Menu Script", Print( tb << Get Context Menu Script )}
);


```

### [Set Context Menu Submenu](#set-context-menu-submenu)

**Syntax:** obj \<< Set Context Menu Submenu( index, submenu count )

**Description:** Turns the "index" menu item into a submenu with "submenu count" menu items

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Context Menu Script(
    {"A", Print( "A" ), "B", Print( "B" ), "B1", Print( "B1" ), "B2", Print( "B2" ), "B3",
    Print( "B3" ), "C", Print( "C" )}
);
tb << Set Context Menu Submenu( 2, 3 );


```

### [Set Data Font](#set-data-font)

**Syntax:** obj \<< Set Data Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font( "Arial Black" );


```

**Example 2**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Data Font Name](#set-data-font-name)

**Syntax:** obj \<< Set Data Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font Name( "Arial Black" );


```

### [Set Data Font Scale](#set-data-font-scale)

**Syntax:** obj \<< Set Data Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
Wait( 2 );
tb << Set Data Font Scale( 2.0 );


```

### [Set Data Font Size](#set-data-font-size)

**Syntax:** obj \<< Set Data Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font Size( 14 );


```

### [Set Data Font Style](#set-data-font-style)

**Syntax:** obj \<< Set Data Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font Style( "Italic" );


```

**Example 2**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Data Font Style( "Italic Bold Underline" );


```

### [Set Heading Column Borders](#set-heading-column-borders)

**Syntax:** obj \<< Set Heading Column Borders( state=0|1 )

**Description:** Column borders in headers

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Heading Column Borders( 1 );


```

### [Set Locked Columns](#set-locked-columns)

**Syntax:** obj \<< Set Locked Columns( number )

**Description:** Locks the first n columns so that cannot be dragged with the hand cursor or have any columns dropped before them.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << set locked columns( 1 );


```

### [Set Row Borders](#set-row-borders)

**Syntax:** obj \<< Set Row Borders( state=0|1 )

**Description:** Draw a line above and below each row

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Row Borders( 1 );


```

### [Set Row Change Function](#set-row-change-function)

**Syntax:** obj \<< Set Row Change Function( Function( {thisBox}, <script> ) )

**Description:** Sets the expression that is evaluated when a row is selected.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Selectable Rows();
tb << set row change function( Function( {thisBox}, Print( thisBox << get selected rows ) ) );


```

### [Set Scrollable](#set-scrollable)

**Syntax:** obj \<< Set Scrollable( rows, columns )

**Description:** Turns scrolling on or off for this TableBox.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Scrollable( 3, 0 );


```

### [Set Selectable Rows](#set-selectable-rows)

**Syntax:** obj \<< Set Selectable Rows( state=0|1 )

**Description:** Makes the rows of this TableBox selectable or not.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Selectable Rows();


```

### [Set Selected Row Color](#set-selected-row-color)

**Syntax:** obj \<< Set Selected Row Color( color )

**Description:** Sets the background color for selected rows, only valid if "Set Selectable Rows" is set

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Selectable Rows();
tb << Set Selected Rows( [1, 4] );
tb << Set Selected Row Color( "Red" );


```

### [Set Selected Rows](#set-selected-rows)

**Syntax:** obj \<< Set Selected Rows( row matrix )

**Description:** Selects the given rows and deselects other rows.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Selected Rows( [1, 4] );


```

### [Set Shade Alternate Rows](#set-shade-alternate-rows)

**Syntax:** obj \<< Set Shade Alternate Rows( state=0|1 )

**Description:** Shade the background of every other row in the table

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Shade Alternate Rows( 1 );


```

### [Set Shade Cells](#set-shade-cells)

**Syntax:** obj \<< Set Shade Cells( state=0|1 )

**Description:** Shade the background of every cell in the table

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Shade Cells( 1 );


```

### [Set Shade Headings](#set-shade-headings)

**Syntax:** obj \<< Set Shade Headings( state=0|1 )

**Description:** Shade the background in column headings

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Shade Headings( 1 );


```

### [Set Title Font](#set-title-font)

**Syntax:** obj \<< Set Title Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font( "Arial Black" );


```

**Example 2**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Title Font Name](#set-title-font-name)

**Syntax:** obj \<< Set Title Font Name( fontname )

**Description:** Sets the font for text strings.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font Name( "Arial Black" );


```

### [Set Title Font Scale](#set-title-font-scale)

**Syntax:** obj \<< Set Title Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
Wait( 2 );
tb << Set Title Font Scale( 2.0 );


```

### [Set Title Font Size](#set-title-font-size)

**Syntax:** obj \<< Set Title Font Size( n )

**Description:** Sets the font size in points for text strings.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font Size( 14 );


```

### [Set Title Font Style](#set-title-font-style)

**Syntax:** obj \<< Set Title Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font Style( "Italic" );


```

**Example 2**

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Title Font Style( "Italic Bold Underline" );


```

### [Set Underline Headings](#set-underline-headings)

**Syntax:** obj \<< Set Underline Headings( state=0|1 )

**Description:** Draw a line underneath the column headings

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Set Underline Headings( 1 );


```

### [Simulate](#simulate)

**Syntax:** obj \<< Simulate( nsample, Random Seed(number), Out(column), In(column), Update(<columns>) )

**Description:** Performs a simulation by switching out a column with one that has a simulation formula.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Fit Model(
    Y( :weight ),
    Effects( :age, :sex, :height ),
    Personality( "Generalized Regression" ),
    Generalized Distribution( "Normal" ),
    Run( Fit( Estimation Method( Lasso( Adaptive ) ), Validation Method( AICc ) ) )
);
obj << (fit[1] << Save Simulation Formula);
rpt = Report( obj );
dtlst = rpt["Parameter Estimates for Original Predictors"][
Number Col Box( "Prob > ChiSquare" )] << Simulate(
    10,
    Out( :weight ),
    In( :weight Simulation Formula )
);
dtlst[2] << Distribution( Y( :height ) );


```

### [Sort By Column](#sort-by-column)

**Syntax:** obj \<< Sort By Column( <column index or title>, \<ascending=0|1> )

**Description:** Sorts all of the rows of the table based on the values in the given column. Default sort order is descending.

```

New Window( "Mountains",
    tb = Table Box(
        String Col Box( "Mountain", {"K2", "Delphi", "Kilimanjaro", "Grand Teton"} ),
        Number Col Box( "Elevation (meters)", {8611, 681, 5895, 4199} ),
        Plot Col Box( "", {8611, 681, 5895, 4199} )
    )
);
tb << Sort By Column( 1 );
Wait( 2 );
tb << Sort By Column( "Elevation (meters)" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Tabulate Box](#tabulate-box)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Tabulate Stacked Columns List](#tabulate-stacked-columns-list)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [Tabulate Stacked List](#tabulate-stacked-list)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TextBox](#textbox)

## [Associated Constructors](#associated-constructors)

### [Text Box](#text-box)

**Syntax:** y = Text Box( text, \<<Justify Text( strPos ), \<<Set Wrap( width ) )

**Description:** Returns a display box that contains text.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );


```

## [Item Messages](#item-messages)

### [Bullet point](#bullet-point)

**Syntax:** obj \<< Bullet point( state=0|1 )

**Description:** Draws a bullet character, which precedes the text.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Bullet Point( 1 );


```

### [Fixed Size](#fixed-size)

**Syntax:** obj \<< Fixed Size( state=0|1, <width>, <height> )

**Description:** If enabled, the TextBox does not expand if the width of the text is greater than the width of the TextBox.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Fixed Size( 1 );
text << Set Text( "Some More Text" );


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Get Base Font;


```

### [Get Bullet](#get-bullet)

**Syntax:** bullet = obj \<< Get Bullet

**Description:** Returns a value indicating whether a bullet character is drawn before the text.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Bullet Point( 1 );
text << Get Bullet;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Hidden State](#get-hidden-state)

**Syntax:** 0|1 = obj \<< Get Hidden State( state=0|1 )

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Hide( 1 );
text << Get Hidden State;


```

### [Get Justify](#get-justify)

**Syntax:** justify = obj \<< Get Justify

**Description:** Left, center, or right justifies the text.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Width( 200 );
text << Get Justify();


```

### [Get Rotation](#get-rotation)

**Syntax:** rotation = obj \<< Get Rotation

**Description:** Returns the rotation of the text.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Get Rotation();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns the string content of the box.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
Print( text << Get Text() );


```

### [Get Tip](#get-tip)

**Syntax:** "string" = obj \<< Get Tip

**Description:** Returns the tooltip of the Text Box.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Tip( "Example Tooltip" );
text << Get Tip();


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the TextBox.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Width( 200 );
text << Justify Text( "right" );
text << Get Width;


```

### [Get Wrap](#get-wrap)

**Syntax:** obj \<< Get Wrap

**Description:** Returns the current wrap point in pixels

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Wrap( 50 );
text << Get Wrap;


```

### [Hide](#hide)

**Syntax:** obj \<< Hide( state=0|1 )

**Description:** Shows or hides the text.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Hide( 1 );


```

### [Justify Text](#justify-text)

**Syntax:** obj \<< Justify Text( "Left"|"Center"|"Right" )

**Description:** Left, center, or right justifies the text.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Width( 200 );
text << Justify Text( "right" );


```

### [Markup](#markup)

**Syntax:** obj \<< Markup( state=0|1 )

**Description:** Indicates that the text might contain HTML markup and should be interpreted. The HTML tags supported are bold (), italic (), underlined(), font face(), font color(), font size(, and background color(). For font color and background color, you can specify the color by name (blue), by hexadecimal triplet, specified in HTML syntax (#0000ff), or hexadecimal format (0x0000ff). If a name specifies a color, the name uses the JMP definition of the color.

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << setText(
    "This is <b>bold</b> text. This is <i>italic</i> text. This is <u>underlined</u> text. This is <b><i><u>bold, italic, underlined</u></i></b> text."
);
text << markup;


```

**Example 2**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << setText(
    "This is <font color='Blue'>blue</font> text. This is a <background color='yellow'>yellow</background> background. This is <font color='#0000ff'><background color='0xffff00'>blue text on a yellow background</background></font>."
);
text << markup;


```

**Example 3**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << setText( "Text using a <font face='Vivaldi'>different</font> font face." );
text << markup;


```

**Example 4**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << setText( "Text using a <font size='16'>different</font> font size." );
text << markup;


```

### [Preprocess Markup](#preprocess-markup)

**Syntax:** obj \<< Preprocess Markup( state=0|1 )

**Description:** Indicates that the text should be preprocessed to replace JMP markup tags with properly formatted HTML tags.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << setText(
    "This is *bold* text. This is ~italic~ text. This is _underlined_ text. This is *~_bold, italic, underlined_~* text."
);
text << markup;
text << preprocess markup;


```

### [Rotate Text](#rotate-text)

**Syntax:** obj \<< Rotate Text( left|right|horizontal )

**Description:** Rotates the text 90 degrees left or right, or returns it to the horizontal.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Rotate Text( "left" );


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Text](#set-text)

**Syntax:** obj \<< Set Text( "string", \<Run Script(bool)> )

**Description:** Changes the string content of the box. For Text Edit Box, an optional Run Script(bool) argument sets whether the Text Edit Box's script is run when Set Text runs. The default value is 0 (does not run the script).

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Text( "New Text" );


```

**Example 2**

```

win = New Window( "Example 2",
    text = Text Edit Box( "Example Text", <<Set SCript( Print( "Changed" ) ) )
);
text << Set Text( "New Text", Run Script( 1 ) );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( text )

**Description:** Sets the tooltip of the Text Box.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Tip( "Example Tooltip" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the TextBox.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Width( 200 );
text << Justify Text( "right" );


```

### [Set Wrap](#set-wrap)

**Syntax:** obj \<< Set Wrap( n )

**Description:** Set the wrap point, in pixels (n).

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set Wrap( 50 );


```

### [SetNLines](#setnlines)

**Syntax:** obj \<< SetNLines( number )

**Description:** Sets the number of lines the text can appear on.

```

win = New Window( "Example", fontobj = text = Text Box( "Example Text" ) );
text << Set N Lines( 3 );
win << Append( Text Box( "More Text" ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TextEditBox](#texteditbox)

## [Associated Constructors](#associated-constructors)

### [Text Edit Box](#text-edit-box)

**Syntax:** y = Text Edit Box( text, \<<Password Style( bool ), \<<Set Script( script ), \<<Set Width( value ) )

**Description:** Returns a display box that contains editable text.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );


```

## [Item Messages](#item-messages)

### [Bullet point](#bullet-point)

**Syntax:** obj \<< Bullet point( state=0|1 )

**Description:** Draws a bullet character, which precedes the text.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Bullet Point( 1 );


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( state=0|1 )

**Description:** Sets if the TextEditBox can be edited.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Enable( 0 );


```

### [Fixed Size](#fixed-size)

**Syntax:** obj \<< Fixed Size( state=0|1, <width>, <height> )

**Description:** If enabled, the TextBox does not expand if the width of the text is greater than the width of the TextBox.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Fixed Size( 1 );
text << Set Text( "Some More Text" );


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Get Base Font;


```

### [Get Bullet](#get-bullet)

**Syntax:** bullet = obj \<< Get Bullet

**Description:** Returns a value indicating whether a bullet character is drawn before the text.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Bullet Point( 1 );
text << Get Bullet;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Get the function that is executed after the text is edited.

```

New Window( "Example",
    teb = Text Edit Box( "pw?",
        <<SetFunction(
            Function( {this},
                this << passwordStyle( 1 );/* hide my display*/ /* put my password into my sibling's display */
                (this << sib) << settext( this << getText );
            )
        )
    ),
    Text Box( "" )/* here's the sibling box, waiting to show the pw */
);
teb << Get Function;


```

### [Get Hidden State](#get-hidden-state)

**Syntax:** 0|1 = obj \<< Get Hidden State( state=0|1 )

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Hide( 1 );
text << Get Hidden State;


```

### [Get Hint](#get-hint)

**Syntax:** "string" = obj \<< Get Hint

**Description:** Text that is displayed as a hint when the Text Box is empty.

```

win = New Window( "Example", text = Text Edit Box( "" ) );
text << Set Hint( "Enter your name" );
text << Get Hint;


```

### [Get Justify](#get-justify)

**Syntax:** justify = obj \<< Get Justify

**Description:** Left, center, or right justifies the text.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Width( 200 );
text << Get Justify();


```

### [Get Rotation](#get-rotation)

**Syntax:** rotation = obj \<< Get Rotation

**Description:** Returns the rotation of the text.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Get Rotation();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns the string content of the box.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
Print( text << Get Text() );


```

### [Get Text Changed](#get-text-changed)

**Syntax:** function = obj \<< Get Text Changed

**Description:** Returns the function that is executed each time a change is made to the text.

```

New Window( "Example",
    teb = Text Edit Box( "Example Text",
        <<Set Text Changed( Function( {this, value}, (this << sib) << settext( value ) ) )
    ),
    Text Box( "" )
);
teb << Get Text Changed;


```

### [Get Tip](#get-tip)

**Syntax:** "string" = obj \<< Get Tip

**Description:** Returns the tooltip of the Text Box.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Tip( "Example Tooltip" );
text << Get Tip();


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the TextBox.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Width( 200 );
text << Justify Text( "right" );
text << Get Width;


```

### [Get Wrap](#get-wrap)

**Syntax:** obj \<< Get Wrap

**Description:** Returns the current wrap point in pixels

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Wrap( 50 );
text << Get Wrap;


```

### [Hide](#hide)

**Syntax:** obj \<< Hide( state=0|1 )

**Description:** Shows or hides the text.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Hide( 1 );


```

### [Is Enabled](#is-enabled)

**Syntax:** obj \<< Is Enabled( state=0|1 )

**Description:** Sets if the TextEditBox can be edited.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Enable( 0 );
text << Is Enabled();


```

### [Justify Text](#justify-text)

**Syntax:** obj \<< Justify Text( "Left"|"Center"|"Right" )

**Description:** Left, center, or right justifies the text.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Width( 200 );
text << Justify Text( "right" );


```

### [Markup](#markup)

**Syntax:** obj \<< Markup( state=0|1 )

**Description:** Indicates that the text might contain HTML markup and should be interpreted. The HTML tags supported are bold (), italic (), underlined(), font face(), font color(), font size(, and background color(). For font color and background color, you can specify the color by name (blue), by hexadecimal triplet, specified in HTML syntax (#0000ff), or hexadecimal format (0x0000ff). If a name specifies a color, the name uses the JMP definition of the color.

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << setText(
    "This is <b>bold</b> text. This is <i>italic</i> text. This is <u>underlined</u> text. This is <b><i><u>bold, italic, underlined</u></i></b> text."
);
text << markup;


```

**Example 2**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << setText(
    "This is <font color='Blue'>blue</font> text. This is a <background color='yellow'>yellow</background> background. This is <font color='#0000ff'><background color='0xffff00'>blue text on a yellow background</background></font>."
);
text << markup;


```

**Example 3**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << setText( "Text using a <font face='Vivaldi'>different</font> font face." );
text << markup;


```

**Example 4**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << setText( "Text using a <font size='16'>different</font> font size." );
text << markup;


```

### [Password Style](#password-style)

**Syntax:** obj \<< Password Style( state=0|1 )

**Description:** If enabled, the TextEditBox shows \*\*\*\*\* instead of passwords.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Password Style( 1 );


```

### [Preprocess Markup](#preprocess-markup)

**Syntax:** obj \<< Preprocess Markup( state=0|1 )

**Description:** Indicates that the text should be preprocessed to replace JMP markup tags with properly formatted HTML tags.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << setText(
    "This is *bold* text. This is ~italic~ text. This is _underlined_ text. This is *~_bold, italic, underlined_~* text."
);
text << markup;
text << preprocess markup;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

**Description:** Restores the text content to its initial value.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Text( "Example" );
Wait( 2 );
text << Revert();


```

### [Rotate Text](#rotate-text)

**Syntax:** obj \<< Rotate Text( left|right|horizontal )

**Description:** Rotates the text 90 degrees left or right, or returns it to the horizontal.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Rotate Text( "left" );


```

### [Script](#script)

**Syntax:** obj \<< Set Script( script ) obj \<< Script( script )

**Description:** After the text is edited, the specified script will execute.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Script( Print( "New Value: " || Char( text << Get Text ) ) );


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Function](#set-function)

**Syntax:** obj \<< Set Function( Function( {thisBox}, <script> ) )

**Description:** Sets the given function for the control. The function's script runs when the change to the Text Edit Box is committed.

```

New Window( "Example",
    Text Edit Box( "pw?",
        <<SetFunction(
            Function( {thisBox},
                thisBox << passwordStyle( 1 );/* hide my display*/ /* put my password into my sibling's display */
                (thisBox << sib) << settext( thisBox << getText );
            )
        )
    ),
    Text Box( "" )/* here's the sibling box, waiting to show the pw */
);


```

### [Set Hint](#set-hint)

**Syntax:** obj \<< Set Hint( "string" )

**Description:** Text that is displayed as a hint when the Text Box is empty.

```

win = New Window( "Example", text = Text Edit Box( "" ) );
text << Set Hint( "Enter your name" );
text << Fixed Size( 0 );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script ) obj \<< Script( script )

**Description:** After the text is edited, the specified script will execute.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Script( Print( "New Value: " || Char( text << Get Text ) ) );


```

### [Set Text](#set-text)

**Syntax:** obj \<< Set Text( "string", \<Run Script(bool)> )

**Description:** Changes the string content of the box. For Text Edit Box, an optional Run Script(bool) argument sets whether the Text Edit Box's script is run when Set Text runs. The default value is 0 (does not run the script).

**Example 1**

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Text( "New Text" );


```

**Example 2**

```

win = New Window( "Example 2",
    text = Text Edit Box( "Example Text", <<Set SCript( Print( "Changed" ) ) )
);
text << Set Text( "New Text", Run Script( 1 ) );


```

### [Set Text Changed](#set-text-changed)

**Syntax:** obj \<< Set Text Changed( Function( {this, value}, <script> ) )

**Description:** Sets the function that is executed each time a change is made to the text. This callback is called during editing before the change is committed. In the case of a canceled Edit operation, an additional callback will be generated to provide the original value.

```

New Window( "Example",
    Text Edit Box( "Example Text",
        <<Set Text Changed( Function( {this, value}, (this << sib) << settext( value ) ) )
    ),
    Text Box( "" )
);


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( text )

**Description:** Sets the tooltip of the Text Box.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Tip( "Example Tooltip" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the TextBox.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Width( 200 );
text << Justify Text( "right" );


```

### [Set Wrap](#set-wrap)

**Syntax:** obj \<< Set Wrap( n )

**Description:** Set the wrap point, in pixels (n).

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set Wrap( 50 );


```

### [SetNLines](#setnlines)

**Syntax:** obj \<< SetNLines( number )

**Description:** Sets the number of lines the text can appear on.

```

win = New Window( "Example", fontobj = text = Text Edit Box( "Example Text" ) );
text << Set N Lines( 3 );
win << Append( Text Box( "More Text" ) );


```

### [White Box Style](#white-box-style)

**Syntax:** obj \<< White Box Style( 0=ordinary text, 1=bordered white box entry field )

**Description:** Whether to appear as an entry field with the text inside a bordered white box, or just plain text that you can click to edit

```

New Window( "Example", Text Edit Box( "Example Text", <<White Box Style( 0 ) ) );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TextSeg](#textseg)

## [Associated Constructors](#associated-constructors)

### [Text Seg](#text-seg)

**Syntax:** seg = Text Seg("text")

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Fill Color( "Green" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Frame;


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Get Base Font;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fill Color](#get-fill-color)

**Syntax:** color = obj \<< Get Fill Color

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Fill Color;


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Fill Pattern;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Gradient Transparency;


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Line Width;


```

### [Get Location](#get-location)

**Syntax:** obj \<< Get Location

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( ts = Text Seg( "moves with axes" ) );
ts << set location( 60, 60 );
ts << get location();


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Marker Size;


```

### [Get Relative](#get-relative)

**Syntax:** obj \<< Get Relative

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "fixed bottom left" ) );
seg << set location( 0, 1 );
seg << set relative( 1, 1 );
seg << get relative();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns the string used by the text seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements(
        Points( X, Y, Legend( 1 ), Jitter( 1 ) ),
        Line Of Fit(
            X,
            Y,
            Legend( 4 ),
            Confidence of Fit( 1 ),
            Confidence of Prediction( 1 ),
            Degree( "Cubic" ),
            Equation( 1 ),
            Root Mean Square Error( 1 ),
            R²( 0 )
        )
    )
);
fontobj = seg = Report( gb )[Framebox( 1 )] << Find Seg( "TextSeg" );
seg << Get Text;


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Get Text Color

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Text Color;


```

### [Get Text Style](#get-text-style)

**Syntax:** obj \<< Get Text Style

**Description:** Gets how the text is drawn with respect to the cursor pen.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Get Text Style;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 (clear) and 1 (opaque).

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Get Transparency;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Gradient Transparency( "None" );


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Parent;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Revert;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Line Width( 3 );


```

### [Set Location](#set-location)

**Syntax:** obj \<< Set Location

**Description:** Sets the location of the text. If Relative is set, the 0,0 will be the top left and 1,1 will be the bottom right. If Relative is not set, then the coordinates will be relative to the axes.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "fixed bottom left" ) );
seg << set location( 0, 1 );
seg << set relative( 1, 1 );
w[FrameBox( 1 )] << append seg( ts2 = Text Seg( "moves with axes" ) );
ts2 << set location( 60, 60 );
ts2 << get location();


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Relative](#set-relative)

**Syntax:** obj \<< Set Relative( 0|1,0|1 )

**Description:** A value of 0 means the x or y coordinate will be relative to the frame box and a value of 1 means the x or y value will be relative to the axes. When relative is set to 0, the x and y coordinates will map from 0,0 to 1,1 for the top left to bottom right of the graph box.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "fixed bottom left" ) );
seg << set location( 0, 1 );
seg << set relative( 1, 1 );
w[FrameBox( 1 )] << append seg( ts2 = Text Seg( "moves with axes" ) );
ts2 << set location( 60, 60 );


```

### [Set Text](#set-text)

**Syntax:** obj \<< Set Text( text )

**Description:** Sets the string used by the text seg.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
gb = Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements(
        Points( X, Y, Legend( 1 ), Jitter( 1 ) ),
        Line Of Fit(
            X,
            Y,
            Legend( 4 ),
            Confidence of Fit( 1 ),
            Confidence of Prediction( 1 ),
            Degree( "Cubic" ),
            Equation( 1 ),
            Root Mean Square Error( 1 ),
            R²( 0 )
        )
    )
);
g = Report( gb );
fontobj = seg = g[Framebox( 1 )] << Find Seg( "TextSeg" );
seg << Get Text;
seg << Set Text( seg << Get Text || "  Tallest: Lawrence" );


```

### [Set Text Alignment](#set-text-alignment)

**Syntax:** obj \<< Set Text Alignment( left|center|right,\<top|center|bottom> )

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "center" ) );
seg << set relative( 1, 1 );
seg << set location( .5, .5 );
seg << set text alignment( center, center );


```

### [Set Text Color](#set-text-color)

**Syntax:** obj \<< Set Text Color( color )

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Text Color( "Green" );


```

### [Set Text Style](#set-text-style)

**Syntax:** obj \<< Set Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Transparency( .3 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color )

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Text Color( "Green" );


```

### [Text Style](#text-style)

**Syntax:** obj \<< Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

w = New Window( "test", Graph Box( FrameSize( 400, 400 ), ) );
w[FrameBox( 1 )] << append seg( seg = Text Seg( "default location fixed bottom left" ) );
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [TextTruncatorBox](#texttruncatorbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TreeBox](#treebox)

## [Associated Constructors](#associated-constructors)

### [Tree Box](#tree-box)

**Syntax:** tree = Tree Box( \<{rootnodes}>, \<Size( x, y )>, \<Multiselect( 0|1 )> )

**Description:** Returns a display box to show a hierarchical tree. By default, a single item can be selected. If multiselect is specified, more than one item in the tree can be selected.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );


```

## [Item Messages](#item-messages)

### [Add Root](#add-root)

**Syntax:** obj \<< Add Root( node )

**Description:** Add a root node to the tree

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Add Root( Tree Node( "New Root" ) );
Print( (tree << Get Roots) << Get Label );


```

### [Clear Selection](#clear-selection)

**Syntax:** obj \<< Clear Selection

**Description:** Clears the current selection; the items are still there, but are no longer selected.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Selected( root1 );
Wait( 1 );
tree << Clear Selection;


```

### [Collapse](#collapse)

**Syntax:** obj \<< Collapse( node )

**Description:** Collapse the node in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Wait( 0 );
tree << expand( root1 );
Wait( 1 );
tree << Collapse( root1 );


```

### [Enable](#enable)

**Syntax:** obj \<< Enable( 0|1 )

**Description:** Sets this control to be enabled (1) or disabled (0).

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);


```

### [Enable Item](#enable-item)

**Syntax:** obj \<< Enable Item( node, 0|1 )

**Description:** Enable or Disable the node in the tree. Set state to 1 to enable the node. Set state to 0 to disable the node.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Enable Item( root1, 0 );


```

### [Expand](#expand)

**Syntax:** obj \<< Expand( node )

**Description:** Expand the node in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Wait( 0 );
tree << expand( root1 );


```

### [Get Context Menu Script](#get-context-menu-script)

**Syntax:** script = obj \<< Get Context Menu Script

**Description:** Returns the script, function, or method that runs when user right-clicks on the tree or a tree node.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Context Menu Script(
    Function( {thistree, thisnode},
        If( Is Empty( thisnode ),
            {  /*Whole Tree Menu*/ {"Tree Menu", "", Function( {tree, node}, /*dont use node*/
                Print( "Tree one" )
            )}, {"", "separator", ""}, {"Tree - Menu 2", "",
            Function( {tree, node}, /*dont use node*/Print( "Tree two" )
            )}}
        ,
            {  /*node menu*/{"Rename", "", Function( {tree, node},
                node << Set Label( "New Name" )
            )}, {"Add Child", "", Function( {tree, node},
                node << append( Tree Node( "Added" ) )
            )}}
        )
    )
);
Show( tree << Get Context Menu Script );


```

### [Get Function](#get-function)

**Syntax:** obj \<< Get Function

**Description:** Returns the function or script set for the control, if any.

```

//This message applies to many display box objects
New Window( "Example",
    bb = Button Box( "press me",
        <<setFunction(
            Function( {this/* functions specified with SetFunction get 'this' display box */},
                this << setButtonName( "thanks" )
            )
        )
    )
);
bb << Get Function;


```

### [Get Node Double Click Script](#get-node-double-click-script)

**Syntax:** script = obj \<< Get Node Double Click Script

**Description:** Returns the script, function, or method that runs when a node is double-clicked.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Node Double Click Script(
    Function( {thistree, thisnode},
        Print( thisnode << get label )
    )
);
Show( tree << Get Node Double Click Script );


```

### [Get Node Select Script](#get-node-select-script)

**Syntax:** obj \<< Get Node Select Script( script|Function( {thistree, thisnode}, <script> ) )

**Description:** Returns the script, function, or method that runs when selection changes in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Node Select Script(
    Function( {thistree, thisnode},
        If( !Is Empty( thisnode ),
            Print( thisnode << get label )
        )
    )
);
Show( tree << Get Node Select Script );


```

### [Get Roots](#get-roots)

**Syntax:** obj \<< Get Roots

**Description:** Get list of root tree nodes. If no roots are present, an empty list is returned.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
rootList = tree << Get Roots;
Print( rootList << Get Label );


```

### [Get Selected](#get-selected)

**Syntax:** index = obj \<< Get Selected

**Description:** For a single-select tree, gets the selected tree node or Empty if no node is selected. For a multi-select tree, gets a list of the selected nodes or Empty if no node is selected.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Selected( root1 );
sel = tree << Get Selected;
Print( sel );


```

### [Is Collapsed](#is-collapsed)

**Syntax:** collapsed = obj \<< Is Collapsed( node )

**Description:** Returns true if the node is collapsed in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Wait( 0 );
tree << expand( root1 );
Show( tree << Is Collapsed( root1 ) );
Show( tree << Is Collapsed( root2 ) );


```

### [Is Enabled](#is-enabled)

**Syntax:** 0|1 = obj \<< Is Enabled

**Description:** Returns the enabled state of the control

```

//This message applies to many display box objects
New Window( "Example",
    cb1 = Check Box( "Mother", cb2 << Enable( cb1 << Get() ) ),
    cb2 = Check Box( "Grandmother", <<Enable( 0 ) )
);
cb2 << Is Enabled();


```

### [Is Expanded](#is-expanded)

**Syntax:** expanded = obj \<< Is Expanded( node )

**Description:** Returns true if the node is expanded in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Wait( 0 );
tree << expand( root1 );
Show( tree << Is Expanded( root1 ) );
Show( tree << Is Expanded( root2 ) );


```

### [Is Item Enabled](#is-item-enabled)

**Syntax:** enabled = obj \<< Is Item Enabled( node )

**Description:** Returns true if the node is enabled in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Wait( 0 );
Show( tree << Is Item Enabled( root1 ) );


```

### [Is Multiselect](#is-multiselect)

**Syntax:** obj \<< Is Multiselect

**Description:** Returns 1 if the tree is multi-select. Returns 0 if tree is single-select.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Print( tree << Is Multiselect );


```

### [Is Root](#is-root)

**Syntax:** obj \<< Is Root( node )

**Description:** Returns true if the node is a root node in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Show( tree << Is Root( c1 ) );
Show( tree << Is Root( root2 ) );


```

### [Is Selected](#is-selected)

**Syntax:** selected = obj \<< Is Selected( node )

**Description:** Returns true if the node is selected in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Selected( root1 );
Show( tree << Is Selected( root1 ) );
Show( tree << Is Selected( c1 ) );


```

### [Make Visible](#make-visible)

**Syntax:** obj \<< Make Visible( node )

**Description:** Bring the node into view within the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Make Visible( c3 );


```

### [Remove Root](#remove-root)

**Syntax:** obj \<< Remove Root( node )

**Description:** Remove a root node from the tree

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Remove Root( root2 );
Print( (tree << Get Roots) << Get Label );


```

### [Set Context Menu Script](#set-context-menu-script)

**Syntax:** obj \<< Set Context Menu Script( Function( {thistree, thisnode}, <script> ) )

**Description:** Set the script, function, or method to run when user right-clicks on the tree or a tree node.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Context Menu Script(
    Function( {thistree, thisnode},
        If( Is Empty( thisnode ),
            {  /*Whole Tree Menu*/ {"Tree Menu", "", Function( {tree, node}, /*dont use node*/
                Print( "Tree one" )
            )}, {"", "separator", ""}, {"Tree - Menu 2", "",
            Function( {tree, node}, /*dont use node*/Print( "Tree two" )
            )}}
        ,
            {  /*node menu*/{"Rename", "", Function( {tree, node},
                node << Set Label( "New Name" )
            )}, {"Add Child", "", Function( {tree, node},
                node << append( Tree Node( "Added" ) )
            )}}
        )
    )
);


```

### [Set Multiselect](#set-multiselect)

**Syntax:** obj \<< Set Multiselect( state=0|1 )

**Description:** Set the tree to be single-select (0) or multi-select (1).

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Multiselect( 1 );


```

### [Set Node Double Click Script](#set-node-double-click-script)

**Syntax:** obj \<< Set Node Double Click Script( script )

**Description:** Set the script, function, or method to run when a node is double-clicked.

**Example 1**

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Node Double Click Script( Beep() );


```

**Example 2**

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Node Double Click Script(
    Function( {thistree, thisnode},
        Print( thisnode << get label )
    )
);


```

### [Set Node Select Script](#set-node-select-script)

**Syntax:** obj \<< Set Node Select Script( script|Function( {thistree, thisnode}, <script> ) )

**Description:** Set the script, function, or method to run when selection changes in the tree. Empty is passed to the script if selection was cleared

**Example 1**

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Node Select Script( Beep() );


```

**Example 2**

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Node Select Script(
    Function( {thistree, thisnode},
        If( !Is Empty( thisnode ),
            Print( thisnode << get label )
        )
    )
);


```

### [Set Roots](#set-roots)

**Syntax:** obj \<< Set Roots( roots )

**Description:** Set the list of root nodes shown in the tree.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Wait( 1 );
rootList = {Tree Node( "One" ), Tree Node( "Two" )};
tree << Set Roots( rootList );
Print( (tree << Get Roots) << Get Label );


```

### [Set Script](#set-script)

**Syntax:** obj \<< Set Script( script )

**Description:** Sets the given script to run when the control is clicked.

**JMP Version Added:** 16

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Set Script( Print( "Pressed." ) );


```

### [Set Selected](#set-selected)

**Syntax:** obj \<< Set Selected( node|{nodes}, \<0|1> )

**Description:** Selects the given tree node in the tree display box. If a list of tree nodes is used, multi-select trees will select all nodes in the list. If a list of tree nodes is used, single-select trees will select the first node in the list.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
tree << Set Selected( root1 );


```

### [Set Size](#set-size)

**Syntax:** obj \<< Set Size( width,height )

**Description:** Sets the width and height of the box.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );

c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );

root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );

New Window( "TreeBox Tests", tree = Tree Box( {root1, root2}, Size( 300, 200 ) ) );
Wait( 1 );
tree << Set Size( 400, 300 );


```

### [Set Tip](#set-tip)

**Syntax:** obj \<< Set Tip( tip )

**Description:** Sets the text to be displayed as a tooltip when the mouse hovers over the control.

```

//This message applies to many display box objects
New Window( "Example", ex = Button Box( "Hover Me", Print( "Pressed." ) ) );
ex << Set Tip( "Print message to log" );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get User Resizable](#get-user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [User Resizable](#user-resizable)

**Syntax:** obj \<< User Resizable; obj \<< Get User Resizable

**Description:** If the box is user resizable, the cursor will change near the bottom and right edges to allow drag-and-drop resizing.

```

root1 = Tree Node( "Parent 1" );
root2 = Tree Node( "Parent 2" );
c1 = Tree Node( "Child 1" );
c2 = Tree Node( "Child 2" );
c3 = Tree Node( "Child 3" );
c4 = Tree Node( "Child 4" );
root1 << Append( c1 );
root1 << Append( c2 );
root2 << Append( c3 );
root2 << Append( c4 );
New Window( "resize",
    H Splitter Box(
        Size( 600, 200 ),
        tree = Tree Box( {root1, root2} ),
        scroll = Scroll Box(
            Size( 300, 200 ),
            Picture Box( Open( "$SAMPLE_IMAGES/tile.jpg", jpg ) )
        )
    )
);
tree << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
scroll << Set Stretch( "Window", "Window" ) << Set Max Size( 10000, 10000 );
Wait( 2 );
tree << User Resizable( {0, 0} );
scroll << User Resizable( {0, 0} );


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TreeMapBox](#treemapbox)

## [Item Messages](#item-messages)

### [Frame Size](#frame-size)

**Syntax:** obj \<< Frame Size( width,height )

**Description:** Sets the frame size of the TreeMapBox.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
tm = Treemap( Categories( :city ), Sizes( :POP ) );
tmr = tm << report;
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
tmbox = If( prefVal == 1,
    tmr[FrameBox( 1 )],
    tmr[Treemap Box( 1 )]
);
tmbox << Frame Size( 200, 200 );


```

### [Group Label Background](#group-label-background)

**Syntax:** obj \<< Group Label Background( transparency )

**Description:** Sets the transparency of the background for group labels.

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
Treemap(
    Categories( :city, :State ),
    Sizes( :POP ),
    SendToReport( Dispatch( {}, "", TreeMapBox, {Group Label Background( 0.25 )} ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
tm = Treemap( Categories( :city, :State ), Sizes( :POP ) );
tmr = tm << report;
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    tmr << Dispatch( {}, "Graph Builder", FrameBox,
        {DispatchSeg( Treemap Seg( 1 ), {Group Label Background( 1 )} )}
    ),
    tmbox = tmr[Treemap Box( 1 )];
    tmbox << Group Label Background( 1 );
);


```

### [Ignore Group Hierarchy](#ignore-group-hierarchy)

**Syntax:** obj \<< Ignore Group Hierarchy( state=0|1 )

**Description:** If more than one category is specified, the categories are grouped. If this message is enabled, the group hierarchy is ignored.

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
Treemap(
    Categories( :city, :State ),
    Sizes( :POP ),
    SendToReport( Dispatch( {}, "", TreeMapBox, {Ignore Group Hierarchy( 1 )} ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
tm = Treemap( Categories( :city, :State ), Sizes( :POP ) );
tmr = tm << report;
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    tmr << Dispatch( {}, "Graph Builder", FrameBox,
        {DispatchSeg( Treemap Seg( 1 ), {Ignore Group Hierarchy( 1 )} )}
    ),
    tmbox = tmr[Treemap Box( 1 )];
    tmbox << Ignore Group Hierarchy( 1 );
);


```

### [Show Group Labels](#show-group-labels)

**Syntax:** obj \<< Show Group Labels( state=0|1 )

**Description:** If disabled, group labels are not shown. On by default.

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
Treemap(
    Categories( :city, :State ),
    Sizes( :POP ),
    SendToReport( Dispatch( {}, "", TreeMapBox, {Show Group Labels( 0 )} ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
tm = Treemap( Categories( :city, :State ), Sizes( :POP ) );
tmr = tm << report;
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    tmr << Dispatch( {}, "Graph Builder", FrameBox,
        {DispatchSeg( Treemap Seg( 1 ), {Show Group Labels( 0 )} )}
    ),
    tmbox = tmr[Treemap Box( 1 )];
    tmbox << Show Group Labels( 0 );
);


```

### [Show Labels](#show-labels)

**Syntax:** obj \<< Show Labels( state=0|1 )

**Description:** If disabled, labels are not shown. On by default.

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
Treemap(
    Categories( :city, :State ),
    Sizes( :POP ),
    SendToReport( Dispatch( {}, "", TreeMapBox, {Show  Labels( 0 )} ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
tm = Treemap( Categories( :city, :State ), Sizes( :POP ) );
tmr = tm << report;
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    tmr << Dispatch( {}, "Graph Builder", FrameBox,
        {DispatchSeg( Treemap Seg( 1 ), {Show Labels( 0 )} )}
    ),
    tmbox = tmr[Treemap Box( 1 )];
    tmbox << Show Labels( 0 );
);


```

### [Suppress Box Frames](#suppress-box-frames)

**Syntax:** obj \<< Suppress Box Frames( state=0|1 )

**Description:** If enabled, the box frames are not shown.

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
Treemap(
    Categories( :city, :State ),
    Sizes( :POP ),
    SendToReport( Dispatch( {}, "", TreeMapBox, {Suppress Box Frames( 1 )} ) )
);


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
tm = Treemap( Categories( :city ), Sizes( :POP ) );
tmr = tm << report;
treemapGBPref = Get Platform Preference( treemap( "Use Graph Builder" ) );
prefVal = Arg( Arg( Arg( treemapGBPref, 1 ) ) );
If( prefVal == 1,
    tmr << Dispatch( {}, "Graph Builder", FrameBox,
        {DispatchSeg( Treemap Seg( 1 ), {Suppress Box Frames( 1 )} )}
    ),
    tmbox = tmr[Treemap Box( 1 )];
    tmbox << Suppress Box Frames( 1 );
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [TreeMapSeg](#treemapseg)

## [Associated Constructors](#associated-constructors)

### [Treemap](#treemap)

**Syntax:** Treemap

**Description:** Shows a response summarized by many categories.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));


```

## [Item Messages](#item-messages)

### [Child](#child)

**Syntax:** seg2 = obj \<< Child

**Description:** Returns the first child of the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Child; // not many segs support children


```

### [Class Name](#class-name)

**Syntax:** classname = obj \<< Class Name

**Description:** Returns the name of the display class for the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Class Name;


```

### [Clip Shape](#clip-shape)

**Syntax:** seg \<< Clip Shape(Boundaries(Shape File, [ID(string)]) | Path([string] | [matrix]) | Empty())

**Description:** Clips the geometry by the given shape. The shape can be specified using a shape file or a path. An optional ID can be specified with a shape file to select a single shape from the file, otherwise the union of all shapes is used as the clipping region. A clipping path can be specified with an N x 3 matrix or with a text representation. A path matrix has three columns for x, y, and flags for each point in the path. The flag values are 0 for control, 1 for move, 2 for line segment, 3 for cubic Bézier segment, and are negative if the point also closes the path. Path text supports SVG syntax.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
Wait( 2 );
cs << Clip Shape( Boundaries( "US States" ) );


```

### [Color Theme](#color-theme)

**Syntax:** obj \<< Color Theme

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Delete the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Delete;


```

### [Density Gradient](#density-gradient)

**Syntax:** obj \<< Density Gradient( "Fade to White"|"Fade To Gray"|"Full Color"="Fade to White" )

**Description:** Sets the coloring behavior of density gradients. "Fade to White" by default.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Density Gradient( "Fade to Gray" );


```

### [Error Bar Cap](#error-bar-cap)

**Syntax:** obj \<< Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Error Bar Cap Shape](#error-bar-cap-shape)

**Syntax:** obj \<< Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Fill Color](#fill-color)

**Syntax:** obj \<< Fill Color( color )

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Fill Color( "Green" );


```

### [First Value](#first-value)

**Syntax:** obj \<< First Value( state=0|1 )

**JMP Version Added:** 16

### [Frame](#frame)

**Syntax:** FrameBox = obj \<< Frame

**Description:** Returns the frame box that the display seg is in.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Frame;


```

### [Get Base Font](#get-base-font)

**Syntax:** font = obj \<< Get Base Font

**Description:** Returns the base font used for text drawn by the box. Base fonts are predefined names such as Title, Text, Annotation, and others, which are specified in the Preferences for fonts.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Get Base Font;


```

### [Get Clip Shape](#get-clip-shape)

**Syntax:** obj \<< Get Clip Shape

**Description:** Returns the current clipping shape

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Size( 653, 396 ),
    Show Control Panel( 0 ),
    Variables( X( :Longitude ), Y( :Latitude ) ),
    Elements( Contour( X, Y, Legend( 2 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Background Map( Boundaries( "US States" ) ), Grid Line Order( 2 ),
            Reference Line Order( 3 )}
        )
    )
);
cs = (gb << Report)[FrameBox( 1 )] << Find Seg( Contour Seg( 1 ) );
cs << Clip Shape( Boundaries( "US States" ) );
Wait( 2 );
cs << Get Clip Shape();


```

### [Get Density Gradient](#get-density-gradient)

**Syntax:** obj \<< Get Density Gradient

**Description:** Gets the coloring behavior of density gradients.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Density Gradient;


```

### [Get Description](#get-description)

**Syntax:** description = obj \<< Get Description

**Description:** Gets the description for the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << get description();


```

### [Get Error Bar Cap](#get-error-bar-cap)

**Syntax:** obj \<< Get Error Bar Cap

**Description:** Returns the current kind of error bar end cap.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap();


```

### [Get Error Bar Cap Shape](#get-error-bar-cap-shape)

**Syntax:** { begin, end } = obj \<< Get Error Bar Cap Shape

**Description:** Returns the shape of the end cap on error bars.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Error Bar Cap Shape();


```

### [Get Fill Color](#get-fill-color)

**Syntax:** color = obj \<< Get Fill Color

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Fill Color;


```

### [Get Fill Pattern](#get-fill-pattern)

**Syntax:** obj \<< Get Fill Pattern

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Fill Pattern;


```

### [Get Font](#get-font)

**Syntax:** obj \<< Get Font

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Get Font;


```

### [Get Font Name](#get-font-name)

**Syntax:** obj \<< Get Font Name

**Description:** Returns the name of the font.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font Name( "Times New Roman" );
fontobj << Get Font Name;


```

### [Get Font Scale](#get-font-scale)

**Syntax:** obj \<< Get Font Scale

**Description:** Returns the current scale factor for font.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Get Font Scale;


```

### [Get Font Size](#get-font-size)

**Syntax:** obj \<< Get Font Size

**Description:** Returns the size of the font.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Get Font Size;


```

### [Get Font Style](#get-font-style)

**Syntax:** obj \<< Get Font Style

**Description:** Returns the font style name.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font Name( "Arial" );
fontobj << Set Font Style( "Italic" );
fontobj << Get Font Style;


```

### [Get Gradient](#get-gradient)

**Syntax:** obj \<< Get Gradient

**Description:** Gets the coloring gradient.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient;


```

### [Get Gradient Color Theme](#get-gradient-color-theme)

**Syntax:** obj \<< Get Gradient Color Theme

**Description:** Gets the gradient's color theme.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Color Theme;


```

### [Get Gradient Discrete Colors](#get-gradient-discrete-colors)

**Syntax:** obj \<< Get Gradient Discrete Colors

**Description:** Gets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Discrete Colors;


```

### [Get Gradient Fill](#get-gradient-fill)

**Syntax:** obj \<< Get Gradient Fill

**Description:** Gets the coloring behavior for values outside of the range of the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Fill;


```

### [Get Gradient Label Count](#get-gradient-label-count)

**Syntax:** obj \<< Get Gradient Label Count

**Description:** Gets the number of labels in a gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Label Count;


```

### [Get Gradient Label Levels](#get-gradient-label-levels)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Label Levels

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Legend Horizontal](#get-gradient-legend-horizontal)

**Syntax:** obj \<< Get Gradient Legend Horizontal

**Description:** Gets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Legend Horizontal;


```

### [Get Gradient Legend Label Format](#get-gradient-legend-label-format)

**Syntax:** obj \<< Get Gradient Legend Label Format

**Description:** Gets the format for gradient legend labels

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Legend Label Format;


```

### [Get Gradient Legend Label Width](#get-gradient-legend-label-width)

**Syntax:** obj \<< Get Gradient Legend Label Width

**Description:** Gets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Legend Label Width;


```

### [Get Gradient Legend Show Labels](#get-gradient-legend-show-labels)

**Syntax:** obj \<< Get Gradient Legend Show Labels

**Description:** Gets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Legend Show Labels;


```

### [Get Gradient Level Count](#get-gradient-level-count)

**Syntax:** obj \<< Get Gradient Level Count

**Description:** Gets the number of levels in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Levels;


```

### [Get Gradient Lightness Range](#get-gradient-lightness-range)

**Syntax:** obj \<< Get Gradient Lightness Range

**Description:** Gets the minimum and maximum lightness for level colors in a gradient. Missing values indicate that the color theme's original value is used.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Lightness Range;


```

### [Get Gradient Range](#get-gradient-range)

**Syntax:** obj \<< Get Gradient Range

**Description:** Gets the range over which non-custom gradient scales are generated.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Range;


```

### [Get Gradient Reverse Color Order](#get-gradient-reverse-color-order)

**Syntax:** obj \<< Get Gradient Reverse Color Order

**Description:** Gets if the order of colors in a gradient is reversed.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Reverse Color Order;


```

### [Get Gradient Reverse Label Order](#get-gradient-reverse-label-order)

**Syntax:** obj \<< Get Gradient Reverse Label Order

**Description:** Gets if the order of labels in a gradient is reversed.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Reverse Label Order;


```

### [Get Gradient Scale](#get-gradient-scale)

**Syntax:** obj \<< Get Gradient Scale

**Description:** Gets the gradient scale type.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale;


```

### [Get Gradient Scale Values](#get-gradient-scale-values)

**Syntax:** [value1,value1, ... value N] = obj \<< Get Gradient Scale Values

**Description:** Gets the set of values used for labels in the gradient's scale.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Get Gradient Scale Values;


```

**Example 2**

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 100] );
seg << Get Gradient Scale Values;


```

### [Get Gradient Show Missing](#get-gradient-show-missing)

**Syntax:** obj \<< Get Gradient Show Missing

**Description:** Gets when to show the legend entry for missing values.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Show Missing;


```

### [Get Gradient Transparency](#get-gradient-transparency)

**Syntax:** obj \<< Get Gradient Transparency

**Description:** Gets the transparency behavior of gradients.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Gradient Transparency;


```

### [Get Group Label Border Color](#get-group-label-border-color)

**Syntax:** color = obj \<< Get Group Label Border Color

**Description:** Gets the floating group label border color.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Group Label Border Color();


```

### [Get Group Label Color](#get-group-label-color)

**Syntax:** color = obj \<< Get Group Label Color

**Description:** Gets the floating group label fill color.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Group Label Color();


```

### [Get Group Label Font](#get-group-label-font)

**Syntax:** font = obj \<< Get Group Label Font

**Description:** Gets the group label font.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Group Label Font();


```

### [Get Group Label Font Color](#get-group-label-font-color)

**Syntax:** color = obj \<< Get Group Label Font Color

**Description:** Gets the group label font color.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Group Label Font Color();


```

### [Get Group Spacing](#get-group-spacing)

**Syntax:** obj \<< Get Group Spacing

**Description:** Returns the amount of space around group tiles.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Group Spacing();


```

### [Get Interval Draw Directions](#get-interval-draw-directions)

**Syntax:** obj \<< Get Interval Draw Directions

**Description:** Gets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Get Interval Draw Directions;


```

### [Get Line Color](#get-line-color)

**Syntax:** color = obj \<< Get Line Color

**Description:** Returns the color of the lines.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Line Color;


```

### [Get Line Style](#get-line-style)

**Syntax:** pen style = obj \<< Get Line Style

**Description:** Returns the style of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Line Style;


```

### [Get Line Width](#get-line-width)

**Syntax:** number = obj \<< Get Line Width

**Description:** Returns the width of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Line Width;


```

### [Get Marker](#get-marker)

**Syntax:** marker = obj \<< Get Marker

**Description:** Returns the marker style.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Marker;


```

### [Get Marker Size](#get-marker-size)

**Syntax:** size = obj \<< Get Marker Size

**Description:** Returns the size of the markers.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Marker Size;


```

### [Get Orientation Bias](#get-orientation-bias)

**Syntax:** bias = obj \<< Get Orientation Bias

**Description:** Gets the relative preference of horizontal vs. vertical area splitting.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/SATByYear.jmp" );
gb = Graph Builder( Variables( X( :State ), Size( :Population ) ), Elements( Treemap( X ) ) );
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Orientation Bias();


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Get Text Color

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Text Color;


```

### [Get Text Style](#get-text-style)

**Syntax:** obj \<< Get Text Style

**Description:** Gets how the text is drawn with respect to the cursor pen.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Get Text Style;


```

### [Get Transparency](#get-transparency)

**Syntax:** obj \<< Get Transparency

**Description:** Returns a numeric value representing transparency between 0 (clear) and 1 (opaque).

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Get Transparency;


```

### [Gradient](#gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Gradient Color Theme](#gradient-color-theme)

**Syntax:** obj \<< Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Gradient Discrete Colors](#gradient-discrete-colors)

**Syntax:** obj \<< Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Gradient Fill](#gradient-fill)

**Syntax:** obj \<< Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Gradient Label Count](#gradient-label-count)

**Syntax:** obj \<< Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Label Count( 8 );


```

### [Gradient Label Levels](#gradient-label-levels)

**Syntax:** obj \<< Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Legend Horizontal](#gradient-legend-horizontal)

**Syntax:** obj \<< Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Gradient Legend Label Format](#gradient-legend-label-format)

**Syntax:** obj \<< Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Gradient Legend Label Width](#gradient-legend-label-width)

**Syntax:** obj \<< Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Gradient Legend Show Labels](#gradient-legend-show-labels)

**Syntax:** obj \<< Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Gradient Level Count](#gradient-level-count)

**Syntax:** obj \<< Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Levels( 7 );


```

### [Gradient Lightness Range](#gradient-lightness-range)

**Syntax:** obj \<< Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Gradient Range](#gradient-range)

**Syntax:** obj \<< Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Gradient Reverse Color Order](#gradient-reverse-color-order)

**Syntax:** obj \<< Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Gradient Reverse Label Order](#gradient-reverse-label-order)

**Syntax:** obj \<< Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Gradient Scale](#gradient-scale)

**Syntax:** obj \<< Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Gradient Scale Values](#gradient-scale-values)

**Syntax:** obj \<< Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Gradient Show Missing](#gradient-show-missing)

**Syntax:** obj \<< Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Gradient Transparency](#gradient-transparency)

**Syntax:** obj \<< Gradient Transparency( "None"|"Linear"="Linear" )

**Description:** Sets the transparency behavior of gradients. "Linear" by default.

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Gradient Transparency( "None" );


```

### [Group Label Background](#group-label-background)

**Syntax:** obj \<< Group Label Background( transparency )

**Description:** Sets the transparency of the background for group labels.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
gb = Graph Builder(
    Variables( X( :season ), X( :species, Position( 1 ) ), Color( :miles ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 8 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( Treemap Seg( 1 ) ));
seg << Group Label Background( 0.4 );


```

### [Ignore Group Hierarchy](#ignore-group-hierarchy)

**Syntax:** obj \<< Ignore Group Hierarchy( state=0|1 )

**Description:** If more than one category is specified, the categories are grouped. If this message is enabled, the group hierarchy is ignored.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
gb = Graph Builder(
    Variables( X( :season ), X( :species, Position( 1 ) ), Color( :miles ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 8 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( Treemap Seg( 1 ) ));
seg << Ignore Group Hierarchy( 1 );


```

### [Last Value](#last-value)

**Syntax:** obj \<< Last Value( state=0|1 )

**JMP Version Added:** 16

### [Line Color](#line-color)

**Syntax:** obj \<< Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Line Color( "Green" );


```

### [Line Style](#line-style)

**Syntax:** obj \<< Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Line Style( "Dotted" );


```

### [Line Width](#line-width)

**Syntax:** obj \<< Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Line Width( 3 );


```

### [Marker](#marker)

**Syntax:** obj \<< Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Marker( "Square" );


```

### [Marker Size](#marker-size)

**Syntax:** obj \<< Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Max Value](#max-value)

**Syntax:** obj \<< Max Value( state=0|1 )

**JMP Version Added:** 16

### [Min Value](#min-value)

**Syntax:** obj \<< Min Value( state=0|1 )

**JMP Version Added:** 16

### [Name](#name)

**Syntax:** obj \<< Name( state=0|1 )

**JMP Version Added:** 16

### [Parent](#parent)

**Syntax:** seg2 = obj \<< Parent

**Description:** Returns the parent of the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Parent;


```

### [Revert](#revert)

**Syntax:** obj \<< Revert

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Revert;


```

### [Set Base Font](#set-base-font)

**Syntax:** obj \<< Set Base Font( "Text"|"Heading"|"Title"|"Small"|"Mono"|"Formula Editor"|"Annotation"|"Axis"|"Marker"|"Axis Title"|"Graph Label"|"Legend"|"Graph Title"|"Caption"|"Data Table"|"Hover Label" )

**Description:** Sets the base font for text drawn by the box.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
Wait( 2 );
fontobj << Set Base Font( "Title" );


```

### [Set Description](#set-description)

**Syntax:** obj \<< Set Description( description )

**Description:** Sets the description for the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << set description( "my seg" );


```

### [Set Error Bar Cap](#set-error-bar-cap)

**Syntax:** obj \<< Set Error Bar Cap( "None"|"Tiny"|"Small"|"Medium"|"Large" )

**Description:** Specifies what type of end cap to put on error bars.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap( "Large" );


```

### [Set Error Bar Cap Shape](#set-error-bar-cap-shape)

**Syntax:** obj \<< Set Error Bar Cap Shape( begin, end )

**Description:** Specifies the shape of the end cap to display on error bars. A single argument sets the shape for both ends of the bar, or separate arguments can be provided for the start and end. The default shape is "Line". A shape of "Arrow" draws an outward pointing arrow, and "None" omits the cap.

**JMP Version Added:** 18

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :Age ), Y( :Height ) ),
    Elements( Line( X, Y, Legend( 4 ), Error Bars( "Range" ) ) ), 

);
frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Error Bar Cap Shape( "Line", "Arrow" );


```

### [Set Fill Color](#set-fill-color)

**Syntax:** obj \<< Set Fill Color( color )

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Fill Color( "Green" );


```

### [Set Fill Pattern](#set-fill-pattern)

**Syntax:** obj \<< Set Fill Pattern

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Fill Pattern( "h wave medium" );


```

### [Set Font](#set-font)

**Syntax:** obj \<< Set Font( fontName, <size>, \<"bold italic underline strikeout">, <angle> )

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font( "Arial Black" );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font( "Arial Black", 12, "Italic Underline" );


```

### [Set Font Name](#set-font-name)

**Syntax:** obj \<< Set Font Name( fontname )

**Description:** Sets the font for text strings.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font Name( "Arial Black" );


```

### [Set Font Scale](#set-font-scale)

**Syntax:** obj \<< Set Font Scale( f )

**Description:** Sets a scale factor for the current font. The scale factor will be applied to the size that is determined from the base font and point size.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
Wait( 2 );
fontobj << Set Font Scale( 2.0 );


```

### [Set Font Size](#set-font-size)

**Syntax:** obj \<< Set Font Size( n )

**Description:** Sets the font size in points for text strings.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font Size( 14 );


```

### [Set Font Style](#set-font-style)

**Syntax:** obj \<< Set Font Style( style )

**Description:** Sets the font style for text strings. To set more than one style at once, place them in the same string, separated by spaces (see Example 2 below).

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font Style( "Italic" );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
fontobj << Set Font Style( "Italic Bold Underline" );


```

### [Set Gradient](#set-gradient)

**Syntax:** obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<Contour Levels(num)>, \<Reverse Gradient(0|1)>, \<Density Gradient("Fade To White"|"Fade To Gray"|"Full Color")>, \<Gradient Transparency("None"|"Linear")> } obj \<< { \<Color Theme(theme)>, \<Min Lightness(0-1)>, \<Max Lightness(0-1)>, \<N Labels(num)>, \<Show Missing Color("On"|"Off"|"Auto")>, \<Scale Type("Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom")>, \<Scale Values([v1, v2, …])>, \<Range Type("Default"|"Exact Data Range"|"Middle 90%")>, \<Fill("Between"|"Above"|"Below"|"Above Below")>, \<Reverse Gradient(0|1)>, \<Reverse Labels(0|1)>, \<Discrete Color(0|1)> }, \<Label Format(labelFormat)>, \<Width(num)>, \<Horizontal(0|1)>, \<Show Labels(0|1)>

**Description:** Sets the coloring gradient.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient( {Color Theme( "Viridis" ), N Labels( 7 )} );


```

### [Set Gradient Color Theme](#set-gradient-color-theme)

**Syntax:** obj \<< Set Gradient Color Theme

**Description:** Sets the gradient's color theme.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Color Theme( "Viridis" );


```

### [Set Gradient Custom Scale](#set-gradient-custom-scale)

**Syntax:** obj \<< Set Gradient Custom Scale

**Description:** Sets the gradient to use a list of values for a custom scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Custom Scale( {0.0, 5.0, 10.0, 20.0} );


```

### [Set Gradient Discrete Colors](#set-gradient-discrete-colors)

**Syntax:** obj \<< Set Gradient Discrete Colors

**Description:** Sets if each level in a gradient should be a single color or if colors should transition smoothly.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Points( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Marker Seg( 1 ) );
seg << Set Gradient Discrete Colors( 1 );


```

### [Set Gradient Fill](#set-gradient-fill)

**Syntax:** obj \<< Set Gradient Fill( "Between"|"Above"|"Below"|"Above Below"="Above Below" )

**Description:** Sets the coloring behavior for values outside of the range of the gradient's scale. "Above Below" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Middle 90%" );
seg << Set Gradient Fill( "Between" );


```

### [Set Gradient Label Count](#set-gradient-label-count)

**Syntax:** obj \<< Set Gradient Label Count

**Description:** Sets the number of labels in a gradient's legend. This is one more than the number of contour levels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Label Count( 8 );


```

### [Set Gradient Label Levels](#set-gradient-label-levels)

**Syntax:** obj \<< Set Gradient Label Levels( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Legend Horizontal](#set-gradient-legend-horizontal)

**Syntax:** obj \<< Set Gradient Legend Horizontal

**Description:** Sets if the gradient's legend should be drawn horizontally.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Horizontal( 1 );


```

### [Set Gradient Legend Label Format](#set-gradient-legend-label-format)

**Syntax:** obj \<< Set Gradient Legend Label Format

**Description:** Sets the format for gradient legend labels

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Label Format( "Fixed Dec", 6, 3 );


```

### [Set Gradient Legend Label Width](#set-gradient-legend-label-width)

**Syntax:** obj \<< Set Gradient Legend Label Width

**Description:** Sets the maximum character length of gradient legend labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Label Width( 4 );


```

### [Set Gradient Legend Show Labels](#set-gradient-legend-show-labels)

**Syntax:** obj \<< Set Gradient Legend Show Labels

**Description:** Sets if the level labels should be shown in the gradient's legend.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Legend Show Labels( 0 );


```

### [Set Gradient Level Count](#set-gradient-level-count)

**Syntax:** obj \<< Set Gradient Level Count

**Description:** Sets the number of levels in a gradient. This is one less than the number of labels.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Levels( 7 );


```

### [Set Gradient Lightness Range](#set-gradient-lightness-range)

**Syntax:** obj \<< Set Gradient Lightness Range

**Description:** Sets the minimum and maximum lightness for level colors in a gradient. The colors will be scaled to cover this range. A missing value is treated as no change.

**JMP Version Added:** 18

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Lightness Range( Min( 0.25 ), Max( 0.75 ) );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Lightness Range( 0.25, 0.75 );


```

**Example 3**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Lightness Range( ., 0.75 );


```

### [Set Gradient Range](#set-gradient-range)

**Syntax:** obj \<< Set Gradient Range( "Default"|"Exact Data Range"|"Middle 90%"="Default" )

**Description:** Sets the range over which non-custom gradient scales are generated. "Default" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Range( "Exact Data Range" );


```

### [Set Gradient Reverse Color Order](#set-gradient-reverse-color-order)

**Syntax:** obj \<< Set Gradient Reverse Color Order

**Description:** Reverses the order of the colors in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Reverse Color Order( 1 );


```

### [Set Gradient Reverse Label Order](#set-gradient-reverse-label-order)

**Syntax:** obj \<< Set Gradient Reverse Label Order

**Description:** Reverses the order of the labels in a gradient.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Gradient Reverse Label Order( 1 );


```

### [Set Gradient Scale](#set-gradient-scale)

**Syntax:** obj \<< Set Gradient Scale( "Linear"|"Quantile"|"Standard Deviation"|"Log"|"Log Offset"|"Custom"="Linear" )

**Description:** Sets the gradient scale type. "Linear" by default.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale( "Quantile" );


```

### [Set Gradient Scale Values](#set-gradient-scale-values)

**Syntax:** obj \<< Set Gradient Scale Values( [value1,value1, ... value N] )

**Description:** Sets a custom set of values for use in the gradient's scale.

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Little Pond.jmp" );
gb = Graph Builder( Variables( X( :X ), Y( :Y ), Color( :Z ) ), Elements( Contour( X, Y ) ) );
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Contour Seg( 1 ) );
seg << Set Gradient Scale Values( [-10.0, 0.0, 10.0] );


```

### [Set Gradient Show Missing](#set-gradient-show-missing)

**Syntax:** obj \<< Set Gradient Show Missing( "Auto"|"On"|"Off"="Auto" )

**Description:** Sets when to show the legend entry for missing values. "Auto" by default.

**JMP Version Added:** 18

```

dt = Open( "$Sample_Data/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :city ), Y( :POP ), Color( :NO ) ),
    Elements( Bar( X, Y ) )
);
frame = (gb << Report)[FrameBox( 1 )];
seg = frame << Find Seg( Bar Seg( 1 ) );
seg << Set Gradient Show Missing( "Off" );


```

### [Set Group Label Border Color](#set-group-label-border-color)

**Syntax:** obj \<< Set Group Label Border Color( color )

**Description:** Sets the floating group label border color.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Group Label Border Color( "Blue" );


```

### [Set Group Label Color](#set-group-label-color)

**Syntax:** obj \<< Set Group Label Color( color )

**Description:** Sets the floating group label fill color.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Group Label Color( "Blue" );


```

### [Set Group Label Font](#set-group-label-font)

**Syntax:** obj \<< Set Group Label Font( <label position> fontName, <size>, \<"bold italic underline strikeout">, <angle>, <label position>, \<Font(fontName)>, \<Size(size)>, \<Style("bold italic underline strikeout")>, \<Angle(angle)> )

**Description:** Sets the group label font. If a label position is specified, the font is only applied if group labels use that position.

**JMP Version Added:** 17

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Group Label Font( "Arial Black", 16 );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Group Label Font( "Floating", Size( 24 ) );


```

### [Set Group Label Font Color](#set-group-label-font-color)

**Syntax:** obj \<< Set Group Label Font Color( color )

**Description:** Sets the group label font color.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :State ), X( :city, Position( 1 ) ), ),
    Elements( Treemap( X( 1 ), X( 2 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Group Label Font Color( "Blue" );


```

### [Set Group Spacing](#set-group-spacing)

**Syntax:** obj \<< Set Group Spacing( spacing=1 )

**Description:** Sets the amount of space around group tiles. "1" by default.

**JMP Version Added:** 16

**Example 1**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Group Spacing( 5 );


```

**Example 2**

```

Open( "$SAMPLE_DATA/Cities.jmp" );
Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {DispatchSeg( TreeMapSeg( 1 ), Set Group Spacing( 4 ) )}
        )
    )
);


```

### [Set Interval Draw Directions](#set-interval-draw-directions)

**Syntax:** obj \<< Set Interval Draw Directions( Both|Upper|Lower|None )

**Description:** Sets the directions in which intervals should be drawn.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :age ), Y( :weight ) ),
    Elements(
        Points(
            X,
            Y,
            Legend( 3 ),
            Summary Statistic( "Mean" ),
            Error Interval( "Standard Deviation" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Graph Builder", FrameBox,
            {Reference Line Order( 3 ), DispatchSeg(
                BarSeg( 1 ),
                {Set Interval Draw Directions( "Upper" )}
            )}
        )
    )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( "Bar Seg" ));
seg << Set Interval Draw Directions( "Lower" );


```

### [Set Line Color](#set-line-color)

**Syntax:** obj \<< Set Line Color( color )

**Description:** Set the color for all lines in the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Line Color( "Green" );


```

### [Set Line Style](#set-line-style)

**Syntax:** obj \<< Set Line Style( pen style )

**Description:** Sets the style of the lines. Options are Solid, Dotted, Dashed, DashDot, and DashDotDot.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Line Style( "Dotted" );


```

### [Set Line Width](#set-line-width)

**Syntax:** obj \<< Set Line Width( "1"|"2"|"3"|"4"|"5"|"6"|"Other..." )

**Description:** Sets the width of the lines.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Line Width( 3 );


```

### [Set Marker](#set-marker)

**Syntax:** obj \<< Set Marker( marker )

**Description:** Sets the marker style for all markers.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Marker( "Square" );


```

### [Set Marker Size](#set-marker-size)

**Syntax:** obj \<< Set Marker Size( size )

**Description:** Sets the size for the markers. Size options are Dot, Small, Medium, Large, XL, XXL, and XXXL.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Marker( "Square" );
seg << Set Marker Size( "XL" );


```

### [Set Orientation Bias](#set-orientation-bias)

**Syntax:** obj \<< Set Orientation Bias( bias )

**Description:** Sets the relative preference of horizontal vs. vertical area splitting. The argument should be a number between -1 and 1.

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/SATByYear.jmp" );
gb = Graph Builder( Variables( X( :State ), Size( :Population ) ), Elements( Treemap( X ) ) );
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Orientation Bias( 0.5 );


```

### [Set Text Color](#set-text-color)

**Syntax:** obj \<< Set Text Color( color )

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Text Color( "Green" );


```

### [Set Text Style](#set-text-style)

**Syntax:** obj \<< Set Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Set Transparency](#set-transparency)

**Syntax:** obj \<< Set Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Transparency( .3 );


```

### [Show Category Name](#show-category-name)

**Syntax:** obj \<< Show Category Name( state=0|1 )

### [Show Group Labels](#show-group-labels)

**Syntax:** obj \<< Show Group Labels( state=0|1 )

**Description:** If disabled, group labels are not shown. On by default.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
gb = Graph Builder(
    Variables( X( :season ), X( :species, Position( 1 ) ), Color( :miles ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 8 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( Treemap Seg( 1 ) ));
seg << Show Group Labels( 0 );


```

### [Show Group Name](#show-group-name)

**Syntax:** obj \<< Show Group Name( state=0|1 )

### [Show Labels](#show-labels)

**Syntax:** obj \<< Show Labels( state=0|1 )

**Description:** If disabled, labels are not shown. On by default.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
gb = Graph Builder(
    Variables( X( :season ), X( :species, Position( 1 ) ), Color( :miles ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 8 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( Treemap Seg( 1 ) ));
seg << Show Labels( 0 );


```

### [Sib](#sib)

**Syntax:** seg2 = obj \<< Sib

**Description:** Returns the sibling of the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Sib;


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( seg2 )

**Description:** Adds a display seg immediately after the display seg.

```

win = New Window( "World",
    gb = Graph(
        FrameSize( 800, 400 ),
        X Scale( -180, 180 ),
        Y Scale( -90, 90 ),
        <<Background Map( Images( "Simple Earth" ) )
    )
);
imgBox = win[framebox( 1 )];
mapSeg = imgBox << FindSeg( MapSeg( 1 ) );
mapSeg << Transparency( 0.5 );
Try(
    xAxis = gb[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = gb[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
mapSeg << Sib Append( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( seg2 )

**Description:** Adds a display seg immediately before the display seg.

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
Try(
    xAxis = g[AxisBox( 2 )];
    xMin = (xAxis << get min);
    xMax = (xAxis << get max);
,
    xMin = 0;
    xMax = 100;
);
yAxis = g[AxisBox( 1 )];
yMin = (yAxis << get min);
yMax = (yAxis << get max);
xval = Matrix( {xmin, xmax} );
yval = Matrix( {ymin, ymax} );
seg << Sib Prepend( Line Seg( xval, yval, <<line color( "Green" ), <<line width( 3 ) ) );


```

### [Suppress Box Frames](#suppress-box-frames)

**Syntax:** obj \<< Suppress Box Frames( state=0|1 )

**Description:** If enabled, the box frames are not shown.

```

Open( "$SAMPLE_DATA/Animals.jmp" );
gb = Graph Builder(
    Variables( X( :season ), X( :species, Position( 1 ) ), Color( :miles ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 8 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
seg = (frame << Find Seg( Treemap Seg( 1 ) ));
seg << Suppress Box Frames( 1 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color )

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Text Color( "Green" );


```

### [Text Style](#text-style)

**Syntax:** obj \<< Text Style( [Left|Center|Right], [Top|VCenter|Baseline|Bottom], [Erased], [Boxed] )

**Description:** Sets how the text is drawn with respect to the cursor pen. When supported, "Erased" fills the bounding box of the text and "Erased" outlines it. If not specified, the default horizontal alignment is "Left" and vertical is "Baseline".

**JMP Version Added:** 17

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Graph Builder(
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 3 ) ), Line Of Fit( X, Y, Legend( 5 ), Equation( 1 ) ) )
);

frame = Report( obj )[FrameBox( 1 )];
seg = (frame << Find Seg( “Text Seg” ));
seg << Set Text Style( {Center, VCenter} );


```

### [Transparency](#transparency)

**Syntax:** obj \<< Transparency( number )

**Description:** Sets the shape transparency. The argument should be a numeric value between 0 and 1.

**JMP Version Added:** 16

```

Open( "$SAMPLE_DATA/Cities.jmp" );
gb = Graph Builder(
    Variables( X( :Region ), X( :State, Position( 1 ) ) ),
    Elements( Treemap( X( 1 ), X( 2 ), Legend( 3 ) ) )
);
frame = Report( gb )[FrameBox( 1 )];
fontobj = seg = (frame << Find Seg( "TreeMapSeg" ));
seg << Set Transparency( .3 );


```

## [Shared Item Messages](#shared-item-messages)

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

# [UnknownBox](#unknownbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [UnlineUpBox](#unlineupbox)

## [Associated Constructors](#associated-constructors)

### [UnlineUp Box](#unlineup-box)

**Syntax:** y = UnLineup Box(displayBoxArgs, ... )

**Description:** Returns a display box that temporarily suspends the column layout of a Lineup Box. The child of the Unlineup Box will be stretched to span all columns of the Lineup Box.

```

New Window( "unlineup",
    Lineup Box( N Col( 2 ),
        Unlineup Box( Text Box( "First Section", <<Justify Text( "Center" ) ) ),
        Button Box( "First Section 1" ),
        Button Box( "First Section 2" ),
        Unlineup Box( Text Box( "Second Section", <<Justify Text( "Center" ) ) ),
        Button Box( "Second Section 1" ),
        Button Box( "Second Section 2" )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [WebBrowserBox](#webbrowserbox)

## [Associated Constructors](#associated-constructors)

### [Web Browser Box](#web-browser-box)

**Syntax:** wb = Web Browser Box( url )

**Description:** Returns a display box to view a web page, specified by the url string argument.

**JMP Version Added:** Before version 14

```

New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Window", "Window" );
wb << Set Max Size( 10000, 10000 );


```

## [Item Messages](#item-messages)

### [Execute Script](#execute-script)

**Syntax:** "Promise" = obj \<< Execute Script

**Description:** Asynchronously executes the given Javascript in context of the current page. Returns a promise for the script result (as a string)

**JMP Version Added:** 18

**Example 1**

```

New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Window", "Window" );
wb << Set Max Size( 10000, 10000 );
Wait( 2 );
wb << Execute Script( "document.title = \!"New Title\!"" );


```

**Example 2**

```

// Example illustrating navigating Web Browser Box to a URL and retrieve the page HTML source.
New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Window", "Window" );
wb << Set Max Size( 10000, 10000 );
Wait( 2 );
Process Content = Function( {promise, response},
    content = response;

// Possibly remove outer double-quotes
    If(
        Length( content ) >= 2 & Substr( content, 1, 1 ) == "\!"" & Substr( content, -1, 1 )
         == "\!"",
        content = Substr( content, 2, Length( content ) - 2 )
    );

// Fix up some escaped characters.
    content = Substitute( content,
        "\n", "\!n",    // Line feeds
        "\t", "\!t",    // Tabs
        "\\!"", "\!"",  // Double-quotes
        "\u003C", "<",
        "\u003E", ">"
    );  

// Print HTML source to Log.
    Print( content );
);

p = wb << Execute Script( "document.documentElement.outerHTML" );
p << On Result( Process Content );


```

### [Get URL](#get-url)

**Syntax:** "URL" = obj \<< Get URL

**Description:** Returns the URL that the browser has navigated to.

**JMP Version Added:** 15

```

New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Window", "Window" );
wb << Set Max Size( 10000, 10000 );
Wait( 2 );
Print( wb << Get URL() );


```

### [Navigate](#navigate)

**Syntax:** obj \<< Navigate( "URL" )

**Description:** Browses to the specified URL.

**JMP Version Added:** 15

```

New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Window", "Window" );
wb << Set Max Size( 10000, 10000 );


```

### [Set Size](#set-size)

**Syntax:** obj \<< Set Size( width,height )

**Description:** Sets the width and height of the web browser box. The web browser box has a default Stretch setting of 'Window' that must be changed to 'Off' to honor the requested size.

```

New Window( "Example", wb = Web Browser Box() );
wb << Navigate( "http://www.jmp.com" );
wb << Set Stretch( "Off", "Off" );
wb << Set Size( 100, 100 );


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [WordCloudBox](#wordcloudbox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [WrapListBox](#wraplistbox)

## [Associated Constructors](#associated-constructors)

### [Wrap List Box](#wrap-list-box)

**Syntax:** y = Wrap List Box( displayBox, ... )

**Description:** Returns a display box that arranges the display boxes provided by the arguments in a horizontal layout, but will wrap that list when printing.

```

New Window( "WrapListBox",
    Wrap List Box(
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "1" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "2" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "3" ) ),
        Graph Box( framesize( 150, 100 ), Text( {50, 50}, "4" ) )
    )
);


```

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [dragHolder](#dragholder)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [gdisplaybox](#gdisplaybox)

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [gline](#gline)

## [Item Messages](#item-messages)

### [Color](#color)

**Syntax:** obj \<< Color( color )

**Description:** Sets the color of the line.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
la = rbiv << Add Line Annotation( Line( 100, 50, 240, 100 ) );
la << Color( "Red" );


```

### [Dashed](#dashed)

**Syntax:** obj \<< Dashed( state=0|1 )

**Description:** Enables or disables a dashed line.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
la = rbiv << Add Line Annotation( Line( 100, 50, 240, 100 ) );
la << Dashed( 1 );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Removes the annotation from on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Delete;


```

### [Deleteable](#deleteable)

**Syntax:** obj \<< Deleteable

**Description:** Allows "delete" to be removed from the context menu

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << deleteable( 0 );


```

### [Line](#line)

**Syntax:** obj \<< Line( x1,y1,x2,y2 )

**Description:** Draws a line on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
la = rbiv << Add Line Annotation( Line( 100, 50, 240, 100 ) );


```

### [Point from](#point-from)

**Syntax:** obj \<< Point from( state=0|1 )

**Description:** Draws (1) or removes (0) an arrow at the beginning of the line.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
la = rbiv << Add Line Annotation( Line( 100, 50, 240, 100 ) );
la << Point From( 1 );


```

### [Point to](#point-to)

**Syntax:** obj \<< Point to( state=0|1 )

**Description:** Draws (1) or removes (0) an arrow at the end of the line.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
la = rbiv << Add Line Annotation( Line( 100, 50, 240, 100 ) );
la << Point To( 1 );


```

### [Reanchor](#reanchor)

**Syntax:** obj \<< Reanchor

### [Thick](#thick)

**Syntax:** obj \<< Thick( state=0|1 )

**Description:** Draws the line thick (1) or thin (0).

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
la = rbiv << Add Line Annotation( Line( 100, 50, 240, 100 ) );
la << Thick( 1 );


```

### [Unanchor](#unanchor)

**Syntax:** obj \<< Unanchor

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [gpin](#gpin)

## [Item Messages](#item-messages)

### [Add Text](#add-text)

**Syntax:** obj \<< Add Text( "string" )

**Description:** Adds a custom block of text to the pinned hover label.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
gpin << Add Text( "And now for something completely different!" );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color )

### [Click Link](#click-link)

**Syntax:** obj \<< Click Link( "\<index, integer>" )

**Description:** Simulates a click action on the link associated with the given text or index. If none is provided, assumes the last link, which is usually the graphlet, if present.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
frame << Set Gridlet(
    Annex(
        {{Matcher( "My Link" ), value( "Click Me!" ), click( Web( "https://jmp.com" ) )}}
    )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);

links = gpin << Get Links;
Show( links );
gpin << Click Link( 1 );
gpin << Click Link( links[1] );
gpin << Click Link();


```

### [Close](#close)

**Syntax:** obj \<< Close

**Description:** Closes the hover label.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
Wait( 3 );
text = gpin << Close;


```

### [Copy](#copy)

**Syntax:** "string" = obj \<< Copy

**Description:** Copies the hover label contents to the clipboard.

If the operation is assigned to a variable, the hover label text content is stored in it.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
text = gpin << Copy;
Show( text );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Removes the annotation from on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Delete;


```

### [Deleteable](#deleteable)

**Syntax:** obj \<< Deleteable

**Description:** Allows "delete" to be removed from the context menu

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << deleteable( 0 );


```

### [Edit](#edit)

**Syntax:** obj \<< Edit

**Description:** Launches a visual editor for the contents of the hover label.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
text = gpin << Edit;


```

### [Filled](#filled)

**Syntax:** obj \<< Filled( state=0|1 )

### [Font](#font)

**Syntax:** obj \<< Font

**Description:** Sets the pinned hover label font.

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
gpin << Font( "Tahoma", 11, "Bold" );


```

### [Frame Color](#frame-color)

**Syntax:** obj \<< Frame Color( color )

### [Get Links](#get-links)

**Syntax:** obj \<< Get Links

**Description:** "Returns a list of the text associated with the clickable entries in the hover label.

Pictures and graphlets are associated with an empty string

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
frame << Set Gridlet(
    Annex(
        {{Matcher( "My Link" ), value( "Click Me!" ), click( Web( "https://jmp.com" ) )}}
    )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
links = gpin << Get Links;
Show( links );


```

### [Get Local Context](#get-local-context)

**Syntax:** Associative Array = obj \<< Get Local Context

**Description:** Returns an associative array with the names and values of the local variables provided as part of the hover label execution context.

See graphlet preset definitions for usage examples.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
hlec = gpin << Get Local Context;
Show( hlec );


```

### [Launch graphlet](#launch-graphlet)

**Syntax:** obj \<< Launch graphlet

**Description:** Launches the graphlet visualization or platform in a new window.

The launcher/previous content can be recovered with an Undo command.

The same functionality is provided by Clicking on the graphlet thumbnail.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
frame << Set Gridlet(
    Annex(
        {{Matcher( "My Link" ), value( "Click Me!" ), click( Web( "https://jmp.com" ) )}}
    )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
gpin << Launch Graphlet;


```

### [Launch in last](#launch-in-last)

**Syntax:** obj \<< Launch in last

**Description:** Launches the graphlet visualization or platform in a new window or in the last launched window, replacing its contents.

The launcher/previous content can be recovered with an Undo command.

The same functionality is provided by Alt-Clicking on the graphlet thumbnail.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
frame << Set Gridlet(
    Annex(
        {{Matcher( "My Link" ), value( "Click Me!" ), click( Web( "https://jmp.com" ) )}}
    )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
gpin << Launch in last;
Wait( 1 );
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {4, 4} ),
    Index Row( {34, 34} ),
    UniqueID( -1293538908 ),
    FoundPt( {465, 179} ),
    Origin( {4.14739884393064, 108.411354449472} ),
    Tag Line( 1 )
);
Wait( 3 );
gpin << Launch in last;


```

### [Launch in place](#launch-in-place)

**Syntax:** obj \<< Launch in place

**Description:** Launches the graphlet visualization or platform in the current window, replacing its contents.

The launcher/previous content can be recovered with an Undo command.

The same functionality is provided by Control-Clicking on the graphlet thumbnail.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
frame << Set Gridlet(
    Annex(
        {{Matcher( "My Link" ), value( "Click Me!" ), click( Web( "https://jmp.com" ) )}}
    )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
Wait( 3 );
gpin << Launch in Place;


```

### [Pin](#pin)

**Syntax:** obj \<< Pin

### [Reanchor](#reanchor)

**Syntax:** obj \<< Reanchor

### [Replace Text](#replace-text)

**Syntax:** obj \<< Replace Text( "string" )

**Description:** Replaces the pinned hover label text content with the given text.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
gpin << Replace Text( "Nobody expects the Spanish Inquisition!" );


```

### [Revert Text](#revert-text)

**Syntax:** obj \<< Revert Text

**Description:** Reverts the pinned hover label text content to its original text.

**JMP Version Added:** 14

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :height ), Y( :weight ) ),
    Elements( Points( X, Y, Legend( 4 ) ), Line Of Fit( X, Y, Legend( 6 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
gpin = frame << Add Pin Annotation(
    Seg( Marker Seg( 1 ) ),
    Index( 7 ),
    Index Row( 7 ),
    UniqueID( 691854391 ),
    FoundPt( {124, 311} ),
    Origin( {51.0074683737235, 80.0858968472606} ),
    Offset( {-4, -106} ),
    Tag Line( 1 )
);
gpin << Replace Text( "Nobody expects the Spanish Inquisition!" );
Wait( 3 );
gpin << Revert Text;


```

### [Subset](#subset)

**Syntax:** obj \<< Subset

**Description:** Launches a data table with a local data filter that shows only the subset of the data associated with the visual element under the hover label.

**JMP Version Added:** 15

```

dt = Open( "$SAMPLE_DATA/Big Class Families.jmp" );
gb = dt << Graph Builder(
    Show Control Panel( 0 ),
    Variables( X( :age ), Y( :weight ) ),
    Elements( Bar( X, Y, Legend( 7 ) ) )
);
frame = (gb << report)[FrameBox( 1 )];
frame << Set Graphlet(
    Picture(
        loader = Include( "$BUILTIN_SCRIPTS/hllib.jsl" );
        hlp = loader:lazyLoad( "hllPresets" );
        hlp:launchPie();
    ),
    Title( "Pie Preset" ),
    Reapply( 1 )
);
frame << Set Gridlet(
    Annex(
        {{Matcher( "My Link" ), value( "Click Me!" ), click( Web( "https://jmp.com" ) )}}
    )
);
gpin = frame << Add Pin Annotation(
    Seg( BarSeg( 1 ) ),
    Index( {0, 0} ),
    Index Row( {0, 0} ),
    UniqueID( 1513503376 ),
    FoundPt( {107, 211} ),
    Origin( {0.00867052023121384, 96.6870397553517} ),
    Tag Line( 1 )
);
text = gpin << Subset;


```

### [Tag Line](#tag-line)

**Syntax:** obj \<< Tag Line( state=0|1 )

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color )

### [Unanchor](#unanchor)

**Syntax:** obj \<< Unanchor

### [Use Gradient](#use-gradient)

**Syntax:** obj \<< Use Gradient( state=0|1 )

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [gpolygon](#gpolygon)

## [Item Messages](#item-messages)

### [Closed](#closed)

**Syntax:** obj \<< Closed( state=0|1 )

**Description:** If enabled, the polygon automatically has an interior even if the starting and ending points do not match.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
pa = rbiv << Add Polygon Annotation( Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ) );
pa << Closed( 1 );


```

### [Color](#color)

**Syntax:** obj \<< Color( color )

**Description:** Sets the color of the polygon.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
pa = rbiv << Add Polygon Annotation( Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ) );
pa << Color( "Red" );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Removes the annotation from on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Delete;


```

### [Deleteable](#deleteable)

**Syntax:** obj \<< Deleteable

**Description:** Allows "delete" to be removed from the context menu

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << deleteable( 0 );


```

### [Filled](#filled)

**Syntax:** obj \<< Filled( state=0|1 )

**Description:** Enables or disables a filled polygon.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
pa = rbiv << Add Polygon Annotation( Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ) );
pa << Filled( 1 );


```

### [Points](#points)

**Syntax:** obj \<< Points

**Description:** Sets the points the polygon should extend to.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
pa = rbiv << Add Polygon Annotation();
pa << Points( {255, 125}, {210, 80}, {250, 70} );
pa << closed( 0 );
pa << Color( "Red" );


```

### [Raised](#raised)

**Syntax:** obj \<< Raised( state=0|1 )

**Description:** Enables or disables a raised polygon.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
pa = rbiv << Add Polygon Annotation( Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ) );
pa << Raised( 1 );


```

### [Reanchor](#reanchor)

**Syntax:** obj \<< Reanchor

### [Smooth](#smooth)

**Syntax:** obj \<< Smooth( state=0|1 )

**Description:** Enables or disables a smooth polygon.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
pa = rbiv << Add Polygon Annotation( Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ) );
pa << Smooth( 1 );


```

### [Unanchor](#unanchor)

**Syntax:** obj \<< Unanchor

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [gshape](#gshape)

## [Item Messages](#item-messages)

### [Color](#color)

**Syntax:** obj \<< Color( color )

**Description:** Sets the color of the shape.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
xaxis = rbiv[axisbox( 2 )];
{xsize, ysize} = xaxis << getsize;
ovalshape = xaxis << Add Simple Shape Annotation( Oval( 0, 0, xsize / 2, ysize ) );
ovalshape << Color( "Green" );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Removes the annotation from on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Delete;


```

### [Deleteable](#deleteable)

**Syntax:** obj \<< Deleteable

**Description:** Allows "delete" to be removed from the context menu

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << deleteable( 0 );


```

### [Filled](#filled)

**Syntax:** obj \<< Filled( state=0|1 )

**Description:** Enables or disables a filled shape.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
xaxis = rbiv[axisbox( 2 )];
{xsize, ysize} = xaxis << getsize;
ovalshape = xaxis << Add Simple Shape Annotation( Oval( 0, 0, xsize / 2, ysize ) );
ovalshape << Filled( 1 );


```

### [Oval](#oval)

**Syntax:** obj \<< Oval( x1,y1,x2,y2 )

**Description:** Draws an oval on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );


```

### [Raised](#raised)

**Syntax:** obj \<< Raised( state=0|1 )

**Description:** Enables or disables a raised shape.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
xaxis = rbiv[axisbox( 2 )];
{xsize, ysize} = xaxis << getsize;
ovalshape = xaxis << Add Simple Shape Annotation( Oval( 0, 0, xsize / 2, ysize ) );
ovalshape << Raised( 1 );


```

### [Reanchor](#reanchor)

**Syntax:** obj \<< Reanchor

### [Rectangle](#rectangle)

**Syntax:** obj \<< Rectangle( x1,y1,x2,y2 )

**Description:** Draws a rectangle on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Unanchor](#unanchor)

**Syntax:** obj \<< Unanchor

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Background Color](#get-background-color)

**Syntax:** obj \<< Background Color( color ); color = obj \<< Get Background Color

**Description:** If the background color is set, the box is filled with the background color prior to drawing its content. If the background color is not set, the background and content of the containing boxes show through.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Background Color );
Wait( 2 );
tb << Background Color( "Yellow" );


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get Text](#get-text)

**Syntax:** obj \<< Get Text

**Description:** Returns a string containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get Text );


```

### [Get Text Color](#get-text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color ); color = obj \<< Get Text Color

**Description:** Text will be drawn using the text color if it has been set. If the property has not been set, the box will inherit the text color of the containing box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Text Color );
Wait( 2 );
tb << Text Color( "Red" );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```

# [gtext](#gtext)

## [Item Messages](#item-messages)

### [Background Color](#background-color)

**Syntax:** obj \<< Background Color( color )

**Description:** Sets the background color of the text.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Background Color( "Blue" );


```

### [Delete](#delete)

**Syntax:** obj \<< Delete

**Description:** Removes the annotation from on top of the display box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Delete;


```

### [Deleteable](#deleteable)

**Syntax:** obj \<< Deleteable

**Description:** Allows "delete" to be removed from the context menu

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << deleteable( 0 );


```

### [Editable](#editable)

**Syntax:** obj \<< Editable( state=0|1 )

**Description:** If enabled (1), text can be clicked on with a mouse to be edited.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Editable( 0 );


```

### [Filled](#filled)

**Syntax:** obj \<< Filled( state=0|1 )

**Description:** Enables or disables filled text.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Text Box( {65, 50, 200, 77} );
ta << Filled;


```

### [Fixed Size](#fixed-size)

**Syntax:** obj \<< Fixed Size( state=0|1 )

**Description:** If enabled, honors the user-defined annotation size; otherwise, calculates it based on the text content.

**JMP Version Added:** 14

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Text Box( {65, 50, 200, 77} );
ta << Fixed Size( 1 );


```

### [Font](#font)

**Syntax:** obj \<< Font( face,<size>,<style> )

**Description:** Sets the text font.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Font( "Times New Roman", 14, "Bold" );


```

### [Get Background Color](#get-background-color)

**Syntax:** color = obj \<< Get Background Color

**Description:** Returns the color of the background.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Background Color( "Blue" );
Print( ta << Get Background Color );


```

### [Get Font](#get-font)

**Syntax:** font = obj \<< Get Font

**Description:** Returns the text font.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Font( "Times New Roman", 14, "Bold" );
Print( ta << Get Font );


```

### [Get Text Color](#get-text-color)

**Syntax:** color = obj \<< Get Text Color

**Description:** Returns the color of the text.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Text Color( "Blue" );
Print( ta << Get Text Color );


```

### [GetEditable](#geteditable)

**Syntax:** 0|1 = obj \<< GetEditable

**Description:** Returns if the text is editable.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
Print( ta << Get Editable );


```

### [GetFilled](#getfilled)

**Syntax:** 0|1 = obj \<< GetFilled

**Description:** Returns if the text is filled.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Text Box( {65, 50, 200, 77} );
Print( ta << Get Filled );


```

### [GetOctant](#getoctant)

**Syntax:** N|NE|E|SE|S|SW|W|NW = obj \<< GetOctant

**Description:** Returns the location that the text is drawn in.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Octant( "SE" );
Print( ta << Get Octant );


```

### [GetTagLine](#gettagline)

**Syntax:** 0|1 = obj \<< GetTagLine

**Description:** Returns if the tag line is enabled (1) or disabled (0).

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Tag Line;
Print( ta << Get Tag Line );


```

### [GetText](#gettext)

**Syntax:** "string" = obj \<< GetText

**Description:** Returns the text.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
Print( ta << Get Text );


```

### [Justification](#justification)

**Syntax:** obj \<< Justification( "string" )

**Description:** Sets the text justification

**JMP Version Added:** 15

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this
at the next
meeting." );
ta << Justification( "center" );


```

### [Minimized](#minimized)

**Syntax:** obj \<< Minimized( state=0|1 )

**JMP Version Added:** 18

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Text Box( {65, 50, 200, 77} );
ta << Minimized( 1 );


```

### [Octant](#octant)

**Syntax:** obj \<< Octant( \<N|NE|E|SE|S|SW|W|NW> )

**Description:** Sets the location in the display box that the text should be drawn.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Octant( "SE" );


```

### [Reanchor](#reanchor)

**Syntax:** obj \<< Reanchor

### [Tag Anchor](#tag-anchor)

**Syntax:** obj \<< Tag Anchor

### [Tag Line](#tag-line)

**Syntax:** obj \<< Tag Line( state=0|1 )

**Description:** Adds a line from the upper left of the display box to the text

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Tag Line;


```

### [Text](#text)

**Syntax:** obj \<< Text( "string" )

**Description:** Sets the text to string.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );


```

### [Text Box](#text-box)

**Syntax:** obj \<< Text Box( x1,y1,x2,y2 )

**Description:** Places the text in a Text Box.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Text Box( {65, 50, 200, 77} );


```

### [Text Color](#text-color)

**Syntax:** obj \<< Text Color( color )

**Description:** Sets the color of the text.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
ta = rbiv << Add Text Annotation();
ta << Text( "We need to discuss this at the next meeting." );
ta << Text Color( "Blue" );


```

### [Unanchor](#unanchor)

**Syntax:** obj \<< Unanchor

## [Shared Item Messages](#shared-item-messages)

### [Add Line Annotation](#add-line-annotation)

**Syntax:** obj \<< Add Line Annotation

**Description:** Adds a line on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Line Annotation( Line( 160, 235, 240, 235 ) );


```

### [Add Pin Annotation](#add-pin-annotation)

**Syntax:** obj \<< Add Pin Annotation

**Description:** Adds a pinned annotation on top of a display box. Most attributes (such as Index Row, UniqueID and FoundPt) are designed for internal use only.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Bivariate(
    Y( :weight ),
    X( :height ),
    SendToReport(
        Dispatch( {}, "Bivar Plot", FrameBox,
            Add Pin Annotation(
                Seg( Marker Seg( 1 ) ),
                Index( 17 ),
                Index Row( 17 ),
                UniqueID( -960001792 ),
                FoundPt( {238, 219} ),
                Origin( {64.9765625, 142} ),
                Offset( {-174, -40} ),
                Tag Line( 1 ),
                Font( "Helvetica", 11, "Plain" )
            )
        )
    )
);


```

### [Add Polygon Annotation](#add-polygon-annotation)

**Syntax:** obj \<< Add Polygon Annotation

**Description:** Adds a polygon on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Polygon Annotation(
    Points( {210, 80}, {230, 70}, {280, 115}, {240, 120} ),
    Color( "Red" ),
    Closed( 1 )
);


```

### [Add Simple Shape Annotation](#add-simple-shape-annotation)

**Syntax:** obj \<< Add Simple Shape Annotation

**Description:** Adds a simple shape on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Simple Shape Annotation( Oval( 210, 100, 250, 75 ) );
rbiv << Add Simple Shape Annotation( Rectangle( 70, 180, 95, 215 ) );


```

### [Add Text Annotation](#add-text-annotation)

**Syntax:** obj \<< Add Text Annotation

**Description:** Adds text on top of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);


```

### [Append](#append)

**Syntax:** obj \<< Append( db2 )

**Description:** Add db2 to the display tree after db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );


```

### [Border](#border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Border Color](#border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Bring Window To Front](#bring-window-to-front)

**Syntax:** obj \<< Bring Window To Front

**Description:** Brings the window to the front.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Run Script( "Bivariate" );
w << Bring Window To Front;


```

### [Child](#child)

**Syntax:** obj \<< Child

**Description:** Returns the child of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
axisChild = axisParent << child();
Print( axisChild << Class Name() );


```

### [Class Name](#class-name)

**Syntax:** obj \<< Class Name

**Description:** Returns the name of the display class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Class Name();


```

### [Clone Box](#clone-box)

**Syntax:** obj \<< Clone Box

**Description:** Makes a new copy of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << append( Text Box( "=== below ===" ) );
clonedBox = rbiv << Clone Box();
rbiv << append( clonedBox );


```

### [Close Window](#close-window)

**Syntax:** obj \<< Close Window( \<"NoSave"> )

**Description:** Closes the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Close Window;


```

### [Copy Data](#copy-data)

**Syntax:** obj \<< Copy Data

**Description:** copies the tab-delimited data from a matrix or table to the clip board.

```

New Window( "x", mat = Matrix Box( [1 2 3, 4 5 6, 7 8 9] ) );
mat << CopyData;


```

### [Copy Graph](#copy-graph)

**Syntax:** obj \<< Copy Graph

**Description:** Puts a picture of the graph and axes on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
(rbiv[FrameBox( 1 )]) << Copy Graph();
"paste into a paint program";


```

### [Copy Picture](#copy-picture)

**Syntax:** obj \<< Copy Picture

**Description:** Puts a picture of the display box on the clipboard.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Copy Picture();


```

### [Delete Box](#delete-box)

**Syntax:** obj \<< Delete Box

**Description:** Delete the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisbox << Delete Box();


```

### [Deselect](#deselect)

**Syntax:** obj \<< Deselect

**Description:** Deselects this object for use by Edit menu commands.

```

//This message applies to all display box objects
selected = 0;
New Window( "Example",
    ex = Button Box( "Press Me",
        selected = !selected;
        refresh;
    )
);
refresh = Function( {},
    If( selected,
        ex << Select,
        ex << Deselect
    )
);


```

### [Dispatch](#dispatch)

**Syntax:** obj \<< Dispatch( {outline node, ...}, display element, display element type, command )

**Description:** Send command to a specific part of a display tree.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Dispatch( {}, "Bivar Plot", FrameBox, {Marker Size( 3 )} );


```

### [Enabled](#enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Find](#find)

**Syntax:** obj \<< Find

**Description:** Returns a display box with the given argument.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv << Find( axis box( 1 ) );
axisbox << Delete();


```

### [Get Annotation](#get-annotation)

**Syntax:** obj \<< Get Annotation

**Description:** Returns the first annotation that is anchored to this display box. Other annotations can be accessed by using Sib() on the result.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Add Text Annotation(
    Text( "We need to discuss this at the next meeting." ),
    Text Box( {65, 35, 200, 77} )
);
annotation = rbiv << Get Annotation;
annotation << delete;


```

### [Get Border](#get-border)

**Syntax:** obj \<< Border( sides ); sides = obj \<< Get Border

**Description:** Borders are solid lines drawn around the outside of a display box. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical borders.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Border );
Wait( 1 );
tb << Border( 1 );


```

### [Get Border Color](#get-border-color)

**Syntax:** obj \<< Border Color( color ); color = obj \<< Get Border Color

**Description:** Optional color to override the default color for box borders.

**JMP Version Added:** 19

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Wait( 2 );
tb << Border( 1 );
tb << Border Color( "Light Red" );


```

### [Get Content Size](#get-content-size)

**Syntax:** obj \<< Get Content Size

**Description:** Returns the content size within the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Content Size();
Show( c );


```

### [Get Display Path](#get-display-path)

**Syntax:** obj \<< Get Display Path( parent box, <receiver expr>, \<Mode("XPath"|"Subscript")> )

**Description:** Gets a relatively robust expression to navigate between parent box and obj. This path is not guaranteed to be stable across JMP releases. The receiver expr is incorporated into the output expression if provided. If not, the expression provided for parent box is used instead. As shown in the example, this message is mainly useful for increasing the robustness of a path you already have available. The XPath mode is default.

#### [Basic](#basic)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
xpath expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Expr( Report( biv ) ) ); // Make Number Col Box(9) more robust
Show( xpath expr );
xpath expr << Select;


```

#### [Subscript Mode](#subscript-mode)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
rpt = Report( biv );
subscript expr = rpt[Number Col Box( 9 )] << Get Display Path( rpt, Mode( "Subscript" ) ); // Make Number Col Box(9) more robust
Show( subscript expr );
subscript expr << Select;


```

### [Get Enabled](#get-enabled)

**Syntax:** obj \<< Enabled( state=0|1 ); state = obj \<< Get Enabled

**Description:** An object that is not enabled will not respond to keyboard or mouse input. This property is inherited by child objects, so a container object that is disabled will cause all descendent objects to be disabled.

```

//This message applies to all display objects
New Window( "enabled",
    V List Box(
        check = Check Box(
            {"Use Password"},
            ptext << Enabled( check << Get( 1 ) );
            pvalue << Enabled( check << Get( 1 ) );
        ),
        Lineup Box( N Col( 2 ),
            Text Box( "Username:" ),
            Text Edit Box( "", <<Set Width( 100 ) ),
            ptext = Text Box( "Password:", <<Enabled( 0 ) ),
            pvalue = Text Edit Box( "",
                <<Password Style( 1 ),
                <<Set Width( 20 ),
                <<Enabled( 0 )
            )
        )
    )
);


```

### [Get HTML](#get-html)

**Syntax:** obj \<< Get HTML( <format> )

**Description:** Returns a string containing HTML source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get HTML );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.html", obj << Get HTML( "svg" ) ); // Prefer <<Save HTML
Web( "$TEMP/Oneway.html", JMPWindow );


```

### [Get Height](#get-height)

**Syntax:** width = obj \<< Get Height

**Description:** Returns the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Height;


```

### [Get Horizontal Alignment](#get-horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Get Journal](#get-journal)

**Syntax:** obj \<< Get Journal

**Description:** Returns a string containing journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Print( rbiv << Get Journal );


```

### [Get Margin](#get-margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Max Size](#get-max-size)

**Syntax:** width,height = obj \<< Get Max Size

**Description:** Returns the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Max Size;


```

### [Get Min Size](#get-min-size)

**Syntax:** width,height = obj \<< Get Min Size

**Description:** Returns the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Min Size;


```

### [Get Namespace](#get-namespace)

**Syntax:** obj \<< Get Namespace

**Description:** Returns the namespace associated with this display object.

```

//This message applies to all display objects
x = 1;
w = New Window( "Test", b = Button Box( "Press me" ) );
b:x = 2;
ns = b << GetNamespace();
Show( ns:x, x );


```

### [Get On Close](#get-on-close)

**Syntax:** obj \<< Get On Close

**Description:** Returns the script or function that will run when the window closes.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);
Show( w << Get On Close );


```

### [Get Padding](#get-padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Get Page Setup](#get-page-setup)

**Syntax:** obj \<< Get Page Setup

**Description:** Get page setup information for PDF

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Page Setup Test" ) );
w << get page setup();


```

### [Get Picture](#get-picture)

**Syntax:** obj \<< Get Picture( \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Captures db as an Image Object. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
New Window( "Example", rbiv << Get Picture );


```

#### [Scale](#scale)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example", rbiv << Get Picture( Scale( 1.5 ) ) );


```

#### [View and Appearance](#view-and-appearance)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
New Window( "Example",
    H List Box(
        rbiv << Get Picture( View( "Screen" ), Appearance( "Current" ) ),
        rbiv << Get Picture( View( "Print" ), Appearance( "Default" ) )
    )
);


```

### [Get Project](#get-project)

**Syntax:** project = obj \<< Get Project()

**Description:** Returns the parent project of the window, or Empty() if it is not in a project.

**JMP Version Added:** 14

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
c = w << Get Project();
Show( c );


```

### [Get Properties](#get-properties)

**Syntax:** obj \<< Get Properties

**Description:** Returns an associative array that contains the display box's properties and their values.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Properties;


```

### [Get Property](#get-property)

**Syntax:** obj \<< Get Property( "property" )

**Description:** Returns the current setting for the named property.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property( "Enabled" );


```

### [Get Property List](#get-property-list)

**Syntax:** obj \<< Get Property List

**Description:** Returns a list of properties the display box has.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Get Property List;


```

### [Get RTF](#get-rtf)

**Syntax:** obj \<< Get RTF( <format> )

**Description:** Returns a string containing RTF source for the display box.

**Example 1**

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << Set Text( win << Get RTF );


```

**Example 2**

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = dt << Oneway( Y( :height ), X( :sex ), Means( 1 ), Mean Diamonds( 1 ) );
Save Text File( "$TEMP/Oneway.rtf", obj << Get RTF( "png" ) ); // Prefer <<Save RTF
Open( "$TEMP/Oneway.rtf" );


```

### [Get Row States](#get-row-states)

**Syntax:** rs = obj \<< Get Row States( <dt> )

**Description:** Returns a vector containing the row state for every row in the given data table or the current data table. The row states can come from the table, or from the filter context of the box.

#### [Single table](#single-table)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Get Show Window](#get-show-window)

**Syntax:** obj \<< Get Show Window

**Description:** Returns the visibility of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
Print( w << Get Show Window() );


```

### [Get Size](#get-size)

**Syntax:** width,height = obj \<< Get Size

**Description:** Returns the size of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
Print( fb << Get Size );


```

### [Get Stretch](#get-stretch)

**Syntax:** x,y = obj \<< Get Stretch

**Description:** Returns the stretching flags for this display box in the horizontal and vertical directions.

**JMP Version Added:** 16

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        spacer = Spacer Box(
            Size( 20, 20 ),
            Color( "Light Red" ),
            <<Set Stretch( "Fill", "Off" )
        )
    )
);
spacer << Get Stretch();


```

### [Get UI Only](#get-ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Get Vertical Alignment](#get-vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Get Visibility](#get-visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Get Web Support](#get-web-support)

**Syntax:** obj \<< Get Web Support

**Description:** Return a number indicating the level of Interactive HTML support for the display object. 1 means some or all elements are supported. 0 means no support.

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
obj = Bivariate( Y( :Weight ), X( :Height ) );
s = obj << Get Web Support();
Show( s );


```

### [Get Width](#get-width)

**Syntax:** width = obj \<< Get Width

**Description:** Returns the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Get Width;


```

### [Get Window Icon](#get-window-icon)

**Syntax:** obj \<< Get Window Icon

**Description:** Returns the window icon.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Icon;
Show( t );


```

### [Get Window Position](#get-window-position)

**Syntax:** obj \<< Get Window Position

**Description:** Returns the position of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
p = w << Get Window Position();
Show( p );


```

### [Get Window Size](#get-window-size)

**Syntax:** obj \<< Get Window Size

**Description:** Returns the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
s = w << Get Window Size();
Show( s );


```

### [Get Window Title](#get-window-title)

**Syntax:** obj \<< Get Window Title

**Description:** Returns the window title.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
t = w << Get Window Title;
Show( t );


```

### [Get Window View](#get-window-view)

**Syntax:** obj \<< Get Window View

**Description:** Returns the current window view. Windows can be "Visible", "Invisible", or "Private".

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Print( w << Get Window View() );


```

### [Get XML](#get-xml)

**Syntax:** obj \<< Get XML( \<English(0|1)>, \<NoData(0|1)> )

**Description:** Retrieves the display tree formatted as XML. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which can be very large for some display trees.

```

//This message applies to all display box objects
win = New Window( "test", a = Text Box( "my test" ) );
a << set text( win << get xml );


```

### [GetOffset](#getoffset)

**Syntax:** x,y = obj \<< GetOffset

**Description:** Returns the offset of this display box relative to the parent box. You might need to use the \<<parent message in a loop to accumulate several offsets.

```

New Window( "example",
    MouseBox(
        Graph Box(
            title( "title" ),
            Pen Size( 3 );
            Y Function( -3 + 100 / 2 * (1 + Sin( (2 * Pi() * (x + .3)) / 100 )), x );
        ),
        <<settrackenable( 1 ) // put the mouse box to work, watching "tracking"
    ,
        <<settrack( // events from the mouse (movement, with button up or down)
            Function( {this, pt}, // parameters: this is the mousebox, pt is mouse x,y
                {fb, offset, t, off, size}, // local variables
                // recalulate offset and size each time, the values can change
                fb = this[framebox( 1 )]; // the framebox in the graph 
                offset = [0, 0]; // accumulator to sum up the offset between framebox and mousebox
                t = fb; // a temporary box that starts at the frame 
                While( t != this, // and walks up to the mousebox
                    off = t << getOffset; // ask each box for its offset to the immediate parent
                    offset += Matrix( off ); // convert list answer to matrix so + will work
                    t = t << parent; // crawl up to the mousebox, one box at a time
                );
                size = Matrix( fb << getSize ); // the frame knows its size
                If( // over the frame box
                    offset[1] < pt[1] < offset[1] + size[1] & offset[2] < pt[2] < offset[2]
                     + size[2]
                ,
                    fb << setbackgroundcolor( "red" ),
                    fb << setbackgroundcolor( "blue" )
                );
            )
        )
    )
);


```

### [Horizontal Alignment](#horizontal-alignment)

**Syntax:** obj \<< Horizontal Alignment( "Default"|"Left"|"Center"|"Right" ); "Default"|"Left"|"Center"|"Right" = obj \<< Get Horizontal Alignment

**Description:** Horizontal alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Border( 1 );
Wait( 2 );
lb << Horizontal Alignment( "Right" );


```

### [Inval](#inval)

**Syntax:** obj \<< Inval

**Description:** Invalidate the displaybox. The window will update when either the \<<UpdateWindow message is sent or the operating system has time for the update.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Inval example",
    Button Box( "red",
        color = "red";
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    ),
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change 
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    ),
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Is Dirty](#is-dirty)

**Syntax:** obj \<< Is Dirty

**Description:** Gets the document's modified status. 1 means the document has been modified and will prompt for saving; 0 means the document is not modified.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Is Modal Dialog](#is-modal-dialog)

**Syntax:** obj \<< Is Modal Dialog

**Description:** Returns true if the window is a modal dialog. Only useful when called from a window handler callback.

```

With Window Handler(
    New Window( "Modal Window", <<Modal ),
    Function( {win},
        Print( win << Is Modal Dialog() );
        win << close window();
    )
);


```

### [Journal](#journal)

**Syntax:** obj \<< Journal

**Description:** Makes a journal from the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << journal;


```

### [Journal Window](#journal-window)

**Syntax:** obj \<< Journal Window

**Description:** Opens a journal window of the window.

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Journal Window;


```

### [Launch](#launch)

**Syntax:** obj \<< Launch

**Description:** Evaluates the given argument in the context of the display box.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "example",
    ob1 = Outline Box( "treemap launcher" ),
    ob2 = Outline Box( "bivariate partial" ),
    ob3 = Outline Box( "bivariate launched" )
);
ob1 << launch( Treemap() );
ob2 << launch( Bivariate( Y( :height ) ) );
ob3 << launch( Bivariate( Y( :height ), X( :weight ) ) );


```

### [Make RowState Handler](#make-rowstate-handler)

**Syntax:** rs = obj \<< Make RowState Handler( <dt>, function(a) )

**Description:** Creates a row state handler for the given data table or the current data table. The function is called when the row states change in the filter context of the box. The argument of the function holds the rows numbers that have changed, or -1 if the row state filter has changed.

#### [Single table](#single-table_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    Data Filter Context Box(
        H List Box(
            dt << Data Filter(
                Local,
                Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
                Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
            ),
            V List Box(
                t = Text Box( "0 Rows Excluded" ),
                Distribution(
                    Continuous Distribution( Column( :weight ) ),
                    Nominal Distribution( Column( :age ) )
                )
            )
        )
    )
);
updatetext = Function( {},
    rs = t << Get Row States( dt );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = t << Make Row State Handler( dt, rsupdate );
updatetext();


```

#### [Where subset](#where-subset_1)

```

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
New Window( "filter test",
    t = Text Box( "0 Rows Excluded" ),
    dist = Distribution(
        Continuous Distribution( Column( :weight ) ),
        Nominal Distribution( Column( :age ) ),
        Local Data Filter(
            Add Filter( columns( :height ), Where( :height >= 51 & :height <= 62 ) ),
            Mode( Select( 0 ), Show( 1 ), Include( 1 ) )
        ),
        Where( :sex == "F" )
    )
);
subset = dist << Get Data Table();
updatetext = Function( {},
    rs = Report( dist ) << Get Row States( subset );
    n = 0;
    For( ii = 1, ii <= N Rows( rs ), ii++,
        If( Excluded( As Row State( rs[ii] ) ),
            n
            ++)
    );
    t << Set Text( Char( n ) || " Rows Excluded" );
);
rsupdate = Function( {a},
    If( Is Matrix( a ),
        updatetext()
    )
);
rsh = Report( dist ) << Make Row State Handler( subset, rsupdate );
updatetext();


```

### [Margin](#margin)

**Syntax:** obj \<< Margin( sides ); sides = obj \<< Get Margin

**Description:** Margin adds space between the border of the box and adjacent boxes. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical margins.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Margin );
tb << Border( 1 );
Wait( 2 );
tb << Margin( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Maximize Window](#maximize-window)

**Syntax:** obj \<< Maximize Window( \<state=0|1> )

**Description:** Maximizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Maximize Window( 1 );
Wait( 1 );
w << Maximize Window( 0 );


```

### [Minimize Window](#minimize-window)

**Syntax:** obj \<< Minimize Window( \<state=0|1> )

**Description:** Minimizes the window. Default argument is 1.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Minimize Window( 1 );
Wait( 1 );
w << Minimize Window( 0 );


```

### [Move Window](#move-window)

**Syntax:** obj \<< Move Window( x,y )

**Description:** Moves the window to the specified position.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 2 );
w << Move Window( 500, 500 );


```

### [Next](#next)

**Syntax:** obj \<< Next

**Description:** Returns the display box after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
next = rbiv << Next();
Print( next << Class Name() );


```

### [On Close](#on-close)

**Syntax:** obj \<< On Close( script )

**Description:** Sets a script or function to run upon closing the window. This script should return 1 to allow the close, or 0 to prevent the window from closing.

#### [Close Function](#close-function)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    Function( {this}, 
        // Modal dialogs return Button(1) if OK is pressed, Button(-1) if cancelled
        New Window( "Are you sure?",
            <<modal,
            V List Box(
                Text Box( "Press OK to allow " || (this << Get Window Title) || " to close" ),
                H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
            )
        )["button"] == 1
    )
);


```

#### [Close Script](#close-script)

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << On Close(
    // Modal dialogs return Button(1) if OK is pressed, Button(-1) if canceled
    New Window( "Are you sure?",
        <<modal,
        V List Box(
            Text Box( "Press OK to allow the window to close" ),
            H List Box( Button Box( "OK" ), Button Box( "Cancel" ) )
        )
    )["button"] == 1
);


```

### [Optimize Display](#optimize-display)

**Syntax:** obj \<< Optimize Display

**Description:** Sets a data table's column widths and window to an optimum size.

**JMP Version Added:** 14

```

//This message applies to Data Table objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
dt << Optimize Display;


```

### [Pad Window](#pad-window)

**Syntax:** obj \<< Pad Window( bool )

**Description:** Turns window padding on or off.

```

//This message applies to all display box objects
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
r = d << report;
r << Pad Window( 0 );


```

### [Padding](#padding)

**Syntax:** obj \<< Padding( sides ); sides = obj \<< Get Padding

**Description:** Padding adds space between the content and the border of the box. Use named arguments, or provide a list of values. If a single value is provided, it will be applied to all sides. If two values are specified, they will be applied to horizontal and vertical padding.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Padding );
tb << Border( 1 );
Wait( 1 );
tb << Padding( Left( 20 ), Top( 20 ), Right( 20 ), Bottom( 20 ) );


```

### [Page Break](#page-break)

**Syntax:** obj \<< Page Break

**Description:** Inserts a page break before the display box.

```

//This message applies to all display box objects
New Window( "Example",
    ob = Outline Box( "Outline Box",
        V List Box(
            ob2 = Outline Box( "Outline Box 2",
                H List Box( Text Edit Box( "Top Left" ), Text Edit Box( "Top Right" ) )
            ),
            ob3 = Outline Box( "Outline Box",
                H List Box( Text Edit Box( "Bottom Left" ), Text Edit Box( "Bottom Right" ) )
            )
        )
    )
);
ob3 << Page Break;


```

### [Parent](#parent)

**Syntax:** obj \<< Parent

**Description:** Returns the parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisParent = axisbox << parent();
Print( axisParent << Class Name() );


```

### [Prepend](#prepend)

**Syntax:** obj \<< Prepend( db2 )

**Description:** Add db2 to the display tree before db.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << prepend( Text Box( "=== above ===" ) );


```

### [Prev Sib](#prev-sib)

**Syntax:** obj \<< Prev Sib

**Description:** Returns the previous sibling of the display box.

**JMP Version Added:** 15

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 2 )];
axisSibling = axisbox << Prev Sib();
Print( axisSibling << Class Name() );


```

### [Print Window](#print-window)

**Syntax:** obj \<< Print Window

**Description:** Prints the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Print Window;


```

### [Reshow](#reshow)

**Syntax:** obj \<< Reshow

**Description:** Invalidate the displaybox and update the window with the new content. See \<<Inval and \<<UpdateWindow messages if more control over timing of the update is required.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "Reshow example",
    Button Box( "red",
        color = "red";
        g << reshow/* tell the graph that something changed */;
    ),
    Button Box( "blue",
        color = "blue";
        g << reshow/* tell the graph that something changed */;
    ),
    g = Graph Box(/* the graph does NOT watch for the color variable to change
                     but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);


```

### [Save Capture](#save-capture)

**Syntax:** obj \<< Save Capture( \<"path">, <format>, \<Add Sibling(n)> )

**Description:** Saves a screen capture of the display box at the specified path. If a path is not given, the Save As window appears.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Capture( "$TEMP/jmp_example.png", "png" );


```

### [Save HTML](#save-html)

**Syntax:** obj \<< Save HTML( <pathname>, <format> )

**Description:** Saves HTML source and folder of graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save HTML( "$TEMP/jmp_example.html" );


```

### [Save Interactive HTML](#save-interactive-html)

**Syntax:** obj \<< Save Interactive HTML( <pathname>, <Boolean> )

**Description:** Saves Interactive HTML with Data to a file. The Boolean argument represents the report being static.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Interactive HTML( "$TEMP/jmp_example.html" );


```

### [Save Journal](#save-journal)

**Syntax:** obj \<< Save Journal( <pathname> )

**Description:** Saves journal source for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Journal( "$TEMP/jmp_example.jrn" );


```

### [Save MSWord](#save-msword)

**Syntax:** obj \<< Save MSWord( <pathname>, <format> )

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

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save MSWord( "$TEMP/jmp_example.doc" );


```

### [Save PDF](#save-pdf)

**Syntax:** obj \<< Save PDF( <pathname>, \<Show Page Setup(0|1)>, \<Portrait(0|1)> )

**Description:** Saves a PDF of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save PDF( "$TEMP/jmp_example.pdf" );


```

### [Save Picture](#save-picture)

**Syntax:** obj \<< Save Picture( <pathname>, <format>, \<Scale(factor)>, \<Type("Bitmap" | "Scalable")>, \<View("Picture" | "Screen" | "Print"), \<Appearance("Default" | "Current")>, \<SubRect(Left(number), Top(number), Right(number), Bottom(number))> )

**Description:** Saves a picture of the display box. Supported formats are EMF(Windows), PICT(Macintosh), JPEG or JPG, GIF, or PNG. The optional Scale argument will render the image at a scaled resolution. Scaling requires that the display box be stretchable. The Type argument determines whether the result will be a scalable vector image or a bitmap. By default a scalable image is returned, which is suitable for saving to vector formats like PDF. The View option changes the behavior of some boxes. The default option of "Picture" draws the report as it would when exporting to an image format, with scrolled areas fully shown. View mode of "Screen" draws the report as seen on-screen, and "Print" draws the report as it does when printing, without any of the page setup features. The SubRect option will capture a portion of the resulting image rather than a full image. The Appearance option can change from the "Default" output colors to the "Current" colors as seen on-screen. The View, SubRect, and Appearance options are only supported for Type "Bitmap".

#### [Default](#default_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Picture( "$TEMP/jmp_example.png", "png" );


```

#### [Scale](#scale_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv[FrameBox( 1 )] << Set Stretch( "Window", "Window" );
rbiv << Save Picture( "$TEMP/jmp_example_scale.png", "png", Scale( 1.5 ) );
New Window( "scaled image", New Image( "$TEMP/jmp_example_scale.png" ) );


```

#### [View and Appearance](#view-and-appearance_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line( {Line Color( {212, 73, 88} )} ),
    Fit Polynomial( 3, {Line Color( {61, 174, 70} )} ),
    Kernel Smoother( 1, 1, 0.5, 0 )
);
rbiv = biv << report;
rbiv << Save Picture(
    "$TEMP/jmp_example_screen.png",
    "png",
    View( "Screen" ),
    Appearance( "Current" )
);
rbiv << Save Picture(
    "$TEMP/jmp_example_print.png",
    "png",
    View( "Print" ),
    Appearance( "Default" )
);
New Window( "Example",
    H List Box(
        New Image( "$TEMP/jmp_example_screen.png" ),
        New Image( "$TEMP/jmp_example_print.png" )
    )
);


```

### [Save Presentation](#save-presentation)

**Syntax:** obj \<< Save Presentation( "filename.pptx", \<Template("path\\to\\my_template.pptx")>, \<Insert(Begin|End|#) | Replace(Begin|End|#) | Append>, \<Outline Titles(None|Hide|TopLeft|TopRight|BottomLeft|BottomRight)>, \<"EMF"|"PNG"|"JPG"|"Native"> )

**Description:** Saves the display box tables and graphs slides in a presentation. The presentation can be opened with Microsoft PowerPoint or other presentation software.

```

Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save Presentation( "$TEMP/jmp_example.pptx" );
Open( "$TEMP/jmp_example.pptx" );


```

### [Save RTF](#save-rtf)

**Syntax:** obj \<< Save RTF( <pathname>, <format> )

**Description:** Saves RTF source with graphics in format specified.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Save RTF( "$TEMP/jmp_example.rtf", "png" );


```

### [Save Text](#save-text)

**Syntax:** obj \<< Save Text( <pathname>, <format> )

**Description:** Saves a file containing the text of the display box.

```

//This message applies to all display box objects
win = New Window( "Example", a = Text Box( "Example Text" ) );
a << save text( "$TEMP/jmp_example.txt" );


```

### [Save Window Report](#save-window-report)

**Syntax:** obj \<< Save Window Report( pathname, \<embed data(0|1)> )

**Description:** Saves the current report window to a JMP report file (.jrp).

**JMP Version Added:** 16

```

//This message can be sent to any display box object but will be applied to the report window
Open( "$SAMPLE_DATA/Big Class.jmp" );
d = distribution( Column( :height ) );
d << Save Window Report( "$DOCUMENTS/test.jrp", embed data( 1 ) );


```

### [Scroll Window](#scroll-window)

**Syntax:** obj \<< Scroll Window( DisplayBox | \<Relative(<v> | <h>,<v>)> | \<Absolute(<v> | <h>,<v>) )

**Description:** Adjust the window scrollbar to bring the given DisplayBox into view, or scroll a relative number of pixels, or scroll to an absolute pixel location. In place of a number of pixels the keywords "Start" or "End" can be used.

#### [Absolute](#absolute)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Absolute( "End", "End" ) );
Wait( 1 );
fm << scroll window( Absolute( 0, 300 ) );
Wait( 1 );


```

#### [Box](#box)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
For( i = 1, i <= 5, i++, // repeatedly, bring each frame box into view for 1/2 second
    fm << scroll window( Report( fm )[framebox( 2 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 3 )] );
    Wait( .5 );
    fm << scroll window( Report( fm )[framebox( 1 )] );
    Wait( .5 );
);


```

#### [Relative](#relative)

```


Open( "$SAMPLE_DATA/Blood Pressure.jmp" );
fm = Fit Model(
    Y( :BP 8M, :BP 12M, :BP 6M, :BP 8W, :BP 12W, :BP 6W, :BP 8F, :BP 12F, :BP 6F ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);
fm << setwindowsize( 600, 600 ); // shrink the window
fm << scroll window( Relative( 300 ) );
Wait( 1 );
fm << scroll window( Relative( -50 ) );
Wait( 1 );
fm << scroll window( Relative( "Start" ) );
Wait( 1 );


```

### [Select](#select)

**Syntax:** obj \<< Select

**Description:** Selects this object for use by Edit menu commands.

```

//This message applies to all display box objects
New Window( "Example", ex = Button Box( "Press Me" ) );
ex << Select;


```

### [Set Content Size](#set-content-size)

**Syntax:** obj \<< Set Content Size( x,y )

**Description:** Sets the content size within the window.

```

//This message applies to all display box objects
w = New Window( "Test",
    lb = List Box( {"a", "b", "c", "d"} ),
    Button Box( "Enable 2nd item",
        lb << enable item( 2, 1 );
        Show( lb << item enabled( 2 ) );
    ),
    Button Box( "Disable 2nd item",
        lb << enable item( 2, 0 );
        Show( lb << item enabled( 2 ) );
    )
);
Wait( 2 );
w << Set Content Size( 400, 300 );


```

### [Set Dirty](#set-dirty)

**Syntax:** obj \<< Set Dirty

**Description:** Sets the document's modified status. 0 will not prompt for saving; 1 will prompt.

**JMP Version Added:** 14

```


ww = New Window( "Test", <<Script, "Open(\!"$SAMPLE_DATA\Big Class.jmp\!");" );
Show( ww << Is Dirty );
ww << Set Dirty( 0 );
Show( ww << Is Dirty );


```

### [Set Height](#set-height)

**Syntax:** obj \<< Set Height( width )

**Description:** Sets the height of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Height( 150 );


```

### [Set Main Window](#set-main-window)

**Syntax:** obj \<< Set Main Window

**Description:** Set the window to be the main window in JMP and sets the prior main window to be a normal window

```

//This message applies to all display box objects
w = New Window( "Main Window", Text Box( "Main JMP Window" ) );
w << Set Main Window;


```

### [Set Max Size](#set-max-size)

**Syntax:** obj \<< Set Max Size( width,height )

**Description:** Sets the maximum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Max Size( 500, 500 );
fb << Get Max Size;


```

### [Set Min Size](#set-min-size)

**Syntax:** obj \<< Set Min Size( width,height )

**Description:** Sets the minimum size of this display box for purposes of auto-stretching.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Min Size( 30, 30 );
fb << Get Min Size;


```

### [Set Page Setup](#set-page-setup)

**Syntax:** obj \<< Set Page Setup( \<margins(left, top, right, bottom)>, \<scale(s)>, \<portrait(0|1)>, \<paper size(p)>, \<Table of Contents(always, never, default)> )

**Description:** Sets the page setup information that is used during printing or saving as pdf. A Table of Contents can optionally be generated from Outline Boxes.

```

//This message applies to all display box objects
w = New Window( "Window", Outline Box( "TOC", Text Box( "Page Setup Test" ) ) );
w << Set page setup(
    margins( 1, 1, 1, 1 ),
    scale( 1 ),
    portrait( 1 ),
    paper size( "Letter" ),
    Table of Contents( "always" )
);
w << Save pdf( "$DOCUMENTS\test.pdf" );


```

### [Set Print Footers](#set-print-footers)

**Syntax:** obj \<< Set Print Footers( left footer, center footer, right header )

**Description:** Sets the left, center, and right footers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Footer Test" ) );
w << Set Print Footers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Print Headers](#set-print-headers)

**Syntax:** obj \<< Set Print Headers( left header, center header, right header )

**Description:** Sets the left, center, and right headers for printed output

```

//This message applies to all display box objects
w = New Window( "Window", Text Box( "Header Test" ) );
w << Set Print Headers(
    "Today is: &d;"/*left*/, "&wt;"/*center*/,
    "Page &pn; of &pc;"/*right*/
);
w << Print Window;


```

### [Set Property](#set-property)

**Syntax:** obj \<< Set Property( "property", value )

**Description:** Sets the value for the named property for the display box.

```

New Window( "Example", bb = Button Box( "Press Me", Print( "Pressed" ) ) );
bb << Set Property( "Enabled", 0 );


```

### [Set Report Title](#set-report-title)

**Syntax:** obj \<< Set Report Title( "string" )

**Description:** Changes the report title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Report Title( "New Title" );


```

### [Set Stretch](#set-stretch)

**Syntax:** obj \<< Set Stretch( x,y )

**Description:** Sets the horizontal and vertical stretching behavior of the box. Boxes that stretch with Window will resize as the window or splitter size changes. Boxes that stretch to Fill will stretch to fill available space in their container. Boxes with stretching turned Off generally will not stretch. Most boxes default to Neutral, which means that they will determine their behavior based on their child boxes.

**JMP Version Added:** 16

#### [Stretch to Fill](#stretch-to-fill)

```

//This message applies to all display box objects
New Window( "Stretch",
    V List Box(
        H List Box( Text Edit Box( "String1" ), Text Edit Box( "String2" ) ),
        Spacer Box( Size( 20, 20 ), Color( "Light Red" ), <<Set Stretch( "Fill", "Off" ) )
    )
);


```

#### [Stretch with Window](#stretch-with-window)

```

//This message applies to all display box objects
New Window( "Example",
    H List Box(
        tv = Text Box( "V+V", <<rotate text( left ) ),
        V List Box(
            Text Box( "resize the containing window" ),
            th = Text Box( "H+H" ),
            ts = Spacer Box( <<Size( 10, 30 ), <<Color( "blue" ) )
        )
    )
);
tv << Vertical Alignment( "Center" );
th << Horizontal Alignment( "Center" );
th << Set Stretch( "Window", "Off" );
ts << Set Min Size( 5, 20 );
ts << Set Max Size( 100000, 100 );
ts << Set Stretch( "Window", "Window" );


```

### [Set Summary Behavior](#set-summary-behavior)

**Syntax:** obj \<< Set Summary Behavior( "Default"|"Visible"|"Collapse" )

**Description:** Sets the behavior of the box when a report is viewed in Summary mode.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
d << Report View( "Summary" );
r = d << Report;
tb = r[Table Box( 1 )];
tb << Set Summary Behavior( "Visible" );


```

### [Set Width](#set-width)

**Syntax:** obj \<< Set Width( width )

**Description:** Sets the width of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << Set Width( 400 );


```

### [Set Window Icon](#set-window-icon)

**Syntax:** obj \<< Set Window Icon( icon name )

**Description:** Sets the window icon.

```

//This message applies to all display box objects
w = New Window( "Example", ex = Button Box( "New Analysis" ) );
w << Set Window Icon( "Scatter3D" );


```

### [Set Window Size](#set-window-size)

**Syntax:** obj \<< Set Window Size( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 800, 1200 );


```

### [Set Window Title](#set-window-title)

**Syntax:** obj \<< Set Window Title( "string" )

**Description:** Changes the window title.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Set Window Title( "New Title" );


```

### [Show Properties](#show-properties)

**Syntax:** obj \<< Show Properties

**Description:** Displays a property editor for display boxes

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Properties();


```

### [Show Tree Structure](#show-tree-structure)

**Syntax:** obj \<< Show Tree Structure

**Description:** Displays a hierarchical tree structure of the display box and its related nodes.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rbiv << Show Tree Structure();


```

### [Show Window](#show-window)

**Syntax:** obj \<< Show Window( state=0|1 )

**Description:** Shows or hides the window. This is useful for hiding windows temporarily. On by default.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
Wait( 1 );
w << Show Window( 0 );
Wait( 2 );
w << Show Window( 1 );


```

### [Sib](#sib)

**Syntax:** obj \<< Sib

**Description:** Returns the sibling of the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
axisbox = rbiv[axis box( 1 )];
axisSibling = axisbox << sib();
Print( axisSibling << Class Name() );


```

### [Sib Append](#sib-append)

**Syntax:** obj \<< Sib Append( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately after this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r()[framebox( 1 )];
fb << sib append(
    Text Box( "============ after ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib append( Text Box( "=== below ===" ), "Vertical" );


```

### [Sib Prepend](#sib-prepend)

**Syntax:** obj \<< Sib Prepend( Display box, Horizontal|Vertical )

**Description:** Adds a display box immediately before this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/big class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
fb = r[framebox( 1 )];
fb << sib prepend(
    Text Box( "    ============ before ==============", Rotate Text( "Right" ) ),
    "Horizontal"
);
fb << sib prepend( Text Box( "=== above ===" ), "Vertical" );


```

### [Size Window](#size-window)

**Syntax:** obj \<< Size Window( x,y )

**Description:** Sets the size of the window.

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Size Window( 500, 500 );


```

### [Top Parent](#top-parent)

**Syntax:** obj \<< Top Parent

**Description:** Returns the root parent of this display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
rootParent = rbiv << Top Parent();
Print( rootParent << Class Name() );


```

### [UI Only](#ui-only)

**Syntax:** obj \<< UI Only( state=0|1 ); state = obj \<< Get UI Only

### [Update Window](#update-window)

**Syntax:** obj \<< Update Window

**Description:** Update the window holding the displaybox if there are invalidated regions. The \<<Inval message creates invalidated regions.

```

//This message applies to all display box objects
color = "green"; /* initial color in a variable */
New Window( "UpdateWindow example",
    Button Box( "red",
        color = "red";
        // try commenting out each of the 4 lines that follow, run the script,
        // click the buttons, and resize the windows (for example) to force a
        // redraw.  All 4 lines are important, though the last two may be
        // slightly different on Windows and Mac OSs.
        g1 << inval; /* tell the oval to redraw */
        g2 << inval; /* tell the rectangle to redraw */
        g1 << updateWindow; /* tell the oval window to update immediately */
        g2 << updateWindow; /* tell the rect window to update immediately */
        // this is a busy-wait to help demonstrate the various behaviors...
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 /* delay without wait(.5) */ );
    ),
    Button Box( "blue",
        color = "blue";
        g1 << inval; /* same comments */
        g2 << inval;
        g1 << updateWindow;
        g2 << updateWindow;
        x = Tick Seconds();
        While( Tick Seconds() - x < .5, 0 );
    )
);
New Window( "oval",
    g1 = Graph Box(/* the graph does NOT watch for the color variable to change
                      but will use the current value of color when it reshows */
        Fill Color( color );
        Oval( 10, 80, 70, 50, 1 );
    )
);
New Window( "rect",
    g2 = Graph Box(
        Fill Color( color );
        Rect( 10, 80, 70, 50, 1 );
    )
);


```

### [Vertical Alignment](#vertical-alignment)

**Syntax:** obj \<< Vertical Alignment( "Default"|"Top"|"Center"|"Bottom" ); "Default"|"Top"|"Center"|"Bottom" = obj \<< Get Vertical Alignment

**Description:** Vertical alignment controls the positioning of the box within a container if the box does not fill the entire space.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
lb = r[List Box( 6 )];
lb << Set Horizontal( 1 );
lb = r[List Box( 7 )];
lb << Border( 1 );
Wait( 2 );
lb << Vertical Alignment( "Bottom" );


```

### [Visibility](#visibility)

**Syntax:** obj \<< Visibility( "Visible"|"Hidden"|"Collapse" ); "Visible"|"Hidden"|"Collapse" = obj \<< Get Visibility

**Description:** Visibility determines whether a box is shown and whether it takes up space. The default value of "Visible" means that the object will be shown. A "Hidden" box is not shown but still takes up space, while a "Collapsed" box takes up no space in the layout.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
d = dt << Distribution( Column( :height ) );
r = d << report;
tb = r[Table Box( 1 )];
Show( tb << Get Visibility );
Wait( 1 );
tb << Visibility( "Collapse" );
Show( tb << Get Visibility );


```

### [Window Class Name](#window-class-name)

**Syntax:** obj \<< Window Class Name

**Description:** Returns the name of the window class for the display box.

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Bivariate( y( :weight ), x( :height ) );
rbiv = biv << report;
Show( biv << Window Class Name() );
Show( rbiv << Window Class Name() );


```

### [XPath](#xpath)

**Syntax:** obj \<< XPath( XPath expression, \<English(0|1)>, \<NoData(0|1)> )

**Description:** Applies an XPath expression to the XML representation of the display tree and returns the results. By default, strings are returned in the local language, and the XML includes data values within some boxes. Use the English option to return English strings where available. Use the NoData option to omit the data values within boxes, which is useful for performance when your query is based only on box attributes.

#### [Attributes](#attributes)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[@isOpen='false']" )) << Close( 0 );


```

#### [Box type](#box-type)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//TextEditBox" )) << Text Color( "Green" );


```

#### [Child box](#child-box)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Summary of Fit']/TableBox" )) <<
Make Into Data Table;


```

#### [Data](#data)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//NumberColBoxItem[text()='40']/parent::*" )) <<
Text Color( "Green" );


```

#### [Display Seg](#display-seg)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//MarkerSeg" )) << Set Marker( "Square" );


```

#### [Text](#text_1)

```

//This message applies to all display box objects
dt = Open( "$SAMPLE_DATA/Big Class.jmp" );
biv = dt << Run Script( "Bivariate" );
(Report( biv ) << xpath( "//OutlineBox[text()='Parameter Estimates']" )) << Close;


```

### [Zoom Window](#zoom-window)

**Syntax:** obj \<< Zoom Window

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

```

//This message applies to all display box objects
w = Open( "$SAMPLE_DATA/Big Class.jmp" );
w << Set Window Size( 80, 120 );
Wait( 2 );
w << Zoom Window;


```
# JMP Python Usage Documentation

# [Python Integration](#python-integration)

## [Functions](#functions)

### [ALL_HOME](#all_home)

**Syntax:** jmp.ALL_HOME

**Description:** Value corresponding to JSL's $ALL_HOME directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.ALL_HOME)


```

### [BUILTIN_SCRIPTS](#builtin_scripts)

**Syntax:** jmp.BUILTIN_SCRIPTS

**Description:** Value corresponding to JSL's $BUILTIN_SCRIPTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.BUILTIN_SCRIPTS)


```

### [Constants](#constants)

### [DESKTOP](#desktop)

**Syntax:** jmp.DESKTOP

**Description:** Value corresponding to JSL's $DESKTOP directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.DESKTOP)


```

### [DOCUMENTS](#documents)

**Syntax:** jmp.DOCUMENTS

**Description:** Value corresponding to JSL's $DOCUMENTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.DOCUMENTS)


```

### [DOWNLOADS](#downloads)

**Syntax:** jmp.DOWNLOADS

**Description:** Value corresponding to JSL's $DOWNLOADS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.DOWNLOADS)


```

### [DataType](#datatype)

**Syntax:** jmp.DataType.enum_value

**Description:** jmp.DataType is an enumeration representing a JMP column's data types. These are used with the jmp.DataTable.new_column() function to create columns other than the default Numeric type.

**JMP Version Added:** 18

```

import jmp

# for the sake of typing
from jmp import DataType as dType
print('jmp.DataType members:')
print( list(map(lambda c: c.name, dType)) )


```

### [Enums](#enums)

### [Functions](#functions_1)

### [HOME](#home)

**Syntax:** jmp.HOME

**Description:** Value corresponding to JSL's $HOME directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.HOME)


```

### [JMPPRJ](#jmpprj)

**Syntax:** jmp.JMPPRJ

**Description:** Returns the physical path of the project's temporary directory. Returns the current working directory, or None if script is not running within a project.

**JMP Version Added:** 19

```

import jmp
print(jmp.JMPPRJ)


```

### [ModelingType](#modelingtype)

**Syntax:** jmp.ModelingType.enum_value

**Description:** jmp.ModelingType is an enumeration representing a JMP column's modeling or analysis type. These are used with the jmp.DataTable.new_column() function to create columns other than the default Continuous modeling type. Note TypeNone differs from JMP's modeling type None as 'None' is a Python keyword.

**JMP Version Added:** 18

```

import jmp

# for the sake of typing
from jmp import ModelingType as mType
print('jmp.ModleingType members:')
print( list(map(lambda c: c.name, mType)) )


```

### [PYTHONW_EXE](#pythonw_exe)

**Syntax:** jmp.PYTHONW_EXE

**Description:** Path to the JMP installed no-console Python executable (Windows only).

**JMP Version Added:** 19

```

import jmp

import platform
if platform.system() == "Windows":
    print(jmp.PYTHONW_EXE)


```

### [PYTHON_EXE](#python_exe)

**Syntax:** jmp.PYTHON_EXE

**Description:** Path to the JMP installed Python executable.

**JMP Version Added:** 18

```

import jmp
print(jmp.PYTHON_EXE)


```

### [PY_USER_APPDIR](#py_user_appdir)

**Syntax:** jmp.PY_USER_APPDIR

**Description:** Path to the user directory location acting as the base of JMP's Python support. The site-packages directory is within this directory hierarchy.

**JMP Version Added:** 18

```

import jmp
print(jmp.PY_USER_APPDIR)


```

### [SAMPLE_APPS](#sample_apps)

**Syntax:** jmp.SAMPLE_APPS

**Description:** Value corresponding to JSL's $SAMPLE_APPS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_APPS)


```

### [SAMPLE_DASHBOARDS](#sample_dashboards)

**Syntax:** jmp.SAMPLE_DASHBOARDS

**Description:** Value corresponding to JSL's $SAMPLE_DASHBOARDS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_DASHBOARDS)


```

### [SAMPLE_DATA](#sample_data)

**Syntax:** jmp.SAMPLE_DATA

**Description:** Value corresponding to JSL's $SAMPLE_DATA directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_DATA)


```

### [SAMPLE_IMAGES](#sample_images)

**Syntax:** jmp.SAMPLE_IMAGES

**Description:** Value corresponding to JSL's $SAMPLE_IMAGES directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_IMAGES)


```

### [SAMPLE_IMPORT_DATA](#sample_import_data)

**Syntax:** jmp.SAMPLE_IMPORT_DATA

**Description:** Value corresponding to JSL's $SAMPLE_IMPORT_DATA directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_IMPORT_DATA)


```

### [SAMPLE_PROJECTS](#sample_projects)

**Syntax:** jmp.SAMPLE_PROJECTS

**Description:** Value corresponding to JSL's $SAMPLE_PROJECTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_PROJECTS)


```

### [SAMPLE_SCRIPTS](#sample_scripts)

**Syntax:** jmp.SAMPLE_SCRIPTS

**Description:** Value corresponding to JSL's $SAMPLE_SCRIPTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_SCRIPTS)


```

### [TEMP](#temp)

**Syntax:** jmp.TEMP

**Description:** Value corresponding to JSL's $TEMP directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.TEMP)


```

### [USER_APPDATA](#user_appdata)

**Syntax:** jmp.USER_APPDATA

**Description:** Value corresponding to JSL's $USER_APPDATA directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.USER_APPDATA)


```

### [**jmp_version**](#jmp_version)

**Syntax:** jmp.**jmp_version**

**Description:** Version number of the JMP executable.

**JMP Version Added:** 18

```

import jmp
print(jmp.__jmp_version__)


```

### [**version**](#version)

**Syntax:** jmp.**version**

**Description:** Version number of the 'jmp' import package. This is not the JMP version.

**JMP Version Added:** 18

```

import jmp
print(jmp.__version__)


```

### [current](#current)

**Syntax:** dt = jmp.current()

**Description:** Returns a DataTable object for the current JMP data table.

**JMP Version Added:** 18

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(jmp.current())


```

### [eval](#eval)

**Syntax:** result = eval(<string>|<Expression>)

**Description:** Evaluates the argument and returns the result.

**JMP Version Added:** 19

```

import jmp

from jmp import eval, Expression
expression = Expression("2 + 2")
result = eval(expression)
print(result)


```

### [from_dataframe](#from_dataframe)

**Syntax:** result = jmp.from_dataframe(\<library.Dataframe>, allow_copy=<boolean>, allow_csv_fallback=<boolean>, visibility=<string>)

**Description:** Returns a jmp.DataTable object from a protocol compliant library's dataframe.

**JMP Version Added:** 19

#### [CSV Fallback](#csv-fallback)

```

import jmp

import jmputils        
try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

# Object columns are unsupported with jmp.from_dataframe() 
df = pd.DataFrame({
    "objects": pd.Series([{"a": 1, "b": 2}, {"a": 3, "b": 4}, {"a": 5, "b": 6}, {"a": 7, "b": 8}, {"a": 9, "b": 10}, {"a": 11, "b": 12}]),
})

dt = jmp.from_dataframe(df)
print(dt)


```

#### [Ibis to JMP](#ibis-to-jmp)

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
    jmputils.jpip('install', 'ibis-framework[duckdb,examples]')

except Exception as e:
    print(f'Install failed with exception: {e}')         

 import pandas as pd
 import ibis

 pandas_df = pd.DataFrame(
     [["a", 1, 2], ["b", 3, 4]],
     columns=["one", "two", "three"],
 )
 t = ibis.memtable(pandas_df, name="t")
 print(t)
 dt = jmp.from_dataframe(t)
 print(dt)


```

#### [JMP to Pandas](#jmp-to-pandas)

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
pandas_df = (pd.api.interchange.from_dataframe(dt))
print(pandas_df)


```

#### [JMP to Polars](#jmp-to-polars)

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('polars'):
        jmputils.jpip('install', 'polars', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import polars as pl

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
polars_df = pl.from_dataframe(dt)
print(polars_df)


```

#### [Pandas to JMP](#pandas-to-jmp)

```

import jmp

import jmputils

try:
    # pandas depends on numpy will install numpy if needed
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd
import numpy as np

pandas_df = pd.DataFrame(
    {
        "A": 1.0,
        "B": pd.Timestamp("20130102"),
        "C": pd.Series(1, index=list(range(4)), dtype="float32"),
        "D": np.array([3] * 4, dtype="int32"),
        "E": pd.Categorical(["test", "train", "test", "train"]),
        "F": "foo",
    }
)
print(pandas_df)

dt = jmp.from_dataframe(pandas_df)
print(dt)


```

#### [Polars to JMP](#polars-to-jmp)

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('polars'):
        jmputils.jpip('install', 'polars', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import polars as pl
from datetime import date

polars_df = pl.DataFrame(
 {
    "foo": [1, 2, 3],
    "bar": [6.0, 7.0, 8.0],
    "ham": [date(2020, 1, 2), date(2021, 3, 4), date(2022, 5, 6)],
  }
 )
 print(polars_df)
 dt = jmp.from_dataframe(polars_df)
 print(dt)


```

#### [Visibility](#visibility)

```

import jmp

import jmputils

try:
    # pandas depends on numpy will install numpy if needed
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd
import numpy as np

pandas_df = pd.DataFrame(
    {
        "A": 1.0,
        "B": pd.Timestamp("20130102"),
        "C": pd.Series(1, index=list(range(4)), dtype="float32"),
        "D": np.array([3] * 4, dtype="int32"),
        "E": pd.Categorical(["test", "train", "test", "train"]),
        "F": "foo",
    }
)
print(pandas_df)

dt = jmp.from_dataframe(pandas_df, visibility="invisible")
#dt = jmp.from_dataframe(pandas_df, visibility="private")

print(dt)


```

### [from_dataframe_using_csv](#from_dataframe_using_csv)

**Syntax:** result = jmp.from_dataframe_using_csv(\<library.Dataframe>, visibility=<string>)

**Description:** Returns a jmp.DataTable object from a library's dataframe using the provided CSV conversion method.

**JMP Version Added:** 19

#### [General](#general)

```

import jmp

import jmputils
try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

# Object columns are unsupported with jmp.from_dataframe() 
df = pd.DataFrame({
    "objects": pd.Series([{"a": 1, "b": 2}, {"a": 3, "b": 4}, {"a": 5, "b": 6}, {"a": 7, "b": 8}, {"a": 9, "b": 10}, {"a": 11, "b": 12}]),
})

try:
    # Try converting object without CSV fallback
    dt = jmp.from_dataframe(df, True, False)
    print("Converted using jmp.from_dataframe()")
except: 
    # Explicitly convert using CSV
    dt = jmp.from_dataframe_using_csv(df)
    print("Converted using jmp.from_dataframe_using_csv()")

print(dt)


```

#### [Visibility](#visibility_1)

```

import jmp

import jmputils
try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

# Object columns are unsupported with jmp.from_dataframe() 
df = pd.DataFrame({
    "objects": pd.Series([{"a": 1, "b": 2}, {"a": 3, "b": 4}, {"a": 5, "b": 6}, {"a": 7, "b": 8}, {"a": 9, "b": 10}, {"a": 11, "b": 12}]),
})

dt = jmp.from_dataframe_using_csv(df, visibility="invisible")
#dt = jmp.from_dataframe_using_csv(df, visibility="private")

print(dt)


```

### [open](#open)

**Syntax:** obj = jmp.open('file_path' < , visibility='Invisible | Private' )

**Description:** Opens a file located at file_path. If the file is a .jmp file or a file that imports into a JMP data table, the object returned will be a DataTable object. Otherwise will return True or False for success or failure. The optional visibility parameter controls whether the opened file is hidden from view. Invisible is just hidden from view, while still showing up in the recent files menu and home window. With a Private table, the reference returned is the only reference to the table, and it does not appear in any of the file lists.

**JMP Version Added:** 18

#### [Excel](#excel)

```

import jmp

obj = jmp.open(jmp.SAMPLE_IMPORT_DATA + 'Bigclass.xlsx')
print(obj)


```

#### [Invisible](#invisible)

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Animals.jmp', visibility = 'Invisible')
dt = jmp.current()
print(dt)  # success
dt = jmp.table('Animals')
print(dt)  # success
# Select and run the above first if you want to see that even though
# there is no window, Animals.jmp appears in recent files and
# home window's list of files
dt.close(save=False);
del dt


```

#### [JMP](#jmp)

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(dt)


```

#### [JSL Script](#jsl-script)

```

import jmp

obj = jmp.open(jmp.SAMPLE_SCRIPTS + 'string.jsl')
print(obj)


```

#### [Private](#private)

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Animals.jmp', visibility = 'Private')
dt = jmp.current()
print(dt)  # => None
try:
  dt = jmp.table('Animals')
except FileNotFoundError:
  print('Requested table not found')
dt = jmp.open(jmp.SAMPLE_DATA + 'Animals.jmp', visibility = 'Private')
print(dt)
dt.close(save=False)
del dt


```

### [path_variable](#path_variable)

**Syntax:** path_value = jmp.path_variable('SAMPLE_DATA')

**Description:** Returns the value of a path variable, which is a name like SAMPLE_DATA that is substituted for when found in pathnames.

**JMP Version Added:** 19

```

import jmp

path_value = jmp.path_variable('SAMPLE_DATA')
if not path_value:
    print('Invalid path variable.')
else:
    print(path_value)


```

### [r_name](#r_name)

**Syntax:** dt = jmp.r_name(jsl_var)

**Description:** Maps a JMP variable name to an R variable name using R variable naming rules.

**JMP Version Added:** 19

```

import jmp

rName = jmp.r_name('c d e')
print(rName)


```

### [reset](#reset)

**Syntax:** jmp.reset()

**Description:** Resets the shared Python environment, primarily clearing all references to objects. This does not change the import cache of imported modules. This is a limitation of the Python environment itself. Modules that load shared libraries cannot be unloaded by the running process. To reload pure Python code, see the Python.org documentation on importlib reload().

**JMP Version Added:** 19

```

import jmp

pi = 3.1415927
print(pi)
jmp.reset()
print(pi)


```

### [run_jsl](#run_jsl)

**Syntax:** result = jmp.run_jsl('JSL script contents' \<, echo = True | False | None > )

**Description:** Run JSL scripting from within the Python environment, including the JSL Python interface functions. Optional echo= parameter when set to False or None stops the presented JSL source code from echoing to the log. A result will be returned for the same JSL object types that are supported by Python Send() / Get(). Script failure or unsupported JSL object types will return None.

**JMP Version Added:** 18

#### [Column Properties](#column-properties)

```

import jmp

# Create a data table
# dt = jmp.DataTable(name='table_name', rows=n)
pbp = jmp.DataTable(rows=5)
pbp.name = 'Powered by Python'
pbp.new_column('Name', jmp.DataType.Character)
pbp.new_column('Hourly Rate')
#
pbp['Name'] = ['Janet', 'James', 'Jerry', 'Jenny', 'Jill']
pbp[1] = [ 14.25, 9.75, 15.0, 12.35, '17.25']  # last value bad => becomes missing
pbp[1][4] = 17.25
#
# Change column format: Hourly Rate
jmp.run_jsl('''
Data Table( "Powered by Python" ):Hourly Rate << Format( "Currency", "USD", 17, 2 );
Data Table( "Powered by Python" ):Name << Set Display Width( 75 );
''')


```

#### [Get Version](#get-version)

```

import jmp

jmp.run_jsl('Python Get Version();')


```

#### [Returned value](#returned-value)

```

import jmp

value = jmp.run_jsl('''
Names default to here(1);
an A = 1.5;
x = 5 * anA;
''')
print( f'{value} = jmp.run_jsl()')


```

### [table](#table)

**Syntax:** dt = jmp.table('table_name')

**Description:** Returns a DataTable object for the opened table having 'table_name'

**JMP Version Added:** 18

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print( jmp.table('Big Class') )


```

## [jmp > DataConnector](#jmp-dataconnector)

### [Functions](#functions_2)

#### [Ability to copy with copy.copy](#ability-to-copy-with-copycopy)

**Description:** DataConnector objects support shallow copying with the standard copy.copy function.

Changing the copying behavior in subclasses is not supported, so subclasses should not add additional instance attributes because they will not be copied.

**JMP Version Added:** 19

```

import jmp

import copy

class ExampleConnectorType(jmp.DataConnectorType):
    fields = {'My Option': int}

class ExampleConnector(jmp.DataConnector):
    def _do_as_data_source(self):
        return ExampleDataSource(copy.copy(self))

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

class ExampleDataSource(jmp.DataSource):
    def __init__(self, config):
        self._config = config
        print("Connecting to data source")

    def get_tables(self, schema):
        return ['example']

    def open_table(self, schema, table):
        dt = jmp.DataTable(rows=1, visibility='private')
        dt.new_column('column')
        dt['column'] = [self._config['My Option']]
        return dt

jmp.run_jsl(r"""
New SQL Query(
    Connection(
        New Data Connector(
            Type( "Python:__main__:ExampleConnectorType" ),
            My Option( 42 )
        )
    ),
    QueryName( "example" ),
    Select( Star ),
    From( Table( "example", Alias( "t1" ) ) )
) << Run;
""", echo=False)


```

#### [Concepts](#concepts)

#### [Functions](#functions_3)

#### [Methods](#methods)

#### [Special Items](#special-items)

#### [**getitem**](#getitem)

**Syntax:** value = dc["FIELD NAME"]

**Description:** Gets the value associated with a field.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {"Example Field": str}

class ExampleConnector(jmp.DataConnector):
    ...

    def _do_as_data_source(self):
        ef = self["Example Field"]
        # When running the JSL below, ef will be "example value"
        print(f"{ef=}")
        ...

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

# This will fail but only after printing the value
jmp.run_jsl("""
    New SQL Query( Connection(
        New Data Connector(
            Type("Python:__main__:ExampleConnectorType"),
            Example Field("example value")
        )
    ) ) << Modify
""", echo=False)


```

#### [\_do_as_data_source](#_do_as_data_source)

**Syntax:** def \_do_as_data_source(self) -> jmp.DataSource:

**Description:** Subclasses should override this function to create a connection. The returned connection, in the form of a subclass of jmp.DataSource, enables integration with Query Builder.

Avoid storing and using a reference to the connector instance (self) in the returned data source. Other code might also hold a reference and change configuration values unexpectedly. Instead, consider using copy.copy to make an independent copy to refer to, like "self_copy = copy.copy(self)".

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {'My Option': int}

class ExampleConnector(jmp.DataConnector):
    def _do_as_data_source(self):
        return ExampleDataSource(self['My Option'])

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

class ExampleDataSource(jmp.DataSource):
    def __init__(self, my_option):
        self._my_option = my_option
        print("Connecting to data source")

    def get_tables(self, schema):
        return ['example']

    def open_table(self, schema, table):
        dt = jmp.DataTable(rows=1, visibility='private')
        dt.new_column('column')
        dt['column'] = [self._my_option]
        return dt

jmp.run_jsl(r"""
New SQL Query(
    Connection(
        New Data Connector(
            Type( "Python:__main__:ExampleConnectorType" ),
            My Option( 42 )
        )
    ),
    QueryName( "example" ),
    Select( Star ),
    From( Table( "example", Alias( "t1" ) ) )
) << Run;
""", echo=False)


```

#### [\_do_open](#_do_open)

**Syntax:** def \_do_open(self) -> jmp.DataTable:

**Description:** Subclasses can override this function to open a table directly. This function implements the Open message in JSL (New Data Connector(...) \<< Open()).

If both this function and \_do_as_data_source are implemented, they should be able to open the same set of tables.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {'My Option': int}

class ExampleConnector(jmp.DataConnector):
    def _do_open(self):
        dt = jmp.DataTable(rows=1)
        dt.new_column('column')
        dt['column'] = [self['My Option']]
        return dt

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

jmp.run_jsl(r"""
New Data Connector(
    Type( "Python:__main__:ExampleConnectorType" ),
    My Option( 42 )
) << Open();
""", echo=False)


```

#### [tie](#tie)

**Syntax:** jmp.DataConnector.tie(DataConnectorTypeClass, DataConnectorClass)

**Description:** Associates a jmp.DataConnectorType subclass and a jmp.DataConnector subclass, "tying" them together and completing the definitions of both classes. This association gives the jmp.DataConnector subclass access to the jmp.DataConnectorType subclass and its field definitions. It also ensures that the jmp.DataConnectorType subclass creates jmp.DataConnector instances using the specified subclass.

This function creates the association by setting attributes on the subclasses.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {'My Option': int}

class ExampleConnector(jmp.DataConnector):
    def _do_open(self):
        dt = jmp.DataTable(rows=1)
        dt.new_column('column')
        dt['column'] = [self['My Option']]
        return dt

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

jmp.run_jsl(r"""
New Data Connector(
    Type( "Python:__main__:ExampleConnectorType" ),
    My Option( 42 )
) << Open();
""", echo=False)


```

## [jmp > DataConnectorField](#jmp-dataconnectorfield)

### [Functions](#functions_4)

#### [Constructors](#constructors)

#### [**init**](#init)

**Syntax:** field = jmp.DataConnectorField(type, \<default=DEFAULT_VALUE,> \<tooltip="TOOLTIP" | None,> \<ui_name="UI NAME" | None,> \<credential="CREDENTIAL TYPE" | None,> \<sensitive=True | False,> \<mask_input=True | False>)

**Description:** DataConnectorField defines a field.

Base arguments:

type: The type of the field, such as int (see jmp.DataConnectorType.fields for more information).

default: The default value for the field, such as 42. If not provided, the default value depends on the type. The default value is None if that is supported, for example, if the type is "int | None". Otherwise, it is the "empty" value for the type: "" for str, 0 for int, and False for bool.

tooltip: If provided and not None, it is used as a tooltip for the field in the data connector editor.

ui_name: If provided and not None, it is used as the name of the field in the data connector editor instead of the actual name of the field.

Extra arguments when type is "str" or "str | None":

credential: If provided and not None, the type of credential stored by this field. The valid values are "username" and "password". JMP uses this information to enable placeholder support.

sensitive: When true, this field is considered to hold sensitive information and as such its values are not written out in plain text. Defaults to true if "credential" is set and false otherwise.

mask_input: When true, the value is obscured and shown with dots in the Data Connector Editor. Defaults to true if "credential" is "password" or "sensitive" is true and credential is not set.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    _DCF = jmp.DataConnectorField
    fields = {
        "Field 1": int,
        # Same as Field 1 but uses jmp.DataConnectorField instead of a bare type
        "Field 2": _DCF(int),
        # Like Field 1 and Field 2 but adds a tooltip
        "Field 3": _DCF(int, tooltip="The third field."),
        # Like Field 1 and Field 2 but adds a default value and a tooltip
        "Field 4": _DCF(int, default=42, tooltip="The fourth field."),
        # ui_name is useful for JSL-unfriendly names or localization
        "JSL Unfriendly Field": _DCF(int, ui_name="JSL-Unfriendly Field"),
        # credential (and sensitive and mask_input) are useful for usernames,
        # passwords, and other sorts of credentials
        "Password Field": _DCF(str, credential="password"),
    }

class ExampleConnector(jmp.DataConnector):
    def _do_open(self):
        # Show the values then error
        print(f"{self["Field 1"] = }")
        print(f"{self["Field 2"] = }")
        print(f"{self["Field 3"] = }")
        print(f"{self["Field 4"] = }")
        print(f"{self["JSL Unfriendly Field"] = }")
        print(f"{self["Password Field"] = }")
        raise NotImplementedError

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

# To see the tooltips, the UI name, and the masking triggered by credential,
# you'll need to launch the Data Connector Editor and set the type to
# Python:__main__:ExampleConnectorType.
jmp.run_jsl(r"""
New Data Connector(
    Type( "Python:__main__:ExampleConnectorType" ),
    Field 1( 4 ),
    Field 2( 19 ),
    Field 3( 23 ),
    Field 4( 42 ),
    JSL Unfriendly Field( 65 ),
    // This encodes the string "107":
    Password Field( "0173AEE42BA6B646CBE03941DD25153DAAFDF2ED3039A9E64296808E53DA110CDE45733216E9B2A3F82AA052F370443F231C8B1D83E2AA68B6D19DD4B6BB0CE08F635C07162E3E13B2AF77D25DF8DDD1DB" )
) << Open();
""", echo=False)


```

## [jmp > DataConnectorGroupedFields](#jmp-dataconnectorgroupedfields)

### [Functions](#functions_5)

#### [Constructors](#constructors_1)

#### [**init**](#init_1)

**Syntax:** fields = jmp.DataConnectorGroupedFields([("Group 1 Name", GROUP_1_FIELDS), ("Group 2 Name", GROUP_2_FIELDS), ...])

**Description:** jmp.DataConnectorGroupedFields defines fields in named groups. The groups are passed as a list of pairs. The first element of each pair is the name of the group, and the second is a dictionary with the fields. This dictionary has the same format as one used directly as the value for jmp.DataConnectorType.fields.

The use of groups affects the fields' presentation in the data connector editor but not their programmatic access. The group name is used only in the UI, so the advice for field names to avoid characters that should not be used in JSL names does not apply.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = jmp.DataConnectorGroupedFields([
        # Specify a first group named "Route" that has "Destination" and
        # "Origin" fields.
        ("Route", {
            "Destination": str,
            "Origin": str,
        }),
        # Specify a second group named "Vehicle" that has "Passengers" and
        # "Range" fields.
        ("Vehicle", {
            "Passengers": int,
            "Range": int,
        }),
    ])

class ExampleConnector(jmp.DataConnector):
    def _do_open(self):
        # Show the values then error
        print(f"{self["Destination"] = }")
        print(f"{self["Origin"] = }")
        print(f"{self["Passengers"] = }")
        print(f"{self["Range"] = }")
        raise NotImplementedError

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

# To see the groups you'll need to launch the Data Connector Editor
# and set the type to Python:__main__:ExampleConnectorType.
jmp.run_jsl(r"""
New Data Connector(
    Type( "Python:__main__:ExampleConnectorType" ),
    Destination( "JMP" ),
    Origin( "RDU" ),
    Passengers( 5 ),
    Range( 254 )
) << Open();
""")


```

## [jmp > DataConnectorType](#jmp-dataconnectortype)

### [Functions](#functions_6)

#### [Properties](#properties)

#### [fields](#fields)

**Syntax:** fields = {"Name 1": TYPE_1 | jmp.DataConnectorField(...), "Name 2": TYPE_2 | jmp.DataConnectorField(...), ...} | jmp.DataConnectorGroupedFields(...)

**Description:** Subclasses must define a class-level variable named "fields" that specifies the configuration options for this type. It should be a dict or a jmp.DataConnectorGroupedFields object.

The keys of the dict are the names of the configuration options, which are exposed in JSL and the editor. They should be formatted like JSL identifiers. The value corresponding to each key is the type of the field, such as str or int, or a jmp.DataConnectorField object.

The supported types include bool, int, and str. Optional versions of these, such as typing.Optional[bool] or bool | None for bool, are also supported. A missing value is represented by None.

**JMP Version Added:** 19

```

import jmp

import typing

class ExampleConnectorType(jmp.DataConnectorType):
    _DCF = jmp.DataConnectorField
    fields = {
        "Basic Int Field": int,
        "Optional Int Field": int | None,
        "Alternative Optional Int Field": typing.Optional[int],
        "Int Field With Default And Tooltip": _DCF(int, default=42, tooltip=(
            "Tooltip for complicated int field."
        )),
        "Catalog": _DCF(str, default="main", tooltip=(
            "Database catalog in which to access schemas and tables."
        )),
    }

class ExampleConnector(jmp.DataConnector):
    def _do_open(self):
        # Show values for demo purposes and then error out
        print(f"{self["Basic Int Field"] = }")
        print(f"{self["Optional Int Field"] = }")
        print(f"{self["Alternative Optional Int Field"] = }")
        print(f"{self["Int Field With Default And Tooltip"] = }")
        print(f"{self["Catalog"] = }")
        raise NotImplementedError

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

# To see the tooltips you'll need to launch the Data Connector Editor
# and set the type to Python:__main__:ExampleConnectorType.
jmp.run_jsl(r"""
New Data Connector( Type( "Python:__main__:ExampleConnectorType" ) ) << Open();
""")


```

## [jmp > DataSource](#jmp-datasource)

### [Functions](#functions_7)

#### [Methods](#methods_1)

#### [get_schemas](#get_schemas)

**Syntax:** def get_schemas(self) -> Sequence[str] | None:

**Description:** Subclasses can override this function to provide a list of the schemas in the data source. If this function is not overridden or it returns None, the data source is assumed to not support schemas.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {}

class ExampleConnector(jmp.DataConnector):
    def _do_as_data_source(self):
        return ExampleDataSource()

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

# Pretend our data source has two schemas, each with a table
class ExampleDataSource(jmp.DataSource):
    def get_schemas(self):
        # Normally you would get this dynamically instead of hard-coding it.
        return ['schema1', 'schema2']

    def get_tables(self, schema):
        return ['example']

    def open_table(self, schema, table):
        dt = jmp.DataTable(rows=1, visibility='private')
        dt.new_column('column', jmp.DataType.Character)
        dt['column'] = [f'{schema}.{table}']
        return dt

jmp.run_jsl(r"""
New SQL Query(
    Connection(
        New Data Connector(
            Type( "Python:__main__:ExampleConnectorType" )
        )
    ),
    QueryName( "example" ),
    Select( Star ),
    From( Table( "example", Schema( "schema1" ), Alias( "t1" ) ) )
) << Run;
""", echo=False)


```

#### [get_tables](#get_tables)

**Syntax:** def get_tables(self, schema: str) -> Sequence\[str\]:

**Description:** Subclasses should override this function to provide a list of the tables in the data source. If schemas are supported, this list should include only the tables under the schema that is passed. If schemas are not supported, the schema parameter should be ignored.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {}

class ExampleConnector(jmp.DataConnector):
    def _do_as_data_source(self):
        return ExampleDataSource()

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

class ExampleDataSource(jmp.DataSource):
    def get_tables(self, schema):
        # Normally you would get this dynamically instead of hard-coding it.
        return ['example1', 'example2']

    def open_table(self, schema, table):
        dt = jmp.DataTable(rows=1, visibility='private')
        dt.new_column('column', jmp.DataType.Character)
        dt['column'] = [table]
        return dt

jmp.run_jsl(r"""
New SQL Query(
    Connection(
        New Data Connector(
            Type( "Python:__main__:ExampleConnectorType" )
        )
    ),
    QueryName( "A" ),
    Select( Star ),
    From( Table( "example1", Alias( "t1" ) ) )
) << Run;
""", echo=False)


```

#### [open_table](#open_table)

**Syntax:** def open_table(self, schema: str, table: str) -> jmp.DataTable | str:

**Description:** Subclasses should override this function to get the table data for the named table. If schemas are not supported, the value of the schema argument can be ignored. The function should return a jmp.DataTable or a string containing a path to a file in a data format supported by JMP.

If returning a data table directly, the table should be created privately. If returning a path string, JMP opens the table itself and captures the settings that it used, preserving them in Query Builder scripts.

**JMP Version Added:** 19

**Create the table directly**

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {}

class ExampleConnector(jmp.DataConnector):
    def _do_as_data_source(self):
        return ExampleDataSource()

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

class ExampleDataSource(jmp.DataSource):
    def get_tables(self, schema):
        return ['example']

    def open_table(self, schema, table):
        # Normally you would use schema and table.
        dt = jmp.DataTable(rows=1, visibility='private')
        dt.new_column('Hello', jmp.DataType.Character)
        dt['Hello'] = ['world!']
        return dt

jmp.run_jsl(r"""
New SQL Query(
    Connection(
        New Data Connector(
            Type( "Python:__main__:ExampleConnectorType" )
        )
    ),
    QueryName( "example" ),
    Select( Star ),
    From( Table( "example", Alias( "t1" ) ) )
) << Run;
""", echo=False)


```

**Return a file path**

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {}

class ExampleConnector(jmp.DataConnector):
    def _do_as_data_source(self):
        return ExampleDataSource()

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

class ExampleDataSource(jmp.DataSource):
    def get_tables(self, schema):
        return ['example']

    def open_table(self, schema, table):
        # Normally you would use schema and table.
        return jmp.SAMPLE_IMPORT_DATA + 'Bigclass_L.txt'

jmp.run_jsl(r"""
New SQL Query(
    Connection(
        New Data Connector(
            Type( "Python:__main__:ExampleConnectorType" )
        )
    ),
    QueryName( "example" ),
    Select( Star ),
    From( Table( "example", Alias( "t1" ) ) )
) << Run;
""", echo=False)


```

#### [open_table_with_settings](#open_table_with_settings)

**Syntax:** def open_table_with_settings(self, schema: str, table: str, settings: str | None) -> (jmp.DataTable, str | None):

**Description:** Subclasses can override this function instead of open_table to provide custom handling of table open settings. This function is like open_table but is also called with the existing settings, if any. It must return a data table, and it must also return the new settings, if any. Missing settings are indicated by None.

**JMP Version Added:** 19

```

import jmp


class ExampleConnectorType(jmp.DataConnectorType):
    fields = {}

class ExampleConnector(jmp.DataConnector):
    def _do_as_data_source(self):
        return ExampleDataSource()

jmp.DataConnector.tie(ExampleConnectorType, ExampleConnector)

class ExampleDataSource(jmp.DataSource):
    def get_tables(self, schema):
        return ['example']

    def open_table_with_settings(self, schema, table, settings):
        print(f"Input settings: {settings!r}")
        if settings is None:
            # In practice settings are something you prompt the user
            # for, but here we hard-code it.
            settings = f'settings for {table}'
        dt = jmp.DataTable(visibility='private')
        dt.new_column()
        print(f"Output settings: {settings!r}")
        return dt, settings

jmp.run_jsl(r"""
Write( ( New SQL Query(
    Connection(
        New Data Connector(
            Type( "Python:__main__:ExampleConnectorType" )
        )
    ),
    QueryName( "example" ),
    Select( Star ),
    From( Table( "example", Alias( "t1" ) ) )
) << Run Foreground ) << Get Property( "Source" ) );
""", echo=False)


```

## [jmp > DataTable > Column](#jmp-datatable-column)

### [Functions](#functions_8)

#### [Concepts](#concepts_1)

#### [Constructors](#constructors_2)

#### [Equality](#equality)

**Description:** The Column object supports equality and inequality checks. Since a DataTable.Column is actually a reference to a live data table column, multiple Column objects could point to the same actual column. The checks for equality == and inequality != test do not compare content. Instead they check whether two DataTable.Column objects point to the column.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
col1 = dt[0]
col2 = dt['name']
col3 = dt['age']
print( col1 == col2 )
print( col1 == col3 )
print( col1 != col2 )
print( col1 != col3 )


```

#### [Mapping](#mapping)

**Description:** The DataTable.Column object supports the Python mapping protocol. Providing the array [] operators utilizing the numeric row index.

**JMP Version Added:** 18

```

import jmp

dt = jmp.DataTable('Names', 5)
dt.new_column('First Name', jmp.DataType.Character)
dt[0]  = ['Paul', 'Kimi', 'Evan', 'Ernest', 'Shannon' ]
for i in range(0, dt.nrows):
    print( dt[0][i] )


```

#### [Properties](#properties_1)

#### [Sequence](#sequence)

**Description:** The DataTable.Column behaves like a Python sequence. This allows iterating on the values of the column.

**JMP Version Added:** 18

```

import jmp

dt = jmp.DataTable('Names', 5)
dt.new_column('First Name', jmp.DataType.Character)
dt[0]  = ['Paul', 'Kimi', 'Evan', 'Ernest', 'Shannon' ]
for n in dt[0]:
    print( n )


```

#### [Slice](#slice)

**Description:** The slice operator is used as a parameter to the [ ] get item operation. This consists of start:stop:step. These parameters are optional. The returned value will be a list of values, beginning with the start value not including the stop value incremented by the step value. Negative numbers for start or stop, are 1-based indexes from the end of the sequence. A negative [step] value decrements the step count, rather than incrementing. Empty values have appropriate defaults. [::-1] will return the complete list in reverse order. And [:] will return the entire array in current item order.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print( [c.name for c in dt[:]] )         # print list of column names default step = 1
reverse_cols = dt[::-1]                  # list of column names in reverse order
print( [c.name for c in reverse_cols] )  # print reversed column name list
print( dt['name'][0:20:2] )              # print every other value in range [0, 20)


```

#### [Special Items](#special-items_1)

#### [**eq**](#eq)

**Syntax:** column1 == column2

**Description:** Equality test, returns true when two jmp.DataTable.Column objects point to the same JMP data table column. This does not check that content matches, but the two variables point to exactly the same column.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
col1 = dt[0]
col2 = dt['name']
col3 = dt['age']
print( col1 == col2 )
print( col1 == col3 )


```

#### [**getitem**](#getitem_1)

**Syntax:** value = column[ index ]

**Description:** Provides the [] operator for getting a jmp.DataTable.Column object's value from the column with 0-based index.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
col = dt[0]
for i in range ( len(col) ):
    print( col[i] )


```

#### [**init**](#init_2)

**Syntax:** Column( dt_obj, name | index)

**Description:** Creates a new column object that points to a specific column in a data table. A jmp.DataTable object is required for the dt_obj parameter and a valid column name or index is required.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
col = jmp.DataTable.Column(dt, 'name')
print(col)

# Note: it's simpler to just let Python create one for you through assignment.
col2 = dt['name'];
print(col2)


```

#### [**len**](#len)

**Syntax:** count = len( column )

**Description:** Returns the number of columns in the table.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
print( len( dt['name'] ) )


```

#### [**ne**](#ne)

**Syntax:** column1 != column2

**Description:** Inequality test, returns true when two jmp.DataTable.Column objects do not point to the same data table column. This does not check that content matches, but the two objects do not point to exactly the same column.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
col1 = dt[0]
col2 = dt['name']
col3 = dt['age']
print( col1 != col2 )
print( col1 != col3 )


```

#### [**setitem**](#setitem)

**Syntax:** dt['name' | index] = [ list, of, items, count, must, match, table, rows]

**Description:** Provides the [] operator for setting values in a column getting a jmp.DataTable.Column object from the table by column name or 0-based index.

**JMP Version Added:** 18

**datetime.date**

```

import jmp

from datetime import date
dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column('birthday', jmp.DataType.Numeric)
dt['birthday'].format = "m/d/y"
dt['birthday'][0] = date.today()


```

**datetime.datetime**

```

import jmp

from datetime import datetime
dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column('birthday', jmp.DataType.Numeric)
dt['birthday'].format = "m/d/y h:m:s"
dt['birthday'][0] = datetime.now()


```

**Expression**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column("expressions", jmp.DataType.Expression)
dt['expressions'][0] = jmp.Expression('1 + 1')
print(dt['expressions'][0])
result = jmp.eval(dt['expressions'][0])
print(result)


```

**Image**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column("images", jmp.DataType.Expression)
for i in range( len( dt["images"] ) ):
    dt['images'][i] = jmp.Image(jmp.SAMPLE_IMAGES + "tile.jpg")
print(dt['images'][0])


```

**Row State**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column("rs", jmp.DataType.RowState)
dt['rs'][0] = jmp.RowState(selected=True, marker=3, color=4)
print(dt['rs'][0])


```

**Standard**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
column = dt[0]
column2 = dt['age']
print(column)
print(column2)


```

**time.struct_time**

```

import jmp

import time
dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column('birthday', jmp.DataType.Numeric)
dt['birthday'].format = "h:m:s"
dt['birthday'][0] = time.localtime()


```

#### [**str**](#str)

**Syntax:** str( column_obj )

**Description:** Returns a sting representation of containing summary information about the data table's column.

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(dt[0])


```

#### [data_length](#data_length)

**Syntax:** col_obj.data_length

**Description:** Property returning the column field's data length. This value can be 0, 1, 2, 4 or 8 bytes. 0 is the default and implies 8 bytes used for data table numeric fields.

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(f'Data length of dt[-1] (weight column): {dt[-1].data_length}')


```

#### [display_width](#display_width)

**Syntax:** col_obj.display_width col_obj.display_width = <int>

**Description:** Change column's display width.

**JMP Version Added:** 19

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
jmp.run_jsl('Wait( 0 );')
print(dt[0].display_width)
dt[0].display_width = 100
print(dt[0].display_width)


```

#### [dtype](#dtype)

**Syntax:** col_obj.dtype

**Description:** Property returning the enumeration value for the column's data type.

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(f"Data Type of dt['age']: {dt['age'].dtype}")
dt['age'].dtype = jmp.DataType.Character 
print(f"Updated Data Type of dt['age']: {dt['age'].dtype}")


```

#### [format](#format)

**Syntax:** col_obj.format col_obj.format = tuple< <string>|<int>, ... >

**Description:** Get Format

**JMP Version Added:** 19

**Different Variations**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + "XYZ Stock Averages (plots).jmp")
dt[0].format = ("ddMonyyyy", 9)
dt[1].format = "Currency"
dt[2].format = (
    "best",
    "Use Thousands Separator",
    10,
    0)
dt[3].format = (
    "Fixed Dec",
    "Use Thousands Separator",
    10,
    2
)


```

**Tuple Assignment**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
print(dt[3].format)
dt[3].format = ('Fixed Dec', 6, 3)
print(dt[3].format)


```

#### [formula](#formula)

**Syntax:** col_obj.formula col_obj.formula = \<Expression | string>

**Description:** Sets a columns formula given an Expression object or a string representing valid JSL.

**JMP Version Added:** 19

**Expression**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column('ratio', jmp.DataType.Numeric)
dt['ratio'].formula = jmp.Expression(':Height / :Weight')
print(dt['ratio'].formula)


```

**String**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt.new_column('ratio', jmp.DataType.Numeric)
dt['ratio'].formula = ':Height / :Weight'
print(dt['ratio'].formula)


```

#### [mtype](#mtype)

**Syntax:** col_obj.mtype

**Description:** Property returning the enumeration value for the column's modeling type.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(f"Modeling Type of dt['age']: {dt['age'].mtype}") 
dt['age'].mtype = jmp.ModelingType.Nominal
print(f"Updated Modeling Type of dt['age']: {dt['age'].mtype}")


```

#### [name](#name)

**Syntax:** col_obj.name col_obj.name = <string>

**Description:** Column name property, is both readable and settable.

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
print(dt[0].name)
dt[0].name = 'First Name'


```

## [jmp > DataTable](#jmp-datatable)

### [Functions](#functions_9)

#### [Concepts](#concepts_2)

#### [Constructors](#constructors_3)

#### [Equality](#equality_1)

**Description:** The DataTable object supports equality and inequality checks. Since a DataTable is actually a reference to a live data table, multiple objects could point to the same JMP table. The checks for equality == and inequality != test do not compare content. They check whether two DataTable objects point to the same JMP table.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt2 = jmp.current()
iris = jmp.open(jmp.SAMPLE_DATA + "Iris.jmp")
print( dt == dt2 )
print( dt == iris)
print( dt != dt2 )
print( dt != iris )


```

#### [Mapping](#mapping_1)

**Description:** The DataTable object supports the Python mapping protocol. Providing the array [] operators, and use of either a column name or numeric value as the column index.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print( f'Column name: {dt[1].name}' )
print( f"Column name: {dt['age'].name}" )


```

#### [Methods](#methods_2)

#### [Properties](#properties_2)

#### [Sequence](#sequence_1)

**Description:** The DataTable object behaves like a Python sequence. This allows iterating on the columns of the table.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
for n in dt:
    print( n.name )


```

#### [Slice](#slice_1)

**Description:** The slice operator is used as a parameter to the [ ] get item operation. This consists of start:stop:step. These parameters are optional. The returned value will be a list of values, beginning with the start value not including the stop value incremented by the step value. Negative numbers for start or stop, are 1-based indexes from the end of the sequence. A negative 'step' value decrements the step count, rather than incrementing. Empty values have appropriate defaults. [::-1] will return the complete list in reverse order. And [:] will return the entire array in current item order.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print( [c.name for c in dt[:]] )         # print list of column names default step = 1
reverse_cols = dt[::-1]                  # list of column names in reverse order
print( [c.name for c in reverse_cols] )  # print reversed column name list
print( dt['name'][0:20:2] )              # print every other value in range [0, 20)


```

#### [Special Items](#special-items_2)

#### [**eq**](#eq_1)

**Syntax:** table1 == table2

**Description:** Equality test, returns true when two jmp.DataTable objects point to the same JMP data table. This does not check that content matches, but the two variables point to exactly the same table.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt2 = jmp.current()
iris = jmp.open(jmp.SAMPLE_DATA + "Iris.jmp")
print( dt == dt2 )
print( dt == iris)


```

#### [**getitem**](#getitem_2)

**Syntax:** column = dt['name' | index]

**Description:** Provides the [] operator for getting a jmp.DataTable.Column object from the table by column name or 0-based index.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
column = dt[0]
column2 = dt['age']
print(column)
print(column2)


```

#### [**init**](#init_3)

**Syntax:** dt = jmp.DataTable(\<name='table_name'>, \<rows=n>, \<visibility='Invisible' | 'Private' )

**Description:** Create a new data table having name 'table_name' with n rows. Parameters and keywords are optional, unless only rows are specified or order of parmeters is reversed.

**JMP Version Added:** 18

**Empty Table**

```

import jmp
dt = jmp.DataTable()


```

**Invisible**

```

import jmp
dt = jmp.DataTable('Powered By Python', 40, visibility='Invisible')


```

**Named Empty Table**

```

import jmp
dt = jmp.DataTable('Powered By Python')


```

**Named with rows**

```

import jmp
dt = jmp.DataTable('Powered By Python', 40)


```

**Private**

```

import jmp
dt = jmp.DataTable('Powered By Python', 40, visibility='private')


```

**With keywords**

```

import jmp
dt = jmp.DataTable(rows=40, name='Powered By Python')


```

#### [**len**](#len_1)

**Syntax:** count = len(dt)

**Description:** Returns the number of columns in the table.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
print( len(dt) )


```

#### [**ne**](#ne_1)

**Syntax:** table1 != table2

**Description:** Inequality test, returns true when two jmp.DataTable objects do not point to the same data table. This does not check that content matches, but the two objects do not point to exactly the same table.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt2 = jmp.current()
iris = jmp.open(jmp.SAMPLE_DATA + "Iris.jmp")
print( dt != dt2 )
print( dt != iris)


```

#### [**setitem**](#setitem_1)

**Syntax:** dt['name' | index] = [ list, of, items, count, must, match, table, rows]

**Description:** Provides the [] operator for setting values in a column getting a jmp.DataTable.Column object from the table by column name or 0-based index.

**JMP Version Added:** 18

```

import jmp

dt = jmp.DataTable('Names', 5)
dt.new_column('First Name', jmp.DataType.Character)
dt[0]  = ['Paul', 'Kimi', 'Evan', 'Ernest', 'Shannon' ]
print( dt[0][:] )


```

#### [**str**](#str_1)

**Syntax:** str( data_table )

**Description:** Returns a sting representation of summary information about the data table object.

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(dt)


```

#### [add_rows](#add_rows)

**Syntax:** add_rows(rows, \<at=-1>)

**Description:** Adds rows to the DataTable. rows is required. at is optional. If at is 0, insert at the beginning of the table. If it is \<0, insert at the end of the table. Otherwise, if at is m, insert at row m (0-based indexing).

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
dt.add_rows(5)
dt.add_rows(1, at=0)
dt.add_rows(2, at=12) # 0-based indexing


```

#### [begin_update](#begin_update)

**Syntax:** dt.begin_update() # added JMP 19.1

**Description:** Small tables update rapidly, but for large tables, having to update the user interface while making mass changes to a column is very time consuming. The begin_update() method stops the GUI updates to the data table until a corresponding end_update().

**JMP Version Added:** 19

```

import jmp

import random
import time

dt = jmp.open(jmp.SAMPLE_DATA + "Wafer Stacked.jmp")
print(dt.nrows)

start_time = time.perf_counter()
dt.begin_update()
try:
    for x in range(dt.nrows):
        dt[5][x] = random.randint(1,1000)
finally:
    dt.end_update()

end_time = time.perf_counter()
elapsed = end_time - start_time
print(f'Elapsed time: {elapsed:.3f}')


```

#### [cell_height](#cell_height)

**Syntax:** dt.cell_height dt.cell_height = <int>

**Description:** Set the display height of each data table cell.

**JMP Version Added:** 19

```

import jmp
dt = jmp.DataTable()
jmp.run_jsl('Wait(0)')
print(dt.cell_height)
dt.cell_height = 40
print(dt.cell_height)


```

#### [close](#close)

**Syntax:** dt.close( \<save= True | False>)

**Description:** Close method on DataTable object. Like JSL, defaults to saving the file if called without parameters. To abandon a file such as a one created as a temporary table use dt.close(False) or dt.close(save=False) for more clarity.

**JMP Version Added:** 18

```

import jmp

import os

# To remove the wow.jmp file uncomment then run the 2 lines below,
# if os.path.isfile('wow.jmp'):
#    os.unlink('wow.jmp')

dt = jmp.DataTable('wow', 5)
dt.new_column('one')
dt.close()                # saves and closes file

dt = jmp.open('wow.jmp')
dt.new_column('two')
dt.close(save=False)      # closes without saving


```

#### [delete_columns](#delete_columns)

**Syntax:** delete_columns('name', ..., 'name')

**Description:** The delete_columms() method works like the JSL equivalent Delete Columns() message. Acceptable arguments are: no arguments; column name or comma separated names; a Python list of column names. Using no arguments means delete the selected columns.

**JMP Version Added:** 19

```

import jmp


dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

dt.select_columns('weight')     # JSL:  dt << Select Columns( {:weight})
r = dt.delete_columns()                  # delete by selected column(s)
print(r)

r = dt.delete_columns('name', 'sex')     # delete by name
print(r)

r = dt.delete_columns(['age', 'height']) # delete with list of column names
print(r)


```

#### [end_update](#end_update)

**Syntax:** dt.end_update() # added JMP 19.1

**Description:** Restores the data table GUI update processing.

**JMP Version Added:** 19

```

import jmp

import random
import time

dt = jmp.open(jmp.SAMPLE_DATA + "Wafer Stacked.jmp")
print(dt.nrows)

start_time = time.perf_counter()
dt.begin_update()
try:
    for x in range(dt.nrows):
        dt[5][x] = random.randint(1,1000)
finally:
    dt.end_update()

end_time = time.perf_counter()
elapsed = end_time - start_time
print(f'Elapsed time: {elapsed:.3f}')


```

#### [name](#name_1)

**Syntax:** dt.name dt.name = 'string'

**Description:** The name property is both a setter and a getter for the data table's name.

**JMP Version Added:** 18

```

import jmp
dt = jmp.DataTable()
print(dt.name)
dt.name = 'Powered by Python'


```

#### [ncols](#ncols)

**Syntax:** dt.ncols

**Description:** A read-only property returning the number of columns in the table.

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(f'Number of columns: {dt.ncols}')


```

#### [new_column](#new_column)

**Syntax:** dt.new_column( name='column_name', dtype=jmp.Numeric | .Character | .RowState | .Expression, mtype=jmp.ModelingType.Continuous | ... | TypeNone dlen=len cell type's data length especially for numeric 8(double),4(int32),2(int16),1(int8) where=n insert column after column n

**Description:** Create a new data table column, optionally specifying name, column type, data length, and modeling type

**JMP Version Added:** 18

**New Class**

```

import jmp

from jmp import DataTable as Dt
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
nc = jmp.DataTable('New Class', dt.nrows)
nc.new_column('name', jmp.DataType.Character)
# populate column from a list
nc[0] = ['Fred','Kimi','Amanda','Courtney','Paul','Theresa','Erika','Blake','Joseph','Amber',
    'Daphne','Robert','James','Richard', 'Eric','Mark','Coleen','Brian','Bryan','Emily',
    'Bonnie','Georgia','Terrance','Carmen','Hunter','Samantha','Kay','Tamara','Brett','David',
    'Chandler','Siebela','Judy','Hui','Drew','Russ','Megan','Evan','Alex','Travis'
]
col = nc.new_column('age', jmp.DataType.Numeric)
# populate column from another column
nc['age'] = dt['age']
print(nc['age'][::])
print(col.__class__)


```

**Small Class**

```

import jmp

dt = jmp.DataTable('Names', 5)
dt.new_column('First Name', jmp.DataType.Character)
dt[0]  = ['Paul', 'Kimi', 'Evan', 'Ernest', 'Shannon' ]
print( dt[0][:] )
print( list( dt['First Name'] ) )
dt.new_column('Distance (km)', jmp.DataType.Numeric, jmp.ModelingType.Continuous)
dt[1] = [ 1239.2, 12266.4, 15.75, 35.0, 10.6 ]


```

#### [nrows](#nrows)

**Syntax:** dt.nrows

**Description:** A read-only property returning the number of rows in the table.

**JMP Version Added:** 18

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(f'Number of rows: {dt.nrows}')


```

#### [row_states](#row_states)

**Syntax:** dt.row_states dt.row_states = [state1, state2, ..., stateN]

**Description:** Sets the Row States for all rows in the data table.

**JMP Version Added:** 19

**General Use**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

dt.row_states[0] = jmp.RowState(marker=4, color=3)
print(dt.row_states)

dt.row_states[0].selected = True
dt.row_states[1] = jmp.RowState(value=22)
print(dt.row_states)


```

**Iteration**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
for i in range(len(dt.row_states)):
    if dt['age'][i] % 2:
        dt.row_states[i].selected = True
print(dt.row_states)


```

**List of Integers**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
dt.row_states = [33, 33, 33, 33, 33, 97, 97, 97, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 768]
print(dt.row_states)


```

**List of Tuples (, )**

```

import jmp
from jmp import RowState
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
dt.row_states = [(2, RowState(marker=2, selected=True)), (5, 97)]
print(dt.row_states)


```

**Reset Row States**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
dt.row_states = [33, 33, 33, 33, 33, 97, 97, 97, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 768]
print(dt.row_states)

dt.row_states = [0] * dt.nrows
print(dt.row_states)


```

**Row State Column**

```

import jmp
from jmp import DataType
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

rs_col = dt.new_column('rs', DataType.RowState)
dt['rs'] = dt.row_states

dt['rs'][0] = jmp.RowState(value=33)
dt['rs'][1] = jmp.RowState(color=2, marker=3)

row_state = jmp.RowState(color=4, selected=False)
dt['rs'][3] = row_state
row_state.marker = 9
dt['rs'][4] = row_state

dt.row_states = dt['rs']
print(dt.row_states)


```

#### [save](#save)

**Syntax:** dt.save( < path='file_path' > )

**Description:** Save data table using table name to current directory. Optional path argument allows saving to a different location or name.

**JMP Version Added:** 18

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
dt[0][0] = 'Katie'
dt.save('BC_lowercase.jmp')


```

#### [scripts](#scripts)

**Syntax:** dt.scripts dt.scripts = \<dict\<str : \<str | Expression>>>

**Description:** The scripts property allows for reading and writing of data table scripts.

**JMP Version Added:** 19

**Deleting Scripts**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

# Reassigning of scripts removes all other scripts
dt.scripts = {
    "Example": 'Print("Foo")',
    "Example 2": jmp.Expression('Print("Bar")')
}

print("Distribution" in dt.scripts)   # False
print("Example" in dt.scripts)        # True
print("Example 2" in dt.scripts)      # True

# Deleting a script
# Note: If the script editing window is open, the script will not be deleted. 
del dt.scripts["Example"]
dt.scripts["Example 2"] = None

print("Example" in dt.scripts)        # False
print("Example 2" in dt.scripts)      # False

dt.scripts = {
    "Example": 'Print("FooBar")',
}

# Deleting all scripts
dt.scripts = {}


```

**Get/Set Scripts**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

# Getting a script
print(dt.scripts["Distribution"])

# Adding a script
dt.scripts["Example"] = 'Print("Foo")'
dt.scripts["Example 2"] = jmp.Expression('Print("Bar")')

# Getting all scripts
print(dt.scripts)


```

**Multiple Scripts**

```

import jmp
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

# Concatenation
dt.scripts |= {
    "Example": 'Print("Foo")',
    "Example 2": jmp.Expression('Print("Bar")')
}

print("Distribution" in dt.scripts)
print("Example" in dt.scripts)
print("Example 2" in dt.scripts)

# Reassigning of scripts removes all other scripts
dt.scripts = {
    "Example": 'Print("FooBar")',
}
print(dt.scripts)

# Iteration
for name, value in dt.scripts.items():
    print(name, value)

for name in dt.scripts:
    print(name, dt.scripts[name])


```

#### [select_columns](#select_columns)

**Syntax:** select_columns('name', ..., 'name')

**Description:** The select_columms() method works like the JSL equivalent Select Columns() message. Acceptable arguments are: column name or comma separated names; a Python list of column names.

**JMP Version Added:** 19

**All**

```

import jmp


dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
dt.select_columns([col.name for col in dt])
# all columns should be selected.


```

**Example 1**

```

import jmp


dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
dt.select_columns('weight')
dt.select_columns('name', 'sex')
dt.select_columns(['age', 'height'])
# all columns should be selected.


```

## [jmp > Expression](#jmp-expression)

### [Functions](#functions_10)

#### [Concepts](#concepts_3)

#### [Constructors](#constructors_4)

#### [Equality](#equality_2)

**Description:** The Expression object supports equality and inequality checks. When comparing equality between two Expression objects, the values are compared and returned if they are equal or not. This is a comparison of the values of the Expression object and not the evaluation of the values.

**JMP Version Added:** 19

```

import jmp

expr1 = jmp.Expression('1 + 1')
expr2 = jmp.Expression('2 + 0')
expr3 = jmp.Expression('1 + 1')
print(expr1 == expr2)
print(expr1 == expr3)
print(expr1 != expr2)
print(expr1 != expr3)


```

#### [Properties](#properties_3)

#### [Special Items](#special-items_3)

#### [**eq**](#eq_2)

**Syntax:** expression1 == expression2

**Description:** The equality test returns true if the Expression object has the same content as another Expression object and returns false otherwise.

**JMP Version Added:** 19

```

import jmp

expr1 = jmp.Expression('1 + 1')
expr2 = jmp.Expression('2 + 0')
expr3 = jmp.Expression('1 + 1')
print(expr1 == expr2)
print(expr1 == expr3)


```

#### [**init**](#init_4)

**Syntax:** Expression(jsl=<string>)

**Description:** Creates a new Expression object.

**JMP Version Added:** 19

```

import jmp

from jmp import Expression, eval
expr = Expression(jsl="2 + 2")
print(f'Expression: {expr}')
print(f'Result: {eval(expr)}')
expr.jsl = '1 + 1'
print(f'Expression Adjusted: {eval(expr)}')


```

#### [**ne**](#ne_2)

**Syntax:** expression1 != expression2

**Description:** The inequality test returns true if the Expression object has different content as another Expression object and returns false otherwise.

**JMP Version Added:** 19

```

import jmp

expr1 = jmp.Expression('1 + 1')
expr2 = jmp.Expression('2 + 0')
expr3 = jmp.Expression('1 + 1')
print(expr1 != expr2)
print(expr1 != expr3)


```

#### [**str**](#str_2)

**Syntax:** str( expr_obj )

**Description:** Returns a sting representation of containing all information about the Expression object.

**JMP Version Added:** 19

```

import jmp
expr = jmp.Expression(':Height / :Weight')
print(expr)


```

#### [jsl](#jsl)

**Syntax:** expr_obj.jsl expr_obj.jsl = <string>

**Description:** Expression jsl property, is readable and settable.

**JMP Version Added:** 19

```

import jmp

expr = jmp.Expression(jsl='0 + 0')
print(expr)
expr.jsl = '2 + 2'
print(expr)


```

## [jmp > Image](#jmp-image)

### [Functions](#functions_11)

#### [Concepts](#concepts_4)

#### [Constructors](#constructors_5)

#### [Equality](#equality_3)

**Description:** The Image object supports equality and inequality checks. When comparing equality between two Image objects, the values are compared and returned if they are equal or not.

**JMP Version Added:** 19

```

import jmp

image1 = jmp.Image(jmp.SAMPLE_IMAGES + 'tile.jpg')
image2 = jmp.Image(jmp.SAMPLE_IMAGES + 'pi.gif')
image3 = jmp.Image(path=jmp.SAMPLE_IMAGES + 'tile.jpg')
print(image1 == image2)
print(image1 == image3)
print(image1 != image2)
print(image1 != image3)


```

#### [Special Items](#special-items_4)

#### [**eq**](#eq_3)

**Syntax:** image1 == image2

**Description:** The equality test returns true if the Image object has the same content as another Image object and returns false otherwise.

**JMP Version Added:** 19

```

import jmp

image1 = jmp.Image(jmp.SAMPLE_IMAGES + 'tile.jpg')
image2 = jmp.Image(jmp.SAMPLE_IMAGES + 'pi.gif')
image3 = jmp.Image(path=jmp.SAMPLE_IMAGES + 'tile.jpg')
print(image1 == image2)
print(image1 == image3)


```

#### [**init**](#init_5)

**Syntax:** jmp.Image(path=<string>)

**Description:** Creates a new Image object.

**JMP Version Added:** 19

```

import jmp

image = jmp.Image(jmp.SAMPLE_IMAGES + 'tile.jpg')
print(f'Image: {image}')
jmp.open(image)


```

#### [**ne**](#ne_3)

**Syntax:** image1 != image2

**Description:** The inequality test returns true if the Image object has different content as another Image object and returns false otherwise.

**JMP Version Added:** 19

```

import jmp

image1 = jmp.Image(jmp.SAMPLE_IMAGES + 'tile.jpg')
image2 = jmp.Image(jmp.SAMPLE_IMAGES + 'pi.gif')
image3 = jmp.Image(path=jmp.SAMPLE_IMAGES + 'tile.jpg')
print(image1 != image2)
print(image1 != image3)


```

#### [**str**](#str_3)

**Syntax:** str( image_obj )

**Description:** Returns a sting representation of containing all information about the Image object.

**JMP Version Added:** 19

```

import jmp
image = jmp.Image(jmp.SAMPLE_IMAGES + 'tile.jpg')
print(image)


```

## [jmp > Project](#jmp-project)

### [Functions](#functions_12)

#### [Constructors](#constructors_6)

#### [Functions](#functions_13)

#### [Properties](#properties_4)

#### [Special Items](#special-items_5)

#### [**init**](#init_6)

**Syntax:** prj = jmp.Project(\<name='Project name'>)

**Description:** Create a new Project object for accessing JMP projects and files.

**JMP Version Added:** 19

**Empty Project**

```

import jmp
prj = jmp.Project()


```

**Named Empty Project**

```

import jmp
prj = jmp.Project('My Project')


```

**Project Name**

```

import jmp

prj = jmp.Project()
print(prj.name)


```

#### [**str**](#str_4)

**Syntax:** str( project )

**Description:** Returns the string representation of the project

**JMP Version Added:** 19

```

import jmp

prj = jmp.Project()
print( prj )


```

#### [contents](#contents)

**Syntax:** prj.name

**Description:** Returns a list of the file names contained within the project.

**JMP Version Added:** 19

```

import jmp

prj = jmp.Project()
print(prj.contents)


```

#### [exists](#exists)

**Syntax:** prj.exists('file_name')

**Description:** Takes a file name and validates if the file exists within the project.

**JMP Version Added:** 19

```

import jmp

prj = jmp.Project()
print( prj.exists('myfile.data') )


```

#### [extract](#extract)

**Syntax:** prj.extract('file_name')

**Description:** Takes a file name and extracts the file from to project to the project's temporary directory.

**JMP Version Added:** 19

```

import jmp

prj = jmp.Project()
success = prj.extract('myfile.data')


```

#### [extract_all](#extract_all)

**Syntax:** prj.extract_all()

**Description:** Extracts all project files to the project's temporary directory.

**JMP Version Added:** 19

```

import jmp

prj = jmp.Project()
success = prj.extract_all()


```

#### [is_extracted](#is_extracted)

**Syntax:** prj.is_extracted('file_name')

**Description:** Takes a file name and checks if the file as already been extracted from the project archive.

**JMP Version Added:** 19

```

import jmp

prj = jmp.Project()
print( prj.is_extracted('myfile.data') )


```

#### [name](#name_2)

**Syntax:** prj.name

**Description:** The project name property is read only

**JMP Version Added:** 19

```

import jmp

prj = jmp.Project()
print(prj.name)


```

## [jmp > RowState](#jmp-rowstate)

### [Functions](#functions_14)

#### [Concepts](#concepts_5)

#### [Constructors](#constructors_7)

#### [Equality](#equality_4)

**Description:** The RowState object supports equality and inequality checks. When comparing equality between two RowState objects, the values are compared and returned if they are equal or not. If two RowStates have the same content yet are intialized differently, they will still return true.

**JMP Version Added:** 19

```

import jmp

rs1 = jmp.RowState(color=4, marker=2, selected=True)
rs2 = jmp.RowState(color=11, excluded=True, labeled=True)
rs3 = jmp.RowState(value=1057)
print(rs1 == rs2)
print(rs1 == rs3)
print(rs1 != rs2)
print(rs1 != rs3)


```

#### [Properties](#properties_5)

#### [Special Items](#special-items_6)

#### [**eq**](#eq_4)

**Syntax:** rs1 == rs2

**Description:** The equality test returns true if the RowState object has the same content as another RowState object and returns false otherwise.

**JMP Version Added:** 19

```

import jmp

rs1 = jmp.RowState(color=4, marker=2, selected=True)
rs2 = jmp.RowState(color=11, excluded=True, labeled=True)
rs3 = jmp.RowState(value=1057)
print(rs1 == rs2)
print(rs1 == rs3)


```

#### [**init**](#init_7)

**Syntax:** jmp.RowState(selected?=<boolean>, hidden?=<booleane>, labeled?=<boolean>, excluded?=<boolean>, color?=<int>, marker?=<int>) jmp.RowState(value=<int>)

**Description:** Creates a new RowState object. RowState is an object holding any of the six characteristics that rows in a JMP data table can have: selected, hidden, excluded, labeled, colored, and marked.

**JMP Version Added:** 19

```

import jmp

from jmp import RowState
rs = RowState(color=4, marker=2, selected=True)
print(f'Row State: {rs}')

rs_from_value = RowState(value=33)
print(f'Row State from Value: {rs_from_value}')


```

#### [**ne**](#ne_4)

**Syntax:** image1 != image2

**Description:** The inequality test returns true if the RowState object has different content as another RowState object and returns false otherwise.

**JMP Version Added:** 19

```

import jmp

rs1 = jmp.RowState(color=4, marker=2, selected=True)
rs2 = jmp.RowState(color=11, excluded=True, labeled=True)
rs3 = jmp.RowState(value=1057)
print(rs1 != rs2)
print(rs1 != rs3)


```

#### [**str**](#str_5)

**Syntax:** str( rs_obj )

**Description:** Returns a sting representation of containing all information about the RowState object.

**JMP Version Added:** 19

```

import jmp
rs = jmp.RowState(color=11, excluded=True, labeled=True)
print(rs)


```

#### [color](#color)

**Syntax:** rs_obj.color rs_obj.color = <int>

**Description:** RowState color property, is readable and settable. Colors are chosen from 0 to 84. (0-15 basics, 16-31 dark, 32-47 light, 48-63 very dark, 64-79 very light, 80-84 grays)

**JMP Version Added:** 19

```

import jmp

rs = jmp.RowState(color=5)
print(rs)
rs.color = 0
print(rs)


```

#### [excluded](#excluded)

**Syntax:** rs_obj.excluded rs_obj.excluded = <boolean>

**Description:** RowState excluded property, is readable and settable.

**JMP Version Added:** 19

```

import jmp

rs = jmp.RowState(excluded=True)
print(rs)
rs.excluded = False 
print(rs)


```

#### [hidden](#hidden)

**Syntax:** rs_obj.hidden rs_obj.hidden = <boolean>

**Description:** RowState hidden property, is readable and settable.

**JMP Version Added:** 19

```

import jmp

rs = jmp.RowState(hidden=True)
print(rs)
rs.hidden = False 
print(rs)


```

#### [labeled](#labeled)

**Syntax:** rs_obj.labeled rs_obj.labeled = <boolean>

**Description:** RowState labeled property, is readable and settable.

**JMP Version Added:** 19

```

import jmp

rs = jmp.RowState(labeled=True)
print(rs)
rs.labeled = False 
print(rs)


```

#### [marker](#marker)

**Syntax:** rs_obj.marker rs_obj.marker = <int>

**Description:** RowState marker property, is readable and settable. Markers are chosen from 0 to 31

**JMP Version Added:** 19

```

import jmp

rs = jmp.RowState(marker=3)
print(rs)
rs.marker = 0
print(rs)


```

#### [selected](#selected)

**Syntax:** rs_obj.selected rs_obj.selected = <boolean>

**Description:** RowState selected property, is readable and settable.

**JMP Version Added:** 19

```

import jmp

rs = jmp.RowState(selected=True)
print(rs)
rs.selected = False 
print(rs)


```

## [jmp > globals](#jmp-globals)

### [Functions](#functions_15)

#### [Concepts](#concepts_6)

#### [Iteration](#iteration)

**Description:** The globals property supports iterating across the set of values.

**JMP Version Added:** 19

```

import jmp

jmp.globals['pi'] = 3.1415927
jmp.globals['e'] = 2.718
jmp.run_jsl('''
    show(::pi)
''')

for x in jmp.globals:
    print( x )


```

#### [Methods](#methods_3)

#### [Special Items](#special-items_7)

#### [**getitem**](#getitem_3)

**Syntax:** value = jmp.globals['name']

**Description:** Gets a JSL global variable as a Python object. Returns None if the object cannot be found. Returns an opaque type for data types that cannot be handed. Capable of transferring the same types of objects as Python Send() and Python Get().

**JMP Version Added:** 19

```

import jmp

jmp.run_jsl('''
    pi = 3.1415929
''')
print( jmp.globals['pi'] )


```

#### [**len**](#len_2)

**Syntax:** length = len( jmp.globals )

**Description:** Returns the number of symbols in the JSL global environment.

**JMP Version Added:** 19

```

import jmp

print( len( jmp.globals ) )
jmp.globals['pi'] = 3.1415927
print( len( jmp.globals ) )
jmp.globals['e'] =  2.7182818
print( len( jmp.globals ) )


```

#### [**setitem**](#setitem_2)

**Syntax:** jmp.globals['name'] = value

**Description:** Due to Python scoping and the design of Python Get(), only variables in the Python global scope are accessible with Python Get(). The jmp.globals dictionary provides the capacity to directly set or create a JSL variable from Python code. The value type can be any Python type currently supported by Python Get().

**JMP Version Added:** 19

```

import jmp

jmp.globals['pi'] = 3.1415927
jmp.run_jsl('''
    show(pi)
''')


```

#### [**str**](#str_6)

**Syntax:** str(jmp.globals)

**Description:** Display the contents of globals in a dictionary representation. Note that the globals dictionary is utilized by JMP itself so there may be additional entries.

**JMP Version Added:** 19

```

import jmp

jmp.globals['pi'] = 3.1415927
jmp.globals['e'] =  2.7182818
jmp.globals['Bb'] = 'bumble bee'
print( jmp.globals )
d = str(jmp.globals)
print(d)


```

#### [get](#get)

**Syntax:** value = jmp.globals.get('name')

**Description:** The get() function returns the value for the given key. Like JSL, the key is a fuzzy match.

**JMP Version Added:** 19

```

import jmp

jmp.globals['pi'] = 3.1415927
jmp.globals['an A'] = 'Annie'
print( jmp.globals.get('pi') )                        
print( jmp.globals.get('ana') )


```

#### [items](#items)

**Syntax:** item_list = jmp.globals.items()

**Description:** Returns a list of key-value pairs in the namespace. Note that the globals dictionary is utilized by JMP itself so there may be additional entries.

**JMP Version Added:** 19

```

import jmp

jmp.globals['pi'] = 3.1415927
jmp.globals['bB'] = 'Bumble Bee'
print( jmp.globals.items() )


```

#### [keys](#keys)

**Syntax:** key_list = jmp.globals.keys()

**Description:** Returns a list of the keys in the namespace. Note that the globals dictionary is utilized by JMP itself so there may be additional entries.

**JMP Version Added:** 19

```

import jmp

jmp.globals['pi'] = 3.1415927
jmp.globals['bB'] = 'Bumble Bee'
print( jmp.globals.keys() )


```

#### [values](#values)

**Syntax:** value_list = jmp.globals.values()

**Description:** Returns the values in the namespace. Note that the globals dictionary is utilized by JMP itself so there may be additional entries.

**JMP Version Added:** 19

```

import jmp

jmp.globals['pi'] = 3.1415927
jmp.globals['bB'] = 'Bumble Bee'
print( jmp.globals.values() )


```

## [jmp > here](#jmp-here)

### [Functions](#functions_16)

#### [Concepts](#concepts_7)

#### [Iteration](#iteration_1)

**Description:** The here property supports iterating across the values in the 'here' namespace.

**JMP Version Added:** 19

```

import jmp

jmp.here['pi'] = 3.1415927
jmp.globals['e'] = 2.718
jmp.run_jsl('''
    Names Default to Here(1);
    show(pi)
''')

for x in jmp.here:
    print( x )
print([x for x in jmp.globals])


```

#### [Methods](#methods_4)

#### [Special Items](#special-items_8)

#### [**getitem**](#getitem_4)

**Syntax:** value = jmp.here['name']

**Description:** Gets a JSL variable from the current 'here' namespace as a Python object. Returns None if the object cannot be found, or an opaque type for data types that cannot yet be handled. Providing direct retrieval of a JSL variable into the local Python scope. Supports transfers of the same types of objects as Python Send(). Note that in JSL namespace scoping, the 'here' namespace is local to script submission, and code submitted from different script windows will have separate 'here' namespaces. Code that includes another script has a single 'here' namespace. This shared namespace also exists for a JSL script running Python via Submit() or Execute(), Python scripts calling run_jsl().

**JMP Version Added:** 19

**Example 1**

```

import jmp

jmp.globals['e'] = 2.71828
jmp.run_jsl('''
    Names Default to Here(1);
    pi = 3.1415929;
    show(::e);
''')
print( jmp.here['pi'] )


```

**Scope**

```

import jmp

jmp.run_jsl('''
Names Default to Here(1);
here_v = "here";
Show(here_v);
''')
print( f'temporary: {jmp.here['here_v']}' )
try:    
    print(here_v)
except:
    print('here_v is not in Python globals().')
def scoped():
    v = jmp.here['here_v']
    print(f'scoped: {v}')

scoped()
try:    
    print(v)
except:
    print('v is local to scoped().')


```

#### [**len**](#len_3)

**Syntax:** length = len( jmp.here )

**Description:** Returns the number of symbols in the JSL 'here' namespace.

**JMP Version Added:** 19

```

import jmp

print( len( jmp.here ) )
jmp.here['pi'] = 3.1415927
print( len( jmp.here ) )
jmp.here['e'] =  2.7182818
print( len( jmp.here ) )


```

#### [**setitem**](#setitem_3)

**Syntax:** jmp.here['name'] = value

**Description:** Provides the means to set a value into the JSL script's 'here' namespace. This allows sending back a value that could not be reached by Python Get(). Only variables in the Python global scope can be seen by Python Get(). Supports same object types as Python Get(). Note on JSL namespace scoping, the 'here' namespace is local to the script submission. Code submitted from different script windows will have separate 'here' namespaces. Code including another script will have a single 'here' namespace. This holds true for a JSL script running Python via Submit() or Execute(), Python scripts calling run_jsl().

**JMP Version Added:** 19

```

import jmp

jmp.here['pi'] = 3.1415927
jmp.run_jsl('''
    Names Default to Here(1);
    show(pi)
''')


```

#### [**str**](#str_7)

**Syntax:** str(jmp.here)

**Description:** Display the contents of here in a dictionary representation.

**JMP Version Added:** 19

```

import jmp

jmp.here['pi'] = 3.1415927
jmp.here['e'] =  2.7182818
jmp.here['Bb'] = 'bumble bee'
print( jmp.here )
d = str(jmp.here)
print(d)


```

#### [get](#get_1)

**Syntax:** value = jmp.here.get('name')

**Description:** The get() function returns the value for the given key. Like JSL, the key is a fuzzy match.

**JMP Version Added:** 19

```

import jmp

jmp.here['pi'] = 3.1415927
jmp.here['bB'] = 'Bumble Bee'
print( jmp.here.get('pi') )                        
print( jmp.here.get('b  b') )


```

#### [items](#items_1)

**Syntax:** item_list = jmp.here.items()

**Description:** Returns a list of key-value pairs in the namespace.

**JMP Version Added:** 19

```

import jmp

jmp.here['pi'] = 3.1415927
jmp.here['bB'] = 'Bumble Bee'
print( jmp.here.items() )


```

#### [keys](#keys_1)

**Syntax:** key_list = jmp.here.keys()

**Description:** Returns a list of the keys in the namespace.

**JMP Version Added:** 19

```

import jmp

jmp.here['pi'] = 3.1415927
jmp.here['bB'] = 'Bumble Bee'
print( jmp.here.keys() )


```

#### [values](#values_1)

**Syntax:** value_list = jmp.here.values()

**Description:** Returns the values in the namespace.

**JMP Version Added:** 19

```

import jmp

jmp.here['pi'] = 3.1415927
jmp.here['bB'] = 'Bumble Bee'
print( jmp.here.values() )


```

## [jmp > live](#jmp-live)

### [Functions](#functions_17)

#### [Functions](#functions_18)

#### [get_credentials()](#get_credentials)

**Syntax:** jmp.live.get_credentials(\<credential_name>)

**Description:** In JMP Live data refresh scripts, returns the credentials with the given name (or, if no name is provided, the default credentials) assigned to the script. Returned value is a dictionary with "username", "password", and "key_file_path" keys.

**JMP Version Added:** 19

```

import jmp

dt = jmp.DataTable()

credentials = jmp.live.get_credentials()

# login to external data source using credentials['username'] and credentials['password']
# create dt using obtained data

jmp.live.set_result(dt)


```

#### [get_import_file_path()](#get_import_file_path)

**Syntax:** jmp.live.get_import_file_path()

**Description:** In JMP Live data import scripts, returns the path to the uploaded import file.

**JMP Version Added:** 19

```

import jmp

dt = jmp.DataTable()

importPath = jmp.live.get_import_file_path()
with open(importPath) as importFile:
    # [import data from importFile to dt]

jmp.live.set_result(dt)


```

#### [set_result()](#set_result)

**Syntax:** jmp.live.set_result()

**Description:** In JMP Live data refresh and import scripts, sets the result table. Set the result to None to cancel the update.

**JMP Version Added:** 19

```

import jmp

dt = jmp.DataTable()
shouldUpdate = True

# add data to dt, or set shouldUpdate to False

if shouldUpdate:
    jmp.live.set_result(dt)
else:
    jmp.live.set_result(None)


```

## [jmp > log](#jmp-log)

### [Functions](#functions_19)

#### [Functions](#functions_20)

#### [flush](#flush)

**Syntax:** jmp.log.flush()

**Description:** The log.flush() and log.write() functions overload Python's stdio and stderr flush() and write() functions. These are largely for JMP's internal use as they direct the Python's output to the JMP log and embedded log windows. jmp.log.flush() is a NOP, and returns and empty string.

**JMP Version Added:** 18

```

import jmp

import jmp.log
jmp.log.flush()


```

#### [write](#write)

**Syntax:** jmp.log.write('message')

**Description:** The log.flush() and log.write() functions overload Python's stdio and stderr flush() and write() functions. These are largely for JMP's internal use as they direct the Python's output to the JMP log and embedded log windows. Programs can call jmp.log.write('message') to explicitly send the message to the JMP log or embedded log windows.

**JMP Version Added:** 18

```

import jmp

import jmp.log
jmp.log.write('I am a log message.')


```

## [jmp](#jmp_1)

### [Functions](#functions_21)

#### [ALL_HOME](#all_home_1)

**Syntax:** jmp.ALL_HOME

**Description:** Value corresponding to JSL's $ALL_HOME directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.ALL_HOME)


```

#### [BUILTIN_SCRIPTS](#builtin_scripts_1)

**Syntax:** jmp.BUILTIN_SCRIPTS

**Description:** Value corresponding to JSL's $BUILTIN_SCRIPTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.BUILTIN_SCRIPTS)


```

#### [Constants](#constants_1)

#### [DESKTOP](#desktop_1)

**Syntax:** jmp.DESKTOP

**Description:** Value corresponding to JSL's $DESKTOP directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.DESKTOP)


```

#### [DOCUMENTS](#documents_1)

**Syntax:** jmp.DOCUMENTS

**Description:** Value corresponding to JSL's $DOCUMENTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.DOCUMENTS)


```

#### [DOWNLOADS](#downloads_1)

**Syntax:** jmp.DOWNLOADS

**Description:** Value corresponding to JSL's $DOWNLOADS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.DOWNLOADS)


```

#### [DataType](#datatype_1)

**Syntax:** jmp.DataType.enum_value

**Description:** jmp.DataType is an enumeration representing a JMP column's data types. These are used with the jmp.DataTable.new_column() function to create columns other than the default Numeric type.

**JMP Version Added:** 18

```

import jmp

# for the sake of typing
from jmp import DataType as dType
print('jmp.DataType members:')
print( list(map(lambda c: c.name, dType)) )


```

#### [Enums](#enums_1)

#### [Functions](#functions_22)

#### [HOME](#home_1)

**Syntax:** jmp.HOME

**Description:** Value corresponding to JSL's $HOME directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.HOME)


```

#### [JMPPRJ](#jmpprj_1)

**Syntax:** jmp.JMPPRJ

**Description:** Returns the physical path of the project's temporary directory. Returns the current working directory, or None if script is not running within a project.

**JMP Version Added:** 19

```

import jmp
print(jmp.JMPPRJ)


```

#### [ModelingType](#modelingtype_1)

**Syntax:** jmp.ModelingType.enum_value

**Description:** jmp.ModelingType is an enumeration representing a JMP column's modeling or analysis type. These are used with the jmp.DataTable.new_column() function to create columns other than the default Continuous modeling type. Note TypeNone differs from JMP's modeling type None as 'None' is a Python keyword.

**JMP Version Added:** 18

```

import jmp

# for the sake of typing
from jmp import ModelingType as mType
print('jmp.ModleingType members:')
print( list(map(lambda c: c.name, mType)) )


```

#### [PYTHONW_EXE](#pythonw_exe_1)

**Syntax:** jmp.PYTHONW_EXE

**Description:** Path to the JMP installed no-console Python executable (Windows only).

**JMP Version Added:** 19

```

import jmp

import platform
if platform.system() == "Windows":
    print(jmp.PYTHONW_EXE)


```

#### [PYTHON_EXE](#python_exe_1)

**Syntax:** jmp.PYTHON_EXE

**Description:** Path to the JMP installed Python executable.

**JMP Version Added:** 18

```

import jmp
print(jmp.PYTHON_EXE)


```

#### [PY_USER_APPDIR](#py_user_appdir_1)

**Syntax:** jmp.PY_USER_APPDIR

**Description:** Path to the user directory location acting as the base of JMP's Python support. The site-packages directory is within this directory hierarchy.

**JMP Version Added:** 18

```

import jmp
print(jmp.PY_USER_APPDIR)


```

#### [SAMPLE_APPS](#sample_apps_1)

**Syntax:** jmp.SAMPLE_APPS

**Description:** Value corresponding to JSL's $SAMPLE_APPS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_APPS)


```

#### [SAMPLE_DASHBOARDS](#sample_dashboards_1)

**Syntax:** jmp.SAMPLE_DASHBOARDS

**Description:** Value corresponding to JSL's $SAMPLE_DASHBOARDS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_DASHBOARDS)


```

#### [SAMPLE_DATA](#sample_data_1)

**Syntax:** jmp.SAMPLE_DATA

**Description:** Value corresponding to JSL's $SAMPLE_DATA directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_DATA)


```

#### [SAMPLE_IMAGES](#sample_images_1)

**Syntax:** jmp.SAMPLE_IMAGES

**Description:** Value corresponding to JSL's $SAMPLE_IMAGES directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_IMAGES)


```

#### [SAMPLE_IMPORT_DATA](#sample_import_data_1)

**Syntax:** jmp.SAMPLE_IMPORT_DATA

**Description:** Value corresponding to JSL's $SAMPLE_IMPORT_DATA directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_IMPORT_DATA)


```

#### [SAMPLE_PROJECTS](#sample_projects_1)

**Syntax:** jmp.SAMPLE_PROJECTS

**Description:** Value corresponding to JSL's $SAMPLE_PROJECTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_PROJECTS)


```

#### [SAMPLE_SCRIPTS](#sample_scripts_1)

**Syntax:** jmp.SAMPLE_SCRIPTS

**Description:** Value corresponding to JSL's $SAMPLE_SCRIPTS directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.SAMPLE_SCRIPTS)


```

#### [TEMP](#temp_1)

**Syntax:** jmp.TEMP

**Description:** Value corresponding to JSL's $TEMP directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.TEMP)


```

#### [USER_APPDATA](#user_appdata_1)

**Syntax:** jmp.USER_APPDATA

**Description:** Value corresponding to JSL's $USER_APPDATA directory.

**JMP Version Added:** 18

```

import jmp
print(jmp.USER_APPDATA)


```

#### [**jmp_version**](#jmp_version_1)

**Syntax:** jmp.**jmp_version**

**Description:** Version number of the JMP executable.

**JMP Version Added:** 18

```

import jmp
print(jmp.__jmp_version__)


```

#### [**version**](#version_1)

**Syntax:** jmp.**version**

**Description:** Version number of the 'jmp' import package. This is not the JMP version.

**JMP Version Added:** 18

```

import jmp
print(jmp.__version__)


```

#### [current](#current_1)

**Syntax:** dt = jmp.current()

**Description:** Returns a DataTable object for the current JMP data table.

**JMP Version Added:** 18

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(jmp.current())


```

#### [eval](#eval_1)

**Syntax:** result = eval(<string>|<Expression>)

**Description:** Evaluates the argument and returns the result.

**JMP Version Added:** 19

```

import jmp

from jmp import eval, Expression
expression = Expression("2 + 2")
result = eval(expression)
print(result)


```

#### [from_dataframe](#from_dataframe_1)

**Syntax:** result = jmp.from_dataframe(\<library.Dataframe>, allow_copy=<boolean>, allow_csv_fallback=<boolean>, visibility=<string>)

**Description:** Returns a jmp.DataTable object from a protocol compliant library's dataframe.

**JMP Version Added:** 19

**CSV Fallback**

```

import jmp

import jmputils        
try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

# Object columns are unsupported with jmp.from_dataframe() 
df = pd.DataFrame({
    "objects": pd.Series([{"a": 1, "b": 2}, {"a": 3, "b": 4}, {"a": 5, "b": 6}, {"a": 7, "b": 8}, {"a": 9, "b": 10}, {"a": 11, "b": 12}]),
})

dt = jmp.from_dataframe(df)
print(dt)


```

**Ibis to JMP**

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
    jmputils.jpip('install', 'ibis-framework[duckdb,examples]')

except Exception as e:
    print(f'Install failed with exception: {e}')         

 import pandas as pd
 import ibis

 pandas_df = pd.DataFrame(
     [["a", 1, 2], ["b", 3, 4]],
     columns=["one", "two", "three"],
 )
 t = ibis.memtable(pandas_df, name="t")
 print(t)
 dt = jmp.from_dataframe(t)
 print(dt)


```

**JMP to Pandas**

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
pandas_df = (pd.api.interchange.from_dataframe(dt))
print(pandas_df)


```

**JMP to Polars**

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('polars'):
        jmputils.jpip('install', 'polars', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import polars as pl

dt = jmp.open(jmp.SAMPLE_DATA + "Big Class.jmp")
polars_df = pl.from_dataframe(dt)
print(polars_df)


```

**Pandas to JMP**

```

import jmp

import jmputils

try:
    # pandas depends on numpy will install numpy if needed
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd
import numpy as np

pandas_df = pd.DataFrame(
    {
        "A": 1.0,
        "B": pd.Timestamp("20130102"),
        "C": pd.Series(1, index=list(range(4)), dtype="float32"),
        "D": np.array([3] * 4, dtype="int32"),
        "E": pd.Categorical(["test", "train", "test", "train"]),
        "F": "foo",
    }
)
print(pandas_df)

dt = jmp.from_dataframe(pandas_df)
print(dt)


```

**Polars to JMP**

```

import jmp

import jmputils

try:
    if not jmputils.is_installed('polars'):
        jmputils.jpip('install', 'polars', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import polars as pl
from datetime import date

polars_df = pl.DataFrame(
 {
    "foo": [1, 2, 3],
    "bar": [6.0, 7.0, 8.0],
    "ham": [date(2020, 1, 2), date(2021, 3, 4), date(2022, 5, 6)],
  }
 )
 print(polars_df)
 dt = jmp.from_dataframe(polars_df)
 print(dt)


```

**Visibility**

```

import jmp

import jmputils

try:
    # pandas depends on numpy will install numpy if needed
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd
import numpy as np

pandas_df = pd.DataFrame(
    {
        "A": 1.0,
        "B": pd.Timestamp("20130102"),
        "C": pd.Series(1, index=list(range(4)), dtype="float32"),
        "D": np.array([3] * 4, dtype="int32"),
        "E": pd.Categorical(["test", "train", "test", "train"]),
        "F": "foo",
    }
)
print(pandas_df)

dt = jmp.from_dataframe(pandas_df, visibility="invisible")
#dt = jmp.from_dataframe(pandas_df, visibility="private")

print(dt)


```

#### [from_dataframe_using_csv](#from_dataframe_using_csv_1)

**Syntax:** result = jmp.from_dataframe_using_csv(\<library.Dataframe>, visibility=<string>)

**Description:** Returns a jmp.DataTable object from a library's dataframe using the provided CSV conversion method.

**JMP Version Added:** 19

**General**

```

import jmp

import jmputils
try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

# Object columns are unsupported with jmp.from_dataframe() 
df = pd.DataFrame({
    "objects": pd.Series([{"a": 1, "b": 2}, {"a": 3, "b": 4}, {"a": 5, "b": 6}, {"a": 7, "b": 8}, {"a": 9, "b": 10}, {"a": 11, "b": 12}]),
})

try:
    # Try converting object without CSV fallback
    dt = jmp.from_dataframe(df, True, False)
    print("Converted using jmp.from_dataframe()")
except: 
    # Explicitly convert using CSV
    dt = jmp.from_dataframe_using_csv(df)
    print("Converted using jmp.from_dataframe_using_csv()")

print(dt)


```

**Visibility**

```

import jmp

import jmputils
try:
    if not jmputils.is_installed('pandas'):
        jmputils.jpip('install', 'pandas', echo=False)
except Exception as e:
    print(f'Install failed with exception: {e}')

import pandas as pd

# Object columns are unsupported with jmp.from_dataframe() 
df = pd.DataFrame({
    "objects": pd.Series([{"a": 1, "b": 2}, {"a": 3, "b": 4}, {"a": 5, "b": 6}, {"a": 7, "b": 8}, {"a": 9, "b": 10}, {"a": 11, "b": 12}]),
})

dt = jmp.from_dataframe_using_csv(df, visibility="invisible")
#dt = jmp.from_dataframe_using_csv(df, visibility="private")

print(dt)


```

#### [open](#open_1)

**Syntax:** obj = jmp.open('file_path' < , visibility='Invisible | Private' )

**Description:** Opens a file located at file_path. If the file is a .jmp file or a file that imports into a JMP data table, the object returned will be a DataTable object. Otherwise will return True or False for success or failure. The optional visibility parameter controls whether the opened file is hidden from view. Invisible is just hidden from view, while still showing up in the recent files menu and home window. With a Private table, the reference returned is the only reference to the table, and it does not appear in any of the file lists.

**JMP Version Added:** 18

**Excel**

```

import jmp

obj = jmp.open(jmp.SAMPLE_IMPORT_DATA + 'Bigclass.xlsx')
print(obj)


```

**Invisible**

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Animals.jmp', visibility = 'Invisible')
dt = jmp.current()
print(dt)  # success
dt = jmp.table('Animals')
print(dt)  # success
# Select and run the above first if you want to see that even though
# there is no window, Animals.jmp appears in recent files and
# home window's list of files
dt.close(save=False);
del dt


```

**JMP**

```

import jmp

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print(dt)


```

**JSL Script**

```

import jmp

obj = jmp.open(jmp.SAMPLE_SCRIPTS + 'string.jsl')
print(obj)


```

**Private**

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Animals.jmp', visibility = 'Private')
dt = jmp.current()
print(dt)  # => None
try:
  dt = jmp.table('Animals')
except FileNotFoundError:
  print('Requested table not found')
dt = jmp.open(jmp.SAMPLE_DATA + 'Animals.jmp', visibility = 'Private')
print(dt)
dt.close(save=False)
del dt


```

#### [path_variable](#path_variable_1)

**Syntax:** path_value = jmp.path_variable('SAMPLE_DATA')

**Description:** Returns the value of a path variable, which is a name like SAMPLE_DATA that is substituted for when found in pathnames.

**JMP Version Added:** 19

```

import jmp

path_value = jmp.path_variable('SAMPLE_DATA')
if not path_value:
    print('Invalid path variable.')
else:
    print(path_value)


```

#### [r_name](#r_name_1)

**Syntax:** dt = jmp.r_name(jsl_var)

**Description:** Maps a JMP variable name to an R variable name using R variable naming rules.

**JMP Version Added:** 19

```

import jmp

rName = jmp.r_name('c d e')
print(rName)


```

#### [reset](#reset_1)

**Syntax:** jmp.reset()

**Description:** Resets the shared Python environment, primarily clearing all references to objects. This does not change the import cache of imported modules. This is a limitation of the Python environment itself. Modules that load shared libraries cannot be unloaded by the running process. To reload pure Python code, see the Python.org documentation on importlib reload().

**JMP Version Added:** 19

```

import jmp

pi = 3.1415927
print(pi)
jmp.reset()
print(pi)


```

#### [run_jsl](#run_jsl_1)

**Syntax:** result = jmp.run_jsl('JSL script contents' \<, echo = True | False | None > )

**Description:** Run JSL scripting from within the Python environment, including the JSL Python interface functions. Optional echo= parameter when set to False or None stops the presented JSL source code from echoing to the log. A result will be returned for the same JSL object types that are supported by Python Send() / Get(). Script failure or unsupported JSL object types will return None.

**JMP Version Added:** 18

**Column Properties**

```

import jmp

# Create a data table
# dt = jmp.DataTable(name='table_name', rows=n)
pbp = jmp.DataTable(rows=5)
pbp.name = 'Powered by Python'
pbp.new_column('Name', jmp.DataType.Character)
pbp.new_column('Hourly Rate')
#
pbp['Name'] = ['Janet', 'James', 'Jerry', 'Jenny', 'Jill']
pbp[1] = [ 14.25, 9.75, 15.0, 12.35, '17.25']  # last value bad => becomes missing
pbp[1][4] = 17.25
#
# Change column format: Hourly Rate
jmp.run_jsl('''
Data Table( "Powered by Python" ):Hourly Rate << Format( "Currency", "USD", 17, 2 );
Data Table( "Powered by Python" ):Name << Set Display Width( 75 );
''')


```

**Get Version**

```

import jmp

jmp.run_jsl('Python Get Version();')


```

**Returned value**

```

import jmp

value = jmp.run_jsl('''
Names default to here(1);
an A = 1.5;
x = 5 * anA;
''')
print( f'{value} = jmp.run_jsl()')


```

#### [table](#table_1)

**Syntax:** dt = jmp.table('table_name')

**Description:** Returns a DataTable object for the opened table having 'table_name'

**JMP Version Added:** 18

```

import jmp

jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')
print( jmp.table('Big Class') )


```

## [jmpex > R - module > R - class](#jmpex-r-module-r-class)

### [Functions](#functions_23)

#### [Constants](#constants_2)

#### [Constructors](#constructors_8)

#### [Functions](#functions_24)

#### [**init**](#init_8)

**Syntax:** jmpex.R.R( \<'rpy2'> )

**Description:** Function to create R extension class object. Optional parameter to specify backend for R support. Currently only 'rpy2' is supported. This is the default if no argument is specified.

**JMP Version Added:** 19

```

import jmp

from jmpex.R import R

jr = R()
print(jr.r_version())


```

#### [**version**](#version_2)

**Syntax:** ver = jmpex.R.R().**version**

**Description:** The jmpex package's R support version.

**JMP Version Added:** 19

```

import jmp

from jmpex.R import R

jr = R()
print(jr.__version__)


```

#### [get](#get_2)

**Syntax:** pyobj = jmpex.R.R.get( 'name' )

**Description:** Gets the named variable from the R environment and returns it to Python using the r2obj() function. An R DataFrame is returned as a pandas.DataFrame.

**JMP Version Added:** 19

**Numeric Vector**

```

import jmp

from jmpex.R import R
import numpy as np
import rpy2.robjects as ro

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

# initialize jmpex.R.R class
jr = R()

a = dt['age']
nar = np.array( a )
print(nar.__class__)
print(nar)
rv = ro.vectors.FloatVector(nar)
print(rv.__class__)
print(rv)


```

**Set Column**

```

import jmp

from jmpex.R import R
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

jr = R()

a = jr.set( dt['age'], 'rage' )   # as_name required from Python

print(a.__class__)
print(a)
ra = jr.get('rage')
print( ra.__class__ )
print( ra )


```

**Set Data Table**

```

import jmp

from jmpex.R import R
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

jr = R()

d = jr.set( dt , 'rdt' )   # as_name required from Python
print(d.__class__)
print(d)
# A R DataFrame is returned to Python as a pandas.DataFrame
rdt = jr.get('rdt')
print( rdt.__class__ )
print( rdt )


```

**String Vector**

```

import jmp

from jmpex.R import R
import numpy as np
import rpy2.robjects as ro

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

jr = R()

s = dt['name']
nas = np.array(s)
print(nas.__class__)
print(nas)
rv = ro.vectors.StrVector(nas)
print(rv.__class__)
print(rv)


```

#### [is_connected](#is_connected)

**Syntax:** jmpex.R.R.is_connected( )

**Description:** Static function which is available whether or not an R() instance object exists. Indicates R subsystem has been initialized.

**JMP Version Added:** 19

```

import jmp

from jmpex.R import R

print(f'R initialized: {R.is_connected()}')
jr = R()
print(f'R initialized: {R.is_connected()}')


```

#### [obj2r](#obj2r)

**Syntax:** jmpex.R.R.obj2r( var )

**Description:** Create an R object from Python object.

**JMP Version Added:** 19

```

import jmp

from jmpex.R import R

jr = R()
d = { "canine": ["poodle", "dalmation", "wolf"], 
      "ages": [ 1, 3, 5], 
      "vet bill": [200.0, 300.57, 2000.99] }

r_obj = jr.obj2r( d )
p_obj = jr.r2obj( r_obj )

print(r_obj.__class__)
print(r_obj)

print(p_obj.__class__)
print(p_obj)


```

#### [r2obj](#r2obj)

**Syntax:** jmpex.R.R.r2obj( var )

**Description:** Create a regular Python object from R object.

**JMP Version Added:** 19

```

import jmp

from jmpex.R import R

jr = R()
d = { "canine": ["poodle", "dalmation", "wolf"], 
      "ages": [ 1, 3, 5], 
      "vet bill": [200.0, 300.57, 2000.99] }

r_obj = jr.obj2r( d )
p_obj = jr.r2obj( r_obj )

print(r_obj.__class__)
print(r_obj)

print(p_obj.__class__)
print(p_obj)


```

#### [r_version](#r_version)

**Syntax:** ver = jmpex.R.R.r_version( )

**Description:** Returns the version of R.

**JMP Version Added:** 19

```

import jmp

from jmpex.R import R

jr = R()
print(f'R Version: {jr.r_version()}')


```

#### [set](#set)

**Syntax:** jmpex.R.R.set( var, as_name )

**Description:** Set Python variable into R environment named by the 'as_name' parameter. The R object is created using the obj2r() function internally. Name has been passed through the appropriate name -> R Name() function to ensure name is a valid R variable name.

**JMP Version Added:** 19

**Numeric Vector**

```

import jmp

from jmpex.R import R
import numpy as np
import rpy2.robjects as ro

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

# initialize jmpex.R
jr = R()

a = dt['age']
nar = np.array( a )
print(nar.__class__)
print(nar)
rv = ro.vectors.FloatVector(nar)
print(rv.__class__)
print(rv)


```

**Set Column**

```

import jmp

from jmpex.R import R
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

jr = R()

a = jr.set( dt['age'], 'rage' )   # as_name required from Python

print(a.__class__)
print(a)
ra = jr.get('rage')
print( ra.__class__ )
print( ra )


```

**Set Data Table**

```

import jmp

from jmpex.R import R
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

jr = R()

# R DataFrame can be jmp.DataTable, pandas.DataFrame, ...
d = jr.set( dt , 'Big.Class' )   # becomes 'Big.Class'
jr.submit('Big.Class')           # see: JSL R Send File(); R Submit();

print(d.__class__)
print(d)
bc = jr.get('Big.Class')
print( bc.__class__ )
print( bc )


```

**String Vector**

```

import jmp

from jmpex.R import R
import numpy as np
import rpy2.robjects as ro

dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

jr = R()

s = dt['name']
nas = np.array(s)
print(nas.__class__)
print(nas)
rv = ro.vectors.StrVector(nas)
print(rv.__class__)
print(rv)


```

#### [submit](#submit)

**Syntax:** jmpex.R.R.submit( 'R script' )

**Description:** Submit R program code for evaluation. Returns result as Python object if available.

**JMP Version Added:** 19

**Script**

```

import jmp

from jmpex.R import R

jr = R()
jr.submit('''
x <- rnorm (100)
y <- x**2 + rnorm (100)
''')


```

**Set Data Table**

```

import jmp

from jmpex.R import R

jr = R()
dt = jmp.open(jmp.SAMPLE_DATA + 'Big Class.jmp')

# R DataFrame can be jmp.DataTable, pandas.DataFrame, ...
d = jr.set( dt , 'Big.Class' )   # becomes 'Big.Class'
df = jr.submit('Big.Class')           # see: JSL R Send File(); R Submit();
print(f'DataFrame:\n{df}')

print(d.__class__)
print(d)
bc = jr.get('Big.Class')
print( bc.__class__ )
print( bc )


```

#### [submit_file](#submit_file)

**Syntax:** jmpex.R.R.submit_file('path_to_R_script')

**Description:** Submit an R script file for evaluation. Returns result as Python object if available.

**JMP Version Added:** 19

```

import jmp

import os
from jmpex.R import R

jr = R()
result = jr.submit_file( os.path.join(jmp.SAMPLE_SCRIPTS, 'R', 'SI_example.R') )
print(result)
print(result.__class__)

po = jr.r2obj(result)
print(po)
print(po.__class__)


```

## [jmpex > R - module](#jmpex-r-module)

### [Functions](#functions_25)

#### [Concepts](#concepts_8)

#### [R](#r)

**Description:** The R module represents jmpex.R which contains the Python Class R. The class jmpex.R.R implements the interface functionality.

**JMP Version Added:** 19

## [jmpex](#jmpex)

### [Functions](#functions_26)

#### [Concepts](#concepts_9)

#### [jmpex - package](#jmpex-package)

**Description:** The jmpex package contains extension interfaces supported by JMP. Currently it contains only an R support module.

**JMP Version Added:** 19

## [jmputils](#jmputils)

### [Functions](#functions_27)

#### [Constants](#constants_3)

#### [Functions](#functions_28)

#### [**version**](#version_3)

**Description:** Version number of the jmputils package.

**JMP Version Added:** 19

```

import jmp

import jmputils
print( jmputils.__version__ )


```

#### [create_jpip](#create_jpip)

**Syntax:** create_jpip( 'directory_path' )

**Description:** Function to create the terminal/command shell version of the jpip script within the specified directory. The jpip script wraps the Python pip command ensuring the appropriate environment variables are configured. This ensures that packages installed by jpip are installed in the JMP site-packages directory.

**JMP Version Added:** 18

```

import jmp

import jmputils

jmp.run_jsl('''
dest_path = Pick Directory("Directory location to save jpip script.");
// Pick Directory on windows returns a leading / use Convert File Path()
If( Host is("Windows"),
    dest_path = Convert File Path( dest_path, windows )
);
Python Send(dest_path);
''')
jmputils.create_jpip(dest_path)


```

#### [is_installed](#is_installed)

**Syntax:** success = is_installed(package_name)

**Description:** Returns True | False if package_name is installed.

**JMP Version Added:** 19

**Example 1**

```

import jmp

import jmputils

if not jmputils.is_installed('certifi'):
    result = jmputils.jpip('install', 'certifi', echo=False)
    try:
        result.check_returncode()
        print( jmputils.package_version('certifi') )
    except Exception as e:
        print(f'jpip install failed with reason: {e}')
else:
    print( jmputils.package_version('certifi') )


```

**Package not found**

```

import jmp

import jmputils

if jmputils.is_installed('invalidjmppackage'):
    print("Surprise!")
else:
    print('Package not found.')


```

#### [jpip](#jpip)

**Syntax:** result = jpip( 'pip_cmd', packages='', echo=True )

**Description:** Callable from within JMP, this function wraps the Python pip command. Returns a subprocess.CompletedProcess object. Pass to this function a pip command argument as a string, with optional space-delimited string of packages to install. A more reliable alternate is to use lists of individual arguments. The list method works even when there are spaces in directory paths. The packages argument defaults to an empty string. The 'jmputils' package is part of the JMP embedded Python standard library. Functions within jmputils utilize only Python standard library calls or JMP built-in functionality.

**JMP Version Added:** 18

**install**

```

import jmp

from jmputils import jpip
# update to latest version of pip and setuptools then install numpy & pandas
jpip('install --upgrade', 'pip setuptools certifi')
jpip('install', 'numpy pandas')


```

**install (list arguments)**

```

import jmp

from jmputils import jpip
# update to latest version of pip and setuptools then install numpy & pandas
jpip(['install', '--upgrade'], ['pip', 'setuptools', 'certifi'])
jpip(['install'], ['numpy', 'pandas'])


```

**jmpex**

```

import jmp

import os
from jmputils import jpip
# Install jmpex package 
jpip('install', [ os.path.join(jmp.SAMPLE_SCRIPTS, 'Python', 'jmpex.zip') ] )


```

**list**

```

import jmp

from jmputils import jpip
jpip('list')


```

**Local Package**

```

import jmp

from jmputils import jpip
jmp.run_jsl('''
dest_path = Pick Directory("Directory location of local package directory to install.");
// Pick Directory on windows returns a leading / use Convert File Path()
If( Host is("Windows"),
    dest_path = Convert File Path( dest_path, windows )
);
Python Send(dest_path);
''')
print(dest_path)
jpip('install', dest_path)


```

**Requirements file**

```

import jmp

from jmputils import jpip

jmp.run_jsl('''

src_path = Pick File(
    "Select requirements.txt File",
    "$DOCUMENTS",
    {"TXT Files|txt", "All Files|*"},
    0,
    0,
    "requirements.txt"
);
show(src_path);
If( Host is("Windows"),
    src_path = Convert File Path( src_path, windows )
);
show(src_path);
Python Send(src_path);
''')
jpip('install', f'-r {src_path}')


```

**uninstall**

```

import jmp

from jmputils import jpip
# R support package jmpex uninstalled like any other Python package. 
jpip('uninstall', 'jmpex')


```

#### [package_version](#package_version)

**Syntax:** package_version(package_name)

**Description:** Version number of the named package, if installed.

**JMP Version Added:** 19

```

import jmp

import jmputils
# package_version() internally calls is_installed()
print( jmputils.package_version('certifi') )


```

#### [packages](#packages)

**Syntax:** pkgs_dict = packages()

**Description:** Returns a Python dictionary containing the list of installed packages.

**JMP Version Added:** 19

```

import jmp

import jmputils
pkgs = jmputils.packages()
print('Package,', 'Version')
for key, value in pkgs.items():
    print(f'{key}: {value}')


```
# JMP Sample Data JSL Examples

# [Bivariate Analysis](#bivariate-analysis)

More examples for this topic using the sample data files provided with JMP

### [Perform bivariate analysis](#perform-bivariate-analysis)

```

// Open data table
dt = Open("$Sample_Data/AdverseR.jmp");
// Bivariate
Bivariate(
    Y( :DAY ON DRUG ),
    X( :WEIGHT )
);


```

### [Example jsl to transpose at table](#example-jsl-to-transpose-at-table)

```

// Open data table
dt = Open("$Sample_Data/Animals Subset.jmp");
// Transpose by
Current Data Table() <<
Transpose(
    columns( :subject, :miles ),
    By( :species ),
    Label( :season )
);


```

### [Jsl code to join two tables using a cartesian join](#jsl-code-to-join-two-tables-using-a-cartesian-join)

```

// Open data table
dt = Open("$Sample_Data/Batch.jmp");
// Join
Open( "$SAMPLE_DATA/Oil Amount.jmp" ) <<
Join(
    With( Data Table( "Batch" ) ),
    Cartesian Join
);


```

### [Generate a standard least squares model](#generate-a-standard-least-squares-model)

```

// Open data table
dt = Open("$Sample_Data/Big Class Families.jmp");
// Fit weight to age vector and height
Fit Model(
    Y( :weight ),
    Effects( :age vector, :height ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Run(
        :weight << {Lack of Fit( 0 ),
        Plot Actual by Predicted( 0 ),
        Plot Regression( 0 ),
        Plot Residual by Predicted( 0 ),
        Plot Effect Leverage( 0 )}
    )
);


```

### [Perform a contingency analysis with crosstabs](#perform-a-contingency-analysis-with-crosstabs)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Contingency
Contingency(
    Y( :age ),
    X( :sex ),
    Crosstabs(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        "Cell Chi^2"n( 0 )
    )
);


```

### [Set value labels column property](#set-value-labels-column-property)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Set Sex Value Labels
Column( "sex" ) <<
ValueLabels(
    {"M", "F"},
    {"Male", "Female"}
);
Column( "sex" ) << UseValueLabels;


```

### [Perform hierarchical cluster analysis](#perform-hierarchical-cluster-analysis)

```

// Open data table
dt = Open("$Sample_Data/Birth Death.jmp");
// Hierarchical Cluster
Hierarchical Cluster(
    Columns( :birth, :death ),
    Color Clusters( 1 ),
    Mark Clusters( 1 ),
    Number of Clusters( 14 )
);


```

### [Perform a paired t-test](#perform-a-paired-t-test)

```

// Open data table
dt = Open("$Sample_Data/Blood Pressure by Time.jmp");
// paired t-test
(
Matched Pairs(
    y( BP AM, BP PM ),
    Reference Frame( 1 )
) << report)[AxisBox( 1 )] << Revert Axis;


```

### [Perform contingency analysis](#perform-contingency-analysis)

```

// Open data table
dt = Open("$Sample_Data/Car Physical Data.jmp");
// Contingency
Contingency(
    Y( :Country ),
    X( :Type ),
    Contingency Table(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 ),
        Col Cum( 0 ),
        Col Cum %( 0 ),
        Row Cum( 0 ),
        Row Cum %( 0 )
    )
);


```

### [Generate contingency analysis](#generate-contingency-analysis)

```

// Open data table
dt = Open("$Sample_Data/Car Poll.jmp");
// Contingency
Contingency(
    Y( :type ),
    X( :marital status )
);


```

### [Generate multiple correspondence analysis](#generate-multiple-correspondence-analysis)

```

// Open data table
dt = Open("$Sample_Data/Car Poll.jmp");
// Multiple Correspondence Analysis
Multiple Correspondence Analysis(
    Y(
        :sex, :marital status, :country,
        :size
    ),
    Cross Table(
        Cell Chi Square( 0 ),
        Show Total( 1 )
    )
);


```

### [Generate multiple correspondence analysis with a supplementary variable](#generate-multiple-correspondence-analysis-with-a-supplementary-variable)

```

// Open data table
dt = Open("$Sample_Data/Car Poll.jmp");
// Multiple Correspondence Analysis - with Supplementary Variable
Multiple Correspondence Analysis(
    Y( :country, :size ),
    Z( :sex ),
    Cross Table(
        Cell Chi Square( 0 ),
        Show Total( 1 )
    ),
    Cross Table of Supplementary Columns(
        Cell Chi Square( 0 ),
        Show Total( 1 )
    )
);


```

### [Generate a bivariate analsys with discrete values of hue and shade](#generate-a-bivariate-analsys-with-discrete-values-of-hue-and-shade)

```

// Open data table
dt = Open("$Sample_Data/Color Palette.jmp");
// Bivariate
Bivariate( Y( :hue axis ), X( :shade ) );


```

### [Perform process screening analysis with grouping variable](#perform-process-screening-analysis-with-grouping-variable)

```

// Open data table
dt = Open("$Sample_Data/Consumer Prices.jmp");
// Process Screening of Price by Series
Process Screening(
    Y( :Price ),
    Grouping( :Series ),
    Time( :Date ),
    Subgroup Sample Size( 3 ),
    Recent Shift Up( 1 ),
    Recent Shift Down( 1 ),
    Shift Graph( 1 )
);


```

### [Build a nominal logistic regression model](#build-a-nominal-logistic-regression-model)

```

// Open data table
dt = Open("$Sample_Data/Crops.jmp");
// Nominal Logistic Regression
Fit Model(
    Y( :CROP ),
    Effects( :S1, :S3 ),
    Personality( "Nominal Logistic" ),
    Run
);


```

### [Generate a hierarchical cluster](#generate-a-hierarchical-cluster)

```

// Open data table
dt = Open("$Sample_Data/Crops.jmp");
// Hierarchical Cluster
Hierarchical Cluster(
    Columns( :S1, :S3 ),
    Color Clusters( 1 ),
    Mark Clusters( 1 ),
    Number of Clusters( 7 )
);


```

### [Fit a standard least squares model with REML method, including random effects and interactions.](#fit-a-standard-least-squares-model-with-reml-method-including-random-effects-and-interactions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Battery Data.jmp");
// Reduced Model 1
Fit Model(
    Y( :OCV ),
    Effects(
        :Whole Plots & Random,
        :Subplots & Random, :A1, :A2, :A3,
        :A4, :C1, :C2, :A1 * C1, :A1 * C2,
        :A2 * C1, :A4 * C2
    ),
    Keep dialog open( 1 ),
    Personality(
        "Standard Least Squares"
    ),
    Method( "REML" )
);


```

### [Fit a linear mixed-effects model with random effects for whole plots and subplots, and include fixed effects for temperature, time, catalyst, and their interactions.](#fit-a-linear-mixed-effects-model-with-random-effects-for-whole-plots-and-subplots-and-include-fixed-effects-for-temperature-time-catalyst-and-their-interactions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Catalyst Design.jmp");
// Model
Fit Model(
    Effects(
        :Whole Plots & Random,
        :Subplots & Random, :Temperature,
        :Time, :Catalyst,
        :Temperature * :Time,
        :Temperature * :Catalyst,
        :Time * :Catalyst
    ),
    Y( :Y )
);


```

### [Fit a standard least squares model with random effects to simulate the response variable Y using specified effects and experimental design factors.](#fit-a-standard-least-squares-model-with-random-effects-to-simulate-the-response-variable-y-using-specified-effects-and-experimental-design-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Catalyst Design.jmp");
// Model for Y Simulated
Fit Model(
    Y( :Y Simulated ),
    Effects(
        :Temperature, :Time, :Catalyst,
        :Temperature * :Time,
        :Temperature * :Catalyst,
        :Time * :Catalyst
    ),
    Random Effects(
        :Whole Plots, :Subplots
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Method( "REML" )
);


```

### [Load data from the specified file and edit it using the Custom Design platform .](#load-data-from-the-specified-file-and-edit-it-using-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Donev Mixture Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Fit a Definitive Screening design to analyze the effects of various factors on the solids content in a peanut processing experiment.](#fit-a-definitive-screening-design-to-analyze-the-effects-of-various-factors-on-the-solids-content-in-a-peanut-processing-experiment)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Peanut Data.jmp");
// Fit Definitive Screening
Fit Definitive Screening(
    X(
        :pH, :Water Temp,
        :Extraction TIme, :Ratio,
        :Agitation Speed, :Hydrolyze,
        :"Pre-Soak"n
    ),
    Y( :Solids )
);


```

### [Develop a reduced multiple regression model using the Percent Reacted as the dependent variable, with Catalyst, Temperature, and Concentration as independent variables, and including interaction effects between Catalyst and Temperature, and Temperature and Concentration.](#develop-a-reduced-multiple-regression-model-using-the-percent-reacted-as-the-dependent-variable-with-catalyst-temperature-and-concentration-as-independent-variables-and-including-interaction-effects-between-catalyst-and-temperature-and-temperature-and-concentration)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 32 Runs.jmp");
// Reduced Model
Fit Model(
    Y( :Percent Reacted ),
    Effects(
        :Catalyst, :Temperature,
        :Concentration,
        :Catalyst * :Temperature,
        :Temperature * :Concentration
    ),
    Keep dialog open( 1 ),
    Personality(
        "Standard Least Squares"
    )
);


```

### [Fit a regression model with interaction effects to predict percent reacted using feed rate, catalyst, stir rate, temperature, and concentration from the Reactor Augment Data dataset.](#fit-a-regression-model-with-interaction-effects-to-predict-percent-reacted-using-feed-rate-catalyst-stir-rate-temperature-and-concentration-from-the-reactor-augment-data-dataset)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor Augment Data.jmp");
// Model
Fit Model(
    Effects(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration,
        :Feed Rate * :Catalyst,
        :Feed Rate * :Stir Rate,
        :Feed Rate * :Temperature,
        :Feed Rate * :Concentration,
        :Catalyst * :Stir Rate,
        :Catalyst * :Temperature,
        :Catalyst * :Concentration,
        :Stir Rate * :Temperature,
        :Stir Rate * :Concentration,
        :Temperature * :Concentration
    ),
    Y( :Percent Reacted )
);


```

### [Fit a standard least squares model to analyze the effects of various factors on wine ratings using Fit Model function.](#fit-a-standard-least-squares-model-to-analyze-the-effects-of-various-factors-on-wine-ratings-using-fit-model-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Wine Data.jmp");
// Reduced Model
Fit Model(
    Y( :Rating ),
    Effects(
        :Rater, :Variety, :"De-Stem"n,
        :Yeast, :Press, :Barrel Seasoning,
        :Filtering
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Screening" )
);


```

### [Create a categorical analysis comparing various responses across different age groups using the Categorical function.](#create-a-categorical-analysis-comparing-various-responses-across-different-age-groups-using-the-categorical-function)

```

// Open data table
dt = Open("$Sample_Data/Discovery US 2018 Survey.jmp");
// Categorical by Age
Categorical(
    X( :Age ),
    Responses( :Handedness ),
    Responses( :Analysis ),
    Responses( :BBQ ),
    Responses( :Pie ),
    Responses( :Discoveries ),
    Responses( :OS ),
    Responses( :Usage ),
    Responses( :Boy Band ),
    Responses( :DGA ),
    Responses( :Type ),
    Legend( 0 )
);


```

### [Perform a standard least squares regression analysis to model the relationship between the response variable and the specified effects.](#perform-a-standard-least-squares-regression-analysis-to-model-the-relationship-between-the-response-variable-and-the-specified-effects)

```

// Open data table
dt = Open("$Sample_Data/Drug.jmp");
// Fit Model
Fit Model(
    Y( :y ),
    Effects( :Drug, :x ),
    Personality(
        "Standard Least Squares"
    ),
    Run
);


```

### [Perform a conditional logistic regression analysis using the Choice platform to adjust for confounding variables.](#perform-a-conditional-logistic-regression-analysis-using-the-choice-platform-to-adjust-for-confounding-variables)

```

// Open data table
dt = Open("$Sample_Data/Endometrial Cancer.jmp");
// Conditional Logistic Regression
Choice(
    Profile DataTable(
        Current Data Table()
    ),
    Profile ID( :Outcome ),
    Profile Grouping( :Pair ),
    Profile Effects(
        :Gallbladder, :Hypertension
    ),
    "Firth Bias-adjusted Estimates"n( 0 ),
    Likelihood Ratio Tests( 1 )
);


```

### [Fit a nonlinear mixed-effects model with Scheffe cubic interactions for a mixture design experiment.](#fit-a-nonlinear-mixed-effects-model-with-scheffe-cubic-interactions-for-a-mixture-design-experiment)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Formulation For Homogeneity DOE.jmp");
// Model
Fit Model(
    Effects(
        :Solvent & Mixture,
        :Active & Mixture,
        :Water & Mixture,
        :Solvent * :Active,
        :Solvent * :Water,
        :Active * :Water,
        :Solvent * :Active * :Water,
        Scheffe Cubic( Solvent, Active ),
        Scheffe Cubic( Solvent, Water ),
        Scheffe Cubic( Active, Water )
    ),
    Y( :T ),
    No Intercept( 1 )
);


```

### [Build a loglinear variance model with interaction terms for shrinkage in the Injection Molding dataset.](#build-a-loglinear-variance-model-with-interaction-terms-for-shrinkage-in-the-injection-molding-dataset)

```

// Open data table
dt = Open("$Sample_Data/InjectionMolding.jmp");
// Model
Fit Model(
    Y( :Shrinkage ),
    Effects(
        :MoldTemp, :Screw Speed,
        :MoldTemp * :Screw Speed
    ),
    LogVariance Effects(
        :Hold Time & LogVariance
    ),
    Personality( "Loglinear Variance" ),
    Run
);


```

### [Create a JSL script to define and parameterize an exponential loss function template.](#create-a-jsl-script-to-define-and-parameterize-an-exponential-loss-function-template)

```

// Exponential.jsl
///////////////////////////////////////////////////////////////////////////////////////////////////////////
// JSL to create a loss function template of Exponenential             //
///////////////////////////////////////////////////////////////////////////////////////////////////////////

dt= new table ("Exponential");
dt<<New Column("Time", Numeric,continuous);   
dt<<New Column("Censor", Numeric,continuous);
dt<<New Column("Exponential", Numeric,continuous);
col=column( "Exponential");
col<<formula( Parameter({sigma=28703.3328183542}, -IfMZ( :Censor==0, (-Log(sigma))- :Time/sigma, -( :Time/sigma)))  );


```

### [Perform one-way analysis with matching using the Oneway function .](#perform-one-way-analysis-with-matching-using-the-oneway-function)

```

// Open data table
dt = Open("$Sample_Data/Matching.jmp");
// Oneway - Matching
Oneway(
    Y( :miles ),
    X( :season ),
    X Axis proportional( 0 ),
    Matching Lines( 1 ),
    Matching Column( subject )
);


```

### [Explore patterns in a dataset containing various laboratory test results using the function `Explore Patterns`.](#explore-patterns-in-a-dataset-containing-various-laboratory-test-results-using-the-function-explore-patterns)

```

// Open data table
dt = Open("$Sample_Data/Nicardipine Lab Patterns.jmp");
// Explore Patterns
Explore Patterns(
    Y(
        :Activated PTT, :ALT, :ALP, :AST,
        :Bilirubin, :BUN, :Calcium, :CO2,
        :Chloride, :Creatine Kinase,
        :Creatinine, :Erythrocytes,
        :Glucose, :Hematocrit,
        :Hemoglobin, :LDH, :Leukocytes,
        :PCO2, :Partial Pressure Oxygen,
        :pH, :Phosphate, :Platelet,
        :Potassium, :Protein,
        :Prothrombin Time, :Sodium,
        :Urate
    )
);


```

### [Fit a statistical model using the Fit Model platform with specified effects and response variable.](#fit-a-statistical-model-using-the-fit-model-platform-with-specified-effects-and-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Odor JSS.jmp");
// Model
Fit Model(
    Effects(
        :temp & RS, :gl ratio & RS,
        :ht & RS, :temp * :temp,
        :temp * :gl ratio,
        :gl ratio * :gl ratio,
        :temp * :ht, :gl ratio * :ht,
        :ht * :ht
    ),
    Y( :Odor )
);


```

### [Fit a statistical model using a knotted spline effect to analyze the relationship between ozone levels and population.](#fit-a-statistical-model-using-a-knotted-spline-effect-to-analyze-the-relationship-between-ozone-levels-and-population)

```

// Open data table
dt = Open("$Sample_Data/Polycity.jmp");
// Fit Model with Knotted Spline Effect
Fit Model(
    Y( :OZONE ),
    Effects( :POP & Knotted( 5 ) ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Leverage" ),
    Run(
        :OZONE << {Lack of Fit( 0 ),
        Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Create a bivariate plot to visualize the relationship between the portion of the population aged 60 and above and the portion aged 0-19, adjusting the frame size and marker drawing mode.](#create-a-bivariate-plot-to-visualize-the-relationship-between-the-portion-of-the-population-aged-60-and-above-and-the-portion-aged-0-19-adjusting-the-frame-size-and-marker-drawing-mode)

```

// Open data table
dt = Open("$Sample_Data/PopAgeGroup.jmp");
// Age Portion
Bivariate(
    Y( :"Portion60+"n ),
    X( :"Portion 0-19"n ),
    SendToReport(
        Dispatch( {}, "Bivar Plot",
            FrameBox,
            {Frame Size( 532, 339 ),
            Marker Drawing Mode( "Fast" )
            }
        )
    )
);


```

### [Perform a logistic regression analysis with age as the dependent variable and weight in pounds as the independent variable.](#perform-a-logistic-regression-analysis-with-age-as-the-dependent-variable-and-weight-in-pounds-as-the-independent-variable)

```

// Open data table
dt = Open("$Sample_Data/World Class.jmp");
// Logistic
Logistic(
    Y( :age ),
    X( :"weight (lb.)"n )
);


```

### [Generate an Exponentially Weighted Moving Average (EWMA) control chart for monitoring quality control metrics.](#generate-an-exponentially-weighted-moving-average-ewma-control-chart-for-monitoring-quality-control-metrics)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Clips1.jmp");
// EWMA Chart
EWMA Control Chart(
    Y( :Gap ),
    Subgroup( :Sample )
);


```

### [Perform a bivariate analysis on the Hours and Temp variables using the Bivariate platform.](#perform-a-bivariate-analysis-on-the-hours-and-temp-variables-using-the-bivariate-platform)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Devalt.jmp");
// Bivariate
Bivariate( Y( :Hours ), X( :Temp ) );


```

### [Generate a model-driven multivariate control chart with principal component scores using historical data.](#generate-a-model-driven-multivariate-control-chart-with-principal-component-scores-using-historical-data)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Flight Delays.jmp");
// PCA score with historical
Model Driven Multivariate Control Chart(
    Process( :Prin1, :Prin2, :Prin3 ),
    Historical Data End at Row( 16 ),
    T2 Plot,
    Statistical Prediction Error Plot,
    Normalized DModX Plot
);


```

### [Build a Multivariate Control Chart using the Principal Components method and Phase Detection.](#build-a-multivariate-control-chart-using-the-principal-components-method-and-phase-detection)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Gravel.jmp");
// Multivariate Control Chart
Multivariate Control Chart(
    Y( :Large, :Medium ),
    Principal Components( 1 ),
    Phase Detection( 1 )
);


```

### [Fit a parametric survival model using the LogNormal distribution in the Fit Model platform, incorporating frequency weights and a censoring variable.](#fit-a-parametric-survival-model-using-the-lognormal-distribution-in-the-fit-model-platform-incorporating-frequency-weights-and-a-censoring-variable)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Devalt.jmp");
// Fit Parametric Survival
Fit Model(
    Freq( :Weight ),
    Y( :Hours ),
    Effects( :x ),
    Personality( "Parametric Survival" ),
    Distribution( LogNormal ),
    Censor( :Censor ),
    Censor Code( 1 ),
    Run(
        Likelihood Ratio Tests( 1 ),
        {
        Estimate Survival Probability(
            x = 40.9853,
            [30000, 10000],
            Alpha( 0.05 )
        )}
    )
);


```

### [Perform repeated measures degradation analysis using the Degradation function.](#perform-repeated-measures-degradation-analysis-using-the-degradation-function)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Device B.jmp");
// Degradation
Degradation(
    Y( :Power Drop ),
    Time( :Hours ),
    Label( :Device ),
    X( :Degrees C ),
    Application(
        Repeated Measures Degradation
    )
);


```

### [Perform a One-Way ANOVA analysis on temperature data using the Oneway platform, comparing Fahrenheit measurements across different thermometer types and generating various comparative visualizations, including ANOM charts and mean diamonds.](#perform-a-one-way-anova-analysis-on-temperature-data-using-the-oneway-platform-comparing-fahrenheit-measurements-across-different-thermometer-types-and-generating-various-comparative-visualizations-including-anom-charts-and-mean-diamonds)

```

// Open data table
dt = Open("$Sample_Data/S4 Temps.jmp");
// Oneway - Thermometers
Oneway(
    Y( :fahrenheit ),
    X( :thermometer ),
    Each Pair(
        1,
        Ordered Differences Report( 0 )
    ),
    ANOM( 1 ),
    Mean Diamonds( 1 ),
    Comparison Circles( 1 ),
    SendToReport(
        Dispatch( {"Analysis of Means"},
            "ANOM Graph", FrameBox,
            {Marker Size( 4 )}
        )
    )
);


```

### [Perform an ordinal logistic regression analysis to model the Taste Test outcome based on Salt & RS and Salt squared effects.](#perform-an-ordinal-logistic-regression-analysis-to-model-the-taste-test-outcome-based-on-salt-rs-and-salt-squared-effects)

```

// Open data table
dt = Open("$Sample_Data/Salt in Popcorn.jmp");
// Ordinal Fit
Fit Model(
    Y( :Taste Test ),
    Effects( :Salt & RS, :Salt * :Salt ),
    Personality( "Ordinal Logistic" ),
    Run
);


```

### [Join two data tables containing unequal numbers of rows using the By Row Number method.](#join-two-data-tables-containing-unequal-numbers-of-rows-using-the-by-row-number-method)

```

// Open data table
dt = Open("$Sample_Data/Species1.jmp");
// Joining unequal rows
Data Table( "Species1" ) <<
Join(
    With(
        Open(
            "$SAMPLE_DATA/Species2.jmp"
        )
    ),
    By Row Number
);


```

### [Perform a one-way ANOVA analysis in the Oneway platform.](#perform-a-one-way-anova-analysis-in-the-oneway-platform)

```

// Open data table
dt = Open("$Sample_Data/Snapdragon.jmp");
// Oneway Anova
Oneway(
    Y( :Y ),
    X( :Soil ),
    Block( :Block ),
    Anova( 1 ),
    Mean Diamonds( 1 )
);


```

### [Perform a One-Way ANOVA with ANOMV for Variances to analyze the relationship between weight and brand in the Spring Data dataset.](#perform-a-one-way-anova-with-anomv-for-variances-to-analyze-the-relationship-between-weight-and-brand-in-the-spring-data-dataset)

```

// Open data table
dt = Open("$Sample_Data/Spring Data.jmp");
// Oneway with ANOMV
Oneway(
    Y( :Weight ),
    X( :Brand ),
    ANOM for Variances(
        1,
        Show Summary Report( 1 )
    ),
    Box Plots( 0 ),
    Mean Diamonds( 0 ),
    SendToReport(
        Dispatch(
            {
            "Analysis of Means for Variances"
            }, "ANOMV Graph", FrameBox,
            {Marker Size( 4 )}
        )
    )
);


```

### [Fit a Nominal Logistic Regression Model using selected variables to predict the Survival status.](#fit-a-nominal-logistic-regression-model-using-selected-variables-to-predict-the-survival-status)

```

// Open data table
dt = Open("$Sample_Data/Titanic Passengers.jmp");
// Fit Model
Fit Model(
    Y( :Survived ),
    Effects(
        :Passenger Class, :Sex, :Age,
        :Siblings and Spouses,
        :Parents and Children, :Fare
    ),
    Personality( "Nominal Logistic" ),
    Run(
        Likelihood Ratio Tests( 1 ),
        Wald Tests( 0 )
    )
);


```

### [Create a Variability Chart with Standard Deviation and Bias Reports to assess linearity and process variation.](#create-a-variability-chart-with-standard-deviation-and-bias-reports-to-assess-linearity-and-process-variation)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/MSALinearity.jmp");
// Variability Chart
Variability Chart(
    Y( :Response ),
    X( :Part ),
    Standard( :Standard ),
    Process Variation( 14.9286 ),
    Std Dev Chart( 1 ),
    Bias Report( 1 ),
    Linearity Study( 0.05 )
);


```

### [Perform Bivariate Analysis on Weight and Height Data with Fit Line and Fit Robust Models](#perform-bivariate-analysis-on-weight-and-height-data-with-fit-line-and-fit-robust-models)

```

// Open data table
dt = Open("$Sample_Data/Weight Measurements.jmp");
// Bivariate
Bivariate(
    Y( :weight ),
    X( :height ),
    Fit Line(
        {Line Color( {213, 72, 87} )}
    ),
    Fit Robust(
        {Line Color( {57, 177, 67} )}
    )
);


```

### [Perform a contingency analysis on categorical variables age and sex, displaying counts, percentages, and expected frequencies.](#perform-a-contingency-analysis-on-categorical-variables-age-and-sex-displaying-counts-percentages-and-expected-frequencies)

```

// Open data table
dt = Open("$Sample_Data/World Class.jmp");
// Contingency
Contingency(
    Y( :age ),
    X( :sex ),
    Crosstabs(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        "Cell Chi^2"n( 0 )
    )
);


```

### [Example jsl code to join 2 tables by matching columns](#example-jsl-code-to-join-2-tables-by-matching-columns)

```

// Open data table
dt = Open("$Sample_Data/Coffee Shop Purchases.jmp");
// Join
Data Table( "Coffee Shop Purchases" ) <<
Join(
    With(
        Data Table(
            "Coffee Shop Purchases"
        )
    ),
    By Matching Columns(
        :Date = :Date,
        :Customer = :Customer,
        :Beverage = :Beverage
    ),
    Drop multiples( 1, 1 ),
    "Include non-matches"n( 0, 0 ),
    Preserve main table order( 1 ),
    Output Table(
        "Coffee Shop Purchases Final"
    )
);


```

### [Fit a Standard Least Squares Model with Effect Screening to Predict Price Using Carat Weight, Color, Clarity, Depth, Table, Cut, and Report as Effects.](#fit-a-standard-least-squares-model-with-effect-screening-to-predict-price-using-carat-weight-color-clarity-depth-table-cut-and-report-as-effects)

```

// Open data table
dt = Open("$Sample_Data/Diamonds Data.jmp");
// Fit Model
Fit Model(
    Y( :Price ),
    Effects(
        :Carat Weight, :Color, :Clarity,
        :Depth, :Table, :Cut, :Report
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Screening" ),
    Run(
        Profiler(
            1,
            Confidence Intervals( 1 ),
            Desirability Functions( 1 ),
            Price <<
            Response Limits(
                {Lower( 2000, 0.01 ),
                Middle( 3000, 1 ),
                Upper( 4000, 0.01 ),
                Goal( Match Target ),
                Importance( 1 )}
            ),
            Term Value(
                Carat Size(
                    0.631909406669322
                ),
                Color( "E" ),
                Clarity( "VS2" ),
                Depth( 58.015177401438 ),
                Table( 62.4632071198035 ),
                Cut( "Ideal" ),
                Report( "GIA" )
            )
        ),
        :Price << {Sorted Estimates( 0 ),
        Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 ),
        Plot Regression( 0 ),
        Plot Residual by Predicted( 0 ),
        Plot Effect Leverage( 0 )}
    )
);


```

### [Perform Multiple Correspondence Analysis (MCA) with 'TV', 'Film', 'Art', and 'Restaurant' as categorical response variables, 'Subject' as a supplementary row variable, and 'Age' as a supplementary column variable, and visualize the results in a 2D plot.](#perform-multiple-correspondence-analysis-mca-with-tv-film-art-and-restaurant-as-categorical-response-variables-subject-as-a-supplementary-row-variable-and-age-as-a-supplementary-column-variable-and-visualize-the-results-in-a-2d-plot)

```

// Open data table
dt = Open("$Sample_Data/Employee Taste.jmp");
// MCA-subject-supp-age
Multiple Correspondence Analysis(
    Y( :TV, :Film, :Art, :Restaurant ),
    X( :Subject ),
    Z( :Age ),
    Cross Table( Show Total( 1 ) ),
    Cross Table of Supplementary Rows(
        Show Total( 1 )
    ),
    Select dimension( 1, 3 ),
    SendToReport(
        Dispatch( {}, "Variable Summary",
            OutlineBox,
            {Close( 1 )}
        ),
        Dispatch(
            {"Correspondence Analysis"},
            "2", ScaleBox,
            {Format( "Fixed Dec", 12, 0 ),
            Min( -2 ), Max( 3.5 ),
            Inc( 1 ), Minor Ticks( 1 )}
        ),
        Dispatch(
            {"Correspondence Analysis"},
            "Details", OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Fit a quadratic regression model by including polynomial terms of reaction time and reaction temperature, as well as their interactions and higher-order interactions, using the Fit Model function.](#fit-a-quadratic-regression-model-by-including-polynomial-terms-of-reaction-time-and-reaction-temperature-as-well-as-their-interactions-and-higher-order-interactions-using-the-fit-model-function)

```

// Open data table
dt = Open("$Sample_Data/First-Order Kinetics.jmp");
// Model quadratic
Fit Model(
    Effects(
        :Reaction Time & RS,
        :Reaction Temperature & RS,
        :Reaction Time * :Reaction Time,
        :Reaction Time *
        :Reaction Temperature,
        :Reaction Temperature *
        :Reaction Temperature,
        :Reaction Time * :Reaction Time
         * :Reaction Time,
        :Reaction Time * :Reaction Time
         * :Reaction Temperature,
        :Reaction Time * (
        Reaction Temperature *
        :Reaction Temperature),
        :Reaction Temperature *
        :Reaction Temperature *
        :Reaction Temperature
    ),
    Y( :Yield )
);


```

### [Perform a choice model analysis using the Choice function .](#perform-a-choice-model-analysis-using-the-choice-function)

```

// Open data table
dt = Open("$Sample_Data/Lung Cancer Choice.jmp");
// Choice
Open(
    "$SAMPLE_DATA/Lung Cancer Responses.jmp"
);
Choice(
    Response DataTable(
        Lung Cancer Choice
    ),
    Profile DataTable(
        Lung Cancer Responses
    ),
    Subject DataTable(
        Lung Cancer Choice
    ),
    Response Profile ID Chosen(
        :Lung Cancer
    ),
    Response Freq( :Count ),
    Response Profile ID Choices(
        :Choice1, :Choice2
    ),
    Profile ID( :Lung Cancer ),
    Profile Effects( :Lung Cancer ),
    Subject Effects( :Smoker ),
    "Firth Bias-adjusted Estimates"n( 0 ),
    Likelihood Ratio Tests( 1 )
);


```

### [Construct a response surface model using the Standard Least Squares personality to analyze the effects of multiple variables and their interactions on the odor response.](#construct-a-response-surface-model-using-the-standard-least-squares-personality-to-analyze-the-effects-of-multiple-variables-and-their-interactions-on-the-odor-response)

```

// Open data table
dt = Open("$Sample_Data/Odor Control Original.jmp");
// Response Surface
Fit Model(
    Y( :odor ),
    Effects(
        :temp & RS, :gl ratio & RS,
        :ht & RS, :temp * :temp,
        :gl ratio * :temp,
        :gl ratio * :gl ratio,
        :ht * :temp, :ht * :gl ratio,
        :ht * :ht
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        Profiler( 1 ),
        :odor << {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )}
    )
);


```

### [Create a Bubble Plot Street Map visualization using longitude and latitude data to represent population sizes, with colors indicating lead levels. Use the Background Map function to display a street map service and set axis scales and settings for the X and Y coordinates. Incorporate custom title and frame adjustments.](#create-a-bubble-plot-street-map-visualization-using-longitude-and-latitude-data-to-represent-population-sizes-with-colors-indicating-lead-levels-use-the-background-map-function-to-display-a-street-map-service-and-set-axis-scales-and-settings-for-the-x-and-y-coordinates-incorporate-custom-title-and-frame-adjustments)

```

// Open data table
dt = Open("$Sample_Data/Pollutants Map.jmp");
// Bubble Plot Street Map
Bubble Plot(
    X( :Longitude ),
    Y( :Latitude ),
    Sizes( :POP ),
    ID( :Lead ),
    Bubble Size( 18.1 ),
    Label( "None" ),
    Trail Lines( "None" ),
    Color Theme(
        "Green to Black to Red"
    ),
    Title Position( 0, 0 ),
    SendToReport(
        Dispatch( {}, "1", ScaleBox,
            {Min( -125.667129872271 ),
            Max( -69.8506306784654 ),
            Inc( 10 ), Minor Ticks( 1 ),
            Rotated Labels(
                "Horizontal"
            )}
        ),
        Dispatch( {}, "2", ScaleBox,
            {Min( 21.9791666666667 ),
            Max( 53.1081814236111 ),
            Inc( 5 ), Minor Ticks( 1 ),
            Rotated Labels(
                "Horizontal"
            )}
        ),
        Dispatch( {}, "Bubble Plot",
            FrameBox,
            {Frame Size( 598, 343 ),
            Background Map(
                Images(
                    "Street Map Service"
                )
            ), Grid Line Order( 3 ),
            Reference Line Order( 4 )}
        )
    )
);


```

### [Analyze customer preference data for potato chips using Max Diff with a focus on product of value.](#analyze-customer-preference-data-for-potato-chips-using-max-diff-with-a-focus-on-product-of-value)

```

// Open data table
dt = Open("$Sample_Data/Potato Chip Responses.jmp");
// Max Diff for Product Of
Open(
    "$Sample_Data/Potato Chip Subjects.jmp"
);
Open(
    "$Sample_Data/Potato Chip Profiles.jmp"
);
MaxDiff(
    Response Data Table(
        Data Table(
            "Potato Chip Responses"
        )
    ),
    Profile DataTable(
        Potato Chip Profiles
    ),
    Subject DataTable(
        Data Table(
            "Potato Chip Subjects"
        )
    ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices(
        :Choice 1, :Choice 2, :Choice 3
    ),
    Profile ID( :Profile ID ),
    Profile Effects( :Product Of ),
    Subject Subject ID( :Respondent ),
    Subject Effects(
        :Citizenship, :Gender
    ),
    "Firth Bias-adjusted Estimates"n( 1 ),
    Response Best Option( :Best Profile ),
    Response Worst Option(
        :Worst Profile
    )
);


```

### [Fit a generalized linear model with a Poisson distribution and log link function to the Ship Damage data table.](#fit-a-generalized-linear-model-with-a-poisson-distribution-and-log-link-function-to-the-ship-damage-data-table)

```

// Open data table
dt = Open("$Sample_Data/Ship Damage.jmp");
// Fit Model
Fit Model(
    Offset( :Service ),
    Y( :N ),
    Effects(
        :Type B, :Type C, :Type D,
        :Type E, :Yr 65, :Yr 70, :Yr 75,
        :Op 75
    ),
    Personality(
        "Generalized Linear Model"
    ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" ),
    Overdispersion Tests and Intervals(
        0
    ),
    "Firth Bias-adjusted Estimates"n( 0 ),
    Run
);


```

### [Perform a multiple linear regression analysis with length, basilar, zygomat, and postorb as response variables, and sex as a categorical predictor utilizing the Standard Least Squares personality in the Fit Model platform, and generate diagnostic plots including Actual by Predicted, Residual by Predicted, and Effect Leverage plots for each response variable.](#perform-a-multiple-linear-regression-analysis-with-length-basilar-zygomat-and-postorb-as-response-variables-and-sex-as-a-categorical-predictor-utilizing-the-standard-least-squares-personality-in-the-fit-model-platform-and-generate-diagnostic-plots-including-actual-by-predicted-residual-by-predicted-and-effect-leverage-plots-for-each-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Skull.jmp");
// Fit Model 2
Fit Model(
    Y(
        :length, :basilar, :zygomat,
        :postorb
    ),
    Effects( :sex ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        :length <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )},
        :basilar <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )},
        :zygomat <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )},
        :postorb <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Perform a bivariate analysis on infant mortality rate against crude birth rate using the World Demographics dataset.](#perform-a-bivariate-analysis-on-infant-mortality-rate-against-crude-birth-rate-using-the-world-demographics-dataset)

```

// Open data table
dt = Open("$Sample_Data/World Demographics.jmp");
// Bivariate: Infant Mortality by Birth Rate
Bivariate(
    Y( :Infant Mortality Rate ),
    X( :"Crude Birth Rate (1000)"n ),
    SendToReport(
        Dispatch( {}, "Bivar Plot",
            FrameBox,
            {Frame Size( 264, 205 ),
            Marker Size( 2 ),
            DispatchSeg(
                Marker Seg( 1 ),
                label offset(
                    {1, -104, 22},
                    {7, 8, -4},
                    {126, -2, 13},
                    {160, -15, -26},
                    {198, -103, -15}
                )
            )}
        )
    )
);


```

# [Categorical](#categorical)

More examples for this topic using the sample data files provided with JMP

## [Indicator Group](#indicator-group)

### [Perform categorical analysis with indicator group](#perform-categorical-analysis-with-indicator-group)

```

// Open data table
dt = Open("$Sample_Data/Consumer Preferences.jmp");
// Flossing Indicator by Age
Categorical(
    X( :Age Group ),
    Indicator Group(
        :Floss After Waking Up,
        :Floss After Meal,
        :Floss Before Sleep,
        :Floss Another Time
    ),
    Share Of Responses( 0 ),
    Share Chart( 0 ),
    Frequency Chart( 1 ),
    Crosstab Transposed( 1 ),
    Legend( 0 ),
    Test Each Response( 1 )
);


```

# [Clustering](#clustering)

More examples for this topic using the sample data files provided with JMP

### [Build a partition model](#build-a-partition-model)

```

// Open data table
dt = Open("$Sample_Data/Auto Raw Data.jmp");
// Partition (Claim Y/N)
Partition(
    Y( :"Claim(Y/N)"n ),
    X(
        :AgeClass, :Gender, :Car Power,
        :Rating Class, :"City(Y/N)"n
    ),
    Minimum Size Split( 20 ),
    Show Split Prob( 1 ),
    Small Tree View( 1 ),
    Criterion( "Maximize Significance" ),
    Initial Splits(
        :AgeClass == {"Young"},
        {:"City(Y/N)"n == {"Y"},
        {:Rating Class == {"D", "C"}}}
    ),
    SendToReport(
        Dispatch( {}, "Partition Graph",
            FrameBox,
            {Frame Size( 400, 195 ),
            Marker Drawing Mode( "Fast" )
            }
        ),
        Dispatch( {}, "Partition Report",
            FrameBox,
            {Frame Size( 400, 74 )}
        )
    )
);


```

### [Build a partition model](#build-a-partition-model_1)

```

// Open data table
dt = Open("$Sample_Data/Auto Raw Data.jmp");
// Partition (Claim USD)
Partition(
    Y( :Claim USD ),
    X(
        :AgeClass, :Gender, :Car Power,
        :Rating Class, :"City(Y/N)"n
    ),
    Minimum Size Split( 20 ),
    Small Tree View( 1 ),
    Criterion( "Maximize Significance" ),
    Initial Splits(
        :Rating Class == {"A", "B"},
        {},
        {:AgeClass == {"Elder"}, {},
        {:"City(Y/N)"n == {"N"}}}
    ),
    SendToReport(
        Dispatch( {}, "2", ScaleBox,
            {
            Format(
                "Currency",
                "USD",
                15,
                0
            )}
        ),
        Dispatch( {}, "Partition Report",
            FrameBox,
            {
            Marker Drawing Mode( "Fast" )
            }
        )
    )
);


```

### [Fit a nominal logistic model](#fit-a-nominal-logistic-model)

```

// Open data table
dt = Open("$Sample_Data/Auto Raw Data.jmp");
// Fit Model (Claim Y/N)
Fit Model(
    Y( :"Claim(Y/N)"n ),
    Effects(
        :AgeClass, :"City(Y/N)"n,
        :Rating Class
    ),
    Personality( "Nominal Logistic" ),
    Run(
        Likelihood Ratio Tests( 1 ),
        Wald Tests( 0 ),
        Profiler(
            1,
            Term Value(
                AgeClass( "Elder" ),
                "City(Y/N)"n( "N" ),
                Rating Class( "A" )
            )
        )
    )
);


```

### [Build a decision tree model using partition](#build-a-decision-tree-model-using-partition)

```

// Open data table
dt = Open("$Sample_Data/Bands Data.jmp");
// Partition (final)
Random Reset( 234 );
Partition(
    Y( :Banding? ),
    X(
        :grain screened,
        :proof on ctd ink, :blade mfg,
        :paper type, :ink type,
        :direct steam, :solvent type,
        :type on cylinder, :press type,
        :unit number, :cylinder size,
        :paper mill location,
        :plating tank, :proof cut,
        :viscosity, :caliper,
        :ink temperature, :humidity,
        :roughness, :blade pressure,
        :varnish pct, :press speed,
        :ink pct, :solvent pct,
        :ESA Voltage, :ESA Amperage, :wax,
        :hardener, :roller durometer,
        :current density,
        :anode space ratio,
        :chrome content
    ),
    Validation Portion( 0.2 ),
    Split History( 1 ),
    Informative Missing( 1 ),
    Go
);


```

### [Perform Multiple Correspondence Analysis (MCA) on the given data table, fitting supplementary variables by age.](#perform-multiple-correspondence-analysis-mca-on-the-given-data-table-fitting-supplementary-variables-by-age)

```

// Open data table
dt = Open("$Sample_Data/Employee Taste.jmp");
// MCA-level-supp-age
Multiple Correspondence Analysis(
    Y( :TV, :Film, :Art, :Restaurant ),
    Z( :Age ),
    Cross Table( Show Total( 1 ) ),
    Cross Table of Supplementary Columns(
        Show Total( 1 )
    ),
    SendToReport(
        Dispatch( {}, "Variable Summary",
            OutlineBox,
            {Close( 1 )}
        ),
        Dispatch(
            {"Correspondence Analysis"},
            "Details", OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Perform hierarchical clustering on flight distances using the Ward method with standardized data, and display the dendrogram with 10 clusters colored for easy identification.](#perform-hierarchical-clustering-on-flight-distances-using-the-ward-method-with-standardized-data-and-display-the-dendrogram-with-10-clusters-colored-for-easy-identification)

```

// Open data table
dt = Open("$Sample_Data/Flight Distances.jmp");
// Hierarchical Cluster
Hierarchical Cluster(
    Y(
        :Birmingham, :Boston, :Buffalo,
        :Chicago, :Cleveland, :Dallas,
        :Denver, :Detroit, :El Paso,
        :Houston, :Indianapolis,
        :Kansas City, :Los Angeles,
        :Louisville, :Memphis, :Miami,
        :Minneapolis, :New Orleans,
        :New York, :Omaha, :Philadelphia,
        :Phoenix, :Pittsburgh, :St. Louis,
        :Salt Lake City, :San Francisco,
        :Seattle, :Washington DC
    ),
    Label( :Cities ),
    Method( "Ward" ),
    Standardize Data( 1 ),
    Distance Matrix( 1 ),
    Dendrogram Scale( "Distance Scale" ),
    Number of Clusters( 10 ),
    Color Clusters( 1 ),
    SendToReport(
        Dispatch( {}, "Dendrogram",
            OutlineBox,
            {SetHorizontal( 1 )}
        )
    )
);


```

### [Fit a generalized linear model with various interaction and Scheffe cubic effects in the Fit Model platform.](#fit-a-generalized-linear-model-with-various-interaction-and-scheffe-cubic-effects-in-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/NMR DoE.jmp");
// Model
Fit Model(
    Effects(
        :Propanol & Mixture,
        :Butanol & Mixture,
        :Pentanol & Mixture,
        :Propanol * :Butanol,
        :Propanol * :Pentanol,
        :Butanol * :Pentanol,
        :Propanol * :Butanol * :Pentanol,
        Scheffe Cubic(
            Propanol,
            Butanol
        ),
        Scheffe Cubic(
            Propanol,
            Pentanol
        ),
        Scheffe Cubic(
            Butanol,
            Pentanol
        )
    ),
    No Intercept( 1 )
);


```

### [Analyze a multivariate dataset using the Multivariate platform, generating a scatterplot matrix with density ellipses and customizing axis scales.](#analyze-a-multivariate-dataset-using-the-multivariate-platform-generating-a-scatterplot-matrix-with-density-ellipses-and-customizing-axis-scales)

```

// Open data table
dt = Open("$Sample_Data/Polyethylene Process.jmp");
// Multivariate
Multivariate(
    Y( :Tmax2, :z2, :Fi2 ),
    Estimation Method( "Row-wise" ),
    Scatterplot Matrix(
        Density Ellipses( 1 ),
        Shaded Ellipses( 0 )
    ),
    SendToReport(
        Dispatch( {"Scatterplot Matrix"},
            "102", ScaleBox,
            {Min( 0.385563909774436 ),
            Max( 0.576842105263158 ),
            Inc( 0.025 ),
            Minor Ticks( 0 )}
        ),
        Dispatch( {"Scatterplot Matrix"},
            "101", ScaleBox,
            {Min( 0.5675 ),
            Max( 0.636453182118107 ),
            Inc( 0.01 ), Minor Ticks( 0 )
            }
        ),
        Dispatch( {"Scatterplot Matrix"},
            "100", ScaleBox,
            {Min( 272.586320371566 ),
            Max( 292.665882156916 ),
            Inc( 5 ), Minor Ticks( 1 )}
        )
    )
);


```

### [Perform hierarchical spatial clustering on defects using the Ward method .](#perform-hierarchical-spatial-clustering-on-defects-using-the-ward-method)

```

// Open data table
dt = Open("$Sample_Data/Wafer Stacked.jmp");
// Spatial Cluster of Defects
Hierarchical Cluster(
    Y( :Defects ),
    Object ID( :Lot, :Wafer ),
    Attribute ID( :X_Die, :Y_Die ),
    Method( "Ward" ),
    Standardize Data( 0 ),
    Cluster Summary( 1 ),
    Dendrogram Scale( "Distance Scale" ),
    Number of Clusters( 7 ),
    Add Spatial Measures(
        Attributes( 1 ),
        Angle( 1 ),
        Radius( 1 ),
        Streak Angle( 1 ),
        Streak Distance( 1 )
    ),
    SendToReport(
        Dispatch( {}, "Dendrogram",
            OutlineBox,
            {Close( 1 ),
            SetHorizontal( 1 )}
        ),
        Dispatch( {"Dendrogram"},
            "Clust Dendro", FrameBox,
            {Frame Size( 35, 700 )}
        )
    )
);


```

### [Change column modeling type from ordinal to nominal and build a standard least squares model](#change-column-modeling-type-from-ordinal-to-nominal-and-build-a-standard-least-squares-model)

```

// Open data table
dt = Open("$Sample_Data/Big Class Families.jmp");
// Fit weight to age and height
Column( "age" ) <<
Set Modeling Type( "Nominal" );
Fit Model(
    Y( :weight ),
    Effects( :age, :height ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Run(
        :weight << {Lack of Fit( 0 ),
        Plot Actual by Predicted( 0 ),
        Plot Residual by Predicted( 0 ),
        Plot Effect Leverage( 0 )},
        Effect Summary( 0 )
    )
);


```

### [Perform bivariate analysis with a t test](#perform-bivariate-analysis-with-a-t-test)

```

// Open data table
dt = Open("$Sample_Data/Blood Pressure by Time.jmp");
// bivariate
Bivariate(
    x( BP AM ),
    Y( BP PM ),
    Paired T Test
);


```

### [Generate decision tree model using partition](#generate-decision-tree-model-using-partition)

```

// Open data table
dt = Open("$Sample_Data/Car Poll.jmp");
// Partition
Partition(
    Y( :country ),
    X(
        :sex, :marital status, :age,
        :type, :size
    )
);


```

### [Perform a k means cluster analysis with normal mixtures](#perform-a-k-means-cluster-analysis-with-normal-mixtures)

```

// Open data table
dt = Open("$Sample_Data/Cytometry.jmp");
// Normal Mixtures
K Means Cluster(
    Y( :CD3, :CD8, :CD4, :MCB ),
    {Mixtures Tolerance( 0.00000001 ),
    Mixtures MaxIter( 200 ),
    Mixtures N Starts( 20 ),
    Outlier Cluster( 0 ),
    Diagonal Variance( 0 ),
    Number of Clusters( 6 ),
    Normal Mixtures, Go( Biplot 3D( 1 ) )
    },
    SendToReport(
        Dispatch( {}, "Control Panel",
            OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Load data from an experiment file and edit it using the Custom Design platform .](#load-data-from-an-experiment-file-and-edit-it-using-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Cake Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Load data table and modify factors in Custom Design.](#load-data-table-and-modify-factors-in-custom-design)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Runners Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Fit a linear mixed-effects model to analyze the effect of experimental factors on the thickness of vinyl products.](#fit-a-linear-mixed-effects-model-to-analyze-the-effect-of-experimental-factors-on-the-thickness-of-vinyl-products)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Vinyl Data.jmp");
// Model
Fit Model(
    Effects(
        :Whole Plots & Random,
        :m1 & RS & Mixture,
        :m2 & RS & Mixture,
        :m3 & RS & Mixture,
        :extrusion rate * :temperature,
        :extrusion rate * :m1,
        :extrusion rate * :m2,
        :extrusion rate * :m3,
        :temperature * :m1,
        :temperature * :m2,
        :temperature * :m3, :m1 * :m2,
        :m1 * :m3, :m2 * :m3
    ),
    Y( :thickness ),
    No Intercept( 1 )
);


```

### [Construct a decision tree model for the response variable Y using the Partition platform, with the specified input variables and validation column, and incorporating initial splits to improve model accuracy.](#construct-a-decision-tree-model-for-the-response-variable-y-using-the-partition-platform-with-the-specified-input-variables-and-validation-column-and-incorporating-initial-splits-to-improve-model-accuracy)

```

// Open data table
dt = Open("$Sample_Data/Diabetes.jmp");
// Decision Tree of Y
Partition(
    Y( :Y ),
    X(
        :Age, :Gender, :BMI, :BP,
        :Total Cholesterol, :LDL, :HDL,
        :TCH, :LTG, :Glucose
    ),
    Validation( :Validation ),
    Split History( 1 ),
    Informative Missing( 1 ),
    Initial Splits(
        :LTG < 4.6444,
        {:BMI < 27.3},
        {:BMI < 31.6, {:BMI < 24.4}}
    )
);


```

### [Build a decision tree model for ordinal response variable using the Partition platform with specified initial splits and informative missing values.](#build-a-decision-tree-model-for-ordinal-response-variable-using-the-partition-platform-with-specified-initial-splits-and-informative-missing-values)

```

// Open data table
dt = Open("$Sample_Data/Diabetes.jmp");
// Decision Tree of Y Ordinal
Partition(
    Y( :Y Ordinal ),
    X(
        :Age, :Gender, :BMI, :BP,
        :Total Cholesterol, :LDL, :HDL,
        :TCH, :LTG, :Glucose
    ),
    Validation( :Validation ),
    Split History( 1 ),
    Informative Missing( 1 ),
    Initial Splits(
        :LTG < 4.6444,
        {:BMI < 24.6},
        {:BMI < 30.8, {}, {:BMI < 32.3}}
    )
);


```

### [Partition the Diamonds Data using the Partition platform, specifying Price as the response variable, and include Carat Weight, Color, Clarity, Depth, Table, Cut, and Report as predictors. Set the Minimum Size Split to 5, display split probabilities, and use the Maximize Significance criterion. Define initial splits for Color, Clarity, and Cut based on specified categorical values.](#partition-the-diamonds-data-using-the-partition-platform-specifying-price-as-the-response-variable-and-include-carat-weight-color-clarity-depth-table-cut-and-report-as-predictors-set-the-minimum-size-split-to-5-display-split-probabilities-and-use-the-maximize-significance-criterion-define-initial-splits-for-color-clarity-and-cut-based-on-specified-categorical-values)

```

// Open data table
dt = Open("$Sample_Data/Diamonds Data.jmp");
// Partition
Partition(
    Y( :Price ),
    X(
        :Carat Weight, :Color, :Clarity,
        :Depth, :Table, :Cut, :Report
    ),
    Minimum Size Split( 5 ),
    Show Split Prob( 1 ),
    Criterion( "Maximize Significance" ),
    Initial Splits(
        :Color == {"E", "D", "F"},
        {:Clarity == {"VVS1", "IF",
        "VVS2"}},
        {:Cut == {"Good", "Very Good"}}
    )
);


```

### [Perform a MANOVA analysis to evaluate the effects of drug and dep1 on multiple dependent variables (LogHist0, LogHist1, LogHist3, and LogHist5) using contrasts and sum response functions.](#perform-a-manova-analysis-to-evaluate-the-effects-of-drug-and-dep1-on-multiple-dependent-variables-loghist0-loghist1-loghist3-and-loghist5-using-contrasts-and-sum-response-functions)

```

// Open data table
dt = Open("$Sample_Data/Dogs.jmp");
// Manova
Fit Model(
    Y(
        :LogHist0, :LogHist1, :LogHist3,
        :LogHist5
    ),
    Effects(
        :drug, :dep1, :drug * :dep1
    ),
    Personality( "Manova" ),
    Run(
        Response Function( "Contrast" ),
        Response Function( "Sum" )
    )
);


```

### [Build a Naive Bayes model for predicting the BAD variable using selected financial predictors.](#build-a-naive-bayes-model-for-predicting-the-bad-variable-using-selected-financial-predictors)

```

// Open data table
dt = Open("$Sample_Data/Equity.jmp");
// Naive Bayes of BAD
Partition(
    Method( "Naive Bayes" ),
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON,
        :JOB, :YOJ, :DEROG, :DELINQ,
        :CLAGE, :NINQ, :CLNO
    ),
    Validation( :Validation )
);


```

### [Perform K-Nearest Neighbors classification on the BAD variable using specified predictors in the Equity dataset.](#perform-k-nearest-neighbors-classification-on-the-bad-variable-using-specified-predictors-in-the-equity-dataset)

```

// Open data table
dt = Open("$Sample_Data/Equity.jmp");
// K Nearest Neighbors of BAD
Partition(
    Method( "K Nearest Neighbors"
    ),
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON,
        :JOB, :YOJ, :DEROG, :DELINQ,
        :CLAGE, :NINQ, :CLNO
    ),
    Validation( :Validation ),
    K( 10 )
);


```

### [Perform multivariate analysis of variance (MANOVA) to model the relationship between two dependent variables and multiple independent variables.](#perform-multivariate-analysis-of-variance-manova-to-model-the-relationship-between-two-dependent-variables-and-multiple-independent-variables)

```

// Open data table
dt = Open("$Sample_Data/Exercise.jmp");
// Fit Model
Fit Model(
    Y( :chins, :situps, :jumps ),
    Effects( :weight, :waist, :pulse ),
    Personality( "Manova" ),
    Run
);


```

### [Analyze uplift effects using the Uplift function, with Purchase as the outcome and Gender, Age, Hair Color, U.S. Region, and Residence as predictors, incorporating a validation column, specifying a minimum split size of 63, considering Promotion as the treatment, utilizing split history, handling informative missing values, generating an uplift graph, and limiting the number of splits to 4.](#analyze-uplift-effects-using-the-uplift-function-with-purchase-as-the-outcome-and-gender-age-hair-color-us-region-and-residence-as-predictors-incorporating-a-validation-column-specifying-a-minimum-split-size-of-63-considering-promotion-as-the-treatment-utilizing-split-history-handling-informative-missing-values-generating-an-uplift-graph-and-limiting-the-number-of-splits-to-4)

```

// Open data table
dt = Open("$Sample_Data/Hair Care Product.jmp");
// Uplift
Uplift(
    Y( :Purchase ),
    X(
        :Gender, :Age, :Hair Color,
        :U.S. Region, :Residence
    ),
    Validation( :Validation ),
    Minimum Size Split( 63 ),
    Treatment( :Promotion ),
    Split History( 1 ),
    Informative Missing( 1 ),
    Uplift Graph( 1 ),
    Split Best( 4 )
);


```

### [Fit a Nominal Logistic Regression Model](#fit-a-nominal-logistic-regression-model)

```

// Open data table
dt = Open("$Sample_Data/Nonlinear Examples/Logistic w Loss.jmp");
// Fit Model
Fit Model(
    Y( :Y ),
    Effects( :X ),
    Personality( "Nominal Logistic" ),
    Run(
        Likelihood Ratio Tests( 1 ),
        Wald Tests( 0 ),
        Logistic Plot( 1 )
    )
);


```

### [Fit a nonlinear model to the data using the Model Y variable, with the loss function specified as negative log-likelihood, using the Newton method for optimization and omitting the final plot.](#fit-a-nonlinear-model-to-the-data-using-the-model-y-variable-with-the-loss-function-specified-as-negative-log-likelihood-using-the-newton-method-for-optimization-and-omitting-the-final-plot)

```

// Open data table
dt = Open("$Sample_Data/Nonlinear Examples/Logistic w Loss.jmp");
// Nonlinear with ModelY and Loss
Nonlinear(
    X( :Model Y ),
    Loss( :Loss ),
    Second Deriv Method( 1 ),
    Loss is Neg LogLikelihood( 1 ),
    Newton,
    Finish,
    Plot( 0 )
);


```

### [Perform hierarchical cluster analysis on factor scores using the Ward method with standardized data and generate cluster summary and two-way clustering with a specified number of clusters and dendrogram scale.](#perform-hierarchical-cluster-analysis-on-factor-scores-using-the-ward-method-with-standardized-data-and-generate-cluster-summary-and-two-way-clustering-with-a-specified-number-of-clusters-and-dendrogram-scale)

```

// Open data table
dt = Open("$Sample_Data/Online Consumer Data.jmp");
// Hierarchical Cluster on Factor Scores
Hierarchical Cluster(
    Y(
        :Privacy, :Security, :Reputation,
        :Trust, :Purchase Int
    ),
    Method( "Ward" ),
    Standardize Data( 1 ),
    Cluster Summary( 1 ),
    Two Way Clustering,
    Number of Clusters( 4 ),
    Dendrogram Scale( "Distance Scale" ),
    More Color Map Columns(
        :Internet Use
    )
);


```

### [Perform hierarchical clustering on the Penguin dataset using centroid linkage and standardize the data. Generate a constellation plot.](#perform-hierarchical-clustering-on-the-penguin-dataset-using-centroid-linkage-and-standardize-the-data-generate-a-constellation-plot)

```

// Open data table
dt = Open("$Sample_Data/Penguins.jmp");
// Hierarchical Clustering
Hierarchical Cluster(
    Y(
        :Culmen Length, :Culmen Depth,
        :Flipper Length, :Body Mass,
        :Delta 15 N, :Delta 13 C
    ),
    Label( :Species ),
    Method( "Centroid" ),
    Standardize Data( 1 ),
    Color Clusters( 1 ),
    Dendrogram Scale( "Distance Scale" ),
    Number of Clusters( 4 ),
    Constellation Plot( 1 )
);


```

### [Analyze a dataset containing failure frequencies using categorical analysis with sample size, date, and multiple response variables.](#analyze-a-dataset-containing-failure-frequencies-using-categorical-analysis-with-sample-size-date-and-multiple-response-variables)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failure3Freq.jmp");
// Categorical
Categorical(
    Sample Size( :SampleSize ),
    X( :clean, :date ),
    Response Frequencies(
        :contamination, :corrosion,
        :doping, :metallization,
        :miscellaneous, :oxide defect,
        :silicon defect
    )
);


```

### [Apply categorical multivariate ID analysis using the Categorical platform with frequency, ID, X, multiple response by ID, and sample size configurations.](#apply-categorical-multivariate-id-analysis-using-the-categorical-platform-with-frequency-id-x-multiple-response-by-id-and-sample-size-configurations)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failure3ID.jmp");
// Cat MultID2
Categorical(
    Freq( :N ),
    ID( :ID ),
    X( :clean, :date ),
    Multiple Response by ID( :failure ),
    Sample Size( :SampleSize )
);


```

### [Perform Principal Component Analysis to identify underlying factors influencing multiple quality control metrics in Steam Turbine Historical data.](#perform-principal-component-analysis-to-identify-underlying-factors-influencing-multiple-quality-control-metrics-in-steam-turbine-historical-data)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Steam Turbine Historical.jmp");
// Principal Component Analysis
Multivariate Control Chart(
    Y(
        :Fuel, :Steam Flow, :Steam Temp,
        :MW, :Cool Temp, :Pressure
    )
) << Save T Square <<
Save Principal Components;
Current Data Table() <<
New Column( :PCA Column,
    Continuous,
    Formula(
        :Prin1 ^ 2 + :Prin2 ^ 2 + :Prin3
         ^ 2 + :Prin4 ^ 2 + :Prin5 ^ 2
        +:Prin6 ^ 2
    )
);


```

### [Fit a standard least squares model with multiple effects and generate a profiler plot.](#fit-a-standard-least-squares-model-with-multiple-effects-and-generate-a-profiler-plot)

```

// Open data table
dt = Open("$Sample_Data/Reactor.jmp");
// Fit Model
Fit Model(
    Y( :Y ),
    Effects( :F, :Ct, :A, :T, :Cn ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        Profiler,
        :Y <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 0 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Perform standard least squares regression analysis with minimal report emphasis and an alpha level of 0.05.](#perform-standard-least-squares-regression-analysis-with-minimal-report-emphasis-and-an-alpha-level-of-005)

```

// Open data table
dt = Open("$Sample_Data/Singularity.jmp");
// Model 2
Fit Model(
    Censor Code( "" ),
    Y( :Y ),
    Effects( :X1, :X3, :X2 ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Set Alpha Level( 0.05 )
);


```

### [Create a scatterplot matrix with density ellipses and color map on correlations for multiple variables in a multivariate analysis.](#create-a-scatterplot-matrix-with-density-ellipses-and-color-map-on-correlations-for-multiple-variables-in-a-multivariate-analysis)

```

// Open data table
dt = Open("$Sample_Data/Tablet Production.jmp");
// Multivariate
Multivariate(
    Y(
        :Disso, :Mill Time, :Blend Time,
        :Blend Speed, :Force,
        :Coating Viscosity, :Inlet Temp,
        :Exhaust Temp, :Spray Rate,
        :Atomizer Pressure
    ),
    Estimation Method( "Row-wise" ),
    Scatterplot Matrix(
        Density Ellipses( 1 ),
        Shaded Ellipses( 0 ),
        Vertical( 1 ),
        Ellipse Color( 3 )
    ),
    Color Map On Correlations( 1 )
);


```

### [Perform hierarchical cluster analysis on crude death rate and crude birth rate using Ward's method and geometric spacing scaling with 14 clusters.](#perform-hierarchical-cluster-analysis-on-crude-death-rate-and-crude-birth-rate-using-wards-method-and-geometric-spacing-scaling-with-14-clusters)

```

// Open data table
dt = Open("$Sample_Data/World Demographics.jmp");
// Hierarchical Cluster: Crude Death Rate and Crude Birth Rate
Hierarchical Cluster(
    Y(
        :"Crude Death Rate (1000)"n,
        :"Crude Birth Rate (1000)"n
    ),
    Method( "Ward" ),
    Standardize( 1 ),
    Color Clusters( 1 ),
    Mark Clusters( 1 ),
    Dendrogram Scale(
        "Geometric Spacing"
    ),
    Number of Clusters( 14 )
);


```

# [Control Charts](#control-charts)

More examples for this topic using the sample data files provided with JMP

### [Build a rare event T control chart in the Control Chart Builder platform using Weibull limits for subgrouped data analysis.](#build-a-rare-event-t-control-chart-in-the-control-chart-builder-platform-using-weibull-limits-for-subgrouped-data-analysis)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Fan Burnout.jmp");
// Control Chart Builder T Chart
Control Chart Builder(
    Class( "Rare Event" ),
    Variables(
        Subgroup( :Burnout ),
        Y( :Hours between Burnouts )
    ),
    Chart(
        Points( Statistic( "Count" ) ),
        Limits( Sigma( "Weibull" ) )
    )
);


```

# [DOE](#doe)

More examples for this topic using the sample data files provided with JMP

### [Make a full factorial design with a continuous factor, a 3-level categorical factor and a 4 level categorical factor](#make-a-full-factorial-design-with-a-continuous-factor-a-3-level-categorical-factor-and-a-4-level-categorical-factor)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/2x3x4 Factorial.jmp");
// DOE Dialog
DOE(
    Full Factorial Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Add Factor(
        Continuous,
        {-1, 1},
        "X1",
        0
    ),
    Add Factor(
        Categorical,
        {"x", "y", "z"},
        "X2",
        0
    ),
    Add Factor(
        Categorical,
        {"A", "B", "C", "D"},
        "X3",
        0
    ), Set Random Seed( 151647685 ),
    Make Design, Simulate Responses( 0 ),
    Set Run Order( Sort Left to Right ),
    Make Table}
);


```

### [Generate a 50 trial space filling design with 3 continuous factors and 2 categorical factors](#generate-a-50-trial-space-filling-design-with-3-continuous-factors-and-2-categorical-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Algorithm Data.jmp");
// DOE Dialog
DOE(
    Space Filling Design,
    {
    Add Response(
        Maximize, "CPU Time", ., ., .
    ),
    Change Factor Settings(
        1, -1, 1, "Alpha"
    ),
    Change Factor Settings(
        2, -1, 1, "Beta"
    ),
    Add Factor(
        Continuous, -1, 1, "Gamma", 0
    ),
    Add Factor(
        Categorical,
        {"Dynamic", "Greedy", "Transform"
        },
        "Algorithm",
        0
    ),
    Add Factor(
        Categorical,
        {"A", "B"},
        "Compiler",
        0
    ), Set Random Seed( 12345 ),
    FFF Optimality Criterion( "MaxPro" ),
    Space Filling Design Type(
        Fast Flexible Filling, 50
    ), Make Table}
);


```

### [Generate a response surface design with three response targets and four factors, including center points, in the DOE platform.](#generate-a-response-surface-design-with-three-response-targets-and-four-factors-including-center-points-in-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Bounce Data.jmp");
// DOE Dialog
DOE(
    Response Surface Design,
    {
    Add Response(
        Match Target, "Stretch", 350, 550,
        1
    ),
    Change Factor Settings(
        1, 0.7, 1.7, "Silica"
    ),
    Change Factor Settings(
        2, 1.8, 2.8, "Sulfur"
    ),
    Add Factor(
        Continuous, 40, 60, "Silane", 0
    ), Set Random Seed( 12345 ),
    Make Design( 1 ), Center Points( 3 ),
    Make Table}
);


```

### [Generate a custom design experiment using the DOE platform with categorical factors for furnace temperature and coating, and maximize the response for corrosion resistance.](#generate-a-custom-design-experiment-using-the-doe-platform-with-categorical-factors-for-furnace-temperature-and-coating-and-maximize-the-response-for-corrosion-resistance)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Box Corrosion Split-Plot.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Corrosion Resistance",
        ., ., .
    ),
    Add Factor(
        Categorical,
        {"360", "370", "380"},
        "Furnace Temp",
        1
    ),
    Add Factor(
        Categorical,
        {"C1", "C2", "C3", "C4"},
        "Coating",
        0
    ), Set Random Seed( 15973514 ),
    Number of Starts( 3 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {1, 1}, {2, 1} ),
    Set Sample Size( 24 ),
    Set N Whole Plots( 6 ), Make Design}
);


```

### [Design a custom experimental design with response maximization and multiple continuous factors.](#design-a-custom-experimental-design-with-response-maximization-and-multiple-continuous-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Catalyst Design.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Add Factor(
        Continuous, -1, 1, "Temperature",
        2
    ),
    Add Factor(
        Continuous, -1, 1, "Time", 1
    ),
    Add Factor(
        Continuous, -1, 1, "Catalyst", 0
    ), Set Random Seed( 12345 ),
    Number of Starts( 1000 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Set N Whole Plots( 4 ),
    Set N Subplots( 8 ),
    Set Sample Size( 24 ),
    Simulate Responses, Make Design}
);


```

### [Create a custom design of experiments dialog for optimizing coffee brewing conditions, including categorical and continuous factors, responses, and alias terms.](#create-a-custom-design-of-experiments-dialog-for-optimizing-coffee-brewing-conditions-including-categorical-and-continuous-factors-responses-and-alias-terms)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Coffee Data.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Match Target, "Strength", 1.2,
        1.4, .
    ),
    Add Factor(
        Categorical,
        {"Coarse", "Medium"},
        "Grind",
        0
    ),
    Add Factor(
        Continuous, 195, 205,
        "Temperature", 0
    ),
    Add Factor(
        Continuous, 3, 4, "Time", 0
    ),
    Add Factor(
        Continuous, 1.6, 2.4, "Charge", 0
    ),
    Add Factor( Blocking, 4, "Station" ),
    Set Random Seed( 569534903 ),
    Number of Starts( 100 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {4, 1} ),
    Add Term( {5, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ),
    Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {1, 1}, {4, 1} ),
    Add Alias Term( {2, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {4, 1} ),
    Add Alias Term( {3, 1}, {4, 1} ),
    Set Sample Size( 12 ), Make Design}
);


```

### [Generate a custom response surface method (RSM) design using the DOE platform with specified factors, responses, and optimality criteria. The code opens a sample data table, configures the DOE dialog to include three continuous factors, sets the random seed and number of starts for optimization, specifies the model terms, and finalizes the design with a specified sample size and optimality criterion.](#generate-a-custom-response-surface-method-rsm-design-using-the-doe-platform-with-specified-factors-responses-and-optimality-criteria-the-code-opens-a-sample-data-table-configures-the-doe-dialog-to-include-three-continuous-factors-sets-the-random-seed-and-number-of-starts-for-optimization-specifies-the-model-terms-and-finalizes-the-design-with-a-specified-sample-size-and-optimality-criterion)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Custom RSM.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Match Target, "Y", 54, 56, .
    ),
    Add Factor(
        Continuous, -1, 1, "X1", 0
    ),
    Add Factor(
        Continuous, -1, 1, "X2", 0
    ),
    Add Factor(
        Continuous, -1, 1, "X3", 0
    ), Set Random Seed( 929281409 ),
    Number of Starts( 40 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {1, 2} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {2, 2} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Add Term( {3, 2} ),
    Set Sample Size( 16 ),
    Optimality Criterion( 2 ),
    Make Design}
);


```

### [Construct a full factorial design with categorical and continuous factors using the DOE platform](#construct-a-full-factorial-design-with-categorical-and-continuous-factors-using-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/DOE Example 1.jmp");
// DOE Dialog
DOE(
    Full Factorial Design,
    {
    Add Response(
        Match Target, "Depth", 0.12, 0.22,
        .
    ),
    Add Factor(
        Categorical,
        {"John", "Mary"},
        "Operator",
        0
    ),
    Add Factor(
        Continuous,
        {3, 5},
        "Speed",
        0
    ),
    Add Factor(
        Continuous,
        {150, 165},
        "Current",
        0
    ), Set Random Seed( 1344277810 ),
    Make Design}
);


```

### [Generate a Definitive Screening Design for optimizing yield based on continuous factors.](#generate-a-definitive-screening-design-for-optimizing-yield-based-on-continuous-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction Data.jmp");
// DOE Dialog
DOE(
    Definitive Screening Design,
    {
    Add Response(
        Maximize, "Yield", ., ., .
    ),
    Add Factor(
        Continuous, 0, 10, "Methanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Ethanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Propanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Butanol", 0
    ),
    Add Factor(
        Continuous, 6, 9, "pH", 0
    ),
    Add Factor(
        Continuous, 1, 2, "Time", 0
    ), Number of Extra Runs( 0 ),
    Set Random Seed( 123 ), Make Design}
);


```

### [Create a definitive screening design with multiple continuous factors and response optimization using the DOE (Design of Experiments) platform.](#create-a-definitive-screening-design-with-multiple-continuous-factors-and-response-optimization-using-the-doe-design-of-experiments-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction2 Data.jmp");
// DOE Dialog
DOE(
    Definitive Screening Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Add Factor(
        Continuous, 0, 10, "Methanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Ethanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Propanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Butanol", 0
    ),
    Add Factor(
        Continuous, 6, 9, "pH", 0
    ),
    Add Factor(
        Continuous, 1, 2, "Time", 0
    ), Number of Extra Runs( 0 ),
    Show Blocking Options( 1, 2 ),
    Make Design}
);


```

### [Create a definitive screening design with multiple continuous factors and an extra set of runs for the DOE platform.](#create-a-definitive-screening-design-with-multiple-continuous-factors-and-an-extra-set-of-runs-for-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction3 Data.jmp");
// DOE Dialog
DOE(
    Definitive Screening Design,
    {
    Add Response(
        Maximize, "Yield", ., ., .
    ),
    Add Factor(
        Continuous, 0, 10, "Methanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Ethanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Propanol", 0
    ),
    Add Factor(
        Continuous, 0, 10, "Butanol", 0
    ),
    Add Factor(
        Continuous, 6, 9, "pH", 0
    ),
    Add Factor(
        Continuous, 1, 2, "Time", 0
    ), Show Blocking Options( 1, 2 ),
    Number of Extra Runs( 4 ),
    Set Random Seed( 123 ), Make Design}
);


```

### [Create a custom design of experiments (DOE) with a generalized linear model response function.](#create-a-custom-design-of-experiments-doe-with-a-generalized-linear-model-response-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Metacrate Limit Of Detection DOE.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Metacrate", ., ., ., 1,
        99
    ),
    Add Factor(
        Continuous, 110, 150,
        "Dichloromethane", 0
    ),
    Add Factor(
        Continuous, 400, 600, "Methanol",
        0
    ),
    Add Factor(
        Continuous, 3, 7, "Sample Volume",
        0
    ), Set Random Seed( 981216 ),
    Number of Starts( 6776 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {1, 2} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {2, 2} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Add Term( {3, 2} ),
    Set Sample Size( 32 ),
    Optimality Criterion(
        "Make I-Optimal Design"
    ), Simulate Responses( 0 ),
    Save X Matrix( 0 ), Make Design}
);


```

### [Generate a Definitive Screening Design for optimizing the Solids response in a peanut processing experiment using continuous and categorical factors.](#generate-a-definitive-screening-design-for-optimizing-the-solids-response-in-a-peanut-processing-experiment-using-continuous-and-categorical-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Peanut Data.jmp");
// DOE Dialog
DOE(
    Definitive Screening Design,
    {
    Add Response(
        Maximize, "Solids", ., ., .
    ),
    Add Factor(
        Continuous, -1, 1, "pH", 0
    ),
    Add Factor(
        Continuous, -1, 1, "Water Temp",
        0
    ),
    Add Factor(
        Continuous, -1, 1,
        "Extraction TIme", 0
    ),
    Add Factor(
        Continuous, -1, 1, "Ratio", 0
    ),
    Add Factor(
        Continuous, -1, 1,
        "Agitation Speed", 0
    ),
    Add Factor(
        Categorical,
        {"L1", "L2"},
        "Hydrolyze",
        0
    ),
    Add Factor(
        Categorical,
        {"L1", "L2"},
        "Pre-Soak",
        0
    ), Show Blocking Options( 0, 0 ),
    Number of Extra Runs( 4 ),
    Set Random Seed( 12345 ), Make Design,
    Simulate Responses( 0 ),
    Save X Matrix( 0 )}
);


```

### [Construct a covering array using the DOE platform with specified categorical factors and constraints.](#construct-a-covering-array-using-the-doe-platform-with-specified-categorical-factors-and-constraints)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Phone Data.jmp");
// DOE Dialog
DOE(
    Covering Array,
    {
    Add Factor(
        Categorical,
        {"USA", "UK", "Canada", "France",
        "Mexico"},
        "Market",
        0
    ),
    Add Factor(
        Categorical,
        {"ISDN", "Bus", "Coin", "Res"},
        "Near Phone",
        0
    ),
    Add Factor(
        Categorical,
        {"A", "B"},
        "Near Interface",
        0
    ),
    Add Factor(
        Categorical,
        {"ISDN", "Bus", "Coin", "Res"},
        "Far Phone",
        0
    ),
    Add Factor(
        Categorical,
        {"A", "B"},
        "Far Interface",
        0
    ), Set Strength( 2 ),
    Disallowed Combinations(
        Near Phone == "ISDN" &
        Near Interface == "A" | Far Phone
         == "ISDN" & Far Interface == "A"
         | Near Phone == "Bus" &
        Near Interface == "B" |
        Near Phone == "Res" &
        Near Interface == "B"
    ), Set Random Seed( 632 )}
);


```

### [Generate a Mixture Design using the DOE Dialog with specified constraints and settings.](#generate-a-mixture-design-using-the-doe-dialog-with-specified-constraints-and-settings)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Piepel.jmp");
// DOE Dialog
DOE(
    Mixture Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Change Factor Settings(
        1, 0.1, 0.5, "X1"
    ),
    Change Factor Settings(
        2, 0.1, 0.7, "X2"
    ),
    Change Factor Settings(
        3, 0, 0.7, "X3"
    ), Set Random Seed( 205900700 ),
    Add Constraint(
        [-85 -90 -100 -90,
        85 90 100 95,
        -0.7 0 -1 -0.4]
    ),
    Mixture Design Type(
        Extreme Vertices, 2
    )}
);


```

### [Perform custom design of experiments with categorical and continuous factors, and add various terms and constraints to optimize the response Number Popped.](#perform-custom-design-of-experiments-with-categorical-and-continuous-factors-and-add-various-terms-and-constraints-to-optimize-the-response-number-popped)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Popcorn DOE Results.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        "Maximize", "Number Popped", ., .,
        .
    ),
    Add Response(
        "None", "Total Kernals", ., ., .
    ),
    Add Factor(
        Categorical,
        {"Top Secret", "Wilbur"},
        "Brand",
        0
    ),
    Add Factor(
        Continuous, 3, 5, "Time", 0
    ),
    Add Factor(
        Continuous, 5, 10, "Power", 0
    ), Set Random Seed( 151747005 ),
    Number of Starts( 40 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Add Term( {2, 2} ),
    Add Term( {3, 2} ),
    Set Sample Size( 16 ),
    Add Constraint( [1 1 13, -1 -1 -10] ),
    Make Design}
);


```

### [Create a screening design with Plackett-Burman DOE platform and incorporate multiple continuous factors and response settings.](#create-a-screening-design-with-plackett-burman-doe-platform-and-incorporate-multiple-continuous-factors-and-response-settings)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Plackett-Burman.jmp");
// DOE Dialog
DOE(
    Screening Design,
    {
    Add Response(
        Maximize, "Percent Reacted", 90,
        100, 1
    ),
    Add Factor(
        Continuous, 10, 15, "Feed Rate",
        0
    ),
    Add Factor(
        Continuous, 1, 2, "Catalyst", 0
    ),
    Add Factor(
        Continuous, 100, 120, "Stir Rate",
        0
    ),
    Add Factor(
        Continuous, 140, 180,
        "Temperature", 0
    ),
    Add Factor(
        Continuous, 3, 6, "Concentration",
        0
    ), Set Random Seed( 34567 ),
    Make Design( 3 )}
);


```

### [Create a custom design experiment using the DOE platform with multiple continuous factors and optimization of a response variable.](#create-a-custom-design-experiment-using-the-doe-platform-with-multiple-continuous-factors-and-optimization-of-a-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 20 Custom.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Percent Reacted", 90,
        99, 1
    ),
    Add Factor(
        Continuous, 10, 15, "Feed Rate",
        0
    ),
    Add Factor(
        Continuous, 1, 2, "Catalyst", 0
    ),
    Add Factor(
        Continuous, 100, 120, "Stir Rate",
        0
    ),
    Add Factor(
        Continuous, 140, 180,
        "Temperature", 0
    ),
    Add Factor(
        Continuous, 3, 6, "Concentration",
        0
    ), Set Random Seed( 2024677686 ),
    Number of Starts( 200 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {4, 1} ),
    Add Term( {5, 1} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {1, 1}, {4, 1} ),
    Add Term( {1, 1}, {5, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Add Term( {2, 1}, {4, 1} ),
    Add Term( {2, 1}, {5, 1} ),
    Add Term( {3, 1}, {4, 1} ),
    Add Term( {3, 1}, {5, 1} ),
    Add Term( {4, 1}, {5, 1} ),
    Set Sample Size( 20 ), Make Design}
);


```

### [Create a full factorial design of experiments for optimizing reactor conditions.](#create-a-full-factorial-design-of-experiments-for-optimizing-reactor-conditions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 32 Runs.jmp");
// DOE Dialog
DOE(
    Full Factorial Design,
    {
    Add Response(
        Maximize, "Percent Reacted", 90,
        100, 1
    ),
    Add Factor(
        Continuous,
        {10, 15},
        "Feed Rate",
        0
    ),
    Add Factor(
        Continuous,
        {1, 2},
        "Catalyst",
        0
    ),
    Add Factor(
        Continuous,
        {100, 120},
        "Stir Rate",
        0
    ),
    Add Factor(
        Continuous,
        {140, 180},
        "Temperature",
        0
    ),
    Add Factor(
        Continuous,
        {3, 6},
        "Concentration",
        0
    ), Set Random Seed( 12345 ),
    Make Design, Make Table}
);


```

### [Title: Create a Covering Array Design of Experiments (DOE) with Four Categorical Factors: Web Browser, Operating System, RAM, and Connection Speed.](#title-create-a-covering-array-design-of-experiments-doe-with-four-categorical-factors-web-browser-operating-system-ram-and-connection-speed)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Software Data.jmp");
// DOE Dialog
DOE(
    Covering Array,
    {
    Add Factor(
        Categorical,
        {"Safari", "IE", "Firefox",
        "Chrome", "Other"},
        "Web Browser",
        0
    ),
    Add Factor(
        Categorical,
        {"Macintosh", "Windows"},
        "Operating System",
        0
    ),
    Add Factor(
        Categorical,
        {"16 MB", "4 MB", "8 MB"},
        "RAM",
        0
    ),
    Add Factor(
        Categorical,
        {"0-1 Mbps", "1-5 Mbps",
        ">5 Mbps"},
        "Connection Speed",
        0
    ), Set Strength( 3 )}
);


```

### [Create a custom experimental design using the MIDI DOE platform, including mixture components and specified constraints.](#create-a-custom-experimental-design-using-the-midi-doe-platform-including-mixture-components-and-specified-constraints)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Formulation For Homogeneity DOE.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Add Factor(
        Mixture, 0.26, 0.8, "Solvent", 0
    ),
    Add Factor(
        Mixture, 0.18, 0.4, "Active", 0
    ),
    Add Factor(
        Mixture, 0.02, 0.56, "Water", 0
    ), Set Random Seed( 625641159 ),
    Number of Starts( 6371 ),
    Add Constraint(
        [-1 1.4 0 0, 0 0.1 -1 0]
    ), Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Add Term( {1, 1}, {2, 1}, {3, 1} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Set Sample Size( 16 ),
    Simulate Responses( 0 ),
    Save X Matrix( 0 ), Make Design}
);


```

### [Design an experiment using a custom mixture design with specified factors, responses, and constraints.](#design-an-experiment-using-a-custom-mixture-design-with-specified-factors-responses-and-constraints)

```

// Open data table
dt = Open("$Sample_Data/Potato Chip Responses.jmp");
// Basis for Design
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Add Factor(
        Continuous, -1, 1, "X1", 2
    ),
    Add Factor(
        Continuous, -1, 1, "X2", 1
    ),
    Add Factor(
        Categorical,
        {"L1", "L2", "L3", "L4", "L5",
        "L6", "L7", "L8", "L9", "L10"},
        "X3",
        0
    ), Set Random Seed( 117724710 ),
    Number of Starts( 253 ),
    Add Term( {1, 0} ),
    Add Term( {3, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ),
    Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {3, 1} ),
    Set N Whole Plots( 4 ),
    Set N Subplots( 16 ),
    Set Sample Size( 48 ), Make Design,
    Make Table}
);


```

### [Perform Response Surface Methodology (RSM) analysis for four responses using the Fit Model platform with specified effects, Standard Least Squares personality, and Profiler for scaled estimates and actual by predicted plots.](#perform-response-surface-methodology-rsm-analysis-for-four-responses-using-the-fit-model-platform-with-specified-effects-standard-least-squares-personality-and-profiler-for-scaled-estimates-and-actual-by-predicted-plots)

```

// Open data table
dt = Open("$Sample_Data/Tiretread.jmp");
// RSM for 4 Responses
Fit Model(
    Y(
        :ABRASION, :MODULUS, :ELONG,
        :HARDNESS
    ),
    Effects(
        :SILICA & RS, :SILANE & RS,
        :SULFUR & RS, :SILICA * :SILICA,
        :SILANE * :SILICA,
        :SILANE * :SILANE,
        :SULFUR * :SILICA,
        :SULFUR * :SILANE,
        :SULFUR * :SULFUR
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        Profiler(
            Confidence Intervals( 1 )
        ),
        :ABRASION <<
        {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )},
        :MODULUS <<
        {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )},
        :ELONG << {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )},
        :HARDNESS <<
        {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )}
    )
);


```

### [Generate a space filling design by loading factors from a table](#generate-a-space-filling-design-by-loading-factors-from-a-table)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Algorithm Factors.jmp");
// Load and Edit in Space Filling Design
DOE(
    Space Filling Design,
    Load Factors( Current Data Table() )
);


```

### [Generate a custom design by loading factors from a table](#generate-a-custom-design-by-loading-factors-from-a-table)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Algorithm Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Use evaluate design on a mixed model design](#use-evaluate-design-on-a-mixed-model-design)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Battery Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Whole Plots, :Subplots, :A1, :A2,
        :A3, :A4, :C1, :C2
    )
);


```

### [Perform a screening analysis with the OCV as the response variable and A1, A2, A3, A4, C1, and C2 as the factors.](#perform-a-screening-analysis-with-the-ocv-as-the-response-variable-and-a1-a2-a3-a4-c1-and-c2-as-the-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Battery Data.jmp");
// Screening
Screening(
    Y( :OCV ),
    X( :A1, :A2, :A3, :A4, :C1, :C2 )
);


```

### [Open and edit an existing data table in a space-filling design using the DOE function .](#open-and-edit-an-existing-data-table-in-a-space-filling-design-using-the-doe-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Borehole Factors.jmp");
// Load and Edit in Space Filling Design
DOE(
    Space Filling Design,
    Load Factors( Current Data Table() )
);


```

### [Open and edit the current data table in the Custom Design platform.](#open-and-edit-the-current-data-table-in-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Borehole Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Evaluate the design using the DOE platform, focusing on the factors Silica, Sulfur, and Silane.](#evaluate-the-design-using-the-doe-platform-focusing-on-the-factors-silica-sulfur-and-silane)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Bounce Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X( :Silica, :Sulfur, :Silane )
);


```

### [Load existing data from a Response Surface Design experiment and edit its factors.](#load-existing-data-from-a-response-surface-design-experiment-and-edit-its-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Bounce Factors.jmp");
// Load and Edit in Response Surface Design
DOE(
    Response Surface Design,
    Load Factors( Current Data Table() )
);


```

### [Load an existing data table and modify it in a custom design experiment.](#load-an-existing-data-table-and-modify-it-in-a-custom-design-experiment)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Bounce Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Load and Edit in Response Surface Design using DOE and Load Responses functions.](#load-and-edit-in-response-surface-design-using-doe-and-load-responses-functions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Bounce Response.jmp");
// Load and Edit in Response Surface Design
DOE(
    Response Surface Design,
    Load Responses(
        Current Data Table()
    )
);


```

### [Evaluate the design of a Box Corrosion Split-Plot experiment using the DOE platform, focusing on the factors: Whole Plots, Furnace Temp, and Coating.](#evaluate-the-design-of-a-box-corrosion-split-plot-experiment-using-the-doe-platform-focusing-on-the-factors-whole-plots-furnace-temp-and-coating)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Box Corrosion Split-Plot.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Whole Plots, :Furnace Temp,
        :Coating
    )
);


```

### [Evaluate the design of a cake experiment using the specified factors: Cocoa, Sugar, Flour, Butter, Milk, and Eggs.](#evaluate-the-design-of-a-cake-experiment-using-the-specified-factors-cocoa-sugar-flour-butter-milk-and-eggs)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Cake Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Cocoa, :Sugar, :Flour, :Butter,
        :Milk, :Eggs
    )
);


```

### [Apply linear constraints to regression analysis. Use the Fit Model function to create a linear regression model with constraints on the coefficients of the predictors.](#apply-linear-constraints-to-regression-analysis-use-the-fit-model-function-to-create-a-linear-regression-model-with-constraints-on-the-coefficients-of-the-predictors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Cake Data.jmp");
// Constraint
{1 * :Cocoa + 1 * :Sugar + 1 * :Flour <=
0.45, -1 * :Cocoa + -1 * :Sugar + -1 *
:Flour <= -0.45};


```

### [Perform MaxDiff analysis using a Firth bias-adjusted logistic regression model to analyze multiple-choice data with profile effects.](#perform-maxdiff-analysis-using-a-firth-bias-adjusted-logistic-regression-model-to-analyze-multiple-choice-data-with-profile-effects)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Candy Survey.jmp");
// MaxDiff
MaxDiff(
    One Table( 1 ),
    Response Subject ID( :Subject ),
    Profile ID( :Choice ),
    Profile Grouping(
        :Subject, :Choice Set
    ),
    Profile Effects( :Candy ),
    "Firth Bias-adjusted Estimates"n( 1 )
);


```

### [Generate a MaxDiff Design for a Candy Survey using the DOE Dialog function.](#generate-a-maxdiff-design-for-a-candy-survey-using-the-doe-dialog-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Candy Survey.jmp");
// DOE Dialog
DOE(
    MaxDiff Design,
    X( :Candy ),
    {Set Number of Profiles( 4 ),
    Set Number of Choice Sets( 7 ),
    Make Design, Simulate Responses( 0 )}
);


```

### [Evaluate the design of an experiment involving temperature, time, and catalyst in a DOE platform using Whole Plots and Subplots.](#evaluate-the-design-of-an-experiment-involving-temperature-time-and-catalyst-in-a-doe-platform-using-whole-plots-and-subplots)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Catalyst Design.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        Whole Plots, Subplots,
        :Temperature, :Time, :Catalyst
    )
);


```

### [Perform data loading and editing operations within the Custom Design platform.](#perform-data-loading-and-editing-operations-within-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Cheese Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Load and edit design factors in the Choice Design platform.](#load-and-edit-design-factors-in-the-choice-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Coffee Choice Factors.jmp");
// Load and Edit in Choice Design
DOE(
    Choice Design,
    Load Factors( Current Data Table() )
);


```

### [Load and edit an existing dataset in the Custom Design platform.](#load-and-edit-an-existing-dataset-in-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Coffee Choice Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Load data table Coffee Factors and open Custom Design window pre-populated with factors from the current data table.](#load-data-table-coffee-factors-and-open-custom-design-window-pre-populated-with-factors-from-the-current-data-table)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Coffee Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Evaluate the design of an experiment using the specified factors in DOE platform.](#evaluate-the-design-of-an-experiment-using-the-specified-factors-in-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Custom RSM.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X( :X1, :X2, :X3 )
);


```

### [Perform screening analysis on the response variable Y using predictors X1, X2, and X3 from a specific dataset.](#perform-screening-analysis-on-the-response-variable-y-using-predictors-x1-x2-and-x3-from-a-specific-dataset)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Custom RSM.jmp");
// Screening
Screening( Y( :Y ), X( :X1, :X2, :X3 ) );


```

### [Evaluate the design of an experiment using the DOE platform with the specified factors.](#evaluate-the-design-of-an-experiment-using-the-doe-platform-with-the-specified-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/DOE Example 1.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X( :Operator, :Speed, :Current )
);


```

### [Perform Two-Level Screening Analysis on Design Experiment Data Using the Fit Two Level Screening Function](#perform-two-level-screening-analysis-on-design-experiment-data-using-the-fit-two-level-screening-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/DOE Example 1.jmp");
// Screening
Fit Two Level Screening(
    Y( :Depth ),
    X( :Operator, :Speed, :Current )
);


```

### [Fit a Definitive Screening model to analyze the effects of six process variables on yield.](#fit-a-definitive-screening-model-to-analyze-the-effects-of-six-process-variables-on-yield)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction Data.jmp");
// Fit Definitive Screening
Fit Definitive Screening(
    X(
        :Methanol, :Ethanol, :Propanol,
        :Butanol, :pH, :Time
    ),
    Y( :Yield )
);


```

### [Evaluate the design of an experiment focusing on the response variables associated with Methanol, Ethanol, Propanol, Butanol, pH, and Time.](#evaluate-the-design-of-an-experiment-focusing-on-the-response-variables-associated-with-methanol-ethanol-propanol-butanol-ph-and-time)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Methanol, :Ethanol, :Propanol,
        :Butanol, :pH, :Time
    )
);


```

### [Load and edit data in the Definitive Screening Design platform using the current data table.](#load-and-edit-data-in-the-definitive-screening-design-platform-using-the-current-data-table)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction Factors.jmp");
// Load and Edit in Definitive Screening Design
DOE(
    Definitive Screening Design,
    Load Factors( Current Data Table() )
);


```

### [Load an existing data table from the sample data folder into the Custom Design platform for further experimentation and analysis using DOE and Load Factors functions.](#load-an-existing-data-table-from-the-sample-data-folder-into-the-custom-design-platform-for-further-experimentation-and-analysis-using-doe-and-load-factors-functions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Evaluate the experimental design by assessing the selected factors for optimization.](#evaluate-the-experimental-design-by-assessing-the-selected-factors-for-optimization)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction2 Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Lot, :Methanol, :Ethanol,
        :Propanol, :Butanol, :pH, :Time
    )
);


```

### [Evaluate the experimental design for the Extraction3 Data using the Design of Experiments (DOE) platform with the specified factors.](#evaluate-the-experimental-design-for-the-extraction3-data-using-the-design-of-experiments-doe-platform-with-the-specified-factors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction3 Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Lot, :Methanol, :Ethanol,
        :Propanol, :Butanol, :pH, :Time
    )
);


```

### [Load data from a specified file and open it in the Choice Design platform.](#load-data-from-a-specified-file-and-open-it-in-the-choice-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Laptop Factors.jmp");
// Load and Edit in Choice Design
DOE(
    Choice Design,
    Load Factors( Current Data Table() )
);


```

### [Evaluate the design of the experiment using the Dichloromethane, Methanol, and Sample Volume factors in the DOE platform.](#evaluate-the-design-of-the-experiment-using-the-dichloromethane-methanol-and-sample-volume-factors-in-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Metacrate Limit Of Detection DOE.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Dichloromethane, :Methanol,
        :Sample Volume
    )
);


```

### [Evaluate the design using the variables pH, Water Temp, Extraction Time, Ratio, Agitation Speed, Hydrolyze, and Pre-Soak.](#evaluate-the-design-using-the-variables-ph-water-temp-extraction-time-ratio-agitation-speed-hydrolyze-and-pre-soak)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Peanut Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :pH, :Water Temp,
        :Extraction TIme, :Ratio,
        :Agitation Speed, :Hydrolyze,
        :"Pre-Soak"n
    )
);


```

### [Load and edit a Definitive Screening Design from an existing data table.](#load-and-edit-a-definitive-screening-design-from-an-existing-data-table)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Peanut Factors.jmp");
// Load and Edit in Definitive Screening Design
DOE(
    Definitive Screening Design,
    Load Factors( Current Data Table() )
);


```

### [Load a data table and edit it using the Custom Design platform .](#load-a-data-table-and-edit-it-using-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Peanut Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Identify and filter out disallowed combinations in data table by specifying conditions on categorical variables . The script uses the Open and Data Filter functions to accomplish this task.](#identify-and-filter-out-disallowed-combinations-in-data-table-by-specifying-conditions-on-categorical-variables-the-script-uses-the-open-and-data-filter-functions-to-accomplish-this-task)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Phone Data.jmp");
// Disallowed Combinations
Near Phone == "ISDN" & Near Interface ==
"A" | Far Phone == "ISDN" & Far Interface
 == "A" | Near Phone == "Bus" &
Near Interface == "B" | Near Phone ==
"Res" & Near Interface == "B";


```

### [Load and edit experimental factors in a Covering Array design.](#load-and-edit-experimental-factors-in-a-covering-array-design)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Phone Factors.jmp");
// Load and Edit in Covering Array
DOE(
    Covering Array,
    Load Factors( Current Data Table() )
);


```

### [Load a factor experiment data table and edit it in the Custom Design platform.](#load-a-factor-experiment-data-table-and-edit-it-in-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Phone Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Apply linear constraints to a dataset.](#apply-linear-constraints-to-a-dataset)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Piepel.jmp");
// Constraint
{-85 * :X1 + -90 * :X2 + -100 * :X3 - (
-90), 85 * :X1 + 90 * :X2 + 100 * :X3
-95, -0.7 * :X1 + -1 * :X3 - (-0.4)};


```

### [Perform screening analysis using the Screening function to identify significant factors affecting the Percent Reacted.](#perform-screening-analysis-using-the-screening-function-to-identify-significant-factors-affecting-the-percent-reacted)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Plackett-Burman.jmp");
// Screening
Screening(
    Y( :Percent Reacted ),
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Evaluate Design: Assess experimental factors in a Plackett-Burman design using the DOE platform.](#evaluate-design-assess-experimental-factors-in-a-plackett-burman-design-using-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Plackett-Burman.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Load sample data from the Plastifactors dataset and apply the mixture design to the current data table using the DOE platform.](#load-sample-data-from-the-plastifactors-dataset-and-apply-the-mixture-design-to-the-current-data-table-using-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Plastifactors.jmp");
// Load and Edit in Mixture Design
DOE(
    Mixture Design,
    Load Factors( Current Data Table() )
);


```

### [Load an existing data table and edit it within the Custom Design platform .](#load-an-existing-data-table-and-edit-it-within-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Plastifactors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Perform a screening analysis for the response variables 'Number Popped' and 'Total Kernels' against the predictor variables 'Brand', 'Time', and 'Power'.](#perform-a-screening-analysis-for-the-response-variables-number-popped-and-total-kernels-against-the-predictor-variables-brand-time-and-power)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Popcorn DOE Results.jmp");
// Screening
Screening(
    Y( :Number Popped, :Total Kernels ),
    X( :Brand, :Time, :Power )
);


```

### [Apply constraints to the factors in a DOE analysis.](#apply-constraints-to-the-factors-in-a-doe-analysis)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Popcorn DOE Results.jmp");
// Constraint
{1 * :Time + 1 * :Power <= 13, 1 * :Time
 + 1 * :Power >= 10};


```

### [Perform a screening analysis with Percent Reacted as the response variable and Feed Rate, Catalyst, Stir Rate, Temperature, and Concentration as the explanatory variables.](#perform-a-screening-analysis-with-percent-reacted-as-the-response-variable-and-feed-rate-catalyst-stir-rate-temperature-and-concentration-as-the-explanatory-variables)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 20 Custom.jmp");
// Screening
Screening(
    Y( :Percent Reacted ),
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Perform a two-level screening analysis on a design experiment data table using the Fit Two Level Screening function.](#perform-a-two-level-screening-analysis-on-a-design-experiment-data-table-using-the-fit-two-level-screening-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 8 Runs.jmp");
// Screening
Fit Two Level Screening(
    Y( :Percent Reacted ),
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Evaluate the Design of a Reactor Experiment Using DOE Function](#evaluate-the-design-of-a-reactor-experiment-using-doe-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 32 Runs.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Perform two-level screening analysis on a reactor experiment dataset to identify significant factors affecting percent reacted](#perform-two-level-screening-analysis-on-a-reactor-experiment-dataset-to-identify-significant-factors-affecting-percent-reacted)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 32 Runs.jmp");
// Screening
Fit Two Level Screening(
    Y( :Percent Reacted ),
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Evaluate the statistical properties of a designed experiment using the Evaluate Design function in the DOE platform.](#evaluate-the-statistical-properties-of-a-designed-experiment-using-the-evaluate-design-function-in-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 8 Runs.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Evaluate the design of an experiment with multiple factors in DOE (Design of Experiments) platform.](#evaluate-the-design-of-an-experiment-with-multiple-factors-in-doe-design-of-experiments-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor Augment Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration
    )
);


```

### [Load and Edit a Screening Design using current data table.](#load-and-edit-a-screening-design-using-current-data-table)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor Factors.jmp");
// Load and Edit in Screening Design
DOE(
    Screening Design,
    Load Factors( Current Data Table() )
);


```

### [Open and edit the existing factors in a custom design from the specified data table.](#open-and-edit-the-existing-factors-in-a-custom-design-from-the-specified-data-table)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Load and edit data in a screening design using DOE and Load Responses functions.](#load-and-edit-data-in-a-screening-design-using-doe-and-load-responses-functions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor Response.jmp");
// Load and Edit in Screening Design
DOE(
    Screening Design,
    Load Responses(
        Current Data Table()
    )
);


```

### [Load and Edit Responses in a Custom Design Experiment](#load-and-edit-responses-in-a-custom-design-experiment)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor Response.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Responses(
        Current Data Table()
    )
);


```

### [Load factors from an existing data table and edit them in the Covering Array platform.](#load-factors-from-an-existing-data-table-and-edit-them-in-the-covering-array-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Software Factors.jmp");
// Load and Edit in Covering Array
DOE(
    Covering Array,
    Load Factors( Current Data Table() )
);


```

### [Load data from the Vinyl Factors file and edit it in the Custom Design platform.](#load-data-from-the-vinyl-factors-file-and-edit-it-in-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Vinyl Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Load and edit an existing response data table in the Custom Design platform.](#load-and-edit-an-existing-response-data-table-in-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Vinyl Responses.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Responses(
        Current Data Table()
    )
);


```

### [Load data table and Edit in Screening Design using Load Factors function.](#load-data-table-and-edit-in-screening-design-using-load-factors-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Weld Factors.jmp");
// Load and Edit in Screening Design
DOE(
    Screening Design,
    Load Factors( Current Data Table() )
);


```

### [Load data from the Weld Factors sample dataset and edit the design experiment using the Custom Design platform.](#load-data-from-the-weld-factors-sample-dataset-and-edit-the-design-experiment-using-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Weld Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Load factors from a specified data table and edit them in the Custom Design platform.](#load-factors-from-a-specified-data-table-and-edit-them-in-the-custom-design-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Wine Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Apply constraint to ensure positive levels of active ingredient and sufficient water relative to solvent in formulation.](#apply-constraint-to-ensure-positive-levels-of-active-ingredient-and-sufficient-water-relative-to-solvent-in-formulation)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Formulation For Homogeneity DOE.jmp");
// Constraint
{1 * :Solvent + -1.4 * :Active >= 0, -0.1
 * :Active + 1 * :Water >= 0};


```

### [Evaluate the experimental design with the variables Solvent, Active, and Water.](#evaluate-the-experimental-design-with-the-variables-solvent-active-and-water)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Formulation For Homogeneity DOE.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X( :Solvent, :Active, :Water )
);


```

### [Perform variable screening using the Screening platform on a dataset containing 18 predictors and one response variable.](#perform-variable-screening-using-the-screening-platform-on-a-dataset-containing-18-predictors-and-one-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Supersaturated.jmp");
// Screening
Screening(
    Y( :Y ),
    X(
        :X1, :X2, :X3, :X4, :X5, :X6, :X7,
        :X8, :X9, :X10, :X11, :X12, :X13,
        :X14, :X15, :X16, :X17, :X18
    )
);


```

# [Data Table](#data-table)

More examples for this topic using the sample data files provided with JMP

## [Concatenate](#concatenate)

### [Concatenate 2 tables](#concatenate-2-tables)

```

// Open data table
dt = Open("$Sample_Data/Cancer2.jmp");
// Concatenate
Open( "$SAMPLE_DATA/Cancer1.jmp" ) <<
Concatenate( Data Table( "Cancer2" ) );


```

```

// Open data table
dt = Open("$Sample_Data/Cancer1.jmp");
// Concatenate
Data Table( "Cancer1" ) <<
Concatenate(
    Open( "$SAMPLE_DATA/Cancer2.jmp" )
);


```

## [Value Labels](#value-labels)

### [Set value labels column property](#set-value-labels-column-property)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Set Age Value Labels
Column( "age" ) <<
ValueLabels(
    {12, 13, 14, 15, 16, 17},
    {"Twelve", "Thirteen", "Fourteen",
    "Fifteen", "Sixteen", "Seventeen"}
);
Column( "age" ) << UseValueLabels;


```

# [Data Tables](#data-tables)

More examples for this topic using the sample data files provided with JMP

### [Stack data in a data table](#stack-data-in-a-data-table)

```

// Open data table
dt = Open( "$Sample_Data/Antibiotic MICs.jmp" );
// Stack MICs
dt << Stack(
    Columns( :penicillin, :streptomycin, :neomycin ),
    Source Label Column( :Stack Source Label ),
    Stacked Data Column( :Stack Data Column ),
    Output Table( :Stack Output Table )
);


```

### [Perfrom distribution analysis with continuous and nominal data](#perfrom-distribution-analysis-with-continuous-and-nominal-data)

```

// Open data table
dt = Open("$Sample_Data/Birth Death.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :birth )
    ),
    Continuous Distribution(
        Column( :death )
    ),
    Nominal Distribution(
        Column( :Region )
    )
);


```

### [Open the manage limits utility](#open-the-manage-limits-utility)

```

// Open data table
dt = Open("$Sample_Data/Cheese Manufacturing Data.jmp");
// Manage Limits
Manage Limits(
    Process Variables(
        :pH, :Salt Concentration,
        :Moisture Content
    ),
    Grouping( :Cheese Type )
);


```

### [Genearate a tabulated report with grouping columns](#genearate-a-tabulated-report-with-grouping-columns)

```

// Open data table
dt = Open("$Sample_Data/Cola Heart Rate.jmp");
// Tabulate
Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Column Table(
            Analysis Columns( :Baseline ),
            Statistics( Mean )
        ),
        Row Table(
            Grouping Columns( :Testers )
        )
    )
);


```

### [Cluster variables using the K-means clustering algorithm with the specified numerical columns.](#cluster-variables-using-the-k-means-clustering-algorithm-with-the-specified-numerical-columns)

```

// Open data table
dt = Open("$Sample_Data/Diabetes.jmp");
// Cluster Variables
Cluster Variables(
    Y(
        :Age, :BMI, :BP,
        :Total Cholesterol, :LDL, :HDL,
        :TCH, :LTG, :Glucose
    )
);


```

### [Create multiple rows in the data table to simulate rolling a dice many times.](#create-multiple-rows-in-the-data-table-to-simulate-rolling-a-dice-many-times)

```

// Open data table
dt = Open("$Sample_Data/DiceRolls.jmp");
// Roll Many
Current Data Table() <<
Add Rows( :Num Rolls );


```

### [Create a tabulation with mean and standard deviation statistics for columns X and Y, grouped by Ship event and Lot.](#create-a-tabulation-with-mean-and-standard-deviation-statistics-for-columns-x-and-y-grouped-by-ship-event-and-lot)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Tabulate
Tabulate(
    Add Table(
        Column Table(
            Analysis Columns( :X, :Y ),
            Statistics( Mean, Std Dev )
        ),
        Row Table(
            Grouping Columns(
                :Ship event, :Lot
            )
        )
    )
);


```

### [Generate a tabular summary with double row groupings on surface quality and color.](#generate-a-tabular-summary-with-double-row-groupings-on-surface-quality-and-color)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Tabulate 2
Tabulate(
    Show Control Panel( 0 ),
    Add Table(
        Row Table(
            Grouping Columns(
                :surface quality
            )
        ),
        Row Table(
            Grouping Columns( :color )
        )
    )
);


```

### [Open Profile and Subjects Tables from Sample Data Directory.](#open-profile-and-subjects-tables-from-sample-data-directory)

```

// Open data table
dt = Open("$Sample_Data/Laptop Runs.jmp");
// Open Profile and Subjects Tables
Open( "$Sample_Data/Laptop Profile.jmp" );
Open(
    "$Sample_Data/Laptop Subjects.jmp"
);


```

### [Create a loss function template for the LogLogistic distribution. Define a new table with columns for Time, Censor, Model, and LogLogistic Loss. Implement the LogLogistic model formula with parameters b0 and b1. Define the LogLogistic Loss formula with parameter sigma and incorporate conditional logic based on the Censor variable using IfMZ function.](#create-a-loss-function-template-for-the-loglogistic-distribution-define-a-new-table-with-columns-for-time-censor-model-and-loglogistic-loss-implement-the-loglogistic-model-formula-with-parameters-b0-and-b1-define-the-loglogistic-loss-formula-with-parameter-sigma-and-incorporate-conditional-logic-based-on-the-censor-variable-using-ifmz-function)

```

// LogLogistic.jsl
///////////////////////////////////////////////////////////////////////////////////////////////////////////
// JSL to create a loss function template of LogLogistic                 //
///////////////////////////////////////////////////////////////////////////////////////////////////////////

dt= new table ("LogLogistic");
dt<<New Column("Time", Numeric,continuous);   
dt<<New Column("Censor", Numeric,continuous);
dt<<New Column("Model", Numeric,continuous);
dt<<New Column("LogLogistic Loss", Numeric,continuous);

column( "Model") << formula( Parameter({b0=-11.8912196204114, b1=9.03834026782309}, Log( :Time)-(b0+b1*Empty())) );

column( "LogLogistic Loss") << formula( Parameter({sigma=0.5}, -IfMZ( :censor==0,  :Model/sigma-2*Log(1+Exp( :Model/sigma))-Log(sigma), -Log(1+Exp( :Model/sigma))))  );


```

### [Transpose specific columns with a label in the current data table.](#transpose-specific-columns-with-a-label-in-the-current-data-table)

```

// Open data table
dt = Open("$Sample_Data/Materials2.jmp");
// Transpose with label
Current Data Table() <<
Transpose(
    Columns( :plastic, :tin, :gold ),
    Label( :item )
);


```

### [Generate and visualize the missing data pattern for a specified set of columns.](#generate-and-visualize-the-missing-data-pattern-for-a-specified-set-of-columns)

```

// Open data table
dt = Open("$Sample_Data/Missing Data Pattern.jmp");
// Missing Data Pattern
Current Data Table() <<
Missing Data Pattern(
    Columns(
        :Trial 1, :Trial 2, :Trial 3,
        :Trial 4
    )
);


```

### [Open a data table and open a web page displaying the Palmer Penguins dataset.](#open-a-data-table-and-open-a-web-page-displaying-the-palmer-penguins-dataset)

```

// Open data table
dt = Open("$Sample_Data/Penguins.jmp");
// Web page
Web(
    "https://allisonhorst.github.io/palmerpenguins/"
);


```

### [Join two data tables based on their unequal numbers of rows using the Join function.](#join-two-data-tables-based-on-their-unequal-numbers-of-rows-using-the-join-function)

```

// Open data table
dt = Open("$Sample_Data/Species2.jmp");
// Joining unequal rows
Open( "$SAMPLE_DATA/Species1.jmp" ) <<
Join(
    With( Data Table( "Species2" ) ),
    By Row Number
);


```

### [Open the data tables for Potato Chip Responses, Potato Chip Subjects, and Potato Chip Profiles using the Open function.](#open-the-data-tables-for-potato-chip-responses-potato-chip-subjects-and-potato-chip-profiles-using-the-open-function)

```

// Open data table
dt = Open("$Sample_Data/Potato Chip Responses.jmp");
// Open Profile and Subject Tables
Open(
    "$Sample_Data/Potato Chip Subjects.jmp"
);
Open(
    "$Sample_Data/Potato Chip Profiles.jmp"
);


```

### [Calculate and display contingency statistics for a 2x2 table using the Agreement Statistic.](#calculate-and-display-contingency-statistics-for-a-2x2-table-using-the-agreement-statistic)

```

// Open data table
dt = Open("$Sample_Data/Prime Minister Ratings.jmp");
// Contingency
Contingency(
    Y( 2 ),
    X( 1 ),
    Freq( 3 ),
    Agreement Statistic( 1 )
);


```

### [Create a categorical analysis for variables and generate a frequency chart in the Categorical platform.](#create-a-categorical-analysis-for-variables-and-generate-a-frequency-chart-in-the-categorical-platform)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failure3MultipleField.jmp");
// Categorical
Categorical(
    X( :clean, :date ),
    Multiple Response(
        :Failure1, :Failure2, :Failure3
    ),
    Frequency Chart( 0 )
);


```

### [Run Categorical Delimited analysis using the Categorical function with specified variables from the Failures3Delimited data table.](#run-categorical-delimited-analysis-using-the-categorical-function-with-specified-variables-from-the-failures3delimited-data-table)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failures3Delimited.jmp");
// Categorical Delimited
Categorical(
    ID( :ID ),
    X( :clean, :date ),
    Multiple Delimited( :failureS )
);


```

### [Filter the dataset to include only rows where the space type is exterior using the Data Filter platform.](#filter-the-dataset-to-include-only-rows-where-the-space-type-is-exterior-using-the-data-filter-platform)

```

// Open data table
dt = Open("$Sample_Data/S4 Temps.jmp");
// Data Filter - Exterior Offices
Current Data Table() <<
Data Filter(
    Location( {376, 286} ),
    Add Filter(
        columns( :type of space ),
        Where(
            :type of space == "exterior"
        ),
        Display(
            :type of space,
            Size( 204, 123 ),
            List Display
        )
    ),
    Mode( Select( 0 ), Include( 1 ) )
);


```

### [Perform a Cartesian join between two data tables using the Join() function.](#perform-a-cartesian-join-between-two-data-tables-using-the-join-function)

```

// Open data table
dt = Open("$Sample_Data/Species1.jmp");
// Cartesian join
Data Table( "Species1" ) <<
Join(
    With(
        Open(
            "$SAMPLE_DATA/Species2.jmp"
        )
    ),
    Cartesian Join
);


```

### [Create a variability chart using the Variability Chart function to analyze the Measurement response variable by Operator and part factors, automatically selecting the best analysis type based on EMS, REML, or Bayesian methods, including a standard deviation chart.](#create-a-variability-chart-using-the-variability-chart-function-to-analyze-the-measurement-response-variable-by-operator-and-part-factors-automatically-selecting-the-best-analysis-type-based-on-ems-reml-or-bayesian-methods-including-a-standard-deviation-chart)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/2 Factors Crossed.jmp");
// Variability Chart
Variability Chart(
    Y( :Measurement ),
    X( :Operator, :part# ),
    Analysis Type(
        "Choose best analysis (EMS REML Bayesian)"n
    ),
    Standard( :Standard ),
    Process Variation( 0 ),
    Std Dev Chart( 1 )
);


```

### [Perform EMP Measurement Systems Analysis using Nested Model, including Dispersion Chart, Variance Components, Average Chart, and Dispersion Chart.](#perform-emp-measurement-systems-analysis-using-nested-model-including-dispersion-chart-variance-components-average-chart-and-dispersion-chart)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/2 Factors Nested.jmp");
// EMP Measurement Systems Analysis
EMP Measurement Systems Analysis(
    Y( :" Y"n ),
    X( :Operator ),
    Part( :Part ),
    Model( Nested ),
    Dispersion Chart Type( "Range" ),
    Variance Components( 1 ),
    Average Chart( 1 ),
    Dispersion Chart( 1 )
);


```

### [Perform an EMP Measurement Systems Analysis using nested and crossed factors, generate a dispersion chart using the range method for variability data.](#perform-an-emp-measurement-systems-analysis-using-nested-and-crossed-factors-generate-a-dispersion-chart-using-the-range-method-for-variability-data)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/3 Factors Nested & Crossed.jmp");
// EMP Measurement Systems Analysis
EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator, :Instrument ),
    Part( :Part ),
    Model(
        "Nested then Crossed (3 Factors Only)"n
    ),
    Dispersion Chart Type( "Range" )
);


```

### [Set value labels for the sex column to Male and Female in the World Class data table.](#set-value-labels-for-the-sex-column-to-male-and-female-in-the-world-class-data-table)

```

// Open data table
dt = Open("$Sample_Data/World Class.jmp");
// Set Sex Value Labels
Column( "sex" ) <<
ValueLabels(
    {"M", "F"},
    {"Male", "Female"}
);
Column( "sex" ) << UseValueLabels;


```

### [Set Value Labels for Age Column with Function ValueLabels and UseValueLabels.](#set-value-labels-for-age-column-with-function-valuelabels-and-usevaluelabels)

```

// Open data table
dt = Open("$Sample_Data/World Class.jmp");
// Set Age Value Labels
Column( "age" ) <<
ValueLabels(
    {12, 13, 14, 15, 16, 17},
    {"Twelve", "Thirteen", "Fourteen",
    "Fifteen", "Sixteen", "Seventeen"}
);
Column( "age" ) << UseValueLabels;


```

### [Perform multivariate correlations analysis with mahalanobis distances](#perform-multivariate-correlations-analysis-with-mahalanobis-distances)

```

// Open data table
dt = Open("$Sample_Data/Body Fat.jmp");
// Multivariate Correlations
Multivariate(
    Y(
        :"Age (years)"n, :"Weight (lbs)"n,
        :"Height (inches)"n,
        :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n,
        :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n,
        :"Thigh circumference (cm)"n,
        :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n,
        :
        "Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n,
        :"Wrist circumference (cm)"n
    ),
    Estimation Method( "Row-wise" ),
    Scatterplot Matrix(
        Density Ellipses( 1 ),
        Shaded Ellipses( 0 ),
        Ellipse Color( 3 )
    ),
    Mahalanobis Distances( 1 )
);


```

### [Stack columns of a table and perform contingency analysis on the stacked data](#stack-columns-of-a-table-and-perform-contingency-analysis-on-the-stacked-data)

```

// Open data table
dt = Open("$Sample_Data/Children's Popularity.jmp");
// Stack Columns and Analyze
Data Table( "Children's Popularity.jmp" )
 << Stack(
    columns(
        :Grades, :Sports, :Looks, :Money
    ),
    Source Label Column(
        "Characteristic"
    ),
    Stacked Data Column( "Importance" ),
    Output Table( "Stacked Importance" )
);
Contingency(
    Y( :Characteristic ),
    X( :Importance ),
    Contingency Table(
        Count( 1 ),
        Total %( 0 ),
        Col %( 0 ),
        Row %( 0 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 ),
        Col Cum( 0 ),
        Col Cum %( 0 ),
        Row Cum( 0 ),
        Row Cum %( 0 )
    )
);


```

### [Generate a 3d surface plot](#generate-a-3d-surface-plot)

```

// Open data table
dt = Open("$Sample_Data/Cowboy Hat Template.jmp");
// Surface Plot
Surface Plot(
    Columns( :x, :y, :z ),
    Control Panel( 0 ),
    Lock Z Scale( 1 ),
    Hide Lights Border( 1 ),
    Shine Choice( "Off" ),
    Datapoints Choice( "Points" ),
    Datapoints Choice2( "Points" ),
    Datapoints Choice3( "Points" ),
    XRotate( -77.6289809380828 ),
    YRotate( -2.91022337856568 ),
    ZRotate( 30.2534324018626 ),
    Z Grid Position( 0.523583333333333 ),
    Formula( "x", "y", "z" ),
    Response( "z", "z", :z ),
    Equation( "", "", "", "" ),
    SetVariableAxis(
        z,
        Current Value( 0.283 ),
        Axis Data(
            {Scale( "Linear" ),
            Format( "Best" ), Min( -1 ),
            Max( 1 ), Inc( 0.25 )}
        )
    ),
    SetZAxis(
        z#4,
        Current Value(
            0.283000000000001
        )
    ),
    Graph Size( 334, 334 )
);


```

### [Analyze the distribution of height and weight using the Distribution platform .](#analyze-the-distribution-of-height-and-weight-using-the-distribution-platform)

```

// Open data table
dt = Open("$Sample_Data/Students.jmp");
// Distribution: Height and Weight
Distribution(
    Continuous Distribution(
        Column( :height ),
        Axis Settings(
            Min( 50 ),
            Max( 72.5 ),
            Scale( Linear ),
            Inc( 5 ),
            Minor Ticks( 1 )
        )
    ),
    Continuous Distribution(
        Column( :weight ),
        Axis Settings(
            Min( 50 ),
            Max( 200 ),
            Scale( Linear ),
            Inc( 10 )
        )
    )
);


```

### [Perform a Variability Chart analysis with a crossed model for the new Y variable, using Instrument, Operator, and Part as factors, with options to choose the best analysis using EMS, REML, and Bayesian methods.](#perform-a-variability-chart-analysis-with-a-crossed-model-for-the-new-y-variable-using-instrument-operator-and-part-as-factors-with-options-to-choose-the-best-analysis-using-ems-reml-and-bayesian-methods)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/3 Factors Crossed.jmp");
// Variability Chart of new Y
Variability Chart(
    Y( :new Y ),
    X( :Instrument, :Operator, :Part ),
    Model( "Crossed" ),
    Max Iter( 100 ),
    Conv Limit( 0.00000001 ),
    Number Integration Abscissas( 128 ),
    Number Function Evals( 65536 ),
    Analysis Type(
        "Choose best analysis (EMS REML Bayesian)"
    ),
    Connect Cell Means( 1 ),
    Show Group Means( 1 ),
    Std Dev Chart( 1 ),
    SendToReport(
        Dispatch(
            {
            "Variability Chart for new Y"
            }, "Variability Chart",
            FrameBox,
            {Grid Line Order( 6 ),
            Reference Line Order( 7 )}
        )
    )
);


```

# [Dataset Analysis](#dataset-analysis)

More examples for this topic using the sample data files provided with JMP

### [Perform a Cartesian join between the Oil Amount and Batch data tables.](#perform-a-cartesian-join-between-the-oil-amount-and-batch-data-tables)

```

// Open data table
dt = Open("$Sample_Data/Oil Amount.jmp");
// Join
Data Table( "Oil Amount" ) <<
Join(
    With(
        Open( "$SAMPLE_DATA/Batch.jmp" )
    ),
    Cartesian Join
);


```

# [Design of Experiments](#design-of-experiments)

More examples for this topic using the sample data files provided with JMP

### [Evaluate the design of a study using the DOE platform with variables X1, X2, and X3.](#evaluate-the-design-of-a-study-using-the-doe-platform-with-variables-x1-x2-and-x3)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Simple Linear Functional Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X( :X1, :X2, :X3 )
);


```

### [Create a custom experimental design using the DOE platform with a specified set of factors and terms to maximize the response variable Y.](#create-a-custom-experimental-design-using-the-doe-platform-with-a-specified-set-of-factors-and-terms-to-maximize-the-response-variable-y)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Simple Linear Functional Data.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Add Factor(
        Continuous, -1, 1, "X1", 0
    ),
    Add Factor(
        Continuous, -1, 1, "X2", 0
    ),
    Add Factor(
        Continuous, -1, 1, "X3", 0
    ), Set Random Seed( 78379455 ),
    Number of Starts( 1 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Set Sample Size( 24 ),
    Simulate Responses( 0 ),
    Save X Matrix( 0 ), Make Design}
);


```

### [Generate a custom DOE using the Custom Design function to minimize the Odor response with continuous factors temp, gl ratio, and ht, and include specific polynomial terms and interaction terms.](#generate-a-custom-doe-using-the-custom-design-function-to-minimize-the-odor-response-with-continuous-factors-temp-gl-ratio-and-ht-and-include-specific-polynomial-terms-and-interaction-terms)

```

// Open data table
dt = Open("$Sample_Data/Odor JSS.jmp");
// DOE Dialog
DOE(
    Custom Design,
    {
    Add Response(
        Minimize, "Odor", ., ., .
    ),
    Add Factor(
        Continuous, -1, 1, "temp", 0
    ),
    Add Factor(
        Continuous, -1, 1, "gl ratio", 0
    ),
    Add Factor(
        Continuous, -1, 1, "ht", 0
    ), Set Random Seed( 904322795 ),
    Number of Starts( 21 ),
    Add Term( {1, 0} ),
    Add Term( {1, 1} ),
    Add Term( {2, 1} ),
    Add Term( {3, 1} ),
    Add Term( {1, 2} ),
    Add Term( {1, 1}, {2, 1} ),
    Add Term( {2, 2} ),
    Add Term( {1, 1}, {3, 1} ),
    Add Term( {2, 1}, {3, 1} ),
    Add Term( {3, 2} ),
    Set Sample Size( 16 ),
    Optimality Criterion( 2 ),
    Make Design, Make Table}
);


```

### [Construct a custom experimental design using the DOE platform with specified factors, responses, and aliasing terms.](#construct-a-custom-experimental-design-using-the-doe-platform-with-specified-factors-responses-and-aliasing-terms)

```

// Open data table
dt = Open("$Sample_Data/Potato Chip Combined.jmp");
// Basis for Design
DOE(
    Custom Design,
    {
    Add Response(
        Maximize, "Y", ., ., .
    ),
    Add Factor(
        Continuous, -1, 1, "X1", 2
    ),
    Add Factor(
        Continuous, -1, 1, "X2", 1
    ),
    Add Factor(
        Categorical,
        {"L1", "L2", "L3", "L4", "L5",
        "L6", "L7", "L8", "L9", "L10"},
        "X3",
        0
    ), Set Random Seed( 117724710 ),
    Number of Starts( 253 ),
    Add Term( {1, 0} ),
    Add Term( {3, 1} ),
    Add Alias Term( {1, 1}, {2, 1} ),
    Add Alias Term( {1, 1}, {3, 1} ),
    Add Alias Term( {2, 1}, {3, 1} ),
    Set N Whole Plots( 4 ),
    Set N Subplots( 16 ),
    Set Sample Size( 48 ), Make Design,
    Make Table}
);


```

# [Dimensionality Reduction](#dimensionality-reduction)

More examples for this topic using the sample data files provided with JMP

### [Perform principal components: analysis for variable reduction](#perform-principal-components-analysis-for-variable-reduction)

```

// Open data table
dt = Open("$Sample_Data/Body Fat.jmp");
// Principal Components: Variable Reduction
Principal Components(
    Y(
        :"Age (years)"n, :"Weight (lbs)"n,
        :"Height (inches)"n,
        :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n,
        :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n,
        :"Thigh circumference (cm)"n,
        :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n,
        :
        "Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n,
        :"Wrist circumference (cm)"n
    ),
    Estimation Method( "Row-wise" ),
    on Correlations,
    Cluster Variables,
    SendToReport(
        Dispatch( {"Summary Plots"},
            "PCA Summary Plots", FrameBox,
            {Frame Size( 51, 37 )}
        ),
        Dispatch( {"Summary Plots"},
            "PCA Summary Plots",
            FrameBox( 2 ),
            {Frame Size( 55, 37 )}
        )
    )
);


```

### [Create a loading plot using the Principal Components analysis with specified correlations and eigenvalues on the dataset.](#create-a-loading-plot-using-the-principal-components-analysis-with-specified-correlations-and-eigenvalues-on-the-dataset)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Steam Turbine Historical.jmp");
// Loading plot
Principal Components(
    Y(
        :Fuel, :Steam Flow, :Steam Temp,
        :MW, :Cool Temp, :Pressure
    ),
    Estimation Method( "Default" ),
    "on Correlations",
    Eigenvalues( 1 ),
    Summary Plots( 0 ),
    Loading Plot( 4 )
);


```

# [Distribution Analysis](#distribution-analysis)

More examples for this topic using the sample data files provided with JMP

### [Perform a contingency analysis](#perform-a-contingency-analysis)

```

// Open data table
dt = Open("$Sample_Data/Alcohol.jmp");
// Contingency
Contingency(
    Y( :Relapsed ),
    X( :Alcohol Consumption ),
    Freq( :Count ),
    Contingency Table(
        Count( 1 ),
        Total %( 1 ),
        Col %( 1 ),
        Row %( 1 ),
        Expected( 0 ),
        Deviation( 0 ),
        Cell Chi Square( 0 )
    )
);


```

### [Generate distributions of nominal variables](#generate-distributions-of-nominal-variables)

```

// Open data table
dt = Open("$Sample_Data/AdverseR.jmp");
// Distribution
Distribution(
    Nominal Distribution(
        Column( :TREATMENT GROUP ),
        Mosaic Plot( 1 ),
        Histogram( 1 )
    ),
    Nominal Distribution(
        Column( :ADVERSE REACTION ),
        Mosaic Plot( 1 ),
        Histogram( 1 )
    ),
    Nominal Distribution(
        Column( :ADR SEVERITY ),
        Mosaic Plot( 1 ),
        Histogram( 1 )
    )
);


```

### [Build a repeated measures model](#build-a-repeated-measures-model)

```

// Open data table
dt = Open("$Sample_Data/Animals.jmp");
// Repeated Measures Model
Fit Model(
    Y( :miles ),
    Effects(
        :species,
        :subject[:species] & Random,
        :season, :species * :season
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run
);


```

### [Generate an attribute chart](#generate-an-attribute-chart)

```

// Open data table
dt = Open("$Sample_Data/Attribute Gauge.jmp");
// Attribute Chart
Attribute Chart(
    Y( :A, :B, :C ),
    X( :Part ),
    Standard( :Standard ),
    Effectiveness Report( 1 )
);


```

### [Perform distribution analysis](#perform-distribution-analysis)

```

// Open data table
dt = Open("$Sample_Data/BabySleep.jmp");
// side by side
Distribution(
    y( Awake, Asleep ),
    quantiles( 0 )
);


```

### [Perform a t-test on matched pairs data](#perform-a-t-test-on-matched-pairs-data)

```

// Open data table
dt = Open("$Sample_Data/BabySleep.jmp");
// paired t-test
(
Matched Pairs(
    y( Awake, Asleep ),
    Reference Frame( 1 )
) << report)[AxisBox( 1 )] << Revert Axis;


```

### [Perform a paired t-test using the bivariate platform](#perform-a-paired-t-test-using-the-bivariate-platform)

```

// Open data table
dt = Open("$Sample_Data/BabySleep.jmp");
// bivariate
Bivariate(
    x( Awake ),
    Y( Asleep ),
    Paired T Test
);


```

### [Build a partial least squares model using nipals method](#build-a-partial-least-squares-model-using-nipals-method)

```

// Open data table
dt = Open("$Sample_Data/Baltic.jmp");
// Partial Least Squares
Partial Least Squares(
    Y( :ls, :ha, :dt ),
    X(
        :v1, :v2, :v3, :v4, :v5, :v6, :v7,
        :v8, :v9, :v10, :v11, :v12, :v13,
        :v14, :v15, :v16, :v17, :v18,
        :v19, :v20, :v21, :v22, :v23,
        :v24, :v25, :v26, :v27
    ),
    Fit(
        Method( NIPALS ),
        Initial Number of Factors( 15 )
    )
);


```

### [Set modeling type column property](#set-modeling-type-column-property)

```

// Open data table
dt = Open("$Sample_Data/Big Class Families.jmp");
// Set Categorical
:sibling ages <<
Set Modeling Type( "Ordinal" );
:sports << Set Modeling Type( "Nominal" );
:countries visited <<
Set Modeling Type( "Nominal" );
:family cars <<
Set Modeling Type( "Nominal" );


```

### [Perform distribution analysis on columns with multiple response data](#perform-distribution-analysis-on-columns-with-multiple-response-data)

```

// Open data table
dt = Open("$Sample_Data/Big Class Families.jmp");
// Distribution
Distribution(
    Y(
        :sibling ages, :sports,
        :countries visited, :family cars
    )
);


```

### [Generate distribution analysis with a continuous and nominal data columns](#generate-distribution-analysis-with-a-continuous-and-nominal-data-columns)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :weight )
    ),
    Nominal Distribution(
        Column( :age )
    )
);


```

### [Perform oneway analysis with means and mean diamonds](#perform-oneway-analysis-with-means-and-mean-diamonds)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Oneway
Oneway(
    Y( :height ),
    X( :sex ),
    Means( 1 ),
    Mean Diamonds( 1 )
);


```

### [Generate distribution analysis](#generate-distribution-analysis)

```

// Open data table
dt = Open("$Sample_Data/Blood Pressure by Time.jmp");
// side by side
Distribution(
    y( BP AM, BP PM ),
    quantiles( 0 )
);


```

### [Example jsl to add new rows to a table](#example-jsl-to-add-new-rows-to-a-table)

```

// Open data table
dt = Open("$Sample_Data/Cherts.jmp");
// Add New Rows
Current Data Table() <<
Add Rows(
    {:location name = "Lanesboro", :Al =
    3866, :Mn = 15.56, :Na = 262.95, :Br
     = 0.88, :Ce = 0.45, :Co = 0.31, :Cr
     = 10.57, :Cs = 0.26, :Eu = 0.04, :Fe
     = 433.86, :Hf = 0.15, :La = 0.28,
    :Sc = 0.12, :sm = 0.03, :U = 0.75},
    {:location name = "Stockton", :al =
    2789.16, :Mn = 6.6, :Na = 208.6, :Br
     = 0.45, :Ce = 0.4, :Co = 0.28, :Cr
     = 11.76, :Cs = 0.25, :Eu = 0.04, :Fe
     = 342.8, :Hf = 0.08, :La = 0.12, :Sc
     = 0.05, :Sm = 0.02, :U = 0.63}
);


```

### [Example variable clustering](#example-variable-clustering)

```

// Open data table
dt = Open("$Sample_Data/Cherts.jmp");
// Cluster Variables
Cluster Variables(
    Y(
        :Al, :Mn, :Na, :Br, :Ce, :Co, :Cr,
        :Cs, :Eu, :Fe, :Hf, :La, :Sc, :Sm,
        :U
    ),
    SendToReport(
        Dispatch( {},
            "Standardized Components",
            OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Generate distribution analysis](#generate-distribution-analysis_1)

```

// Open data table
dt = Open("$Sample_Data/Coffee Shop Purchases.jmp");
// Distribution
Distribution(
    Nominal Distribution(
        Column( :Customer )
    ),
    Nominal Distribution(
        Column( :Beverage )
    )
);


```

### [Generate distribution analysis with fitted normal distribution](#generate-distribution-analysis-with-fitted-normal-distribution)

```

// Open data table
dt = Open("$Sample_Data/Cola Heart Rate.jmp");
// Distribution 2
Distribution(
    Stack( 1 ),
    Continuous Distribution(
        Column( :Heart Rate ),
        Horizontal Layout( 1 ),
        Vertical( 0 ),
        Fit Distribution( Normal ),
        Fit Distribution( Smooth Curve )
    ),
    By( :"Time (Raw)"n )
);


```

### [Perform categorical analysis with crosstab transposed and test for response homogeneity](#perform-categorical-analysis-with-crosstab-transposed-and-test-for-response-homogeneity)

```

// Open data table
dt = Open("$Sample_Data/Consumer Preferences.jmp");
// Career by Age Group
Categorical(
    X( :Age Group ),
    Responses(
        :I am working on my career
    ),
    Crosstab Transposed( 1 ),
    Legend( 0 ),
    Test Response Homogeneity( 1 )
);


```

### [Perform categorical analysis with crosstab transposed and test for response homogeneity](#perform-categorical-analysis-with-crosstab-transposed-and-test-for-response-homogeneity_1)

```

// Open data table
dt = Open("$Sample_Data/Consumer Preferences.jmp");
// Home Needs Improve by School Children
Categorical(
    X( :School Age Children ),
    Responses(
        :
        My home needs some major improvements
    ),
    Crosstab Transposed( 1 ),
    Legend( 0 ),
    Test Response Homogeneity( 1 )
);


```

### [Generate a gaussian process model](#generate-a-gaussian-process-model)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Algorithm Data.jmp");
// Model
Gaussian Process(
    Y( :CPU Time ),
    X(
        :Alpha, :Beta, :Gamma, :Algorithm,
        :Compiler
    ),
    Set Correlation Function(
        "Gaussian"
    ),
    Fast GASP( 1 ),
    Block Size( 50 )
);


```

### [Build a predictive model to analyze the impact of ingredient combinations on cake taste using the Fit Model platform.](#build-a-predictive-model-to-analyze-the-impact-of-ingredient-combinations-on-cake-taste-using-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Cake Data.jmp");
// Model
Fit Model(
    Effects(
        :Cocoa & RS & Mixture,
        :Sugar & RS & Mixture,
        :Flour & RS & Mixture,
        :Butter & RS & Mixture,
        :Milk & RS & Mixture
    ),
    Y( :Taste ),
    No Intercept( 1 )
);


```

### [Conduct a screening analysis on a design experiment dataset to evaluate the influence of multiple predictor variables on a response variable.](#conduct-a-screening-analysis-on-a-design-experiment-dataset-to-evaluate-the-influence-of-multiple-predictor-variables-on-a-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Piepel.jmp");
// Screening
Screening( Y( :Y ), X( :X1, :X2, :X3 ) );


```

### [Fit a linear regression model with multiple factors and categorical effects using the Fit Model platform.](#fit-a-linear-regression-model-with-multiple-factors-and-categorical-effects-using-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Wine Data.jmp");
// Model
Fit Model(
    Effects(
        :Rater, :Variety, :Field,
        :"De-Stem"n, :Yeast, :Temperature,
        :Press, :Barrel Age,
        :Barrel Seasoning, :Filtering
    ),
    Y( :Rating )
);


```

### [Fit an ordinal logistic regression model to predict an ordinal response variable using multiple predictor effects in the Fit Model platform.](#fit-an-ordinal-logistic-regression-model-to-predict-an-ordinal-response-variable-using-multiple-predictor-effects-in-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Diabetes.jmp");
// Logistic for Y Ordinal
Fit Model(
    Y( :Y Ordinal ),
    Effects(
        :Age, :Gender, :BMI, :BP,
        :Total Cholesterol, :LDL, :HDL,
        :TCH, :LTG, :Glucose
    ),
    Personality( "Ordinal Logistic" ),
    Run( Likelihood Ratio Tests( 1 ) )
);


```

### [Create a control chart with individual measurement, no center line, and no control limits.](#create-a-control-chart-with-individual-measurement-no-center-line-and-no-control-limits)

```

// Open data table
dt = Open("$Sample_Data/DiceRolls.jmp");
// Plot Results
Control Chart(
    KSigma( 3 ),
    Range Span( 1 ),
    Chart Col(
        :Average,
        Individual Measurement(
            Show Center Line( 0 ),
            Show Control Limits( 0 )
        )
    )
);


```

### [Analyze the distribution of Quack's Weight Change and Quick's Weight Change columns in the Diet.jmp data table, performing a test of mean for each column.](#analyze-the-distribution-of-quacks-weight-change-and-quicks-weight-change-columns-in-the-dietjmp-data-table-performing-a-test-of-mean-for-each-column)

```

// Open data table
dt = Open("$Sample_Data/Diet.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :Quack's Weight Change ),
        Test Mean( 0 )
    ),
    Continuous Distribution(
        Column( :Quick's Weight Change ),
        Test Mean( 0 )
    )
);


```

### [Analyze the distribution of continuous data in the Drug Toxicity dataset using the Distribution platform.](#analyze-the-distribution-of-continuous-data-in-the-drug-toxicity-dataset-using-the-distribution-platform)

```

// Open data table
dt = Open("$Sample_Data/Drug Toxicity.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :Toxicity )
    )
);


```

### [Analyze the distribution of categorical variables using the Distribution platform.](#analyze-the-distribution-of-categorical-variables-using-the-distribution-platform)

```

// Open data table
dt = Open("$Sample_Data/Employee Taste.jmp");
// Distribution
Distribution(
    Nominal Distribution( Column( :TV ) ),
    Nominal Distribution(
        Column( :Film )
    ),
    Nominal Distribution(
        Column( :Art )
    ),
    Nominal Distribution(
        Column( :Restaurant )
    )
);


```

### [Perform a Cartesian join between two data tables using the 'Join' function.](#perform-a-cartesian-join-between-two-data-tables-using-the-join-function)

```

// Open data table
dt = Open("$Sample_Data/Species2.jmp");
// Cartesian join
Open( "$SAMPLE_DATA/Species1.jmp" ) <<
Join(
    With( Data Table( "Species2" ) ),
    Cartesian Join
);


```

### [Fit a linear regression model to analyze the effect of various ingredients and conditions on the strength of bread dough.](#fit-a-linear-regression-model-to-analyze-the-effect-of-various-ingredients-and-conditions-on-the-strength-of-bread-dough)

```

// Open data table
dt = Open("$Sample_Data/Flrpaste.jmp");
// Model
Fit Model(
    Effects(
        :Liquid, :Sugar, :Flour, :Sifted,
        :Type, :Temp, :Salt, :Clamp,
        :Coat
    ),
    Y( :Strength )
);


```

### [Fit a multiple regression model with interactions between predictors using the Fit Model platform.](#fit-a-multiple-regression-model-with-interactions-between-predictors-using-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Simple Linear Functional Data.jmp");
// Model
Fit Model(
    Effects(
        :X1, :X2, :X3, :X1 * :X2,
        :X1 * :X3, :X2 * :X3
    ),
    Y( :Y )
);


```

### [Perform multivariate analysis of variance (MANOVA) using the Fit Model platform with Distance and Durability as response variables and Brand as a fixed effect.](#perform-multivariate-analysis-of-variance-manova-using-the-fit-model-platform-with-distance-and-durability-as-response-variables-and-brand-as-a-fixed-effect)

```

// Open data table
dt = Open("$Sample_Data/Golf Balls.jmp");
// MANOVA
Fit Model(
    Y( :Distance, :Durability ),
    Effects( :Brand ),
    Personality( "Manova" ),
    Run
);


```

### [Perform association analysis of products using the Association Analysis platform.](#perform-association-analysis-of-products-using-the-association-analysis-platform)

```

// Open data table
dt = Open("$Sample_Data/Grocery Purchases.jmp");
// Association Analysis of Product
Association Analysis(
    Item( :Product ),
    ID( :Customer ID )
);


```

### [Create a bivariate analysis with a fit line, quadratic fit, cubic fit, and cubic spline in the Bivariate platform.](#create-a-bivariate-analysis-with-a-fit-line-quadratic-fit-cubic-fit-and-cubic-spline-in-the-bivariate-platform)

```

// Open data table
dt = Open("$Sample_Data/Growth.jmp");
// Bivariate
Bivariate(
    Y( :ratio ),
    X( :age ),
    Fit Line,
    Fit Polynomial( 2 ),
    Fit Polynomial( 3 ),
    Fit Spline( 1000 )
);


```

### [Create a variability chart with nested model analysis using EMS, REML, and Bayesian methods, incorporating standard deviation and gauge RR reports.](#create-a-variability-chart-with-nested-model-analysis-using-ems-reml-and-bayesian-methods-incorporating-standard-deviation-and-gauge-rr-reports)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Variability Chart
Variability Chart(
    Y( :X ),
    X( :Ship event, :Lot ),
    Model( "Nested" ),
    Max Iter( 100 ),
    Conv Limit( 0.00000001 ),
    Number Integration Abscissas( 128 ),
    Number Function Evals( 65536 ),
    Analysis Type(
        "Choose best analysis (EMS REML Bayesian)"n
    ),
    Std Dev Chart( 1 ),
    Gauge RR Report( 1 )
);


```

### [Generate a Pareto Plot to identify the primary causes of surface quality issues from the Hardware Surface Unit Data.](#generate-a-pareto-plot-to-identify-the-primary-causes-of-surface-quality-issues-from-the-hardware-surface-unit-data)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Pareto Plot
Pareto Plot( Cause( :surface quality ) );


```

### [Generate a Shewhart Poisson control chart for a binary surface quality variable using the Control Chart Builder platform.](#generate-a-shewhart-poisson-control-chart-for-a-binary-surface-quality-variable-using-the-control-chart-builder-platform)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Control Chart Builder 3
Control Chart Builder(
    Size( 524, 450 ),
    Show Control Panel( 0 ),
    Show Capability( 0 ),
    Class( Shewhart Attribute ),
    Variables( Y( :surface quality ) ),
    Chart(
        Points( Statistic( "Count" ) ),
        Limits( Sigma( "Poisson" ) )
    )
);


```

### [Perform univariate distribution analysis on nominal and continuous variables.](#perform-univariate-distribution-analysis-on-nominal-and-continuous-variables)

```

// Open data table
dt = Open("$Sample_Data/Htwt12.jmp");
// Distribution
Distribution(
    Nominal Distribution(
        Column( :Gender )
    ),
    Continuous Distribution(
        Column( :Height )
    )
);


```

### [Perform a one-way analysis of a dataset with Height as the dependent variable and Gender as the independent variable, including mean calculations and mean diamond plots.](#perform-a-one-way-analysis-of-a-dataset-with-height-as-the-dependent-variable-and-gender-as-the-independent-variable-including-mean-calculations-and-mean-diamond-plots)

```

// Open data table
dt = Open("$Sample_Data/Htwt15.jmp");
// Oneway
Oneway(
    Y( :Height ),
    X( :Gender ),
    Means( 1 ),
    Box Plots( 0 ),
    Mean Diamonds( 1 )
);


```

### [Fit Johnson Su distribution to continuous data.](#fit-johnson-su-distribution-to-continuous-data)

```

// Open data table
dt = Open("$Sample_Data/JohnsonSuExample.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :x ),
        Fit Distribution( Johnson Su )
    )
);


```

### [Create a loss function template using the Extreme Value distribution with parameters λ and δ .](#create-a-loss-function-template-using-the-extreme-value-distribution-with-parameters-and)

```

// Extreme Value.jsl
///////////////////////////////////////////////////////////////////////////////////////////////////////////
// JSL to create a loss function template of Extreme value            //
///////////////////////////////////////////////////////////////////////////////////////////////////////////

dt= new table ("Extreme value");
dt<<New Column("Time", Numeric,continuous);   
dt<<New Column("Censor", Numeric,continuous);
dt<<New Column("Extreme value", Numeric,continuous);
col=column( "Extreme value");
col<<formula(  Parameter({lambda=3.26944897591195, delta=0.94478144505066}, -IfMZ( :Censor==0, ((-Log(delta))-Exp((Log( :Time/100)-lambda)/delta))+(Log( :Time)/100-lambda)/delta, -Exp((Log( :Time/100)-lambda)/delta))) );


```

### [Fit a nominal logistic regression model to analyze the effect of smoking on lung cancer.](#fit-a-nominal-logistic-regression-model-to-analyze-the-effect-of-smoking-on-lung-cancer)

```

// Open data table
dt = Open("$Sample_Data/Lung Cancer Choice.jmp");
// Model
Fit Model(
    Freq( :Count ),
    Y( :Lung Cancer ),
    Effects( :Smoker ),
    Personality( "Nominal Logistic" )
);


```

### [Calculate distribution statistics for nominal variables with frequencies.](#calculate-distribution-statistics-for-nominal-variables-with-frequencies)

```

// Open data table
dt = Open("$Sample_Data/Mb-dist.jmp");
// Distribution
Distribution(
    Freq( :Count ),
    Nominal Distribution(
        Column( :TYPE )
    )
);


```

### [Open the main data table and simultaneously open the Profile and Subject tables.](#open-the-main-data-table-and-simultaneously-open-the-profile-and-subject-tables)

```

// Open data table
dt = Open("$Sample_Data/Pizza Responses.jmp");
// Open Profile and Subject Tables
Open( "$Sample_Data/Pizza Subjects.jmp" );
Open( "$Sample_Data/Pizza Profiles.jmp" );


```

### [Calculate factor score correlations for specified variables in the Online Consumer Data table using the Multivariate platform with row-wise estimation method and display the results in a square matrix format with scatterplot matrix and shaded ellipses.](#calculate-factor-score-correlations-for-specified-variables-in-the-online-consumer-data-table-using-the-multivariate-platform-with-row-wise-estimation-method-and-display-the-results-in-a-square-matrix-format-with-scatterplot-matrix-and-shaded-ellipses)

```

// Open data table
dt = Open("$Sample_Data/Online Consumer Data.jmp");
// Factor Score Correlations
Multivariate(
    Y(
        :Privacy, :Security, :Reputation,
        :Trust, :Purchase Int
    ),
    Estimation Method( "Row-wise" ),
    Matrix Format( "Square" ),
    Scatterplot Matrix(
        Density Ellipses( 0 ),
        Shaded Ellipses( 0 )
    ),
    Color Map on Correlations( 1 )
);


```

### [Perform logistic regression on the O-Ring Failure data table, predicting the Response variable using Temperature as the predictor, and calculate the inverse prediction for a Response value of 0.00063.](#perform-logistic-regression-on-the-o-ring-failure-data-table-predicting-the-response-variable-using-temperature-as-the-predictor-and-calculate-the-inverse-prediction-for-a-response-value-of-000063)

```

// Open data table
dt = Open("$Sample_Data/O-Ring Failure.jmp");
// Logistic
Logistic(
    Y( Response ),
    X( Temperature ),
    Inverse Prediction(
        Response( 0.00063 )
    )
);


```

### [Perform Partial Least Squares regression with Y variable log RAI and multiple X variables including :S1, :L1, :P1, :S2, :L2, :P2, :S3, :L3, :P3, :S4, :L4, :P4, :S5, :L5, :P5 using the Partial Least Squares function.](#perform-partial-least-squares-regression-with-y-variable-log-rai-and-multiple-x-variables-including-s1-l1-p1-s2-l2-p2-s3-l3-p3-s4-l4-p4-s5-l5-p5-using-the-partial-least-squares-function)

```

// Open data table
dt = Open("$Sample_Data/Penta.jmp");
// Partial Least Squares
Partial Least Squares(
    Y( :log RAI ),
    X(
        :S1, :L1, :P1, :S2, :L2, :P2, :S3,
        :L3, :P3, :S4, :L4, :P4, :S5, :L5,
        :P5
    ),
    Go
);


```

### [Construct a choice model using the One Table option, Subject ID, Choice Set ID, Profile ID, and Profile Effects for Crust, Cheese, and Topping from the Pizza Combined.jmp dataset. Additionally, enable Firth Bias-Adjusted Estimates and Likelihood Ratio Tests.](#construct-a-choice-model-using-the-one-table-option-subject-id-choice-set-id-profile-id-and-profile-effects-for-crust-cheese-and-topping-from-the-pizza-combinedjmp-dataset-additionally-enable-firth-bias-adjusted-estimates-and-likelihood-ratio-tests)

```

// Open data table
dt = Open("$Sample_Data/Pizza Combined.jmp");
// Choice
Choice(
    One Table( 1 ),
    Subject ID( :Subject ),
    Choice Set ID( :Trial ),
    Profile ID( :Indicator ),
    Profile Effects(
        :Crust, :Cheese, :Topping
    ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    Likelihood Ratio Tests( 1 )
);


```

### [Imperative sentence: Create a bivariate plot of the edge variable against the nub variable using the Bivariate platform.](#imperative-sentence-create-a-bivariate-plot-of-the-edge-variable-against-the-nub-variable-using-the-bivariate-platform)

```

// Open data table
dt = Open("$Sample_Data/Pollen.jmp");
// Bivariate
Bivariate( Y( :edge ), X( :nub ) );


```

### [Create a bivariate plot to visualize the relationship between F Rate 60+ and F Rate 0-19 from the PopAgeGroup data table.](#create-a-bivariate-plot-to-visualize-the-relationship-between-f-rate-60-and-f-rate-0-19-from-the-popagegroup-data-table)

```

// Open data table
dt = Open("$Sample_Data/PopAgeGroup.jmp");
// Gender Portion
Bivariate(
    Y( :"F Rate 60+"n ),
    X( :"F Rate 0-19"n ),
    SendToReport(
        Dispatch( {}, "Bivar Plot",
            FrameBox,
            {Frame Size( 706, 434 ),
            Marker Drawing Mode( "Fast" )
            }
        )
    )
);


```

### [Exclude the last 100 rows of data from the current active data table.](#exclude-the-last-100-rows-of-data-from-the-current-active-data-table)

```

// Open data table
dt = Open("$Sample_Data/Polyethylene Process.jmp");
// Set currrent data as excluded
dt = Current Data Table();
lastRow = N Rows( dt );
For( i = 101, i <= lastRow, i++,
    Row State( i ) = Excluded State( 1 )
);


```

### [Generate distribution analysis for continuous variables in the specified data table using the Distribution platform.](#generate-distribution-analysis-for-continuous-variables-in-the-specified-data-table-using-the-distribution-platform)

```

// Open data table
dt = Open("$Sample_Data/Primes.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :Prime )
    ),
    Continuous Distribution(
        Column( :Delta )
    ),
    Continuous Distribution(
        Column( :DeltaDelta )
    )
);


```

### [Create a U Chart with a Weighted Moving Average Chart (UWMA) for a sample data table in the Quality Control platform.](#create-a-u-chart-with-a-weighted-moving-average-chart-uwma-for-a-sample-data-table-in-the-quality-control-platform)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Clips1.jmp");
// UWMA Chart
Control Chart(
    Sample Label( :Status ),
    Sample Size( 5 ),
    K Sigma( 3 ),
    Moving Average Span( 2 ),
    Chart Col( :Gap, UWMA )
);


```

### [Build a control chart for a quality control process using the Control Chart Builder function .](#build-a-control-chart-for-a-quality-control-process-using-the-control-chart-builder-function)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Combined.jmp");
// Control Chart Builder
Control Chart Builder(
    Show Capability( 0 ),
    Variables(
        Subgroup( :Run ),
        Y( :Length )
    ),
    Chart( Position( 1 ) ),
    Chart( Position( 2 ) )
);


```

### [Construct a control chart using the Control Chart Builder platform with DAY as the subgroup variable and DIAMETER as the response variable, displaying both the average and range subgroups with connecting lines and sigma limits.](#construct-a-control-chart-using-the-control-chart-builder-platform-with-day-as-the-subgroup-variable-and-diameter-as-the-response-variable-displaying-both-the-average-and-range-subgroups-with-connecting-lines-and-sigma-limits)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Diameter.jmp");
// Control Chart Builder
Control Chart Builder(
    Show Control Panel( 0 ),
    Variables(
        "Subgroup"(:DAY), "Y"(:DIAMETER)
    ),
    Chart(
        Position( 1 ),
        Points( Statistic( "Average" ) ),
        Limits( Sigma( "Range" ) ),
        Connecting Line( 1 )
    ),
    Chart(
        Position( 2 ),
        Points( Statistic( "Range" ) ),
        Limits( Sigma( "Range" ) ),
        Connecting Line( 1 )
    )
);


```

### [Generate a C Chart using the Control Chart Builder function to visualize defect counts per unit.](#generate-a-c-chart-using-the-control-chart-builder-function-to-visualize-defect-counts-per-unit)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Fabric.jmp");
// Control Chart Builder: C Chart
Control Chart Builder(
    Show Control Panel( 0 ),
    Class( "Shewhart Attribute" ),
    Variables(
        Subgroup( :Bolt ),
        Y( :Flaws )
    ),
    Chart(
        Points( Statistic( "Count" ) ),
        Limits( Sigma( "Poisson" ) )
    )
);


```

### [Generate a Pareto plot displaying the top causes of failures using categorical variables and frequency counts.](#generate-a-pareto-plot-displaying-the-top-causes-of-failures-using-categorical-variables-and-frequency-counts)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failure3ID.jmp");
// Pareto Plot
Pareto Plot(
    Cause( :failure ),
    X( :clean, :date ),
    Freq( :N )
);


```

### [Perform Categorical Multivariate ID Analysis using the Freq, ID, X, Multiple Response by ID, and Sample Size functions.](#perform-categorical-multivariate-id-analysis-using-the-freq-id-x-multiple-response-by-id-and-sample-size-functions)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failure3ID.jmp");
// Cat MultID
Categorical(
    Freq( :N ),
    ID( :ID ),
    X( :clean ),
    Multiple Response by ID( :failure ),
    Sample Size( :SampleSize )
);


```

### [Create a Pareto plot to visualize the rate of occurrences for different causes across various processes in the Quality Control data table.](#create-a-pareto-plot-to-visualize-the-rate-of-occurrences-for-different-causes-across-various-processes-in-the-quality-control-data-table)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failuressize.jmp");
// Pareto Plot - Rate
Pareto Plot(
    Cause( :Causes ),
    X( :Process ),
    Freq( :Count ),
    Per Unit Rates( 1 ),
    Test Rates Across Groups( 1 ),
    Cause[1] << Colors( "Red" ),
    Cause[2] << Colors( "Purple" ),
    Cause[4] << Colors( "BlueGreen" ),
    Cause[5] << Colors( "Yellow" ),
    Cause[6] << Colors( "Blue" ),
    Cause[7] << Colors( "Orange" )
);


```

### [Generate a normal quantile plot for a continuous distribution analysis of the Hours between Burnouts column in the Fan Burnout data table using the Distribution platform .](#generate-a-normal-quantile-plot-for-a-continuous-distribution-analysis-of-the-hours-between-burnouts-column-in-the-fan-burnout-data-table-using-the-distribution-platform)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Fan Burnout.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :Hours between Burnouts ),
        Normal Quantile Plot( 1 )
    )
);


```

### [Generate individual and moving range control charts using the Control Chart Builder platform.](#generate-individual-and-moving-range-control-charts-using-the-control-chart-builder-platform)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Fan Burnout.jmp");
// Control Chart Builder Individual and Moving Range Charts
Control Chart Builder(
    Show Control Panel( 0 ),
    Variables(
        Subgroup( :Burnout ),
        Y( :Hours between Burnouts )
    ),
    Chart(
        Position( 1 ),
        Limits( Spec Limits( 1 ) )
    ),
    Chart( Position( 2 ) ),
    SendToReport(
        Dispatch( {}, "Burnout", ScaleBox,
            {Min( 0 ), Max( 26 ),
            Inc( 2 ), Minor Ticks( 0 )}
        )
    )
);


```

### [Sort the data table by the Shuffle column in ascending order, creating a new output table called Sort of Join of Chocolate Factory with Untitled 3 by Shuffle.](#sort-the-data-table-by-the-shuffle-column-in-ascending-order-creating-a-new-output-table-called-sort-of-join-of-chocolate-factory-with-untitled-3-by-shuffle)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Fancy Chocolate Factory.jmp");
// Source
Data Table(
    "Join of Chocolate Factory with Untitled 3"
) << Sort(
    By( :Shuffle ),
    Order( Ascending ),
    Output Table(
        "Sort of Join of Chocolate Factory with Untitled 3 by Shuffle"
    )
);


```

### [Perform principal component analysis (PCA) on variables using the on Correlations option.](#perform-principal-component-analysis-pca-on-variables-using-the-on-correlations-option)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Flight Delays.jmp");
// Principal Components
Principal Components(
    Y(
        :AA, :CO, :DL, :F9, :FL, :NW, :UA,
        :US, :WN
    ),
    Estimation Method( "Default" ),
    "on Correlations"
);


```

### [Create a Model-Driven Multivariate Control Chart using historical data.](#create-a-model-driven-multivariate-control-chart-using-historical-data)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Flight Delays.jmp");
// Original data with historical
Model Driven Multivariate Control Chart(
    Process(
        :AA, :CO, :DL, :F9, :FL, :NW, :UA,
        :US, :WN
    ),
    Time ID( :Flight date ),
    Historical Data End at Row( 16 ),
    Score Plot(
        Score Ellipse Coverage( 0.95 )
    )
);


```

### [Create a Cusum Chart to monitor the weight process with specified control parameters.](#create-a-cusum-chart-to-monitor-the-weight-process-with-specified-control-parameters)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Oil1 Cusum.jmp");
// Cusum Chart
Control Chart(
    Sample Size( :hour ),
    H( 2 ),
    Chart Col(
        :weight,
        CUSUM(
            Two sided( 1 ),
            Target( 8.1 ),
            Delta( 1 ),
            Sigma( 0.05 ),
            Head Start( 0.05 )
        )
    )
);


```

### [Construct a multivariate control chart using the Multivariate Control Chart function .](#construct-a-multivariate-control-chart-using-the-multivariate-control-chart-function)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Thickness.jmp");
// Multivariate Control Chart
Multivariate Control Chart(
    Y(
        :Thickness 01, :Thickness 02,
        :Thickness 03, :Thickness 04,
        :Thickness 05, :Thickness 06,
        :Thickness 07, :Thickness 08,
        :Thickness 09, :Thickness 10,
        :Thickness 11, :Thickness 12
    ),
    T Square Partitioned( 1 ),
    Principal Components( 1 ),
    Set Alpha Level(
        0.00270000000000004
    )
);


```

### [Construct an NP Chart using the Control Chart Builder to analyze the number of defective items in subgroups with varying lot sizes.](#construct-an-np-chart-using-the-control-chart-builder-to-analyze-the-number-of-defective-items-in-subgroups-with-varying-lot-sizes)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Washers.jmp");
// Control Chart Builder: NP Chart
Control Chart Builder(
    Show Control Panel( 0 ),
    Class( "Shewhart Attribute" ),
    Variables(
        Subgroup( :Lot ),
        Y( :"# defective"n ),
        n Trials( :Lot Size )
    ),
    Chart(
        Points( Statistic( "Count" ) ),
        Limits( Sigma( "Binomial" ) )
    )
);


```

### [Perform a detailed Recurrence Analysis on bladder cancer data by fitting a multi-state model, calculating cost, comparing different treatment groups, and labeling patients.](#perform-a-detailed-recurrence-analysis-on-bladder-cancer-data-by-fitting-a-multi-state-model-calculating-cost-comparing-different-treatment-groups-and-labeling-patients)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Bladder Cancer.jmp");
// Recurrence Analysis
Recurrence Analysis(
    Y( :Age ),
    Cost( :Cost ),
    Grouping( :Treatment Group ),
    Label( :Patient Number ),
    Plot MCF Differences( 1 )
);


```

### [Create a survival analysis using time cycles, censor status, and grouping variables.](#create-a-survival-analysis-using-time-cycles-censor-status-and-grouping-variables)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Blenders.jmp");
// Survival
Survival(
    Y( :Time Cycles ),
    Censor( :Censor ),
    Grouping( :Group )
);


```

### [Perform reliability growth analysis using the Piecewise Weibull NHPP model for change point detection on the BrakeReliability data set.](#perform-reliability-growth-analysis-using-the-piecewise-weibull-nhpp-model-for-change-point-detection-on-the-brakereliability-data-set)

```

// Open data table
dt = Open("$Sample_Data/Reliability/BrakeReliability.jmp");
// Reliability Growth
Reliability Growth(
    Input Format( Dates ),
    Timestamp( :Date ),
    Event Count( :Fixes ),
    Piecewise Weibull NHPP Change Point Detection
);


```

### [Fit a Parametric Survival Model using the LogNormal distribution with the Personality set to Parametric Survival and include the effect of variable x.](#fit-a-parametric-survival-model-using-the-lognormal-distribution-with-the-personality-set-to-parametric-survival-and-include-the-effect-of-variable-x)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Devalt.jmp");
// Parametric Survival Model
Fit Model(
    Weight( :Censor ),
    Freq( :Weight ),
    Y( :Hours ),
    Censor( :Censor ),
    Censor Code( 1 ),
    Effects( :x ),
    Personality( "Parametric Survival" ),
    Distribution( LogNormal )
);


```

### [Fit Parametric Survival model using LogNormal distribution and perform Likelihood Ratio Tests and Estimate Time Quantile analysis.](#fit-parametric-survival-model-using-lognormal-distribution-and-perform-likelihood-ratio-tests-and-estimate-time-quantile-analysis)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Comptime.jmp");
// Fit Parametric Survival
obj =
Fit Model(
    Y( :ExecTime ),
    Effects( :Load ),
    Personality( "Parametric Survival" ),
    Distribution( LogNormal ),
    Run
);
obj << Likelihood Ratio Tests( 1 );
obj <<
Estimate Time Quantile(
    :Load = 5,
    [0.1],
    Alpha( 0.05 )
);


```

### [Analyze and visualize the distribution of tip percentages by server in the Restaurant Tips dataset using the Distribution platform.](#analyze-and-visualize-the-distribution-of-tip-percentages-by-server-in-the-restaurant-tips-dataset-using-the-distribution-platform)

```

// Open data table
dt = Open("$Sample_Data/Restaurant Tips.jmp");
// Distribution: Tip % by Server
Distribution(
    Stack( 1 ),
    Continuous Distribution(
        Column( :Tip Percentage ),
        Horizontal Layout( 1 ),
        Vertical( 0 )
    ),
    By( :Server )
);


```

### [Perform one-way analysis of variance comparing Fahrenheit temperatures across different types of spaces, featuring post-hoc comparisons, ANOM charts, box plots, and comparison circles.](#perform-one-way-analysis-of-variance-comparing-fahrenheit-temperatures-across-different-types-of-spaces-featuring-post-hoc-comparisons-anom-charts-box-plots-and-comparison-circles)

```

// Open data table
dt = Open("$Sample_Data/S4 Temps.jmp");
// Oneway - Type of Space
Oneway(
    Y( :fahrenheit ),
    X( :type of space ),
    Each Pair(
        1,
        LSD Threshold Matrix( 0 ),
        Ordered Differences Report( 0 )
    ),
    ANOM( 1 ),
    Box Plots( 1 ),
    Comparison Circles( 1 )
);


```

### [Create a control chart using the moving average with specifications limits.](#create-a-control-chart-using-the-moving-average-with-specifications-limits)

```

// Open data table
dt = Open("$Sample_Data/Stock Averages.jmp");
// Control Chart Builder: Moving Average
Control Chart Builder(
    Variables(
        Subgroup( :Date ),
        Y( :Moving Average )
    ),
    Chart(
        Position( 1 ),
        Limits( Spec Limits( 1 ) )
    ),
    Chart( Position( 2 ) ),
    Show Control Panel( 0 )
);


```

### [Build a linear regression model using the Fit Model function with multiple predictors.](#build-a-linear-regression-model-using-the-fit-model-function-with-multiple-predictors)

```

// Open data table
dt = Open("$Sample_Data/Supersaturated.jmp");
// Model
Fit Model(
    Effects(
        :X1, :X2, :X3, :X4, :X5, :X6, :X7,
        :X8, :X9, :X10, :X11, :X12, :X13,
        :X14, :X15, :X16, :X17, :X18
    ),
    Y( :Y ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" )
);


```

### [Perform a one-way ANOVA analysis on typing speed data by brand.](#perform-a-one-way-anova-analysis-on-typing-speed-data-by-brand)

```

// Open data table
dt = Open("$Sample_Data/Typing Data.jmp");
// Oneway
Oneway(
    Y( :speed ),
    X( :brand ),
    Means( 1 ),
    All Pairs( 1 )
);


```

### [Perform Multiple Correspondence Analysis on a dataset with Year as the dependent variable, Region and ID as supplementary variables, and Population as the frequency variable, including chi-square measures and totals in the cross tables.](#perform-multiple-correspondence-analysis-on-a-dataset-with-year-as-the-dependent-variable-region-and-id-as-supplementary-variables-and-population-as-the-frequency-variable-including-chi-square-measures-and-totals-in-the-cross-tables)

```

// Open data table
dt = Open("$Sample_Data/US Regional Population.jmp");
// Multiple Correspondence Analysis
Multiple Correspondence Analysis(
    Y( :Year ),
    X( :Region ),
    Freq( :Population ),
    Supplementary ID( :ID ),
    Cross Table(
        Cell Chi Square( 0 ),
        Show Total( 1 )
    ),
    Cross Table of Supplementary Rows(
        Cell Chi Square( 0 ),
        Show Total( 1 )
    )
);


```

### [Generate a distribution analysis report, including nominal distribution analysis for the 'Year' column with horizontal layout, and by group for the 'Region' column.](#generate-a-distribution-analysis-report-including-nominal-distribution-analysis-for-the-year-column-with-horizontal-layout-and-by-group-for-the-region-column)

```

// Open data table
dt = Open("$Sample_Data/US Regional Population.jmp");
// Distribution
Distribution(
    Stack( 1 ),
    Weight( :Population ),
    Nominal Distribution(
        Column( :Year ),
        Horizontal Layout( 1 ),
        Vertical( 0 )
    ),
    By( :Region )
);


```

### [Perform a Variability Chart analysis for crossed and nested factors.](#perform-a-variability-chart-analysis-for-crossed-and-nested-factors)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/3 Factors Crossed & Nested.jmp");
// Variability Chart - Crossed & Nested
Variability Chart(
    Y( :Y ),
    X( :Operator, :Instrument, :Part ),
    Show Points( 1 ),
    Std Dev Chart( 1 )
);


```

### [Perform a Gauge R&R analysis using a Variability Chart with nested and crossed factors.](#perform-a-gauge-rr-analysis-using-a-variability-chart-with-nested-and-crossed-factors)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/3 Factors Nested & Crossed.jmp");
// Gauge R&R
Variability Chart(
    Y( :Y ),
    X( :Operator, :Instrument, :Part ),
    Model( "Nested then Crossed" ),
    Connect Cell Means( 1 ),
    Mean of Std Dev( 1 )
);


```

### [Construct a variability chart to analyze the process variation using crossed model for the response variable.](#construct-a-variability-chart-to-analyze-the-process-variation-using-crossed-model-for-the-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/Gasket.jmp");
// Variability Chart
Variability Chart(
    Y( :Y ),
    Model( "Crossed" ),
    X( :Operator, :Part ),
    Analysis Type(
        "Choose best analysis (EMS REML)"
    ),
    Variability Analysis(
        :Y,
        Connect Cell Means( 1 ),
        Show Grand Mean( 1 ),
        XBar Control Limits( 1 ),
        S Control Limits( 1 ),
        Mean of Std Dev( 1 ),
        "Gauge R&R Report"n( 1 )
    )
);


```

### [Perform a Type 1 Gauge Analysis on variable Y1 with specified tolerance and reference values. Type 1 Gauge() function is used to generate the analysis, and Type 1 Gauge Metadata() function is used to define the parameters such as Lower Tolerance, Upper Tolerance, Reference, and Resolution.](#perform-a-type-1-gauge-analysis-on-variable-y1-with-specified-tolerance-and-reference-values-type-1-gauge-function-is-used-to-generate-the-analysis-and-type-1-gauge-metadata-function-is-used-to-define-the-parameters-such-as-lower-tolerance-upper-tolerance-reference-and-resolution)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/Type 1 Gauge MSA.jmp");
// Type 1 Gauge of Y1
Type 1 Gauge(
    Y( :Y1 ),
    Type 1 Gauge Metadata(
        :
        Y1(
            Lower Tolerance( 49.014 ),
            Upper Tolerance( 51.014 ),
            Reference( 50.014 ),
            Resolution( 0.001 )
        )
    ),
    Type 1 Gauge Analysis( "Y1" )
);


```

### [Perform EMP Measurement Systems Analysis using Crossed Model, Dispersion Chart with Range, and include Average and Dispersion Charts.](#perform-emp-measurement-systems-analysis-using-crossed-model-dispersion-chart-with-range-and-include-average-and-dispersion-charts)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/Wafer.jmp");
// EMP Measurement Systems Analysis
EMP Measurement Systems Analysis(
    Y( :Y ),
    X( :Operator ),
    Part( :Wafer ),
    Model( "Crossed" ),
    Dispersion Chart Type( "Range" ),
    Average Chart( 1 ),
    Dispersion Chart( 1 )
);


```

### [Analyze continuous data by performing a distribution analysis on the weight column in the Weight Measurements data table.](#analyze-continuous-data-by-performing-a-distribution-analysis-on-the-weight-column-in-the-weight-measurements-data-table)

```

// Open data table
dt = Open("$Sample_Data/Weight Measurements.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :weight )
    )
);


```

### [Generate a tabulated report with grouping columns](#generate-a-tabulated-report-with-grouping-columns)

```

// Open data table
dt = Open("$Sample_Data/Auto Raw Data.jmp");
// Tabulate (Summary)
Tabulate(
    Set Format(
        Sum(
            Premium USD( 15, 95 ),
            Claim USD( 15, 95 )
        )
    ),
    Add Table(
        Column Table(
            Analysis Columns(
                :Premium USD
            ),
            Statistics( N, Sum )
        ),
        Column Table(
            Analysis Columns(
                :Claim USD
            ),
            Statistics( N, Sum )
        ),
        Row Table(
            Grouping Columns(
                :Branch, :Zone
            )
        )
    )
);


```

### [Fit a standard least squares model with a prediction profiler](#fit-a-standard-least-squares-model-with-a-prediction-profiler)

```

// Open data table
dt = Open("$Sample_Data/Auto Raw Data.jmp");
// Fit Model (Claim USD)
Fit Model(
    Y( :Claim USD ),
    Effects(
        :AgeClass, :"City(Y/N)"n,
        :Rating Class
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Run(
        Profiler(
            1,
            Confidence Intervals( 1 ),
            Term Value(
                AgeClass( "Elder" ),
                "City(Y/N)"n( "N" ),
                Rating Class( "A" )
            )
        ),
        :Claim USD <<
        {Plot Actual by Predicted( 0 ),
        Plot Regression( 0 ),
        Plot Residual by Predicted( 0 ),
        Plot Effect Leverage( 0 )},
        SendToReport(
            Dispatch(
                {"Response Claim USD",
                "Prediction Profiler"},
                "10000", ScaleBox,
                {
                Format(
                    "Currency",
                    "USD",
                    15,
                    0
                ), Max( 8000 ),
                Inc( 1000 )}
            )
        )
    )
);


```

### [Fit a partial least squares model using the nipals method](#fit-a-partial-least-squares-model-using-the-nipals-method)

```

// Open data table
dt = Open("$Sample_Data/Body Fat.jmp");
// Partial Least Squares
Partial Least Squares(
    Y( :Percent body fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n,
        :"Height (inches)"n,
        :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n,
        :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n,
        :"Thigh circumference (cm)"n,
        :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n,
        :
        "Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n,
        :"Wrist circumference (cm)"n
    ),
    Validation( :Validation ),
    Initial Number of Factors( 13 ),
    Fit(
        Method( NIPALS ),
        Number of Factors( 7 ),
        Variable Importance Plot( 1 )
    )
);


```

### [Perform distribution analysis](#perform-distribution-analysis_1)

```

// Open data table
dt = Open("$Sample_Data/Cars 1993.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :"City Mileage (MPG)"n ),
        Normal Quantile Plot( 1 ),
        Stem and Leaf( 1 )
    ),
    Continuous Distribution(
        Column(
            :"Highway Mileage (MPG)"n
        ),
        Normal Quantile Plot( 1 ),
        Stem and Leaf( 1 )
    ),
    SendToReport(
        Dispatch( {"City Mileage (MPG)"},
            "Distrib Histogram", FrameBox,
            Background Color( 2 )
        ),
        Dispatch(
            {"Highway Mileage (MPG)"},
            "Distrib Histogram", FrameBox,
            Background Color( 2 )
        )
    )
);


```

### [Generate life distribution analysis](#generate-life-distribution-analysis)

```

// Open data table
dt = Open("$Sample_Data/Censor Labels.jmp");
// Life Distribution
Life Distribution(
    Y( :Start Time, :End Time ),
    Freq( :Count ),
    Confidence Interval Method( Wald ),
    <<Set Scale( Nonparametric ),
    Interval Type( Simultaneous ),
    <<Set Scriptables( {} ),
    SendToReport(
        Dispatch( {}, "Event Plot",
            OutlineBox,
            {Close( 0 )}
        ),
        Dispatch( {"Event Plot"},
            "Life Distribution", FrameBox,
            {Frame Size( 401, 285 )}
        ),
        Dispatch( {},
            "Compare Distributions",
            OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Generate distribution analysis with normal quantile plot](#generate-distribution-analysis-with-normal-quantile-plot)

```

// Open data table
dt = Open("$Sample_Data/Circuit Board Production.jmp");
// Distribution
Distribution(
    Automatic Recalc( 1 ),
    Nominal Distribution(
        Column( :Day of Week )
    ),
    Continuous Distribution(
        Column( :Time ),
        Normal Quantile Plot( 1 )
    ),
    SendToReport(
        Dispatch( {}, "Distrib Nom Hist",
            FrameBox,
            {DispatchSeg( Hist Seg( 1 ) )
            }
        ),
        Dispatch( {}, "Distrib Histogram",
            FrameBox,
            {DispatchSeg( Hist Seg( 1 ) )
            }
        ),
        Dispatch( {}, "5", ScaleBox,
            {Scale( "Linear" ),
            Min( 0.0533333333333334 ),
            Max( 0.946666666666666 ),
            Inc( 0.08 ), Minor Ticks( 0 ),
            Show Major Grid( 1 ),
            Rotated Labels(
                "Horizontal"
            )}
        ),
        Dispatch( {}, "Quantiles",
            OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Generate process capability analysis with specified limits and a goal plot](#generate-process-capability-analysis-with-specified-limits-and-a-goal-plot)

```

// Open data table
dt = Open("$Sample_Data/Cities.jmp");
// Process Capability
Process Capability(
    Process Variables(
        :OZONE, :CO, :SO2, :NO
    ),
    Spec Limits(
        OZONE(
            LSL( 0 ),
            Target( 0.05 ),
            USL( 0.1 )
        ),
        CO(
            LSL( 5 ),
            Target( 10 ),
            USL( 20 )
        ),
        SO2(
            LSL( 0 ),
            Target( 0.03 ),
            USL( 0.08 )
        ),
        NO(
            LSL( 0 ),
            Target( 0.025 ),
            USL( 0.6 )
        )
    ),
    Goal Plot( 1, Shade Levels( 1 ) )
);


```

### [Perform categorical analysis with crosstab transposed and test for response homogeneity](#perform-categorical-analysis-with-crosstab-transposed-and-test-for-response-homogeneity_2)

```

// Open data table
dt = Open("$Sample_Data/Consumer Preferences.jmp");
// Categorical Several
Categorical(
    X( :Age Group, :School Age Children ),
    Grouping Option(
        "Each Individually"
    ),
    Responses(
        :I am working on my career
    ),
    Responses(
        :
        My home needs some major improvements
    ),
    Responses(
        :
        I have vast interests outside of work
    ),
    Responses(
        :I come from a large family
    ),
    Crosstab Transposed( 1 ),
    Legend( 0 ),
    Test Response Homogeneity( 1 )
);


```

### [Fit a standard linear regression model to predict Annual Salary Z, incorporating Gender, Length Of Service, and Performance as effects, and suppress detailed diagnostic plots.](#fit-a-standard-linear-regression-model-to-predict-annual-salary-z-incorporating-gender-length-of-service-and-performance-as-effects-and-suppress-detailed-diagnostic-plots)

```

// Open data table
dt = Open("$Sample_Data/Employee Master.jmp");
// Fit Model - Annual Salary Z
Fit Model(
    Y( :Annual Salary Z ),
    Effects(
        :Gender, :Length Of Service,
        :Performance
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Run(
        :Annual Salary Z <<
        {Summary of Fit( 1 ),
        Analysis of Variance( 1 ),
        Parameter Estimates( 1 ),
        Scaled Estimates( 0 ),
        Plot Actual by Predicted( 0 ),
        Plot Regression( 0 ),
        Plot Residual by Predicted( 0 ),
        Plot Studentized Residuals( 0 ),
        Plot Effect Leverage( 0 ),
        Plot Residual by Normal Quantiles(
            0
        ), Box Cox Y Transformation( 0 )}
    ),
    SendToReport(
        Dispatch(
            {"Response Annual Salary Z"},
            "Effect Tests", OutlineBox,
            {Close( 0 )}
        )
    )
);


```

### [Partition a dataset into clusters using the initial splits and set validation portion.](#partition-a-dataset-into-clusters-using-the-initial-splits-and-set-validation-portion)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Partition 3
Partition(
    Y( :surface quality ),
    X(
        :Part, :Lot, :X, :Y, :Z, :Radius,
        :Center, :Gap, :Slot Width,
        :Slot Length, :Slot Depth, :color
    ),
    Validation Portion( 0.5 ),
    Show Split Prob( 1 ),
    Show Split Count( 1 ),
    Split History( 1 ),
    Informative Missing( 1 ),
    Column Contributions( 1 ),
    Initial Splits(
        :Y < 248.8,
        {:Part == {32}, {}, {:Radius <
        10.6}}
    )
);


```

### [Analyze the distribution of actual impurity levels using a lognormal fit and assess process capability with a specified upper specification limit of 2.5.](#analyze-the-distribution-of-actual-impurity-levels-using-a-lognormal-fit-and-assess-process-capability-with-a-specified-upper-specification-limit-of-25)

```

// Open data table
dt = Open("$Sample_Data/Impurity Process Capability with Detection Limits.jmp");
// Distribution Lognormal Capability
Distribution(
    Continuous Distribution(
        Column( :Actual Impurity ),
        Quantiles( 0 ),
        Summary Statistics( 0 ),
        Always use column properties( 1 ),
        Histogram( 0 ),
        Vertical( 0 ),
        Outlier Box Plot( 0 ),
        Fit Lognormal(
            Process Capability(
                LSL( . ),
                Target( . ),
                USL( 2.5 ),
                Show as Graph Reference Lines
            )
        ),
        Process Capability( 0 )
    ),
    Column Switcher(
        :Actual Impurity,
        {:Actual Impurity,
        :"1.0 Limited Impurity"n,
        :"1.5 Limited Impurity"n,
        :"2.0 Limited Impurity"n,
        :"2.5 Limited Impurity"n}
    )
);


```

### [Analyze the distributions of categorical and continuous variables in the Nicardipine dataset using the Distribution() function .](#analyze-the-distributions-of-categorical-and-continuous-variables-in-the-nicardipine-dataset-using-the-distribution-function)

```

// Open data table
dt = Open("$Sample_Data/Nicardipine.jmp");
// Distributions
Distribution(
    Nominal Distribution(
        Column(
            :Body System or Organ Class
        ),
        Order By( "Count Ascending" )
    ),
    Nominal Distribution(
        Column( :"Severity/Intensity"n )
    ),
    Nominal Distribution(
        Column( :Serious Event )
    ),
    Continuous Distribution(
        Column( :Age )
    ),
    Nominal Distribution(
        Column( :Sex )
    ),
    Nominal Distribution(
        Column( :Race )
    ),
    Nominal Distribution(
        Column( :Death Description ),
        Order By( "Count Ascending" )
    )
);


```

### [Analyze and visualize the distribution of multiple continuous columns related to olive oil components and the subregion category in the Distribution platform.](#analyze-and-visualize-the-distribution-of-multiple-continuous-columns-related-to-olive-oil-components-and-the-subregion-category-in-the-distribution-platform)

```

// Open data table
dt = Open("$Sample_Data/Olive Oil.jmp");
// Distribution
Distribution(
    Uniform Scaling( 1 ),
    Continuous Distribution(
        Column( :palmitic )
    ),
    Continuous Distribution(
        Column( :palmitoleic )
    ),
    Continuous Distribution(
        Column( :stearic )
    ),
    Continuous Distribution(
        Column( :oleic )
    ),
    Continuous Distribution(
        Column( :linoleic )
    ),
    Continuous Distribution(
        Column( :linolenic )
    ),
    Continuous Distribution(
        Column( :arachidic )
    ),
    Continuous Distribution(
        Column( :eicosenoic )
    ),
    Nominal Distribution(
        Column( :Subregion ),
        Show Percents( 1 ),
        Mosaic Plot( 1 )
    )
);


```

### [Perform a bivariate analysis with jittering and label offset settings for maximum January temperature points.](#perform-a-bivariate-analysis-with-jittering-and-label-offset-settings-for-maximum-january-temperature-points)

```

// Open data table
dt = Open("$Sample_Data/Pollutants Map.jmp");
// Bivariate
Bivariate(
    Y( :Y ),
    X( :X ),
    SendToReport(
        Dispatch( {},
            "Bivariate Fit of Y By X",
            OutlineBox,
            {
            Set Title(
                "Highlight Maximum January Temperature Points and Label Them"
            )}
        ),
        Dispatch( {}, "Bivar Plot",
            FrameBox,
            {Frame Size( 476, 313 ),
            DispatchSeg(
                Marker Seg( 1 ),
                label offset(
                    {503, 25, 5},
                    {566, -15, 29}
                )
            )}
        )
    )
);


```

### [Perform a MaxDiff analysis for flavor preference using the Potato Chip Responses, Profiles, and Subjects data tables .](#perform-a-maxdiff-analysis-for-flavor-preference-using-the-potato-chip-responses-profiles-and-subjects-data-tables)

```

// Open data table
dt = Open("$Sample_Data/Potato Chip Responses.jmp");
// MaxDiff for Flavor
Open(
    "$Sample_Data/Potato Chip Subjects.jmp"
);
Open(
    "$Sample_Data/Potato Chip Profiles.jmp"
);
MaxDiff(
    Response Data Table(
        Data Table(
            "Potato Chip Responses"
        )
    ),
    Profile DataTable(
        Potato Chip Profiles
    ),
    Subject DataTable(
        Data Table(
            "Potato Chip Subjects"
        )
    ),
    Response Subject ID( :Respondent ),
    Response Profile ID Choices(
        :Choice 1, :Choice 2, :Choice 3
    ),
    Profile ID( :Profile ID ),
    Profile Effects( :Flavor ),
    Subject Subject ID( :Respondent ),
    Subject Effects(
        :Citizenship, :Gender
    ),
    "Firth Bias-adjusted Estimates"n( 1 ),
    Response Best Option( :Best Profile ),
    Response Worst Option(
        :Worst Profile
    )
);


```

### [Perform distribution analysis on specified columns in the Presidential Elections data table with uniform scaling and custom axis settings for continuous distributions.](#perform-distribution-analysis-on-specified-columns-in-the-presidential-elections-data-table-with-uniform-scaling-and-custom-axis-settings-for-continuous-distributions)

```

// Open data table
dt = Open("$Sample_Data/Presidential Elections.jmp");
// Distribution
Distribution(
    Uniform Scaling( 1 ),
    Continuous Distribution(
        Column( :"1980"n ),
        Axis Settings(
            Scale( Linear ),
            Format( Best ),
            Min( 20 ),
            Max( 65 ),
            Inc( 5 )
        )
    ),
    Continuous Distribution(
        Column( :"1984"n ),
        Axis Settings(
            Scale( Linear ),
            Format( Best ),
            Min( 20 ),
            Max( 65 ),
            Inc( 5 )
        )
    ),
    Continuous Distribution(
        Column( :"1996"n ),
        Axis Settings(
            Scale( Linear ),
            Format( Best ),
            Min( 20 ),
            Max( 65 ),
            Inc( 5 )
        )
    )
);


```

### [Generate a P chart for the proportion of defective units using week subgroups with a Binomial distribution in the Control Chart Builder platform.](#generate-a-p-chart-for-the-proportion-of-defective-units-using-week-subgroups-with-a-binomial-distribution-in-the-control-chart-builder-platform)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp");
// P chart of N Defective Week Subgrouping
Control Chart Builder(
    Size( 534, 450 ),
    Show Control Panel( 0 ),
    Class( Shewhart Attribute ),
    Variables(
        Subgroup( :Week ),
        Y( :N Defective ),
        n Trials( :N Units )
    ),
    Chart(
        Points(
            Statistic( "Proportion" )
        ),
        Limits( Sigma( "Binomial" ) )
    ),
    SendToReport(
        Dispatch( {}, "N Defective",
            ScaleBox,
            {Min( -0.000843572386136978 ),
            Max( 0.1 ), Inc( 0.01 ),
            Minor Ticks( 1 )}
        )
    )
);


```

### [Create a P' Chart to Monitor Proportions of Defectives with Laney P' Adjustment, Grouping Data by Week Subgroup Size.](#create-a-p-chart-to-monitor-proportions-of-defectives-with-laney-p-adjustment-grouping-data-by-week-subgroup-size)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp");
// P' chart of N Defective Week Subgrouping
Control Chart Builder(
    Size( 534, 450 ),
    Show Control Panel( 0 ),
    Class( Shewhart Attribute ),
    Variables(
        Subgroup( :Week ),
        Y( :N Defective ),
        n Trials( :N Units )
    ),
    Chart(
        Points(
            Statistic( "Proportion" )
        ),
        Limits(
            Sigma( "Laney P Prime" )
        )
    ),
    SendToReport(
        Dispatch( {}, "N Defective",
            ScaleBox,
            {Min( -0.000843572386136978 ),
            Max( 0.1 ), Inc( 0.01 ),
            Minor Ticks( 1 )}
        )
    )
);


```

### [Create a Laney P' chart of N Defective using the Control Chart Builder with specified subgroup and variable configurations.](#create-a-laney-p-chart-of-n-defective-using-the-control-chart-builder-with-specified-subgroup-and-variable-configurations)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Electrical Component Defect Screening.jmp");
// P' chart of N Defective
Control Chart Builder(
    Size( 622, 305 ),
    Show Control Panel( 0 ),
    Class( Shewhart Attribute ),
    Variables(
        Subgroup( :Week ),
        Subgroup(
            :Weekday,
            Position( 1 )
        ),
        Y( :N Defective ),
        n Trials( :N Units )
    ),
    Chart(
        Points(
            Statistic( "Proportion" )
        ),
        Limits(
            Sigma( "Laney P Prime" )
        )
    ),
    SendToReport(
        Dispatch( {}, "N Defective",
            ScaleBox,
            {Min( -0.00188665487286776 ),
            Max( 0.140225884611048 ),
            Inc( 0.02 ), Minor Ticks( 0 )
            }
        )
    )
);


```

### [Construct an Individual Moving Range (IMR) chart with multiple control limits in the Control Chart Builder platform.](#construct-an-individual-moving-range-imr-chart-with-multiple-control-limits-in-the-control-chart-builder-platform)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Engine Temperature Sensor.jmp");
// IMR Chart
Control Chart Builder(
    Show Capability( 0 ),
    Variables( Y( :Y ) ),
    Chart(
        Position( 1 ),
        Limits( Sigma( Moving Range ) ),
        Warnings(
            Test 1( 1 ),
            Test 2( 1 ),
            Test 3( 1 ),
            Test 4( 1 ),
            Test 5( 1 ),
            Test 6( 1 ),
            Test 7( 1 ),
            Test 8( 1 )
        )
    ),
    Chart(
        Position( 2 ),
        Limits( Sigma( Moving Range ) )
    )
);


```

### [Generate a Short Run DNOM chart using Control Chart Builder, with subgroups defined by Box, and variables for % Cocoa and Product. The chart includes product-level statistics for different types of chocolates, setting targets and sigmas accordingly.](#generate-a-short-run-dnom-chart-using-control-chart-builder-with-subgroups-defined-by-box-and-variables-for-cocoa-and-product-the-chart-includes-product-level-statistics-for-different-types-of-chocolates-setting-targets-and-sigmas-accordingly)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Fancy Chocolate Factory.jmp");
// Short Run DNOM
Control Chart Builder(
    Show Product Separators( 0 ),
    Class( Short Run ),
    Variables(
        Subgroup( :Box ),
        Y( :"% Cocoa"n ),
        Part( :Product )
    ),
    Chart(
        Position( 2 ),
        Points(
            Statistic( "Range Centered" )
        )
    ),
    Product Statistics(
        :
        "% Cocoa"n(
            Product Level(
                Milk Chocolate(
                    Target( 37 ),
                    Sigma(
                        3.76288031574307
                    )
                ),
                Dark Chocolate(
                    Target( 70 ),
                    Sigma(
                        1.75728682873715
                    )
                ),
                Extra Dark Chocolate(
                    Target( 85 ),
                    Sigma(
                        1.00725971457878
                    )
                )
            )
        )
    )
);


```

### [Execute a Short Run Standardized Control Chart with Product Separators and Target Specifications for the % Cocoa variable using the Control Chart Builder function.](#execute-a-short-run-standardized-control-chart-with-product-separators-and-target-specifications-for-the-cocoa-variable-using-the-control-chart-builder-function)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Fancy Chocolate Factory.jmp");
// Short Run Standardized
Control Chart Builder(
    Show Product Separators( 0 ),
    Class( Short Run ),
    Variables(
        Subgroup( :Box, Position( 1 ) ),
        Y( :"% Cocoa"n ),
        Part( :Product )
    ),
    Chart(
        Position( 1 ),
        Points(
            Statistic( "Standardized" )
        ),
        Warnings( Test 1( 1 ) )
    ),
    Chart(
        Position( 2 ),
        Points(
            Statistic( "Standardized" )
        )
    ),
    Product Statistics(
        :
        "% Cocoa"n(
            Product Level(
                Milk Chocolate(
                    Target( 37 ),
                    Sigma( 3.5 )
                ),
                Dark Chocolate(
                    Target( 70 ),
                    Sigma( 1.5 )
                ),
                Extra Dark Chocolate(
                    Target( 85 ),
                    Sigma( 1 )
                )
            )
        )
    )
);


```

### [Create a Control Chart Builder with a specified subgroup, response variable, and phase variable, and customize the limits and appearance using the Sigma Moving Range method.](#create-a-control-chart-builder-with-a-specified-subgroup-response-variable-and-phase-variable-and-customize-the-limits-and-appearance-using-the-sigma-moving-range-method)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Phase Historical Data.jmp");
// Control Chart Builder
Control Chart Builder(
    Show Capability( 0 ),
    Variables(
        Subgroup( :Run ),
        Y( :Force ),
        Phase( :Site )
    ),
    Chart(
        Position( 1 ),
        Limits( Sigma( "Moving Range" ) )
    ),
    Chart(
        Position( 2 ),
        Limits( Sigma( "Moving Range" ) )
    ),
    SendToReport(
        Dispatch( {},
            "Control Chart Builder",
            FrameBox,
            {
            DispatchSeg(
                Text Seg( 4 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            ),
            DispatchSeg(
                Text Seg( 5 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            ),
            DispatchSeg(
                Text Seg( 6 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            )}
        )
    )
);


```

### [Create an Individual Measurement Chart using Control Chart Builder, displaying both Individual and Moving Range statistics.](#create-an-individual-measurement-chart-using-control-chart-builder-displaying-both-individual-and-moving-range-statistics)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Pickles.jmp");
// Individual Measurement Chart
Control Chart Builder(
    Show Control Panel( 0 ),
    Variables( "Y"(:Acid) ),
    Chart(
        Position( 1 ),
        Points(
            Statistic( "Individual" )
        ),
        Limits( Sigma( "Moving Range" ) ),
        Connecting Line( 1 )
    ),
    Chart(
        Position( 2 ),
        Points(
            Statistic( "Moving Range" )
        ),
        Limits( Sigma( "Moving Range" ) ),
        Connecting Line( 1 )
    )
);


```

### [Perform principal components analysis on a dataset containing thickness measurements using the Row-wise estimation method, on covariances, with eigenvalues calculation and arrow lines in the PCA summary plots. Adjust the frame size of the PCA summary plots to 200x200.](#perform-principal-components-analysis-on-a-dataset-containing-thickness-measurements-using-the-row-wise-estimation-method-on-covariances-with-eigenvalues-calculation-and-arrow-lines-in-the-pca-summary-plots-adjust-the-frame-size-of-the-pca-summary-plots-to-200x200)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Thickness.jmp");
// Principal Components
Principal Components(
    Y(
        :Thickness 01, :Thickness 02,
        :Thickness 03, :Thickness 04,
        :Thickness 05, :Thickness 06,
        :Thickness 07, :Thickness 08,
        :Thickness 09, :Thickness 10,
        :Thickness 11, :Thickness 12
    ),
    Estimation Method( "Row-wise" ),
    on Covariances,
    Eigenvalues( 1 ),
    Arrow Lines( 1 ),
    SendToReport(
        Dispatch( {"Summary Plots"},
            "PCA Summary Plots", FrameBox,
            {Frame Size( 200, 200 )}
        ),
        Dispatch( {"Summary Plots"},
            "PCA Summary Plots",
            FrameBox( 2 ),
            {Frame Size( 200, 200 )}
        )
    )
);


```

### [Analyze data from an appliance using a Weibull distribution to perform a life distribution analysis.](#analyze-data-from-an-appliance-using-a-weibull-distribution-to-perform-a-life-distribution-analysis)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Appliance.jmp");
// Life Distribution
Life Distribution(
    Y( :Time Cycles ),
    Failure Cause( :Cause Code ),
    Failure Distribution by Cause(
        Weibull
    ),
    Comparison Criterion( AICc ),
    Allow failure mode to use ZI distributions(
        0
    ),
    Allow failure mode to use TH distributions(
        0
    ),
    Allow failure mode to use DS distributions(
        0
    ),
    Allow failure mode to use fixed parameter models(
        0
    ),
    Allow failure mode to use Bayesian models(
        0
    )
);


```

### [Perform cumulative damage analysis using the Ramp Stress model, Weibull distribution, and Inverse Power relationship.](#perform-cumulative-damage-analysis-using-the-ramp-stress-model-weibull-distribution-and-inverse-power-relationship)

```

// Open data table
dt = Open("$Sample_Data/Reliability/CD Ramp Stress.jmp");
// Cumulative Damage
Open(
    "$SAMPLE_DATA/Reliability/CD Ramp Stress Pattern.jmp"
);
Cumulative Damage(
    Model Type( "Ramp Stress" ),
    Time to Event Data Table(
        "CD Ramp Stress",
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID )
    ),
    Ramp Stress Pattern Data Table(
        "CD Ramp Stress Pattern",
        Intercept( :intercept ),
        Slope( :slope ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Weibull" )
);


```

### [Perform a Cumulative Damage analysis using the Sinusoid Stress model in the Reliability platform, specifying the Weibull distribution and inverse power relationship for the failure data.](#perform-a-cumulative-damage-analysis-using-the-sinusoid-stress-model-in-the-reliability-platform-specifying-the-weibull-distribution-and-inverse-power-relationship-for-the-failure-data)

```

// Open data table
dt = Open("$Sample_Data/Reliability/CD Sinusoid Stress.jmp");
// Cumulative Damage
Open(
    "$SAMPLE_DATA/Reliability/CD Sinusoid Stress Pattern.jmp"
);
Cumulative Damage(
    Model Type( "Sinusoid Stress" ),
    Time to Event Data Table(
        "CD Sinusoid Stress",
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID )
    ),
    Sinusoid Stress Pattern Data Table(
        "CD Sinusoid Stress Pattern",
        Level( :level ),
        Amplitude( :amplitude ),
        Period( :period ),
        Phase( :phase ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Weibull" )
);


```

### [Perform cumulative damage analysis using step stress modeling with an inverse power relationship and Weibull distribution.](#perform-cumulative-damage-analysis-using-step-stress-modeling-with-an-inverse-power-relationship-and-weibull-distribution)

```

// Open data table
dt = Open("$Sample_Data/Reliability/CD Step Stress.jmp");
// Cumulative Damage
Open(
    "$SAMPLE_DATA/Reliability/CD Step Stress Pattern.jmp"
);
Cumulative Damage(
    Model Type( "Step Stress" ),
    Time to Event Data Table(
        "CD Step Stress",
        Time to Event( :Time ),
        Censor( :Censor ),
        Pattern ID( :Pattern ID )
    ),
    Step Stress Pattern Data Table(
        "CD Step Stress Pattern",
        Stress Duration( :Duration ),
        Stress( :Stress ),
        Pattern ID( :Pattern ID )
    ),
    Relationship( "Inverse Power" ),
    Distribution( "Weibull" ),
    Pattern Continuation( "Terminate" )
);


```

### [Split the Y variable by Quadrant in the Wafer Quadrants data set and fit a Standard Least Squares regression model to the resulting subsets, adjusting for the Layout effect.](#split-the-y-variable-by-quadrant-in-the-wafer-quadrants-data-set-and-fit-a-standard-least-squares-regression-model-to-the-resulting-subsets-adjusting-for-the-layout-effect)

```

// Open data table
dt = Open("$Sample_Data/Wafer Quadrants.jmp");
// Split Y by Quadrant
dt = Split(
    Split By( :Quadrant ),
    Split( :Y ),
    Remaining Columns(
        Keep( :Wafer ID, :Layout )
    ),
    Sort by Column Property
);
dt <<
New Script(
    "Model",
    Fit Model(
        Y(
            :"High, High"n, :"High, Low"n,
            :"Low, High"n, :"Low, Low"n
        ),
        Effects( :Layout ),
        Keep dialog open( 1 ),
        Personality(
            "Standard Least Squares"
        ),
        Emphasis( "Minimal Report" )
    )
);


```

### [Analyze the distribution of GDP per Capita for multiple countries using continuous and histogram distribution plots.](#analyze-the-distribution-of-gdp-per-capita-for-multiple-countries-using-continuous-and-histogram-distribution-plots)

```

// Open data table
dt = Open("$Sample_Data/World Demographics.jmp");
// Distribution: GDP per Capita
Distribution(
    Continuous Distribution(
        Column( :GDP per Capita ),
        Vertical( 0 )
    ),
    SendToReport(
        Dispatch( {"GDP per Capita"},
            "Distrib Outlier Box",
            FrameBox,
            {Frame Size( 208, 76 ),
            Marker Size( 2 ),
            DispatchSeg(
                Marker Seg( 1 ),
                label offset(
                    {5, -68, -27},
                    {6, -29, 38},
                    {7, 17, 29},
                    {8, -72, -26}
                )
            )}
        ),
        Dispatch( {"GDP per Capita"},
            "Distrib Histogram", FrameBox,
            {Frame Size( 208, 82 )}
        )
    )
);


```

# [Fit Model](#fit-model)

More examples for this topic using the sample data files provided with JMP

### [Build a gaussian process model](#build-a-gaussian-process-model)

```

// Open data table
dt = Open("$Sample_Data/2D Gaussian Process Example.jmp");
// Model
Gaussian Process(
    Y( :Y ),
    X( :X1, :X2 )
);


```

### [Fit a standard least squares model using frequency](#fit-a-standard-least-squares-model-using-frequency)

```

// Open data table
dt = Open("$Sample_Data/Bacteria.jmp");
// Fit Model Report
Fit Model(
    Freq( :Relative Sizes ),
    Y( :Group Means ),
    Effects( :Group ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Run(
        :Group Means << {{:Group << {}}}
    )
);


```

### [Generate a standard least squares model with a prediction profiler, a normal plot and a pareto plot of estimates](#generate-a-standard-least-squares-model-with-a-prediction-profiler-a-normal-plot-and-a-pareto-plot-of-estimates)

```

// Open data table
dt = Open("$Sample_Data/Bicycle.jmp");
// Fit Model
Fit Model(
    Y( :Y ),
    Effects(
        :HBars, :Dynamo, :Seat, :Tires,
        :Gear, :Raincoat, :Brkfast
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        Profiler( 1 ),
        Y << {Normal Plot( 1 ),
        Pareto Plot( 1 )}
    )
);


```

### [Fit a logistic regression model](#fit-a-logistic-regression-model)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Logistic
Logistic( Y( :age ), X( :weight ) );


```

### [Generate a standard least squares model](#generate-a-standard-least-squares-model)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Fit Model
Fit Model(
    Y( :weight ),
    Effects( :age, :sex, :height ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        :weight <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Fit a manova model](#fit-a-manova-model)

```

// Open data table
dt = Open("$Sample_Data/Blood Pressure.jmp");
// Fit Model
Fit Model(
    Y(
        :BP 8M, :BP 12M, :BP 6M, :BP 8W,
        :BP 12W, :BP 6W, :BP 8F, :BP 12F,
        :BP 6F
    ),
    Effects( :Subject, :Dose ),
    Personality( "Manova" ),
    Run
);


```

### [Fit a standard least squares model with a box cox transformation](#fit-a-standard-least-squares-model-with-a-box-cox-transformation)

```

// Open data table
dt = Open("$Sample_Data/BoxCox.jmp");
// Fit Model
Fit Model(
    Y( :y ),
    Effects(
        :load, :flow, :load * :flow,
        :speed, :load * :speed,
        :flow * :speed, :mud,
        :load * :mud, :flow * :mud,
        :speed * :mud
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run( Box Cox Y Transformation( 1 ) )
);


```

### [Generate an ordinal logistic model](#generate-an-ordinal-logistic-model)

```

// Open data table
dt = Open("$Sample_Data/Cheese.jmp");
// Fit Model
Fit Model(
    Freq( :Count ),
    Y( :Response ),
    Effects( :Cheese ),
    Personality( "Ordinal Logistic" ),
    Run
);


```

### [Generate discriminant analysis](#generate-discriminant-analysis)

```

// Open data table
dt = Open("$Sample_Data/Cherts.jmp");
// Discriminant
Discriminant(
    X( :location name ),
    Y(
        :Al, :Mn, :Na, :Br, :Ce, :Co, :Cr,
        :Cs, :Eu, :Fe, :Hf, :La, :Sc, :Sm,
        :U
    ),
    Show Classification Counts( 1 )
);


```

### [Fit a manova model](#fit-a-manova-model_1)

```

// Open data table
dt = Open("$Sample_Data/Cholesterol.jmp");
// Fit Model
Fit Model(
    Y(
        :April AM, :April PM, :May AM,
        :May PM, :June AM, :June PM
    ),
    Effects( :treatment ),
    Personality( "Manova" ),
    Run
);


```

### [Generate a generalized linear model with a poisson distribution and log link function](#generate-a-generalized-linear-model-with-a-poisson-distribution-and-log-link-function)

```

// Open data table
dt = Open("$Sample_Data/CrabSatellites.jmp");
// Model
Fit Model(
    Y( :satell ),
    Effects(
        :color, :spine, :width, :weight
    ),
    Center Polynomials( 0 ),
    Personality(
        "Generalized Linear Model"
    ),
    GLM Distribution( "Poisson" ),
    Link Function( "Log" )
);


```

### [Build a manova model](#build-a-manova-model)

```

// Open data table
dt = Open("$Sample_Data/Crops.jmp");
// Manova
Fit Model(
    Y( :S1, :S3 ),
    Effects( :CROP ),
    Personality( "Manova" ),
    Run
);


```

### [Fit a standard least squares model with interaction terms](#fit-a-standard-least-squares-model-with-interaction-terms)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/2x3x4 Factorial.jmp");
// Model
Fit Model(
    Effects(
        :X1, :X2, :X3, :X1 * :X2,
        :X1 * :X3, :X2 * :X3
    ),
    Y( :Y ),
    PERSONALITY( Standard Least Squares )
);


```

### [Fit a mixed model with whole plots and subplots](#fit-a-mixed-model-with-whole-plots-and-subplots)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Battery Data.jmp");
// Model
Fit Model(
    Effects(
        :Whole Plots & Random,
        :Subplots & Random, :A1, :A2, :A3,
        :A4, :C1, :C2, :A1 * :A2,
        :A1 * :A3, :A1 * :A4, :A1 * :C1,
        :A1 * :C2, :A2 * :A3, :A2 * :A4,
        :A2 * :C1, :A2 * :C2, :A3 * :A4,
        :A3 * :C1, :A3 * :C2, :A4 * :C1,
        :A4 * :C2, :C1 * :C2
    ),
    Y( :OCV )
);


```

### [Fit a standard least squares model with REML estimation using specified random effects and interactions for OCV in the Battery Data dataset.](#fit-a-standard-least-squares-model-with-reml-estimation-using-specified-random-effects-and-interactions-for-ocv-in-the-battery-data-dataset)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Battery Data.jmp");
// Reduced Model 2
Fit Model(
    Y( :OCV ),
    Effects(
        :Whole Plots & Random,
        :Subplots & Random, :A1, :A2, :A4,
        :C1, :C2, :A1 * C1, :A1 * C2,
        :A2 * C1, :A4 * C2
    ),
    Keep dialog open( 1 ),
    Personality(
        "Standard Least Squares"
    ),
    Method( "REML" )
);


```

### [Fit a Gaussian Process model to predict the response variable using several predictor variables in a Design of Experiments (DOE) context.](#fit-a-gaussian-process-model-to-predict-the-response-variable-using-several-predictor-variables-in-a-design-of-experiments-doe-context)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Borehole Sphere Packing.jmp");
// Model (GP from DOE)
Gaussian Process(
    Y( :Y ),
    X(
        :log10 Rw, :log10 R, :Tu, :Tl,
        :Hu, :Hl, :L, :Kw
    )
);


```

### [Fit a standard least squares linear regression model with multiple interaction terms between silica, sulfur, and silane, using stretch as the response variable.](#fit-a-standard-least-squares-linear-regression-model-with-multiple-interaction-terms-between-silica-sulfur-and-silane-using-stretch-as-the-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Bounce Data.jmp");
// Model
Fit Model(
    Effects(
        :Silica & RS, :Sulfur & RS,
        :Silane & RS, :Silica * :Sulfur,
        :Silica * :Silane,
        :Sulfur * :Silane,
        :Silica * :Silica,
        :Sulfur * :Sulfur,
        :Silane * :Silane
    ),
    Y( :Stretch ),
    PERSONALITY(
        "Standard Least Squares"
    )
);


```

### [Analyze design experiment by evaluating factor effects for grind, temperature, time, charge, and station using the Evaluate Design function in the DOE platform.](#analyze-design-experiment-by-evaluating-factor-effects-for-grind-temperature-time-charge-and-station-using-the-evaluate-design-function-in-the-doe-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Coffee Data.jmp");
// Evaluate Design
DOE(
    Evaluate Design,
    X(
        :Grind, :Temperature, :Time,
        :Charge, :Station
    )
);


```

### [Fit a standard least squares regression model using the Strength variable as the response and Time, Charge, and Station as the predictors.](#fit-a-standard-least-squares-regression-model-using-the-strength-variable-as-the-response-and-time-charge-and-station-as-the-predictors)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Coffee Data.jmp");
// Reduced Model
Fit Model(
    Y( :Strength ),
    Effects( :Time, :Charge, :Station ),
    Keep dialog open( 1 ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Screening" )
);


```

### [Fit a standard least squares regression model with multiple effects and interactions.](#fit-a-standard-least-squares-regression-model-with-multiple-effects-and-interactions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/DOE Example 1.jmp");
// Model
Fit Model(
    Effects(
        :Operator, :Speed, :Current,
        :Operator * :Speed,
        :Operator * :Current,
        :Speed * :Current
    ),
    Y( :Depth ),
    PERSONALITY(
        "Standard Least Squares"
    )
);


```

### [Generate a full factorial mixture experiment model using the Fit Model function with specified effects.](#generate-a-full-factorial-mixture-experiment-model-using-the-fit-model-function-with-specified-effects)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Donev Mixture Data.jmp");
// Model
Fit Model(
    Effects(
        :CuSO4 & RS & Mixture,
        :Na2S2O3 & RS & Mixture,
        :Glyoxal & RS & Mixture,
        :CuSO4 * :Na2S2O3,
        :CuSO4 * :Glyoxal,
        :CuSO4 * :Wavelength,
        :Na2S2O3 * :Glyoxal,
        :Na2S2O3 * :Wavelength,
        :Glyoxal * :Wavelength
    ),
    Y( :Damping ),
    No Intercept( 1 )
);


```

### [Perform Definitive Screening Analysis with Response Variable Yield and Eight Predictor Variables.](#perform-definitive-screening-analysis-with-response-variable-yield-and-eight-predictor-variables)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction2 Data.jmp");
// Fit Definitive Screening
Fit Definitive Screening(
    Y( :Yield ),
    X(
        :Lot, :Methanol, :Ethanol,
        :Propanol, :Butanol, :pH, :Time
    )
);


```

### [Generate a Definitive Screening Design to identify significant factors affecting yield in an extraction process.](#generate-a-definitive-screening-design-to-identify-significant-factors-affecting-yield-in-an-extraction-process)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction3 Data.jmp");
// Fit Definitive Screening
Fit Definitive Screening(
    X(
        :Lot, :Methanol, :Ethanol,
        :Propanol, :Butanol, :pH, :Time
    ),
    Y( :Yield )
);


```

### [Fit a multiple regression model using the Fit Model platform .](#fit-a-multiple-regression-model-using-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Metacrate Limit Of Detection DOE.jmp");
// Model
Fit Model(
    Effects(
        :Dichloromethane & RS,
        :Methanol & RS,
        :Sample Volume & RS,
        :Dichloromethane *
        :Dichloromethane,
        :Dichloromethane * :Methanol,
        :Methanol * :Methanol,
        :Dichloromethane * :Sample Volume,
        :Methanol * :Sample Volume,
        :Sample Volume * :Sample Volume
    ),
    Y( :Metacrate )
);


```

### [Fit a two-part mixed effect model using the Fit Model function to analyze the effects of brand, time, and power on the number of popped and total kernels in popcorn.](#fit-a-two-part-mixed-effect-model-using-the-fit-model-function-to-analyze-the-effects-of-brand-time-and-power-on-the-number-of-popped-and-total-kernels-in-popcorn)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Popcorn DOE Results.jmp");
// Model
Fit Model(
    Effects(
        :Brand, :Time, :Power,
        :Brand * :Time, :Brand * :Power,
        :Time * :Power, :Time * :Time,
        :Power * :Power
    ),
    Y( :Number Popped ),
    Y( :Total Kernels )
);


```

### [Perform a nonlinear regression model using the `Nonlinear` function.](#perform-a-nonlinear-regression-model-using-the-nonlinear-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reaction Kinetics.jmp");
// Model
Nonlinear(
    Y( :Observed Yield ),
    X( :Yield Model )
);


```

### [Fit a complex linear model with multiple effects and interactions to predict the chemical reaction yield.](#fit-a-complex-linear-model-with-multiple-effects-and-interactions-to-predict-the-chemical-reaction-yield)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 20 Custom.jmp");
// Model
Fit Model(
    Effects(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration,
        :Feed Rate * :Catalyst,
        :Feed Rate * :Stir Rate,
        :Feed Rate * :Temperature,
        :Feed Rate * :Concentration,
        :Catalyst * :Stir Rate,
        :Catalyst * :Temperature,
        :Catalyst * :Concentration,
        :Stir Rate * :Temperature,
        :Stir Rate * :Concentration,
        :Temperature * :Concentration
    ),
    Y( :Percent Reacted )
);


```

### [Fit a reduced general linear model with interactions between catalyst, temperature, and concentration to predict percent reacted.](#fit-a-reduced-general-linear-model-with-interactions-between-catalyst-temperature-and-concentration-to-predict-percent-reacted)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 20 Custom.jmp");
// Reduced Model
Fit Model(
    Y( :Percent Reacted ),
    Effects(
        :Catalyst, :Temperature,
        :Concentration,
        :Catalyst * :Temperature,
        :Temperature * :Concentration
    ),
    Personality(
        "Standard Least Squares"
    )
);


```

### [Fit a standard least squares multiple regression model with interactions between feed rate, catalyst, stir rate, temperature, and concentration to predict percent reacted.](#fit-a-standard-least-squares-multiple-regression-model-with-interactions-between-feed-rate-catalyst-stir-rate-temperature-and-concentration-to-predict-percent-reacted)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 8 Runs.jmp");
// Model
Fit Model(
    Effects(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration,
        :Feed Rate * :Catalyst,
        :Feed Rate * :Stir Rate
    ),
    Y( :Percent Reacted ),
    PERSONALITY(
        "Standard Least Squares"
    )
);


```

### [Build a decision tree to predict a binary outcome using specified independent variables, including initial splits and validation settings.](#build-a-decision-tree-to-predict-a-binary-outcome-using-specified-independent-variables-including-initial-splits-and-validation-settings)

```

// Open data table
dt = Open("$Sample_Data/Diabetes.jmp");
// Decision Tree of Y Binary
Partition(
    Y( :Y Binary ),
    X(
        :Age, :Gender, :BMI, :BP,
        :Total Cholesterol, :LDL, :HDL,
        :TCH, :LTG, :Glucose
    ),
    Validation( :Validation ),
    Split History( 1 ),
    Informative Missing( 1 ),
    Initial Splits(
        :LTG >= 4.6444,
        {:BMI >= 32.3, {}, {:LTG >=
        5.3423}},
        {:BP >= 102}
    )
);


```

### [Fit a neural network model for binary classification using specified input variables and a tanh activation function.](#fit-a-neural-network-model-for-binary-classification-using-specified-input-variables-and-a-tanh-activation-function)

```

// Open data table
dt = Open("$Sample_Data/Diabetes.jmp");
// Neural of Y Binary
Neural(
    Y( :Y Binary ),
    X(
        :Age, :Gender, :BMI, :BP,
        :Total Cholesterol, :LDL, :HDL,
        :TCH, :LTG, :Glucose
    ),
    Validation( :Validation ),
    Informative Missing( 0 ),
    Set Random Seed( 1234 ),
    Fit( NTanH( 3 ) )
);


```

### [Analyze and Fit a Curve of Dissolution with Respect to Time, Including a Grouping by Batch and Utilizing F2 Analysis with Bootstrapping.](#analyze-and-fit-a-curve-of-dissolution-with-respect-to-time-including-a-grouping-by-batch-and-utilizing-f2-analysis-with-bootstrapping)

```

// Open data table
dt = Open("$Sample_Data/Dissolution DoE Verification Runs.jmp");
// Fit Curve of Dissolution by Time
Fit Curve(
    Y( :Dissolution ),
    X( :Time ),
    Group( :Batch ),
    F2 Analysis(
        Unit ID( :Tablet in Batch ),
        Alpha( 0.1 ),
        Reference Level( "Reference" ),
        Bootstrap Samples( 2500 )
    )
);


```

### [Fit a generalized linear model using the Fit Model platform with specified effects and without an intercept term.](#fit-a-generalized-linear-model-using-the-fit-model-platform-with-specified-effects-and-without-an-intercept-term)

```

// Open data table
dt = Open("$Sample_Data/Dissolution DoE.jmp");
// Model
Fit Model(
    Effects(
        :Polymer A & Mixture,
        :Polymer B & Mixture,
        :Polymer A * :Total Polymer,
        :Polymer A * :Compression Force,
        :Polymer B * :Total Polymer,
        :Polymer B * :Compression Force,
        :Total Polymer *
        :Compression Force
    ),
    Y( :Dissolution 60 ),
    No Intercept( 1 )
);


```

### [Perform a bivariate analysis fitting LogHist1 as the response variable and LogHist0 as the explanatory variable using the Bivariate platform.](#perform-a-bivariate-analysis-fitting-loghist1-as-the-response-variable-and-loghist0-as-the-explanatory-variable-using-the-bivariate-platform)

```

// Open data table
dt = Open("$Sample_Data/Dogs.jmp");
// Fit LogHist1 By LogHist0
Bivariate(
    Y( :LogHist1 ),
    X( :LogHist0 )
);


```

### [Fit a generalized linear model with separate slopes for different levels of a categorical variable using the standard least squares personality in the Fit Model platform.](#fit-a-generalized-linear-model-with-separate-slopes-for-different-levels-of-a-categorical-variable-using-the-standard-least-squares-personality-in-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Drug.jmp");
// Fit Model-separate slopes
Fit Model(
    Y( :y ),
    Effects( :Drug, :x, :Drug * :x ),
    Personality(
        "Standard Least Squares"
    ),
    Run
);


```

### [Fit a linear mixed model with multiple fixed effects and interactions using the Fit Model platform.](#fit-a-linear-mixed-model-with-multiple-fixed-effects-and-interactions-using-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Functional Data/Mill DOE.jmp");
// Model
Fit Model(
    Effects(
        :"%Beads"n, :"%Strength"n,
        :"Flow(g/min)"n, :"T(ºC)"n,
        :"%Beads"n * :"%Strength"n,
        :"%Beads"n * :"Flow(g/min)"n,
        :"%Beads"n * :"T(ºC)"n,
        :"%Strength"n * :"Flow(g/min)"n,
        :"%Strength"n * :"T(ºC)"n,
        :"Flow(g/min)"n * :"T(ºC)"n,
        :"%Beads"n * :"%Beads"n,
        :"%Strength"n * :"%Strength"n,
        :"Flow(g/min)"n * :"Flow(g/min)"n,
        :"T(ºC)"n * :"T(ºC)"n
    ),
    Y( :"Size/nm"n )
);


```

### [Analyze durability data using a oneway ANOVA to compare means across brands in the Golf Balls dataset.](#analyze-durability-data-using-a-oneway-anova-to-compare-means-across-brands-in-the-golf-balls-dataset)

```

// Open data table
dt = Open("$Sample_Data/Golf Balls.jmp");
// Oneway: Durability by Brand
Oneway(
    Y( :Durability ),
    X( :Brand ),
    Mean Lines( 1 ),
    Connect Means( 1 ),
    Grand Mean( 0 )
);


```

### [Fit a Stepwise Regression Model with Interaction Terms](#fit-a-stepwise-regression-model-with-interaction-terms)

```

// Open data table
dt = Open("$Sample_Data/Hot Dogs2.jmp");
// Fit Model
Fit Model(
    Y( :"$/oz"n ),
    Effects(
        :Type, :Size, :Type * :Size
    ),
    Personality( "Stepwise" ),
    Run
);


```

### [Perform an Oneway analysis with Height as the response variable and Gender as the factor, displaying the means and mean diamonds on the plot.](#perform-an-oneway-analysis-with-height-as-the-response-variable-and-gender-as-the-factor-displaying-the-means-and-mean-diamonds-on-the-plot)

```

// Open data table
dt = Open("$Sample_Data/Htwt12.jmp");
// Oneway
Oneway(
    Y( :Height ),
    X( :Gender ),
    Means( 1 ),
    Box Plots( 0 ),
    Mean Diamonds( 1 )
);


```

### [Perform discriminant analysis to classify species based on sepal and petal measurements using the Iris dataset.](#perform-discriminant-analysis-to-classify-species-based-on-sepal-and-petal-measurements-using-the-iris-dataset)

```

// Open data table
dt = Open("$Sample_Data/Iris.jmp");
// Discriminant
Discriminant(
    X( :Species ),
    Y(
        :Sepal length, :Sepal width,
        :Petal length, :Petal width
    )
);


```

### [Perform a multiple linear regression analysis using the Standard Least Squares personality.](#perform-a-multiple-linear-regression-analysis-using-the-standard-least-squares-personality)

```

// Open data table
dt = Open("$Sample_Data/Longley.jmp");
// Fit Model
Fit Model(
    Y( :y ),
    Effects(
        :x1, :x2, :x3, :x4, :x5, :x6
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Leverage" ),
    Run
);


```

### [Create a loss function template for a Tobit model with a single predictor and standard error parameter.](#create-a-loss-function-template-for-a-tobit-model-with-a-single-predictor-and-standard-error-parameter)

```

// Tobit1.jsl
///////////////////////////////////////////////////////////////////////////////////////////////////////////
// JSL to create a loss function template of Tobit1                          //
///////////////////////////////////////////////////////////////////////////////////////////////////////////

dt= new table ("Tobit1");
dt<<New Column("Y", Numeric,continuous);   
dt<<New Column("Model", Numeric,continuous);
dt<<New Column("Tobit Loss", Numeric,continuous);

column( "Model") << formula( Parameter({b0=0, b1=0, b2=0},  :y-(b0+b1*Empty()+b2*Empty()))  );
column( "Tobit Loss") << formula( Parameter({Sigma=1}, -IfMZ( :y==0, Log(1-Normal Distribution(- :Model/Sigma)), (-Log(Sigma))-0.5*( :Model/Sigma)^2-0.5*Log(2*Pi()))) );


```

### [Create a loss function template for a Weibull distribution with one parameter.](#create-a-loss-function-template-for-a-weibull-distribution-with-one-parameter)

```

// Weibull, 1 Parm.jsl
///////////////////////////////////////////////////////////////////////////////////////////////////////////
// JSL to create a loss function template of Weibull, 1 Parm          //
///////////////////////////////////////////////////////////////////////////////////////////////////////////

dt= new table ("Weibull, 1 Parm");
dt<<New Column("Censor", Numeric,continuous);   
dt<<New Column("Model", Numeric,continuous);
dt<<New Column("Weibull", Numeric,continuous);

column( "Model") << formula( Parameter({b0=3.93988152926993, b1=0.004505313558698, b2=-0.01244813868867}, Log(Empty())-(b0+b1*Empty()+b2*Empty()))  );
column( "Weibull") << formula( Parameter({sigma=0.928115276636918}, -IfMZ( :Censor==0,  :Model/sigma-Exp( :Model/sigma)-Log(sigma), -Exp( :Model/sigma)))  );


```

### [Perform a one-way ANOVA analysis on the variables Count1 and Count2 using the Brand variable as the classifier, and generate pairwise comparisons using Student's t-test and Hsu-MCB method.](#perform-a-one-way-anova-analysis-on-the-variables-count1-and-count2-using-the-brand-variable-as-the-classifier-and-generate-pairwise-comparisons-using-students-t-test-and-hsu-mcb-method)

```

// Open data table
dt = Open("$Sample_Data/Membrane.jmp");
// Oneway
Oneway(
    Y( :Count1, :Count2 ),
    X( :Brand ),
    Anova( 1 ),
    Student's t( 1 ),
    Hsu MCB( 1 )
);


```

### [Fit a reduced nonlinear model with equal alphas for algae density.](#fit-a-reduced-nonlinear-model-with-equal-alphas-for-algae-density)

```

// Open data table
dt = Open("$Sample_Data/Nonlinear Examples/Algae Mitscherlich.jmp");
// Reduced nonlinear model-with equal alphas
Nonlinear(
    Y( :Algae density ),
    X( :equal alphas ),
    Finish
);


```

### [Create a nonlinear regression model to analyze algae density using the Algae Mitscherlich dataset with equal betas.](#create-a-nonlinear-regression-model-to-analyze-algae-density-using-the-algae-mitscherlich-dataset-with-equal-betas)

```

// Open data table
dt = Open("$Sample_Data/Nonlinear Examples/Algae Mitscherlich.jmp");
// Reduced nonlinear model-with equal betas
Nonlinear(
    Y( :Algae density ),
    X( :equal betas ),
    Finish
);


```

### [Fit a nonlinear Meyers Model to the given dataset using the Newton method.](#fit-a-nonlinear-meyers-model-to-the-given-dataset-using-the-newton-method)

```

// Open data table
dt = Open("$Sample_Data/Nonlinear Examples/Chemical Kinetics.jmp");
// Meyers Model Fit
Nonlinear(
    Y( :"Velocity (y)"n ),
    X( :"Model (x)"n ),
    Newton,
    Finish
);


```

### [Perform a nonlinear analysis with the response variable designated as Model2 Y and the loss function specified as Loss2, utilizing gradient-based optimization techniques and Newton's method.](#perform-a-nonlinear-analysis-with-the-response-variable-designated-as-model2-y-and-the-loss-function-specified-as-loss2-utilizing-gradient-based-optimization-techniques-and-newtons-method)

```

// Open data table
dt = Open("$Sample_Data/Nonlinear Examples/Logistic w Loss.jmp");
// Nonlinear with Model2 Y and Loss2
Nonlinear(
    X( :Model2 Y ),
    Loss( :Loss2 ),
    Relative Gradient( 0.000000001 ),
    Gradient Limit( 0.000000001 ),
    CL Limit( 0.00000001 ),
    Numeric Derivatives Only( 1 ),
    Loss is Neg LogLikelihood( 1 ),
    Newton,
    Finish,
    Plot( 0 )
);


```

### [Perform a one-way analysis of variance with nonparametric tests on the Gain variable while grouping data by the Dose variable using the Wilcoxon Test, Median Test, and van der Waerden Test.](#perform-a-one-way-analysis-of-variance-with-nonparametric-tests-on-the-gain-variable-while-grouping-data-by-the-dose-variable-using-the-wilcoxon-test-median-test-and-van-der-waerden-test)

```

// Open data table
dt = Open("$Sample_Data/Nonparametric.jmp");
// Oneway with NP Tests
Oneway(
    Y( :Gain ),
    X( :Dose ),
    Wilcoxon Test( 1 ),
    Median Test( 1 ),
    van der Waerden Test( 1 )
);


```

### [Fit a generalized linear model using the Normal distribution and Log link function.](#fit-a-generalized-linear-model-using-the-normal-distribution-and-log-link-function)

```

// Open data table
dt = Open("$Sample_Data/Nor.jmp");
// Model
Fit Model(
    Y( :Y ),
    Effects( :X ),
    Personality(
        "Generalized Linear Model"
    ),
    GLM Distribution( "Normal" ),
    Link Function( "Log" ),
    Overdispersion Tests and Intervals(
        1
    )
);


```

### [Fit a multiple regression model using standard least squares personality to predict odor based on temperature, glucose ratio, and height, including their interactions.](#fit-a-multiple-regression-model-using-standard-least-squares-personality-to-predict-odor-based-on-temperature-glucose-ratio-and-height-including-their-interactions)

```

// Open data table
dt = Open("$Sample_Data/Odor.jmp");
// Model
Fit Model(
    Effects(
        temp & RS, gl ratio & RS, ht & RS,
        temp * gl ratio, temp * ht,
        gl ratio * ht, temp * temp,
        gl ratio * gl ratio, ht * ht
    ),
    Y( :odor ),
    Personality(
        "Standard Least Squares"
    )
);


```

### [Fit a linear regression model using the Fit Model platform .](#fit-a-linear-regression-model-using-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Polycity.jmp");
// Fit Model with Linear Fit
Fit Model(
    Y( :OZONE ),
    Effects( :POP ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Leverage" ),
    Run(
        :OZONE << {Lack of Fit( 0 ),
        Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Fit a full factorial model with interaction effects for popcorn yield, popcorn type, oil amount, batch, and their interactions.](#fit-a-full-factorial-model-with-interaction-effects-for-popcorn-yield-popcorn-type-oil-amount-batch-and-their-interactions)

```

// Open data table
dt = Open("$Sample_Data/Popcorn.jmp");
// Full Factorial Model
Fit Model(
    Y( :yield ),
    Effects(
        :popcorn, :oil amt,
        :popcorn * :oil amt, :batch,
        :popcorn * :batch,
        :oil amt * :batch,
        :popcorn * :oil amt * :batch
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run
);


```

### [Perform a destructive degradation analysis using the Destructive Degradation() function with multiple models and control methods.](#perform-a-destructive-degradation-analysis-using-the-destructive-degradation-function-with-multiple-models-and-control-methods)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Adhesive Bond.jmp");
// Destructive Degradation Fit
Destructive Degradation(
    Y( :Strength ),
    Time( :Weeks ),
    Censor( :Censor ),
    X( :Degrees ),
    Censor Code( "Right" ),
    Model(
        "Log10", "Sqrt", "Normal",
        "Individual Path with Intercept"
    ),
    Control(
        "Log10", "Sqrt", "Normal",
        "Individual Path with Intercept"
    )
);


```

### [Fit a proportional hazards model to analyze device lifetimes, including effects of average load, average moisture, average vibration, average solar exposure, and location coordinates, while accounting for censoring.](#fit-a-proportional-hazards-model-to-analyze-device-lifetimes-including-effects-of-average-load-average-moisture-average-vibration-average-solar-exposure-and-location-coordinates-while-accounting-for-censoring)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Device X Lifetimes.jmp");
// Fit Proportional Hazards
Fit Model(
    Y( :Usage Hours ),
    Effects(
        :Avg Load, :Avg Moisture,
        :Avg Vibration,
        :Avg Solar Exposure, :Location X,
        :Location Y
    ),
    Personality( "Proportional Hazard" ),
    Censor( :Censor ),
    Censor Code( "1" ),
    Run( Likelihood Ratio Tests( 1 ) )
);


```

### [Fit a parametric survival model with a LogNormal distribution for two continuous response variables YLow and YHigh, considering age and liquidity as predictors using the Fit Model platform .](#fit-a-parametric-survival-model-with-a-lognormal-distribution-for-two-continuous-response-variables-ylow-and-yhigh-considering-age-and-liquidity-as-predictors-using-the-fit-model-platform)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Tobit2.jmp");
// Model
Fit Model(
    Y( :YLow, :YHigh ),
    Effects( :age, :liquidity ),
    Personality( "Parametric Survival" ),
    Distribution( LogNormal )
);


```

### [Fit a parametric survival model using the LogNormal distribution and include effects for 'age' and 'liquidity'.](#fit-a-parametric-survival-model-using-the-lognormal-distribution-and-include-effects-for-age-and-liquidity)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Tobit2.jmp");
// Fit Parametric Survival
Fit Model(
    Y( :YLow, :YHigh ),
    Effects( :age, :liquidity ),
    Personality( "Parametric Survival" ),
    Distribution( LogNormal ),
    Run( Likelihood Ratio Tests( 1 ) )
);


```

### [Fit a standard least squares regression model with aperture, ranging, and cadence as predictors for yield.](#fit-a-standard-least-squares-regression-model-with-aperture-ranging-and-cadence-as-predictors-for-yield)

```

// Open data table
dt = Open("$Sample_Data/Ro.jmp");
// Regression Model
Fit Model(
    Y( :Yield ),
    Effects(
        :Aperture, :Ranging, :Cadence
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run
);


```

### [Fit a main effects model with interaction terms using the Fit Model function and specify the dependent variable and effects in the script.](#fit-a-main-effects-model-with-interaction-terms-using-the-fit-model-function-and-specify-the-dependent-variable-and-effects-in-the-script)

```

// Open data table
dt = Open("$Sample_Data/S4 Temps.jmp");
// Main Effects Model
Fit Model(
    Effects(
        :day & Random, :time of day,
        :thermometer, :outside temp,
        :type of space, :east or west,
        :sector, :wing, :volunteer,
        :outside conditions
    ),
    Y( :fahrenheit )
);


```

### [Perform a one-way ANOVA analysis on temperature data across different offices .](#perform-a-one-way-anova-analysis-on-temperature-data-across-different-offices)

```

// Open data table
dt = Open("$Sample_Data/S4 Temps.jmp");
// Oneway - Offices
Oneway(
    Y( :fahrenheit ),
    X( :"room/office"n ),
    SendToReport(
        Dispatch( {}, "Oneway Plot",
            FrameBox,
            {
            Marker Selection Mode(
                "Selected Haloed"
            )}
        )
    )
);


```

### [Fit nonlinear Poisson regression using the Newton-Raphson method.](#fit-nonlinear-poisson-regression-using-the-newton-raphson-method)

```

// Open data table
dt = Open("$Sample_Data/Ship Damage.jmp");
// Nonlinear
Nonlinear(
    X( :model ),
    Loss( :Poisson ),
    Loss is Neg LogLikelihood( 1 ),
    Newton,
    Finish,
    Plot( 0 )
);


```

### [Fit a Nominal Logistic regression model with multiple predictors.](#fit-a-nominal-logistic-regression-model-with-multiple-predictors)

```

// Open data table
dt = Open("$Sample_Data/Skull.jmp");
// Fit Model
Fit Model(
    Y( :sex ),
    Effects(
        :length, :basilar, :zygomat,
        :postorb
    ),
    Personality( "Nominal Logistic" ),
    Run
);


```

### [Fit a full factorial generalized linear model to predict tool wear.](#fit-a-full-factorial-generalized-linear-model-to-predict-tool-wear)

```

// Open data table
dt = Open("$Sample_Data/Tool Wear.jmp");
// Fit Model: Full Factorial Specification
Fit Model(
    Y( :Wear ),
    Effects(
        :Speed, :Angle, :Speed * :Angle,
        :Material, :Speed * :Material,
        :Angle * :Material,
        :Speed * :Angle * :Material
    ),
    Personality(
        "Standard Least Squares"
    )
);


```

### [Fit a proportional hazards model with specified categorical and continuous covariates, including risk ratios for interpretation.](#fit-a-proportional-hazards-model-with-specified-categorical-and-continuous-covariates-including-risk-ratios-for-interpretation)

```

// Open data table
dt = Open("$Sample_Data/VA Lung Cancer.jmp");
// Fit Proportional Hazards
Fit Model(
    Y( :Time ),
    Effects(
        :Cell Type, :Treatment, :Prior,
        :Age, :Diag Time, :KPS
    ),
    Personality( "Proportional Hazard" ),
    Censor( :censor ),
    Run( Risk Ratios( 1 ) )
);


```

### [Perform one-way analysis of variance to compare the mean heights (in inches) between different sexes from the World Class.jmp dataset.](#perform-one-way-analysis-of-variance-to-compare-the-mean-heights-in-inches-between-different-sexes-from-the-world-classjmp-dataset)

```

// Open data table
dt = Open("$Sample_Data/World Class.jmp");
// Oneway
Oneway(
    Y( :"height (in.)"n ),
    X( :sex ),
    Means( 1 ),
    Mean Diamonds( 1 )
);


```

### [Fit a multiple linear regression model using the Standard Least Squares personality and display plots of actual vs. predicted, residual vs. predicted, and effect leverage.](#fit-a-multiple-linear-regression-model-using-the-standard-least-squares-personality-and-display-plots-of-actual-vs-predicted-residual-vs-predicted-and-effect-leverage)

```

// Open data table
dt = Open("$Sample_Data/World Class.jmp");
// Fit Model
Fit Model(
    Y( :"weight (lb.)"n ),
    Effects(
        :age, :sex, :"height (in.)"n
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        :"weight (lb.)"n <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Build a boosted tree model](#build-a-boosted-tree-model)

```

// Open data table
dt = Open("$Sample_Data/Bands Data.jmp");
// Boosted Tree of Banding?
Random Reset( 123 );
Boosted Tree(
    Y( :Banding? ),
    X(
        :grain screened,
        :proof on ctd ink, :blade mfg,
        :paper type, :ink type,
        :direct steam, :solvent type,
        :type on cylinder, :press type,
        :unit number, :cylinder size,
        :paper mill location,
        :plating tank, :proof cut,
        :viscosity, :caliper,
        :ink temperature, :humidity,
        :roughness, :blade pressure,
        :varnish pct, :press speed,
        :ink pct, :solvent pct,
        :ESA Voltage, :ESA Amperage, :wax,
        :hardener, :roller durometer,
        :current density,
        :anode space ratio,
        :chrome content
    ),
    Validation Portion( 0.2 ),
    Method( "Boosted Tree" ),
    Splits per Tree( 3 ),
    Number of Layers( 41 ),
    Learning Rate( 0.1 ),
    Go
);


```

### [Generate a boosted tree model with validation](#generate-a-boosted-tree-model-with-validation)

```

// Open data table
dt = Open("$Sample_Data/Body Fat.jmp");
// Boosted Tree
Boosted Tree(
    Y( :Percent body fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n,
        :"Height (inches)"n,
        :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n,
        :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n,
        :"Thigh circumference (cm)"n,
        :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n,
        :
        "Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n,
        :"Wrist circumference (cm)"n
    ),
    Validation( :Validation ),
    Method( "Boosted Tree" ),
    Splits per Tree( 3 ),
    Number of Layers( 30 ),
    Learning Rate( 0.1 ),
    Go
);


```

### [Fit a neural model boosted 100x](#fit-a-neural-model-boosted-100x)

```

// Open data table
dt = Open("$Sample_Data/Body Fat.jmp");
// Neural Boosted
Neural(
    Y( :Percent body fat ),
    X(
        :"Age (years)"n, :"Weight (lbs)"n,
        :"Height (inches)"n,
        :"Neck circumference (cm)"n,
        :"Chest circumference (cm)"n,
        :"Abdomen circumference (cm)"n,
        :"Hip circumference (cm)"n,
        :"Thigh circumference (cm)"n,
        :"Knee circumference (cm)"n,
        :"Ankle circumference (cm)"n,
        :
        "Biceps (extended) circumference (cm)"n,
        :"Forearm circumference (cm)"n,
        :"Wrist circumference (cm)"n
    ),
    Validation( :Validation ),
    Missing Value Coding( 0 ),
    Transform Covariates( 1 ),
    Fit(
        NTanH( 1 ),
        Transform Covariates( 1 ),
        Robust Fit( 1 ),
        N Boost( 100 ),
        Diagram( 1 )
    )
);


```

### [Use model comparison to compare several types of models](#use-model-comparison-to-compare-several-types-of-models)

```

// Open data table
dt = Open("$Sample_Data/Body Fat.jmp");
// Model Comparison
Model Comparison(
    Y(
        :
        "Pred Body Fat - 2nd Order Stepwise"n,
        :
        "Pred Body Fat - Variable Reduction PCA"n,
        :"Pred Body Fat - Stepwise"n,
        :"Pred Body Fat - Partition"n,
        :"Pred Body Fat - PLS"n,
        :
        "Pred Body Fat - Bootstrap Forest"n,
        :"Pred Body Fat - Boosted Tree"n,
        :
        "Pred Body Fat - Neural (3,0,0)"n,
        :
        "Pred Body Fat - Neural (4,0,0),(8,0,0)"n,
        :
        "Pred Body Fat - Boosted Neural"n,
        :
        "Pred Body Fat - Ensemble Model"n
    ),
    Where(
        Format( :Validation ) ==
        "Validation"
    )
);


```

### [Fit a model with the prediction profiler with desirability functions](#fit-a-model-with-the-prediction-profiler-with-desirability-functions)

```

// Open data table
dt = Open("$Sample_Data/Chips R Us.jmp");
// Fit Model
Fit Model(
    Y(
        :MN ckt wx, :MN ckt yz,
        :SD ckt wx, :SD ckt yz
    ),
    Effects(
        :Thickness, :PEB, :PUDDLE, :time,
        :focus
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        Profiler(
            Confidence Intervals( 1 ),
            Desirability Functions( 1 )
        ),
        :MN ckt wx <<
        {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )},
        :MN ckt yz <<
        {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )},
        :SD ckt wx <<
        {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )},
        :SD ckt yz <<
        {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )}
    )
);


```

### [Fit a standard least squares linear model to the data in the Borehole Latin Hypercube dataset, with log y as the response variable, and include specified effects and their interactions. Enhance the model with a profiler that includes confidence intervals and term value settings for effective effect screening. Plot the scaled estimates and actual by predicted values for visual analysis.](#fit-a-standard-least-squares-linear-model-to-the-data-in-the-borehole-latin-hypercube-dataset-with-log-y-as-the-response-variable-and-include-specified-effects-and-their-interactions-enhance-the-model-with-a-profiler-that-includes-confidence-intervals-and-term-value-settings-for-effective-effect-screening-plot-the-scaled-estimates-and-actual-by-predicted-values-for-visual-analysis)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Borehole Latin Hypercube.jmp");
// Fit Model
Fit Model(
    Y( :log y ),
    Effects(
        :log10 Rw, :log10 R, :Tu, :Tl,
        :Hu, :Hl, :L, :Kw, :Hu * :Hu,
        :L * :L, :Hl * :Hl, :Kw * :Kw,
        :Hl * :Hu
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Screening" ),
    Run(
        Profiler(
            1,
            Confidence Intervals( 1 ),
            Term Value(
                log10 Rw(
                    -1.06,
                    Max( -0.82 )
                ),
                log10 R( 3.35 ),
                Tu( 89335 ),
                Tl( 89.55, Min( 63.1 ) ),
                Hu( 1050 ),
                Hl( 760 ),
                L( 1400 ),
                Kw( 10950 )
            )
        ),
        :Y << {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )}
    )
);


```

### [Fit a linear regression model using the Least Squares method with multiple effects, including interactions and polynomial terms.](#fit-a-linear-regression-model-using-the-least-squares-method-with-multiple-effects-including-interactions-and-polynomial-terms)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Borehole Sphere Packing.jmp");
// Fit Model (Least Squares)
Fit Model(
    Y( :log y ),
    Effects(
        :log10 Rw, :log10 R, :Tu, :Tl,
        :Hu, :Hl, :L, :Kw, :Hu * :Hu,
        :L * :L, :Hl * :Hl, :Kw * :Kw,
        :Hl * :Hu
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Screening" ),
    Run(
        Profiler(
            1,
            Confidence Intervals( 1 ),
            Term Value(
                log10 Rw(
                    -1.06,
                    Max( -0.82 )
                ),
                log10 R( 3.35 ),
                Tu( 89335 ),
                Tl( 89.55, Min( 63.1 ) ),
                Hu( 1050 ),
                Hl( 760 ),
                L( 1400 ),
                Kw( 10950 )
            )
        ),
        :Y << {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )}
    )
);


```

### [Fit a standard least squares model to the borehole uniform dataset, focusing on effect screening with various model effects, including interactions.](#fit-a-standard-least-squares-model-to-the-borehole-uniform-dataset-focusing-on-effect-screening-with-various-model-effects-including-interactions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Borehole Uniform.jmp");
// Fit Model
Fit Model(
    Y( :log y ),
    Effects(
        :log10 Rw, :log10 R, :Tu, :Tl,
        :Hu, :Hl, :L, :Kw, :Hu * :Hu,
        :L * :L, :Hl * :Hl, :Kw * :Kw,
        :Hl * :Hu
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Screening" ),
    Run(
        Profiler(
            1,
            Confidence Intervals( 1 ),
            Term Value(
                log10 Rw(
                    -1.06,
                    Max( -0.82 )
                ),
                log10 R( 3.35 ),
                Tu( 89335 ),
                Tl( 89.55, Min( 63.1 ) ),
                Hu( 1050 ),
                Hl( 760 ),
                L( 1400 ),
                Kw( 10950 )
            )
        ),
        :Y << {Scaled Estimates( 1 ),
        Plot Actual by Predicted( 1 )}
    )
);


```

### [Perform stepwise regression analysis to identify significant effects on yield in the design experiment data.](#perform-stepwise-regression-analysis-to-identify-significant-effects-on-yield-in-the-design-experiment-data)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Extraction Data.jmp");
// Model for Stepwise
Fit Model(
    Y( :Yield ),
    Effects(
        :Methanol & RS, :Ethanol & RS,
        :Propanol & RS, :Butanol & RS,
        :pH & RS, :Time & RS,
        :Methanol * :Methanol,
        :Methanol * :Ethanol,
        :Ethanol * :Ethanol,
        :Methanol * :Propanol,
        :Ethanol * :Propanol,
        :Propanol * :Propanol,
        :Methanol * :Butanol,
        :Ethanol * :Butanol,
        :Propanol * :Butanol,
        :Butanol * :Butanol,
        :Methanol * :pH, :Ethanol * :pH,
        :Propanol * :pH, :Butanol * :pH,
        :pH * :pH, :Methanol * :Time,
        :Ethanol * :Time,
        :Propanol * :Time,
        :Butanol * :Time, :pH * :Time,
        :Time * :Time
    ),
    Personality( "Stepwise" )
);


```

### [Fit a standard least squares linear model with multiple main effects and interaction terms to analyze the relationship between reactor conditions and percent reacted.](#fit-a-standard-least-squares-linear-model-with-multiple-main-effects-and-interaction-terms-to-analyze-the-relationship-between-reactor-conditions-and-percent-reacted)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Reactor 32 Runs.jmp");
// Model
Fit Model(
    Effects(
        :Feed Rate, :Catalyst, :Stir Rate,
        :Temperature, :Concentration,
        :Feed Rate * :Catalyst,
        :Feed Rate * :Stir Rate,
        :Catalyst * :Stir Rate,
        :Feed Rate * :Temperature,
        :Catalyst * :Temperature,
        :Stir Rate * :Temperature,
        :Feed Rate * :Concentration,
        :Catalyst * :Concentration,
        :Stir Rate * :Concentration,
        :Temperature * :Concentration
    ),
    Y( :Percent Reacted ),
    PERSONALITY(
        "Standard Least Squares"
    )
);


```

### [Perform equivalence tests for the effects of different drug types on measurements using the Fit Model personality.](#perform-equivalence-tests-for-the-effects-of-different-drug-types-on-measurements-using-the-fit-model-personality)

```

// Open data table
dt = Open("$Sample_Data/Drug Measurements.jmp");
// Fit Model Equivalence Tests
Fit Model(
    Y( :Measurement ),
    Effects( :Drug Type ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Leverage" ),
    Run(
        :Measurement <<
        {Summary of Fit( 0 ),
        Analysis of Variance( 0 ),
        Parameter Estimates( 0 ),
        Lack of Fit( 0 ),
        Scaled Estimates( 0 ),
        Plot Actual by Predicted( 0 ),
        Plot Regression( 0 ),
        Plot Residual by Predicted( 1 ),
        Plot Studentized Residuals( 0 ),
        Plot Effect Leverage( 0 ),
        Plot Residual by Normal Quantiles(
            0
        ), Box Cox Y Transformation( 0 ),
        Effect Tests( 0 ),
        Multiple Comparisons(
            Effect( :Drug Type ),
            Student's t(
                1,
                All Pairwise Comparisons Scatterplot(
                    0
                ),
                Equivalence Tests( 3 )
            )
        )}
    )
);


```

### [Create a comprehensive linear model with multiple interaction terms to predict Rating based on various fishing parameters.](#create-a-comprehensive-linear-model-with-multiple-interaction-terms-to-predict-rating-based-on-various-fishing-parameters)

```

// Open data table
dt = Open("$Sample_Data/Fish Patty.jmp");
// Model
Fit Model(
    Effects(
        :Mullet & RS & Mixture,
        :Sheepshead & RS & Mixture,
        :Croaker & RS & Mixture,
        :Mullet * :Sheepshead,
        :Mullet * :Croaker,
        :Mullet * :Temperature,
        :Sheepshead * :Croaker,
        :Sheepshead * :Temperature,
        :Croaker * :Temperature,
        :Mullet * :Sheepshead * :Croaker,
        :Mullet * :Sheepshead *
        :Temperature,
        :Mullet * :Croaker * :Temperature,
        :Sheepshead * :Croaker *
        :Temperature,
        :Mullet * :Sheepshead * :Croaker
         * :Temperature
    ),
    Y( :Rating ),
    No Intercept( 1 )
);


```

### [Create a control chart for the sample label Lot with XBar and R charts, including capability analysis and histogram customization.](#create-a-control-chart-for-the-sample-label-lot-with-xbar-and-r-charts-including-capability-analysis-and-histogram-customization)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Control Chart
Control Chart(
    Sample Label( :Lot ),
    KSigma( 3 ),
    Chart Col(
        :X,
        XBar,
        R,
        Capability(
            Distribution(
                Continuous Distribution(
                    Column( :X ),
                    Quantiles( 0 ),
                    Summary Statistics(
                        0
                    ),
                    Count Axis( 1 ),
                    Outlier Box Plot( 0 ),
                    Normal Quantile Plot(
                        1
                    ),
                    Capability Analysis(
                        LSL( 107 ),
                        USL( 147 ),
                        Target( 127 ),
                        Sigma(
                            40.1484175601687
                        )
                    )
                )
            )
        )
    ),
    SendToReport(
        Dispatch( {"Distributions", "X"},
            "Distrib Histogram", FrameBox,
            {
            DispatchSeg(
                Hist Seg( 1 ),
                Histogram Color( 42 )
            )}
        )
    )
);


```

### [Generate a Profiler report for three response variables (GP Fit, NL Fit, and Difference) with confidence intervals and specific term values using the Nonlinear Examples/CES Production Function.jmp data table.](#generate-a-profiler-report-for-three-response-variables-gp-fit-nl-fit-and-difference-with-confidence-intervals-and-specific-term-values-using-the-nonlinear-examplesces-production-functionjmp-data-table)

```

// Open data table
dt = Open("$Sample_Data/Nonlinear Examples/CES Production Function.jmp");
// Profiler
Profiler(
    Y( :GP Fit, :NL Fit, :Difference ),
    Profiler(
        1,
        Confidence Intervals( 1 ),
        Term Value(
            l( 0.5 ),
            k( 0.3966 )
        )
    ),
    Expand,
    SendToReport(
        Dispatch( {"Prediction Profiler"},
            "Profiler", FrameBox,
            Frame Size( 174, 87 )
        ),
        Dispatch( {"Prediction Profiler"},
            "Profiler", FrameBox( 2 ),
            Frame Size( 174, 87 )
        ),
        Dispatch( {"Prediction Profiler"},
            "Profiler", FrameBox( 3 ),
            Frame Size( 174, 87 )
        ),
        Dispatch( {"Prediction Profiler"},
            "Profiler", FrameBox( 5 ),
            Frame Size( 174, 87 )
        ),
        Dispatch( {"Prediction Profiler"},
            "Profiler", FrameBox( 6 ),
            Frame Size( 174, 87 )
        ),
        Dispatch( {"Prediction Profiler"},
            "Profiler", FrameBox( 7 ),
            Frame Size( 174, 87 )
        )
    )
);


```

### [Construct a choice model using the Profiles, Responses, and Subjects data tables, and specify the response, profile, and subject effects. Adjust for Firth bias and include likelihood ratio tests.](#construct-a-choice-model-using-the-profiles-responses-and-subjects-data-tables-and-specify-the-response-profile-and-subject-effects-adjust-for-firth-bias-and-include-likelihood-ratio-tests)

```

// Open data table
dt = Open("$Sample_Data/Pizza Responses.jmp");
// Choice
Open( "$Sample_Data/Pizza Profiles.jmp" );
Open( "$Sample_Data/Pizza Subjects.jmp" );
Choice(
    Response Data Table(
        Data Table( "Pizza Responses" )
    ),
    Profile DataTable( Pizza Profiles ),
    Subject DataTable(
        Data Table( "Pizza Subjects" )
    ),
    Response Subject ID( :Subject ),
    Response Profile ID Choices(
        :Choice1, :Choice2
    ),
    Profile ID( :ID ),
    Profile Effects(
        :Crust, :Cheese, :Topping
    ),
    Subject Subject ID( :Subject ),
    Subject Effects( :Gender ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    Response Profile ID Chosen( :Choice ),
    Likelihood Ratio Tests( 1 )
);


```

### [Fit a standard least squares regression model to the data with specified effects after stepwise selection, emphasizing effect leverage and generating diagnostic plots.](#fit-a-standard-least-squares-regression-model-to-the-data-with-specified-effects-after-stepwise-selection-emphasizing-effect-leverage-and-generating-diagnostic-plots)

```

// Open data table
dt = Open("$Sample_Data/S4 Temps.jmp");
// Final Model, after Stepwise
Fit Model(
    Y( :fahrenheit ),
    Effects(
        :time of day, :east or west,
        :time of day * :east or west,
        :thermometer, :type of space,
        :sector, :volunteer
    ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Effect Leverage" ),
    Run(
        :fahrenheit <<
        {Parameter Estimates( 0 ),
        Plot Actual by Predicted( 1 ),
        Plot Regression( 0 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Generate a standard least squares regression model with minimal diagnostic plots and analyze effect tests.](#generate-a-standard-least-squares-regression-model-with-minimal-diagnostic-plots-and-analyze-effect-tests)

```

// Open data table
dt = Open("$Sample_Data/Singularity.jmp");
// Fit Model Report
Fit Model(
    Y( :Y ),
    Effects( :X1, :A ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Run(
        :Y << {Analysis of Variance( 1 ),
        Lack of Fit( 0 ),
        Plot Actual by Predicted( 0 ),
        Plot Residual by Predicted( 0 ),
        Plot Effect Leverage( 0 )}
    ),
    SendToReport(
        Dispatch( {"Response Y"},
            "Effect Tests", OutlineBox,
            {Close( 0 )}
        )
    )
);


```

### [Fit a quadratic model with multiple interaction effects using the Fit Model function.](#fit-a-quadratic-model-with-multiple-interaction-effects-using-the-fit-model-function)

```

// Open data table
dt = Open("$Sample_Data/Stochastic Optimization.jmp");
// Quadratic Model
Fit Model(
    Effects(
        :Reaction Time & RS,
        :Reaction Temperature & RS,
        :Reaction Time * :Reaction Time,
        :Reaction Time *
        :Reaction Temperature,
        :Reaction Temperature *
        :Reaction Temperature,
        :Reaction Time * :Reaction Time
         * :Reaction Time,
        :Reaction Time * :Reaction Time
         * :Reaction Temperature,
        :Reaction Time * (
        Reaction Temperature *
        :Reaction Temperature),
        :Reaction Temperature *
        :Reaction Temperature *
        :Reaction Temperature
    ),
    Y( :Yield )
);


```

### [Perform a partition analysis on the Tablet Production data table, focusing on the Lot Acceptance variable as the Y variable and including multiple X variables, and use the Maximize Significance criterion.](#perform-a-partition-analysis-on-the-tablet-production-data-table-focusing-on-the-lot-acceptance-variable-as-the-y-variable-and-including-multiple-x-variables-and-use-the-maximize-significance-criterion)

```

// Open data table
dt = Open("$Sample_Data/Tablet Production.jmp");
// Partition
Partition(
    Y( :Lot Acceptance ),
    X(
        :API Particle Size, :Mill Time,
        :Screen Size,
        :Mag. Stearate Supplier,
        :Lactose Supplier,
        :Sugar Supplier, :Talc Supplier,
        :Blend Time, :Blend Speed,
        :Compressor, :Force,
        :Coating Supplier,
        :Coating Viscosity, :Inlet Temp,
        :Exhaust Temp, :Spray Rate,
        :Atomizer Pressure
    ),
    Minimum Size Split( 5 ),
    Show Split Prob( 1 ),
    Sort Split Candidates( 0 ),
    Criterion( "Maximize Significance" )
);


```

# [Graphical Analysis](#graphical-analysis)

More examples for this topic using the sample data files provided with JMP

### [Build a bar chart using graph builder](#build-a-bar-chart-using-graph-builder)

```

// Open data table
dt = Open("$Sample_Data/Airline Delays.jmp");
// Graph Builder Bar
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Day of Week ),
        Overlay( :Airline )
    ),
    Elements(
        Bar(
            X,
            Legend( 2 ),
            Bar Style( "Side by side" ),
            Summary Statistic( "Mean" )
        )
    ),
    SendToReport(
        Dispatch( {}, "graph title",
            TextEditBox,
            {
            Set Text(
                "Flights by Airline and Day of Week"
            )}
        )
    )
);


```

### [Build a graph builder chart with a wrap variable](#build-a-graph-builder-chart-with-a-wrap-variable)

```

// Open data table
dt = Open("$Sample_Data/Arrhythmia.jmp");
// Graph Builder: QRS duration by Age
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Age ),
        Y( :QRS duration ),
        Wrap( :Sex )
    ),
    Elements(
        Smoother( X, Y, Legend( 34 ) ),
        Points( X, Y, Legend( 35 ) )
    ),
    SendToReport(
        Dispatch( {}, "Age", ScaleBox,
            {Min( -16 )}
        ),
        Dispatch( {}, "", ScaleBox,
            {
            Label Row(
                {Automatic Font Size( 1 ),
                Label Orientation(
                    "Automatic"
                ),
                Automatic Tick Marks( 1 )
                }
            )}
        ),
        Dispatch( {}, "", ScaleBox( 2 ),
            {
            Label Row(
                {Automatic Font Size( 1 ),
                Label Orientation(
                    "Automatic"
                ),
                Automatic Tick Marks( 1 )
                }
            )}
        )
    )
);


```

### [Build a graph builder chart with smoother curves](#build-a-graph-builder-chart-with-smoother-curves)

```

// Open data table
dt = Open("$Sample_Data/Australian Tourism.jmp");
// Graph Builder Smoother 2
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Date ),
        Y( :"Revenue ($'000)"n ),
        Y(
            :Persons Employed,
            Position( 1 ),
            Side( "Right" )
        )
    ),
    Elements(
        Points( X, Y( 1 ), Legend( 1 ) ),
        Smoother(
            X,
            Y( 1 ),
            Legend( 4 )
        ),
        Points( X, Y( 2 ), Legend( 5 ) ),
        Smoother(
            X,
            Y( 2 ),
            Legend( 6 )
        )
    )
);


```

### [Build a graph builder chart with line and bar charts](#build-a-graph-builder-chart-with-line-and-bar-charts)

```

// Open data table
dt = Open("$Sample_Data/Big Class.jmp");
// Graph Builder Line and Bar Charts
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 15, 20 ) ),
        Y( :height, Size( 38, 36 ) ),
        Y( :weight )
    ),
    Elements(
        Position( 1, 1 ),
        Line(
            X,
            Y,
            Legend( 1 ),
            Row order( 0 ),
            Summary Statistic( "Mean" )
        )
    ),
    Elements(
        Position( 1, 2 ),
        Bar(
            X,
            Y,
            Legend( 2 ),
            Bar Style( "Side by side" ),
            Summary Statistic( "Mean" )
        )
    )
);


```

### [Generate a graph builder chart with points and lines and group on x, group on y and overlay](#generate-a-graph-builder-chart-with-points-and-lines-and-group-on-x-group-on-y-and-overlay)

```

// Open data table
dt = Open("$Sample_Data/Cola Heart Rate.jmp");
// Graph Builder 3
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X(
            :"Time (Numeric)"n,
            Size( 0, 22 )
        ),
        Y( :Heart Rate, Size( 0, 23 ) ),
        Group X( :Brand ),
        Group Y( :Type ),
        Overlay( :Testers )
    ),
    Elements(
        Points( X, Y, Legend( 88 ) ),
        Line(
            X,
            Y,
            Legend( 90 ),
            Row order( 0 ),
            Summary Statistic( "Mean" )
        )
    )
);


```

### [Generate a bubble plot with automation on time and trail lines on selected](#generate-a-bubble-plot-with-automation-on-time-and-trail-lines-on-selected)

```

// Open data table
dt = Open("$Sample_Data/Cola Heart Rate.jmp");
// Bubble Plot 3
Bubble Plot(
    X( :"Time (Numeric)"n ),
    Y( :"Rate/Baseline"n ),
    Time( :"Time (Numeric)"n ),
    Coloring( :Gender ),
    ID( :Gender ),
    Trail Bubbles( 1 ),
    Trail Lines( 1 ),
    All Labels( 0 ),
    SendToReport(
        Dispatch( {}, "1", ScaleBox,
            {Min( 8.35671342685371 ),
            Max( 31.3445729133618 )}
        ),
        Dispatch( {}, "2", ScaleBox,
            {Min( 0.959042666666667 ),
            Max( 1.2742 ), Inc( 0.05 ),
            Minor Ticks( 1 )}
        )
    )
);


```

### [Perform response screening analysis to identify most significant categorical factors](#perform-response-screening-analysis-to-identify-most-significant-categorical-factors)

```

// Open data table
dt = Open("$Sample_Data/Consumer Preferences.jmp");
// Response Screening
Response Screening(
    Y(
        :Job Satisfaction,
        :I am working on my career,
        :I want to see the world,
        :
        My home needs some major improvements,
        :
        I have vast interests outside of work,
        :
        I want to get my debt under control,
        :I come from a large family,
        :Brush, :Floss
    ),
    X(
        :Gender, :Single Status,
        :School Age Children, :Age Group
    ),
    Force X Categorical( 1 ),
    Force Y Categorical( 1 )
);


```

### [Generate a contour profiler plot for yield with Reaction Temperature and Reaction Time as factors.](#generate-a-contour-profiler-plot-for-yield-with-reaction-temperature-and-reaction-time-as-factors)

```

// Open data table
dt = Open("$Sample_Data/First-Order Kinetics.jmp");
// Contour Profiler
Contour Profiler(
    Y( :Yield ),
    Contour Profiler(
        1,
        Term Value(
            Reaction Temperature(
                530.05
            ),
            Reaction Time(
                0.1995,
                Min( 0.101 )
            )
        ),
        Contour Value(
            Yield(
                0.596698113207547,
                Lo Limit(
                    0.596698113207547
                ),
                Min( 0.425 ),
                Max( 0.625 )
            )
        ),
        Horizontal Factor(
            Reaction Temperature
        ),
        Vertical Factor( Reaction Time )
    ),
    Expand
);


```

### [Generate a one-way analysis of variance (ANOVA) plot for the response variable Y divided by the categorical variable surface quality, and customize the plot with box plots, mean diamonds, and colored line segments for each surface quality category.](#generate-a-one-way-analysis-of-variance-anova-plot-for-the-response-variable-y-divided-by-the-categorical-variable-surface-quality-and-customize-the-plot-with-box-plots-mean-diamonds-and-colored-line-segments-for-each-surface-quality-category)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Oneway of Y by surface quality
Oneway(
    Y( :Y ),
    X( :surface quality ),
    All Pairs( 1 ),
    Means( 1 ),
    Plot Actual by Quantile( 1 ),
    Box Plots( 1 ),
    Mean Diamonds( 1 ),
    X Axis Proportional( 0 ),
    SendToReport(
        Dispatch( {}, "Oneway Plot",
            FrameBox,
            {
            DispatchSeg(
                Box Plot Seg( 1 ),
                {Confidence Diamond( 0 ),
                Line Color( "Red" )}
            ),
            DispatchSeg(
                Box Plot Seg( 2 ),
                {Confidence Diamond( 0 ),
                Line Color( "Red" )}
            ),
            DispatchSeg(
                Box Plot Seg( 3 ),
                {Confidence Diamond( 0 ),
                Line Color( "Red" )}
            ),
            DispatchSeg(
                Box Plot Seg( 4 ),
                {Confidence Diamond( 0 ),
                Line Color( "Red" )}
            )}
        )
    )
);


```

### [Construct a Variability Chart for analyzing the process variation in Comb MPG using the main factors Mfr Name and Engine, with options for robust analysis methods, box plots, and specific plot dimensions.](#construct-a-variability-chart-for-analyzing-the-process-variation-in-comb-mpg-using-the-main-factors-mfr-name-and-engine-with-options-for-robust-analysis-methods-box-plots-and-specific-plot-dimensions)

```

// Open data table
dt = Open("$Sample_Data/Hybrid Fuel Economy.jmp");
// Variability Chart
Variability Chart(
    Y( :Comb MPG ),
    X( :Mfr Name, :Engine ),
    Max Iter( 100 ),
    Conv Limit( 0.00000001 ),
    Number Integration Abscissas( 128 ),
    Number Function Evals( 65536 ),
    Analysis Type(
        "Choose best analysis (EMS REML Bayesian)"n
    ),
    Process Variation( 0 ),
    Std Dev Chart( 0 ),
    Show Box Plots( 1 ),
    SendToReport(
        Dispatch(
            {
            "Variability Chart for Comb MPG"
            }, "", NomAxisBox( 2 ),
            {Set Width( 539 ),
            Set Height( 161 )}
        )
    )
);


```

### [Prepare a variability chart to analyze shrinkage in investment castings, considering temperature and casting as factors using a nested model.](#prepare-a-variability-chart-to-analyze-shrinkage-in-investment-castings-considering-temperature-and-casting-as-factors-using-a-nested-model)

```

// Open data table
dt = Open("$Sample_Data/Investment Castings.jmp");
// Variability Chart
Variability Chart(
    Y( :Shrinkage ),
    X( :Temperature, :Casting ),
    Model( "Nested" ),
    Max Iter( 100 ),
    Conv Limit( 0.00000001 ),
    Number Integration Abscissas( 128 ),
    Number Function Evals( 65536 ),
    Analysis Type(
        "Choose best analysis (EMS REML Bayesian)"n
    ),
    Process Variation( 0 ),
    Std Dev Chart( 1 ),
    Variance Components( 1 ),
    SendToReport(
        Dispatch( {},
            "Variability Chart for Shrinkage",
            OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Generate a graph using the Graph Builder with color-coded map shapes representing the Change in Population and shaped differently based on the Metropolitan Statistical Area.](#generate-a-graph-using-the-graph-builder-with-color-coded-map-shapes-representing-the-change-in-population-and-shaped-differently-based-on-the-metropolitan-statistical-area)

```

// Open data table
dt = Open("$Sample_Data/PopulationByMSA.jmp");
// Graph Builder
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        Color( :Change in Population ),
        Shape(
            :
            Metropolitan Statistical Area
        )
    ),
    Elements(
        Map Shapes(
            Legend( 2 ),
            Summary Statistic( "Mean" ),
            Show Missing Shapes( 0 )
        )
    ),
    SendToReport(
        Dispatch( {}, "", ScaleBox,
            {Min( -124.862821911553 ),
            Max( -67.2295339264016 ),
            Inc( 10 ), Minor Ticks( 0 )}
        ),
        Dispatch( {}, "", ScaleBox( 2 ),
            {Min( 14.572885454726 ),
            Max( 62.7291891822812 ),
            Inc( 10 ), Minor Ticks( 0 )}
        )
    )
);
:Metropolitan Statistical Area <<
Set Property(
    "Map Role",
    {
    Shape Name Use(
        "$SAMPLE_DATA/US-MSA-Name.jmp",
        "MSA_Name"
    )}
);


```

### [Create a side-by-side bar chart in Graph Builder to visualize the mean profit by product line and quarter from the Profit by Product dataset.](#create-a-side-by-side-bar-chart-in-graph-builder-to-visualize-the-mean-profit-by-product-line-and-quarter-from-the-profit-by-product-dataset)

```

// Open data table
dt = Open("$Sample_Data/Profit by Product.jmp");
// Graph Builder Bar Chart
Graph Builder(
    Size( 570, 481 ),
    Show Control Panel( 0 ),
    Variables(
        X( :Product Line ),
        Y( :Profit ),
        Group X( :Quarter )
    ),
    Elements(
        Bar(
            X,
            Y,
            Legend( 17 ),
            Bar Style( "Side by side" ),
            Summary Statistic( "Mean" )
        )
    ),
    SendToReport(
        Dispatch( {}, "Product Line",
            ScaleBox,
            {Show Major Ticks( 0 ),
            Show Minor Ticks( 0 ),
            Rotated Labels( "Automatic" )
            }
        )
    )
);


```

### [Generate a Laney P-prime control chart for the proportion of Total Plastic defects using the Water Plastics dataset.](#generate-a-laney-p-prime-control-chart-for-the-proportion-of-total-plastic-defects-using-the-water-plastics-dataset)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Water Plastics.jmp");
// Laney P' chart of Total Plastic
Control Chart Builder(
    Size( 814, 307 ),
    Show Two Shewhart Charts( 0 ),
    Show Control Panel( 0 ),
    Show Limit Summaries( 0 ),
    Class( Shewhart Attribute ),
    Variables(
        Subgroup( :Week ),
        Y( :Total Plastic ),
        Phase( :Location ),
        n Trials( :Total Volume )
    ),
    Chart(
        Points(
            Statistic( "Proportion" )
        ),
        Limits(
            Sigma( "Laney P Prime" ),
            Show Lower Limit( 0 )
        )
    ),
    SendToReport(
        Dispatch( {},
            "Control Chart Builder",
            FrameBox,
            {
            DispatchSeg(
                Text Seg( 1 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            ),
            DispatchSeg(
                Text Seg( 2 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            ),
            DispatchSeg(
                Text Seg( 3 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            )}
        )
    )
);


```

### [Create a bar chart using Graph Builder to visualize the mean expenditures across different ethnicities, specifically focusing on Hispanic and White non-Hispanic groups. Apply a local data filter to include only these two ethnicities in the analysis.](#create-a-bar-chart-using-graph-builder-to-visualize-the-mean-expenditures-across-different-ethnicities-specifically-focusing-on-hispanic-and-white-non-hispanic-groups-apply-a-local-data-filter-to-include-only-these-two-ethnicities-in-the-analysis)

```

// Open data table
dt = Open("$Sample_Data/Simpsons Paradox.jmp");
// Graph Builder: Mean (Expenditures) vs. Ethnicity
Graph Builder(
    Size( 534, 450 ),
    Show Control Panel( 0 ),
    Variables(
        X( :Ethnicity ),
        Y( :Expenditures )
    ),
    Elements( Bar( X, Y, Legend( 4 ) ) ),
    Local Data Filter(
        Close Outline( 1 ),
        Add Filter(
            columns( :Ethnicity ),
            Where(
                :Ethnicity == {"Hispanic",
                "White not Hispanic"}
            ),
            Display(
                :Ethnicity,
                N Items( 8 )
            )
        )
    )
);


```

### [Generate a Contour Profiler for the Yield response variable utilizing Reaction Temperature and Reaction Time factors from the Stochastic Optimization dataset.](#generate-a-contour-profiler-for-the-yield-response-variable-utilizing-reaction-temperature-and-reaction-time-factors-from-the-stochastic-optimization-dataset)

```

// Open data table
dt = Open("$Sample_Data/Stochastic Optimization.jmp");
// Contour Profiler
Contour Profiler(
    Y( :Yield ),
    Contour Profiler(
        1,
        Term Value(
            Reaction Temperature(
                530.05
            ),
            Reaction Time(
                0.1995,
                Min( 0.101 )
            )
        ),
        Contour Value(
            Yield(
                0.596698113207547,
                Lo Limit(
                    0.596698113207547
                ),
                Min( 0.425 ),
                Max( 0.625 )
            )
        ),
        Horizontal Factor(
            Reaction Temperature
        ),
        Vertical Factor( Reaction Time )
    ),
    Expand
);


```

### [Create a Graph Builder overlay plot displaying high and low stock prices over time with major grid lines on the x-axis and horizontally oriented, left-aligned legend.](#create-a-graph-builder-overlay-plot-displaying-high-and-low-stock-prices-over-time-with-major-grid-lines-on-the-x-axis-and-horizontally-oriented-left-aligned-legend)

```

// Open data table
dt = Open("$Sample_Data/Stock Averages.jmp");
// Graph Builder Overlay Plot
Graph Builder(
    Size( 568, 407 ),
    Show Control Panel( 0 ),
    Legend Position( "Bottom" ),
    Variables(
        X( :Date ),
        Y( :High ),
        Y( :Low, Position( 1 ) )
    ),
    Elements(
        Points(
            X,
            Y( 1 ),
            Y( 2 ),
            Legend( 1 )
        )
    ),
    SendToReport(
        Dispatch( {}, "Date", ScaleBox,
            {
            Label Row(
                Show Major Grid( 1 )
            )}
        ),
        Dispatch( {}, "Graph Builder",
            FrameBox,
            {Marker Size( 2 )}
        ),
        Dispatch( {}, "400", LegendBox,
            {Orientation( "Horizontal" ),
            Sides( "Left" )}
        )
    )
);


```

### [Create a bar chart using Graph Builder with three Y-axes (High, Low, and Close) over the X-axis (YearWeek) from the TechStock dataset.](#create-a-bar-chart-using-graph-builder-with-three-y-axes-high-low-and-close-over-the-x-axis-yearweek-from-the-techstock-dataset)

```

// Open data table
dt = Open("$Sample_Data/TechStock.jmp");
// Graph Builder 3
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :YearWeek ),
        Y( :High ),
        Y( :Low, Position( 1 ) ),
        Y( :Close, Position( 1 ) )
    ),
    Elements(
        Bar(
            X,
            Y( 1 ),
            Y( 2 ),
            Y( 3 ),
            Legend( 1 ),
            Bar Style( "Interval" )
        )
    )
);


```

### [Create a Graph Builder plot with departure day of week as a categorical variable, net cost as the response variable, grouped by class of service, and overlaid by airline, using points with jitter.](#create-a-graph-builder-plot-with-departure-day-of-week-as-a-categorical-variable-net-cost-as-the-response-variable-grouped-by-class-of-service-and-overlaid-by-airline-using-points-with-jitter)

```

// Open data table
dt = Open("$Sample_Data/Travel Costs.jmp");
// Graph Builder - Root Cause
Graph Builder(
    Variables(
        X( :Net Cost ),
        Y(
            :Departure Day of Week,
            Size( 74 )
        ),
        Group Y( :Class of Service ),
        Overlay( :Airline )
    ),
    Elements(
        Points(
            X,
            Y,
            Legend( 6 ),
            Jitter( 1 )
        )
    )
);


```

### [Create a Graph Builder Map displaying 2008 Election State Winners, where map shapes are sized based on the number of electors using the Color, Size, and Shape variables, and adjust the legend and graph title accordingly.](#create-a-graph-builder-map-displaying-2008-election-state-winners-where-map-shapes-are-sized-based-on-the-number-of-electors-using-the-color-size-and-shape-variables-and-adjust-the-legend-and-graph-title-accordingly)

```

// Open data table
dt = Open("$Sample_Data/US Election 2008.jmp");
// Graph Builder Map Sized by Number of Electors
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        Color( :Winner ),
        Size( :Electors ),
        Shape( :State )
    ),
    Elements(
        Map Shapes(
            Legend( 2 ),
            Summary Statistic( "Mean" ),
            Show Missing Shapes( 0 )
        )
    ),
    SendToReport(
        Dispatch( {}, "400", ScaleBox,
            {
            Legend Model(
                2,
                Properties(
                    0,
                    {Line Color( 1 )}
                )
            )}
        ),
        Dispatch( {}, "graph title",
            TextEditBox,
            {
            Set Text(
                "2008 Election State Winners sized by Number of Electors"
            )}
        )
    )
);


```

### [Create line and bar charts using the Graph Builder platform .](#create-line-and-bar-charts-using-the-graph-builder-platform)

```

// Open data table
dt = Open("$Sample_Data/World Class.jmp");
// Graph Builder Line and Bar Charts
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :age, Size( 15, 20 ) ),
        Y(
            :"height (in.)"n,
            Size( 38, 36 )
        ),
        Y( :"weight (lb.)"n )
    ),
    Elements(
        Position( 1, 1 ),
        Line(
            X,
            Y,
            Legend( 1 ),
            Row order( 0 ),
            Summary Statistic( "Mean" )
        )
    ),
    Elements(
        Position( 1, 2 ),
        Bar(
            X,
            Y,
            Legend( 2 ),
            Bar Style( "Side by side" ),
            Summary Statistic( "Mean" )
        )
    )
);


```

### [Build a contour plot using graph builder](#build-a-contour-plot-using-graph-builder)

```

// Open data table
dt = Open("$Sample_Data/Airline Delays.jmp");
// Graph Builder Contour Plot
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Distance ),
        Y( :Arrival Delay ),
        Wrap( :Airline )
    ),
    Elements(
        Contour(
            X,
            Y,
            Legend( 6 ),
            Number of Levels( 6 )
        )
    )
);


```

### [Fit a standard least squares model](#fit-a-standard-least-squares-model)

```

// Open data table
dt = Open("$Sample_Data/Analgesics.jmp");
// Fit Model
Fit Model(
    Y( :pain ),
    Effects(
        :gender, :drug, :gender * :drug
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run(
        :pain <<
        {Plot Actual by Predicted( 1 ),
        Plot Residual by Predicted( 1 ),
        Plot Effect Leverage( 1 )}
    )
);


```

### [Perform bivariate analysis with a second order polynomial fit](#perform-bivariate-analysis-with-a-second-order-polynomial-fit)

```

// Open data table
dt = Open("$Sample_Data/Birth Death.jmp");
// Bivariate
Bivariate(
    Y( :death ),
    X( :birth ),
    Fit Polynomial( 2 )
);


```

### [Generate a bubble plot with automation by year](#generate-a-bubble-plot-with-automation-by-year)

```

// Open data table
dt = Open("$Sample_Data/BirthDeathYear.jmp");
// Bubble Plot
Bubble Plot(
    X( :Birth ),
    Y( :Death ),
    Time( :Year ),
    ID( :Country ),
    Circle Size( 0.339622641509434 ),
    Time Index( 4.1 )
);


```

### [Generate distribution analysis](#generate-distribution-analysis)

```

// Open data table
dt = Open("$Sample_Data/Cleansing.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :Coal particles )
    ),
    Continuous Distribution(
        Column( :pH )
    ),
    Nominal Distribution(
        Column( :Polymer )
    )
);


```

### [Fit a standard least squares model with 2 way interaction term](#fit-a-standard-least-squares-model-with-2-way-interaction-term)

```

// Open data table
dt = Open("$Sample_Data/Cleansing.jmp");
// Model Specification
Fit Model(
    Y( :Coal particles ),
    Effects(
        :pH, :Polymer, :pH * :Polymer
    ),
    Personality(
        "Standard Least Squares"
    )
);


```

### [Generate a 3d scatterplot](#generate-a-3d-scatterplot)

```

// Open data table
dt = Open("$Sample_Data/Cowboy Hat Template.jmp");
// Scatterplot 3D
Scatterplot 3D( Y( :x, :y, :z ) );


```

### [Generate a 3d scatterplot](#generate-a-3d-scatterplot_1)

```

// Open data table
dt = Open("$Sample_Data/Cowboy Hat.jmp");
// Scatterplot 3D
Scatterplot 3D( Y( :x, :y, :z ) );


```

### [Generate overlay plots for weibull with data plotted as a function](#generate-overlay-plots-for-weibull-with-data-plotted-as-a-function)

```

// Open data table
dt = Open("$Sample_Data/Density Compare.jmp");
// Overlay Plot for Weibulls
Overlay Plot(
    X( :XWeibull ),
    Y( :Weibull11, :Weibul12, :Weibul21 ),
    Function Plot( 1 ),
    Show Points( 0 )
);


```

### [Perform screening analysis to identify significant factors affecting taste in a cake experiment using the Screening function.](#perform-screening-analysis-to-identify-significant-factors-affecting-taste-in-a-cake-experiment-using-the-screening-function)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Cake Data.jmp");
// Screening
Screening(
    Y( :Taste ),
    X(
        :Cocoa, :Sugar, :Flour, :Butter,
        :Milk, :Eggs
    )
);


```

### [Open the Bounce Response data table and load it into the Custom Design platform for response editing.](#open-the-bounce-response-data-table-and-load-it-into-the-custom-design-platform-for-response-editing)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Bounce Response.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Responses(
        Current Data Table()
    )
);


```

### [Build a statistical model using the Fit Model function with specified effects and response variable.](#build-a-statistical-model-using-the-fit-model-function-with-specified-effects-and-response-variable)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Coffee Data.jmp");
// Model
Fit Model(
    Effects(
        :Grind, :Temperature, :Time,
        :Charge, :Station
    ),
    Y( :Strength )
);


```

### [Generate a ternary plot with the variables CuSO4, Na2S2O3, and Glyoxal.](#generate-a-ternary-plot-with-the-variables-cuso4-na2s2o3-and-glyoxal)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Donev Mixture Data.jmp");
// Ternary Plot
obj =
Ternary Plot(
    Y( :CuSO4, :Na2S2O3, :Glyoxal )
);
Report( obj )[framebox( 1 )] <<
Marker Size( 4 );


```

### [Analyze distributions for Miles, Weight, and Strike Point using the Distribution platform, focusing on continuous and nominal variables.](#analyze-distributions-for-miles-weight-and-strike-point-using-the-distribution-platform-focusing-on-continuous-and-nominal-variables)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Runners Covariates.jmp");
// Distribution
Distribution(
    Continuous Distribution(
        Column( :Miles )
    ),
    Continuous Distribution(
        Column( :Weight )
    ),
    Nominal Distribution(
        Column( :Strike Point )
    ),
    Histograms Only
);


```

### [Create a Graph Builder plot with colored points, a line of fit, and the specified variables: Specific Gravity, Tensile Strength, and Supplier.](#create-a-graph-builder-plot-with-colored-points-a-line-of-fit-and-the-specified-variables-specific-gravity-tensile-strength-and-supplier)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Thermoplastic.jmp");
// Graph Builder
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :Specific Gravity ),
        Y( :Tensile Strength ),
        Color( :Supplier )
    ),
    Elements(
        Points( X, Y, Legend( 2 ) ),
        Line Of Fit( X, Y, Legend( 4 ) )
    )
);


```

### [Perform a one-way analysis of variance (ANOVA) to compare the means of the Toxicity response variable across different levels of the Formulation factor, visualize the results with mean diamonds and robust means lines.](#perform-a-one-way-analysis-of-variance-anova-to-compare-the-means-of-the-toxicity-response-variable-across-different-levels-of-the-formulation-factor-visualize-the-results-with-mean-diamonds-and-robust-means-lines)

```

// Open data table
dt = Open("$Sample_Data/Drug Toxicity.jmp");
// Oneway
Oneway(
    Y( :Toxicity ),
    X( :Formulation ),
    "Means/Anova"n( 1 ),
    Mean Diamonds( 1 ),
    Robust Means Lines( 1 )
);


```

### [Perform stepwise linear regression analysis on the Fitness data table to identify significant predictors of Oxygen consumption.](#perform-stepwise-linear-regression-analysis-on-the-fitness-data-table-to-identify-significant-predictors-of-oxygen-consumption)

```

// Open data table
dt = Open("$Sample_Data/Fitness.jmp");
// Stepwise Fit
Fit Model(
    Y( :Oxy ),
    Effects(
        :Runtime, :Weight, :RunPulse,
        :RstPulse, :MaxPulse
    ),
    Personality( "Stepwise" ),
    Run
);


```

### [Create a Graph Builder visualization to explore relationships between lots, parts, and shipping events.](#create-a-graph-builder-visualization-to-explore-relationships-between-lots-parts-and-shipping-events)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// lots, parts, and shipping
Graph Builder(
    Size( 515, 491 ),
    Show Control Panel( 0 ),
    Variables(
        X( :Part ),
        Y( :Lot ),
        Group X( :Ship event )
    ),
    Elements(
        Points( X, Y, Legend( 8 ) )
    )
);


```

### [Open a data table and configure the Graph Builder to visualize surface quality, part, and ship event using a wrap layout with point elements.](#open-a-data-table-and-configure-the-graph-builder-to-visualize-surface-quality-part-and-ship-event-using-a-wrap-layout-with-point-elements)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Graph Builder 3
Graph Builder(
    Size( 569, 500 ),
    Variables(
        X( :surface quality ),
        Y( :Part ),
        Wrap( :Ship event )
    ),
    Elements(
        Points( X, Y, Legend( 7 ) )
    )
);


```

### [Generate a Pareto plot to analyze the dependency of surface quality on different parts, excluding the rate plots and closing the plot outline.](#generate-a-pareto-plot-to-analyze-the-dependency-of-surface-quality-on-different-parts-excluding-the-rate-plots-and-closing-the-plot-outline)

```

// Open data table
dt = Open("$Sample_Data/Hardware Surface Unit Data.jmp");
// Pareto Plot 4
Pareto Plot(
    Cause( :surface quality ),
    X( :Part ),
    Test Rates Across Groups( 1 ),
    No Plot( 1 ),
    SendToReport(
        Dispatch( {}, "Plots", OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Create a 3D scatterplot showing the relationship between sepal and petal dimensions in the Iris dataset.](#create-a-3d-scatterplot-showing-the-relationship-between-sepal-and-petal-dimensions-in-the-iris-dataset)

```

// Open data table
dt = Open("$Sample_Data/Iris.jmp");
// Scatterplot 3D
Scatterplot 3D(
    Y(
        :Sepal length, :Sepal width,
        :Petal length, :Petal width
    ),
    Frame3D(
        Set Rotation(
            -37.7763571468042,
            -20.0181349932962,
            0.755666043084993
        )
    )
);


```

### [Fit a nominal logistic regression model using the occurrence of lung cancer as the response variable, with smoking as the predictor, and incorporating observation frequencies.](#fit-a-nominal-logistic-regression-model-using-the-occurrence-of-lung-cancer-as-the-response-variable-with-smoking-as-the-predictor-and-incorporating-observation-frequencies)

```

// Open data table
dt = Open("$Sample_Data/Lung Cancer.jmp");
// Model
Fit Model(
    Freq( :Count ),
    Y( :Lung Cancer ),
    Effects( :Smoker ),
    Personality( "Nominal Logistic" )
);


```

### [Fit a logistic regression model with a response variable of interest and a predictor variable, including a frequency column.](#fit-a-logistic-regression-model-with-a-response-variable-of-interest-and-a-predictor-variable-including-a-frequency-column)

```

// Open data table
dt = Open("$Sample_Data/Penicillin.jmp");
// Logistic
Logistic(
    Y( Response ),
    X( "ln(dose)"n ),
    Freq( count )
);


```

### [Create a ternary plot using the specified variables.](#create-a-ternary-plot-using-the-specified-variables)

```

// Open data table
dt = Open("$Sample_Data/Plasticizer 78.jmp");
// Ternary Plot
Ternary Plot( Y( :p1, :p2, :p3 ) );


```

### [Create a CUSUM Control Chart for quality control monitoring using a predefined data table.](#create-a-cusum-control-chart-for-quality-control-monitoring-using-a-predefined-data-table)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Engine Temperature Sensor.jmp");
// CUSUM Control Chart
CUSUM Control Chart(
    Y( :Y ),
    Lower Side( 1 ),
    Target( 100 ),
    Sigma( 10 )
);


```

### [Generate a cell plot to visualize the performance of verbal and math scores across different years for each state.](#generate-a-cell-plot-to-visualize-the-performance-of-verbal-and-math-scores-across-different-years-for-each-state)

```

// Open data table
dt = Open("$Sample_Data/SAT.jmp");
// Cell Plot
Cell Plot(
    Y(
        :"2004 Verbal"n, :"2004 Math"n,
        :"2003 Verbal"n, :"2003 Math"n,
        :"2002 Verbal"n, :"2002 Math"n,
        :"2001 Verbal"n, :"2001 Math"n,
        :"1999 Verbal"n, :"1999 Math"n,
        :"1994 Verbal"n, :"1994 Math"n,
        :"1997 Verbal"n, :"1997 Math"n,
        :"1992 Verbal"n, :"1992 Math"n
    ),
    Label( :State )
);


```

### [Generate a Treemap visualization to analyze the relationships and distributions of verbal scores, test-taking percentages, and geographic locations (states) based on the SAT dataset.](#generate-a-treemap-visualization-to-analyze-the-relationships-and-distributions-of-verbal-scores-test-taking-percentages-and-geographic-locations-states-based-on-the-sat-dataset)

```

// Open data table
dt = Open("$Sample_Data/SAT.jmp");
// Treemap
Treemap(
    Categories( :State ),
    Coloring( :"2004 Verbal"n ),
    Sizes( :"% Taking (2004)"n ),
    Ordering( :X, :Y )
);


```

### [Fit a standard least squares model with minimal report and significance level set to 0.05 using the variables X1, X2, and X3 to predict Y.](#fit-a-standard-least-squares-model-with-minimal-report-and-significance-level-set-to-005-using-the-variables-x1-x2-and-x3-to-predict-y)

```

// Open data table
dt = Open("$Sample_Data/Singularity.jmp");
// Model 1
Fit Model(
    Censor Code( "" ),
    Y( :Y ),
    Effects( :X1, :X2, :X3 ),
    Personality(
        "Standard Least Squares"
    ),
    Emphasis( "Minimal Report" ),
    Set Alpha Level( 0.05 )
);


```

### [Generate a distribution analysis for multiple chemical solubility variables.](#generate-a-distribution-analysis-for-multiple-chemical-solubility-variables)

```

// Open data table
dt = Open("$Sample_Data/Solubility.jmp");
// Distribution
Distribution(
    Y(
        :Ether, :"1-Octanol"n,
        :Carbon Tetrachloride, :Benzene,
        :Hexane, :Chloroform
    )
);


```

### [Fit a linear model using the EMS method with interactions and random effects.](#fit-a-linear-model-using-the-ems-method-with-interactions-and-random-effects)

```

// Open data table
dt = Open("$Sample_Data/Split Plot.jmp");
// Fit Model - EMS Method
Fit Model(
    Y( :Y ),
    Effects(
        :Tenderizer, :Carcass,
        :Tenderizer * :Carcass & Random,
        :Roasting Time,
        :Roasting Time * :Tenderizer
    ),
    Personality(
        "Standard Least Squares"
    ),
    Method( "EMS" ),
    Run
);


```

### [Create a Graph Builder Bar Chart with two Y variables from a data table.](#create-a-graph-builder-bar-chart-with-two-y-variables-from-a-data-table)

```

// Open data table
dt = Open("$Sample_Data/Spring.jmp");
// Graph Builder Bar Chart
Graph Builder(
    Show Control Panel( 0 ),
    Variables(
        X( :date ),
        Y( :"Humid1:PM"n ),
        Y( :"Humid4:PM"n, Position( 1 ) )
    ),
    Elements(
        Bar(
            X,
            Y( 1 ),
            Y( 2 ),
            Legend( 1 )
        )
    )
);


```

### [Create a surface plot visualizing the relationship between reaction temperature, reaction time, and yield.](#create-a-surface-plot-visualizing-the-relationship-between-reaction-temperature-reaction-time-and-yield)

```

// Open data table
dt = Open("$Sample_Data/Stochastic Optimization.jmp");
// Surface Plot
Surface Plot(
    Columns( :Yield ),
    Control Panel( 0 ),
    Hide Lights Border( 1 ),
    Scale response axes independently(
        1
    ),
    Datapoints Choice( "Points" ),
    XRotate( -67.3776687507792 ),
    YRotate( -5.03482899952444 ),
    ZRotate( 52.4071239021159 ),
    Formula( "Yield" ),
    Response( :Yield ),
    SetXVariable( Reaction Temperature ),
    SetYVariable( Reaction Time ),
    Graph( Background Color( 0, 0, 0 ) ),
    Graph Size( 443, 443 )
);


```

### [Create a scatter plot of Net Costs using the Graph Builder function .](#create-a-scatter-plot-of-net-costs-using-the-graph-builder-function)

```

// Open data table
dt = Open("$Sample_Data/Travel Costs.jmp");
// Graph Builder - Net Costs
Graph Builder(
    Variables( X( :Net Cost ) ),
    Elements(
        Points(
            X,
            Legend( 3 ),
            Jitter( 1 )
        )
    )
);


```

### [Create a variability chart with nested factors using operator and part configurations and display standard deviation charts.](#create-a-variability-chart-with-nested-factors-using-operator-and-part-configurations-and-display-standard-deviation-charts)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/2 Factors Nested.jmp");
// Variability Chart - Nested
Variability Chart(
    Y( :" Y"n ),
    X( :Operator, :Part ),
    Variance Components( "Nested" ),
    Show Points( 1 ),
    Std Dev Chart( 1 )
);


```

### [Create a bubble plot with scaling for sizes and coloring based on the wolfer variable using Bubble Plot function.](#create-a-bubble-plot-with-scaling-for-sizes-and-coloring-based-on-the-wolfer-variable-using-bubble-plot-function)

```

// Open data table
dt = Open("$Sample_Data/Wolfer Sunspot.jmp");
// Bubble Plot
Bubble Plot(
    X( :part ),
    Y( :cycle ),
    Sizes( :wolfer ),
    Coloring( :wolfer ),
    Circle Size( 5.9433962264151 ),
    SendToReport(
        Dispatch( {}, "2", ScaleBox,
            {Scale( "Linear" ),
            Format( "Best" ), Min( 1740 ),
            Max( 1920 ), Inc( 10 )}
        ),
        Dispatch( {}, "Bubble Plot",
            FrameBox,
            Frame Size( 482, 353 )
        )
    )
);


```

### [Create an overlay plot with needle plots for the high, close, and low stock prices of DJI over time.](#create-an-overlay-plot-with-needle-plots-for-the-high-close-and-low-stock-prices-of-dji-over-time)

```

// Open data table
dt = Open("$Sample_Data/XYZ Stock Averages (plots).jmp");
// Overlay Plot: Needle
Overlay Plot(
    X( :Date ),
    Y( :DJI High, :DJI Close, :DJI Low ),
    Needle( 1 )
);


```

# [Measurement Analysis](#measurement-analysis)

More examples for this topic using the sample data files provided with JMP

### [Perform measurement systems analysis using the EMP procedure with crossed model and range chart for dispersion.](#perform-measurement-systems-analysis-using-the-emp-procedure-with-crossed-model-and-range-chart-for-dispersion)

```

// Open data table
dt = Open("$Sample_Data/Variability Data/2 Factors Crossed.jmp");
// EMP Measurement Systems Analysis
EMP Measurement Systems Analysis(
    Y( :Measurement ),
    X( :Operator ),
    Part( :part# ),
    Model( Crossed ),
    Dispersion Chart Type( "Range" ),
    Average Chart( 1 ),
    Dispersion Chart( 1 )
);


```

# [Mixed Model](#mixed-model)

More examples for this topic using the sample data files provided with JMP

### [Fit a model using the Standard Least Squares personality with specified mixture effects and interactions.](#fit-a-model-using-the-standard-least-squares-personality-with-specified-mixture-effects-and-interactions)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Piepel.jmp");
// Model
Fit Model(
    Effects(
        :X1 & Mixture, :X2 & Mixture,
        :X3 & Mixture, :X1 * :X2,
        :X1 * :X3, :X2 * :X3
    ),
    Y( :Y ),
    No Intercept,
    PERSONALITY(
        "Standard Least Squares"
    )
);


```

### [Load an existing data table and open it in the Custom Design platform for editing.](#load-an-existing-data-table-and-open-it-in-the-custom-design-platform-for-editing)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Software Factors.jmp");
// Load and Edit in Custom Design
DOE(
    Custom Design,
    Load Factors( Current Data Table() )
);


```

### [Perform a variance component analysis using the REML method and fit a model for shrinkage with random effects in the Standard Least Squares personality.](#perform-a-variance-component-analysis-using-the-reml-method-and-fit-a-model-for-shrinkage-with-random-effects-in-the-standard-least-squares-personality)

```

// Open data table
dt = Open("$Sample_Data/Investment Castings.jmp");
// Model: REML
Fit Model(
    Censor Code( "" ),
    Y( :Shrinkage ),
    Effects(
        :Casting[:Temperature] & Random,
        :Temperature
    ),
    Personality(
        "Standard Least Squares"
    ),
    Method( "REML" ),
    Set Alpha Level( 0.05 )
);


```

### [Fit a standard least squares model with mean as the response variable, grp as the effect, and N as the frequency variable.](#fit-a-standard-least-squares-model-with-mean-as-the-response-variable-grp-as-the-effect-and-n-as-the-frequency-variable)

```

// Open data table
dt = Open("$Sample_Data/Noah Decay.jmp");
// Fit Model
Fit Model(
    Freq( :N ),
    Y( :mean ),
    Effects( :grp ),
    Personality(
        "Standard Least Squares"
    ),
    Run( :mean << {{:grp << {}}} )
);


```

### [Create a Pareto Plot for cause analysis using failure data and frequency counts.](#create-a-pareto-plot-for-cause-analysis-using-failure-data-and-frequency-counts)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Failure.jmp");
// Pareto Plot
Pareto Plot(
    Cause( :failure ),
    Freq( :N )
);


```

### [Fit a Weibull-distributed parametric survival model with the Load effect.](#fit-a-weibull-distributed-parametric-survival-model-with-the-load-effect)

```

// Open data table
dt = Open("$Sample_Data/Reliability/Comptime.jmp");
// Parametric Survival Model
Fit Model(
    Y( :ExecTime ),
    Effects( :Load ),
    Personality( "Parametric Survival" ),
    Distribution( Weibull )
);


```

### [Build a multivariate scatterplot matrix with pairwise estimation method for household income, IQ, eighth-grade math, high school graduates, gross state product, vegetable consumption, smokers, physical activity, obese, college degrees, and alcohol consumption.](#build-a-multivariate-scatterplot-matrix-with-pairwise-estimation-method-for-household-income-iq-eighth-grade-math-high-school-graduates-gross-state-product-vegetable-consumption-smokers-physical-activity-obese-college-degrees-and-alcohol-consumption)

```

// Open data table
dt = Open("$Sample_Data/US Demographics.jmp");
// Multivariate
Multivariate(
    Y(
        :Household Income, :IQ,
        :Eighth Grade Math,
        :High School Graduates,
        :Gross State Product,
        :Vegetable Consumption, :Smokers,
        :Physical Activity, :Obese,
        :College Degrees,
        :Alcohol Consumption
    ),
    Estimation Method( "Pairwise" ),
    Scatterplot Matrix(
        Density Ellipses( 1 ),
        Shaded Ellipses( 0 ),
        Ellipse Color( 3 )
    )
);


```

### [Perform choice analysis with gender effects using the Choice function.](#perform-choice-analysis-with-gender-effects-using-the-choice-function)

```

// Open data table
dt = Open("$Sample_Data/Laptop Runs.jmp");
// Choice with Gender
Open( "$Sample_Data/Laptop Profile.jmp" );
Open(
    "$Sample_Data/Laptop Subjects.jmp"
);
Choice(
    Response Data Table(
        Data Table( "Laptop Runs" )
    ),
    Profile DataTable( Laptop Profile ),
    Subject DataTable(
        Data Table( "Laptop Subjects" )
    ),
    Response Subject ID( :Person ),
    Response Grouping(
        :Survey, :Choice Set
    ),
    Response Profile ID Choices(
        :Choice1, :Choice2
    ),
    Profile ID( :Choice ID ),
    Profile Grouping(
        :Survey, :Choice Set
    ),
    Profile Effects(
        :Hard Disk, :Speed, :Battery Life,
        :Price
    ),
    Subject Subject ID( :Person ),
    Subject Effects( :Gender ),
    "Firth Bias-Adjusted Estimates"n( 1 ),
    Response Profile ID Chosen(
        :Response
    ),
    Likelihood Ratio Tests( 1 )
);


```

### [Partition a dataset into clusters based on multiple predictor variables using the Partition platform.](#partition-a-dataset-into-clusters-based-on-multiple-predictor-variables-using-the-partition-platform)

```

// Open data table
dt = Open("$Sample_Data/Liver Cancer.jmp");
// Partition
Partition(
    Y( :Severity ),
    X(
        :BMI, :Age, :Time, :Markers,
        :Hepatitis, :Jaundice
    ),
    Specify Profit Matrix(
        [1 -3, -5 1, . .],
        "High",
        "Low",
        "Undecided"
    ),
    Show Fit Details( 1 ),
    Informative Missing( 1 ),
    Initial Splits(
        :Time >= 2.571,
        {:Time < 12.714, {:Time < 2.857,
        {}, {:Markers == {1}, {}, {:Age
         >= 62.8603}}}, {:Markers == {0},
        {}, {:Jaundice == {0}}}},
        {:Age >= 66.7315, {}, {:Markers
         == {1}, {:BMI >= 20.679}}}
    )
);


```

# [Model Fitting](#model-fitting)

More examples for this topic using the sample data files provided with JMP

### [Develop a standard least squares regression model with mixture effects.](#develop-a-standard-least-squares-regression-model-with-mixture-effects)

```

// Open data table
dt = Open("$Sample_Data/Plasticizer.jmp");
// Model
Fit Model(
    Effects(
        :p1 & RS & Mixture,
        :p2 & RS & Mixture,
        :p3 & RS & Mixture, :p1 * :p2,
        :p1 * :p3, :p2 * :p3
    ),
    Y( :Y ),
    No Intercept,
    PERSONALITY(
        "Standard Least Squares"
    )
);


```

# [Multivariate Analysis](#multivariate-analysis)

More examples for this topic using the sample data files provided with JMP

### [Set multiple response modeling type column property](#set-multiple-response-modeling-type-column-property)

```

// Open data table
dt = Open("$Sample_Data/Big Class Families.jmp");
// Set Multiple Response
:sibling ages <<
Set Modeling Type( "Multiple Response" );
:sports <<
Set Modeling Type( "Multiple Response" );
:countries visited <<
Set Modeling Type( "Multiple Response" );
:family cars <<
Set Modeling Type( "Multiple Response" );


```

### [Perform a Bivariate Analysis to Examine the Relationship Between Difference and Mean.](#perform-a-bivariate-analysis-to-examine-the-relationship-between-difference-and-mean)

```

// Open data table
dt = Open("$Sample_Data/Dogs.jmp");
// Fit diff by mean
Bivariate( Y( :diff ), X( :mean ) );


```

### [Perform Multiple Correspondence Analysis (MCA) on categorical variables TV, Film, Art, and Restaurant, and display the total cross table.](#perform-multiple-correspondence-analysis-mca-on-categorical-variables-tv-film-art-and-restaurant-and-display-the-total-cross-table)

```

// Open data table
dt = Open("$Sample_Data/Employee Taste.jmp");
// MCA-level
Multiple Correspondence Analysis(
    Y( :TV, :Film, :Art, :Restaurant ),
    Cross Table( Show Total( 1 ) )
);


```

### [Perform Multiple Correspondence Analysis (MCA) on categorical data variables with Subject as the supplementary variable, and generate a cross table with total values shown.](#perform-multiple-correspondence-analysis-mca-on-categorical-data-variables-with-subject-as-the-supplementary-variable-and-generate-a-cross-table-with-total-values-shown)

```

// Open data table
dt = Open("$Sample_Data/Employee Taste.jmp");
// MCA-subject
Multiple Correspondence Analysis(
    Y( :TV, :Film, :Art, :Restaurant ),
    X( :Subject ),
    Cross Table( Show Total( 1 ) )
);


```

### [Save T Square statistics and configuration for a multivariate control chart involving six variables.](#save-t-square-statistics-and-configuration-for-a-multivariate-control-chart-involving-six-variables)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Aluminum Pins Historical.jmp");
// Save T Square
dt = Current Data Table();
MyTchart =
Multivariate Control Chart(
    Y(
        :Diameter1, :Diameter2,
        :Diameter3, :Diameter4, :Length1,
        :Length2
    ),
    Subgroup( :subgroup )
);
MyTchart << Save T Square;


```

### [Generate a Model Driven Multivariate Control Chart (MDMCC) for the entire dataset, incorporating all identified process variables and including statistical prediction error and normalized DModX plots for comprehensive analysis.](#generate-a-model-driven-multivariate-control-chart-mdmcc-for-the-entire-dataset-incorporating-all-identified-process-variables-and-including-statistical-prediction-error-and-normalized-dmodx-plots-for-comprehensive-analysis)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Flight Delays.jmp");
// MDMCC with entire data
Model Driven Multivariate Control Chart(
    Process(
        :AA, :CO, :DL, :F9, :FL, :NW, :UA,
        :US, :WN
    ),
    Time ID( :Flight date ),
    Statistical Prediction Error Plot,
    Normalized DModX Plot
);


```

### [Perform multivariate analysis using Row-wise estimation method and create a scatterplot matrix with density ellipses color coded.](#perform-multivariate-analysis-using-row-wise-estimation-method-and-create-a-scatterplot-matrix-with-density-ellipses-color-coded)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Thickness.jmp");
// Multivariate
Multivariate(
    Y(
        :Thickness 01, :Thickness 02,
        :Thickness 03, :Thickness 04,
        :Thickness 05, :Thickness 06,
        :Thickness 07, :Thickness 08,
        :Thickness 09, :Thickness 10,
        :Thickness 11, :Thickness 12
    ),
    Estimation Method( "Row-wise" ),
    Scatterplot Matrix(
        Density Ellipses( 1 ),
        Shaded Ellipses( 0 ),
        Ellipse Color( 3 )
    )
);


```

### [Builld a custom display window with four analysis placed horizontally](#builld-a-custom-display-window-with-four-analysis-placed-horizontally)

```

// Open data table
dt = Open("$Sample_Data/Cola Heart Rate.jmp");
// Fit Y by X Group
New Window(
    "Cola Heart Rate- Fit Y by X of Heart Rate",
    H List Box(
        Oneway(
            Y( :Heart Rate ),
            X( :Drink ),
            Box Plots( 0 ),
            Mean Diamonds( 0 ),
            SendToReport(
                Dispatch( {}, "",
                    NomAxisBox,
                    Rotated Tick Labels(
                        1
                    )
                )
            )
        ),
        Oneway(
            Y( :Heart Rate ),
            X( :Testers ),
            Box Plots( 0 ),
            Mean Diamonds( 0 )
        ),
        Oneway(
            Y( :Heart Rate ),
            X( :"Time (Raw)"n ),
            Box Plots( 0 ),
            Mean Diamonds( 0 )
        ),
        Bivariate(
            Y( :Heart Rate ),
            X( :"Time (Numeric)"n )
        )
    )
);


```

### [Perform Multiple Correspondence Analysis with supplementary rows for subject and gender, and generate detailed coordinates and scaling for the first three dimensions.](#perform-multiple-correspondence-analysis-with-supplementary-rows-for-subject-and-gender-and-generate-detailed-coordinates-and-scaling-for-the-first-three-dimensions)

```

// Open data table
dt = Open("$Sample_Data/Employee Taste.jmp");
// MCA-subject-supp-gender
Multiple Correspondence Analysis(
    Y( :TV, :Film, :Art, :Restaurant ),
    X( :Subject ),
    Z( :Gender ),
    Cross Table( Show Total( 1 ) ),
    Cross Table of Supplementary Rows(
        Show Total( 1 )
    ),
    Show Coordinates( 1 ),
    Select dimension( 1, 3 ),
    SendToReport(
        Dispatch( {}, "Variable Summary",
            OutlineBox,
            {Close( 1 )}
        ),
        Dispatch(
            {"Correspondence Analysis"},
            "2", ScaleBox,
            {Format( "Fixed Dec", 12, 0 ),
            Min( -2 ), Max( 3.5 ),
            Inc( 1 ), Minor Ticks( 1 )}
        ),
        Dispatch(
            {"Correspondence Analysis"},
            "Details", OutlineBox,
            {Close( 1 )}
        ),
        Dispatch(
            {"Correspondence Analysis"},
            "Row and Column Coordinates",
            OutlineBox,
            {Close( 1 )}
        )
    )
);


```

### [Perform confirmatory factor analysis (CFA) with a single-factor conflict model using the SEM platform.](#perform-confirmatory-factor-analysis-cfa-with-a-single-factor-conflict-model-using-the-sem-platform)

```

// Open data table
dt = Open("$Sample_Data/Job Satisfaction.jmp");
// SEM: CFA 1Factor Conflict UI
Structural Equation Models(
    Model Variables(
        :Person_C, :Intra_C, :Inter_C
    ),
    Model Specification(
        New Latent( "Conflict" ),
        Means(
            {"Constant", {:Person_C,
            :Intra_C, :Inter_C}}
        ),
        Loadings(
            {"Conflict", {:Person_C,
            :Intra_C, :Inter_C}, {1}}
        ),
        Variances(
            {:Person_C, {:Person_C}},
            {:Intra_C, {:Intra_C}},
            {:Inter_C, {:Inter_C}},
            {"Conflict", {"Conflict"}}
        )
    )
);


```

# [Neural](#neural)

More examples for this topic using the sample data files provided with JMP

### [Train a neural network model with ABRASION, MODULUS, ELONG, and HARDNESS as the response variables and SILICA, SILANE, and SULFUR as the predictors. Use Holdback validation with a holdback percentage of 33.33.](#train-a-neural-network-model-with-abrasion-modulus-elong-and-hardness-as-the-response-variables-and-silica-silane-and-sulfur-as-the-predictors-use-holdback-validation-with-a-holdback-percentage-of-3333)

```

// Open data table
dt = Open("$Sample_Data/Tiretread.jmp");
// Neural
Neural(
    Y(
        :ABRASION, :MODULUS, :ELONG,
        :HARDNESS
    ),
    X( :SILICA, :SILANE, :SULFUR ),
    Informative Missing( 0 ),
    Validation Method(
        "Holdback", 0.3333
    ),
    Go,
    Profiler( 1 )
);


```

# [Other Analysis](#other-analysis)

More examples for this topic using the sample data files provided with JMP

### [Perform a screening analysis to identify significant factors affecting log life in the Weld-Repaired Castings dataset using the Screening platform.](#perform-a-screening-analysis-to-identify-significant-factors-affecting-log-life-in-the-weld-repaired-castings-dataset-using-the-screening-platform)

```

// Open data table
dt = Open("$Sample_Data/Weld-Repaired Castings.jmp");
// Screening
Screening(
    Y( :"Log Life (×100)"n ),
    X(
        :Initial Structure, :Bead Size,
        :Pressure Treatment,
        :Heat Treatment, :Cooling Rate,
        :Polish, :Final Treatment, :ε1,
        :ε2, :ε3, :ε4
    )
);


```

# [Regression](#regression)

More examples for this topic using the sample data files provided with JMP

### [Perform a Partial Least Squares (PLS) analysis on the Wine Tasting data using the NIPALS method with 1 factor extracted through KFold validation.](#perform-a-partial-least-squares-pls-analysis-on-the-wine-tasting-data-using-the-nipals-method-with-1-factor-extracted-through-kfold-validation)

```

// Open data table
dt = Open("$Sample_Data/Wine Tasting.jmp");
// Partial Least Squares
Partial Least Squares(
    Y(
        :Hedonic, :Goes with meat,
        :Goes with dessert
    ),
    X(
        :Price, :Sugar, :Alcohol,
        :Acidity
    ),
    Validation Method(
        KFold( 5 ),
        Initial Number of Factors( 4 )
    ),
    Fit(
        Method( NIPALS ),
        Number of Factors( 1 )
    )
);


```

# [Statistical Analysis](#statistical-analysis)

More examples for this topic using the sample data files provided with JMP

### [Perform a partition analysis on a dataset using various predictor variables and initial splits criteria to maximize significance.](#perform-a-partition-analysis-on-a-dataset-using-various-predictor-variables-and-initial-splits-criteria-to-maximize-significance)

```

// Open data table
dt = Open("$Sample_Data/Equity.jmp");
// Partition
Partition(
    Y( :BAD ),
    X(
        :LOAN, :MORTDUE, :VALUE, :REASON,
        :JOB, :YOJ, :DEROG, :DELINQ,
        :CLAGE, :NINQ, :CLNO, :DEBTINC
    ),
    Show Split Prob( 1 ),
    Criterion( "Maximize Significance" ),
    Initial Splits(
        :DELINQ >= 1,
        {:DEBTINC >= 43.8475437170116},
        {:DEBTINC >= 45.7439490589145}
    )
);


```

# [Text Analysis](#text-analysis)

More examples for this topic using the sample data files provided with JMP

### [Conduct Latent Semantic Analysis (LSA) on the Reported Term for the Adverse Event column and identify key terms related to intracranial pressure, hepatic function, and urinary tract infection using the Text Explorer platform.](#conduct-latent-semantic-analysis-lsa-on-the-reported-term-for-the-adverse-event-column-and-identify-key-terms-related-to-intracranial-pressure-hepatic-function-and-urinary-tract-infection-using-the-text-explorer-platform)

```

// Open data table
dt = Open("$Sample_Data/Nicardipine.jmp");
// Text Explorer: Adverse Event
_te =
Text Explorer(
    Text Columns(
        :
        Reported Term for the Adverse Event
    ),
    Tokenizing( "Basic Words" ),
    Latent Semantic Analysis(
        1,
        Maximum Number of Terms( 92 ),
        Minimum Term Frequency( 10 ),
        Weighting( "TF IDF" ),
        Number of Singular Vectors( 5 ),
        Centering and Scaling(
            "Centered and Scaled"
        )
    )
);
_lst = Report( _te )[
"Term and Phrase Lists"][
String Col Box( 1 )] << get;
_rowvec =
Contains( _lst, "intracranial" ) |/
Contains( _lst, "pressure" ) |/
Contains( _lst, "increased" ) |/
Contains( _lst, "hepatic" ) |/
Contains( _lst, "function" ) |/
Contains( _lst, "abnormal" ) |/
Contains( _lst, "urinary" ) |/
Contains( _lst, "tract" ) |/
Contains( _lst, "infection" );
Report( _te )["Term and Phrase Lists"][
String Col Box( 1 )] <<
set selected rows( _rowvec );


```

### [Perform Latent Semantic Analysis and generate SVD plots for text exploration in the Pet Survey dataset.](#perform-latent-semantic-analysis-and-generate-svd-plots-for-text-exploration-in-the-pet-survey-dataset)

```

// Open data table
dt = Open("$Sample_Data/Pet Survey.jmp");
// Text Explorer with SVD Plots
Text Explorer(
    Text Columns( :Survey Response ),
    Set Regex( Library( "Words" ) ),
    Latent Semantic Analysis(
        1,
        Maximum Number of Terms( 143 ),
        Minimum Term Frequency( 2 ),
        Weighting( "TF IDF" ),
        Number of Singular Vectors( 100 ),
        Centering and Scaling(
            "Centered and Scaled"
        )
    )
);


```

# [Time Series](#time-series)

More examples for this topic using the sample data files provided with JMP

### [Fit a standard least squares regression model with multiple polynomial and interaction effects.](#fit-a-standard-least-squares-regression-model-with-multiple-polynomial-and-interaction-effects)

```

// Open data table
dt = Open("$Sample_Data/Design Experiment/Custom RSM.jmp");
// Model
Fit Model(
    Y( :Y ),
    Effects(
        :X1 & RS, :X2 & RS, :X3 & RS,
        :X1 * :X1, :X1 * :X2, :X2 * :X2,
        :X1 * :X3, :X2 * :X3, :X3 * :X3
    ),
    Personality(
        "Standard Least Squares"
    )
);


```

### [Analyze and visualize the process history using the Process History Explorer tool, incorporating data from multiple tables by opening and linking relevant datasets.](#analyze-and-visualize-the-process-history-using-the-process-history-explorer-tool-incorporating-data-from-multiple-tables-by-opening-and-linking-relevant-datasets)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Lot Wafer History.jmp");
// Process History Explorer
Open(
    "$SAMPLE_DATA/Quality Control/Lot Wafer Yield.jmp"
);
Open(
    "$SAMPLE_DATA/Quality Control/Lot Wafer History.jmp"
) <<
Process History Explorer(
    ID( :Lot, :Wafer ),
    X( :Tool, :Route ),
    Step( :Layer, :Operation ),
    Timestamp( :TimeIn, :TimeOut ),
    Yield Table( "Lot Wafer Yield" ),
    Yield Columns( "Yield" ),
    Levels with Lowest Yield( 1 )
);


```

### [Forecast time series data by applying the Time Series Forecast function to the specified Y variable, grouped by the Series variable over the Time variable.](#forecast-time-series-data-by-applying-the-time-series-forecast-function-to-the-specified-y-variable-grouped-by-the-series-variable-over-the-time-variable)

```

// Open data table
dt = Open("$Sample_Data/Time Series/M3C Quarterly.jmp");
// Time Series Forecast of Data
Time Series Forecast(
    Y( :Y ),
    Grouping( :Series ),
    Time( :Time )
);


```

### [Generate a Time Series Forecast for grouped quarterly data using the Time Series Forecast function with a 4-period ahead prediction and constrained parameters.](#generate-a-time-series-forecast-for-grouped-quarterly-data-using-the-time-series-forecast-function-with-a-4-period-ahead-prediction-and-constrained-parameters)

```

// Open data table
dt = Open("$Sample_Data/Time Series/M3C Quarterly.jmp");
// Time Series Forecast of Data 2
Time Series Forecast(
    Y( :Y ),
    Grouping( :Series ),
    Time( :Time ),
    Fit Model(
        NAhead( 4 ),
        Period( 4 ),
        Constrain Parameters( 1 )
    )
);


```

### [Perform Time Series X11 decomposition of a dataset containing monthly sales data using the Date column as the time variable.](#perform-time-series-x11-decomposition-of-a-dataset-containing-monthly-sales-data-using-the-date-column-as-the-time-variable)

```

// Open data table
dt = Open("$Sample_Data/Time Series/Monthly Sales.jmp");
// Time Series X11
Time Series(
    X( :Date ),
    Y( :Sales ),
    X11( Additive )
);


```

### [Detrend a time series dataset by removing both linear trend and seasonal cycle with a 12-month cycle.](#detrend-a-time-series-dataset-by-removing-both-linear-trend-and-seasonal-cycle-with-a-12-month-cycle)

```

// Open data table
dt = Open("$Sample_Data/Time Series/Monthly Sales.jmp");
// Time Series Detrended
Time Series(
    X( :Date ),
    Y( :Sales ),
    Remove Linear Trend(
        Remove Cycle(
            Units per Cycle( 12 ),
            Has Constant( 0 )
        )
    )
);


```

### [Analyze time series data using variogram and seasonal ARIMA models with specified parameters.](#analyze-time-series-data-using-variogram-and-seasonal-arima-models-with-specified-parameters)

```

// Open data table
dt = Open("$Sample_Data/Time Series/Seriesg.jmp");
// Time Series
Time Series(
    Y( :Log Passengers ),
    Variogram( 1 ),
    Seasonal ARIMA(
        0,
        1,
        1,
        0,
        1,
        1,
        12,
        No Intercept( 1 )
    )
);


```

### [Compute the Spectral Density for a Time Series Analysis](#compute-the-spectral-density-for-a-time-series-analysis)

```

// Open data table
dt = Open("$Sample_Data/Wolfer Sunspot.jmp");
// Spectral Density
Time Series(
    Y( :wolfer ),
    Spectral Density( 1 )
);


```

### [Create a P chart to monitor the proportion of Total Plastic defects over time using the Control Chart Builder platform , with subgrouping by Week, phase variable by Location, and n Trials based on Total Volume.](#create-a-p-chart-to-monitor-the-proportion-of-total-plastic-defects-over-time-using-the-control-chart-builder-platform-with-subgrouping-by-week-phase-variable-by-location-and-n-trials-based-on-total-volume)

```

// Open data table
dt = Open("$Sample_Data/Quality Control/Water Plastics.jmp");
// P chart of Total Plastic
Control Chart Builder(
    Size( 814, 307 ),
    Show Two Shewhart Charts( 0 ),
    Show Control Panel( 0 ),
    Show Limit Summaries( 0 ),
    Class( Shewhart Attribute ),
    Variables(
        Subgroup( :Week ),
        Y( :Total Plastic ),
        Phase( :Location ),
        n Trials( :Total Volume )
    ),
    Chart(
        Points(
            Statistic( "Proportion" )
        ),
        Limits(
            Sigma( "Binomial" ),
            Show Lower Limit( 0 )
        )
    ),
    SendToReport(
        Dispatch( {},
            "Control Chart Builder",
            FrameBox,
            {
            DispatchSeg(
                Text Seg( 1 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            ),
            DispatchSeg(
                Text Seg( 2 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            ),
            DispatchSeg(
                Text Seg( 3 ),
                {Line Color( "None" ),
                Fill Color( "None" )}
            )}
        )
    )
);


```

# [Visualization](#visualization)

More examples for this topic using the sample data files provided with JMP

### [Fit a linear model using REML with a random effects structure involving both machine and person variables.](#fit-a-linear-model-using-reml-with-a-random-effects-structure-involving-both-machine-and-person-variables)

```

// Open data table
dt = Open("$Sample_Data/Machine.jmp");
// Fit Model REML
Fit Model(
    Y( :rating ),
    Effects(
        :machine, :person & Random,
        :machine * :person & Random
    ),
    Personality(
        "Standard Least Squares"
    ),
    Run
);


```